Warning, /frameworks/kdoctools/docs/meinproc6/man-meinproc6.1.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ 0003 <!ENTITY % English "INCLUDE"><!-- change language only here --> 0004 ]> 0005 0006 <refentry lang="&language;"> 0007 0008 <refentryinfo> 0009 <title>meinproc6 User's Manual</title> 0010 <!-- There is no author in the meinproc.cpp file 0011 Also, based on the information from http://olympus.het.brown.edu/cgi-bin/man/man2html?meinproc+1 0012 0013 <author> 0014 <firstname>Matthias </firstname> 0015 <surname>Hoelzer-Kluepfel</surname> 0016 <affiliation> 0017 <address><email>hoelzer@kde.org</email></address> 0018 </affiliation> 0019 </author> 0020 0021 <author> 0022 <firstname>Stephan</firstname> 0023 <surname>Kulow</surname> 0024 <affiliation> 0025 <address><email>coolo@kde.org</email></address> 0026 </affiliation> 0027 </author> 0028 0029 <author> 0030 <firstname>Cornelius</firstname> 0031 <surname>Schumacher</surname> 0032 <affiliation> 0033 <address><email>schumacher@kde.org</email></address> 0034 </affiliation> 0035 </author> 0036 --> 0037 <date>2014-05-08</date> 0038 <releaseinfo>Frameworks 5.0</releaseinfo> 0039 <productname>KDE Frameworks</productname> 0040 0041 </refentryinfo> 0042 0043 <refmeta> 0044 <refentrytitle><command>meinproc6</command></refentrytitle> 0045 <manvolnum>1</manvolnum> 0046 </refmeta> 0047 0048 <refnamediv> 0049 <refname><command>meinproc6</command></refname> 0050 <refpurpose>&kde; translator for &XML;</refpurpose> 0051 </refnamediv> 0052 0053 <refsynopsisdiv> 0054 <title>Synopsis</title> 0055 0056 <cmdsynopsis> 0057 <command>meinproc6</command> 0058 0059 <arg choice="opt">-h, --help</arg> 0060 <arg choice="opt">-v, --version</arg> 0061 <arg choice="opt">--cache<replaceable> file</replaceable></arg> 0062 <arg choice="opt">--check</arg> 0063 <arg choice="opt">--srcdir<replaceable> dir</replaceable></arg> 0064 <arg choice="opt">--param <replaceable>key</replaceable>=<replaceable>value</replaceable></arg> 0065 0066 <group> 0067 <group> 0068 <arg>-o</arg> 0069 <arg>--output</arg> 0070 </group> 0071 <replaceable> file</replaceable> 0072 </group> 0073 <arg choice="opt">--stdout</arg> 0074 <arg choice="opt">--stylesheet<replaceable> xsl</replaceable></arg> 0075 <arg choice="plain">docbook_file</arg> 0076 </cmdsynopsis> 0077 </refsynopsisdiv> 0078 0079 <refsect1> 0080 <title>Description</title> 0081 0082 <para><command>meinproc6</command> converts DocBook files to &HTML;. 0083 </para> 0084 </refsect1> 0085 0086 <refsect1> 0087 <title>Generic Options</title> 0088 <para> 0089 <variablelist> 0090 0091 <varlistentry> 0092 <term><option>-h</option><option>--help</option></term> 0093 <listitem> 0094 <para> 0095 Show help about options. 0096 </para> 0097 </listitem> 0098 </varlistentry> 0099 0100 <varlistentry> 0101 <term><option>-v</option><option>--version</option></term> 0102 <listitem> 0103 <para> 0104 Show version information. 0105 </para> 0106 </listitem> 0107 </varlistentry> 0108 0109 </variablelist> 0110 </para> 0111 </refsect1> 0112 0113 <refsect1> 0114 <title>Application Options</title> 0115 <variablelist> 0116 0117 <varlistentry> 0118 <term><option>--cache</option> <parameter>file</parameter></term> 0119 <listitem> 0120 <para> 0121 Create a cache file for the document. 0122 </para> 0123 </listitem> 0124 </varlistentry> 0125 0126 <varlistentry> 0127 <term><option>--check</option></term> 0128 <listitem> 0129 <para>Check the document for validity.</para> 0130 <screen>The output can be a bit daunting, since one small mistake can cause a cascade of errors. 0131 The trick is to look at the first error, fix that error, save the file, and run <command>meinproc6</command> again. 0132 </screen> 0133 </listitem> 0134 </varlistentry> 0135 0136 <varlistentry> 0137 <term><option>-o</option>, <option>--output</option><parameter> file</parameter></term> 0138 <listitem> 0139 <para> 0140 Output whole document to <parameter>file</parameter>. 0141 </para> 0142 </listitem> 0143 </varlistentry> 0144 0145 <varlistentry> 0146 <term><option>--stdout</option></term> 0147 <listitem> 0148 <para> 0149 Output whole document to stdout. 0150 </para> 0151 </listitem> 0152 </varlistentry> 0153 0154 <varlistentry> 0155 <term><option>--stylesheet</option> <parameter>xsl</parameter></term> 0156 <listitem> 0157 <para> 0158 Stylesheet to use. 0159 </para> 0160 </listitem> 0161 </varlistentry> 0162 0163 <varlistentry> 0164 <term><option>--srcdir</option> <parameter>dir</parameter></term> 0165 <listitem> 0166 <para> 0167 Set the root directory to look for kdoctools. 0168 </para> 0169 </listitem> 0170 </varlistentry> 0171 0172 <varlistentry> 0173 <term><option>--param</option> key=value</term> 0174 <listitem> 0175 <para> 0176 Set parameters to pass to the stylesheet. 0177 </para> 0178 </listitem> 0179 </varlistentry> 0180 0181 </variablelist> 0182 0183 </refsect1> 0184 0185 <refsect1> 0186 <title>Usage</title> 0187 <para> 0188 The most common way to run <command>meinproc6</command> is simply as 0189 <literallayout> 0190 <userinput><command>meinproc6</command> <replaceable>docbook-file</replaceable> 0191 </userinput> 0192 </literallayout> 0193 where <replaceable>docbook-file</replaceable> is usually index.docbook. 0194 This command creates &HTML; pages from the DocBook file. 0195 Note that these pages are only viewable in &kde;-based browsers (like &konqueror;). 0196 </para> 0197 <para> 0198 If you need to view the &HTML; output in another browser (for example, if you're placing it on line), use 0199 <literallayout> 0200 <userinput><command>meinproc6</command> --stylesheet <replaceable>stylesheet-name</replaceable> <replaceable>docbook-file</replaceable> 0201 </userinput> 0202 </literallayout> 0203 where <replaceable>stylesheet-name</replaceable> is the full path to one of the &XSL; 0204 stylesheets in <kdoctools_installation_prefix>/share/kf5/kdoctools/customization/. 0205 To produce output suitable for the web, you can use <command>kde-web.xsl</command> or 0206 <command>kde-chunk-online.xsl</command>. See the <filename>README</filename> 0207 file in that directory for more details. 0208 </para> 0209 0210 </refsect1> 0211 0212 <refsect1> 0213 <title>See Also</title> 0214 <para><replaceable>kf6options</replaceable>(7), <replaceable>qt6options</replaceable>(7)</para> 0215 </refsect1> 0216 0217 <refsect1> 0218 <title>Bugs</title> 0219 <para>Please use <ulink url="https://bugs.kde.org">&kde;'s bugtracker</ulink> to report bugs.</para> 0220 </refsect1> 0221 0222 </refentry> 0223 0224 0225