|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
-->
|
|
Packit |
e4b6da |
<sect1 id="quickstart">
|
|
Packit |
e4b6da |
<sect1info>
|
|
Packit |
e4b6da |
<abstract role="texinfo-node">
|
|
Packit |
e4b6da |
<para>Examples to get you started</para>
|
|
Packit |
e4b6da |
</abstract>
|
|
Packit |
e4b6da |
</sect1info>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<title>Quick start</title>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<indexterm><primary>example usage</primary></indexterm>
|
|
Packit |
e4b6da |
<indexterm><primary>converting to man pages</primary></indexterm>
|
|
Packit |
e4b6da |
<indexterm><primary>converting to Texinfo</primary></indexterm>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
To convert to man pages, you run the command &docbook2man_ref;. For example,
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<informalexample>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
><prompt>$ </prompt><userinput>docbook2man --solinks manpages.xml</userinput>
|
|
Packit |
e4b6da |
</screen>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
The man pages will be output to your current directory.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
The <option>--solinks</option> options tells &docbook2man; to create man page
|
|
Packit |
e4b6da |
links. You may want to omit this option when developing documentation
|
|
Packit |
e4b6da |
so that your working directory does not explode with many stub man pages.
|
|
Packit |
e4b6da |
(If you don’t know what this means, you can read about it in detail in &db2x_manxml;,
|
|
Packit |
e4b6da |
or just ignore the previous two sentences and always specify this option.)
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
</informalexample>
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
To convert to Texinfo, you run the command &docbook2texi_ref;. For example,
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<informalexample>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
><prompt>$ </prompt><userinput>docbook2texi tdg.xml</userinput>
|
|
Packit |
e4b6da |
</screen>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
One (or more) Texinfo files will be output to your current directory.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
</informalexample>
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
<para>
|
|
Packit |
e4b6da |
The rest of this manual describes in detail all the other options
|
|
Packit |
e4b6da |
and how to customize docbook2X’s output.
|
|
Packit |
e4b6da |
</para>
|
|
Packit |
e4b6da |
|
|
Packit |
e4b6da |
</sect1>
|
|
Packit |
e4b6da |
|