source: pst/sgml/docbook-utils.xml@ eb091c9

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY docbook-utils-download-http "http://sources-redhat.mirrors.redwire.net/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
  <!ENTITY docbook-utils-download-ftp  "ftp://sources.redhat.com/pub/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
  <!ENTITY docbook-utils-size          "125 KB">
  <!ENTITY docbook-utils-buildsize     "1.5 MB">
  <!ENTITY docbook-utils-time          ".04 SBU">
]>

<sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="docbook-utils.html"?>
<title>DocBook-utils-&docbook-utils-version;</title>


<sect2>
<title>Introduction to <application>DocBook-utils</application></title>

<para>The <application>DocBook-utils</application> package is a collection of 
utility scripts used to convert and analyze <acronym>SGML</acronym> documents 
in general, and DocBook files in particular. The scripts are used to convert 
from DocBook or other <acronym>SGML</acronym> formats into 
<quote>classical</quote> file formats like <acronym>HTML</acronym>, man, info, 
<acronym>RTF</acronym> and many more. There's also a utility to compare two 
<acronym>SGML</acronym> files and only display the differences in markup. This 
is useful for comparing documents prepared for different languages.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&docbook-utils-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&docbook-utils-download-ftp;"/></para></listitem>
<listitem><para>Download size: &docbook-utils-size;</para></listitem>
<listitem><para>Estimated Disk space required: &docbook-utils-buildsize;</para></listitem>
<listitem><para>Estimated build time: &docbook-utils-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>DocBook-utils</application> dependencies</title>

<sect4><title>Required</title>
<para><xref linkend="openjade"/>, 
<xref linkend="docbook-dsssl"/> and 
<xref linkend="sgml-dtd-3"/></para></sect4>

<sect4><title>Optional</title>
<para><xref linkend="jadetex"/> (for conversion to <acronym>DVI</acronym>, 
<acronym>PS</acronym> and <acronym>PDF</acronym>), 
<xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for conversion to 
man and texinfo), and  
<xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/> 
(for conversion to <acronym>ASCII</acronym> text)</para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>DocBook-utils</application></title>

<para>Install <application>DocBook-utils</application> by running the 
following commands:</para>

<screen><userinput><command>sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
    /etc/sgml/catalog &amp;&amp;
sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
    /etc/sgml/sgml-docbook.cat &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
cp /etc/sgml/catalog.orig /etc/sgml/catalog &amp;&amp;
cp /etc/sgml/sgml-docbook.cat.orig /etc/sgml/sgml-docbook.cat</command></userinput></screen>

<para>Many packages will use an alternate name for the 
<application>DocBook-utils</application> scripts. If you wish to create these 
alternate names, use the following command:</para>

<screen><userinput><command>for doctype in html ps dvi man pdf rtf tex texi txt
do
    ln -s docbook2$doctype /usr/bin/db2$doctype
done</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>sed -i.orig -e ...</command>: These two <command>sed</command>'s 
remove <application>OpenSP</application> catalog definitions from the
<acronym>SGML</acronym> catalogs because the SGMLDECL unicode.sd declaration
creates errors when <command>openjade</command> builds the 
<application>DocBook-utils</application> documentation files. Backup copies of 
the files are made and copied back to their original place after the build is 
complete. Though these errors are harmless, and won't affect 
<application>DocBook-utils</application> functionality after the build, the
declarations are temporarily removed to provide a clean package build.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>DocBook-utils</application> package contains 
<command>docbook2dvi</command>, <command>docbook2html</command>, 
<command>docbook2man</command>, <command>docbook2pdf</command>, 
<command>docbook2ps</command>, <command>docbook2rtf</command>, 
<command>docbook2tex</command>, <command>docbook2texi</command>, 
<command>docbook2txt</command>, <command>jw</command> and 
<command>sgmldiff</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>docbook2{dvi,html,man,pdf,ps,rtf,tex,texi,txt}</title>

<para>The <command>docbook2{format}</command> scripts are simple one-line 
wrappers to <command>jw</command>. They are provided as easy-to-remember 
names used to convert DocBook or other <acronym>SGML</acronym> files to the 
respective format.</para></sect3>

<sect3><title>jw</title>

<para><command>jw</command> is a script used to convert DocBook or other
<acronym>SGML</acronym> files to various output formats. It hides most of 
<application>OpenJade</application>'s complexity and adds comfortable 
features.</para></sect3>

<sect3><title>sgmldiff</title>

<para><command>sgmldiff</command> is used to compare two 
<acronym>SGML</acronym> files and only return the differences in the markup. 
This is especially useful to compare files that should be identical except 
for language differences in the content.</para></sect3>

</sect2>

</sect1>