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