Added MD5 sum and indexing tags to DocBook-utils

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3356 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2005-01-29 16:43:47 +00:00
parent 5fbff85004
commit 2dde015f60
2 changed files with 85 additions and 37 deletions

View File

@ -23,7 +23,8 @@ who wrote what.</para>
<itemizedlist>
<listitem><para>January 29th, 2005 [randy]: Added vulnerability fix patch to
Bind instructions and bumped version entities to 9.3.0p1.</para></listitem>
Bind instructions and bumped version entities to 9.3.0p1; added MD5 sum to
DocBook-utils instructions.</para></listitem>
<listitem><para>January 28th, 2005 [randy]: Updated to hdparm-5.8,
Mozilla-1.7.5 and Nail-11.20; updated Enigmail version in Thunderbird

View File

@ -6,6 +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">
<!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 "125 KB">
<!ENTITY docbook-utils-buildsize "1.5 MB">
<!ENTITY docbook-utils-time ".04 SBU">
@ -18,6 +19,8 @@
</sect1info>
<?dbhtml filename="docbook-utils.html"?>
<title>DocBook-utils-&docbook-utils-version;</title>
<indexterm zone="docbook-utils">
<primary sortas="a-DocBook-utils">DocBook-utils</primary></indexterm>
<sect2>
<title>Introduction to <application>DocBook-utils</application></title>
@ -33,11 +36,18 @@ is useful for comparing documents prepared for different languages.</para>
<sect3><title>Package information</title>
<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 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>
<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>
</sect3>
<sect3><title><application>DocBook-utils</application> dependencies</title>
@ -45,7 +55,8 @@ is useful for comparing documents prepared for different languages.</para>
<sect4><title>Required</title>
<para><xref linkend="openjade"/>,
<xref linkend="docbook-dsssl"/> and
<xref linkend="sgml-dtd-3"/></para></sect4>
<xref linkend="sgml-dtd-3"/></para>
</sect4>
<sect4><title>Optional</title>
<para><xref linkend="jadetex"/> (for conversion to
@ -53,7 +64,8 @@ is useful for comparing documents prepared for different languages.</para>
<xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for conversion to
man and texinfo), and
<xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
(for conversion to <acronym>ASCII</acronym> text)</para></sect4>
(for conversion to <acronym>ASCII</acronym> text)</para>
</sect4>
</sect3>
</sect2>
@ -72,10 +84,10 @@ can determine if you need to remove these catalog definitions:</para>
<screen><userinput><command>grep "OpenSP-1.5.1" /etc/sgml/catalog</command></userinput></screen>
<para>If anything was returned, run the following command to remove
the catalog definitions:</para>
<para>If anything was returned, run the following command as the root user to
remove the catalog definitions:</para>
<screen><userinput><command>sed -i.orig \
<screen><userinput role='root'><command>sed -i.orig \
-e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
/etc/sgml/catalog \
/etc/sgml/sgml-docbook.cat</command></userinput></screen></note>
@ -84,14 +96,17 @@ the catalog definitions:</para>
following commands:</para>
<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
make</command></userinput></screen>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install</command></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><userinput><command>for doctype in html ps dvi man pdf rtf tex texi txt
<screen><userinput role='root'><command>for doctype in html ps dvi man pdf rtf tex texi txt
do
ln -s docbook2$doctype /usr/bin/db2$doctype
done</command></userinput></screen>
@ -101,38 +116,70 @@ done</command></userinput></screen>
<sect2>
<title>Contents</title>
<para>The <application>DocBook-utils</application> package contains
<command>docbook2dvi</command>, <command>docbook2html</command>,
<command>docbook2man</command>, <command>docbook2pdf</command>,
<command>docbook2ps</command>, <command>docbook2rtf</command>,
<command>docbook2tex</command>, <command>docbook2texi</command>,
<command>docbook2txt</command>, <command>jw</command> and
<command>sgmldiff</command>.</para>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<segtitle>Installed Symlinks</segtitle>
</sect2>
<seglistitem>
<seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw and sgmldiff</seg>
<seg>None</seg>
<seg>/usr/share/doc/html/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>
<sect2><title>Description</title>
</seglistitem>
</segmentedlist>
<sect3><title>docbook2{dvi,html,man,pdf,ps,rtf,tex,texi,txt}</title>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<para>The <command>docbook2{format}</command> scripts are simple one-line
wrappers to <command>jw</command>. They are provided as easy-to-remember
names used to convert DocBook or other <acronym>SGML</acronym> files to the
respective format.</para></sect3>
<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 <acronym>SGML</acronym> files to the respective format.</para>
<indexterm zone="docbook-utils docbook2">
<primary sortas="b-docbook2-star">docbook2*</primary>
</indexterm></listitem>
</varlistentry>
<sect3><title>jw</title>
<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 programs
use of these names.</para>
<indexterm zone="docbook-utils db2">
<primary sortas="g-db2-star">db2*</primary>
</indexterm></listitem>
</varlistentry>
<para><command>jw</command> is a script used to convert DocBook or other
<varlistentry id="jw">
<term><command>jw</command></term>
<listitem><para>is a script used to convert DocBook or other
<acronym>SGML</acronym> files to various output formats. It hides most of
<application>OpenJade</application>'s complexity and adds comfortable
features.</para></sect3>
features.</para>
<indexterm zone="docbook-utils jw">
<primary sortas="b-jw">jw</primary>
</indexterm></listitem>
</varlistentry>
<sect3><title>sgmldiff</title>
<para><command>sgmldiff</command> is used to compare two
<acronym>SGML</acronym> 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></sect3>
<varlistentry id="sgmldiff">
<term><command>sgmldiff</command></term>
<listitem><para>is used to compare two <acronym>SGML</acronym> 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>