Ignore:
Timestamp:
03/25/2020 12:06:24 PM (4 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
Children:
81a73ed8
Parents:
47274444
Message:

Format pst

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pst/sgml/docbook-utils.xml

    r47274444 rfa3edfef  
    3030    <title>Introduction to DocBook-utils</title>
    3131
    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>
     32    <para>
     33      The <application>DocBook-utils</application> package is a collection
     34      of utility scripts used to convert and analyze SGML documents in general,
     35      and DocBook files in particular. The scripts are used to convert from
     36      DocBook or other SGML formats into <quote>classical</quote> file formats
     37      like HTML, man, info, RTF and many more. There's also a utility to compare
     38      two SGML files and only display the differences in markup. This is useful
     39      for comparing documents prepared for different languages.
     40    </para>
    3941
    4042    &lfs91_checked;
     
    4345    <itemizedlist spacing="compact">
    4446      <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>
     47        <para>
     48          Download (HTTP): <ulink url="&docbook-utils-download-http;"/>
     49        </para>
     50      </listitem>
     51      <listitem>
     52        <para>
     53          Download (FTP): <ulink url="&docbook-utils-download-ftp;"/>
     54        </para>
     55      </listitem>
     56      <listitem>
     57        <para>
     58          Download MD5 sum: &docbook-utils-md5sum;
     59        </para>
     60      </listitem>
     61      <listitem>
     62        <para>
     63          Download size: &docbook-utils-size;
     64        </para>
     65      </listitem>
     66      <listitem>
     67        <para>
     68          Estimated disk space required: &docbook-utils-buildsize;
     69        </para>
     70      </listitem>
     71      <listitem>
     72        <para>
     73          Estimated build time: &docbook-utils-time;
     74        </para>
    6175      </listitem>
    6276    </itemizedlist>
     
    6579    <itemizedlist spacing='compact'>
    6680      <listitem>
    67         <para>Required patch: <ulink
    68         url="&patch-root;/docbook-utils-&docbook-utils-version;-grep_fix-1.patch"/></para>
     81        <para>
     82          Required patch: <ulink url=
     83           "&patch-root;/docbook-utils-&docbook-utils-version;-grep_fix-1.patch"/>
     84        </para>
    6985      </listitem>
    7086    </itemizedlist>
     
    97113    <title>Installation of DocBook-utils</title>
    98114
    99     <para>Install <application>DocBook-utils</application> by running the
    100     following commands:</para>
     115    <para>
     116      Install <application>DocBook-utils</application> by running the
     117      following commands:
     118    </para>
    101119
    102120<screen><userinput>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch &amp;&amp;
     
    106124make</userinput></screen>
    107125
    108     <para>This package does not come with a test suite.</para>
    109 
    110     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     126    <para>
     127      This package does not come with a test suite.
     128    </para>
     129
     130    <para>
     131      Now, as the <systemitem class="username">root</systemitem> user:
     132    </para>
    111133
    112134<screen role="root"><userinput>make docdir=/usr/share/doc install</userinput></screen>
    113135
    114     <para>Many packages use an alternate name for the
    115     <application>DocBook-utils</application> scripts. If you wish to create
    116     these alternate names, use the following command as
    117     the <systemitem class="username">root</systemitem> user:</para>
     136    <para>
     137      Many packages use an alternate name for the
     138      <application>DocBook-utils</application> scripts. If you wish to create
     139      these alternate names, use the following command as
     140      the <systemitem class="username">root</systemitem> user:
     141    </para>
    118142
    119143<screen role="root"><userinput>for doctype in html ps dvi man pdf rtf tex texi txt
     
    123147
    124148    <note>
    125       <para>The <command>jw</command> script uses the <command>which</command>
    126       command to locate required utilities. You must install
    127       <xref linkend="which"/> before attempting to use any of the
    128       <application>DocBook-utils</application> programs.</para>
     149      <para>
     150        The <command>jw</command> script uses the <command>which</command>
     151        command to locate required utilities. You must install
     152        <xref linkend="which"/> before attempting to use any of the
     153        <application>DocBook-utils</application> programs.
     154      </para>
    129155    </note>
    130156
     
    134160    <title>Command Explanations</title>
    135161
    136     <para><command>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch</command>:
    137     This patch corrects the syntax in the jw (Jade Wrapper) script which is at
    138     the heart of much db2* processing, so that the current version of
    139     <application>Grep</application> will not reject it.</para>
    140 
    141     <para><command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
    142     This command changes the installation directory of the HTML documents.</para>
    143 
    144     <para><option>docdir=/usr/share/doc</option>:
    145     This option is placed on the <command>make install</command> line because is is not
    146     recognized by <command>configure</command>.</para>
     162    <para>
     163      <command>patch -Np1 -i ../docbook-utils-&docbook-utils-version;-grep_fix-1.patch</command>:
     164      This patch corrects the syntax in the jw (Jade Wrapper) script which is
     165      at the heart of much db2* processing, so that the current version of
     166      <application>grep</application> will not reject it.
     167    </para>
     168
     169    <para>
     170      <command>sed -i 's:/html::' doc/HTML/Makefile.in</command>:
     171      This command changes the installation directory of the HTML documents.
     172    </para>
     173
     174    <para>
     175      <option>docdir=/usr/share/doc</option>: This option is placed on the
     176      <command>make install</command> line because is is not
     177      recognized by <command>configure</command>.
     178    </para>
    147179
    148180  </sect2>
     
    177209        <term><command>docbook2*</command></term>
    178210        <listitem>
    179           <para>are simple one-line wrapper scripts to <command>jw</command>.
    180           They are provided as easy-to-remember names used to convert DocBook or
    181           other SGML files to the respective format.</para>
     211          <para>
     212            are simple one-line wrapper scripts to <command>jw</command>.
     213            They are provided as easy-to-remember names used to convert
     214            DocBook or other SGML files to the respective format.
     215          </para>
    182216          <indexterm zone="docbook-utils docbook2">
    183217            <primary sortas="b-docbook2-star">docbook2*</primary>
     
    189223        <term><command>db2*</command></term>
    190224        <listitem>
    191           <para>are symlinks pointing at the respectively named
    192           <command>docbook2*</command> commands, created to satisfy some
    193           program's use of these names.</para>
     225          <para>
     226            are symlinks pointing at the respectively named
     227            <command>docbook2*</command> commands, created to satisfy some
     228            program's use of these names.
     229          </para>
    194230          <indexterm zone="docbook-utils db2">
    195231            <primary sortas="b-db2-star">db2*</primary>
     
    201237        <term><command>jw</command></term>
    202238        <listitem>
    203           <para>is a script used to convert DocBook or other SGML files to various
    204           output formats. It hides most of <application>OpenJade</application>'s
    205           complexity and adds comfortable features.</para>
     239          <para>
     240            is a script used to convert DocBook or other SGML files to various
     241            output formats. It hides most of
     242            <application>OpenJade</application>'s complexity and adds
     243            comfortable features.
     244          </para>
    206245          <indexterm zone="docbook-utils jw">
    207246            <primary sortas="b-jw">jw</primary>
     
    213252        <term><command>sgmldiff</command></term>
    214253        <listitem>
    215           <para>is used to compare two SGML files and only return the differences
    216           in the markup. This is especially useful to compare files that should be
    217           identical except for language differences in the content.</para>
     254          <para>
     255            is used to compare two SGML files and only return the differences
     256            in the markup. This is especially useful to compare files that
     257            should be identical except for language differences in the content.
     258          </para>
    218259          <indexterm zone="docbook-utils sgmldiff">
    219260            <primary sortas="b-sgmldiff">sgmldiff</primary>
Note: See TracChangeset for help on using the changeset viewer.