Changeset 2fa922f


Ignore:
Timestamp:
02/06/2006 08:45:42 PM (18 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
Branches:
10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
Children:
1ca11cd
Parents:
cf7142a
Message:

Indenting chapter 6, part 8

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7358 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

Location:
chapter06
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • chapter06/man-db.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-man-db" role="wrap">
    7 <title>Man-DB-&man-db-version;</title>
    8 <?dbhtml filename="man-db.html"?>
    9 
    10 <indexterm zone="ch-system-man-db"><primary sortas="a-Man-DB">Man-DB</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Man-DB package contains programs for finding and viewing man pages.</para>
    14 
    15 <segmentedlist>
    16 <segtitle>&buildtime;</segtitle>
    17 <segtitle>&diskspace;</segtitle>
    18 <seglistitem><seg>0.1 SBU</seg><seg>1.1 MB</seg></seglistitem>
    19 </segmentedlist>
    20 
    21 <segmentedlist>
    22 <segtitle>&dependencies;</segtitle>
    23 <seglistitem><seg>Bash, Berkeley DB, Binutils, Coreutils, Gawk, GCC,
    24 Gettext, Glibc, Grep, Make, and Sed</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
    27 
    28 <sect2 role="installation">
    29 <title>Installation of Man-DB</title>
    30 
    31 <para>Three adjustments need to be made to the sources of Man-DB.</para>
    32 
    33 <para>The first one changes the location of translated manual pages that come
    34 with Man-DB, in order for them to be accessible in both traditional and
    35 UTF-8 locales:</para>
     9  <?dbhtml filename="man-db.html"?>
     10
     11  <title>Man-DB-&man-db-version;</title>
     12
     13  <indexterm zone="ch-system-man-db">
     14    <primary sortas="a-Man-DB">Man-DB</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Man-DB package contains programs for finding and viewing man
     21    pages.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>1.1 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Berkeley DB, Binutils, Coreutils, Gawk, GCC, Gettext,
     38        Glibc, Grep, Make, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Man-DB</title>
     46
     47    <para>Three adjustments need to be made to the sources of Man-DB.</para>
     48
     49    <para>The first one changes the location of translated manual pages that come
     50    with Man-DB, in order for them to be accessible in both traditional and
     51    UTF-8 locales:</para>
    3652
    3753<screen><userinput>mv man/de{_DE.88591,} &amp;&amp;
    … …  
    4157sed -i 's,\*_\*,??,' man/Makefile.in</userinput></screen>
    4258
    43 <para>The second change is a <command>sed</command> substitution to delete the
    44 <quote>/usr/man</quote> lines in the
    45 <filename>man_db.conf</filename> file to prevent redundant results when
    46 using programs such as <command>whatis</command>:</para>
     59    <para>The second change is a <command>sed</command> substitution to delete
     60    the <quote>/usr/man</quote> lines in the <filename>man_db.conf</filename>
     61    file to prevent redundant results when using programs such as
     62    <command>whatis</command>:</para>
    4763
    4864<screen><userinput>sed -i '/\t\/usr\/man/d' src/man_db.conf.in</userinput></screen>
    4965
    50 <para>The third change accounts for programs that Man-DB should be able
    51 to find at runtime, but that haven't been installed yet:</para>
     66    <para>The third change accounts for programs that Man-DB should be able
     67    to find at runtime, but that haven't been installed yet:</para>
    5268
    5369<screen><userinput>cat &gt;&gt;include/manconfig.h.in &lt;&lt;"EOF"
    … …  
    5874EOF</userinput></screen>
    5975
    60 <para>The <command>col</command> program is a part of the Util-linux package,
    61 <command>lynx</command> is a text-based web browser
    62 (see BLFS for installation instructions),
    63 <command>vgrind</command> converts program sources to Groff input,
    64 and <command>grap</command> is useful for typesetting graphs in Groff documents.
    65 The <command>vgrind</command> and <command>grap</command> programs are
    66 not normally needed for viewing manual pages. They are
    67 not part of LFS or BLFS, but you should be able to install them yourself
    68 after finishing LFS if you wish to do so.</para>
    69 
    70 <para>Prepare Man-DB for compilation:</para>
     76    <para>The <command>col</command> program is a part of the Util-linux
     77    package, <command>lynx</command> is a text-based web browser (see BLFS
     78    for installation instructions), <command>vgrind</command> converts
     79    program sources to Groff input, and <command>grap</command> is useful
     80    for typesetting graphs in Groff documents. The <command>vgrind</command>
     81    and <command>grap</command> programs are not normally needed for viewing
     82    manual pages. They are not part of LFS or BLFS, but you should be able
     83    to install them yourself after finishing LFS if you wish to do so.</para>
     84
     85    <para>Prepare Man-DB for compilation:</para>
    7186
    7287<screen><userinput>./configure --prefix=/usr --enable-mb-groff --disable-setuid</userinput></screen>
    7388
    74 <para>The meaning of the configure options:</para>
    75 
    76 <variablelist>
    77 <varlistentry>
    78 <term><parameter>--enable-mb-groff</parameter></term>
    79 <listitem><para>This tells the <command>man</command> program to
    80 use the <quote>ascii8</quote> and <quote>nippon</quote> Groff devices for formatting non-ISO-8859-1
    81 manual pages.</para></listitem>
    82 </varlistentry>
    83 <varlistentry>
    84 <term><parameter>--disable-setuid</parameter></term>
    85 <listitem><para>This disables making the <command>man</command> program
    86 setuid to user <quote>man</quote>.</para></listitem>
    87 </varlistentry>
    88 </variablelist>
    89 
    90 <para>Compile the package:</para>
     89    <variablelist>
     90      <title>The meaning of the configure options:</title>
     91
     92      <varlistentry>
     93        <term><parameter>--enable-mb-groff</parameter></term>
     94        <listitem>
     95          <para>This tells the <command>man</command> program to use the
     96          <quote>ascii8</quote> and <quote>nippon</quote> Groff devices for
     97          formatting non-ISO-8859-1 manual pages.</para>
     98        </listitem>
     99      </varlistentry>
     100
     101      <varlistentry>
     102        <term><parameter>--disable-setuid</parameter></term>
     103        <listitem>
     104          <para>This disables making the <command>man</command> program setuid
     105          to user <systemitem class="username">man</systemitem>.</para>
     106        </listitem>
     107      </varlistentry>
     108
     109    </variablelist>
     110
     111    <para>Compile the package:</para>
    91112
    92113<screen><userinput>make</userinput></screen>
    93114
    94 <para>Install the package:</para>
     115    <para>Install the package:</para>
    95116
    96117<screen><userinput>make install</userinput></screen>
    97118
    98 <para>Additional information regarding the compression of
    99 man and info pages can be found in the BLFS book at
    100 <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
    101 
    102 </sect2>
    103 
    104 <sect2><title>Non-English Manual Pages in LFS</title>
    105 
    106 <para>Linux distributions have different policies concerning the character
    107 encoding in which manual pages are stored in the filesystem. E.g., RedHat
    108 stores all manual pages in UTF-8, while Debian uses language-specific
    109 (mostly 8-bit) encodings. This leads to incompatibility of packages with
    110 manual pages designed for different distributions.</para>
    111 
    112 <para>LFS uses the same conventions as Debian. The relationship between
    113 language codes and the expected encoding of manual pages is listed below.
    114 Man-DB automatically converts them to the locale encoding while viewing.</para>
    115 
    116 <!-- Origin: man-db-2.4.3/src/encodings.c -->
    117 <table frame='all'><title>Expected character encoding of manual pages</title>
    118 <tgroup cols='2' align='center' colsep='1' rowsep='1'>
    119 <thead>
    120 <row><entry>Language (code)</entry><entry>Encoding</entry></row>
    121 </thead>
    122 <tbody>
    123 <row><entry>Danish (da)</entry><entry>ISO-8859-1</entry></row>
    124 <row><entry>German (de)</entry><entry>ISO-8859-1</entry></row>
    125 <row><entry>English (en)</entry><entry>ISO-8859-1</entry></row>
    126 <row><entry>Spanish (es)</entry><entry>ISO-8859-1</entry></row>
    127 <row><entry>Finnish (fi)</entry><entry>ISO-8859-1</entry></row>
    128 <row><entry>French (fr)</entry><entry>ISO-8859-1</entry></row>
    129 <row><entry>Irish (ga)</entry><entry>ISO-8859-1</entry></row>
    130 <row><entry>Galician (gl)</entry><entry>ISO-8859-1</entry></row>
    131 <row><entry>Indonesian (id)</entry><entry>ISO-8859-1</entry></row>
    132 <row><entry>Icelandic (is)</entry><entry>ISO-8859-1</entry></row>
    133 <row><entry>Italian (it)</entry><entry>ISO-8859-1</entry></row>
    134 <row><entry>Dutch (nl)</entry><entry>ISO-8859-1</entry></row>
    135 <!-- BUG: "no" is deprecated, should use "nb" or "nn" and symlinks -->
    136 <row><entry>Norwegian (no)</entry><entry>ISO-8859-1</entry></row>
    137 <!-- END BUG -->
    138 <row><entry>Portuguese (pt)</entry><entry>ISO-8859-1</entry></row>
    139 <row><entry>Swedish (sv)</entry><entry>ISO-8859-1</entry></row>
    140 <!-- Languages below require patched groff -->
    141 <row><entry>Czech (cs)</entry><entry>ISO-8859-2</entry></row>
    142 <row><entry>Croatian (hr)</entry><entry>ISO-8859-2</entry></row>
    143 <row><entry>Hungarian (hu)</entry><entry>ISO-8859-2</entry></row>
    144 <row><entry>Japanese (ja)</entry><entry>EUC-JP</entry></row>
    145 <row><entry>Korean (ko)</entry><entry>EUC-KR</entry></row>
    146 <row><entry>Polish (pl)</entry><entry>ISO-8859-2</entry></row>
    147 <row><entry>Russian (ru)</entry><entry>KOI8-R</entry></row>
    148 <row><entry>Slovak (sk)</entry><entry>ISO-8859-2</entry></row>
    149 <row><entry>Turkish (tr)</entry><entry>ISO-8859-9</entry></row>
    150 </tbody>
    151 </tgroup>
    152 </table>
    153 
    154 <note><para>Manual pages in languages not in the list are not supported.
    155 Norwegian doesn't work now because of the transition from no_NO to nb_NO
    156 locale, and Korean is non-functional because of the incomplete Groff patch.
    157 </para></note>
    158 
    159 <para>If upstream distributes the manual pages in the same encoding as
    160 Man-DB expects, the manual pages can be copied to
    161 <filename class="directory">/usr/share/man/<replaceable>[language code]</replaceable></filename>.
    162 E.g., French manual pages
    163 (<ulink url="http://ccb.club.fr/man/man-fr-1.58.0.tar.bz2"/>)
    164 can be installed with the following command:</para>
     119    <para>Additional information regarding the compression of
     120    man and info pages can be found in the BLFS book at
     121    <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
     122
     123  </sect2>
     124
     125  <sect2>
     126    <title>Non-English Manual Pages in LFS</title>
     127
     128    <para>Linux distributions have different policies concerning the character
     129    encoding in which manual pages are stored in the filesystem. E.g., RedHat
     130    stores all manual pages in UTF-8, while Debian uses language-specific
     131    (mostly 8-bit) encodings. This leads to incompatibility of packages with
     132    manual pages designed for different distributions.</para>
     133
     134    <para>LFS uses the same conventions as Debian. The relationship between
     135    language codes and the expected encoding of manual pages is listed below.
     136    Man-DB automatically converts them to the locale encoding while viewing.</para>
     137
     138    <!-- Origin: man-db-2.4.3/src/encodings.c -->
     139    <table>
     140      <title>Expected character encoding of manual pages</title>
     141
     142      <tgroup cols="2">
     143
     144        <thead>
     145          <row>
     146            <entry>Language (code)</entry>
     147            <entry>Encoding</entry>
     148          </row>
     149        </thead>
     150
     151        <tbody>
     152          <row>
     153            <entry>Danish (da)</entry>
     154            <entry>ISO-8859-1</entry>
     155          </row>
     156          <row>
     157            <entry>German (de)</entry>
     158            <entry>ISO-8859-1</entry>
     159          </row>
     160          <row>
     161            <entry>English (en)</entry>
     162            <entry>ISO-8859-1</entry>
     163          </row>
     164          <row>
     165            <entry>Spanish (es)</entry>
     166            <entry>ISO-8859-1</entry>
     167          </row>
     168          <row>
     169            <entry>Finnish (fi)</entry>
     170            <entry>ISO-8859-1</entry>
     171          </row>
     172          <row>
     173            <entry>French (fr)</entry>
     174            <entry>ISO-8859-1</entry>
     175          </row>
     176          <row>
     177            <entry>Irish (ga)</entry>
     178            <entry>ISO-8859-1</entry>
     179          </row>
     180          <row>
     181            <entry>Galician (gl)</entry>
     182            <entry>ISO-8859-1</entry>
     183          </row>
     184          <row>
     185            <entry>Indonesian (id)</entry>
     186            <entry>ISO-8859-1</entry>
     187          </row>
     188          <row>
     189            <entry>Icelandic (is)</entry>
     190            <entry>ISO-8859-1</entry>
     191          </row>
     192          <row>
     193            <entry>Italian (it)</entry>
     194            <entry>ISO-8859-1</entry>
     195          </row>
     196          <row>
     197            <entry>Dutch (nl)</entry>
     198            <entry>ISO-8859-1</entry>
     199          </row>
     200          <!-- BUG: "no" is deprecated, should use "nb" or "nn" and symlinks -->
     201          <row>
     202            <entry>Norwegian (no)</entry>
     203            <entry>ISO-8859-1</entry>
     204          </row>
     205          <!-- END BUG -->
     206          <row>
     207            <entry>Portuguese (pt)</entry>
     208            <entry>ISO-8859-1</entry>
     209          </row>
     210          <row>
     211            <entry>Swedish (sv)</entry>
     212            <entry>ISO-8859-1</entry>
     213          </row>
     214          <!-- Languages below require patched groff -->
     215          <row>
     216            <entry>Czech (cs)</entry>
     217            <entry>ISO-8859-2</entry>
     218          </row>
     219          <row>
     220            <entry>Croatian (hr)</entry>
     221            <entry>ISO-8859-2</entry>
     222          </row>
     223          <row>
     224            <entry>Hungarian (hu)</entry>
     225            <entry>ISO-8859-2</entry>
     226          </row>
     227          <row>
     228            <entry>Japanese (ja)</entry>
     229            <entry>EUC-JP</entry>
     230          </row>
     231          <row>
     232            <entry>Korean (ko)</entry>
     233            <entry>EUC-KR</entry>
     234          </row>
     235          <row>
     236            <entry>Polish (pl)</entry>
     237            <entry>ISO-8859-2</entry>
     238          </row>
     239          <row>
     240            <entry>Russian (ru)</entry>
     241            <entry>KOI8-R</entry>
     242          </row>
     243          <row>
     244            <entry>Slovak (sk)</entry>
     245            <entry>ISO-8859-2</entry>
     246          </row>
     247          <row>
     248            <entry>Turkish (tr)</entry>
     249            <entry>ISO-8859-9</entry>
     250          </row>
     251        </tbody>
     252
     253      </tgroup>
     254
     255    </table>
     256
     257    <note>
     258      <para>Manual pages in languages not in the list are not supported.
     259      Norwegian doesn't work now because of the transition from no_NO to
     260      nb_NO locale, and Korean is non-functional because of the incomplete
     261      Groff patch.</para>
     262    </note>
     263
     264    <para>If upstream distributes the manual pages in the same encoding
     265    as Man-DB expects, the manual pages can be copied to
     266    <filename class="directory">/usr/share/man/<replaceable>[language
     267    code]</replaceable></filename>. E.g., French manual pages
     268    (<ulink url="http://ccb.club.fr/man/man-fr-1.58.0.tar.bz2"/>) can be
     269    installed with the following command:</para>
    165270
    166271<screen role="nodump"><userinput>mkdir -p /usr/share/man/fr &amp;&amp;
    167272cp -rv man? /usr/share/man/fr</userinput></screen>
    168273
    169 <para>If upstream distributes manual pages in UTF-8 (i.e., <quote>for RedHat</quote>)
    170 instead of the encoding listed in the table above, they have to be
    171 converted from UTF-8 to the encoding listed in the table before
    172 installation. E.g., Spanish manual pages
    173 (<ulink url="http://ditec.um.es/~piernas/manpages-es/man-pages-es-1.55.tar.bz2"/>)
    174 can be installed with the following commands:</para>
     274    <para>If upstream distributes manual pages in UTF-8 (i.e., <quote>for
     275    RedHat</quote>) instead of the encoding listed in the table above, they
     276    have to be converted from UTF-8 to the encoding listed in the table before
     277    installation. E.g., Spanish manual pages (<ulink
     278    url="http://ditec.um.es/~piernas/manpages-es/man-pages-es-1.55.tar.bz2"/>)
     279    can be installed with the following commands:</para>
    175280
    176281<screen role="nodump"><userinput>mkdir -p /usr/share/man/es &amp;&amp;
    177282find man? -type f | grep -v 'man7/iso_8859-7.7' | \
    178283while read F ; do
    179         iconv -f UTF-8 -t ISO-8859-1 $F >tmp ; mv tmp $F
     284  iconv -f UTF-8 -t ISO-8859-1 $F >tmp ; mv tmp $F
    180285done &amp;&amp;
    181286cp -rv man? /usr/share/man/es</userinput></screen>
    182287
    183 <note><para>The need to exclude the <filename>man7/iso_8859-7.7</filename> file
    184 from the conversion process because it is already in ISO-8859-1 is a packaging
    185 bug in man-pages-es-1.55. Future versions should not require this workaround.</para></note>
    186 
    187 </sect2>
    188 
    189 <sect2 id="contents-man-db" role="content"><title>Contents of Man-DB</title>
    190 
    191 <segmentedlist>
    192 <segtitle>Installed programs</segtitle>
    193 <seglistitem><seg>accessdb, apropos, catman, lexgrog, man, mandb, manpath,
    194 and whatis</seg></seglistitem>
    195 </segmentedlist>
    196 
    197 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    198 <?dbfo list-presentation="list"?>
    199 <?dbhtml list-presentation="table"?>
    200 
    201 
    202 <varlistentry id="accessdb">
    203 <term><command>accessdb</command></term>
    204 <listitem>
    205 <para>Dumps the <command>whatis</command> database contents in human-readable form</para>
    206 <indexterm zone="ch-system-man-db accessdb"><primary sortas="b-accessdb">accessdb</primary></indexterm>
    207 </listitem>
    208 </varlistentry>
    209 
    210 <varlistentry id="apropos">
    211 <term><command>apropos</command></term>
    212 <listitem>
    213 <para>Searches the <command>whatis</command> database and displays the short descriptions
    214 of system commands that contain a given string</para>
    215 <indexterm zone="ch-system-man-db apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
    216 </listitem>
    217 </varlistentry>
    218 
    219 <varlistentry id="catman">
    220 <term><command>catman</command></term>
    221 <listitem>
    222 <para>Creates or updates the pre-formatted manual pages</para>
    223 <indexterm zone="ch-system-man-db catman"><primary sortas="b-catman">catman</primary></indexterm>
    224 </listitem>
    225 </varlistentry>
    226 
    227 <varlistentry id="lexgrog">
    228 <term><command>lexgrog</command></term>
    229 <listitem>
    230 <para>Displays one-line summary information about a given manual page</para>
    231 <indexterm zone="ch-system-man-db lexgrog"><primary sortas="b-lexgrog">lexgrog</primary></indexterm>
    232 </listitem>
    233 </varlistentry>
    234 
    235 <varlistentry id="man">
    236 <term><command>man</command></term>
    237 <listitem>
    238 <para>Formats and displays the requested manual page</para>
    239 <indexterm zone="ch-system-man-db man"><primary sortas="b-man">man</primary></indexterm>
    240 </listitem>
    241 </varlistentry>
    242 
    243 <varlistentry id="mandb">
    244 <term><command>mandb</command></term>
    245 <listitem>
    246 <para>Creates or updates the <command>whatis</command> database</para>
    247 <indexterm zone="ch-system-man-db mandb"><primary sortas="b-mandb">mandb</primary></indexterm>
    248 </listitem>
    249 </varlistentry>
    250 
    251 <varlistentry id="whatis">
    252 <term><command>whatis</command></term>
    253 <listitem>
    254 <para>Searches the <command>whatis</command> database and displays the short descriptions
    255 of system commands that contain the given keyword as a separate
    256 word</para>
    257 <indexterm zone="ch-system-man-db whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
    258 </listitem>
    259 </varlistentry>
    260 </variablelist>
    261 
    262 </sect2>
     288    <note>
     289      <para>The need to exclude the <filename>man7/iso_8859-7.7</filename> file
     290      from the conversion process because it is already in ISO-8859-1 is a
     291      packaging bug in man-pages-es-1.55. Future versions should not require
     292      this workaround.</para>
     293    </note>
     294
     295  </sect2>
     296
     297  <sect2 id="contents-man-db" role="content">
     298    <title>Contents of Man-DB</title>
     299
     300    <segmentedlist>
     301      <segtitle>Installed programs</segtitle>
     302
     303      <seglistitem>
     304        <seg>accessdb, apropos, catman, lexgrog, man, mandb, manpath,
     305        and whatis</seg>
     306      </seglistitem>
     307    </segmentedlist>
     308
     309    <variablelist>
     310      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     311      <?dbfo list-presentation="list"?>
     312      <?dbhtml list-presentation="table"?>
     313
     314      <varlistentry id="accessdb">
     315        <term><command>accessdb</command></term>
     316        <listitem>
     317          <para>Dumps the <command>whatis</command> database contents in
     318          human-readable form</para>
     319          <indexterm zone="ch-system-man-db accessdb">
     320            <primary sortas="b-accessdb">accessdb</primary>
     321          </indexterm>
     322        </listitem>
     323      </varlistentry>
     324
     325      <varlistentry id="apropos">
     326        <term><command>apropos</command></term>
     327        <listitem>
     328          <para>Searches the <command>whatis</command> database and displays
     329          the short descriptions of system commands that contain a given
     330          string</para>
     331          <indexterm zone="ch-system-man-db apropos">
     332            <primary sortas="b-apropos">apropos</primary>
     333          </indexterm>
     334        </listitem>
     335      </varlistentry>
     336
     337      <varlistentry id="catman">
     338        <term><command>catman</command></term>
     339        <listitem>
     340          <para>Creates or updates the pre-formatted manual pages</para>
     341          <indexterm zone="ch-system-man-db catman">
     342            <primary sortas="b-catman">catman</primary>
     343          </indexterm>
     344        </listitem>
     345      </varlistentry>
     346
     347      <varlistentry id="lexgrog">
     348        <term><command>lexgrog</command></term>
     349        <listitem>
     350          <para>Displays one-line summary information about a given manual
     351          page</para>
     352          <indexterm zone="ch-system-man-db lexgrog">
     353            <primary sortas="b-lexgrog">lexgrog</primary>
     354          </indexterm>
     355        </listitem>
     356      </varlistentry>
     357
     358      <varlistentry id="man">
     359        <term><command>man</command></term>
     360        <listitem>
     361          <para>Formats and displays the requested manual page</para>
     362          <indexterm zone="ch-system-man-db man">
     363            <primary sortas="b-man">man</primary>
     364          </indexterm>
     365        </listitem>
     366      </varlistentry>
     367
     368      <varlistentry id="mandb">
     369        <term><command>mandb</command></term>
     370        <listitem>
     371          <para>Creates or updates the <command>whatis</command> database</para>
     372          <indexterm zone="ch-system-man-db mandb">
     373            <primary sortas="b-mandb">mandb</primary>
     374          </indexterm>
     375        </listitem>
     376      </varlistentry>
     377
     378      <varlistentry id="whatis">
     379        <term><command>whatis</command></term>
     380        <listitem>
     381          <para>Searches the <command>whatis</command> database and displays
     382          the short descriptions of system commands that contain the given
     383          keyword as a separate word</para>
     384          <indexterm zone="ch-system-man-db whatis">
     385            <primary sortas="b-whatis">whatis</primary>
     386          </indexterm>
     387        </listitem>
     388      </varlistentry>
     389
     390    </variablelist>
     391
     392  </sect2>
    263393
    264394</sect1>
    265 

  • chapter06/man-pages.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-man-pages" role="wrap">
    7 <title>Man-pages-&man-pages-version;</title>
    8 <?dbhtml filename="man-pages.html"?>
     9  <?dbhtml filename="man-pages.html"?>
    910
    10 <indexterm zone="ch-system-man-pages"><primary sortas="a-Man-pages">Man-pages</primary></indexterm>
     11  <title>Man-pages-&man-pages-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Man-pages package contains over 1,200 man pages.</para>
     13  <indexterm zone="ch-system-man-pages">
     14    <primary sortas="a-Man-pages">Man-pages</primary>
     15  </indexterm>
    1416
    15 <segmentedlist>
    16 <segtitle>&buildtime;</segtitle>
    17 <segtitle>&diskspace;</segtitle>
    18 <seglistitem><seg>0.1 SBU</seg><seg>18.6 MB</seg></seglistitem>
    19 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2019
    21 <segmentedlist>
    22 <segtitle>&dependencies;</segtitle>
    23 <seglistitem><seg>Bash, Coreutils, and Make</seg></seglistitem>
    24 </segmentedlist>
    25 </sect2>
     20    <para>The Man-pages package contains over 1,200 man pages.</para>
    2621
    27 <sect2 role="installation">
    28 <title>Installation of Man-pages</title>
     22    <segmentedlist>
     23      <segtitle>&buildtime;</segtitle>
     24      <segtitle>&diskspace;</segtitle>
    2925
    30 <para>Install Man-pages by running:</para>
     26      <seglistitem>
     27        <seg>0.1 SBU</seg>
     28        <seg>18.6 MB</seg>
     29      </seglistitem>
     30    </segmentedlist>
     31
     32    <segmentedlist>
     33      <segtitle>&dependencies;</segtitle>
     34
     35      <seglistitem>
     36        <seg>Bash, Coreutils, and Make</seg>
     37      </seglistitem>
     38    </segmentedlist>
     39
     40  </sect2>
     41
     42  <sect2 role="installation">
     43    <title>Installation of Man-pages</title>
     44
     45    <para>Install Man-pages by running:</para>
    3146
    3247<screen><userinput>make install</userinput></screen>
    3348
    34 </sect2>
     49  </sect2>
    3550
     51  <sect2 id="contents-manpages" role="content">
     52    <title>Contents of Man-pages</title>
    3653
    37 <sect2 id="contents-manpages" role="content"><title>Contents of Man-pages</title>
     54    <segmentedlist>
     55      <segtitle>Installed files</segtitle>
    3856
    39 <segmentedlist>
    40 <segtitle>Installed files</segtitle>
    41 <seglistitem><seg>various man pages</seg></seglistitem>
    42 </segmentedlist>
     57      <seglistitem>
     58        <seg>various man pages</seg>
     59      </seglistitem>
     60    </segmentedlist>
    4361
    44 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    45 <?dbfo list-presentation="list"?>
    46 <?dbhtml list-presentation="table"?>
     62    <variablelist>
     63      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     64      <?dbfo list-presentation="list"?>
     65      <?dbhtml list-presentation="table"?>
    4766
    48 <varlistentry id="man-pages">
    49 <term><filename>man pages</filename></term>
    50 <listitem>
    51 <para>Describe the C and C++ functions, important
    52 device files, and significant configuration files</para>
    53 <indexterm zone="ch-system-man-pages man-pages"><primary sortas="e-man-pages">man pages</primary></indexterm>
    54 </listitem>
    55 </varlistentry>
    56 </variablelist>
     67      <varlistentry id="man-pages">
     68        <term><filename>man pages</filename></term>
     69        <listitem>
     70          <para>Describe the C and C++ functions, important
     71          device files, and significant configuration files</para>
     72          <indexterm zone="ch-system-man-pages man-pages">
     73            <primary sortas="e-man-pages">man pages</primary>
     74          </indexterm>
     75        </listitem>
     76      </varlistentry>
    5777
    58 </sect2>
     78    </variablelist>
     79
     80  </sect2>
    5981
    6082</sect1>
    61 

  • chapter06/mktemp.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-mktemp" role="wrap">
    7 <title>Mktemp-&mktemp-version;</title>
    8 <?dbhtml filename="mktemp.html"?>
     9  <?dbhtml filename="mktemp.html"?>
    910
    10 <indexterm zone="ch-system-mktemp"><primary sortas="a-Mktemp">Mktemp</primary></indexterm>
     11  <title>Mktemp-&mktemp-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Mktemp package contains programs used to create secure temporary
    14 files in shell scripts.</para>
     13  <indexterm zone="ch-system-mktemp">
     14    <primary sortas="a-Mktemp">Mktemp</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>436 KB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Coreutils, Make, and Patch</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
     20    <para>The Mktemp package contains programs used to create secure temporary
     21    files in shell scripts.</para>
    2722
    28 <sect2 role="installation">
    29 <title>Installation of Mktemp</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3026
    31 <para>Many scripts still use the deprecated
    32 <command>tempfile</command> program, which has functionality similar
    33 to <command>mktemp</command>. Patch Mktemp to include a
    34 <command>tempfile</command> wrapper:</para>
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>436 KB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Coreutils, Make, and Patch</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41  </sect2>
     42
     43  <sect2 role="installation">
     44    <title>Installation of Mktemp</title>
     45
     46    <para>Many scripts still use the deprecated
     47    <command>tempfile</command> program, which has functionality similar
     48    to <command>mktemp</command>. Patch Mktemp to include a
     49    <command>tempfile</command> wrapper:</para>
    3550
    3651<screen><userinput>patch -Np1 -i ../&mktemp-tempfile-patch;</userinput></screen>
    3752
    38 <para>Prepare Mktemp for compilation:</para>
     53    <para>Prepare Mktemp for compilation:</para>
    3954
    4055<screen><userinput>./configure --prefix=/usr --with-libc</userinput></screen>
    4156
    42 <para>The meaning of the configure options:</para>
     57    <variablelist>
     58      <title>The meaning of the configure options:</title>
    4359
    44 <variablelist>
    45 <varlistentry>
    46 <term><parameter>--with-libc</parameter></term>
    47 <listitem><para>This causes the <command>mktemp</command> program to
    48 use the <emphasis>mkstemp</emphasis> and <emphasis>mkdtemp</emphasis>
    49 functions from the system C library instead of its own implementation of them.
    50 </para></listitem>
    51 </varlistentry>
    52 </variablelist>
     60      <varlistentry>
     61        <term><parameter>--with-libc</parameter></term>
     62        <listitem>
     63          <para>This causes the <command>mktemp</command> program to use the
     64          <emphasis>mkstemp</emphasis> and <emphasis>mkdtemp</emphasis>
     65          functions from the system C library instead of its own implementation
     66          of them. </para>
     67        </listitem>
     68      </varlistentry>
    5369
    54 <para>Compile the package:</para>
     70    </variablelist>
     71
     72    <para>Compile the package:</para>
    5573
    5674<screen><userinput>make</userinput></screen>
    5775
    58 <para>This package does not come with a test suite.</para>
     76    <para>This package does not come with a test suite.</para>
    5977
    60 <para>Install the package:</para>
     78    <para>Install the package:</para>
    6179
    6280<screen><userinput>make install
    6381make install-tempfile</userinput></screen>
    6482
    65 </sect2>
     83  </sect2>
    6684
     85  <sect2 id="contents-mktemp" role="content">
     86    <title>Contents of Mktemp</title>
    6787
    68 <sect2 id="contents-mktemp" role="content"><title>Contents of Mktemp</title>
     88    <segmentedlist>
     89      <segtitle>Installed programs</segtitle>
    6990
    70 <segmentedlist>
    71 <segtitle>Installed programs</segtitle>
    72 <seglistitem><seg>mktemp and tempfile</seg></seglistitem>
    73 </segmentedlist>
     91      <seglistitem>
     92        <seg>mktemp and tempfile</seg>
     93      </seglistitem>
     94    </segmentedlist>
    7495
    75 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    76 <?dbfo list-presentation="list"?>
    77 <?dbhtml list-presentation="table"?>
     96    <variablelist>
     97      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     98      <?dbfo list-presentation="list"?>
     99      <?dbhtml list-presentation="table"?>
    78100
    79 <varlistentry id="mktemp">
    80 <term><command>mktemp</command></term>
    81 <listitem>
    82 <para>Creates temporary files in a secure manner; it is used in scripts</para>
    83 <indexterm zone="ch-system-mktemp mktemp"><primary sortas="b-mktemp">mktemp</primary></indexterm>
    84 </listitem>
    85 </varlistentry>
     101      <varlistentry id="mktemp">
     102        <term><command>mktemp</command></term>
     103        <listitem>
     104          <para>Creates temporary files in a secure manner; it is used in
     105          scripts</para>
     106          <indexterm zone="ch-system-mktemp mktemp">
     107            <primary sortas="b-mktemp">mktemp</primary>
     108          </indexterm>
     109        </listitem>
     110      </varlistentry>
    86111
    87 <varlistentry id="tempfile">
    88 <term><command>tempfile</command></term>
    89 <listitem>
    90 <para>Creates temporary files in a less secure manner than
    91 <command>mktemp</command>; it is installed for backwards-compatibility</para>
    92 <indexterm zone="ch-system-mktemp tempfile"><primary sortas="b-tempfile">tempfile</primary></indexterm>
    93 </listitem>
    94 </varlistentry>
    95 </variablelist>
     112      <varlistentry id="tempfile">
     113        <term><command>tempfile</command></term>
     114        <listitem>
     115          <para>Creates temporary files in a less secure manner than
     116          <command>mktemp</command>; it is installed for
     117          backwards-compatibility</para>
     118          <indexterm zone="ch-system-mktemp tempfile">
     119            <primary sortas="b-tempfile">tempfile</primary>
     120          </indexterm>
     121        </listitem>
     122      </varlistentry>
    96123
    97 </sect2>
     124    </variablelist>
     125
     126  </sect2>
    98127
    99128</sect1>
    100 

  • chapter06/module-init-tools.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-module-init-tools" role="wrap">
    7 <title>Module-Init-Tools-&module-init-tools-version;</title>
    8 <?dbhtml filename="module-init-tools.html"?>
     9  <?dbhtml filename="module-init-tools.html"?>
    910
    10 <indexterm zone="ch-system-module-init-tools"><primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary></indexterm>
     11  <title>Module-Init-Tools-&module-init-tools-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Module-Init-Tools package contains programs for handling kernel
    14 modules in Linux kernels greater than or equal to version 2.5.47.</para>
     13  <indexterm zone="ch-system-module-init-tools">
     14    <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.3 SBU</seg><seg>3.3 MB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Bison,
    25 Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
     20    <para>The Module-Init-Tools package contains programs for handling kernel
     21    modules in Linux kernels greater than or equal to version 2.5.47.</para>
    2822
    29 <sect2 role="installation">
    30 <title>Installation of Module-Init-Tools</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3126
    32 <para>Issue the following commands to perform the tests (note that the
    33 <command>make distclean</command> command is required to clean up the source
    34 tree, as the source gets recompiled as part of the testing process):</para>
     27      <seglistitem>
     28        <seg>0.3 SBU</seg>
     29        <seg>3.3 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Binutils, Bison, Coreutils, Diffutils, Flex, GCC, Glibc,
     38        Grep, M4, Make, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Module-Init-Tools</title>
     46
     47    <para>Issue the following commands to perform the tests (note that the
     48    <command>make distclean</command> command is required to clean up the source
     49    tree, as the source gets recompiled as part of the testing process):</para>
    3550
    3651<screen><userinput>./configure &amp;&amp;
    … …  
    3853make distclean</userinput></screen>
    3954
    40 <para>Prepare Module-Init-Tools for compilation:</para>
     55    <para>Prepare Module-Init-Tools for compilation:</para>
    4156
    4257<screen><userinput>./configure --prefix=/ --enable-zlib</userinput></screen>
    4358
    44 <para>Compile the package:</para>
     59    <para>Compile the package:</para>
    4560
    4661<screen><userinput>make</userinput></screen>
    4762
    48 <para>Install the package:</para>
     63    <para>Install the package:</para>
    4964
    5065<screen><userinput>make install</userinput></screen>
    5166
    52 </sect2>
     67  </sect2>
    5368
     69  <sect2 id="contents-module-init-tools" role="content">
     70    <title>Contents of Module-Init-Tools</title>
    5471
    55 <sect2 id="contents-module-init-tools" role="content"><title>Contents of Module-Init-Tools</title>
     72    <segmentedlist>
     73      <segtitle>Installed programs</segtitle>
    5674
    57 <segmentedlist>
    58 <segtitle>Installed programs</segtitle>
    59 <seglistitem><seg>depmod, generate-modprobe.conf, insmod,
    60 insmod.static, lsmod, modinfo, modprobe, and rmmod</seg></seglistitem>
    61 </segmentedlist>
     75      <seglistitem>
     76        <seg>depmod, generate-modprobe.conf, insmod, insmod.static, lsmod,
     77        modinfo, modprobe, and rmmod</seg>
     78      </seglistitem>
     79    </segmentedlist>
    6280
    63 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    64 <?dbfo list-presentation="list"?>
    65 <?dbhtml list-presentation="table"?>
     81    <variablelist>
     82      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     83      <?dbfo list-presentation="list"?>
     84      <?dbhtml list-presentation="table"?>
    6685
    67 <varlistentry id="depmod">
    68 <term><command>depmod</command></term>
    69 <listitem>
    70 <para>Creates a dependency file based on the symbols it finds in the
    71 existing set of modules; this dependency file is used by <command>modprobe</command> to
    72 automatically load the required modules</para>
    73 <indexterm zone="ch-system-module-init-tools depmod"><primary sortas="b-depmod">depmod</primary></indexterm>
    74 </listitem>
    75 </varlistentry>
     86      <varlistentry id="depmod">
     87        <term><command>depmod</command></term>
     88        <listitem>
     89          <para>Creates a dependency file based on the symbols it finds in the
     90          existing set of modules; this dependency file is used by
     91          <command>modprobe</command> to automatically load the required
     92          modules</para>
     93          <indexterm zone="ch-system-module-init-tools depmod">
     94            <primary sortas="b-depmod">depmod</primary>
     95          </indexterm>
     96        </listitem>
     97      </varlistentry>
    7698
    77 <varlistentry id="generate-modprobe.conf">
    78 <term><command>generate-modprobe.conf</command></term>
    79 <listitem>
    80 <para>Creates a modprobe.conf file from an existing 2.2 or 2.4 module setup</para>
    81 <indexterm zone="ch-system-module-init-tools generate-modprobe.conf"><primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary></indexterm>
    82 </listitem>
    83 </varlistentry>
     99      <varlistentry id="generate-modprobe.conf">
     100        <term><command>generate-modprobe.conf</command></term>
     101        <listitem>
     102          <para>Creates a modprobe.conf file from an existing 2.2 or 2.4 module
     103          setup</para>
     104          <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
     105            <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
     106          </indexterm>
     107        </listitem>
     108      </varlistentry>
    84109
    85 <varlistentry id="insmod">
    86 <term><command>insmod</command></term>
    87 <listitem>
    88 <para>Installs a loadable module in the running kernel</para>
    89 <indexterm zone="ch-system-module-init-tools insmod"><primary sortas="b-insmod">insmod</primary></indexterm>
    90 </listitem>
    91 </varlistentry>
     110      <varlistentry id="insmod">
     111        <term><command>insmod</command></term>
     112        <listitem>
     113          <para>Installs a loadable module in the running kernel</para>
     114          <indexterm zone="ch-system-module-init-tools insmod">
     115            <primary sortas="b-insmod">insmod</primary>
     116          </indexterm>
     117        </listitem>
     118      </varlistentry>
    92119
    93 <varlistentry id="insmod.static">
    94 <term><command>insmod.static</command></term>
    95 <listitem>
    96 <para>A statically compiled version of <command>insmod</command></para>
    97 <indexterm zone="ch-system-module-init-tools insmod.static"><primary
    98 sortas="b-insmod.static">insmod.static</primary></indexterm>
    99 </listitem>
    100 </varlistentry>
     120      <varlistentry id="insmod.static">
     121        <term><command>insmod.static</command></term>
     122        <listitem>
     123          <para>A statically compiled version of <command>insmod</command></para>
     124          <indexterm zone="ch-system-module-init-tools insmod.static">
     125            <primary sortas="b-insmod.static">insmod.static</primary>
     126          </indexterm>
     127        </listitem>
     128      </varlistentry>
    101129
    102 <varlistentry id="lsmod">
    103 <term><command>lsmod</command></term>
    104 <listitem>
    105 <para>Lists currently loaded modules</para>
    106 <indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm>
    107 </listitem>
    108 </varlistentry>
     130      <varlistentry id="lsmod">
     131        <term><command>lsmod</command></term>
     132        <listitem>
     133          <para>Lists currently loaded modules</para>
     134          <indexterm zone="ch-system-module-init-tools lsmod">
     135            <primary sortas="b-lsmod">lsmod</primary>
     136          </indexterm>
     137        </listitem>
     138      </varlistentry>
    109139
    110 <varlistentry id="modinfo">
    111 <term><command>modinfo</command></term>
    112 <listitem>
    113 <para>Examines an object file associated with a kernel module and
    114 displays any information that it can glean</para>
    115 <indexterm zone="ch-system-module-init-tools modinfo"><primary sortas="b-modinfo">modinfo</primary></indexterm>
    116 </listitem>
    117 </varlistentry>
     140      <varlistentry id="modinfo">
     141        <term><command>modinfo</command></term>
     142        <listitem>
     143          <para>Examines an object file associated with a kernel module and
     144          displays any information that it can glean</para>
     145          <indexterm zone="ch-system-module-init-tools modinfo">
     146            <primary sortas="b-modinfo">modinfo</primary>
     147          </indexterm>
     148        </listitem>
     149      </varlistentry>
    118150
    119 <varlistentry id="modprobe">
    120 <term><command>modprobe</command></term>
    121 <listitem>
    122 <para>Uses a dependency file, created by
    123 <command>depmod</command>, to automatically load relevant modules</para>
    124 <indexterm zone="ch-system-module-init-tools modprobe"><primary sortas="b-modprobe">modprobe</primary></indexterm>
    125 </listitem>
    126 </varlistentry>
     151      <varlistentry id="modprobe">
     152        <term><command>modprobe</command></term>
     153        <listitem>
     154          <para>Uses a dependency file, created by
     155          <command>depmod</command>, to automatically load relevant modules</para>
     156          <indexterm zone="ch-system-module-init-tools modprobe">
     157            <primary sortas="b-modprobe">modprobe</primary>
     158          </indexterm>
     159        </listitem>
     160      </varlistentry>
    127161
    128 <varlistentry id="rmmod">
    129 <term><command>rmmod</command></term>
    130 <listitem>
    131 <para>Unloads modules from the running kernel</para>
    132 <indexterm zone="ch-system-module-init-tools rmmod"><primary sortas="b-rmmod">rmmod</primary></indexterm>
    133 </listitem>
    134 </varlistentry>
    135 </variablelist>
     162      <varlistentry id="rmmod">
     163        <term><command>rmmod</command></term>
     164        <listitem>
     165          <para>Unloads modules from the running kernel</para>
     166          <indexterm zone="ch-system-module-init-tools rmmod">
     167            <primary sortas="b-rmmod">rmmod</primary>
     168          </indexterm>
     169        </listitem>
     170      </varlistentry>
    136171
    137 </sect2>
     172    </variablelist>
     173
     174  </sect2>
    138175
    139176</sect1>
    140 

  • chapter06/ncurses.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-ncurses" role="wrap">
    7 <title>Ncurses-&ncurses-version;</title>
    8 <?dbhtml filename="ncurses.html"?>
    9 
    10 <indexterm zone="ch-system-ncurses"><primary sortas="a-Ncurses">Ncurses</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Ncurses package contains libraries for terminal-independent
    14 handling of character screens.</para>
    15 
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.6 SBU</seg><seg>18.6 MB</seg></seglistitem>
    20 </segmentedlist>
    21 
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
    25 Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
    28 
    29 <sect2 role="installation">
    30 <title>Installation of Ncurses</title>
    31 <!-- Uncomment if using a dated ncurses release instead of a numbered one.
    32 
    33 <para>Since the release of Ncurses-&ncurses-version;, some bugs have been fixed
    34 and features added. The most important news are .......
    35 To get these fixes and features, apply the rollup patch:</para>
     9  <?dbhtml filename="ncurses.html"?>
     10
     11  <title>Ncurses-&ncurses-version;</title>
     12
     13  <indexterm zone="ch-system-ncurses">
     14    <primary sortas="a-Ncurses">Ncurses</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Ncurses package contains libraries for terminal-independent
     21    handling of character screens.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.6 SBU</seg>
     29        <seg>18.6 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Glibc, Grep,
     38        Make, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Ncurses</title>
     46    <!-- Uncomment if using a dated ncurses release instead of a numbered one.
     47
     48    <para>Since the release of Ncurses-&ncurses-version;, some bugs have been fixed
     49    and features added. The most important news are .......
     50    To get these fixes and features, apply the rollup patch:</para>
    3651
    3752<screen><userinput>bzcat ../&ncurses-rollup-patch; | patch -Np1</userinput></screen>
    38 -->
    39 
    40 <para>Since the release of Ncurses-&ncurses-version;, a memory leak and some
    41 display bugs were found and fixed upstream. Apply those fixes:</para>
     53    -->
     54
     55    <para>Since the release of Ncurses-&ncurses-version;, a memory leak and some
     56    display bugs were found and fixed upstream. Apply those fixes:</para>
    4257
    4358<screen><userinput>patch -Np1 -i ../&ncurses-fixes-patch;</userinput></screen>
    4459
    45 <para>Prepare Ncurses for compilation:</para>
     60    <para>Prepare Ncurses for compilation:</para>
    4661
    4762<screen><userinput>./configure --prefix=/usr --with-shared --without-debug --enable-widec</userinput></screen>
    4863
    49 <para>The meaning of the configure options:</para>
    50 
    51 <variablelist>
    52 <varlistentry>
    53 <term><parameter>--enable-widec</parameter></term>
    54 <listitem><para>This switch causes wide-character libraries
    55 (e.g., <filename class="libraryfile">libncursesw.so.&ncurses-version;</filename>)
    56 to be built instead of normal ones
    57 (e.g., <filename class="libraryfile">libncurses.so.&ncurses-version;</filename>).
    58 These wide-character libraries are usable in both multibyte and traditional 8-bit
    59 locales, while normal libraries work properly only in 8-bit locales.
    60 Wide-character and normal libraries are source-compatible, but not
    61 binary-compatible.</para>
    62 </listitem>
    63 </varlistentry>
    64 <!--
    65 <varlistentry>
    66 <term><parameter>- -without-cxx-binding</parameter></term>
    67 <listitem><para>This optional switch causes the
    68 <filename class="libraryfile">libncurses++w.a</filename> library
    69 not to be built. Nothing in LFS and BLFS uses this library.</para>
    70 </listitem>
    71 </varlistentry>
    72 -->
    73 </variablelist>
    74 
    75 <para>Compile the package:</para>
     64    <variablelist>
     65      <title>The meaning of the configure option:</title>
     66
     67      <varlistentry>
     68        <term><parameter>--enable-widec</parameter></term>
     69        <listitem>
     70          <para>This switch causes wide-character libraries (e.g., <filename
     71          class="libraryfile">libncursesw.so.&ncurses-version;</filename>)
     72          to be built instead of normal ones (e.g., <filename
     73          class="libraryfile">libncurses.so.&ncurses-version;</filename>).
     74          These wide-character libraries are usable in both multibyte and
     75          traditional 8-bit locales, while normal libraries work properly
     76          only in 8-bit locales. Wide-character and normal libraries are
     77          source-compatible, but not binary-compatible.</para>
     78        </listitem>
     79      </varlistentry>
     80
     81      <!--
     82      <varlistentry>
     83        <term><parameter>- -without-cxx-binding</parameter></term>
     84        <listitem>
     85          <para>This optional switch causes the
     86          <filename class="libraryfile">libncurses++w.a</filename> library
     87          not to be built. Nothing in LFS and BLFS uses this library.</para>
     88        </listitem>
     89      </varlistentry>
     90      -->
     91
     92    </variablelist>
     93
     94    <para>Compile the package:</para>
    7695
    7796<screen><userinput>make</userinput></screen>
    7897
    79 <para>This package does not come with a test suite.</para>
    80 
    81 <para>Install the package:</para>
     98    <para>This package does not come with a test suite.</para>
     99
     100    <para>Install the package:</para>
    82101
    83102<screen><userinput>make install</userinput></screen>
    84103
    85 <para>Give the Ncurses libraries execute permissions:</para>
     104    <para>Give the Ncurses libraries execute permissions:</para>
    86105
    87106<screen><userinput>chmod -v 755 /usr/lib/*.&ncurses-version;</userinput></screen>
    88107
    89 <para>Fix a library that should not be executable:</para>
     108    <para>Fix a library that should not be executable:</para>
    90109
    91110<screen><userinput>chmod -v 644 /usr/lib/libncurses++w.a</userinput></screen>
    92111
    93 <para>Move the libraries to the <filename class="directory">/lib</filename> directory,
    94 where they are expected to reside:</para>
     112    <para>Move the libraries to the <filename class="directory">/lib</filename> directory,
     113    where they are expected to reside:</para>
    95114
    96115<screen><userinput>mv -v /usr/lib/libncursesw.so.5* /lib</userinput></screen>
    97116
    98 <para>Because the libraries have been moved, one symlink points to
    99 a non-existent file. Recreate it:</para>
     117    <para>Because the libraries have been moved, one symlink points to
     118    a non-existent file. Recreate it:</para>
    100119
    101120<screen><userinput>ln -sfv ../../lib/libncursesw.so.5 /usr/lib/libncursesw.so</userinput></screen>
    102121
    103 <para>Many applications still expect the linker to be able to find
    104 non-wide-character Ncurses libraries. Trick such applications into linking with
    105 wide-character libraries by means of symlinks and linker scripts:</para>
     122    <para>Many applications still expect the linker to be able to find
     123    non-wide-character Ncurses libraries. Trick such applications into linking with
     124    wide-character libraries by means of symlinks and linker scripts:</para>
    106125
    107126<screen><userinput>for lib in curses ncurses form panel menu ; do \
    108         rm -vf /usr/lib/lib${lib}.so ; \
    109         echo "INPUT(-l${lib}w)" &gt;/usr/lib/lib${lib}.so ; \
    110         ln -sfv lib${lib}w.a /usr/lib/lib${lib}.a ; \
     127    rm -vf /usr/lib/lib${lib}.so ; \
     128    echo "INPUT(-l${lib}w)" &gt;/usr/lib/lib${lib}.so ; \
     129    ln -sfv lib${lib}w.a /usr/lib/lib${lib}.a ; \
    111130done &amp;&amp;
    112131ln -sfv libncurses++w.a /usr/lib/libncurses++.a</userinput></screen>
    113132
    114 <para>Finally, make sure that old applications that look for
    115 <filename class="libraryfile">-lcurses</filename> at build time are still
    116 buildable:</para>
     133    <para>Finally, make sure that old applications that look for
     134    <filename class="libraryfile">-lcurses</filename> at build time are still
     135    buildable:</para>
    117136
    118137<screen><userinput>echo "INPUT(-lncursesw)" &gt;/usr/lib/libcursesw.so &amp;&amp;
    … …  
    121140ln -sfv libncurses.a /usr/lib/libcurses.a</userinput></screen>
    122141
    123 <note><para>The instructions above don't create non-wide-character Ncurses
    124 libraries since no package installed by compiling from sources would link
    125 against them at runtime.
    126 If you must have such libraries because of some binary-only application,
    127 build them with the following commands:</para>
     142    <note>
     143      <para>The instructions above don't create non-wide-character Ncurses
     144      libraries since no package installed by compiling from sources would
     145      link against them at runtime. If you must have such libraries because
     146      of some binary-only application, build them with the following
     147      commands:</para>
     148
    128149<screen role="nodump"><userinput>make distclean &amp;&amp;
    129150./configure --prefix=/usr --with-shared --without-normal \
    130         --without-debug --without-cxx-binding &amp;&amp;
     151  --without-debug --without-cxx-binding &amp;&amp;
    131152make sources libs &amp;&amp;
    132153cp -av lib/lib*.so.5* /usr/lib</userinput></screen>
    133 </note>
    134 </sect2>
    135 
    136 
    137 <sect2 id="contents-ncurses" role="content"><title>Contents of Ncurses</title>
    138 
    139 <segmentedlist>
    140 <segtitle>Installed programs</segtitle>
    141 <segtitle>Installed libraries</segtitle>
    142 <seglistitem><seg>captoinfo (link to tic), clear, infocmp, infotocap (link to tic),
    143 reset (link to tset), tack, tic, toe, tput, and tset</seg>
    144 <seg>libcursesw.[a,so] (symlink and linker script to libncursesw.[a,so]),
    145 libformw.[a,so], libmenuw.[a,so],
    146 libncurses++w.a, libncursesw.[a,so], libpanelw.[a,so] and their
    147 non-wide-character counterparts without "w" in the library names.</seg></seglistitem>
    148 </segmentedlist>
    149 
    150 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    151 <?dbfo list-presentation="list"?>
    152 <?dbhtml list-presentation="table"?>
    153 
    154 <varlistentry id="captoinfo">
    155 <term><command>captoinfo</command></term>
    156 <listitem>
    157 <para>Converts a termcap description into a terminfo description</para>
    158 <indexterm zone="ch-system-ncurses captoinfo"><primary sortas="b-captoinfo">captoinfo</primary></indexterm>
    159 </listitem>
    160 </varlistentry>
    161 
    162 <varlistentry id="clear">
    163 <term><command>clear</command></term>
    164 <listitem>
    165 <para>Clears the screen, if possible</para>
    166 <indexterm zone="ch-system-ncurses clear"><primary sortas="b-clear">clear</primary></indexterm>
    167 </listitem>
    168 </varlistentry>
    169 
    170 <varlistentry id="infocmp">
    171 <term><command>infocmp</command></term>
    172 <listitem>
    173 <para>Compares or prints out terminfo descriptions</para>
    174 <indexterm zone="ch-system-ncurses infocmp"><primary sortas="b-infocmp">infocmp</primary></indexterm>
    175 </listitem>
    176 </varlistentry>
    177 
    178 <varlistentry id="infotocap">
    179 <term><command>infotocap</command></term>
    180 <listitem>
    181 <para>Converts a terminfo description into a termcap description</para>
    182 <indexterm zone="ch-system-ncurses infotocap"><primary sortas="b-infotocap">infotocap</primary></indexterm>
    183 </listitem>
    184 </varlistentry>
    185 
    186 <varlistentry id="reset">
    187 <term><command>reset</command></term>
    188 <listitem>
    189 <para>Reinitializes a terminal to its default values</para>
    190 <indexterm zone="ch-system-ncurses reset"><primary sortas="b-reset">reset</primary></indexterm>
    191 </listitem>
    192 </varlistentry>
    193 
    194 <varlistentry id="tack">
    195 <term><command>tack</command></term>
    196 <listitem>
    197 <para>The terminfo action checker; it is mainly used to test the
    198 accuracy of an entry in the terminfo database</para>
    199 <indexterm zone="ch-system-ncurses tack"><primary sortas="b-tack">tack</primary></indexterm>
    200 </listitem>
    201 </varlistentry>
    202 
    203 <varlistentry id="tic">
    204 <term><command>tic</command></term>
    205 <listitem>
    206 <para>The terminfo entry-description compiler that translates a
    207 terminfo file from source format into the binary format needed for the
    208 ncurses library routines. A terminfo file contains information on the
    209 capabilities of a certain terminal</para>
    210 <indexterm zone="ch-system-ncurses tic"><primary sortas="b-tic">tic</primary></indexterm>
    211 </listitem>
    212 </varlistentry>
    213 
    214 <varlistentry id="toe">
    215 <term><command>toe</command></term>
    216 <listitem>
    217 <para>Lists all available terminal types, giving the primary name and
    218 description for each</para>
    219 <indexterm zone="ch-system-ncurses toe"><primary sortas="b-toe">toe</primary></indexterm>
    220 </listitem>
    221 </varlistentry>
    222 
    223 <varlistentry id="tput">
    224 <term><command>tput</command></term>
    225 <listitem>
    226 <para>Makes the values of terminal-dependent capabilities available to
    227 the shell; it can also be used to reset or initialize a terminal or
    228 report its long name</para>
    229 <indexterm zone="ch-system-ncurses tput"><primary sortas="b-tput">tput</primary></indexterm>
    230 </listitem>
    231 </varlistentry>
    232 
    233 <varlistentry id="tset">
    234 <term><command>tset</command></term>
    235 <listitem>
    236 <para>Can be used to initialize terminals</para>
    237 <indexterm zone="ch-system-ncurses tset"><primary sortas="b-tset">tset</primary></indexterm>
    238 </listitem>
    239 </varlistentry>
    240 
    241 <varlistentry id="libcurses">
    242 <term><filename class="libraryfile">libcurses</filename></term>
    243 <listitem>
    244 <para>A link to <filename>libncurses</filename></para>
    245 <indexterm zone="ch-system-ncurses libcurses"><primary sortas="c-libcurses">libcurses</primary></indexterm>
    246 </listitem>
    247 </varlistentry>
    248 
    249 <varlistentry id="libncurses">
    250 <term><filename class="libraryfile">libncurses</filename></term>
    251 <listitem>
    252 <para>Contains functions to display text in many complex ways on a
    253 terminal screen; a good example of the use of these functions is the
    254 menu displayed during the kernel's <command>make menuconfig</command></para>
    255 <indexterm zone="ch-system-ncurses libncurses"><primary sortas="c-libncurses">libncurses</primary></indexterm>
    256 </listitem>
    257 </varlistentry>
    258 
    259 <varlistentry id="libform">
    260 <term><filename class="libraryfile">libform</filename></term>
    261 <listitem>
    262 <para>Contains functions to implement forms</para>
    263 <indexterm zone="ch-system-ncurses libform"><primary sortas="c-libform">libform</primary></indexterm>
    264 </listitem>
    265 </varlistentry>
    266 
    267 <varlistentry id="libmenu">
    268 <term><filename class="libraryfile">libmenu</filename></term>
    269 <listitem>
    270 <para>Contains functions to implement menus</para>
    271 <indexterm zone="ch-system-ncurses libmenu"><primary sortas="c-libmenu">libmenu</primary></indexterm>
    272 </listitem>
    273 </varlistentry>
    274 
    275 <varlistentry id="libpanel">
    276 <term><filename class="libraryfile">libpanel</filename></term>
    277 <listitem>
    278 <para>Contains functions to implement panels</para>
    279 <indexterm zone="ch-system-ncurses libpanel"><primary sortas="c-libpanel">libpanel</primary></indexterm>
    280 </listitem>
    281 </varlistentry>
    282 </variablelist>
    283 
    284 </sect2>
     154    </note>
     155
     156  </sect2>
     157
     158  <sect2 id="contents-ncurses" role="content">
     159    <title>Contents of Ncurses</title>
     160
     161    <segmentedlist>
     162      <segtitle>Installed programs</segtitle>
     163      <segtitle>Installed libraries</segtitle>
     164
     165      <seglistitem>
     166        <seg>captoinfo (link to tic), clear, infocmp, infotocap (link to tic),
     167        reset (link to tset), tack, tic, toe, tput, and tset</seg>
     168        <seg>libcursesw.[a,so] (symlink and linker script to libncursesw.[a,so]),
     169        libformw.[a,so], libmenuw.[a,so], libncurses++w.a, libncursesw.[a,so],
     170        libpanelw.[a,so] and their non-wide-character counterparts without "w"
     171        in the library names.</seg>
     172      </seglistitem>
     173    </segmentedlist>
     174
     175    <variablelist>
     176      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     177      <?dbfo list-presentation="list"?>
     178      <?dbhtml list-presentation="table"?>
     179
     180      <varlistentry id="captoinfo">
     181        <term><command>captoinfo</command></term>
     182        <listitem>
     183          <para>Converts a termcap description into a terminfo description</para>
     184          <indexterm zone="ch-system-ncurses captoinfo">
     185            <primary sortas="b-captoinfo">captoinfo</primary>
     186          </indexterm>
     187        </listitem>
     188      </varlistentry>
     189
     190      <varlistentry id="clear">
     191        <term><command>clear</command></term>
     192        <listitem>
     193          <para>Clears the screen, if possible</para>
     194          <indexterm zone="ch-system-ncurses clear">
     195            <primary sortas="b-clear">clear</primary>
     196          </indexterm>
     197        </listitem>
     198      </varlistentry>
     199
     200      <varlistentry id="infocmp">
     201        <term><command>infocmp</command></term>
     202        <listitem>
     203          <para>Compares or prints out terminfo descriptions</para>
     204          <indexterm zone="ch-system-ncurses infocmp">
     205            <primary sortas="b-infocmp">infocmp</primary>
     206          </indexterm>
     207        </listitem>
     208      </varlistentry>
     209
     210      <varlistentry id="infotocap">
     211        <term><command>infotocap</command></term>
     212        <listitem>
     213          <para>Converts a terminfo description into a termcap description</para>
     214          <indexterm zone="ch-system-ncurses infotocap">
     215            <primary sortas="b-infotocap">infotocap</primary>
     216          </indexterm>
     217        </listitem>
     218      </varlistentry>
     219
     220      <varlistentry id="reset">
     221        <term><command>reset</command></term>
     222        <listitem>
     223          <para>Reinitializes a terminal to its default values</para>
     224          <indexterm zone="ch-system-ncurses reset">
     225            <primary sortas="b-reset">reset</primary>
     226          </indexterm>
     227        </listitem>
     228      </varlistentry>
     229
     230      <varlistentry id="tack">
     231        <term><command>tack</command></term>
     232        <listitem>
     233          <para>The terminfo action checker; it is mainly used to test the
     234          accuracy of an entry in the terminfo database</para>
     235          <indexterm zone="ch-system-ncurses tack">
     236            <primary sortas="b-tack">tack</primary>
     237          </indexterm>
     238        </listitem>
     239      </varlistentry>
     240
     241      <varlistentry id="tic">
     242        <term><command>tic</command></term>
     243        <listitem>
     244          <para>The terminfo entry-description compiler that translates a
     245          terminfo file from source format into the binary format needed for the
     246          ncurses library routines. A terminfo file contains information on the
     247          capabilities of a certain terminal</para>
     248          <indexterm zone="ch-system-ncurses tic">
     249            <primary sortas="b-tic">tic</primary>
     250          </indexterm>
     251        </listitem>
     252      </varlistentry>
     253
     254      <varlistentry id="toe">
     255        <term><command>toe</command></term>
     256        <listitem>
     257          <para>Lists all available terminal types, giving the primary name and
     258          description for each</para>
     259          <indexterm zone="ch-system-ncurses toe">
     260            <primary sortas="b-toe">toe</primary>
     261          </indexterm>
     262        </listitem>
     263      </varlistentry>
     264
     265      <varlistentry id="tput">
     266        <term><command>tput</command></term>
     267        <listitem>
     268          <para>Makes the values of terminal-dependent capabilities available to
     269          the shell; it can also be used to reset or initialize a terminal or
     270          report its long name</para>
     271          <indexterm zone="ch-system-ncurses tput">
     272            <primary sortas="b-tput">tput</primary>
     273          </indexterm>
     274        </listitem>
     275      </varlistentry>
     276
     277      <varlistentry id="tset">
     278        <term><command>tset</command></term>
     279        <listitem>
     280          <para>Can be used to initialize terminals</para>
     281          <indexterm zone="ch-system-ncurses tset">
     282            <primary sortas="b-tset">tset</primary>
     283          </indexterm>
     284        </listitem>
     285      </varlistentry>
     286
     287      <varlistentry id="libcurses">
     288        <term><filename class="libraryfile">libcurses</filename></term>
     289        <listitem>
     290          <para>A link to <filename>libncurses</filename></para>
     291          <indexterm zone="ch-system-ncurses libcurses">
     292            <primary sortas="c-libcurses">libcurses</primary>
     293          </indexterm>
     294        </listitem>
     295      </varlistentry>
     296
     297      <varlistentry id="libncurses">
     298        <term><filename class="libraryfile">libncurses</filename></term>
     299        <listitem>
     300          <para>Contains functions to display text in many complex ways on a
     301          terminal screen; a good example of the use of these functions is the
     302          menu displayed during the kernel's <command>make
     303          menuconfig</command></para>
     304          <indexterm zone="ch-system-ncurses libncurses">
     305            <primary sortas="c-libncurses">libncurses</primary>
     306          </indexterm>
     307        </listitem>
     308      </varlistentry>
     309
     310      <varlistentry id="libform">
     311        <term><filename class="libraryfile">libform</filename></term>
     312        <listitem>
     313          <para>Contains functions to implement forms</para>
     314          <indexterm zone="ch-system-ncurses libform">
     315            <primary sortas="c-libform">libform</primary>
     316          </indexterm>
     317        </listitem>
     318      </varlistentry>
     319
     320      <varlistentry id="libmenu">
     321        <term><filename class="libraryfile">libmenu</filename></term>
     322        <listitem>
     323          <para>Contains functions to implement menus</para>
     324          <indexterm zone="ch-system-ncurses libmenu">
     325            <primary sortas="c-libmenu">libmenu</primary>
     326          </indexterm>
     327        </listitem>
     328      </varlistentry>
     329
     330      <varlistentry id="libpanel">
     331        <term><filename class="libraryfile">libpanel</filename></term>
     332        <listitem>
     333          <para>Contains functions to implement panels</para>
     334          <indexterm zone="ch-system-ncurses libpanel">
     335            <primary sortas="c-libpanel">libpanel</primary>
     336          </indexterm>
     337        </listitem>
     338      </varlistentry>
     339
     340    </variablelist>
     341
     342  </sect2>
    285343
    286344</sect1>

  • chapter06/patch.xml

    rcf7142a r2fa922f  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
    34  <!ENTITY % general-entities SYSTEM "../general.ent">
    45  %general-entities;
    56]>
     7
    68<sect1 id="ch-system-patch" role="wrap">
    7 <title>Patch-&patch-version;</title>
    8 <?dbhtml filename="patch.html"?>
     9  <?dbhtml filename="patch.html"?>
    910
    10 <indexterm zone="ch-system-patch"><primary sortas="a-Patch">Patch</primary></indexterm>
     11  <title>Patch-&patch-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Patch package contains a program for modifying or creating files by
    14 applying a <quote>patch</quote> file typically created by the
    15 <command>diff</command> program.</para>
     13  <indexterm zone="ch-system-patch">
     14    <primary sortas="a-Patch">Patch</primary>
     15  </indexterm>
    1616
    17 <segmentedlist>
    18 <segtitle>&buildtime;</segtitle>
    19 <segtitle>&diskspace;</segtitle>
    20 <seglistitem><seg>0.1 SBU</seg><seg>1.5 MB</seg></seglistitem>
    21 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2219
    23 <segmentedlist>
    24 <segtitle>&dependencies;</segtitle>
    25 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
    26 GCC, Glibc, Grep, Make, and Sed</seg></seglistitem>
    27 </segmentedlist>
    28 </sect2>
     20    <para>The Patch package contains a program for modifying or creating files
     21    by applying a <quote>patch</quote> file typically created by the
     22    <command>diff</command> program.</para>
    2923
    30 <sect2 role="installation">
    31 <title>Installation of Patch</title>
     24    <segmentedlist>
     25      <segtitle>&buildtime;</segtitle>
     26      <segtitle>&diskspace;</segtitle>
    3227
    33 <para>Prepare Patch for compilation.</para>
     28      <seglistitem>
     29        <seg>0.1 SBU</seg>
     30        <seg>1.5 MB</seg>
     31      </seglistitem>
     32    </segmentedlist>
     33
     34    <segmentedlist>
     35      <segtitle>&dependencies;</segtitle>
     36
     37      <seglistitem>
     38        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make,
     39        and Sed</seg>
     40      </seglistitem>
     41    </segmentedlist>
     42
     43  </sect2>
     44
     45  <sect2 role="installation">
     46    <title>Installation of Patch</title>
     47
     48    <para>Prepare Patch for compilation.</para>
    3449
    3550<screen><userinput>./configure --prefix=/usr</userinput></screen>
    3651
    37 <para>Compile the package:</para>
     52    <para>Compile the package:</para>
    3853
    3954<screen><userinput>make</userinput></screen>
    4055
    41 <para>This package does not come with a test suite.</para>
     56    <para>This package does not come with a test suite.</para>
    4257
    43 <para>Install the package:</para>
     58    <para>Install the package:</para>
    4459
    4560<screen><userinput>make install</userinput></screen>
    4661
    47 </sect2>
     62  </sect2>
    4863
     64  <sect2 id="contents-patch" role="content">
     65    <title>Contents of Patch</title>
    4966
    50 <sect2 id="contents-patch" role="content"><title>Contents of Patch</title>
     67    <segmentedlist>
     68      <segtitle>Installed program</segtitle>
    5169
    52 <segmentedlist>
    53 <segtitle>Installed program</segtitle>
    54 <seglistitem><seg>patch</seg></seglistitem>
    55 </segmentedlist>
     70      <seglistitem>
     71        <seg>patch</seg>
     72      </seglistitem>
     73    </segmentedlist>
    5674
    57 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    58 <?dbfo list-presentation="list"?>
    59 <?dbhtml list-presentation="table"?>
     75    <variablelist>
     76      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     77      <?dbfo list-presentation="list"?>
     78      <?dbhtml list-presentation="table"?>
    6079
    61 <varlistentry id="patch">
    62 <term><command>patch</command></term>
    63 <listitem>
    64 <para>Modifies files according to a patch file. A patch file is normally
    65 a difference listing created with the <command>diff</command> program. By applying
    66 these differences to the original files, <command>patch</command> creates the patched
    67 versions.</para>
    68 <indexterm zone="ch-system-patch patch"><primary sortas="b-patch">patch</primary></indexterm>
    69 </listitem>
    70 </varlistentry>
    71 </variablelist>
     80      <varlistentry id="patch">
     81        <term><command>patch</command></term>
     82        <listitem>
     83          <para>Modifies files according to a patch file. A patch file is
     84          normally a difference listing created with the <command>diff</command>
     85          program. By applying these differences to the original files,
     86          <command>patch</command> creates the patched versions.</para>
     87          <indexterm zone="ch-system-patch patch">
     88            <primary sortas="b-patch">patch</primary>
     89          </indexterm>
     90        </listitem>
     91      </varlistentry>
    7292
    73 </sect2>
     93    </variablelist>
     94
     95  </sect2>
    7496
    7597</sect1>
    76 
Note: See TracChangeset for help on using the changeset viewer.