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

10.0 10.1 11.0 11.1 11.2 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since f5cdf41 was f5cdf41, checked in by Pierre Labastie <pieere@…>, 5 years ago

role="runtime|nodep" in pst

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

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