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

10.0 10.1 11.0 11.1 11.2 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since e8b9dbf was e8b9dbf, checked in by Randy McMurchy <randy@…>, 18 years ago

Updated build entities in DocBook-utils instructions; added a note to the Fontconfig instructions to have the SGMLSpm Perl module installed if DocBook-utils is installed

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

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