<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<title>docbook2X: Documentation Table of Contents</title>
<link rel="stylesheet" href="docbook2X.css" type="text/css" />
<link rev="made" href="mailto:stevecheng@users.sourceforge.net" />
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1" />
<meta name="description" content=
"Convert DocBook into man pages and Texinfo" />
<link rel="start" href="docbook2X.html" title=
"docbook2X: Documentation Table of Contents" />
<link rel="next" href="manpages.html" title=
"docbook2X: Converting to man pages" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">docbook2X</th>
</tr>
<tr>
<td width="20%" align="left"> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href=
"manpages.html">Next >></a></td>
</tr>
</table>
<hr /></div>
<div class="article" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="docbook2X" name=
"docbook2X"></a>docbook2X</h2>
</div>
<div>
<p class="releaseinfo">Version 0.8.8</p>
</div>
<div>
<p class="author"><b>Author:</b> <span class=
"firstname">Steve</span> <span class="surname">Cheng</span>
(<code class="email"><<a href=
"mailto:stevecheng@users.sourceforge.net">stevecheng@users.sourceforge.net</a>></code>)</p>
</div>
</div>
<hr /></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="sect1"><a href="docbook2X.html#quickstart">Quick
start</a></span></dt>
<dt><span class="sect1"><a href="manpages.html">Converting to man
pages</a></span></dt>
<dd>
<dl>
<dt><span class="refentrytitle"><a href=
"docbook2man.html">docbook2man</a></span> <span class=
"refpurpose">- Convert DocBook to man pages</span></dt>
<dt><span class="refentrytitle"><a href=
"db2x_manxml.html"><span><strong class=
"command">db2x_manxml</strong></span></a></span> <span class=
"refpurpose">- Make man pages from Man-XML</span></dt>
</dl>
</dd>
<dt><span class="sect1"><a href="texinfo.html">Converting to
Texinfo</a></span></dt>
<dd>
<dl>
<dt><span class="refentrytitle"><a href=
"docbook2texi.html">docbook2texi</a></span> <span class=
"refpurpose">- Convert DocBook to Texinfo</span></dt>
<dt><span class="refentrytitle"><a href=
"db2x_texixml.html"><span><strong class=
"command">db2x_texixml</strong></span></a></span> <span class=
"refpurpose">- Make Texinfo files from Texi-XML</span></dt>
</dl>
</dd>
<dt><span class="sect1"><a href="xsltproc.html">The XSLT
stylesheets</a></span></dt>
<dd>
<dl>
<dt><span class="refentrytitle"><a href=
"db2x_xsltproc.html"><span><strong class=
"command">db2x_xsltproc</strong></span></a></span> <span class=
"refpurpose">- XSLT processor invocation wrapper</span></dt>
<dt><span class="refentrytitle"><a href=
"sgml2xml-isoent.html"><span><strong class=
"command">sgml2xml-isoent</strong></span></a></span> <span class=
"refpurpose">- Convert SGML to XML with support for ISO
entities</span></dt>
</dl>
</dd>
<dt><span class="sect1"><a href="charsets.html">Character set
conversion</a></span></dt>
<dd>
<dl>
<dt><span class="refentrytitle"><a href=
"utf8trans.html"><span><strong class=
"command">utf8trans</strong></span></a></span> <span class=
"refpurpose">- Transliterate UTF-8 characters according to a
table</span></dt>
</dl>
</dd>
<dt><span class="sect1"><a href="faq.html">FAQ</a></span></dt>
<dt><span class="sect1"><a href="performance.html">Performance
analysis</a></span></dt>
<dt><span class="sect1"><a href="testing.html">How docbook2X is
tested</a></span></dt>
<dt><span class="sect1"><a href="todo.html">To-do
list</a></span></dt>
<dt><span class="sect1"><a href="changes.html">Release
history</a></span></dt>
<dt><span class="sect1"><a href="design-notes.html">Design
notes</a></span></dt>
<dt><span class="appendix"><a href="install.html">Package
installation</a></span></dt>
<dd>
<dl>
<dt><span class="sect1"><a href=
"install.html#install-procedure">Installation</a></span></dt>
<dt><span class="sect1"><a href="dependencies.html">Dependencies on
other software</a></span></dt>
</dl>
</dd>
<dt><span class="index"><a href="cindex.html">Index</a></span></dt>
</dl>
</div>
<a id="id2476758" class="indexterm" name="id2476758"></a>
<p><em class="firstterm">docbook2X</em> converts <a href=
"http://www.docbook.org/" target="_top">DocBook</a> documents into
man pages and <a href="http://www.texinfo.org/" target=
"_top">Texinfo</a> documents.</p>
<p>It aims to support DocBook version 4.2, excepting the features
that cannot be supported or are not useful in a man page or Texinfo
document.</p>
<a id="id2514399" class="indexterm" name="id2514399"></a><a id=
"id2514406" class="indexterm" name="id2514406"></a>
<p>For information on the latest releases of docbook2X, and
downloads, please visit the <a href=
"http://docbook2x.sourceforge.net/" target="_top">docbook2X home
page</a>.</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="quickstart" name="quickstart"></a>Quick
start</h2>
</div>
</div>
</div>
<a id="id2475015" class="indexterm" name="id2475015"></a><a id=
"id2475022" class="indexterm" name="id2475022"></a><a id=
"id2475029" class="indexterm" name="id2475029"></a>
<p>To convert to man pages, you run the command <a href=
"docbook2man.html" title=
"docbook2X: docbook2man"><span><strong class=
"command">docbook2man</strong></span></a>. For example,</p>
<div class="informalexample">
<pre class="screen">
<code class="prompt">$ </code><strong class=
"userinput"><code>docbook2man --solinks manpages.xml</code></strong>
</pre>
<p>The man pages will be output to your current directory.</p>
<p>The <code class="option">--solinks</code> options tells
<span><strong class="command">docbook2man</strong></span> 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 <span><strong class=
"command">db2x_manxml</strong></span>, or just ignore the previous
two sentences and always specify this option.)</p>
</div>
<p>To convert to Texinfo, you run the command <a href=
"docbook2texi.html" title=
"docbook2X: docbook2texi"><span><strong class=
"command">docbook2texi</strong></span></a>. For example,</p>
<div class="informalexample">
<pre class="screen">
<code class="prompt">$ </code><strong class=
"userinput"><code>docbook2texi tdg.xml</code></strong>
</pre>
<p>One (or more) Texinfo files will be output to your current
directory.</p>
</div>
<p>The rest of this manual describes in detail all the other
options and how to customize docbook2X’s output.</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href=
"manpages.html">Next >></a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top"> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right" valign="top"> Converting to man
pages</td>
</tr>
</table>
</div>
<p class="footer-homepage"><a href=
"http://docbook2x.sourceforge.net/" title=
"docbook2X: Home page">docbook2X home page</a></p>
</body>
</html>