[d7fb898e] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/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">
|
---|
[738c5f8] | 12 | <!ENTITY docbook-utils-time "less than 0.1 SBU">
|
---|
[d7fb898e] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
|
---|
[5bae145] | 16 | <?dbhtml filename="docbook-utils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>DocBook-utils-&docbook-utils-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="docbook-utils">
|
---|
| 26 | <primary sortas="a-DocBook-utils">DocBook-utils</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to DocBook-utils</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>DocBook-utils</application> package is a collection
|
---|
| 33 | of utility scripts used to convert and analyze SGML documents in general,
|
---|
| 34 | and DocBook files in particular. The scripts are used to convert from
|
---|
| 35 | DocBook or other SGML formats into <quote>classical</quote> file formats
|
---|
| 36 | like HTML, man, info, RTF and many more. There's also a utility to compare
|
---|
| 37 | two SGML files and only display the differences in markup. This is useful
|
---|
| 38 | for comparing documents prepared for different languages.</para>
|
---|
| 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (HTTP): <ulink url="&docbook-utils-download-http;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (FTP): <ulink url="&docbook-utils-download-ftp;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download MD5 sum: &docbook-utils-md5sum;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download size: &docbook-utils-size;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated disk space required: &docbook-utils-buildsize;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated build time: &docbook-utils-time;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
| 61 |
|
---|
| 62 | <bridgehead renderas="sect3">DocBook-utils Dependencies</bridgehead>
|
---|
| 63 |
|
---|
| 64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d352a28] | 65 | <para role="required"><xref linkend="openjade"/>,
|
---|
[5bae145] | 66 | <xref linkend="docbook-dsssl"/> and
|
---|
| 67 | <xref linkend="sgml-dtd-3"/></para>
|
---|
| 68 |
|
---|
[738c5f8] | 69 | <bridgehead renderas="sect4">Optional (Runtime Dependencies Only)</bridgehead>
|
---|
[d352a28] | 70 | <para role="optional"><xref linkend="jadetex"/> (for conversion to DVI, PS and PDF),
|
---|
[ba4b31cf] | 71 | <xref linkend="perl-sgmlspm"/> (for conversion to man and texinfo), and
|
---|
[5bae145] | 72 | <xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
|
---|
| 73 | (for conversion to ASCII text)</para>
|
---|
| 74 |
|
---|
[977061b0] | 75 | <para condition="html" role="usernotes">User Notes:
|
---|
| 76 | <ulink url="&blfs-wiki;/docbook-utils"/></para>
|
---|
| 77 |
|
---|
[5bae145] | 78 | </sect2>
|
---|
| 79 |
|
---|
| 80 | <sect2 role="installation">
|
---|
| 81 | <title>Installation of DocBook-utils</title>
|
---|
| 82 |
|
---|
[738c5f8] | 83 | <!-- This shouldn't be required any longer as the OpenSP catalog stuff
|
---|
| 84 | was removed from BLFS two revisions ago.
|
---|
| 85 |
|
---|
[5bae145] | 86 | <note>
|
---|
| 87 | <para>Earlier versions of the BLFS <application>OpenSP</application>
|
---|
| 88 | instructions installed a catalog containing an SGMLDECL
|
---|
| 89 | <filename>unicode.sd</filename> declaration into the system SGML
|
---|
| 90 | catalogs. This declaration causes some of the
|
---|
| 91 | <application>OpenJade</application> programs to fail occasionally.
|
---|
| 92 | You'll need to remove these catalog definitions if they exist, or
|
---|
| 93 | the package build will fail. The following command can determine if
|
---|
| 94 | you need to remove these catalog definitions:</para>
|
---|
| 95 |
|
---|
| 96 | <screen><userinput>grep "OpenSP-1.5.1" /etc/sgml/catalog</userinput></screen>
|
---|
| 97 |
|
---|
| 98 | <para>If anything was returned, run the following command as the
|
---|
| 99 | <systemitem class="username">root</systemitem> user to remove the
|
---|
| 100 | catalog definitions:</para>
|
---|
| 101 |
|
---|
| 102 | <screen role="root"><userinput>sed -i.orig \
|
---|
[04af8b24] | 103 | -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
| 104 | /etc/sgml/catalog \
|
---|
[5bae145] | 105 | /etc/sgml/sgml-docbook.cat</userinput></screen>
|
---|
[04af8b24] | 106 |
|
---|
[5bae145] | 107 | </note>
|
---|
[d7fb898e] | 108 |
|
---|
[738c5f8] | 109 | -->
|
---|
| 110 |
|
---|
[5bae145] | 111 | <para>Install <application>DocBook-utils</application> by running the
|
---|
| 112 | following commands:</para>
|
---|
[2dde015] | 113 |
|
---|
[ecb6484a] | 114 | <screen><userinput>sed -i 's:/html::' doc/HTML/Makefile.in &&
|
---|
| 115 | ./configure --prefix=/usr &&
|
---|
[5bae145] | 116 | make</userinput></screen>
|
---|
[2dde015] | 117 |
|
---|
[738c5f8] | 118 | <para>This package does not come with a test suite.</para>
|
---|
| 119 |
|
---|
[5bae145] | 120 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[eb091c9] | 121 |
|
---|
[5bae145] | 122 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[eb091c9] | 123 |
|
---|
[5bae145] | 124 | <para>Many packages use an alternate name for the
|
---|
| 125 | <application>DocBook-utils</application> scripts. If you wish to create
|
---|
| 126 | these alternate names, use the following command:</para>
|
---|
| 127 |
|
---|
| 128 | <screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
|
---|
[eb091c9] | 129 | do
|
---|
| 130 | ln -s docbook2$doctype /usr/bin/db2$doctype
|
---|
[5bae145] | 131 | done</userinput></screen>
|
---|
| 132 |
|
---|
[4570991] | 133 | <note>
|
---|
| 134 | <para>The <command>jw</command> script uses the <command>which</command>
|
---|
| 135 | command to locate required utilities. You must install
|
---|
| 136 | <xref linkend="which"/> before attempting to use any of the
|
---|
| 137 | <application>DocBook-utils</application> programs.</para>
|
---|
| 138 | </note>
|
---|
| 139 |
|
---|
[5bae145] | 140 | </sect2>
|
---|
| 141 |
|
---|
[ecb6484a] | 142 | <sect2 role="commands">
|
---|
| 143 | <title>Command Explanations</title>
|
---|
| 144 |
|
---|
| 145 | <para><command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
|
---|
| 146 | This command changes the installation directory of the HTML documents.</para>
|
---|
| 147 |
|
---|
| 148 | </sect2>
|
---|
| 149 |
|
---|
[5bae145] | 150 | <sect2 role="content">
|
---|
| 151 | <title>Contents</title>
|
---|
| 152 |
|
---|
| 153 | <segmentedlist>
|
---|
| 154 | <segtitle>Installed Programs</segtitle>
|
---|
| 155 | <segtitle>Installed Libraries</segtitle>
|
---|
| 156 | <segtitle>Installed Directories</segtitle>
|
---|
| 157 | <segtitle>Installed Symlinks</segtitle>
|
---|
| 158 |
|
---|
| 159 | <seglistitem>
|
---|
| 160 | <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
|
---|
| 161 | docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and
|
---|
| 162 | sgmldiff</seg>
|
---|
| 163 | <seg>None</seg>
|
---|
[ecb6484a] | 164 | <seg>/usr/share/doc/docbook-utils-&docbook-utils-version; and
|
---|
[5bae145] | 165 | /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
|
---|
| 166 | <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi,
|
---|
| 167 | and db2txt</seg>
|
---|
| 168 | </seglistitem>
|
---|
| 169 | </segmentedlist>
|
---|
| 170 |
|
---|
| 171 | <variablelist>
|
---|
| 172 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 173 | <?dbfo list-presentation="list"?>
|
---|
| 174 | <?dbhtml list-presentation="table"?>
|
---|
| 175 |
|
---|
| 176 | <varlistentry id="docbook2">
|
---|
| 177 | <term><command>docbook2*</command></term>
|
---|
| 178 | <listitem>
|
---|
| 179 | <para>are simple one-line wrapper scripts to <command>jw</command>.
|
---|
| 180 | They are provided as easy-to-remember names used to convert DocBook or
|
---|
| 181 | other SGML files to the respective format.</para>
|
---|
| 182 | <indexterm zone="docbook-utils docbook2">
|
---|
| 183 | <primary sortas="b-docbook2-star">docbook2*</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="db2">
|
---|
| 189 | <term><command>db2*</command></term>
|
---|
| 190 | <listitem>
|
---|
| 191 | <para>are symlinks pointing at the respectively named
|
---|
| 192 | <command>docbook2*</command> commands, created to satisfy some
|
---|
| 193 | program's use of these names.</para>
|
---|
| 194 | <indexterm zone="docbook-utils db2">
|
---|
| 195 | <primary sortas="g-db2-star">db2*</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="jw">
|
---|
| 201 | <term><command>jw</command></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>is a script used to convert DocBook or other SGML files to various
|
---|
| 204 | output formats. It hides most of <application>OpenJade</application>'s
|
---|
| 205 | complexity and adds comfortable features.</para>
|
---|
| 206 | <indexterm zone="docbook-utils jw">
|
---|
| 207 | <primary sortas="b-jw">jw</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | <varlistentry id="sgmldiff">
|
---|
| 213 | <term><command>sgmldiff</command></term>
|
---|
| 214 | <listitem>
|
---|
| 215 | <para>is used to compare two SGML files and only return the differences
|
---|
| 216 | in the markup. This is especially useful to compare files that should be
|
---|
| 217 | identical except for language differences in the content.</para>
|
---|
| 218 | <indexterm zone="docbook-utils sgmldiff">
|
---|
| 219 | <primary sortas="b-sgmldiff">sgmldiff</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
| 222 | </varlistentry>
|
---|
| 223 |
|
---|
| 224 | </variablelist>
|
---|
| 225 |
|
---|
| 226 | </sect2>
|
---|
[d7fb898e] | 227 |
|
---|
| 228 | </sect1>
|
---|