[d7fb898e] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[d7fb898e] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY docbook-utils-download-http "http://sources-redhat.mirrors.redwire.net/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
| 8 | <!ENTITY docbook-utils-download-ftp "ftp://sources.redhat.com/pub/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
[2dde015] | 9 | <!ENTITY docbook-utils-md5sum "6b41b18c365c01f225bc417cf632d81c">
|
---|
[e8b9dbf7] | 10 | <!ENTITY docbook-utils-size "124 KB">
|
---|
| 11 | <!ENTITY docbook-utils-buildsize "1.44 MB">
|
---|
| 12 | <!ENTITY docbook-utils-time ".03 SBU">
|
---|
[d7fb898e] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
|
---|
[a0f03b0] | 16 | <sect1info>
|
---|
[5cd0959d] | 17 | <othername>$LastChangedBy$</othername>
|
---|
| 18 | <date>$Date$</date>
|
---|
[a0f03b0] | 19 | </sect1info>
|
---|
[d7fb898e] | 20 | <?dbhtml filename="docbook-utils.html"?>
|
---|
| 21 | <title>DocBook-utils-&docbook-utils-version;</title>
|
---|
[2dde015] | 22 | <indexterm zone="docbook-utils">
|
---|
| 23 | <primary sortas="a-DocBook-utils">DocBook-utils</primary></indexterm>
|
---|
[d7fb898e] | 24 |
|
---|
| 25 | <sect2>
|
---|
| 26 | <title>Introduction to <application>DocBook-utils</application></title>
|
---|
| 27 |
|
---|
| 28 | <para>The <application>DocBook-utils</application> package is a collection of
|
---|
| 29 | utility scripts used to convert and analyze <acronym>SGML</acronym> documents
|
---|
| 30 | in general, and DocBook files in particular. The scripts are used to convert
|
---|
| 31 | from DocBook or other <acronym>SGML</acronym> formats into
|
---|
| 32 | <quote>classical</quote> file formats like <acronym>HTML</acronym>, man, info,
|
---|
| 33 | <acronym>RTF</acronym> and many more. There's also a utility to compare two
|
---|
| 34 | <acronym>SGML</acronym> files and only display the differences in markup. This
|
---|
| 35 | is useful for comparing documents prepared for different languages.</para>
|
---|
| 36 |
|
---|
| 37 | <sect3><title>Package information</title>
|
---|
| 38 | <itemizedlist spacing='compact'>
|
---|
[2dde015] | 39 | <listitem><para>Download (HTTP):
|
---|
| 40 | <ulink url="&docbook-utils-download-http;"/></para></listitem>
|
---|
| 41 | <listitem><para>Download (FTP):
|
---|
| 42 | <ulink url="&docbook-utils-download-ftp;"/></para></listitem>
|
---|
| 43 | <listitem><para>Download MD5 sum:
|
---|
| 44 | &docbook-utils-md5sum;</para></listitem>
|
---|
| 45 | <listitem><para>Download size:
|
---|
| 46 | &docbook-utils-size;</para></listitem>
|
---|
| 47 | <listitem><para>Estimated disk space required:
|
---|
| 48 | &docbook-utils-buildsize;</para></listitem>
|
---|
| 49 | <listitem><para>Estimated build time:
|
---|
| 50 | &docbook-utils-time;</para></listitem></itemizedlist>
|
---|
[d7fb898e] | 51 | </sect3>
|
---|
| 52 |
|
---|
| 53 | <sect3><title><application>DocBook-utils</application> dependencies</title>
|
---|
| 54 |
|
---|
| 55 | <sect4><title>Required</title>
|
---|
[81ee3f4] | 56 | <para><xref linkend="which"/>,
|
---|
| 57 | <xref linkend="openjade"/>,
|
---|
[d7fb898e] | 58 | <xref linkend="docbook-dsssl"/> and
|
---|
[2dde015] | 59 | <xref linkend="sgml-dtd-3"/></para>
|
---|
| 60 | </sect4>
|
---|
[d7fb898e] | 61 |
|
---|
| 62 | <sect4><title>Optional</title>
|
---|
[0b5a693] | 63 | <para><xref linkend="jadetex"/> (for conversion to
|
---|
[920c049c] | 64 | <acronym>DVI</acronym>, <acronym>PS</acronym> and <acronym>PDF</acronym>),
|
---|
[34f86ab] | 65 | <xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for conversion to
|
---|
| 66 | man and texinfo), and
|
---|
[d7fb898e] | 67 | <xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
|
---|
[2dde015] | 68 | (for conversion to <acronym>ASCII</acronym> text)</para>
|
---|
| 69 | </sect4>
|
---|
[d7fb898e] | 70 | </sect3>
|
---|
| 71 |
|
---|
| 72 | </sect2>
|
---|
| 73 |
|
---|
| 74 | <sect2>
|
---|
| 75 | <title>Installation of <application>DocBook-utils</application></title>
|
---|
| 76 |
|
---|
[04af8b24] | 77 | <note><para>Earlier versions of the <acronym>BLFS</acronym>
|
---|
| 78 | <application>OpenSP</application> instructions installed a catalog
|
---|
| 79 | containing an SGMLDECL <filename>unicode.sd</filename> declaration
|
---|
| 80 | into the system <acronym>SGML</acronym> catalogs. This declaration
|
---|
| 81 | causes some of the <application>OpenJade</application> programs to
|
---|
| 82 | fail occasionally. You'll need to remove these catalog definitions
|
---|
| 83 | if they exist, or the package build will fail. The following command
|
---|
| 84 | can determine if you need to remove these catalog definitions:</para>
|
---|
| 85 |
|
---|
| 86 | <screen><userinput><command>grep "OpenSP-1.5.1" /etc/sgml/catalog</command></userinput></screen>
|
---|
| 87 |
|
---|
[2dde015] | 88 | <para>If anything was returned, run the following command as the root user to
|
---|
| 89 | remove the catalog definitions:</para>
|
---|
[04af8b24] | 90 |
|
---|
[2dde015] | 91 | <screen><userinput role='root'><command>sed -i.orig \
|
---|
[04af8b24] | 92 | -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
| 93 | /etc/sgml/catalog \
|
---|
| 94 | /etc/sgml/sgml-docbook.cat</command></userinput></screen></note>
|
---|
| 95 |
|
---|
[d7fb898e] | 96 | <para>Install <application>DocBook-utils</application> by running the
|
---|
| 97 | following commands:</para>
|
---|
| 98 |
|
---|
[04af8b24] | 99 | <screen><userinput><command>./configure --prefix=/usr &&
|
---|
[2dde015] | 100 | make</command></userinput></screen>
|
---|
| 101 |
|
---|
| 102 | <para>Now, as the root user:</para>
|
---|
| 103 |
|
---|
| 104 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
[eb091c9] | 105 |
|
---|
[04af8b24] | 106 | <para>Many packages use an alternate name for the
|
---|
[eb091c9] | 107 | <application>DocBook-utils</application> scripts. If you wish to create these
|
---|
| 108 | alternate names, use the following command:</para>
|
---|
| 109 |
|
---|
[2dde015] | 110 | <screen><userinput role='root'><command>for doctype in html ps dvi man pdf rtf tex texi txt
|
---|
[eb091c9] | 111 | do
|
---|
| 112 | ln -s docbook2$doctype /usr/bin/db2$doctype
|
---|
| 113 | done</command></userinput></screen>
|
---|
| 114 |
|
---|
[9f94cd9] | 115 | </sect2>
|
---|
| 116 |
|
---|
[d7fb898e] | 117 | <sect2>
|
---|
| 118 | <title>Contents</title>
|
---|
| 119 |
|
---|
[2dde015] | 120 | <segmentedlist>
|
---|
| 121 | <segtitle>Installed Programs</segtitle>
|
---|
| 122 | <segtitle>Installed Libraries</segtitle>
|
---|
| 123 | <segtitle>Installed Directories</segtitle>
|
---|
| 124 | <segtitle>Installed Symlinks</segtitle>
|
---|
| 125 |
|
---|
| 126 | <seglistitem>
|
---|
| 127 | <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
|
---|
| 128 | docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw and sgmldiff</seg>
|
---|
| 129 | <seg>None</seg>
|
---|
| 130 | <seg>/usr/share/doc/html/docbook-utils-&docbook-utils-version; and
|
---|
| 131 | /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
|
---|
| 132 | <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi and
|
---|
| 133 | db2txt</seg>
|
---|
| 134 |
|
---|
| 135 | </seglistitem>
|
---|
| 136 | </segmentedlist>
|
---|
| 137 |
|
---|
| 138 | <variablelist>
|
---|
| 139 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 140 | <?dbfo list-presentation="list"?>
|
---|
| 141 |
|
---|
| 142 | <varlistentry id="docbook2">
|
---|
| 143 | <term><command>docbook2*</command></term>
|
---|
| 144 | <listitem><para>are simple one-line wrapper scripts to <command>jw</command>.
|
---|
| 145 | They are provided as easy-to-remember names used to convert DocBook or
|
---|
| 146 | other <acronym>SGML</acronym> files to the respective format.</para>
|
---|
| 147 | <indexterm zone="docbook-utils docbook2">
|
---|
| 148 | <primary sortas="b-docbook2-star">docbook2*</primary>
|
---|
| 149 | </indexterm></listitem>
|
---|
| 150 | </varlistentry>
|
---|
| 151 |
|
---|
| 152 | <varlistentry id="db2">
|
---|
| 153 | <term><command>db2*</command></term>
|
---|
| 154 | <listitem><para>are symlinks pointing at the respectively named
|
---|
[d260aaf4] | 155 | <command>docbook2*</command> commands, created to satisfy some program's
|
---|
[2dde015] | 156 | use of these names.</para>
|
---|
| 157 | <indexterm zone="docbook-utils db2">
|
---|
| 158 | <primary sortas="g-db2-star">db2*</primary>
|
---|
| 159 | </indexterm></listitem>
|
---|
| 160 | </varlistentry>
|
---|
| 161 |
|
---|
| 162 | <varlistentry id="jw">
|
---|
| 163 | <term><command>jw</command></term>
|
---|
| 164 | <listitem><para>is a script used to convert DocBook or other
|
---|
[d7fb898e] | 165 | <acronym>SGML</acronym> files to various output formats. It hides most of
|
---|
| 166 | <application>OpenJade</application>'s complexity and adds comfortable
|
---|
[2dde015] | 167 | features.</para>
|
---|
| 168 | <indexterm zone="docbook-utils jw">
|
---|
| 169 | <primary sortas="b-jw">jw</primary>
|
---|
| 170 | </indexterm></listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 |
|
---|
| 173 | <varlistentry id="sgmldiff">
|
---|
| 174 | <term><command>sgmldiff</command></term>
|
---|
| 175 | <listitem><para>is used to compare two <acronym>SGML</acronym> files and
|
---|
| 176 | only return the differences in the markup. This is especially useful to
|
---|
| 177 | compare files that should be identical except for language differences in the
|
---|
| 178 | content.</para>
|
---|
| 179 | <indexterm zone="docbook-utils sgmldiff">
|
---|
| 180 | <primary sortas="b-sgmldiff">sgmldiff</primary>
|
---|
| 181 | </indexterm></listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 | </variablelist>
|
---|
[d7fb898e] | 184 |
|
---|
| 185 | </sect2>
|
---|
| 186 |
|
---|
| 187 | </sect1>
|
---|
| 188 |
|
---|