Changeset 5bae145


Ignore:
Timestamp:
05/16/2005 03:38:09 PM (19 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 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, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
15201c6
Parents:
40d2307
Message:

Tagged docbook-utils.xml

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pst/sgml/docbook-utils.xml

    r40d2307 r5bae145  
    1414
    1515<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
    29 utility scripts used to convert and analyze <acronym>SGML</acronym> documents
    30 in general, and DocBook files in particular. The scripts are used to convert
    31 from 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
    35 is 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="which"/>,
    57 <xref linkend="openjade"/>,
    58 <xref linkend="docbook-dsssl"/> and
    59 <xref linkend="sgml-dtd-3"/></para>
    60 </sect4>
    61 
    62 <sect4><title>Optional</title>
    63 <para><xref linkend="jadetex"/> (for conversion to
    64 <acronym>DVI</acronym>, <acronym>PS</acronym> and <acronym>PDF</acronym>),
    65 <xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for conversion to
    66 man and texinfo), and 
    67 <xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
    68 (for conversion to <acronym>ASCII</acronym> text)</para>
    69 </sect4>
    70 </sect3>
    71 
    72 </sect2>
    73 
    74 <sect2>
    75 <title>Installation of <application>DocBook-utils</application></title>
    76 
    77 <note><para>Earlier versions of the <acronym>BLFS</acronym>
    78 <application>OpenSP</application> instructions installed a catalog
    79 containing an SGMLDECL <filename>unicode.sd</filename> declaration
    80 into the system <acronym>SGML</acronym> catalogs. This declaration
    81 causes some of the <application>OpenJade</application> programs to
    82 fail occasionally. You'll need to remove these catalog definitions
    83 if they exist, or the package build will fail. The following command
    84 can determine if you need to remove these catalog definitions:</para>
    85 
    86 <screen><userinput><command>grep "OpenSP-1.5.1" /etc/sgml/catalog</command></userinput></screen>
    87 
    88 <para>If anything was returned, run the following command as the root user to
    89 remove the catalog definitions:</para>
    90 
    91 <screen><userinput role='root'><command>sed -i.orig \
     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    <bridgehead renderas="sect3">Package Information</bridgehead>
     41    <itemizedlist spacing="compact">
     42      <listitem>
     43        <para>Download (HTTP): <ulink url="&docbook-utils-download-http;"/></para>
     44      </listitem>
     45      <listitem>
     46        <para>Download (FTP): <ulink url="&docbook-utils-download-ftp;"/></para>
     47      </listitem>
     48      <listitem>
     49        <para>Download MD5 sum: &docbook-utils-md5sum;</para>
     50      </listitem>
     51      <listitem>
     52        <para>Download size: &docbook-utils-size;</para>
     53      </listitem>
     54      <listitem>
     55        <para>Estimated disk space required: &docbook-utils-buildsize;</para>
     56      </listitem>
     57      <listitem>
     58        <para>Estimated build time: &docbook-utils-time;</para>
     59      </listitem>
     60    </itemizedlist>
     61
     62    <bridgehead renderas="sect3">DocBook-utils Dependencies</bridgehead>
     63
     64    <bridgehead renderas="sect4">Required</bridgehead>
     65    <para><xref linkend="which"/>,
     66    <xref linkend="openjade"/>,
     67    <xref linkend="docbook-dsssl"/> and
     68    <xref linkend="sgml-dtd-3"/></para>
     69
     70    <bridgehead renderas="sect4">Optional</bridgehead>
     71    <para><xref linkend="jadetex"/> (for conversion to DVI, PS and PDF),
     72    <xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version; (for
     73    conversion to man and texinfo), and
     74    <xref linkend="lynx"/> or <xref linkend="Links"/> or <xref linkend="w3m"/>
     75    (for conversion to ASCII text)</para>
     76
     77  </sect2>
     78
     79  <sect2 role="installation">
     80    <title>Installation of DocBook-utils</title>
     81
     82    <note>
     83      <para>Earlier versions of the BLFS <application>OpenSP</application>
     84      instructions installed a catalog containing an SGMLDECL
     85      <filename>unicode.sd</filename> declaration into the system SGML
     86      catalogs. This declaration causes some of the
     87      <application>OpenJade</application> programs to fail occasionally.
     88      You'll need to remove these catalog definitions if they exist, or
     89      the package build will fail. The following command can determine if
     90      you need to remove these catalog definitions:</para>
     91
     92<screen><userinput>grep "OpenSP-1.5.1" /etc/sgml/catalog</userinput></screen>
     93
     94      <para>If anything was returned, run the following command as the
     95      <systemitem class="username">root</systemitem> user to remove the
     96      catalog definitions:</para>
     97
     98<screen role="root"><userinput>sed -i.orig \
    9299    -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
    93100    /etc/sgml/catalog \
    94     /etc/sgml/sgml-docbook.cat</command></userinput></screen></note>
    95 
    96 <para>Install <application>DocBook-utils</application> by running the
    97 following commands:</para>
    98 
    99 <screen><userinput><command>./configure --prefix=/usr &amp;&amp;
    100 make</command></userinput></screen>
    101 
    102 <para>Now, as the root user:</para>
    103 
    104 <screen><userinput role='root'><command>make install</command></userinput></screen>
    105 
    106 <para>Many packages use an alternate name for the
    107 <application>DocBook-utils</application> scripts. If you wish to create these
    108 alternate names, use the following command:</para>
    109 
    110 <screen><userinput role='root'><command>for doctype in html ps dvi man pdf rtf tex texi txt
     101    /etc/sgml/sgml-docbook.cat</userinput></screen>
     102
     103    </note>
     104
     105    <para>Install <application>DocBook-utils</application> by running the
     106    following commands:</para>
     107
     108<screen><userinput>./configure --prefix=/usr &amp;&amp;
     109make</userinput></screen>
     110
     111    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     112
     113<screen role="root"><userinput>make install</userinput></screen>
     114
     115    <para>Many packages use an alternate name for the
     116    <application>DocBook-utils</application> scripts. If you wish to create
     117    these alternate names, use the following command:</para>
     118
     119<screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
    111120do
    112121    ln -s docbook2$doctype /usr/bin/db2$doctype
    113 done</command></userinput></screen>
    114 
    115 </sect2>
    116 
    117 <sect2>
    118 <title>Contents</title>
    119 
    120 <segmentedlist>
    121 <segtitle>Installed Programs</segtitle>
    122 <segtitle>Installed Libraries</segtitle>
    123 <segtitle>Installed Directories</segtitle>
    124 <segtitle>Installed Symlinks</segtitle>
    125 
    126 <seglistitem>
    127 <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
    128 docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw and sgmldiff</seg>
    129 <seg>None</seg>
    130 <seg>/usr/share/doc/html/docbook-utils-&docbook-utils-version; and
    131 /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
    132 <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi and
    133 db2txt</seg>
    134 
    135 </seglistitem>
    136 </segmentedlist>
    137 
    138 <variablelist>
    139 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
    140 <?dbfo list-presentation="list"?>
    141 
    142 <varlistentry id="docbook2">
    143 <term><command>docbook2*</command></term>
    144 <listitem><para>are simple one-line wrapper scripts to <command>jw</command>.
    145 They are provided as easy-to-remember names used to convert DocBook or
    146 other <acronym>SGML</acronym> files to the respective format.</para>
    147 <indexterm zone="docbook-utils docbook2">
    148 <primary sortas="b-docbook2-star">docbook2*</primary>
    149 </indexterm></listitem>
    150 </varlistentry>
    151 
    152 <varlistentry id="db2">
    153 <term><command>db2*</command></term>
    154 <listitem><para>are symlinks pointing at the respectively named
    155 <command>docbook2*</command> commands, created to satisfy some program's
    156 use of these names.</para>
    157 <indexterm zone="docbook-utils db2">
    158 <primary sortas="g-db2-star">db2*</primary>
    159 </indexterm></listitem>
    160 </varlistentry>
    161 
    162 <varlistentry id="jw">
    163 <term><command>jw</command></term>
    164 <listitem><para>is a script used to convert DocBook or other
    165 <acronym>SGML</acronym> files to various output formats. It hides most of
    166 <application>OpenJade</application>'s complexity and adds comfortable
    167 features.</para>
    168 <indexterm zone="docbook-utils jw">
    169 <primary sortas="b-jw">jw</primary>
    170 </indexterm></listitem>
    171 </varlistentry>
    172 
    173 <varlistentry id="sgmldiff">
    174 <term><command>sgmldiff</command></term>
    175 <listitem><para>is used to compare two <acronym>SGML</acronym> files and
    176 only return the differences in the markup. This is especially useful to
    177 compare files that should be identical except for language differences in the
    178 content.</para>
    179 <indexterm zone="docbook-utils sgmldiff">
    180 <primary sortas="b-sgmldiff">sgmldiff</primary>
    181 </indexterm></listitem>
    182 </varlistentry>
    183 </variablelist>
    184 
    185 </sect2>
     122done</userinput></screen>
     123
     124  </sect2>
     125
     126  <sect2 role="content">
     127    <title>Contents</title>
     128
     129    <segmentedlist>
     130      <segtitle>Installed Programs</segtitle>
     131      <segtitle>Installed Libraries</segtitle>
     132      <segtitle>Installed Directories</segtitle>
     133      <segtitle>Installed Symlinks</segtitle>
     134
     135      <seglistitem>
     136        <seg>docbook2dvi, docbook2html, docbook2man, docbook2pdf, docbook2ps,
     137        docbook2rtf, docbook2tex, docbook2texi, docbook2txt, jw, and
     138        sgmldiff</seg>
     139        <seg>None</seg>
     140        <seg>/usr/share/doc/html/docbook-utils-&docbook-utils-version; and
     141        /usr/share/sgml/docbook/utils-&docbook-utils-version;</seg>
     142        <seg>db2dvi, db2html, db2man, db2pdf, db2ps, db2rtf, db2tex, db2texi,
     143        and db2txt</seg>
     144      </seglistitem>
     145    </segmentedlist>
     146
     147    <variablelist>
     148      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     149      <?dbfo list-presentation="list"?>
     150      <?dbhtml list-presentation="table"?>
     151
     152      <varlistentry id="docbook2">
     153        <term><command>docbook2*</command></term>
     154        <listitem>
     155          <para>are simple one-line wrapper scripts to <command>jw</command>.
     156          They are provided as easy-to-remember names used to convert DocBook or
     157          other SGML files to the respective format.</para>
     158          <indexterm zone="docbook-utils docbook2">
     159            <primary sortas="b-docbook2-star">docbook2*</primary>
     160          </indexterm>
     161        </listitem>
     162      </varlistentry>
     163
     164      <varlistentry id="db2">
     165        <term><command>db2*</command></term>
     166        <listitem>
     167          <para>are symlinks pointing at the respectively named
     168          <command>docbook2*</command> commands, created to satisfy some
     169          program's use of these names.</para>
     170          <indexterm zone="docbook-utils db2">
     171            <primary sortas="g-db2-star">db2*</primary>
     172          </indexterm>
     173        </listitem>
     174      </varlistentry>
     175
     176      <varlistentry id="jw">
     177        <term><command>jw</command></term>
     178        <listitem>
     179          <para>is a script used to convert DocBook or other SGML files to various
     180          output formats. It hides most of <application>OpenJade</application>'s
     181          complexity and adds comfortable features.</para>
     182          <indexterm zone="docbook-utils jw">
     183            <primary sortas="b-jw">jw</primary>
     184          </indexterm>
     185        </listitem>
     186      </varlistentry>
     187
     188      <varlistentry id="sgmldiff">
     189        <term><command>sgmldiff</command></term>
     190        <listitem>
     191          <para>is used to compare two SGML files and only return the differences
     192          in the markup. This is especially useful to compare files that should be
     193          identical except for language differences in the content.</para>
     194          <indexterm zone="docbook-utils sgmldiff">
     195            <primary sortas="b-sgmldiff">sgmldiff</primary>
     196          </indexterm>
     197        </listitem>
     198      </varlistentry>
     199
     200    </variablelist>
     201
     202  </sect2>
    186203
    187204</sect1>
    188 
Note: See TracChangeset for help on using the changeset viewer.