1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY docbook-utils-download-http "https://sourceware.org/ftp/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
---|
8 | <!ENTITY docbook-utils-download-ftp " ">
|
---|
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 |
|
---|
19 | <title>DocBook-utils-&docbook-utils-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="docbook-utils">
|
---|
22 | <primary sortas="a-DocBook-utils">DocBook-utils</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to DocBook-utils</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>DocBook-utils</application> package is a collection
|
---|
30 | of utility scripts used to convert and analyze SGML documents in general,
|
---|
31 | and DocBook files in particular. The scripts are used to convert from
|
---|
32 | DocBook or other SGML formats into <quote>classical</quote> file formats
|
---|
33 | like HTML, man, info, RTF and many more. There's also a utility to compare
|
---|
34 | two SGML files and only display the differences in markup. This is useful
|
---|
35 | for comparing documents prepared for different languages.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs122_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&docbook-utils-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&docbook-utils-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &docbook-utils-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &docbook-utils-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &docbook-utils-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &docbook-utils-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
75 | <itemizedlist spacing='compact'>
|
---|
76 | <listitem>
|
---|
77 | <para>
|
---|
78 | Required patch: <ulink url=
|
---|
79 | "&patch-root;/docbook-utils-&docbook-utils-version;-grep_fix-1.patch"/>
|
---|
80 | </para>
|
---|
81 | </listitem>
|
---|
82 | </itemizedlist>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect3">DocBook-utils Dependencies</bridgehead>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
87 | <para role="required">
|
---|
88 | <xref linkend="openjade"/>,
|
---|
89 | <xref linkend="docbook-dsssl"/>, and
|
---|
90 | <xref linkend="sgml-dtd-3"/>
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <bridgehead renderas="sect4">Recommended (Runtime Dependencies Only)</bridgehead>
|
---|
94 | <para role="recommended">
|
---|
95 | <xref role="runtime" linkend="perl-sgmlspm"/> (for conversion to man and
|
---|
96 | texinfo), and
|
---|
97 | <xref role="runtime" linkend="lynx"/> or
|
---|
98 | <xref role="nodep" linkend="Links"/> or
|
---|
99 | <ulink role="runtime" url="&w3m-url;">W3m</ulink>
|
---|
100 | (for conversion to ASCII text)
|
---|
101 | </para>
|
---|
102 |
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2 role="installation">
|
---|
107 | <title>Installation of DocBook-utils</title>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | Install <application>DocBook-utils</application> by running the
|
---|
111 | following commands:
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <screen><userinput>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch &&
|
---|
115 | sed -i 's:/html::' doc/HTML/Makefile.in &&
|
---|
116 |
|
---|
117 | ./configure --prefix=/usr --mandir=/usr/share/man &&
|
---|
118 | make</userinput></screen>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | This package does not come with a test suite.
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <screen role="root"><userinput>make docdir=/usr/share/doc install</userinput></screen>
|
---|
129 |
|
---|
130 | <para>
|
---|
131 | Many packages use an alternate name for the
|
---|
132 | <application>DocBook-utils</application> scripts. If you wish to create
|
---|
133 | these alternate names, use the following command as
|
---|
134 | the <systemitem class="username">root</systemitem> user:
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
|
---|
138 | do
|
---|
139 | ln -svf docbook2$doctype /usr/bin/db2$doctype
|
---|
140 | done</userinput></screen>
|
---|
141 |
|
---|
142 | <note>
|
---|
143 | <para>
|
---|
144 | The <command>jw</command> script uses the <command>which</command>
|
---|
145 | command to locate required utilities. You must install
|
---|
146 | <xref linkend="which"/> before attempting to use any of the
|
---|
147 | <application>DocBook-utils</application> programs.
|
---|
148 | </para>
|
---|
149 | </note>
|
---|
150 |
|
---|
151 | </sect2>
|
---|
152 |
|
---|
153 | <sect2 role="commands">
|
---|
154 | <title>Command Explanations</title>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | <command>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch</command>:
|
---|
158 | This patch corrects the syntax in the jw (Jade Wrapper) script which is
|
---|
159 | at the heart of much db2* processing, so that the current version of
|
---|
160 | <application>grep</application> will not reject it.
|
---|
161 | </para>
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | <command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
|
---|
165 | This command changes the installation directory of the HTML documents.
|
---|
166 | </para>
|
---|
167 |
|
---|
168 | <para>
|
---|
169 | <parameter>docdir=/usr/share/doc</parameter>: This option is placed on the
|
---|
170 | <command>make install</command> line because it is not
|
---|
171 | recognized by <command>configure</command>.
|
---|
172 | </para>
|
---|
173 |
|
---|
174 | </sect2>
|
---|
175 |
|
---|
176 | <sect2 role="content">
|
---|
177 | <title>Contents</title>
|
---|
178 |
|
---|
179 | <segmentedlist>
|
---|
180 | <segtitle>Installed Programs</segtitle>
|
---|
181 | <segtitle>Installed Libraries</segtitle>
|
---|
182 | <segtitle>Installed Directories</segtitle>
|
---|
183 | <segtitle>Installed Symlinks</segtitle>
|
---|
184 |
|
---|
185 | <seglistitem>
|
---|
186 | <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
|
---|
187 | docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and
|
---|
188 | sgmldiff</seg>
|
---|
189 | <seg>None</seg>
|
---|
190 | <seg>/usr/share/doc/docbook-utils-&docbook-utils-version; and
|
---|
191 | /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
|
---|
192 | <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi,
|
---|
193 | and db2txt</seg>
|
---|
194 | </seglistitem>
|
---|
195 | </segmentedlist>
|
---|
196 |
|
---|
197 | <variablelist>
|
---|
198 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
199 | <?dbfo list-presentation="list"?>
|
---|
200 | <?dbhtml list-presentation="table"?>
|
---|
201 |
|
---|
202 | <varlistentry id="docbook2">
|
---|
203 | <term><command>docbook2*</command></term>
|
---|
204 | <listitem>
|
---|
205 | <para>
|
---|
206 | are simple one-line wrapper scripts to <command>jw</command>.
|
---|
207 | They are provided as easy-to-remember names used to convert
|
---|
208 | DocBook or other SGML files to the respective format
|
---|
209 | </para>
|
---|
210 | <indexterm zone="docbook-utils docbook2">
|
---|
211 | <primary sortas="b-docbook2-star">docbook2*</primary>
|
---|
212 | </indexterm>
|
---|
213 | </listitem>
|
---|
214 | </varlistentry>
|
---|
215 |
|
---|
216 | <varlistentry id="db2">
|
---|
217 | <term><command>db2*</command></term>
|
---|
218 | <listitem>
|
---|
219 | <para>
|
---|
220 | are symlinks pointing at the respectively named
|
---|
221 | <command>docbook2*</command> commands, created to satisfy some
|
---|
222 | program's use of these names
|
---|
223 | </para>
|
---|
224 | <indexterm zone="docbook-utils db2">
|
---|
225 | <primary sortas="b-db2-star">db2*</primary>
|
---|
226 | </indexterm>
|
---|
227 | </listitem>
|
---|
228 | </varlistentry>
|
---|
229 |
|
---|
230 | <varlistentry id="jw">
|
---|
231 | <term><command>jw</command></term>
|
---|
232 | <listitem>
|
---|
233 | <para>
|
---|
234 | is a script used to convert DocBook or other SGML files to various
|
---|
235 | output formats. It hides most of
|
---|
236 | <application>OpenJade</application>'s complexity and adds
|
---|
237 | comfortable features
|
---|
238 | </para>
|
---|
239 | <indexterm zone="docbook-utils jw">
|
---|
240 | <primary sortas="b-jw">jw</primary>
|
---|
241 | </indexterm>
|
---|
242 | </listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="sgmldiff">
|
---|
246 | <term><command>sgmldiff</command></term>
|
---|
247 | <listitem>
|
---|
248 | <para>
|
---|
249 | is used to compare two SGML files and only return the differences
|
---|
250 | in the markup. This is especially useful to compare files that
|
---|
251 | should be identical except for language differences in the content
|
---|
252 | </para>
|
---|
253 | <indexterm zone="docbook-utils sgmldiff">
|
---|
254 | <primary sortas="b-sgmldiff">sgmldiff</primary>
|
---|
255 | </indexterm>
|
---|
256 | </listitem>
|
---|
257 | </varlistentry>
|
---|
258 |
|
---|
259 | </variablelist>
|
---|
260 |
|
---|
261 | </sect2>
|
---|
262 |
|
---|
263 | </sect1>
|
---|