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

11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since f429481 was c93c620c, checked in by Bruce Dubbs <bdubbs@…>, 9 months ago

Tags

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