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

10.0 10.1 11.0 11.1 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus nosym perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since f89fc45 was f89fc45, checked in by Ken Moffat <ken@…>, 7 years ago

more tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@15909 af4574ff-66df-0310-9fd7-8a98e5e911e0

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