Blob Blame History Raw
<?xml version="1.0" encoding="utf-8" ?>
<!-- vim: sta et sw=2
-->
<sect1 id="quickstart">
<sect1info>
<abstract role="texinfo-node">
  <para>Examples to get you started</para>
</abstract>
</sect1info>

<title>Quick start</title>

<indexterm><primary>example usage</primary></indexterm>
<indexterm><primary>converting to man pages</primary></indexterm>
<indexterm><primary>converting to Texinfo</primary></indexterm>

<para>
To convert to man pages, you run the command &docbook2man_ref;.  For example,

<informalexample>
<screen
><prompt>$ </prompt><userinput>docbook2man --solinks manpages.xml</userinput>
</screen>

<para>
The man pages will be output to your current directory.
</para>

<para>
The <option>--solinks</option> options tells &docbook2man; to create man page
links.  You may want to omit this option when developing documentation
so that your working directory does not explode with many stub man pages.
(If you don’t know what this means, you can read about it in detail in &db2x_manxml;,
 or just ignore the previous two sentences and always specify this option.)
</para>

</informalexample>
</para>

<para>
To convert to Texinfo, you run the command &docbook2texi_ref;.  For example,

<informalexample>
<screen
><prompt>$ </prompt><userinput>docbook2texi tdg.xml</userinput>
</screen>

<para>
One (or more) Texinfo files will be output to your current directory.
</para>

</informalexample>
</para>

<para>
The rest of this manual describes in detail all the other options
and how to customize docbook2X’s output.
</para>

</sect1>