mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-25 07:42:13 +08:00
0dddae09e3
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8431 af4574ff-66df-0310-9fd7-8a98e5e911e0
231 lines
8.6 KiB
XML
231 lines
8.6 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY docbook-utils-download-http "http://sources-redhat.mirrors.redwire.net/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
|
<!ENTITY docbook-utils-download-ftp "ftp://sources.redhat.com/pub/docbook-tools/new-trials/SOURCES/docbook-utils-&docbook-utils-version;.tar.gz">
|
|
<!ENTITY docbook-utils-md5sum "6b41b18c365c01f225bc417cf632d81c">
|
|
<!ENTITY docbook-utils-size "124 KB">
|
|
<!ENTITY docbook-utils-buildsize "1.44 MB">
|
|
<!ENTITY docbook-utils-time "less than 0.1 SBU">
|
|
]>
|
|
|
|
<sect1 id="docbook-utils" xreflabel="DocBook-utils-&docbook-utils-version;">
|
|
<?dbhtml filename="docbook-utils.html"?>
|
|
|
|
<sect1info>
|
|
<othername>$LastChangedBy$</othername>
|
|
<date>$Date$</date>
|
|
</sect1info>
|
|
|
|
<title>DocBook-utils-&docbook-utils-version;</title>
|
|
|
|
<indexterm zone="docbook-utils">
|
|
<primary sortas="a-DocBook-utils">DocBook-utils</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to DocBook-utils</title>
|
|
|
|
<para>The <application>DocBook-utils</application> package is a collection
|
|
of utility scripts used to convert and analyze SGML documents in general,
|
|
and DocBook files in particular. The scripts are used to convert from
|
|
DocBook or other SGML formats into <quote>classical</quote> file formats
|
|
like HTML, man, info, RTF and many more. There's also a utility to compare
|
|
two SGML files and only display the differences in markup. This is useful
|
|
for comparing documents prepared for different languages.</para>
|
|
|
|
&lfs65_checked;
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>Download (HTTP): <ulink url="&docbook-utils-download-http;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download (FTP): <ulink url="&docbook-utils-download-ftp;"/></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download MD5 sum: &docbook-utils-md5sum;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Download size: &docbook-utils-size;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated disk space required: &docbook-utils-buildsize;</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Estimated build time: &docbook-utils-time;</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">DocBook-utils Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Required</bridgehead>
|
|
<para role="required"><xref linkend="openjade"/>,
|
|
<xref linkend="docbook-dsssl"/>, and
|
|
<xref linkend="sgml-dtd-3"/></para>
|
|
|
|
<bridgehead renderas="sect4">Optional (Runtime Dependencies Only)</bridgehead>
|
|
<para role="optional"><xref linkend="jadetex"/> (for conversion to DVI, PS and PDF),
|
|
<xref linkend="perl-sgmlspm"/> (for conversion to man and texinfo), and
|
|
<xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
|
|
(for conversion to ASCII text)</para>
|
|
|
|
<para condition="html" role="usernotes">User Notes:
|
|
<ulink url="&blfs-wiki;/docbook-utils"/></para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of DocBook-utils</title>
|
|
|
|
<!-- This shouldn't be required any longer as the OpenSP catalog stuff
|
|
was removed from BLFS two revisions ago.
|
|
|
|
<note>
|
|
<para>Earlier versions of the BLFS <application>OpenSP</application>
|
|
instructions installed a catalog containing an SGMLDECL
|
|
<filename>unicode.sd</filename> declaration into the system SGML
|
|
catalogs. This declaration causes some of the
|
|
<application>OpenJade</application> programs to fail occasionally.
|
|
You'll need to remove these catalog definitions if they exist, or
|
|
the package build will fail. The following command can determine if
|
|
you need to remove these catalog definitions:</para>
|
|
|
|
<screen><userinput>grep "OpenSP-1.5.1" /etc/sgml/catalog</userinput></screen>
|
|
|
|
<para>If anything was returned, run the following command as the
|
|
<systemitem class="username">root</systemitem> user to remove the
|
|
catalog definitions:</para>
|
|
|
|
<screen role="root"><userinput>sed -i.orig \
|
|
-e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
|
/etc/sgml/catalog \
|
|
/etc/sgml/sgml-docbook.cat</userinput></screen>
|
|
|
|
</note>
|
|
|
|
-->
|
|
|
|
<para>Install <application>DocBook-utils</application> by running the
|
|
following commands:</para>
|
|
|
|
<screen><userinput>sed -i 's:/html::' doc/HTML/Makefile.in &&
|
|
./configure --prefix=/usr &&
|
|
make</userinput></screen>
|
|
|
|
<para>This package does not come with a test suite.</para>
|
|
|
|
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|
|
|
<screen role="root"><userinput>make install</userinput></screen>
|
|
|
|
<para>Many packages use an alternate name for the
|
|
<application>DocBook-utils</application> scripts. If you wish to create
|
|
these alternate names, use the following command:</para>
|
|
|
|
<screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
|
|
do
|
|
ln -s docbook2$doctype /usr/bin/db2$doctype
|
|
done</userinput></screen>
|
|
|
|
<note>
|
|
<para>The <command>jw</command> script uses the <command>which</command>
|
|
command to locate required utilities. You must install
|
|
<xref linkend="which"/> before attempting to use any of the
|
|
<application>DocBook-utils</application> programs.</para>
|
|
</note>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<para><command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
|
|
This command changes the installation directory of the HTML documents.</para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Libraries</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
<segtitle>Installed Symlinks</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
|
|
docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and
|
|
sgmldiff</seg>
|
|
<seg>None</seg>
|
|
<seg>/usr/share/doc/docbook-utils-&docbook-utils-version; and
|
|
/usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
|
|
<seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi,
|
|
and db2txt</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="docbook2">
|
|
<term><command>docbook2*</command></term>
|
|
<listitem>
|
|
<para>are simple one-line wrapper scripts to <command>jw</command>.
|
|
They are provided as easy-to-remember names used to convert DocBook or
|
|
other SGML files to the respective format.</para>
|
|
<indexterm zone="docbook-utils docbook2">
|
|
<primary sortas="b-docbook2-star">docbook2*</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="db2">
|
|
<term><command>db2*</command></term>
|
|
<listitem>
|
|
<para>are symlinks pointing at the respectively named
|
|
<command>docbook2*</command> commands, created to satisfy some
|
|
program's use of these names.</para>
|
|
<indexterm zone="docbook-utils db2">
|
|
<primary sortas="g-db2-star">db2*</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="jw">
|
|
<term><command>jw</command></term>
|
|
<listitem>
|
|
<para>is a script used to convert DocBook or other SGML files to various
|
|
output formats. It hides most of <application>OpenJade</application>'s
|
|
complexity and adds comfortable features.</para>
|
|
<indexterm zone="docbook-utils jw">
|
|
<primary sortas="b-jw">jw</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="sgmldiff">
|
|
<term><command>sgmldiff</command></term>
|
|
<listitem>
|
|
<para>is used to compare two SGML files and only return the differences
|
|
in the markup. This is especially useful to compare files that should be
|
|
identical except for language differences in the content.</para>
|
|
<indexterm zone="docbook-utils sgmldiff">
|
|
<primary sortas="b-sgmldiff">sgmldiff</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|