Changeset ddd5542


Ignore:
Timestamp:
02/10/2006 07:05:30 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:
3bf7cb6
Parents:
3f3931b0
Message:

Finished the XML indentation plus few tags changes.

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

Files:
12 edited

Legend:

Unmodified
Added
Removed

  • chapter01/changelog.xml

    r3f3931b0 rddd5542  
    3636    </listitem>
    3737-->
     38
     39    <listitem>
     40      <para>Febraury 10, 2006</para>
     41      <itemizedlist>
     42        <listitem>
     43          <para>[manuel] - Finished the XML indentation plus few tags
     44          changes.</para>
     45        </listitem>
     46      </itemizedlist>
     47    </listitem>
    3848
    3949    <listitem>

  • chapter06/shadow.xml

    r3f3931b0 rddd5542  
    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-shadow" role="wrap">
    7 <title>Shadow-&shadow-version;</title>
    8 <?dbhtml filename="shadow.html"?>
    9 
    10 <indexterm zone="ch-system-shadow"><primary sortas="a-Shadow">Shadow</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Shadow package contains programs for handling passwords in a secure
    14 way.</para>
    15 
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.4 SBU</seg><seg>14.7 MB</seg></seglistitem>
    20 </segmentedlist>
    21 
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Bison, Coreutils,
    25 Diffutils, GCC, Gettext, Glibc, Grep, Make, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
    28 
    29 <sect2 role="installation">
    30 <title>Installation of Shadow</title>
    31 
    32 <note><para>If you would like to enforce the use of strong passwords, refer to
    33 <ulink url="&blfs-root;view/svn/postlfs/cracklib.html"/> for installing Cracklib
    34 prior to building Shadow. Then add <parameter>--with-libcrack</parameter> to the
    35 <command>configure</command> command below.</para></note>
    36 
    37 <para>Prepare Shadow for compilation:</para>
     9  <?dbhtml filename="shadow.html"?>
     10
     11  <title>Shadow-&shadow-version;</title>
     12
     13  <indexterm zone="ch-system-shadow">
     14    <primary sortas="a-Shadow">Shadow</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Shadow package contains programs for handling passwords in a secure
     21    way.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.4 SBU</seg>
     29        <seg>14.7 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Binutils, Bison, Coreutils, Diffutils, 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 Shadow</title>
     46
     47    <note>
     48      <para>If you would like to enforce the use of strong passwords, refer to
     49      <ulink url="&blfs-root;view/svn/postlfs/cracklib.html"/> for installing
     50      Cracklib prior to building Shadow. Then add
     51      <parameter>--with-libcrack</parameter> to the <command>configure</command>
     52      command below.</para>
     53    </note>
     54
     55    <para>Prepare Shadow for compilation:</para>
    3856
    3957<screen><userinput>./configure --libdir=/lib --enable-shared --without-selinux</userinput></screen>
    4058
    41 <para>The meaning of the configure options:</para>
    42 
    43 <variablelist>
    44 <varlistentry>
    45 <term><parameter>--without-selinux</parameter></term>
    46 <listitem><para>Support for selinux is enabled by default, but selinux is not
    47 built in a base LFS system.  The <command>configure</command> script will fail
    48 if this option is not used.</para></listitem>
    49 </varlistentry>
    50 </variablelist>
    51 
    52 <para>Disable the installation of the <command>groups</command> program and its man page, as Coreutils provides a better version:</para>
     59    <variablelist>
     60      <title>The meaning of the configure options:</title>
     61
     62      <varlistentry>
     63        <term><parameter>--without-selinux</parameter></term>
     64        <listitem>
     65          <para>Support for selinux is enabled by default, but selinux is not
     66          built in a base LFS system.  The <command>configure</command> script
     67          will fail if this option is not used.</para>
     68        </listitem>
     69      </varlistentry>
     70
     71    </variablelist>
     72
     73    <para>Disable the installation of the <command>groups</command> program
     74    and its man page, as Coreutils provides a better version:</para>
    5375
    5476<screen><userinput>sed -i 's/groups$(EXEEXT) //' src/Makefile
    5577find man -name Makefile -exec sed -i '/groups/d' {} \;</userinput></screen>
    5678
    57 <para>Disable the installation of Chinese and Korean manual pages, since Man-DB
    58 cannot format them properly:</para>
     79    <para>Disable the installation of Chinese and Korean manual pages, since
     80    Man-DB cannot format them properly:</para>
    5981
    6082<screen><userinput>sed -i -e 's/ ko//' -e 's/ zh_CN zh_TW//' man/Makefile</userinput></screen>
    6183
    62 <para>Compile the package:</para>
     84    <para>Compile the package:</para>
    6385
    6486<screen><userinput>make</userinput></screen>
    6587
    66 <para>This package does not come with a test suite.</para>
    67 
    68 <para>Install the package:</para>
     88    <para>This package does not come with a test suite.</para>
     89
     90    <para>Install the package:</para>
    6991
    7092<screen><userinput>make install</userinput></screen>
    7193
    72 <para id="shadow-limits-login_access">Shadow uses two files to configure
    73 authentication settings for the system. Install these two configuration
    74 files:</para>
    75 
    76 <indexterm zone="shadow-limits-login_access"><primary sortas="e-/etc/limits">/etc/limits</primary></indexterm>
    77 <indexterm zone="shadow-limits-login_access"><primary sortas="e-/etc/login.access">/etc/login.access</primary></indexterm>
     94    <para id="shadow-limits-login_access">Shadow uses two files to configure
     95    authentication settings for the system. Install these two configuration
     96    files:</para>
     97
     98    <indexterm zone="shadow-limits-login_access">
     99      <primary sortas="e-/etc/limits">/etc/limits</primary>
     100    </indexterm>
     101
     102    <indexterm zone="shadow-limits-login_access">
     103      <primary sortas="e-/etc/login.access">/etc/login.access</primary>
     104    </indexterm>
    78105
    79106<screen><userinput>cp -v etc/{limits,login.access} /etc</userinput></screen>
    80107
    81 <para id="shadow-login_defs">Instead of using the default <emphasis>crypt</emphasis> method,
    82 use the more secure <emphasis>MD5</emphasis> method of password
    83 encryption, which also allows passwords longer than 8 characters. It
    84 is also necessary to change the obsolete <filename
    85 class="directory">/var/spool/mail</filename> location for user
    86 mailboxes that Shadow uses by default to the <filename
    87 class="directory">/var/mail</filename> location used currently. Both
    88 of these can be accomplished by changing the relevant configuration
    89 file while copying it to its destination:</para>
    90 
    91 <indexterm zone="shadow-login_defs"><primary sortas="e-/etc/login.defs">/etc/login.defs</primary></indexterm>
    92 
    93 <note><para>If you built Shadow with Cracklib support, insert the following into
    94 the <command>sed</command> given below:</para>
     108    <para id="shadow-login_defs">Instead of using the default
     109    <emphasis>crypt</emphasis> method, use the more secure
     110    <emphasis>MD5</emphasis> method of password encryption, which also allows
     111    passwords longer than 8 characters. It is also necessary to change the
     112    obsolete <filename class="directory">/var/spool/mail</filename> location
     113    for user mailboxes that Shadow uses by default to the <filename
     114    class="directory">/var/mail</filename> location used currently. Both of
     115    these can be accomplished by changing the relevant configuration file
     116    while copying it to its destination:</para>
     117
     118    <indexterm zone="shadow-login_defs">
     119      <primary sortas="e-/etc/login.defs">/etc/login.defs</primary>
     120    </indexterm>
     121
     122    <note>
     123      <para>If you built Shadow with Cracklib support, insert the following into
     124      the <command>sed</command> given below:</para>
    95125
    96126<screen><literal>-e 's@DICTPATH.*@DICTPATH\t/lib/cracklib/pw_dict@'</literal></screen>
    97 </note>
     127    </note>
    98128
    99129<screen><userinput>sed -e's@#MD5_CRYPT_ENAB.no@MD5_CRYPT_ENAB yes@' \
    … …  
    101131    etc/login.defs &gt; /etc/login.defs</userinput></screen>
    102132
    103 <para>Move a misplaced program to its proper location:</para>
     133    <para>Move a misplaced program to its proper location:</para>
    104134
    105135<screen><userinput>mv -v /usr/bin/passwd /bin</userinput></screen>
    106136
    107 <para>Move Shadow's libraries to more appropriate locations:</para>
     137    <para>Move Shadow's libraries to more appropriate locations:</para>
    108138
    109139<screen><userinput>mv -v /lib/libshadow.*a /usr/lib
    … …  
    111141ln -sfv ../../lib/libshadow.so.0 /usr/lib/libshadow.so</userinput></screen>
    112142
    113 <para>The <parameter>-D</parameter> option of the
    114 <command>useradd</command> program requires the <filename
    115 class="directory">/etc/default</filename> directory for it to work
    116 properly:</para>
     143    <para>The <parameter>-D</parameter> option of the
     144    <command>useradd</command> program requires the <filename
     145    class="directory">/etc/default</filename> directory for it to work
     146    properly:</para>
    117147
    118148<screen><userinput>mkdir -v /etc/default</userinput></screen>
    119149
    120 </sect2>
    121 
    122 
    123 <sect2 id="conf-shadow" role="configuration"><title>Configuring Shadow</title>
    124 <indexterm zone="conf-shadow">
    125 <primary sortas="a-Shadow">Shadow</primary>
    126 <secondary>configuring</secondary></indexterm>
    127 
    128 <para>This package contains utilities to add, modify, and delete users
    129 and groups; set and change their passwords; and perform other
    130 administrative tasks. For a full explanation of what
    131 <emphasis>password shadowing</emphasis> means, see the
    132 <filename>doc/HOWTO</filename> file within the unpacked source tree.
    133 If using Shadow support, keep in mind that programs which need to
    134 verify passwords (display managers, FTP programs, pop3 daemons, etc.)
    135 must be Shadow-compliant. That is, they need to be able to work with
    136 shadowed passwords.</para>
    137 
    138 <para>To enable shadowed passwords, run the following command:</para>
     150  </sect2>
     151
     152  <sect2 id="conf-shadow" role="configuration">
     153    <title>Configuring Shadow</title>
     154
     155    <indexterm zone="conf-shadow">
     156      <primary sortas="a-Shadow">Shadow</primary>
     157      <secondary>configuring</secondary>
     158    </indexterm>
     159
     160    <para>This package contains utilities to add, modify, and delete users and
     161    groups; set and change their passwords; and perform other administrative
     162    tasks. For a full explanation of what <emphasis>password shadowing</emphasis>
     163    means, see the <filename>doc/HOWTO</filename> file within the unpacked
     164    source tree. If using Shadow support, keep in mind that programs which need
     165    to verify passwords (display managers, FTP programs, pop3 daemons, etc.)
     166    must be Shadow-compliant. That is, they need to be able to work with
     167    shadowed passwords.</para>
     168
     169    <para>To enable shadowed passwords, run the following command:</para>
    139170
    140171<screen><userinput>pwconv</userinput></screen>
    141172
    142 <para>To enable shadowed group passwords, run:</para>
     173    <para>To enable shadowed group passwords, run:</para>
    143174
    144175<screen><userinput>grpconv</userinput></screen>
    145176
    146 <para>Under normal circumstances, passwords will not have been created
    147 yet. However, if returning to this section later to enable shadowing,
    148 reset any current user passwords with the <command>passwd</command>
    149 command or any group passwords with the <command>gpasswd</command>
    150 command.</para>
    151 
    152 </sect2>
    153 
    154 
    155 <sect2 role="configuration">
    156 <title>Setting the root password</title>
    157 
    158 <para>Choose a password for user <emphasis>root</emphasis> and set it
    159 by running:</para>
     177    <para>Under normal circumstances, passwords will not have been created
     178    yet. However, if returning to this section later to enable shadowing,
     179    reset any current user passwords with the <command>passwd</command>
     180    command or any group passwords with the <command>gpasswd</command>
     181    command.</para>
     182
     183  </sect2>
     184
     185  <sect2 role="configuration">
     186    <title>Setting the root password</title>
     187
     188    <para>Choose a password for user <emphasis>root</emphasis> and set it
     189    by running:</para>
    160190
    161191<screen role="nodump"><userinput>passwd root</userinput></screen>
    162 </sect2>
    163 
    164 
    165 <sect2 id="contents-shadow" role="content"><title>Contents of Shadow</title>
    166 
    167 <segmentedlist>
    168 <segtitle>Installed programs</segtitle>
    169 <segtitle>Installed libraries</segtitle>
    170 <seglistitem><seg>chage, chfn, chpasswd, chsh, expiry, faillog, gpasswd,
    171 groupadd, groupdel, groupmod, grpck, grpconv, grpunconv, lastlog, login,
    172 logoutd, newgrp, newusers, passwd, pwck, pwconv, pwunconv, sg (link to newgrp),
    173 su, useradd, userdel, usermod, vigr (link to vipw), and vipw</seg>
    174 <seg>libshadow.[a,so]</seg>
    175 </seglistitem>
    176 </segmentedlist>
    177 
    178 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    179 <?dbfo list-presentation="list"?>
    180 <?dbhtml list-presentation="table"?>
    181 
    182 <varlistentry id="chage">
    183 <term><command>chage</command></term>
    184 <listitem>
    185 <para>Used to change the maximum number of days between obligatory
    186 password changes</para>
    187 <indexterm zone="ch-system-shadow chage"><primary sortas="b-chage">chage</primary></indexterm>
    188 </listitem>
    189 </varlistentry>
    190 
    191 <varlistentry id="chfn">
    192 <term><command>chfn</command></term>
    193 <listitem>
    194 <para>Used to change a user's full name and other information</para>
    195 <indexterm zone="ch-system-shadow chfn"><primary sortas="b-chfn">chfn</primary></indexterm>
    196 </listitem>
    197 </varlistentry>
    198 
    199 <varlistentry id="chpasswd">
    200 <term><command>chpasswd</command></term>
    201 <listitem>
    202 <para>Used to update the passwords of an entire series of user
    203 accounts</para>
    204 <indexterm zone="ch-system-shadow chpasswd"><primary sortas="b-chpasswd">chpasswd</primary></indexterm>
    205 </listitem>
    206 </varlistentry>
    207 
    208 <varlistentry id="chsh">
    209 <term><command>chsh</command></term>
    210 <listitem>
    211 <para>Used to change a user's default login shell</para>
    212 <indexterm zone="ch-system-shadow chsh"><primary sortas="b-chsh">chsh</primary></indexterm>
    213 </listitem>
    214 </varlistentry>
    215 
    216 <varlistentry id="expiry">
    217 <term><command>expiry</command></term>
    218 <listitem>
    219 <para>Checks and enforces the current password expiration policy</para>
    220 <indexterm zone="ch-system-shadow expiry"><primary sortas="b-expiry">expiry</primary></indexterm>
    221 </listitem>
    222 </varlistentry>
    223 
    224 <varlistentry id="faillog">
    225 <term><command>faillog</command></term>
    226 <listitem>
    227 <para>Is used to examine the log of login failures, to set a maximum number of
    228 failures before an account is blocked, or to reset the failure count</para>
    229 <indexterm zone="ch-system-shadow faillog"><primary sortas="b-faillog">faillog</primary></indexterm>
    230 </listitem>
    231 </varlistentry>
    232 
    233 <varlistentry id="gpasswd">
    234 <term><command>gpasswd</command></term>
    235 <listitem>
    236 <para>Is used to add and delete members and administrators to groups</para>
    237 <indexterm zone="ch-system-shadow gpasswd"><primary sortas="b-gpasswd">gpasswd</primary></indexterm>
    238 </listitem>
    239 </varlistentry>
    240 
    241 <varlistentry id="groupadd">
    242 <term><command>groupadd</command></term>
    243 <listitem>
    244 <para>Creates a group with the given name</para>
    245 <indexterm zone="ch-system-shadow groupadd"><primary sortas="b-groupadd">groupadd</primary></indexterm>
    246 </listitem>
    247 </varlistentry>
    248 
    249 <varlistentry id="groupdel">
    250 <term><command>groupdel</command></term>
    251 <listitem>
    252 <para>Deletes the group with the given name</para>
    253 <indexterm zone="ch-system-shadow groupdel"><primary sortas="b-groupdel">groupdel</primary></indexterm>
    254 </listitem>
    255 </varlistentry>
    256 
    257 <varlistentry id="groupmod">
    258 <term><command>groupmod</command></term>
    259 <listitem>
    260 <para>Is used to modify the given group's name or GID</para>
    261 <indexterm zone="ch-system-shadow groupmod"><primary sortas="b-groupmod">groupmod</primary></indexterm>
    262 </listitem>
    263 </varlistentry>
    264 
    265 <varlistentry id="grpck">
    266 <term><command>grpck</command></term>
    267 <listitem>
    268 <para>Verifies the integrity of the group files <filename>/etc/group</filename>
    269 and <filename>/etc/gshadow</filename></para>
    270 <indexterm zone="ch-system-shadow grpck"><primary sortas="b-grpck">grpck</primary></indexterm>
    271 </listitem>
    272 </varlistentry>
    273 
    274 <varlistentry id="grpconv">
    275 <term><command>grpconv</command></term>
    276 <listitem>
    277 <para>Creates or updates the shadow group file from the normal group file</para>
    278 <indexterm zone="ch-system-shadow grpconv"><primary sortas="b-grpconv">grpconv</primary></indexterm>
    279 </listitem>
    280 </varlistentry>
    281 
    282 <varlistentry id="grpunconv">
    283 <term><command>grpunconv</command></term>
    284 <listitem>
    285 <para>Updates <filename>/etc/group</filename>
    286 from <filename>/etc/gshadow</filename> and then deletes the latter</para>
    287 <indexterm zone="ch-system-shadow grpunconv"><primary sortas="b-grpunconv">grpunconv</primary></indexterm>
    288 </listitem>
    289 </varlistentry>
    290 
    291 <varlistentry id="lastlog">
    292 <term><command>lastlog</command></term>
    293 <listitem>
    294 <para>Reports the most recent login of all users or of a given user</para>
    295 <indexterm zone="ch-system-shadow lastlog"><primary sortas="b-lastlog">lastlog</primary></indexterm>
    296 </listitem>
    297 </varlistentry>
    298 
    299 <varlistentry id="login">
    300 <term><command>login</command></term>
    301 <listitem>
    302 <para>Is used by the system to let users sign on</para>
    303 <indexterm zone="ch-system-shadow login"><primary sortas="b-login">login</primary></indexterm>
    304 </listitem>
    305 </varlistentry>
    306 
    307 <varlistentry id="logoutd">
    308 <term><command>logoutd</command></term>
    309 <listitem>
    310 <para>Is a daemon used to enforce restrictions on log-on time and ports</para>
    311 <indexterm zone="ch-system-shadow logoutd"><primary sortas="b-logoutd">logoutd</primary></indexterm>
    312 </listitem>
    313 </varlistentry>
    314 
    315 <varlistentry id="newgrp">
    316 <term><command>newgrp</command></term>
    317 <listitem>
    318 <para>Is used to change the current GID during a login session</para>
    319 <indexterm zone="ch-system-shadow newgrp"><primary sortas="b-newgrp">newgrp</primary></indexterm>
    320 </listitem>
    321 </varlistentry>
    322 
    323 <varlistentry id="newusers">
    324 <term><command>newusers</command></term>
    325 <listitem>
    326 <para>Is used to create or update an entire series of user accounts</para>
    327 <indexterm zone="ch-system-shadow newusers"><primary sortas="b-newusers">newusers</primary></indexterm>
    328 </listitem>
    329 </varlistentry>
    330 
    331 <varlistentry id="passwd">
    332 <term><command>passwd</command></term>
    333 <listitem>
    334 <para>Is used to change the password for a user or group account</para>
    335 <indexterm zone="ch-system-shadow passwd"><primary sortas="b-passwd">passwd</primary></indexterm>
    336 </listitem>
    337 </varlistentry>
    338 
    339 <varlistentry id="pwck">
    340 <term><command>pwck</command></term>
    341 <listitem>
    342 <para>Verifies the integrity of the password files
    343 <filename>/etc/passwd</filename> and <filename>/etc/shadow</filename></para>
    344 <indexterm zone="ch-system-shadow pwck"><primary sortas="b-pwck">pwck</primary></indexterm>
    345 </listitem>
    346 </varlistentry>
    347 
    348 <varlistentry id="pwconv">
    349 <term><command>pwconv</command></term>
    350 <listitem>
    351 <para>Creates or updates the shadow password file from the normal
    352 password file</para>
    353 <indexterm zone="ch-system-shadow pwconv"><primary sortas="b-pwconv">pwconv</primary></indexterm>
    354 </listitem>
    355 </varlistentry>
    356 
    357 <varlistentry id="pwunconv">
    358 <term><command>pwunconv</command></term>
    359 <listitem>
    360 <para>Updates <filename>/etc/passwd</filename>
    361 from <filename>/etc/shadow</filename> and then deletes the latter</para>
    362 <indexterm zone="ch-system-shadow pwunconv"><primary sortas="b-pwunconv">pwunconv</primary></indexterm>
    363 </listitem>
    364 </varlistentry>
    365 
    366 <varlistentry id="sg">
    367 <term><command>sg</command></term>
    368 <listitem>
    369 <para>Executes a given command while the user's GID
    370 is set to that of the given group</para>
    371 <indexterm zone="ch-system-shadow sg"><primary sortas="b-sg">sg</primary></indexterm>
    372 </listitem>
    373 </varlistentry>
    374 
    375 <varlistentry id="su">
    376 <term><command>su</command></term>
    377 <listitem>
    378 <indexterm zone="ch-system-shadow su"><primary sortas="b-su">su</primary></indexterm>
    379 <para>Runs a shell with substitute user and group IDs</para>
    380 </listitem>
    381 </varlistentry>
    382 
    383 <varlistentry id="useradd">
    384 <term><command>useradd</command></term>
    385 <listitem>
    386 <para>Creates a new user with the given name, or updates the default
    387 new-user information</para>
    388 <indexterm zone="ch-system-shadow useradd"><primary sortas="b-useradd">useradd</primary></indexterm>
    389 </listitem>
    390 </varlistentry>
    391 
    392 <varlistentry id="userdel">
    393 <term><command>userdel</command></term>
    394 <listitem>
    395 <para>Deletes the given user account</para>
    396 <indexterm zone="ch-system-shadow userdel"><primary sortas="b-userdel">userdel</primary></indexterm>
    397 </listitem>
    398 </varlistentry>
    399 
    400 <varlistentry id="usermod">
    401 <term><command>usermod</command></term>
    402 <listitem>
    403 <para>Is used to modify the given user's login name, User
    404 Identification (UID),
    405 shell, initial group, home directory, etc.</para>
    406 <indexterm zone="ch-system-shadow usermod"><primary sortas="b-usermod">usermod</primary></indexterm>
    407 </listitem>
    408 </varlistentry>
    409 
    410 <varlistentry id="vigr">
    411 <term><command>vigr</command></term>
    412 <listitem>
    413 <para>Edits the <filename>/etc/group</filename> or
    414 <filename>/etc/gshadow</filename> files</para>
    415 <indexterm zone="ch-system-shadow vigr"><primary sortas="b-vigr">vigr</primary></indexterm>
    416 </listitem>
    417 </varlistentry>
    418 
    419 <varlistentry id="vipw">
    420 <term><command>vipw</command></term>
    421 <listitem>
    422 <para>Edits the <filename>/etc/passwd</filename> or
    423 <filename>/etc/shadow</filename> files</para>
    424 <indexterm zone="ch-system-shadow vipw"><primary sortas="b-vipw">vipw</primary></indexterm>
    425 </listitem>
    426 </varlistentry>
    427 
    428 <varlistentry id="libshadow">
    429 <term><filename class="libraryfile">libshadow</filename></term>
    430 <listitem>
    431 <para>Contains functions used by most programs in this package</para>
    432 <indexterm zone="ch-system-shadow libshadow"><primary sortas="c-libshadow">libshadow</primary></indexterm>
    433 </listitem>
    434 </varlistentry>
    435 </variablelist>
    436 
    437 </sect2>
     192
     193  </sect2>
     194
     195  <sect2 id="contents-shadow" role="content">
     196    <title>Contents of Shadow</title>
     197
     198    <segmentedlist>
     199      <segtitle>Installed programs</segtitle>
     200      <segtitle>Installed libraries</segtitle>
     201
     202      <seglistitem>
     203        <seg>chage, chfn, chpasswd, chsh, expiry, faillog, gpasswd, groupadd,
     204        groupdel, groupmod, grpck, grpconv, grpunconv, lastlog, login, logoutd,
     205        newgrp, newusers, passwd, pwck, pwconv, pwunconv, sg (link to newgrp),
     206        su, useradd, userdel, usermod, vigr (link to vipw), and vipw</seg>
     207        <seg>libshadow.[a,so]</seg>
     208      </seglistitem>
     209    </segmentedlist>
     210
     211    <variablelist>
     212      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     213      <?dbfo list-presentation="list"?>
     214      <?dbhtml list-presentation="table"?>
     215
     216      <varlistentry id="chage">
     217        <term><command>chage</command></term>
     218        <listitem>
     219          <para>Used to change the maximum number of days between obligatory
     220          password changes</para>
     221          <indexterm zone="ch-system-shadow chage">
     222            <primary sortas="b-chage">chage</primary>
     223          </indexterm>
     224        </listitem>
     225      </varlistentry>
     226
     227      <varlistentry id="chfn">
     228        <term><command>chfn</command></term>
     229        <listitem>
     230          <para>Used to change a user's full name and other information</para>
     231          <indexterm zone="ch-system-shadow chfn">
     232            <primary sortas="b-chfn">chfn</primary>
     233          </indexterm>
     234        </listitem>
     235      </varlistentry>
     236
     237      <varlistentry id="chpasswd">
     238        <term><command>chpasswd</command></term>
     239        <listitem>
     240          <para>Used to update the passwords of an entire series of user
     241          accounts</para>
     242          <indexterm zone="ch-system-shadow chpasswd">
     243            <primary sortas="b-chpasswd">chpasswd</primary>
     244          </indexterm>
     245        </listitem>
     246      </varlistentry>
     247
     248      <varlistentry id="chsh">
     249        <term><command>chsh</command></term>
     250        <listitem>
     251          <para>Used to change a user's default login shell</para>
     252          <indexterm zone="ch-system-shadow chsh">
     253            <primary sortas="b-chsh">chsh</primary>
     254          </indexterm>
     255        </listitem>
     256      </varlistentry>
     257
     258      <varlistentry id="expiry">
     259        <term><command>expiry</command></term>
     260        <listitem>
     261          <para>Checks and enforces the current password expiration policy</para>
     262          <indexterm zone="ch-system-shadow expiry">
     263            <primary sortas="b-expiry">expiry</primary>
     264          </indexterm>
     265        </listitem>
     266      </varlistentry>
     267
     268      <varlistentry id="faillog">
     269        <term><command>faillog</command></term>
     270        <listitem>
     271          <para>Is used to examine the log of login failures, to set a maximum
     272          number of failures before an account is blocked, or to reset the
     273          failure count</para>
     274          <indexterm zone="ch-system-shadow faillog">
     275            <primary sortas="b-faillog">faillog</primary>
     276          </indexterm>
     277        </listitem>
     278      </varlistentry>
     279
     280      <varlistentry id="gpasswd">
     281        <term><command>gpasswd</command></term>
     282        <listitem>
     283          <para>Is used to add and delete members and administrators to
     284          groups</para>
     285          <indexterm zone="ch-system-shadow gpasswd">
     286            <primary sortas="b-gpasswd">gpasswd</primary>
     287          </indexterm>
     288        </listitem>
     289      </varlistentry>
     290
     291      <varlistentry id="groupadd">
     292        <term><command>groupadd</command></term>
     293        <listitem>
     294          <para>Creates a group with the given name</para>
     295          <indexterm zone="ch-system-shadow groupadd">
     296            <primary sortas="b-groupadd">groupadd</primary>
     297          </indexterm>
     298        </listitem>
     299      </varlistentry>
     300
     301      <varlistentry id="groupdel">
     302        <term><command>groupdel</command></term>
     303        <listitem>
     304          <para>Deletes the group with the given name</para>
     305          <indexterm zone="ch-system-shadow groupdel">
     306            <primary sortas="b-groupdel">groupdel</primary>
     307          </indexterm>
     308        </listitem>
     309      </varlistentry>
     310
     311      <varlistentry id="groupmod">
     312        <term><command>groupmod</command></term>
     313        <listitem>
     314          <para>Is used to modify the given group's name or GID</para>
     315          <indexterm zone="ch-system-shadow groupmod">
     316            <primary sortas="b-groupmod">groupmod</primary>
     317          </indexterm>
     318        </listitem>
     319      </varlistentry>
     320
     321      <varlistentry id="grpck">
     322        <term><command>grpck</command></term>
     323        <listitem>
     324          <para>Verifies the integrity of the group files
     325          <filename>/etc/group</filename> and
     326          <filename>/etc/gshadow</filename></para>
     327          <indexterm zone="ch-system-shadow grpck">
     328            <primary sortas="b-grpck">grpck</primary>
     329          </indexterm>
     330        </listitem>
     331      </varlistentry>
     332
     333      <varlistentry id="grpconv">
     334        <term><command>grpconv</command></term>
     335        <listitem>
     336          <para>Creates or updates the shadow group file from the normal
     337          group file</para>
     338          <indexterm zone="ch-system-shadow grpconv">
     339            <primary sortas="b-grpconv">grpconv</primary>
     340          </indexterm>
     341        </listitem>
     342      </varlistentry>
     343
     344      <varlistentry id="grpunconv">
     345        <term><command>grpunconv</command></term>
     346        <listitem>
     347          <para>Updates <filename>/etc/group</filename> from
     348          <filename>/etc/gshadow</filename> and then deletes the latter</para>
     349          <indexterm zone="ch-system-shadow grpunconv">
     350            <primary sortas="b-grpunconv">grpunconv</primary>
     351          </indexterm>
     352        </listitem>
     353      </varlistentry>
     354
     355      <varlistentry id="lastlog">
     356        <term><command>lastlog</command></term>
     357        <listitem>
     358          <para>Reports the most recent login of all users or of a
     359          given user</para>
     360          <indexterm zone="ch-system-shadow lastlog">
     361            <primary sortas="b-lastlog">lastlog</primary>
     362          </indexterm>
     363        </listitem>
     364      </varlistentry>
     365
     366      <varlistentry id="login">
     367        <term><command>login</command></term>
     368        <listitem>
     369          <para>Is used by the system to let users sign on</para>
     370          <indexterm zone="ch-system-shadow login">
     371            <primary sortas="b-login">login</primary>
     372          </indexterm>
     373        </listitem>
     374      </varlistentry>
     375
     376      <varlistentry id="logoutd">
     377        <term><command>logoutd</command></term>
     378        <listitem>
     379          <para>Is a daemon used to enforce restrictions on log-on time
     380          and ports</para>
     381          <indexterm zone="ch-system-shadow logoutd">
     382            <primary sortas="b-logoutd">logoutd</primary>
     383          </indexterm>
     384        </listitem>
     385      </varlistentry>
     386
     387      <varlistentry id="newgrp">
     388        <term><command>newgrp</command></term>
     389        <listitem>
     390          <para>Is used to change the current GID during a login session</para>
     391          <indexterm zone="ch-system-shadow newgrp">
     392            <primary sortas="b-newgrp">newgrp</primary>
     393          </indexterm>
     394        </listitem>
     395      </varlistentry>
     396
     397      <varlistentry id="newusers">
     398        <term><command>newusers</command></term>
     399        <listitem>
     400          <para>Is used to create or update an entire series of user
     401          accounts</para>
     402          <indexterm zone="ch-system-shadow newusers">
     403            <primary sortas="b-newusers">newusers</primary>
     404          </indexterm>
     405        </listitem>
     406      </varlistentry>
     407
     408      <varlistentry id="passwd">
     409        <term><command>passwd</command></term>
     410        <listitem>
     411          <para>Is used to change the password for a user or group account</para>
     412          <indexterm zone="ch-system-shadow passwd">
     413            <primary sortas="b-passwd">passwd</primary>
     414          </indexterm>
     415        </listitem>
     416      </varlistentry>
     417
     418      <varlistentry id="pwck">
     419        <term><command>pwck</command></term>
     420        <listitem>
     421          <para>Verifies the integrity of the password files
     422          <filename>/etc/passwd</filename> and
     423          <filename>/etc/shadow</filename></para>
     424          <indexterm zone="ch-system-shadow pwck">
     425            <primary sortas="b-pwck">pwck</primary>
     426          </indexterm>
     427        </listitem>
     428      </varlistentry>
     429
     430      <varlistentry id="pwconv">
     431        <term><command>pwconv</command></term>
     432        <listitem>
     433          <para>Creates or updates the shadow password file from the normal
     434          password file</para>
     435          <indexterm zone="ch-system-shadow pwconv">
     436            <primary sortas="b-pwconv">pwconv</primary>
     437          </indexterm>
     438        </listitem>
     439      </varlistentry>
     440
     441      <varlistentry id="pwunconv">
     442        <term><command>pwunconv</command></term>
     443        <listitem>
     444          <para>Updates <filename>/etc/passwd</filename> from
     445          <filename>/etc/shadow</filename> and then deletes the latter</para>
     446          <indexterm zone="ch-system-shadow pwunconv">
     447            <primary sortas="b-pwunconv">pwunconv</primary>
     448          </indexterm>
     449        </listitem>
     450      </varlistentry>
     451
     452      <varlistentry id="sg">
     453        <term><command>sg</command></term>
     454        <listitem>
     455          <para>Executes a given command while the user's GID
     456          is set to that of the given group</para>
     457          <indexterm zone="ch-system-shadow sg">
     458            <primary sortas="b-sg">sg</primary>
     459          </indexterm>
     460        </listitem>
     461      </varlistentry>
     462
     463      <varlistentry id="su">
     464        <term><command>su</command></term>
     465        <listitem>
     466          <para>Runs a shell with substitute user and group IDs</para>
     467          <indexterm zone="ch-system-shadow su">
     468            <primary sortas="b-su">su</primary>
     469          </indexterm>
     470        </listitem>
     471      </varlistentry>
     472
     473      <varlistentry id="useradd">
     474        <term><command>useradd</command></term>
     475        <listitem>
     476          <para>Creates a new user with the given name, or updates the default
     477          new-user information</para>
     478          <indexterm zone="ch-system-shadow useradd">
     479            <primary sortas="b-useradd">useradd</primary>
     480          </indexterm>
     481        </listitem>
     482      </varlistentry>
     483
     484      <varlistentry id="userdel">
     485        <term><command>userdel</command></term>
     486        <listitem>
     487          <para>Deletes the given user account</para>
     488          <indexterm zone="ch-system-shadow userdel">
     489            <primary sortas="b-userdel">userdel</primary>
     490          </indexterm>
     491        </listitem>
     492      </varlistentry>
     493
     494      <varlistentry id="usermod">
     495        <term><command>usermod</command></term>
     496        <listitem>
     497          <para>Is used to modify the given user's login name, User
     498          Identification (UID), shell, initial group, home directory, etc.</para>
     499          <indexterm zone="ch-system-shadow usermod">
     500            <primary sortas="b-usermod">usermod</primary>
     501          </indexterm>
     502        </listitem>
     503      </varlistentry>
     504
     505      <varlistentry id="vigr">
     506        <term><command>vigr</command></term>
     507        <listitem>
     508          <para>Edits the <filename>/etc/group</filename> or
     509          <filename>/etc/gshadow</filename> files</para>
     510          <indexterm zone="ch-system-shadow vigr">
     511            <primary sortas="b-vigr">vigr</primary>
     512          </indexterm>
     513        </listitem>
     514      </varlistentry>
     515
     516      <varlistentry id="vipw">
     517        <term><command>vipw</command></term>
     518        <listitem>
     519          <para>Edits the <filename>/etc/passwd</filename> or
     520          <filename>/etc/shadow</filename> files</para>
     521          <indexterm zone="ch-system-shadow vipw">
     522            <primary sortas="b-vipw">vipw</primary>
     523          </indexterm>
     524        </listitem>
     525      </varlistentry>
     526
     527      <varlistentry id="libshadow">
     528        <term><filename class="libraryfile">libshadow</filename></term>
     529        <listitem>
     530          <para>Contains functions used by most programs in this package</para>
     531          <indexterm zone="ch-system-shadow libshadow">
     532            <primary sortas="c-libshadow">libshadow</primary>
     533          </indexterm>
     534        </listitem>
     535      </varlistentry>
     536
     537    </variablelist>
     538
     539  </sect2>
    438540
    439541</sect1>
    440 

  • chapter06/strippingagain.xml

    r3f3931b0 rddd5542  
    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-strippingagain">
    7 <title>Stripping Again</title>
    8 <?dbhtml filename="strippingagain.html"?>
     9  <?dbhtml filename="strippingagain.html"?>
    910
    10 <para>If the intended user is not a programmer and does not plan to do
    11 any debugging on the system software, the system size can be decreased
    12 by about 200 MB by removing the debugging symbols from binaries and
    13 libraries. This causes no inconvenience other than not being able to
    14 debug the software fully anymore.</para>
     11  <title>Stripping Again</title>
    1512
    16 <para>Most people who use the command mentioned below do not
    17 experience any difficulties. However, it is easy to make a typo and
    18 render the new system unusable, so before running the
    19 <command>strip</command> command, it is a good idea to make a
    20 backup of the LFS system in its current state.</para>
     13  <para>If the intended user is not a programmer and does not plan to do
     14  any debugging on the system software, the system size can be decreased
     15  by about 200 MB by removing the debugging symbols from binaries and
     16  libraries. This causes no inconvenience other than not being able to
     17  debug the software fully anymore.</para>
    2118
    22 <para>Before performing the stripping, take special care to ensure that
    23 none of the binaries that are about to be stripped are running. If
    24 unsure whether the user entered chroot with the command given in
    25 <xref linkend="ch-system-chroot" role=","/> first exit from
    26 chroot:</para>
     19  <para>Most people who use the command mentioned below do not
     20  experience any difficulties. However, it is easy to make a typo and
     21  render the new system unusable, so before running the
     22  <command>strip</command> command, it is a good idea to make a
     23  backup of the LFS system in its current state.</para>
     24
     25  <para>Before performing the stripping, take special care to ensure that
     26  none of the binaries that are about to be stripped are running. If
     27  unsure whether the user entered chroot with the command given in
     28  <xref linkend="ch-system-chroot" role=","/> first exit from
     29  chroot:</para>
    2730
    2831<screen role="nodump"><userinput>logout</userinput></screen>
    2932
    30 <para>Then reenter it with:</para>
     33  <para>Then reenter it with:</para>
    3134
    3235<screen role="nodump"><userinput>chroot $LFS /tools/bin/env -i \
    … …  
    3538    /tools/bin/bash --login</userinput></screen>
    3639
    37 <para>Now the binaries and libraries can be safely stripped:</para>
     40  <para>Now the binaries and libraries can be safely stripped:</para>
    3841
    3942<screen><userinput>/tools/bin/find /{,usr/}{bin,lib,sbin} -type f \
    40    -exec /tools/bin/strip --strip-debug '{}' ';'</userinput></screen>
     43  -exec /tools/bin/strip --strip-debug '{}' ';'</userinput></screen>
    4144
    42 <para>A large number of files will be reported as having their file
    43 format not recognized. These warnings can be safely ignored. These
    44 warnings indicate that those files are scripts instead of
    45 binaries.</para>
     45  <para>A large number of files will be reported as having their file
     46  format not recognized. These warnings can be safely ignored. These
     47  warnings indicate that those files are scripts instead of
     48  binaries.</para>
    4649
    47 <para>If disk space is very tight, the
    48 <parameter>--strip-all</parameter> option can be used on the binaries
    49 in <filename class="directory">/{,usr/}{bin,sbin}</filename> to gain
    50 several more megabytes. Do not use this option on libraries&mdash;they will
    51 be destroyed.</para>
     50  <para>If disk space is very tight, the
     51  <parameter>--strip-all</parameter> option can be used on the binaries
     52  in <filename class="directory">/{,usr/}{bin,sbin}</filename> to gain
     53  several more megabytes. Do not use this option on libraries&mdash;they will
     54  be destroyed.</para>
    5255
    5356</sect1>
    54 

  • chapter06/sysklogd.xml

    r3f3931b0 rddd5542  
    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]>
    6 <sect1 id="ch-system-sysklogd" xreflabel="Sysklogd" role="wrap">
    7 <title>Sysklogd-&sysklogd-version;</title>
    8 <?dbhtml filename="sysklogd.html"?>
    97
    10 <indexterm zone="ch-system-sysklogd"><primary sortas="a-Sysklogd">Sysklogd</primary></indexterm>
     8<sect1 id="ch-system-sysklogd" role="wrap">
     9  <?dbhtml filename="sysklogd.html"?>
    1110
    12 <sect2 role="package"><title/>
    13 <para>The Sysklogd package contains programs for logging system messages, such
    14 as those given by the kernel when unusual things happen.</para>
     11  <title>Sysklogd-&sysklogd-version;</title>
    1512
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>704 KB</seg></seglistitem>
    20 </segmentedlist>
     13  <indexterm zone="ch-system-sysklogd">
     14    <primary sortas="a-Sysklogd">Sysklogd</primary>
     15  </indexterm>
    2116
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Binutils, Coreutils, GCC, Glibc, Make</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
     17  <sect2 role="package">
     18    <title/>
    2719
    28 <sect2 role="installation">
    29 <title>Installation of Sysklogd</title>
     20    <para>The Sysklogd package contains programs for logging system messages,
     21    such as those given by the kernel when unusual things happen.</para>
    3022
    31 <para>The following patch fixes various issues, including a problem building
    32 Sysklogd with Linux 2.6 series kernels</para>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>704 KB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Binutils, Coreutils, GCC, Glibc, Make</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41  </sect2>
     42
     43  <sect2 role="installation">
     44    <title>Installation of Sysklogd</title>
     45
     46    <para>The following patch fixes various issues, including a problem building
     47    Sysklogd with Linux 2.6 series kernels</para>
    3348
    3449<screen><userinput>patch -Np1 -i ../&sysklogd-fixes-patch;</userinput></screen>
    3550
    36 <para>The following patch makes sysklogd treat bytes in the 0x80--0x9f range
    37 literally in the messages being logged, instead of replacing them with octal
    38 codes. Unpatched sysklogd would damage messages in the UTF-8 encoding.</para>
     51    <para>The following patch makes sysklogd treat bytes in the 0x80--0x9f range
     52    literally in the messages being logged, instead of replacing them with octal
     53    codes. Unpatched sysklogd would damage messages in the UTF-8 encoding.</para>
    3954
    4055<screen><userinput>patch -Np1 -i ../&sysklogd-8bit-patch;</userinput></screen>
    4156
    42 <para>Compile the package:</para>
     57    <para>Compile the package:</para>
    4358
    4459<screen><userinput>make</userinput></screen>
    4560
    46 <para>This package does not come with a test suite.</para>
     61    <para>This package does not come with a test suite.</para>
    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="conf-sysklogd" role="configuration">
     70    <title>Configuring Sysklogd</title>
    5471
    55 <sect2 id="conf-sysklogd" role="configuration"><title>Configuring Sysklogd</title>
    56 <indexterm zone="conf-sysklogd">
    57 <primary sortas="a-Sysklogd">Sysklogd</primary>
    58 <secondary>configuring</secondary></indexterm>
     72    <indexterm zone="conf-sysklogd">
     73      <primary sortas="a-Sysklogd">Sysklogd</primary>
     74      <secondary>configuring</secondary>
     75    </indexterm>
    5976
    60 <indexterm zone="conf-sysklogd"><primary sortas="e-/etc/syslog.conf">/etc/syslog.conf</primary></indexterm>
     77    <indexterm zone="conf-sysklogd">
     78      <primary sortas="e-/etc/syslog.conf">/etc/syslog.conf</primary>
     79    </indexterm>
    6180
    62 <para>Create a new <filename>/etc/syslog.conf</filename> file by running the
    63 following:</para>
     81    <para>Create a new <filename>/etc/syslog.conf</filename> file by running the
     82    following:</para>
    6483
    6584<screen><userinput>cat &gt; /etc/syslog.conf &lt;&lt; "EOF"
    … …  
    8099EOF</userinput></screen>
    81100
    82 </sect2>
     101  </sect2>
    83102
     103  <sect2 id="contents-sysklogd" role="content">
     104    <title>Contents of Sysklogd</title>
    84105
    85 <sect2 id="contents-sysklogd" role="content"><title>Contents of Sysklogd</title>
     106    <segmentedlist>
     107      <segtitle>Installed programs</segtitle>
    86108
    87 <segmentedlist>
    88 <segtitle>Installed programs</segtitle>
    89 <seglistitem><seg>klogd and syslogd</seg></seglistitem>
    90 </segmentedlist>
     109      <seglistitem>
     110        <seg>klogd and syslogd</seg>
     111      </seglistitem>
     112    </segmentedlist>
    91113
    92 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    93 <?dbfo list-presentation="list"?>
    94 <?dbhtml list-presentation="table"?>
     114    <variablelist>
     115      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     116      <?dbfo list-presentation="list"?>
     117      <?dbhtml list-presentation="table"?>
    95118
    96 <varlistentry id="klogd">
    97 <term><command>klogd</command></term>
    98 <listitem>
    99 <para>A system daemon for intercepting and logging kernel messages</para>
    100 <indexterm zone="ch-system-sysklogd klogd"><primary sortas="b-klogd">klogd</primary></indexterm>
    101 </listitem>
    102 </varlistentry>
     119      <varlistentry id="klogd">
     120        <term><command>klogd</command></term>
     121        <listitem>
     122          <para>A system daemon for intercepting and logging kernel messages</para>
     123          <indexterm zone="ch-system-sysklogd klogd">
     124            <primary sortas="b-klogd">klogd</primary>
     125          </indexterm>
     126        </listitem>
     127      </varlistentry>
    103128
    104 <varlistentry id="syslogd">
    105 <term><command>syslogd</command></term>
    106 <listitem>
    107 <para>Logs the messages that system programs offer for logging. Every logged
    108 message contains at least a date stamp and a hostname, and normally the
    109 program's name too, but that depends on how trusting the logging daemon is told
    110 to be</para>
    111 <indexterm zone="ch-system-sysklogd syslogd"><primary sortas="b-syslogd">syslogd</primary></indexterm>
    112 </listitem>
    113 </varlistentry>
    114 </variablelist>
     129      <varlistentry id="syslogd">
     130        <term><command>syslogd</command></term>
     131        <listitem>
     132          <para>Logs the messages that system programs offer for logging. Every
     133          logged message contains at least a date stamp and a hostname, and
     134          normally the program's name too, but that depends on how trusting the
     135          logging daemon is told to be</para>
     136          <indexterm zone="ch-system-sysklogd syslogd">
     137            <primary sortas="b-syslogd">syslogd</primary>
     138          </indexterm>
     139        </listitem>
     140      </varlistentry>
    115141
    116 </sect2>
     142    </variablelist>
     143
     144  </sect2>
    117145
    118146</sect1>

  • chapter06/sysvinit.xml

    r3f3931b0 rddd5542  
    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-sysvinit" role="wrap">
    7 <title>Sysvinit-&sysvinit-version;</title>
    8 <?dbhtml filename="sysvinit.html"?>
    9 
    10 <indexterm zone="ch-system-sysvinit"><primary sortas="a-Sysvinit">Sysvinit</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Sysvinit package contains programs for controlling the startup,
    14 running, and shutdown of the system.</para>
    15 
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>1012 KB</seg></seglistitem>
    20 </segmentedlist>
    21 
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Binutils, Coreutils, GCC, Glibc, and Make</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
    27 
    28 <sect2 role="installation">
    29 <title>Installation of Sysvinit</title>
    30 
    31 <para>When run-levels are changed (for example, when halting the
    32 system), <command>init</command> sends termination signals to those
    33 processes that <command>init</command> itself started and that should
    34 not be running in the new run-level.  While doing this,
    35 <command>init</command> outputs messages like <quote>Sending processes
    36 the TERM signal</quote> which seem to imply that it is sending these
    37 signals to all currently running processes. To avoid this
    38 misinterpretation, modify the source so that these messages read like
    39 <quote>Sending processes started by init the TERM signal</quote>
    40 instead:</para>
     9  <?dbhtml filename="sysvinit.html"?>
     10
     11  <title>Sysvinit-&sysvinit-version;</title>
     12
     13  <indexterm zone="ch-system-sysvinit">
     14    <primary sortas="a-Sysvinit">Sysvinit</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Sysvinit package contains programs for controlling the startup,
     21    running, and shutdown of the system.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.1 SBU</seg><seg>1012 KB</seg>
     29      </seglistitem>
     30    </segmentedlist>
     31
     32    <segmentedlist>
     33      <segtitle>&dependencies;</segtitle>
     34
     35      <seglistitem>
     36        <seg>Binutils, Coreutils, GCC, Glibc, and Make</seg>
     37      </seglistitem>
     38    </segmentedlist>
     39
     40  </sect2>
     41
     42  <sect2 role="installation">
     43    <title>Installation of Sysvinit</title>
     44
     45    <para>When run-levels are changed (for example, when halting the
     46    system), <command>init</command> sends termination signals to those
     47    processes that <command>init</command> itself started and that should
     48    not be running in the new run-level.  While doing this,
     49    <command>init</command> outputs messages like <quote>Sending processes
     50    the TERM signal</quote> which seem to imply that it is sending these
     51    signals to all currently running processes. To avoid this
     52    misinterpretation, modify the source so that these messages read like
     53    <quote>Sending processes started by init the TERM signal</quote>
     54    instead:</para>
    4155
    4256<screen><userinput>sed -i 's@Sending processes@&amp; started by init@g' \
    4357    src/init.c</userinput></screen>
    4458
    45 <para>Compile the package:</para>
     59    <para>Compile the package:</para>
    4660
    4761<screen><userinput>make -C src</userinput></screen>
    4862
    49 <para>This package does not come with a test suite.</para>
    50 
    51 <para>Install the package:</para>
     63    <para>This package does not come with a test suite.</para>
     64
     65    <para>Install the package:</para>
    5266
    5367<screen><userinput>make -C src install</userinput></screen>
    5468
    55 </sect2>
    56 
    57 
    58 <sect2 id="conf-sysvinit" role="configuration"><title>Configuring Sysvinit</title>
    59 <indexterm zone="conf-sysvinit">
    60 <primary sortas="a-Sysvinit">Sysvinit</primary>
    61 <secondary>configuring</secondary></indexterm>
    62 
    63 <indexterm zone="conf-sysvinit"><primary sortas="e-/etc/inittab">/etc/inittab</primary></indexterm>
    64 
    65 <para>Create a new file <filename>/etc/inittab</filename> by running the
    66 following:</para>
     69  </sect2>
     70
     71  <sect2 id="conf-sysvinit" role="configuration">
     72    <title>Configuring Sysvinit</title>
     73
     74    <indexterm zone="conf-sysvinit">
     75      <primary sortas="a-Sysvinit">Sysvinit</primary>
     76      <secondary>configuring</secondary>
     77    </indexterm>
     78
     79    <indexterm zone="conf-sysvinit">
     80      <primary sortas="e-/etc/inittab">/etc/inittab</primary>
     81    </indexterm>
     82
     83    <para>Create a new file <filename>/etc/inittab</filename> by running the
     84    following:</para>
    6785
    6886<screen><userinput>cat &gt; /etc/inittab &lt;&lt; "EOF"
    … …  
    94112# End /etc/inittab</literal>
    95113EOF</userinput></screen>
    96 </sect2>
    97 
    98 
    99 <sect2 id="contents-sysvinit" role="content"><title>Contents of Sysvinit</title>
    100 
    101 <segmentedlist>
    102 <segtitle>Installed programs</segtitle>
    103 <seglistitem><seg>halt, init, killall5, last, lastb (link to last), mesg, pidof (link to
    104 killall5), poweroff (link to halt), reboot (link to halt), runlevel, shutdown, sulogin, telinit
    105 (link to init), utmpdump, and wall</seg></seglistitem>
    106 </segmentedlist>
    107 
    108 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    109 <?dbfo list-presentation="list"?>
    110 <?dbhtml list-presentation="table"?>
    111 
    112 <varlistentry id="halt">
    113 <term><command>halt</command></term>
    114 <listitem>
    115 <para>Normally invokes <command>shutdown</command> with the
    116 <parameter>-h</parameter> option, except when already in run-level 0,
    117 then it tells the kernel to halt the system; it notes in the
    118 file <filename>/var/log/wtmp</filename> that the system is being
    119 brought down</para>
    120 <indexterm zone="ch-system-sysvinit halt"><primary sortas="b-halt">halt</primary></indexterm>
    121 </listitem>
    122 </varlistentry>
    123 
    124 <varlistentry id="init">
    125 <term><command>init</command></term>
    126 <listitem>
    127 <para>The first process to be started when the kernel has initialized
    128 the hardware which takes over the boot process and
    129 starts all the proceses it is instructed to</para>
    130 <indexterm zone="ch-system-sysvinit init"><primary sortas="b-init">init</primary></indexterm>
    131 </listitem>
    132 </varlistentry>
    133 
    134 <varlistentry id="killall5">
    135 <term><command>killall5</command></term>
    136 <listitem>
    137 <para>Sends a signal to all processes, except the processes in its own
    138 session so it will not kill the shell running the script that called
    139 it</para>
    140 <indexterm zone="ch-system-sysvinit killall5"><primary sortas="b-killall5">killall5</primary></indexterm>
    141 </listitem>
    142 </varlistentry>
    143 
    144 <varlistentry id="last">
    145 <term><command>last</command></term>
    146 <listitem>
    147 <para>Shows which users last logged in (and out),
    148 searching back through the <filename>/var/log/wtmp</filename> file; it
    149 also shows system boots, shutdowns, and run-level changes</para>
    150 <indexterm zone="ch-system-sysvinit last"><primary sortas="b-last">last</primary></indexterm>
    151 </listitem>
    152 </varlistentry>
    153 
    154 <varlistentry id="lastb">
    155 <term><command>lastb</command></term>
    156 <listitem>
    157 <para>Shows the failed login attempts, as logged in
    158 <filename>/var/log/btmp</filename></para>
    159 <indexterm zone="ch-system-sysvinit lastb"><primary sortas="b-lastb">lastb</primary></indexterm>
    160 </listitem>
    161 </varlistentry>
    162 
    163 <varlistentry id="mesg">
    164 <term><command>mesg</command></term>
    165 <listitem>
    166 <para>Controls whether other users can send messages to the current
    167 user's terminal</para>
    168 <indexterm zone="ch-system-sysvinit mesg"><primary sortas="b-mesg">mesg</primary></indexterm>
    169 </listitem>
    170 </varlistentry>
    171 
    172 <varlistentry id="mountpoint">
    173 <term><command>mountpoint</command></term>
    174 <listitem>
    175 <para>Checks if the directory is a mountpoint</para>
    176 <indexterm zone="ch-system-sysvinit mountpoint"><primary sortas="b-mountpoint">mountpoint</primary></indexterm>
    177 </listitem>
    178 </varlistentry>
    179 
    180 <varlistentry id="pidof">
    181 <term><command>pidof</command></term>
    182 <listitem>
    183 <para>Reports the PIDs of the given programs</para>
    184 <indexterm zone="ch-system-sysvinit pidof"><primary sortas="b-pidof">pidof</primary></indexterm>
    185 </listitem>
    186 </varlistentry>
    187 
    188 <varlistentry id="poweroff">
    189 <term><command>poweroff</command></term>
    190 <listitem>
    191 <para>Tells the kernel to halt the system and switch off the computer
    192 (see <command>halt</command>)</para>
    193 <indexterm zone="ch-system-sysvinit poweroff"><primary sortas="b-poweroff">poweroff</primary></indexterm>
    194 </listitem>
    195 </varlistentry>
    196 
    197 <varlistentry id="reboot">
    198 <term><command>reboot</command></term>
    199 <listitem>
    200 <para>Tells the kernel to reboot the system (see
    201 <command>halt</command>)</para>
    202 <indexterm zone="ch-system-sysvinit reboot"><primary sortas="b-reboot">reboot</primary></indexterm>
    203 </listitem>
    204 </varlistentry>
    205 
    206 <varlistentry id="runlevel">
    207 <term><command>runlevel</command></term>
    208 <listitem>
    209 <para>Reports the previous and the current run-level, as noted in the last run-level
    210 record in <filename>/var/run/utmp</filename></para>
    211 <indexterm zone="ch-system-sysvinit runlevel"><primary sortas="b-runlevel">runlevel</primary></indexterm>
    212 </listitem>
    213 </varlistentry>
    214 
    215 <varlistentry id="shutdown">
    216 <term><command>shutdown</command></term>
    217 <listitem>
    218 <para>Brings the system down in a secure way, signaling all processes
    219 and notifying all logged-in users</para>
    220 <indexterm zone="ch-system-sysvinit shutdown"><primary sortas="b-shutdown">shutdown</primary></indexterm>
    221 </listitem>
    222 </varlistentry>
    223 
    224 <varlistentry id="sulogin">
    225 <term><command>sulogin</command></term>
    226 <listitem>
    227 <para>Allows <emphasis>root</emphasis> to log in; it is
    228 normally invoked by <command>init</command> when the system goes into single user mode</para>
    229 <indexterm zone="ch-system-sysvinit sulogin"><primary sortas="b-sulogin">sulogin</primary></indexterm>
    230 </listitem>
    231 </varlistentry>
    232 
    233 <varlistentry id="telinit">
    234 <term><command>telinit</command></term>
    235 <listitem>
    236 <para>Tells <command>init</command> which run-level to change to</para>
    237 <indexterm zone="ch-system-sysvinit telinit"><primary sortas="b-telinit">telinit</primary></indexterm>
    238 </listitem>
    239 </varlistentry>
    240 
    241 <varlistentry id="utmpdump">
    242 <term><command>utmpdump</command></term>
    243 <listitem>
    244 <para>Displays the content of the given login file in a more
    245 user-friendly format</para>
    246 <indexterm zone="ch-system-sysvinit utmpdump"><primary sortas="b-utmpdump">utmpdump</primary></indexterm>
    247 </listitem>
    248 </varlistentry>
    249 
    250 <varlistentry id="wall">
    251 <term><command>wall</command></term>
    252 <listitem>
    253 <para>Writes a message to all logged-in users</para>
    254 <indexterm zone="ch-system-sysvinit wall"><primary sortas="b-wall">wall</primary></indexterm>
    255 </listitem>
    256 </varlistentry>
    257 </variablelist>
    258 
    259 </sect2>
     114
     115  </sect2>
     116
     117  <sect2 id="contents-sysvinit" role="content">
     118    <title>Contents of Sysvinit</title>
     119
     120    <segmentedlist>
     121      <segtitle>Installed programs</segtitle>
     122
     123      <seglistitem>
     124        <seg>halt, init, killall5, last, lastb (link to last), mesg, mountpoint,
     125        pidof (link to killall5), poweroff (link to halt), reboot (link to halt),
     126        runlevel, shutdown, sulogin, telinit (link to init), utmpdump, and
     127        wall</seg>
     128      </seglistitem>
     129    </segmentedlist>
     130
     131    <variablelist>
     132      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     133      <?dbfo list-presentation="list"?>
     134      <?dbhtml list-presentation="table"?>
     135
     136      <varlistentry id="halt">
     137        <term><command>halt</command></term>
     138        <listitem>
     139          <para>Normally invokes <command>shutdown</command> with the
     140          <parameter>-h</parameter> option, except when already in run-level 0,
     141          then it tells the kernel to halt the system; it notes in the
     142          file <filename>/var/log/wtmp</filename> that the system is being
     143          brought down</para>
     144          <indexterm zone="ch-system-sysvinit halt">
     145            <primary sortas="b-halt">halt</primary>
     146          </indexterm>
     147        </listitem>
     148      </varlistentry>
     149
     150      <varlistentry id="init">
     151        <term><command>init</command></term>
     152        <listitem>
     153          <para>The first process to be started when the kernel has initialized
     154          the hardware which takes over the boot process and starts all the
     155          proceses it is instructed to</para>
     156          <indexterm zone="ch-system-sysvinit init">
     157            <primary sortas="b-init">init</primary>
     158          </indexterm>
     159        </listitem>
     160      </varlistentry>
     161
     162      <varlistentry id="killall5">
     163        <term><command>killall5</command></term>
     164        <listitem>
     165          <para>Sends a signal to all processes, except the processes in its own
     166          session so it will not kill the shell running the script that called
     167          it</para>
     168          <indexterm zone="ch-system-sysvinit killall5">
     169            <primary sortas="b-killall5">killall5</primary>
     170          </indexterm>
     171        </listitem>
     172      </varlistentry>
     173
     174      <varlistentry id="last">
     175        <term><command>last</command></term>
     176        <listitem>
     177          <para>Shows which users last logged in (and out), searching back
     178          through the <filename>/var/log/wtmp</filename> file; it also shows
     179          system boots, shutdowns, and run-level changes</para>
     180          <indexterm zone="ch-system-sysvinit last">
     181            <primary sortas="b-last">last</primary>
     182          </indexterm>
     183        </listitem>
     184      </varlistentry>
     185
     186      <varlistentry id="lastb">
     187        <term><command>lastb</command></term>
     188        <listitem>
     189          <para>Shows the failed login attempts, as logged in
     190          <filename>/var/log/btmp</filename></para>
     191          <indexterm zone="ch-system-sysvinit lastb">
     192            <primary sortas="b-lastb">lastb</primary>
     193          </indexterm>
     194        </listitem>
     195      </varlistentry>
     196
     197      <varlistentry id="mesg">
     198        <term><command>mesg</command></term>
     199        <listitem>
     200          <para>Controls whether other users can send messages to the current
     201          user's terminal</para>
     202          <indexterm zone="ch-system-sysvinit mesg">
     203            <primary sortas="b-mesg">mesg</primary>
     204          </indexterm>
     205        </listitem>
     206      </varlistentry>
     207
     208      <varlistentry id="mountpoint">
     209        <term><command>mountpoint</command></term>
     210        <listitem>
     211          <para>Checks if the directory is a mountpoint</para>
     212          <indexterm zone="ch-system-sysvinit mountpoint">
     213            <primary sortas="b-mountpoint">mountpoint</primary>
     214          </indexterm>
     215        </listitem>
     216      </varlistentry>
     217
     218      <varlistentry id="pidof">
     219        <term><command>pidof</command></term>
     220        <listitem>
     221          <para>Reports the PIDs of the given programs</para>
     222          <indexterm zone="ch-system-sysvinit pidof">
     223            <primary sortas="b-pidof">pidof</primary>
     224          </indexterm>
     225        </listitem>
     226      </varlistentry>
     227
     228      <varlistentry id="poweroff">
     229        <term><command>poweroff</command></term>
     230        <listitem>
     231          <para>Tells the kernel to halt the system and switch off the computer
     232          (see <command>halt</command>)</para>
     233          <indexterm zone="ch-system-sysvinit poweroff">
     234            <primary sortas="b-poweroff">poweroff</primary>
     235          </indexterm>
     236        </listitem>
     237      </varlistentry>
     238
     239      <varlistentry id="reboot">
     240        <term><command>reboot</command></term>
     241        <listitem>
     242          <para>Tells the kernel to reboot the system (see
     243          <command>halt</command>)</para>
     244          <indexterm zone="ch-system-sysvinit reboot">
     245            <primary sortas="b-reboot">reboot</primary>
     246          </indexterm>
     247        </listitem>
     248      </varlistentry>
     249
     250      <varlistentry id="runlevel">
     251        <term><command>runlevel</command></term>
     252        <listitem>
     253          <para>Reports the previous and the current run-level, as noted in the
     254          last run-level record in <filename>/var/run/utmp</filename></para>
     255          <indexterm zone="ch-system-sysvinit runlevel">
     256            <primary sortas="b-runlevel">runlevel</primary>
     257          </indexterm>
     258        </listitem>
     259      </varlistentry>
     260
     261      <varlistentry id="shutdown">
     262        <term><command>shutdown</command></term>
     263        <listitem>
     264          <para>Brings the system down in a secure way, signaling all processes
     265          and notifying all logged-in users</para>
     266          <indexterm zone="ch-system-sysvinit shutdown">
     267            <primary sortas="b-shutdown">shutdown</primary>
     268          </indexterm>
     269        </listitem>
     270      </varlistentry>
     271
     272      <varlistentry id="sulogin">
     273        <term><command>sulogin</command></term>
     274        <listitem>
     275          <para>Allows <systemitem class="username">root</systemitem> to log in;
     276          it is normally invoked by <command>init</command> when the system goes
     277          into single user mode</para>
     278          <indexterm zone="ch-system-sysvinit sulogin">
     279            <primary sortas="b-sulogin">sulogin</primary>
     280          </indexterm>
     281        </listitem>
     282      </varlistentry>
     283
     284      <varlistentry id="telinit">
     285        <term><command>telinit</command></term>
     286        <listitem>
     287          <para>Tells <command>init</command> which run-level to change to</para>
     288          <indexterm zone="ch-system-sysvinit telinit">
     289            <primary sortas="b-telinit">telinit</primary>
     290          </indexterm>
     291        </listitem>
     292      </varlistentry>
     293
     294      <varlistentry id="utmpdump">
     295        <term><command>utmpdump</command></term>
     296        <listitem>
     297          <para>Displays the content of the given login file in a more
     298          user-friendly format</para>
     299          <indexterm zone="ch-system-sysvinit utmpdump">
     300            <primary sortas="b-utmpdump">utmpdump</primary>
     301          </indexterm>
     302        </listitem>
     303      </varlistentry>
     304
     305      <varlistentry id="wall">
     306        <term><command>wall</command></term>
     307        <listitem>
     308          <para>Writes a message to all logged-in users</para>
     309          <indexterm zone="ch-system-sysvinit wall">
     310            <primary sortas="b-wall">wall</primary>
     311          </indexterm>
     312        </listitem>
     313      </varlistentry>
     314
     315    </variablelist>
     316
     317  </sect2>
    260318
    261319</sect1>
    262 

  • chapter06/tar.xml

    r3f3931b0 rddd5542  
    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-tar" role="wrap">
    7 <title>Tar-&tar-version;</title>
    8 <?dbhtml filename="tar.html"?>
     9  <?dbhtml filename="tar.html"?>
    910
    10 <indexterm zone="ch-system-tar"><primary sortas="a-Tar">Tar</primary></indexterm>
     11  <title>Tar-&tar-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Tar package contains an archiving program.</para>
     13  <indexterm zone="ch-system-tar">
     14    <primary sortas="a-Tar">Tar</primary>
     15  </indexterm>
    1416
    15 <segmentedlist>
    16 <segtitle>&buildtime;</segtitle>
    17 <segtitle>&diskspace;</segtitle>
    18 <seglistitem><seg>0.2 SBU</seg><seg>12.7 MB</seg></seglistitem>
    19 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2019
    21 <segmentedlist>
    22 <segtitle>&dependencies;</segtitle>
    23 <seglistitem><seg>Bash, Binutils, Coreutils,
    24 Diffutils, GCC, Gettext, Glibc, Grep, Make, and Sed</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
     20    <para>The Tar package contains an archiving program.</para>
    2721
    28 <sect2 role="installation">
    29 <title>Installation of Tar</title>
     22    <segmentedlist>
     23      <segtitle>&buildtime;</segtitle>
     24      <segtitle>&diskspace;</segtitle>
    3025
    31 <para>Apply a patch to fix some issues with the test suite when using
    32 GCC-&gcc-version;:</para>
     26      <seglistitem>
     27        <seg>0.2 SBU</seg>
     28        <seg>12.7 MB</seg>
     29      </seglistitem>
     30    </segmentedlist>
     31
     32    <segmentedlist>
     33      <segtitle>&dependencies;</segtitle>
     34
     35      <seglistitem>
     36        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc,
     37        Grep, Make, and Sed</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41  </sect2>
     42
     43  <sect2 role="installation">
     44    <title>Installation of Tar</title>
     45
     46    <para>Apply a patch to fix some issues with the test suite when using
     47    GCC-&gcc-version;:</para>
    3348
    3449<screen><userinput>patch -Np1 -i ../&tar-gcc4_fix-patch;</userinput></screen>
    3550
    36 <para>Tar has a bug when the <parameter>-S</parameter> option is used
    37 with files larger than 4 GB. The following patch properly fixes this issue:</para>
     51    <para>Tar has a bug when the <parameter>-S</parameter> option is used
     52    with files larger than 4 GB. The following patch properly fixes this
     53    issue:</para>
    3854
    3955<screen><userinput>patch -Np1 -i ../&tar-sparse_fix-patch;</userinput></screen>
    4056
    41 <para>Prepare Tar for compilation:</para>
     57    <para>Prepare Tar for compilation:</para>
    4258
    4359<screen><userinput>./configure --prefix=/usr --bindir=/bin --libexecdir=/usr/sbin</userinput></screen>
    4460
    45 <para>Compile the package:</para>
     61    <para>Compile the package:</para>
    4662
    4763<screen><userinput>make</userinput></screen>
    4864
    49 <para>To test the results, issue:
    50 <userinput>make check</userinput>.</para>
     65    <para>To test the results, issue:
     66    <userinput>make check</userinput>.</para>
    5167
    52 <para>Install the package:</para>
     68    <para>Install the package:</para>
    5369
    5470<screen><userinput>make install</userinput></screen>
    5571
    56 </sect2>
     72  </sect2>
    5773
    5874
    59 <sect2 id="contents-tar" role="content"><title>Contents of Tar</title>
     75  <sect2 id="contents-tar" role="content">
     76    <title>Contents of Tar</title>
    6077
    61 <segmentedlist>
    62 <segtitle>Installed programs</segtitle>
    63 <seglistitem><seg>rmt and tar</seg></seglistitem>
    64 </segmentedlist>
     78    <segmentedlist>
     79      <segtitle>Installed programs</segtitle>
    6580
    66 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    67 <?dbfo list-presentation="list"?>
    68 <?dbhtml list-presentation="table"?>
     81      <seglistitem>
     82        <seg>rmt and tar</seg>
     83      </seglistitem>
     84    </segmentedlist>
    6985
    70 <varlistentry id="rmt">
    71 <term><command>rmt</command></term>
    72 <listitem>
    73 <para>Remotely manipulates a magnetic
    74 tape drive through an interprocess communication connection</para>
    75 <indexterm zone="ch-system-tar rmt"><primary sortas="b-rmt">rmt</primary></indexterm>
    76 </listitem>
    77 </varlistentry>
     86    <variablelist>
     87      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     88      <?dbfo list-presentation="list"?>
     89      <?dbhtml list-presentation="table"?>
    7890
    79 <varlistentry id="tar">
    80 <term><command>tar</command></term>
    81 <listitem>
    82 <para>Creates, extracts files from, and lists the contents of archives,
    83 also known as tarballs</para>
    84 <indexterm zone="ch-system-tar tar"><primary sortas="b-tar">tar</primary></indexterm>
    85 </listitem>
    86 </varlistentry>
    87 </variablelist>
     91      <varlistentry id="rmt">
     92        <term><command>rmt</command></term>
     93        <listitem>
     94          <para>Remotely manipulates a magnetic
     95          tape drive through an interprocess communication connection</para>
     96          <indexterm zone="ch-system-tar rmt">
     97            <primary sortas="b-rmt">rmt</primary>
     98          </indexterm>
     99        </listitem>
     100      </varlistentry>
    88101
    89 </sect2>
     102      <varlistentry id="tar">
     103        <term><command>tar</command></term>
     104        <listitem>
     105          <para>Creates, extracts files from, and lists the contents of archives,
     106          also known as tarballs</para>
     107          <indexterm zone="ch-system-tar tar">
     108            <primary sortas="b-tar">tar</primary>
     109          </indexterm>
     110        </listitem>
     111      </varlistentry>
     112
     113    </variablelist>
     114
     115  </sect2>
    90116
    91117</sect1>
    92 

  • chapter06/texinfo.xml

    r3f3931b0 rddd5542  
    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-texinfo" role="wrap">
    7 <title>Texinfo-&texinfo-version;</title>
    8 <?dbhtml filename="texinfo.html"?>
    9 
    10 <indexterm zone="ch-system-texinfo"><primary sortas="a-Texinfo">Texinfo</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Texinfo package contains programs for reading, writing, and
    14 converting info pages.</para>
    15 
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.2 SBU</seg><seg>14.7 MB</seg></seglistitem>
    20 </segmentedlist>
    21 
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Coreutils,
    25 Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
    28 
    29 <sect2 role="installation">
    30 <title>Installation of Texinfo</title>
    31 
    32 <para>The <command>info</command> program makes assumptions such as that
    33 a string occupies the same number of character cells on the screen and bytes
    34 in memory and that one can break the string anywhere, which fail in
    35 UTF-8 based locales. The patch below makes them valid
    36 by falling back to English messages when a multibyte locale is in use:</para>
     9  <?dbhtml filename="texinfo.html"?>
     10
     11  <title>Texinfo-&texinfo-version;</title>
     12
     13  <indexterm zone="ch-system-texinfo">
     14    <primary sortas="a-Texinfo">Texinfo</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Texinfo package contains programs for reading, writing, and
     21    converting info pages.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.2 SBU</seg>
     29        <seg>14.7 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc,
     38        Grep, Make, Ncurses, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Texinfo</title>
     46
     47    <para>The <command>info</command> program makes assumptions such as that
     48    a string occupies the same number of character cells on the screen and
     49    bytes in memory and that one can break the string anywhere, which fail
     50    in UTF-8 based locales. The patch below makes them valid by falling back
     51    to English messages when a multibyte locale is in use:</para>
    3752
    3853<screen><userinput>patch -Np1 -i ../&texinfo-multibyte-patch;</userinput></screen>
    3954
    40 <para>Texinfo allows local users to overwrite arbitrary files via a symlink
    41 attack on temporary files. Apply the following patch to fix this:</para>
     55    <para>Texinfo allows local users to overwrite arbitrary files via a symlink
     56    attack on temporary files. Apply the following patch to fix this:</para>
    4257
    4358<screen><userinput>patch -Np1 -i ../&texinfo-tempfile_fix-patch;</userinput></screen>
    4459
    45 <para>Prepare Texinfo for compilation:</para>
     60    <para>Prepare Texinfo for compilation:</para>
    4661
    4762<screen><userinput>./configure --prefix=/usr</userinput></screen>
    4863
    49 <para>Compile the package:</para>
     64    <para>Compile the package:</para>
    5065
    5166<screen><userinput>make</userinput></screen>
    5267
    53 <para>To test the results, issue:
    54 <userinput>make check</userinput>.</para>
    55 
    56 <para>Install the package:</para>
     68    <para>To test the results, issue:
     69    <userinput>make check</userinput>.</para>
     70
     71    <para>Install the package:</para>
    5772
    5873<screen><userinput>make install</userinput></screen>
    5974
    60 <para>Optionally, install the components belonging in a TeX installation:</para>
     75    <para>Optionally, install the components belonging in a TeX
     76    installation:</para>
     77    <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
    6178
    6279<screen><userinput>make TEXMF=/usr/share/texmf install-tex</userinput></screen>
    6380
    64 <para>The meaning of the make parameter:</para>
    65 
    66 <variablelist>
    67 <varlistentry>
    68 <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
    69 <listitem><para>The <envar>TEXMF</envar> makefile variable holds the location of the
    70 root of the TeX tree if, for example, a TeX package will be installed
    71 later.</para></listitem>
    72 </varlistentry>
    73 </variablelist>
    74 <!-- FIXME: doesn't the TeX installation in BLFS overwrite files there? -->
    75 
    76 <para>The Info documentation system uses a plain text file to hold its
    77 list of menu entries. The file is located at
    78 <filename>/usr/share/info/dir</filename>.  Unfortunately, due to
    79 occasional problems in the Makefiles of various packages, it can
    80 sometimes get out of sync with the info pages installed on the
    81 system. If the <filename>/usr/share/info/dir</filename> file ever
    82 needs to be recreated, the following optional commands will accomplish
    83 the task:</para>
     81    <variablelist>
     82      <title>The meaning of the make parameter:</title>
     83
     84      <varlistentry>
     85        <term><parameter>TEXMF=/usr/share/texmf</parameter></term>
     86        <listitem>
     87          <para>The <envar>TEXMF</envar> makefile variable holds the location
     88          of the root of the TeX tree if, for example, a TeX package will be
     89          installed later.</para>
     90        </listitem>
     91      </varlistentry>
     92
     93    </variablelist>
     94
     95    <para>The Info documentation system uses a plain text file to hold its list of
     96    menu entries. The file is located at <filename>/usr/share/info/dir</filename>.
     97    Unfortunately, due to occasional problems in the Makefiles of various packages,
     98    it can sometimes get out of sync with the info pages installed on the system.
     99    If the <filename>/usr/share/info/dir</filename> file ever needs to be
     100    recreated, the following optional commands will accomplish the task:</para>
    84101
    85102<screen role="nodump"><userinput>cd /usr/share/info
    … …  
    89106done</userinput></screen>
    90107
    91 </sect2>
    92 
    93 <sect2 id="contents-texinfo" role="content"><title>Contents of Texinfo</title>
    94 
    95 <segmentedlist>
    96 <segtitle>Installed programs</segtitle>
    97 <seglistitem><seg>info, infokey, install-info,
    98 makeinfo, texi2dvi, texi2pdf, and texindex</seg></seglistitem>
    99 </segmentedlist>
    100 
    101 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    102 <?dbfo list-presentation="list"?>
    103 <?dbhtml list-presentation="table"?>
    104 
    105 <varlistentry id="info">
    106 <term><command>info</command></term>
    107 <listitem>
    108 <para>Used to read info pages which are similar to man pages, but often go much
    109 deeper than just explaining all the available command line options. For example,
    110 compare <command>man bison</command> and <command>info bison</command>.</para>
    111 <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm>
    112 </listitem>
    113 </varlistentry>
    114 
    115 <varlistentry id="infokey">
    116 <term><command>infokey</command></term>
    117 <listitem>
    118 <para>Compiles a source file containing Info customizations into a
    119 binary format</para>
    120 <indexterm zone="ch-system-texinfo infokey"><primary sortas="b-infokey">infokey</primary></indexterm>
    121 </listitem>
    122 </varlistentry>
    123 
    124 <varlistentry id="install-info">
    125 <term><command>install-info</command></term>
    126 <listitem>
    127 <para>Used to install info pages; it updates entries in the
    128 <command>info</command> index file</para>
    129 <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm>
    130 </listitem>
    131 </varlistentry>
    132 
    133 <varlistentry id="makeinfo">
    134 <term><command>makeinfo</command></term>
    135 <listitem>
    136 <para>Translates the given Texinfo source documents into
    137 info pages, plain text, or HTML</para>
    138 <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm>
    139 </listitem>
    140 </varlistentry>
    141 
    142 <varlistentry id="texi2dvi">
    143 <term><command>texi2dvi</command></term>
    144 <listitem>
    145 <para>Used to format the given Texinfo document into a
    146 device-independent file that can be printed</para>
    147 <indexterm zone="ch-system-texinfo texi2dvi"><primary sortas="b-texi2dvi">texi2dvi</primary></indexterm>
    148 </listitem>
    149 </varlistentry>
    150 
    151 <varlistentry id="texi2pdf">
    152 <term><command>texi2pdf</command></term>
    153 <listitem>
    154 <para>Used to format the given Texinfo document into a
    155 Portable Document Format (PDF) file</para>
    156 <indexterm zone="ch-system-texinfo texi2pdf"><primary sortas="b-texi2pdf">texi2pdf</primary></indexterm>
    157 </listitem>
    158 </varlistentry>
    159 
    160 <varlistentry id="texindex">
    161 <term><command>texindex</command></term>
    162 <listitem>
    163 <para>Used to sort Texinfo index files</para>
    164 <indexterm zone="ch-system-texinfo texindex"><primary sortas="b-texindex">texindex</primary></indexterm>
    165 </listitem>
    166 </varlistentry>
    167 </variablelist>
    168 
    169 </sect2>
     108  </sect2>
     109
     110  <sect2 id="contents-texinfo" role="content">
     111    <title>Contents of Texinfo</title>
     112
     113    <segmentedlist>
     114      <segtitle>Installed programs</segtitle>
     115
     116      <seglistitem>
     117        <seg>info, infokey, install-info, makeinfo, texi2dvi, texi2pdf, and
     118        texindex</seg>
     119      </seglistitem>
     120    </segmentedlist>
     121
     122    <variablelist>
     123      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     124      <?dbfo list-presentation="list"?>
     125      <?dbhtml list-presentation="table"?>
     126
     127      <varlistentry id="info">
     128        <term><command>info</command></term>
     129        <listitem>
     130          <para>Used to read info pages which are similar to man pages, but
     131          often go much deeper than just explaining all the available command
     132          line options. For example, compare <command>man bison</command> and
     133          <command>info bison</command>.</para>
     134          <indexterm zone="ch-system-texinfo info">
     135            <primary sortas="b-info">info</primary>
     136          </indexterm>
     137        </listitem>
     138      </varlistentry>
     139
     140      <varlistentry id="infokey">
     141        <term><command>infokey</command></term>
     142        <listitem>
     143          <para>Compiles a source file containing Info customizations into a
     144          binary format</para>
     145          <indexterm zone="ch-system-texinfo infokey">
     146            <primary sortas="b-infokey">infokey</primary>
     147          </indexterm>
     148        </listitem>
     149      </varlistentry>
     150
     151      <varlistentry id="install-info">
     152        <term><command>install-info</command></term>
     153        <listitem>
     154          <para>Used to install info pages; it updates entries in the
     155          <command>info</command> index file</para>
     156          <indexterm zone="ch-system-texinfo install-info">
     157            <primary sortas="b-install-info">install-info</primary>
     158          </indexterm>
     159        </listitem>
     160      </varlistentry>
     161
     162      <varlistentry id="makeinfo">
     163        <term><command>makeinfo</command></term>
     164        <listitem>
     165          <para>Translates the given Texinfo source documents into
     166          info pages, plain text, or HTML</para>
     167          <indexterm zone="ch-system-texinfo makeinfo">
     168            <primary sortas="b-makeinfo">makeinfo</primary>
     169          </indexterm>
     170        </listitem>
     171      </varlistentry>
     172
     173      <varlistentry id="texi2dvi">
     174        <term><command>texi2dvi</command></term>
     175        <listitem>
     176          <para>Used to format the given Texinfo document into a
     177          device-independent file that can be printed</para>
     178          <indexterm zone="ch-system-texinfo texi2dvi">
     179            <primary sortas="b-texi2dvi">texi2dvi</primary>
     180          </indexterm>
     181        </listitem>
     182      </varlistentry>
     183
     184      <varlistentry id="texi2pdf">
     185        <term><command>texi2pdf</command></term>
     186        <listitem>
     187          <para>Used to format the given Texinfo document into a
     188          Portable Document Format (PDF) file</para>
     189          <indexterm zone="ch-system-texinfo texi2pdf">
     190            <primary sortas="b-texi2pdf">texi2pdf</primary>
     191          </indexterm>
     192        </listitem>
     193      </varlistentry>
     194
     195      <varlistentry id="texindex">
     196        <term><command>texindex</command></term>
     197        <listitem>
     198          <para>Used to sort Texinfo index files</para>
     199          <indexterm zone="ch-system-texinfo texindex">
     200            <primary sortas="b-texindex">texindex</primary>
     201          </indexterm>
     202        </listitem>
     203      </varlistentry>
     204
     205    </variablelist>
     206
     207  </sect2>
    170208
    171209</sect1>
    172 

  • chapter06/udev.xml

    r3f3931b0 rddd5542  
    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-udev" role="wrap">
    7 <title>Udev-&udev-version;</title>
    8 <?dbhtml filename="udev.html"?>
    9 
    10 <indexterm zone="ch-system-udev"><primary sortas="a-Udev">Udev</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Udev package contains programs for dynamic creation of device nodes.</para>
    14 
    15 <segmentedlist>
    16 <segtitle>&buildtime;</segtitle>
    17 <segtitle>&diskspace;</segtitle>
    18 <seglistitem><seg>0.1 SBU</seg><seg>3.8 MB</seg></seglistitem>
    19 </segmentedlist>
    20 
    21 <segmentedlist>
    22 <segtitle>&dependencies;</segtitle>
    23 <seglistitem><seg>Coreutils and Make</seg></seglistitem>
    24 </segmentedlist>
    25 
    26 </sect2>
    27 
    28 <sect2 role="installation">
    29 <title>Installation of Udev</title>
    30 
    31 <para>Compile the package:</para>
     9  <?dbhtml filename="udev.html"?>
     10
     11  <title>Udev-&udev-version;</title>
     12
     13  <indexterm zone="ch-system-udev">
     14    <primary sortas="a-Udev">Udev</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Udev package contains programs for dynamic creation of device
     21    nodes.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>3.8 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Coreutils and Make</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41  </sect2>
     42
     43  <sect2 role="installation">
     44    <title>Installation of Udev</title>
     45
     46    <para>Compile the package:</para>
    3247
    3348<screen><userinput>make EXTRAS=extras/run_directory</userinput></screen>
    3449
    35 <para>The meaning of the make option:</para>
    36 
    37 <variablelist>
    38   <varlistentry>
    39     <term><parameter>EXTRAS=extras/run_directory</parameter>
    40     </term>
    41     <listitem>
    42       <para>This builds the <command>udev_run_devd</command> and
    43         <command>udev_run_hotplugd</command> binaries, which are required for
    44         correct handling of hotpluggable devices.
    45       </para>
    46     </listitem>
    47   </varlistentry>
    48 </variablelist>
    49 
    50 <para>To test the results, issue:
    51 <userinput>make test</userinput>.</para>
    52 
    53 <para>Install the package:</para>
     50    <variablelist>
     51      <title>The meaning of the make option:</title>
     52
     53      <varlistentry>
     54        <term><parameter>EXTRAS=extras/run_directory</parameter></term>
     55        <listitem>
     56          <para>This builds the <command>udev_run_devd</command> and
     57          <command>udev_run_hotplugd</command> binaries, which are required
     58          for correct handling of hotpluggable devices.</para>
     59        </listitem>
     60      </varlistentry>
     61
     62    </variablelist>
     63
     64    <para>To test the results, issue:
     65    <userinput>make test</userinput>.</para>
     66
     67    <para>Install the package:</para>
    5468
    5569<screen><userinput>make DESTDIR=/ EXTRAS=extras/run_directory install</userinput></screen>
    5670
    57 <para>The meaning of the make option:</para>
    58 
    59 <variablelist>
    60   <varlistentry>
    61     <term><parameter>DESTDIR=/</parameter>
    62     </term>
    63     <listitem>
    64       <para>This prevents the Udev build process from killing any
    65         <command>udevd</command> processes that may be running on the host
    66         system.
    67       </para>
    68     </listitem>
    69   </varlistentry>
    70 </variablelist>
    71 
    72 <para>Udev's configuration is far from ideal by default, so install
    73 the configuration files here:</para>
     71    <variablelist>
     72      <title>The meaning of the make parameter:</title>
     73
     74      <varlistentry>
     75        <term><parameter>DESTDIR=/</parameter></term>
     76        <listitem>
     77          <para>This prevents the Udev build process from killing any
     78          <command>udevd</command> processes that may be running on the
     79          host system.</para>
     80        </listitem>
     81      </varlistentry>
     82
     83    </variablelist>
     84
     85    <para>Udev's configuration is far from ideal by default, so install
     86    the configuration files here:</para>
    7487
    7588<screen><userinput>cp -v ../&udev-config-file; /etc/udev/rules.d/25-lfs.rules</userinput></screen>
    7689
    77 <para>Install the documentation that explains how to create Udev rules:</para>
     90    <para>Install the documentation that explains how to create Udev rules:</para>
    7891
    7992<screen><userinput>install -m644 -D -v docs/writing_udev_rules/index.html /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
    8093
    81 <!-- Not for the LiveCD -->
    82 <!-- Edit Me -->
    83 <para>Run the <command>udevstart</command> program to create our full
    84 complement of device nodes.</para>
     94    <!-- Not for the LiveCD -->
     95    <!-- Edit Me -->
     96    <para>Run the <command>udevstart</command> program to create our full
     97    complement of device nodes.</para>
    8598
    8699<screen><userinput>/sbin/udevstart</userinput></screen>
    87100
    88 </sect2>
    89 
    90 <sect2 id="contents-udev" role="content"><title>Contents of Udev</title>
    91 
    92 <segmentedlist>
    93 <segtitle>Installed programs</segtitle>
    94 <segtitle>Installed directory</segtitle>
    95 <seglistitem><seg>udev, udev_run_devd, udev_run_hotplugd, udevcontrol, udevd,
    96 udevinfo, udevmonitor, udevsend, udevstart, and udevtest</seg>
    97 <seg>/etc/udev</seg></seglistitem>
    98 </segmentedlist>
    99 
    100 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    101 <?dbfo list-presentation="list"?>
    102 <?dbhtml list-presentation="table"?>
    103                                                                                
    104 <varlistentry id="udev">
    105 <term><command>udev</command></term>
    106 <listitem>
    107 <para>Creates device nodes in <filename
    108 class="directory">/dev</filename> or renames network interfaces (not
    109 in LFS) in response to hotplug events</para>
    110 <indexterm zone="ch-system-udev udev"><primary sortas="b-udev">udev</primary></indexterm>
    111 </listitem></varlistentry>
    112 
    113 <varlistentry id="udev_run_devd">
    114   <term><command>udev_run_devd</command></term>
    115   <listitem>
    116     <para>Executes programs and scripts in the
    117       <filename class="directory">/etc/dev.d/</filename> directory in response
    118       to hotplug events
    119     </para>
    120     <indexterm zone="ch-system-udev udev_run_devd">
    121       <primary sortas="b-udev_run_devd">udev_run_devd</primary>
    122     </indexterm>
    123   </listitem>
    124 </varlistentry>
    125 
    126 <varlistentry id="udev_run_hotplugd">
    127   <term><command>udev_run_hotplugd</command></term>
    128   <listitem>
    129     <para>Executes programs and scripts in the
    130       <filename class="directory">/etc/hotplug.d/</filename> directory in
    131       response to hotplug events
    132     </para>
    133     <indexterm zone="ch-system-udev udev_run_hotplugd">
    134       <primary sortas="b-udev_run_hotplugd">udev_run_hotplugd</primary>
    135     </indexterm>
    136   </listitem>
    137 </varlistentry>
    138 
    139 <varlistentry id="udevcontrol">
    140 <term><command>udevcontrol</command></term>
    141 <listitem>
    142 <para>Configures a number of options for the running <command>udevd</command>
    143 daemon, such as the log level.</para>
    144 <indexterm zone="ch-system-udev udevcontrol"><primary sortas="b-udevcontrol">udevcontrol</primary>
    145 </indexterm>
    146 </listitem></varlistentry>
    147 
    148 <varlistentry id="udevd">
    149 <term><command>udevd</command></term>
    150 <listitem>
    151 <para>A daemon that reorders hotplug events before submitting them to
    152 <command>udev</command>,
    153 thus avoiding various race conditions</para>
    154 <indexterm zone="ch-system-udev udevd"><primary sortas="b-udevd">udevd</primary></indexterm>
    155 </listitem></varlistentry>
    156 
    157 <varlistentry id="udevinfo">
    158 <term><command>udevinfo</command></term>
    159 <listitem>
    160 <para>Allows users to query the <command>udev</command> database for
    161 information on any device currently present on the system; it also
    162 provides a way to query any device in the <systemitem
    163 class="filesystem">sysfs</systemitem> tree to help create udev
    164 rules</para>
    165 <indexterm zone="ch-system-udev udevinfo"><primary sortas="b-udevinfo">udevinfo</primary></indexterm>
    166 </listitem></varlistentry>
    167 
    168 <varlistentry id="udevmonitor">
    169 <term><command>udevmonitor</command></term>
    170 <listitem>
    171 <para>Prints the event received from the kernel and the event which
    172 <command>udev</command> sends out after rule processing</para>
    173 <indexterm zone="ch-system-udev udevmonitor"><primary sortas="b-udevmonitor">udevmonitor</primary>
    174 </indexterm>
    175 </listitem></varlistentry>
    176 
    177 <varlistentry id="udevsend">
    178 <term><command>udevsend</command></term>
    179 <listitem>
    180 <para>Delivers hotplug events to <command>udevd</command></para>
    181 <indexterm zone="ch-system-udev udevsend"><primary sortas="b-udevsend">udevsend</primary></indexterm>
    182 </listitem></varlistentry>
    183 
    184 <varlistentry id="udevstart">
    185 <term><command>udevstart</command></term>
    186 <listitem>
    187 <para>Creates device nodes in <filename
    188 class="directory">/dev</filename> that correspond to drivers compiled directly
    189 into the kernel; it performs that task by simulating hotplug events presumably
    190 dropped by the kernel before invocation of this program (e.g., because the root
    191 filesystem has not been mounted) and submitting such synthetic hotplug events
    192 to <command>udev</command></para>
    193 <indexterm zone="ch-system-udev udevstart"><primary sortas="b-udevstart">udevstart</primary></indexterm>
    194 </listitem>
    195 </varlistentry>
    196 
    197 <varlistentry id="udevtest">
    198 <term><command>udevtest</command></term>
    199 <listitem>
    200 <para>Simulates a <command>udev</command> run for the given device,
    201 and prints out the name of the node the real <command>udev</command> would
    202 have created or (not in LFS) the name of the renamed network interface</para>
    203 <indexterm zone="ch-system-udev udevtest"><primary sortas="b-udevtest">udevtest</primary></indexterm>
    204 </listitem></varlistentry>
    205 
    206 <varlistentry id="etc-udev">
    207 <term><filename class="directory">/etc/udev</filename></term>
    208 <listitem>
    209 <para>Contains <command>udev</command> configuation files,
    210 device permissions, and rules for device naming</para>
    211 <indexterm zone="ch-system-udev etc-udev"><primary sortas="e-/etc/udev">/etc/udev</primary></indexterm>
    212 </listitem></varlistentry>
    213 </variablelist>
    214 </sect2>
     101  </sect2>
     102
     103  <sect2 id="contents-udev" role="content">
     104    <title>Contents of Udev</title>
     105
     106    <segmentedlist>
     107      <segtitle>Installed programs</segtitle>
     108      <segtitle>Installed directory</segtitle>
     109
     110      <seglistitem>
     111        <seg>udev, udev_run_devd, udev_run_hotplugd, udevcontrol, udevd,
     112        udevinfo, udevmonitor, udevsend, udevstart, and udevtest</seg>
     113        <seg>/etc/udev</seg>
     114      </seglistitem>
     115    </segmentedlist>
     116
     117    <variablelist>
     118      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     119      <?dbfo list-presentation="list"?>
     120      <?dbhtml list-presentation="table"?>
     121
     122      <varlistentry id="udev">
     123        <term><command>udev</command></term>
     124        <listitem>
     125          <para>Creates device nodes in <filename class="directory">/dev</filename>
     126          or renames network interfaces (not in LFS) in response to hotplug
     127          events</para>
     128          <indexterm zone="ch-system-udev udev">
     129            <primary sortas="b-udev">udev</primary>
     130          </indexterm>
     131        </listitem>
     132      </varlistentry>
     133
     134      <varlistentry id="udev_run_devd">
     135        <term><command>udev_run_devd</command></term>
     136        <listitem>
     137          <para>Executes programs and scripts in the <filename
     138          class="directory">/etc/dev.d/</filename> directory in response to
     139          hotplug events</para>
     140          <indexterm zone="ch-system-udev udev_run_devd">
     141            <primary sortas="b-udev_run_devd">udev_run_devd</primary>
     142          </indexterm>
     143        </listitem>
     144      </varlistentry>
     145
     146      <varlistentry id="udev_run_hotplugd">
     147        <term><command>udev_run_hotplugd</command></term>
     148        <listitem>
     149          <para>Executes programs and scripts in the <filename
     150          class="directory">/etc/hotplug.d/</filename> directory in response
     151          to hotplug events</para>
     152          <indexterm zone="ch-system-udev udev_run_hotplugd">
     153            <primary sortas="b-udev_run_hotplugd">udev_run_hotplugd</primary>
     154          </indexterm>
     155        </listitem>
     156      </varlistentry>
     157
     158      <varlistentry id="udevcontrol">
     159        <term><command>udevcontrol</command></term>
     160        <listitem>
     161          <para>Configures a number of options for the running
     162          <command>udevd</command> daemon, such as the log level.</para>
     163          <indexterm zone="ch-system-udev udevcontrol">
     164            <primary sortas="b-udevcontrol">udevcontrol</primary>
     165          </indexterm>
     166        </listitem>
     167      </varlistentry>
     168
     169      <varlistentry id="udevd">
     170        <term><command>udevd</command></term>
     171        <listitem>
     172          <para>A daemon that reorders hotplug events before submitting them to
     173          <command>udev</command>, thus avoiding various race conditions</para>
     174          <indexterm zone="ch-system-udev udevd">
     175            <primary sortas="b-udevd">udevd</primary>
     176          </indexterm>
     177        </listitem>
     178      </varlistentry>
     179
     180      <varlistentry id="udevinfo">
     181        <term><command>udevinfo</command></term>
     182        <listitem>
     183          <para>Allows users to query the <command>udev</command> database for
     184          information on any device currently present on the system; it also
     185          provides a way to query any device in the <systemitem
     186          class="filesystem">sysfs</systemitem> tree to help create udev
     187          rules</para>
     188          <indexterm zone="ch-system-udev udevinfo">
     189            <primary sortas="b-udevinfo">udevinfo</primary>
     190          </indexterm>
     191        </listitem>
     192      </varlistentry>
     193
     194      <varlistentry id="udevmonitor">
     195        <term><command>udevmonitor</command></term>
     196        <listitem>
     197          <para>Prints the event received from the kernel and the event which
     198          <command>udev</command> sends out after rule processing</para>
     199          <indexterm zone="ch-system-udev udevmonitor">
     200            <primary sortas="b-udevmonitor">udevmonitor</primary>
     201          </indexterm>
     202        </listitem>
     203      </varlistentry>
     204
     205      <varlistentry id="udevsend">
     206        <term><command>udevsend</command></term>
     207        <listitem>
     208          <para>Delivers hotplug events to <command>udevd</command></para>
     209          <indexterm zone="ch-system-udev udevsend">
     210            <primary sortas="b-udevsend">udevsend</primary>
     211          </indexterm>
     212        </listitem>
     213      </varlistentry>
     214
     215      <varlistentry id="udevstart">
     216        <term><command>udevstart</command></term>
     217        <listitem>
     218          <para>Creates device nodes in <filename class="directory">/dev</filename>
     219          that correspond to drivers compiled directly into the kernel; it
     220          performs that task by simulating hotplug events presumably dropped by
     221          the kernel before invocation of this program (e.g., because the root
     222          filesystem has not been mounted) and submitting such synthetic hotplug
     223          events to <command>udev</command></para>
     224          <indexterm zone="ch-system-udev udevstart">
     225            <primary sortas="b-udevstart">udevstart</primary>
     226          </indexterm>
     227        </listitem>
     228      </varlistentry>
     229
     230      <varlistentry id="udevtest">
     231        <term><command>udevtest</command></term>
     232        <listitem>
     233          <para>Simulates a <command>udev</command> run for the given device,
     234          and prints out the name of the node the real <command>udev</command>
     235          would have created or (not in LFS) the name of the renamed network
     236          interface</para>
     237          <indexterm zone="ch-system-udev udevtest">
     238            <primary sortas="b-udevtest">udevtest</primary>
     239          </indexterm>
     240        </listitem>
     241      </varlistentry>
     242
     243      <varlistentry id="etc-udev">
     244        <term><filename class="directory">/etc/udev</filename></term>
     245        <listitem>
     246          <para>Contains <command>udev</command> configuation files,
     247          device permissions, and rules for device naming</para>
     248          <indexterm zone="ch-system-udev etc-udev">
     249            <primary sortas="e-/etc/udev">/etc/udev</primary>
     250          </indexterm>
     251        </listitem>
     252      </varlistentry>
     253
     254    </variablelist>
     255
     256  </sect2>
    215257
    216258</sect1>
    217 

  • chapter06/util-linux.xml

    r3f3931b0 rddd5542  
    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-util-linux" role="wrap">
    7 <title>Util-linux-&util-linux-version;</title>
    8 <?dbhtml filename="util-linux.html"?>
    9 
    10 <indexterm zone="ch-system-util-linux"><primary sortas="a-Util-linux">Util-linux</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Util-linux package contains miscellaneous utility programs. Among
    14 them are utilities for handling file systems, consoles, partitions, and
    15 messages.</para>
    16 
    17 <segmentedlist>
    18 <segtitle>&buildtime;</segtitle>
    19 <segtitle>&diskspace;</segtitle>
    20 <seglistitem><seg>0.2 SBU</seg><seg>11.6 MB</seg></seglistitem>
    21 </segmentedlist>
    22 
    23 <segmentedlist>
    24 <segtitle>&dependencies;</segtitle>
    25 <seglistitem><seg>Bash, Binutils, Coreutils,
    26 Diffutils, GCC, Gettext, Glibc, Grep, Make, Ncurses, Sed, and Zlib</seg></seglistitem>
    27 </segmentedlist>
    28 </sect2>
    29 
    30 <sect2 role="installation">
    31 <title>FHS compliance notes</title>
    32 
    33 <para>The FHS recommends using the <filename
    34 class="directory">/var/lib/hwclock</filename> directory instead of the
    35 usual <filename class="directory">/etc</filename> directory as the
    36 location for the <filename>adjtime</filename> file. To make the
    37 <command>hwclock</command> program FHS-compliant, run the
    38 following:</para>
     9  <?dbhtml filename="util-linux.html"?>
     10
     11  <title>Util-linux-&util-linux-version;</title>
     12
     13  <indexterm zone="ch-system-util-linux">
     14    <primary sortas="a-Util-linux">Util-linux</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Util-linux package contains miscellaneous utility programs. Among
     21    them are utilities for handling file systems, consoles, partitions, and
     22    messages.</para>
     23
     24    <segmentedlist>
     25      <segtitle>&buildtime;</segtitle>
     26      <segtitle>&diskspace;</segtitle>
     27
     28      <seglistitem>
     29        <seg>0.2 SBU</seg>
     30        <seg>11.6 MB</seg>
     31      </seglistitem>
     32    </segmentedlist>
     33
     34    <segmentedlist>
     35      <segtitle>&dependencies;</segtitle>
     36
     37      <seglistitem>
     38        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc,
     39        Grep, Make, Ncurses, Sed, and Zlib</seg>
     40      </seglistitem>
     41    </segmentedlist>
     42
     43  </sect2>
     44
     45  <sect2 role="installation">
     46    <title>FHS compliance notes</title>
     47
     48    <para>The FHS recommends using the <filename
     49    class="directory">/var/lib/hwclock</filename> directory instead of the
     50    usual <filename class="directory">/etc</filename> directory as the
     51    location for the <filename>adjtime</filename> file. To make the
     52    <command>hwclock</command> program FHS-compliant, run the
     53    following:</para>
    3954
    4055<screen><userinput>sed -i 's@etc/adjtime@var/lib/hwclock/adjtime@g' \
    … …  
    4257mkdir -p /var/lib/hwclock</userinput></screen>
    4358
    44 </sect2>
    45 
    46 <sect2 role="installation">
    47 <title>Installation of Util-linux</title>
    48 
    49 <para>Util-linux fails to compile against newer versions of Linux-Libc-Headers.
    50 The following patch properly fixes this issue:</para>
     59  </sect2>
     60
     61  <sect2 role="installation">
     62    <title>Installation of Util-linux</title>
     63
     64    <para>Util-linux fails to compile against newer versions of Linux-Libc-Headers.
     65    The following patch properly fixes this issue:</para>
    5166
    5267<screen><userinput>patch -Np1 -i ../&util-linux-cramfs-patch;</userinput></screen>
    5368
    54 <para>Prepare Util-linux for compilation:</para>
     69    <para>Prepare Util-linux for compilation:</para>
    5570
    5671<screen><userinput>./configure</userinput></screen>
    5772
    58 <para>Compile the package:</para>
     73    <para>Compile the package:</para>
    5974
    6075<screen><userinput>make HAVE_KILL=yes HAVE_SLN=yes</userinput></screen>
    6176
    62 <para>The meaning of the make parameters:</para>
    63 
    64 <variablelist>
    65 <varlistentry>
    66 <term><parameter>HAVE_KILL=yes</parameter></term>
    67 <listitem><para>This prevents the
    68 <command>kill</command> program (already installed by Procps) from being
    69 built and installed again.</para></listitem>
    70 </varlistentry>
    71 
    72 <varlistentry>
    73 <term><parameter>HAVE_SLN=yes</parameter></term>
    74 <listitem><para>This prevents the <command>sln</command> program (a
    75 statically linked version of <command>ln</command> already installed
    76 by Glibc) from being built and installed again.</para></listitem>
    77 </varlistentry>
    78 </variablelist>
    79 
    80 <para>This package does not come with a test suite.</para>
    81 
    82 <para>Install the package and move the <command>logger</command> binary to
    83 <filename class="directory">/bin</filename> as it is needed by the
    84 LFS-Bootscripts package:</para>
     77    <variablelist>
     78      <title>The meaning of the make parameters:</title>
     79
     80      <varlistentry>
     81        <term><parameter>HAVE_KILL=yes</parameter></term>
     82        <listitem>
     83          <para>This prevents the <command>kill</command> program (already
     84          installed by Procps) from being built and installed again.</para>
     85        </listitem>
     86      </varlistentry>
     87
     88      <varlistentry>
     89        <term><parameter>HAVE_SLN=yes</parameter></term>
     90        <listitem>
     91          <para>This prevents the <command>sln</command> program (a
     92          statically linked version of <command>ln</command> already installed
     93          by Glibc) from being built and installed again.</para>
     94        </listitem>
     95      </varlistentry>
     96
     97    </variablelist>
     98
     99    <para>This package does not come with a test suite.</para>
     100
     101    <para>Install the package and move the <command>logger</command> binary to
     102    <filename class="directory">/bin</filename> as it is needed by the
     103    LFS-Bootscripts package:</para>
    85104
    86105<screen><userinput>make HAVE_KILL=yes HAVE_SLN=yes install
    87106mv /usr/bin/logger /bin</userinput></screen>
    88107
    89 </sect2>
    90 
    91 <sect2 id="contents-utillinux" role="content"><title>Contents of Util-linux</title>
    92 
    93 <segmentedlist>
    94 <segtitle>Installed programs</segtitle>
    95 <seglistitem><seg>agetty, arch, blockdev, cal, cfdisk, chkdupexe, col, colcrt,
    96 colrm, column, ctrlaltdel, cytune, ddate, dmesg, elvtune, fdformat, fdisk,
    97 fsck.cramfs, fsck.minix, getopt, hexdump, hwclock, ipcrm, ipcs, isosize, line,
    98 logger, look, losetup, mcookie, mkfs, mkfs.bfs, mkfs.cramfs, mkfs.minix, mkswap,
    99 more, mount, namei, pg, pivot_root, ramsize (link to rdev), raw, rdev, readprofile,
    100 rename, renice, rev, rootflags (link to rdev), script, setfdprm, setsid, setterm,
    101 sfdisk, swapdev, swapoff (link to swapon), swapon, tunelp, ul, umount, vidmode (link to rdev),
    102 whereis, and write</seg></seglistitem>
    103 </segmentedlist>
    104 
    105 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    106 <?dbfo list-presentation="list"?>
    107 <?dbhtml list-presentation="table"?>
    108 
    109 <varlistentry id="agetty">
    110 <term><command>agetty</command></term>
    111 <listitem>
    112 <para>Opens a tty port, prompts for a login name,
    113 and then invokes the <command>login</command> program</para>
    114 <indexterm zone="ch-system-util-linux agetty"><primary sortas="b-agetty">agetty</primary></indexterm>
    115 </listitem>
    116 </varlistentry>
    117 
    118 <varlistentry id="arch">
    119 <term><command>arch</command></term>
    120 <listitem>
    121 <para>Reports the machine's architecture</para>
    122 <indexterm zone="ch-system-util-linux arch"><primary sortas="b-arch">arch</primary></indexterm>
    123 </listitem>
    124 </varlistentry>
    125 
    126 <varlistentry id="blockdev">
    127 <term><command>blockdev</command></term>
    128 <listitem>
    129 <para>Allows users to call block device ioctls from the command line</para>
    130 <indexterm zone="ch-system-util-linux blockdev"><primary sortas="b-blockdev">blockdev</primary></indexterm>
    131 </listitem>
    132 </varlistentry>
    133 
    134 <varlistentry id="cal">
    135 <term><command>cal</command></term>
    136 <listitem>
    137 <para>Displays a simple calendar</para>
    138 <indexterm zone="ch-system-util-linux cal"><primary sortas="b-cal">cal</primary></indexterm>
    139 </listitem>
    140 </varlistentry>
    141 
    142 <varlistentry id="cfdisk">
    143 <term><command>cfdisk</command></term>
    144 <listitem>
    145 <para>Manipulates the partition table of the given device</para>
    146 <indexterm zone="ch-system-util-linux cfdisk"><primary sortas="b-cfdisk">cfdisk</primary></indexterm>
    147 </listitem>
    148 </varlistentry>
    149 
    150 <varlistentry id="chkdupexe">
    151 <term><command>chkdupexe</command></term>
    152 <listitem>
    153 <para>Finds duplicate executables</para>
    154 <indexterm zone="ch-system-util-linux chkdupexe"><primary sortas="b-chkdupexe">chkdupexe</primary></indexterm>
    155 </listitem>
    156 </varlistentry>
    157 
    158 <varlistentry id="col">
    159 <term><command>col</command></term>
    160 <listitem>
    161 <para>Filters out reverse line feeds</para>
    162 <indexterm zone="ch-system-util-linux col"><primary sortas="b-col">col</primary></indexterm>
    163 </listitem>
    164 </varlistentry>
    165 
    166 <varlistentry id="colcrt">
    167 <term><command>colcrt</command></term>
    168 <listitem>
    169 <para>Filters <command>nroff</command> output for terminals
    170 that lack some capabilities, such as overstriking and half-lines</para>
    171 <indexterm zone="ch-system-util-linux colcrt"><primary sortas="b-colcrt">colcrt</primary></indexterm>
    172 </listitem>
    173 </varlistentry>
    174 
    175 <varlistentry id="colrm">
    176 <term><command>colrm</command></term>
    177 <listitem>
    178 <para>Filters out the given columns</para>
    179 <indexterm zone="ch-system-util-linux colrm"><primary sortas="b-colrm">colrm</primary></indexterm>
    180 </listitem>
    181 </varlistentry>
    182 
    183 <varlistentry id="column">
    184 <term><command>column</command></term>
    185 <listitem>
    186 <para>Formats a given file into multiple columns</para>
    187 <indexterm zone="ch-system-util-linux column"><primary sortas="b-column">column</primary></indexterm>
    188 </listitem>
    189 </varlistentry>
    190 
    191 <varlistentry id="ctrlaltdel">
    192 <term><command>ctrlaltdel</command></term>
    193 <listitem>
    194 <para>Sets the function of the Ctrl+Alt+Del key combination to a hard or a
    195 soft reset</para>
    196 <indexterm zone="ch-system-util-linux ctrlaltdel"><primary sortas="b-ctrlaltdel">ctrlaltdel</primary></indexterm>
    197 </listitem>
    198 </varlistentry>
    199 
    200 <varlistentry id="cytune">
    201 <term><command>cytune</command></term>
    202 <listitem>
    203 <para>Tunes the parameters of the serial line drivers for
    204 Cyclades cards</para>
    205 <indexterm zone="ch-system-util-linux cytune"><primary sortas="b-cytune">cytune</primary></indexterm>
    206 </listitem>
    207 </varlistentry>
    208 
    209 <varlistentry id="ddate">
    210 <term><command>ddate</command></term>
    211 <listitem>
    212 <para>Gives the Discordian date or converts the given Gregorian date
    213 to a Discordian one</para>
    214 <indexterm zone="ch-system-util-linux ddate"><primary sortas="b-ddate">ddate</primary></indexterm>
    215 </listitem>
    216 </varlistentry>
    217 
    218 <varlistentry id="dmesg">
    219 <term><command>dmesg</command></term>
    220 <listitem>
    221 <para>Dumps the kernel boot messages</para>
    222 <indexterm zone="ch-system-util-linux dmesg"><primary sortas="b-dmesg">dmesg</primary></indexterm>
    223 </listitem>
    224 </varlistentry>
    225 
    226 <varlistentry id="elvtune">
    227 <term><command>elvtune</command></term>
    228 <listitem>
    229 <para>Tunes the performance and interactivity of a block
    230 device</para>
    231 <indexterm zone="ch-system-util-linux elvtune"><primary sortas="b-elvtune">elvtune</primary></indexterm>
    232 </listitem>
    233 </varlistentry>
    234 
    235 <varlistentry id="fdformat">
    236 <term><command>fdformat</command></term>
    237 <listitem>
    238 <para>Low-level formats a floppy disk</para>
    239 <indexterm zone="ch-system-util-linux fdformat"><primary sortas="b-fdformat">fdformat</primary></indexterm>
    240 </listitem>
    241 </varlistentry>
    242 
    243 <varlistentry id="fdisk">
    244 <term><command>fdisk</command></term>
    245 <listitem>
    246 <para>Manipulates the partition table of the given device</para>
    247 <indexterm zone="ch-system-util-linux fdisk"><primary sortas="b-fdisk">fdisk</primary></indexterm>
    248 </listitem>
    249 </varlistentry>
    250 
    251 <varlistentry id="fsck.cramfs">
    252 <term><command>fsck.cramfs</command></term>
    253 <listitem>
    254 <para>Performs a consistency check on the Cramfs file system on the
    255 given device</para>
    256 <indexterm zone="ch-system-util-linux fsck.cramfs"><primary sortas="b-fsck.cramfs">fsck.cramfs</primary></indexterm>
    257 </listitem>
    258 </varlistentry>
    259 
    260 <varlistentry id="fsck.minix">
    261 <term><command>fsck.minix</command></term>
    262 <listitem>
    263 <para>Performs a consistency check on the Minix file system on the
    264 given device</para>
    265 <indexterm zone="ch-system-util-linux fsck.minix"><primary sortas="b-fsck.minix">fsck.minix</primary></indexterm>
    266 </listitem>
    267 </varlistentry>
    268 
    269 <varlistentry id="getopt">
    270 <term><command>getopt</command></term>
    271 <listitem>
    272 <para>Parses options in the given command line</para>
    273 <indexterm zone="ch-system-util-linux getopt"><primary sortas="b-getopt">getopt</primary></indexterm>
    274 </listitem>
    275 </varlistentry>
    276 
    277 <varlistentry id="hexdump">
    278 <term><command>hexdump</command></term>
    279 <listitem>
    280 <para>Dumps the given file in hexadecimal or in another given format</para>
    281 <indexterm zone="ch-system-util-linux hexdump"><primary sortas="b-hexdump">hexdump</primary></indexterm>
    282 </listitem>
    283 </varlistentry>
    284 
    285 <varlistentry id="hwclock">
    286 <term><command>hwclock</command></term>
    287 <listitem>
    288 <para>Reads or sets the system's hardware clock, also called
    289 the Real-Time Clock (RTC) or Basic Input-Output System (BIOS)
    290 clock</para>
    291 <indexterm zone="ch-system-util-linux hwclock"><primary sortas="b-hwclock">hwclock</primary></indexterm>
    292 </listitem>
    293 </varlistentry>
    294 
    295 <varlistentry id="ipcrm">
    296 <term><command>ipcrm</command></term>
    297 <listitem>
    298 <para>Removes the given Inter-Process Communication (IPC) resource</para>
    299 <indexterm zone="ch-system-util-linux ipcrm"><primary sortas="b-ipcrm">ipcrm</primary></indexterm>
    300 </listitem>
    301 </varlistentry>
    302 
    303 <varlistentry id="ipcs">
    304 <term><command>ipcs</command></term>
    305 <listitem>
    306 <para>Provides IPC status information</para>
    307 <indexterm zone="ch-system-util-linux ipcs"><primary sortas="b-ipcs">ipcs</primary></indexterm>
    308 </listitem>
    309 </varlistentry>
    310 
    311 <varlistentry id="isosize">
    312 <term><command>isosize</command></term>
    313 <listitem>
    314 <para>Reports the size of an iso9660 file system</para>
    315 <indexterm zone="ch-system-util-linux isosize"><primary sortas="b-isosize">isosize</primary></indexterm>
    316 </listitem>
    317 </varlistentry>
    318 
    319 <varlistentry id="line">
    320 <term><command>line</command></term>
    321 <listitem>
    322 <para>Copies a single line</para>
    323 <indexterm zone="ch-system-util-linux line"><primary sortas="b-line">line</primary></indexterm>
    324 </listitem>
    325 </varlistentry>
    326 
    327 <varlistentry id="logger">
    328 <term><command>logger</command></term>
    329 <listitem>
    330 <para>Enters the given message into the system log</para>
    331 <indexterm zone="ch-system-util-linux logger"><primary sortas="b-logger">logger</primary></indexterm>
    332 </listitem>
    333 </varlistentry>
    334 
    335 <varlistentry id="look">
    336 <term><command>look</command></term>
    337 <listitem>
    338 <para>Displays lines that begin with the given string</para>
    339 <indexterm zone="ch-system-util-linux look"><primary sortas="b-look">look</primary></indexterm>
    340 </listitem>
    341 </varlistentry>
    342 
    343 <varlistentry id="losetup">
    344 <term><command>losetup</command></term>
    345 <listitem>
    346 <para>Sets up and controls loop devices</para>
    347 <indexterm zone="ch-system-util-linux losetup"><primary sortas="b-losetup">losetup</primary></indexterm>
    348 </listitem>
    349 </varlistentry>
    350 
    351 <varlistentry id="mcookie">
    352 <term><command>mcookie</command></term>
    353 <listitem>
    354 <para>Generates magic cookies (128-bit random hexadecimal numbers) for
    355 <command>xauth</command></para>
    356 <indexterm zone="ch-system-util-linux mcookie"><primary sortas="b-mcookie">mcookie</primary></indexterm>
    357 </listitem>
    358 </varlistentry>
    359 
    360 <varlistentry id="mkfs">
    361 <term><command>mkfs</command></term>
    362 <listitem>
    363 <para>Builds a file system on a device (usually a hard disk
    364 partition)</para>
    365 <indexterm zone="ch-system-util-linux mkfs"><primary sortas="b-mkfs">mkfs</primary></indexterm>
    366 </listitem>
    367 </varlistentry>
    368 
    369 <varlistentry id="mkfs.bfs">
    370 <term><command>mkfs.bfs</command></term>
    371 <listitem>
    372 <para>Creates a Santa Cruz Operations (SCO) bfs file system</para>
    373 <indexterm zone="ch-system-util-linux mkfs.bfs"><primary sortas="b-mkfs.bfs">mkfs.bfs</primary></indexterm>
    374 </listitem>
    375 </varlistentry>
    376 
    377 <varlistentry id="mkfs.cramfs">
    378 <term><command>mkfs.cramfs</command></term>
    379 <listitem>
    380 <para>Creates a cramfs file system</para>
    381 <indexterm zone="ch-system-util-linux mkfs.cramfs"><primary sortas="b-mkfs.cramfs">mkfs.cramfs</primary></indexterm>
    382 </listitem>
    383 </varlistentry>
    384 
    385 <varlistentry id="mkfs.minix">
    386 <term><command>mkfs.minix</command></term>
    387 <listitem>
    388 <para>Creates a Minix file system</para>
    389 <indexterm zone="ch-system-util-linux mkfs.minix"><primary sortas="b-mkfs.minix">mkfs.minix</primary></indexterm>
    390 </listitem>
    391 </varlistentry>
    392 
    393 <varlistentry id="mkswap">
    394 <term><command>mkswap</command></term>
    395 <listitem>
    396 <para>Initializes the given device or file to be used as a swap area</para>
    397 <indexterm zone="ch-system-util-linux mkswap"><primary sortas="b-mkswap">mkswap</primary></indexterm>
    398 </listitem>
    399 </varlistentry>
    400 
    401 <varlistentry id="more">
    402 <term><command>more</command></term>
    403 <listitem>
    404 <para>A filter for paging through text one screen at a time</para>
    405 <indexterm zone="ch-system-util-linux more"><primary sortas="b-more">more</primary></indexterm>
    406 </listitem>
    407 </varlistentry>
    408 
    409 <varlistentry id="mount">
    410 <term><command>mount</command></term>
    411 <listitem>
    412 <para>Attaches the file system on the given device to a specified
    413 directory in the file-system tree</para>
    414 <indexterm zone="ch-system-util-linux mount"><primary sortas="b-mount">mount</primary></indexterm>
    415 </listitem>
    416 </varlistentry>
    417 
    418 <varlistentry id="namei">
    419 <term><command>namei</command></term>
    420 <listitem>
    421 <para>Shows the symbolic links in the given pathnames</para>
    422 <indexterm zone="ch-system-util-linux namei"><primary sortas="b-namei">namei</primary></indexterm>
    423 </listitem>
    424 </varlistentry>
    425 
    426 <varlistentry id="pg">
    427 <term><command>pg</command></term>
    428 <listitem>
    429 <para>Displays a text file one screen full at a time</para>
    430 <indexterm zone="ch-system-util-linux pg"><primary sortas="b-pg">pg</primary></indexterm>
    431 </listitem>
    432 </varlistentry>
    433 
    434 <varlistentry id="pivot_root">
    435 <term><command>pivot_root</command></term>
    436 <listitem>
    437 <para>Makes the given file system the new root file system of the
    438 current process</para>
    439 <indexterm zone="ch-system-util-linux pivot_root"><primary sortas="b-pivot_root">pivot_root</primary></indexterm>
    440 </listitem>
    441 </varlistentry>
    442 
    443 <varlistentry id="ramsize">
    444 <term><command>ramsize</command></term>
    445 <listitem>
    446 <para>Sets the size of the RAM disk in a bootable image</para>
    447 <indexterm zone="ch-system-util-linux ramsize"><primary sortas="b-ramsize">ramsize</primary></indexterm>
    448 </listitem>
    449 </varlistentry>
    450 
    451 <varlistentry id="raw">
    452 <term><command>raw</command></term>
    453 <listitem>
    454 <para>Used to bind a Linux raw character device to a block
    455 device</para>
    456 <indexterm zone="ch-system-util-linux raw"><primary sortas="b-raw">raw</primary></indexterm>
    457 </listitem>
    458 </varlistentry>
    459 
    460 <varlistentry id="rdev">
    461 <term><command>rdev</command></term>
    462 <listitem>
    463 <para>Queries and sets the root device, among other things, in a
    464 bootable image</para>
    465 <indexterm zone="ch-system-util-linux rdev"><primary sortas="b-rdev">rdev</primary></indexterm>
    466 </listitem>
    467 </varlistentry>
    468 
    469 <varlistentry id="readprofile">
    470 <term><command>readprofile</command></term>
    471 <listitem>
    472 <para>Reads kernel profiling information</para>
    473 <indexterm zone="ch-system-util-linux readprofile"><primary sortas="b-readprofile">readprofile</primary></indexterm>
    474 </listitem>
    475 </varlistentry>
    476 
    477 <varlistentry id="rename">
    478 <term><command>rename</command></term>
    479 <listitem>
    480 <para>Renames the given files, replacing a given string with another</para>
    481 <indexterm zone="ch-system-util-linux rename"><primary sortas="b-rename">rename</primary></indexterm>
    482 </listitem>
    483 </varlistentry>
    484 
    485 <varlistentry id="renice">
    486 <term><command>renice</command></term>
    487 <listitem>
    488 <para>Alters the priority of running processes</para>
    489 <indexterm zone="ch-system-util-linux renice"><primary sortas="b-renice">renice</primary></indexterm>
    490 </listitem>
    491 </varlistentry>
    492 
    493 <varlistentry id="rev">
    494 <term><command>rev</command></term>
    495 <listitem>
    496 <para>Reverses the lines of a given file</para>
    497 <indexterm zone="ch-system-util-linux rev"><primary sortas="b-rev">rev</primary></indexterm>
    498 </listitem>
    499 </varlistentry>
    500 
    501 <varlistentry id="rootflags">
    502 <term><command>rootflags</command></term>
    503 <listitem>
    504 <para>Sets the rootflags in a bootable image</para>
    505 <indexterm zone="ch-system-util-linux rootflags"><primary sortas="b-rootflags">rootflags</primary></indexterm>
    506 </listitem>
    507 </varlistentry>
    508 
    509 <varlistentry id="script">
    510 <term><command>script</command></term>
    511 <listitem>
    512 <para>Makes a typescript of a terminal session</para>
    513 <indexterm zone="ch-system-util-linux script"><primary sortas="b-script">script</primary></indexterm>
    514 </listitem>
    515 </varlistentry>
    516 
    517 <varlistentry id="setfdprm">
    518 <term><command>setfdprm</command></term>
    519 <listitem>
    520 <para>Sets user-provided floppy disk parameters</para>
    521 <indexterm zone="ch-system-util-linux setfdprm"><primary sortas="b-setfdprm">setfdprm</primary></indexterm>
    522 </listitem>
    523 </varlistentry>
    524 
    525 <varlistentry id="setsid">
    526 <term><command>setsid</command></term>
    527 <listitem>
    528 <para>Runs the given program in a new session</para>
    529 <indexterm zone="ch-system-util-linux setsid"><primary sortas="b-setsid">setsid</primary></indexterm>
    530 </listitem>
    531 </varlistentry>
    532 
    533 <varlistentry id="setterm">
    534 <term><command>setterm</command></term>
    535 <listitem>
    536 <para>Sets terminal attributes</para>
    537 <indexterm zone="ch-system-util-linux setterm"><primary sortas="b-setterm">setterm</primary></indexterm>
    538 </listitem>
    539 </varlistentry>
    540 
    541 <varlistentry id="sfdisk">
    542 <term><command>sfdisk</command></term>
    543 <listitem>
    544 <para>A disk partition table manipulator</para>
    545 <indexterm zone="ch-system-util-linux sfdisk"><primary sortas="b-sfdisk">sfdisk</primary></indexterm>
    546 </listitem>
    547 </varlistentry>
    548 
    549 <varlistentry id="swapdev">
    550 <term><command>swapdev</command></term>
    551 <listitem>
    552 <para>Sets the swap device in a bootable image</para>
    553 <indexterm zone="ch-system-util-linux swapdev"><primary sortas="b-swapdev">swapdev</primary></indexterm>
    554 </listitem>
    555 </varlistentry>
    556 
    557 <varlistentry id="swapoff">
    558 <term><command>swapoff</command></term>
    559 <listitem>
    560 <para>Disables devices and files for paging and swapping</para>
    561 <indexterm zone="ch-system-util-linux swapoff"><primary sortas="b-swapoff">swapoff</primary></indexterm>
    562 </listitem>
    563 </varlistentry>
    564 
    565 <varlistentry id="swapon">
    566 <term><command>swapon</command></term>
    567 <listitem>
    568 <para>Enables devices and files for paging and swapping and lists the devices
    569 and files currently in use</para>
    570 <indexterm zone="ch-system-util-linux swapon"><primary sortas="b-swapon">swapon</primary></indexterm>
    571 </listitem>
    572 </varlistentry>
    573 
    574 <varlistentry id="tunelp">
    575 <term><command>tunelp</command></term>
    576 <listitem>
    577 <para>Tunes the parameters of the line printer</para>
    578 <indexterm zone="ch-system-util-linux tunelp"><primary sortas="b-tunelp">tunelp</primary></indexterm>
    579 </listitem>
    580 </varlistentry>
    581 
    582 <varlistentry id="ul">
    583 <term><command>ul</command></term>
    584 <listitem>
    585 <para>A filter for translating underscores into
    586 escape sequences indicating underlining for the terminal in use</para>
    587 <indexterm zone="ch-system-util-linux ul"><primary sortas="b-ul">ul</primary></indexterm>
    588 </listitem>
    589 </varlistentry>
    590 
    591 <varlistentry id="umount">
    592 <term><command>umount</command></term>
    593 <listitem>
    594 <para>Disconnects a file system from the system's file tree</para>
    595 <indexterm zone="ch-system-util-linux umount"><primary sortas="b-umount">umount</primary></indexterm>
    596 </listitem>
    597 </varlistentry>
    598 
    599 <varlistentry id="vidmode">
    600 <term><command>vidmode</command></term>
    601 <listitem>
    602 <para>Sets the video mode in a bootable image</para>
    603 <indexterm zone="ch-system-util-linux vidmode"><primary sortas="b-vidmode">vidmode</primary></indexterm>
    604 </listitem>
    605 </varlistentry>
    606 
    607 <varlistentry id="whereis">
    608 <term><command>whereis</command></term>
    609 <listitem>
    610 <para>Reports the location of the binary, source, and man page
    611 for the given command</para>
    612 <indexterm zone="ch-system-util-linux whereis"><primary sortas="b-whereis">whereis</primary></indexterm>
    613 </listitem>
    614 </varlistentry>
    615 
    616 <varlistentry id="write">
    617 <term><command>write</command></term>
    618 <listitem>
    619 <para>Sends a message to the given user
    620 <emphasis>if</emphasis> that user has not disabled receipt of such messages</para>
    621 <indexterm zone="ch-system-util-linux write"><primary sortas="b-write">write</primary></indexterm>
    622 </listitem>
    623 </varlistentry>
    624 </variablelist>
    625 
    626 </sect2>
     108  </sect2>
     109
     110  <sect2 id="contents-utillinux" role="content">
     111    <title>Contents of Util-linux</title>
     112
     113    <segmentedlist>
     114      <segtitle>Installed programs</segtitle>
     115
     116      <seglistitem>
     117        <seg>agetty, arch, blockdev, cal, cfdisk, chkdupexe, col, colcrt,
     118        colrm, column, ctrlaltdel, cytune, ddate, dmesg, elvtune, fdformat,
     119        fdisk, fsck.cramfs, fsck.minix, getopt, hexdump, hwclock, ipcrm,
     120        ipcs, isosize, line, logger, look, losetup, mcookie, mkfs, mkfs.bfs,
     121        mkfs.cramfs, mkfs.minix, mkswap, more, mount, namei, pg, pivot_root,
     122        ramsize (link to rdev), raw, rdev, readprofile, rename, renice, rev,
     123        rootflags (link to rdev), script, setfdprm, setsid, setterm, sfdisk,
     124        swapdev, swapoff (link to swapon), swapon, tunelp, ul, umount, vidmode
     125        (link to rdev), whereis, and write</seg>
     126      </seglistitem>
     127    </segmentedlist>
     128
     129    <variablelist>
     130      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     131      <?dbfo list-presentation="list"?>
     132      <?dbhtml list-presentation="table"?>
     133
     134      <varlistentry id="agetty">
     135        <term><command>agetty</command></term>
     136        <listitem>
     137          <para>Opens a tty port, prompts for a login name,
     138          and then invokes the <command>login</command> program</para>
     139          <indexterm zone="ch-system-util-linux agetty">
     140            <primary sortas="b-agetty">agetty</primary>
     141          </indexterm>
     142        </listitem>
     143      </varlistentry>
     144
     145      <varlistentry id="arch">
     146        <term><command>arch</command></term>
     147        <listitem>
     148          <para>Reports the machine's architecture</para>
     149          <indexterm zone="ch-system-util-linux arch">
     150            <primary sortas="b-arch">arch</primary>
     151          </indexterm>
     152        </listitem>
     153      </varlistentry>
     154
     155      <varlistentry id="blockdev">
     156        <term><command>blockdev</command></term>
     157        <listitem>
     158          <para>Allows users to call block device ioctls from the command
     159          line</para>
     160          <indexterm zone="ch-system-util-linux blockdev">
     161            <primary sortas="b-blockdev">blockdev</primary>
     162          </indexterm>
     163        </listitem>
     164      </varlistentry>
     165
     166      <varlistentry id="cal">
     167        <term><command>cal</command></term>
     168        <listitem>
     169          <para>Displays a simple calendar</para>
     170          <indexterm zone="ch-system-util-linux cal">
     171            <primary sortas="b-cal">cal</primary>
     172          </indexterm>
     173        </listitem>
     174      </varlistentry>
     175
     176      <varlistentry id="cfdisk">
     177        <term><command>cfdisk</command></term>
     178        <listitem>
     179          <para>Manipulates the partition table of the given device</para>
     180          <indexterm zone="ch-system-util-linux cfdisk">
     181            <primary sortas="b-cfdisk">cfdisk</primary>
     182          </indexterm>
     183        </listitem>
     184      </varlistentry>
     185
     186      <varlistentry id="chkdupexe">
     187        <term><command>chkdupexe</command></term>
     188        <listitem>
     189          <para>Finds duplicate executables</para>
     190          <indexterm zone="ch-system-util-linux chkdupexe">
     191            <primary sortas="b-chkdupexe">chkdupexe</primary>
     192          </indexterm>
     193        </listitem>
     194      </varlistentry>
     195
     196      <varlistentry id="col">
     197        <term><command>col</command></term>
     198        <listitem>
     199          <para>Filters out reverse line feeds</para>
     200          <indexterm zone="ch-system-util-linux col">
     201            <primary sortas="b-col">col</primary>
     202          </indexterm>
     203        </listitem>
     204      </varlistentry>
     205
     206      <varlistentry id="colcrt">
     207        <term><command>colcrt</command></term>
     208        <listitem>
     209          <para>Filters <command>nroff</command> output for terminals
     210          that lack some capabilities, such as overstriking and half-lines</para>
     211          <indexterm zone="ch-system-util-linux colcrt">
     212            <primary sortas="b-colcrt">colcrt</primary>
     213          </indexterm>
     214        </listitem>
     215      </varlistentry>
     216
     217      <varlistentry id="colrm">
     218        <term><command>colrm</command></term>
     219        <listitem>
     220          <para>Filters out the given columns</para>
     221          <indexterm zone="ch-system-util-linux colrm">
     222            <primary sortas="b-colrm">colrm</primary>
     223          </indexterm>
     224        </listitem>
     225      </varlistentry>
     226
     227      <varlistentry id="column">
     228        <term><command>column</command></term>
     229        <listitem>
     230          <para>Formats a given file into multiple columns</para>
     231          <indexterm zone="ch-system-util-linux column">
     232            <primary sortas="b-column">column</primary>
     233          </indexterm>
     234        </listitem>
     235      </varlistentry>
     236
     237      <varlistentry id="ctrlaltdel">
     238        <term><command>ctrlaltdel</command></term>
     239        <listitem>
     240          <para>Sets the function of the Ctrl+Alt+Del key combination to a
     241          hard or a soft reset</para>
     242          <indexterm zone="ch-system-util-linux ctrlaltdel">
     243            <primary sortas="b-ctrlaltdel">ctrlaltdel</primary>
     244          </indexterm>
     245        </listitem>
     246      </varlistentry>
     247
     248      <varlistentry id="cytune">
     249        <term><command>cytune</command></term>
     250        <listitem>
     251          <para>Tunes the parameters of the serial line drivers for
     252          Cyclades cards</para>
     253          <indexterm zone="ch-system-util-linux cytune">
     254            <primary sortas="b-cytune">cytune</primary>
     255          </indexterm>
     256        </listitem>
     257      </varlistentry>
     258
     259      <varlistentry id="ddate">
     260        <term><command>ddate</command></term>
     261        <listitem>
     262          <para>Gives the Discordian date or converts the given Gregorian date
     263          to a Discordian one</para>
     264          <indexterm zone="ch-system-util-linux ddate">
     265            <primary sortas="b-ddate">ddate</primary>
     266          </indexterm>
     267        </listitem>
     268      </varlistentry>
     269
     270      <varlistentry id="dmesg">
     271        <term><command>dmesg</command></term>
     272        <listitem>
     273          <para>Dumps the kernel boot messages</para>
     274          <indexterm zone="ch-system-util-linux dmesg">
     275            <primary sortas="b-dmesg">dmesg</primary>
     276          </indexterm>
     277        </listitem>
     278      </varlistentry>
     279
     280      <varlistentry id="elvtune">
     281        <term><command>elvtune</command></term>
     282        <listitem>
     283          <para>Tunes the performance and interactivity of a block
     284          device</para>
     285          <indexterm zone="ch-system-util-linux elvtune">
     286            <primary sortas="b-elvtune">elvtune</primary>
     287          </indexterm>
     288        </listitem>
     289      </varlistentry>
     290
     291      <varlistentry id="fdformat">
     292        <term><command>fdformat</command></term>
     293        <listitem>
     294          <para>Low-level formats a floppy disk</para>
     295          <indexterm zone="ch-system-util-linux fdformat">
     296            <primary sortas="b-fdformat">fdformat</primary>
     297          </indexterm>
     298        </listitem>
     299      </varlistentry>
     300
     301      <varlistentry id="fdisk">
     302        <term><command>fdisk</command></term>
     303        <listitem>
     304          <para>Manipulates the partition table of the given device</para>
     305          <indexterm zone="ch-system-util-linux fdisk">
     306            <primary sortas="b-fdisk">fdisk</primary>
     307          </indexterm>
     308        </listitem>
     309      </varlistentry>
     310
     311      <varlistentry id="fsck.cramfs">
     312        <term><command>fsck.cramfs</command></term>
     313        <listitem>
     314          <para>Performs a consistency check on the Cramfs file system on the
     315          given device</para>
     316          <indexterm zone="ch-system-util-linux fsck.cramfs">
     317            <primary sortas="b-fsck.cramfs">fsck.cramfs</primary>
     318          </indexterm>
     319        </listitem>
     320      </varlistentry>
     321
     322      <varlistentry id="fsck.minix">
     323        <term><command>fsck.minix</command></term>
     324        <listitem>
     325          <para>Performs a consistency check on the Minix file system on the
     326          given device</para>
     327          <indexterm zone="ch-system-util-linux fsck.minix">
     328            <primary sortas="b-fsck.minix">fsck.minix</primary>
     329          </indexterm>
     330        </listitem>
     331      </varlistentry>
     332
     333      <varlistentry id="getopt">
     334        <term><command>getopt</command></term>
     335        <listitem>
     336          <para>Parses options in the given command line</para>
     337          <indexterm zone="ch-system-util-linux getopt">
     338            <primary sortas="b-getopt">getopt</primary>
     339          </indexterm>
     340        </listitem>
     341      </varlistentry>
     342
     343      <varlistentry id="hexdump">
     344        <term><command>hexdump</command></term>
     345        <listitem>
     346          <para>Dumps the given file in hexadecimal or in another given
     347          format</para>
     348          <indexterm zone="ch-system-util-linux hexdump">
     349            <primary sortas="b-hexdump">hexdump</primary>
     350          </indexterm>
     351        </listitem>
     352      </varlistentry>
     353
     354      <varlistentry id="hwclock">
     355        <term><command>hwclock</command></term>
     356        <listitem>
     357          <para>Reads or sets the system's hardware clock, also called
     358          the Real-Time Clock (RTC) or Basic Input-Output System (BIOS)
     359          clock</para>
     360          <indexterm zone="ch-system-util-linux hwclock">
     361            <primary sortas="b-hwclock">hwclock</primary>
     362          </indexterm>
     363        </listitem>
     364      </varlistentry>
     365
     366      <varlistentry id="ipcrm">
     367        <term><command>ipcrm</command></term>
     368        <listitem>
     369          <para>Removes the given Inter-Process Communication (IPC) resource</para>
     370          <indexterm zone="ch-system-util-linux ipcrm">
     371            <primary sortas="b-ipcrm">ipcrm</primary>
     372          </indexterm>
     373        </listitem>
     374      </varlistentry>
     375
     376      <varlistentry id="ipcs">
     377        <term><command>ipcs</command></term>
     378        <listitem>
     379          <para>Provides IPC status information</para>
     380          <indexterm zone="ch-system-util-linux ipcs">
     381            <primary sortas="b-ipcs">ipcs</primary>
     382          </indexterm>
     383        </listitem>
     384      </varlistentry>
     385
     386      <varlistentry id="isosize">
     387        <term><command>isosize</command></term>
     388        <listitem>
     389          <para>Reports the size of an iso9660 file system</para>
     390          <indexterm zone="ch-system-util-linux isosize">
     391            <primary sortas="b-isosize">isosize</primary>
     392          </indexterm>
     393        </listitem>
     394      </varlistentry>
     395
     396      <varlistentry id="line">
     397        <term><command>line</command></term>
     398        <listitem>
     399          <para>Copies a single line</para>
     400          <indexterm zone="ch-system-util-linux line">
     401            <primary sortas="b-line">line</primary>
     402          </indexterm>
     403        </listitem>
     404      </varlistentry>
     405
     406      <varlistentry id="logger">
     407        <term><command>logger</command></term>
     408        <listitem>
     409          <para>Enters the given message into the system log</para>
     410          <indexterm zone="ch-system-util-linux logger">
     411            <primary sortas="b-logger">logger</primary>
     412          </indexterm>
     413        </listitem>
     414      </varlistentry>
     415
     416      <varlistentry id="look">
     417        <term><command>look</command></term>
     418        <listitem>
     419          <para>Displays lines that begin with the given string</para>
     420          <indexterm zone="ch-system-util-linux look">
     421            <primary sortas="b-look">look</primary>
     422          </indexterm>
     423        </listitem>
     424      </varlistentry>
     425
     426      <varlistentry id="losetup">
     427        <term><command>losetup</command></term>
     428        <listitem>
     429          <para>Sets up and controls loop devices</para>
     430          <indexterm zone="ch-system-util-linux losetup">
     431            <primary sortas="b-losetup">losetup</primary>
     432          </indexterm>
     433        </listitem>
     434      </varlistentry>
     435
     436      <varlistentry id="mcookie">
     437        <term><command>mcookie</command></term>
     438        <listitem>
     439          <para>Generates magic cookies (128-bit random hexadecimal numbers) for
     440          <command>xauth</command></para>
     441          <indexterm zone="ch-system-util-linux mcookie">
     442            <primary sortas="b-mcookie">mcookie</primary>
     443          </indexterm>
     444        </listitem>
     445      </varlistentry>
     446
     447      <varlistentry id="mkfs">
     448        <term><command>mkfs</command></term>
     449        <listitem>
     450          <para>Builds a file system on a device (usually a hard disk
     451          partition)</para>
     452          <indexterm zone="ch-system-util-linux mkfs">
     453            <primary sortas="b-mkfs">mkfs</primary>
     454          </indexterm>
     455        </listitem>
     456      </varlistentry>
     457
     458      <varlistentry id="mkfs.bfs">
     459        <term><command>mkfs.bfs</command></term>
     460        <listitem>
     461          <para>Creates a Santa Cruz Operations (SCO) bfs file system</para>
     462          <indexterm zone="ch-system-util-linux mkfs.bfs">
     463            <primary sortas="b-mkfs.bfs">mkfs.bfs</primary>
     464          </indexterm>
     465        </listitem>
     466      </varlistentry>
     467
     468      <varlistentry id="mkfs.cramfs">
     469        <term><command>mkfs.cramfs</command></term>
     470        <listitem>
     471          <para>Creates a cramfs file system</para>
     472          <indexterm zone="ch-system-util-linux mkfs.cramfs">
     473            <primary sortas="b-mkfs.cramfs">mkfs.cramfs</primary>
     474          </indexterm>
     475        </listitem>
     476      </varlistentry>
     477
     478      <varlistentry id="mkfs.minix">
     479        <term><command>mkfs.minix</command></term>
     480        <listitem>
     481          <para>Creates a Minix file system</para>
     482          <indexterm zone="ch-system-util-linux mkfs.minix">
     483            <primary sortas="b-mkfs.minix">mkfs.minix</primary>
     484          </indexterm>
     485        </listitem>
     486      </varlistentry>
     487
     488      <varlistentry id="mkswap">
     489        <term><command>mkswap</command></term>
     490        <listitem>
     491          <para>Initializes the given device or file to be used as a swap
     492          area</para>
     493          <indexterm zone="ch-system-util-linux mkswap">
     494            <primary sortas="b-mkswap">mkswap</primary>
     495          </indexterm>
     496        </listitem>
     497      </varlistentry>
     498
     499      <varlistentry id="more">
     500        <term><command>more</command></term>
     501        <listitem>
     502          <para>A filter for paging through text one screen at a time</para>
     503          <indexterm zone="ch-system-util-linux more">
     504            <primary sortas="b-more">more</primary>
     505          </indexterm>
     506        </listitem>
     507      </varlistentry>
     508
     509      <varlistentry id="mount">
     510        <term><command>mount</command></term>
     511        <listitem>
     512          <para>Attaches the file system on the given device to a specified
     513          directory in the file-system tree</para>
     514          <indexterm zone="ch-system-util-linux mount">
     515            <primary sortas="b-mount">mount</primary>
     516          </indexterm>
     517        </listitem>
     518      </varlistentry>
     519
     520      <varlistentry id="namei">
     521        <term><command>namei</command></term>
     522        <listitem>
     523          <para>Shows the symbolic links in the given pathnames</para>
     524          <indexterm zone="ch-system-util-linux namei">
     525            <primary sortas="b-namei">namei</primary>
     526          </indexterm>
     527        </listitem>
     528      </varlistentry>
     529
     530      <varlistentry id="pg">
     531        <term><command>pg</command></term>
     532        <listitem>
     533          <para>Displays a text file one screen full at a time</para>
     534          <indexterm zone="ch-system-util-linux pg">
     535            <primary sortas="b-pg">pg</primary>
     536          </indexterm>
     537        </listitem>
     538      </varlistentry>
     539
     540      <varlistentry id="pivot_root">
     541        <term><command>pivot_root</command></term>
     542        <listitem>
     543          <para>Makes the given file system the new root file system of the
     544          current process</para>
     545          <indexterm zone="ch-system-util-linux pivot_root">
     546            <primary sortas="b-pivot_root">pivot_root</primary>
     547          </indexterm>
     548        </listitem>
     549      </varlistentry>
     550
     551      <varlistentry id="ramsize">
     552        <term><command>ramsize</command></term>
     553        <listitem>
     554          <para>Sets the size of the RAM disk in a bootable image</para>
     555          <indexterm zone="ch-system-util-linux ramsize">
     556            <primary sortas="b-ramsize">ramsize</primary>
     557          </indexterm>
     558        </listitem>
     559      </varlistentry>
     560
     561      <varlistentry id="raw">
     562        <term><command>raw</command></term>
     563        <listitem>
     564          <para>Used to bind a Linux raw character device to a block
     565          device</para>
     566          <indexterm zone="ch-system-util-linux raw">
     567            <primary sortas="b-raw">raw</primary>
     568          </indexterm>
     569        </listitem>
     570      </varlistentry>
     571
     572      <varlistentry id="rdev">
     573        <term><command>rdev</command></term>
     574        <listitem>
     575          <para>Queries and sets the root device, among other things, in a
     576          bootable image</para>
     577          <indexterm zone="ch-system-util-linux rdev">
     578            <primary sortas="b-rdev">rdev</primary>
     579          </indexterm>
     580        </listitem>
     581      </varlistentry>
     582
     583      <varlistentry id="readprofile">
     584        <term><command>readprofile</command></term>
     585        <listitem>
     586          <para>Reads kernel profiling information</para>
     587          <indexterm zone="ch-system-util-linux readprofile">
     588            <primary sortas="b-readprofile">readprofile</primary>
     589          </indexterm>
     590        </listitem>
     591      </varlistentry>
     592
     593      <varlistentry id="rename">
     594        <term><command>rename</command></term>
     595        <listitem>
     596          <para>Renames the given files, replacing a given string with
     597          another</para>
     598          <indexterm zone="ch-system-util-linux rename">
     599            <primary sortas="b-rename">rename</primary>
     600          </indexterm>
     601        </listitem>
     602      </varlistentry>
     603
     604      <varlistentry id="renice">
     605        <term><command>renice</command></term>
     606        <listitem>
     607          <para>Alters the priority of running processes</para>
     608          <indexterm zone="ch-system-util-linux renice">
     609            <primary sortas="b-renice">renice</primary>
     610          </indexterm>
     611        </listitem>
     612      </varlistentry>
     613
     614      <varlistentry id="rev">
     615        <term><command>rev</command></term>
     616        <listitem>
     617          <para>Reverses the lines of a given file</para>
     618          <indexterm zone="ch-system-util-linux rev">
     619            <primary sortas="b-rev">rev</primary>
     620          </indexterm>
     621        </listitem>
     622      </varlistentry>
     623
     624      <varlistentry id="rootflags">
     625        <term><command>rootflags</command></term>
     626        <listitem>
     627          <para>Sets the rootflags in a bootable image</para>
     628          <indexterm zone="ch-system-util-linux rootflags">
     629            <primary sortas="b-rootflags">rootflags</primary>
     630          </indexterm>
     631        </listitem>
     632      </varlistentry>
     633
     634      <varlistentry id="script">
     635        <term><command>script</command></term>
     636        <listitem>
     637          <para>Makes a typescript of a terminal session</para>
     638          <indexterm zone="ch-system-util-linux script">
     639            <primary sortas="b-script">script</primary>
     640          </indexterm>
     641        </listitem>
     642      </varlistentry>
     643
     644      <varlistentry id="setfdprm">
     645        <term><command>setfdprm</command></term>
     646        <listitem>
     647          <para>Sets user-provided floppy disk parameters</para>
     648          <indexterm zone="ch-system-util-linux setfdprm">
     649            <primary sortas="b-setfdprm">setfdprm</primary>
     650          </indexterm>
     651        </listitem>
     652      </varlistentry>
     653
     654      <varlistentry id="setsid">
     655        <term><command>setsid</command></term>
     656        <listitem>
     657          <para>Runs the given program in a new session</para>
     658          <indexterm zone="ch-system-util-linux setsid">
     659            <primary sortas="b-setsid">setsid</primary>
     660          </indexterm>
     661        </listitem>
     662      </varlistentry>
     663
     664      <varlistentry id="setterm">
     665        <term><command>setterm</command></term>
     666        <listitem>
     667          <para>Sets terminal attributes</para>
     668          <indexterm zone="ch-system-util-linux setterm">
     669            <primary sortas="b-setterm">setterm</primary>
     670          </indexterm>
     671        </listitem>
     672      </varlistentry>
     673
     674      <varlistentry id="sfdisk">
     675        <term><command>sfdisk</command></term>
     676        <listitem>
     677          <para>A disk partition table manipulator</para>
     678          <indexterm zone="ch-system-util-linux sfdisk">
     679            <primary sortas="b-sfdisk">sfdisk</primary>
     680          </indexterm>
     681        </listitem>
     682      </varlistentry>
     683
     684      <varlistentry id="swapdev">
     685        <term><command>swapdev</command></term>
     686        <listitem>
     687          <para>Sets the swap device in a bootable image</para>
     688          <indexterm zone="ch-system-util-linux swapdev">
     689            <primary sortas="b-swapdev">swapdev</primary>
     690          </indexterm>
     691        </listitem>
     692      </varlistentry>
     693
     694      <varlistentry id="swapoff">
     695        <term><command>swapoff</command></term>
     696        <listitem>
     697          <para>Disables devices and files for paging and swapping</para>
     698          <indexterm zone="ch-system-util-linux swapoff">
     699            <primary sortas="b-swapoff">swapoff</primary>
     700          </indexterm>
     701        </listitem>
     702      </varlistentry>
     703
     704      <varlistentry id="swapon">
     705        <term><command>swapon</command></term>
     706        <listitem>
     707          <para>Enables devices and files for paging and swapping and
     708          lists the devices and files currently in use</para>
     709          <indexterm zone="ch-system-util-linux swapon">
     710            <primary sortas="b-swapon">swapon</primary>
     711          </indexterm>
     712        </listitem>
     713      </varlistentry>
     714
     715      <varlistentry id="tunelp">
     716        <term><command>tunelp</command></term>
     717        <listitem>
     718          <para>Tunes the parameters of the line printer</para>
     719          <indexterm zone="ch-system-util-linux tunelp">
     720            <primary sortas="b-tunelp">tunelp</primary>
     721          </indexterm>
     722        </listitem>
     723      </varlistentry>
     724
     725      <varlistentry id="ul">
     726        <term><command>ul</command></term>
     727        <listitem>
     728          <para>A filter for translating underscores into escape sequences
     729          indicating underlining for the terminal in use</para>
     730          <indexterm zone="ch-system-util-linux ul">
     731            <primary sortas="b-ul">ul</primary>
     732          </indexterm>
     733        </listitem>
     734      </varlistentry>
     735
     736      <varlistentry id="umount">
     737        <term><command>umount</command></term>
     738        <listitem>
     739          <para>Disconnects a file system from the system's file tree</para>
     740          <indexterm zone="ch-system-util-linux umount">
     741            <primary sortas="b-umount">umount</primary>
     742          </indexterm>
     743        </listitem>
     744      </varlistentry>
     745
     746      <varlistentry id="vidmode">
     747        <term><command>vidmode</command></term>
     748        <listitem>
     749          <para>Sets the video mode in a bootable image</para>
     750          <indexterm zone="ch-system-util-linux vidmode">
     751            <primary sortas="b-vidmode">vidmode</primary>
     752          </indexterm>
     753        </listitem>
     754      </varlistentry>
     755
     756      <varlistentry id="whereis">
     757        <term><command>whereis</command></term>
     758        <listitem>
     759          <para>Reports the location of the binary, source, and man page
     760          for the given command</para>
     761          <indexterm zone="ch-system-util-linux whereis">
     762            <primary sortas="b-whereis">whereis</primary>
     763          </indexterm>
     764        </listitem>
     765      </varlistentry>
     766
     767      <varlistentry id="write">
     768        <term><command>write</command></term>
     769        <listitem>
     770          <para>Sends a message to the given user <emphasis>if</emphasis> that
     771          user has not disabled receipt of such messages</para>
     772          <indexterm zone="ch-system-util-linux write">
     773            <primary sortas="b-write">write</primary>
     774          </indexterm>
     775        </listitem>
     776      </varlistentry>
     777
     778    </variablelist>
     779
     780  </sect2>
    627781
    628782</sect1>
    629 

  • chapter06/vim.xml

    r3f3931b0 rddd5542  
    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-vim" role="wrap">
    7 <title>Vim-&vim-version;</title>
    8 <?dbhtml filename="vim.html"?>
    9 
    10 <indexterm zone="ch-system-vim"><primary sortas="a-Vim">Vim</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Vim package contains a powerful text editor.</para>
    14 
    15 <segmentedlist>
    16 <segtitle>&buildtime;</segtitle>
    17 <segtitle>&diskspace;</segtitle>
    18 <seglistitem><seg>0.4 SBU</seg><seg>38.0 MB</seg></seglistitem>
    19 </segmentedlist>
    20 
    21 <segmentedlist>
    22 <segtitle>&dependencies;</segtitle>
    23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
    24 GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem>
    25 </segmentedlist>
    26 
    27 <tip>
    28 <title>Alternatives to Vim</title>
    29 <para>If you prefer another editor&mdash;such as Emacs, Joe, or
    30 Nano&mdash;please refer to <ulink url="&blfs-root;view/svn/postlfs/editors.html"/>
    31 for suggested installation instructions.</para>
    32 </tip>
    33 </sect2>
    34 
    35 <sect2 role="installation">
    36 <title>Installation of Vim</title>
    37 
    38 <para>First, unpack both
    39 <filename>vim-&vim-version;.tar.bz2</filename> and (optionally)
    40 <filename>vim-&vim-version;-lang.tar.gz</filename> archives into the
    41 same directory. Then, change the default location of the
    42 <filename>vimrc</filename> configuration file to <filename
    43 class="directory">/etc</filename>:</para>
     9  <?dbhtml filename="vim.html"?>
     10
     11  <title>Vim-&vim-version;</title>
     12
     13  <indexterm zone="ch-system-vim">
     14    <primary sortas="a-Vim">Vim</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Vim package contains a powerful text editor.</para>
     21
     22    <segmentedlist>
     23      <segtitle>&buildtime;</segtitle>
     24      <segtitle>&diskspace;</segtitle>
     25
     26      <seglistitem>
     27        <seg>0.4 SBU</seg>
     28        <seg>38.0 MB</seg>
     29      </seglistitem>
     30    </segmentedlist>
     31
     32    <segmentedlist>
     33      <segtitle>&dependencies;</segtitle>
     34
     35      <seglistitem>
     36        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make,
     37        Ncurses, and Sed</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41    <tip>
     42      <title>Alternatives to Vim</title>
     43
     44      <para>If you prefer another editor&mdash;such as Emacs, Joe, or
     45      Nano&mdash;please refer to <ulink
     46      url="&blfs-root;view/svn/postlfs/editors.html"/> for suggested
     47      installation instructions.</para>
     48    </tip>
     49
     50  </sect2>
     51
     52  <sect2 role="installation">
     53    <title>Installation of Vim</title>
     54
     55    <para>First, unpack both
     56    <filename>vim-&vim-version;.tar.bz2</filename> and (optionally)
     57    <filename>vim-&vim-version;-lang.tar.gz</filename> archives into the
     58    same directory. Then, change the default location of the
     59    <filename>vimrc</filename> configuration file to <filename
     60    class="directory">/etc</filename>:</para>
    4461
    4562<screen><userinput>echo '#define SYS_VIMRC_FILE "/etc/vimrc"' &gt;&gt; src/feature.h</userinput></screen>
    4663
    47 <para>Now prepare Vim for compilation:</para>
     64    <para>Now prepare Vim for compilation:</para>
    4865
    4966<screen><userinput>./configure --prefix=/usr --enable-multibyte</userinput></screen>
    5067
    51 <para>The meaning of the configure options:</para>
    52 
    53 <variablelist>
    54 <varlistentry>
    55 <term><parameter>--enable-multibyte</parameter></term>
    56 <listitem><para>This switch enables support for
    57 editing files in multibyte character encodings.  This is needed if using a
    58 locale with a multibyte character set. This switch is also helpful to be able to
    59 edit text files initially created in Linux distributions like Fedora Core that
    60 use UTF-8 as a default character set.</para>
    61 </listitem>
    62 </varlistentry>
    63 </variablelist>
    64 
    65 <para>Compile the package:</para>
     68    <variablelist>
     69      <title>The meaning of the configure options:</title>
     70
     71      <varlistentry>
     72        <term><parameter>--enable-multibyte</parameter></term>
     73        <listitem>
     74          <para>This switch enables support for editing files in multibyte
     75          character encodings.  This is needed if using a locale with a
     76          multibyte character set. This switch is also helpful to be able
     77          to edit text files initially created in Linux distributions like
     78          Fedora Core that use UTF-8 as a default character set.</para>
     79        </listitem>
     80      </varlistentry>
     81
     82    </variablelist>
     83
     84    <para>Compile the package:</para>
    6685
    6786<screen><userinput>make</userinput></screen>
    6887
    69 <para>To test the results, issue: <userinput>make test</userinput>. However,
    70 this test suite outputs a lot of binary data to the screen, which can cause
    71 issues with the settings of the current terminal. This can be resolved by
    72 redirecting the output to a log file.</para>
    73 
    74 <para>Install the package:</para>
     88    <para>To test the results, issue: <userinput>make test</userinput>. However,
     89    this test suite outputs a lot of binary data to the screen, which can cause
     90    issues with the settings of the current terminal. This can be resolved by
     91    redirecting the output to a log file.</para>
     92
     93    <para>Install the package:</para>
    7594
    7695<screen><userinput>make install</userinput></screen>
    7796
    78 <para>In UTF-8 locales, the <command>vimtutor</command> program
    79 tries to convert the tutorials from ISO-8859-1 to UTF-8. Since
    80 some tutorials are not in ISO-8859-1, the text in them is thus made unreadable.
    81 If you unpacked the <filename>vim-&vim-version;-lang.tar.gz</filename>
    82 archive and are going to use a UTF-8 based locale, remove non-ISO-8859-1
    83 tutorials. An English tutorial will be used instead.</para>
    84 <!-- Removal is used instead of conversion in order for the user to be able to
    85 painlessly revert his UTF-8 locale choice. -->
     97    <para>In UTF-8 locales, the <command>vimtutor</command> program tries to
     98    convert the tutorials from ISO-8859-1 to UTF-8. Since some tutorials are
     99    not in ISO-8859-1, the text in them is thus made unreadable. If you
     100    unpacked the <filename>vim-&vim-version;-lang.tar.gz</filename> archive
     101    and are going to use a UTF-8 based locale, remove non-ISO-8859-1 tutorials.
     102    An English tutorial will be used instead.</para>
     103    <!-- Removal is used instead of conversion in order for the user to be able to
     104    painlessly revert his UTF-8 locale choice. -->
    86105
    87106<screen><userinput>rm -f /usr/share/vim/vim64/tutor/tutor.{gr,pl,ru,sk}
    88107rm -f /usr/share/vim/vim64/tutor/tutor.??.*</userinput></screen>
    89108
    90 <para>Many users are used to using <command>vi</command> instead of
    91 <command>vim</command>. To allow execution of <command>vim</command>
    92 when users habitually enter <command>vi</command>, create a
    93 symlink:</para>
     109    <para>Many users are used to using <command>vi</command> instead of
     110    <command>vim</command>. To allow execution of <command>vim</command>
     111    when users habitually enter <command>vi</command>, create a
     112    symlink:</para>
    94113
    95114<screen><userinput>ln -sv vim /usr/bin/vi</userinput></screen>
    96115
    97 <para>By default, Vim's documentation is installed in
    98 <filename class="directory">/usr/share/vim</filename>. The following symlink
    99 allows the documentation to be accessed via
    100 <filename class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
    101 it consistent with the location of documentation for other packages:</para>
     116    <para>By default, Vim's documentation is installed in <filename
     117    class="directory">/usr/share/vim</filename>. The following symlink
     118    allows the documentation to be accessed via <filename
     119    class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
     120    it consistent with the location of documentation for other packages:</para>
    102121
    103122<screen><userinput>ln -sv ../vim/vim64/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
    104123
    105 <para>If an X Window System is going to be installed on the LFS
    106 system, it may be necessary to recompile Vim after installing X. Vim
    107 comes with a GUI version of the editor that requires X and some
    108 additional libraries to be installed. For more information on this
    109 process, refer to the Vim documentation and the Vim installation page
    110 in the BLFS book at <ulink
    111 url="&blfs-root;view/svn/postlfs/editors.html#postlfs-editors-vim"/>.</para>
    112 
    113 </sect2>
    114 
    115 <sect2 id="conf-vim" role="configuration"><title>Configuring Vim</title>
    116 <indexterm zone="conf-vim"><primary sortas="e-/etc/vimrc">/etc/vimrc</primary></indexterm>
    117 
    118 <para>By default, <command>vim</command> runs in vi-incompatible mode. This may
    119 be new to users who have used other editors in the past. The
    120 <quote>nocompatible</quote> setting is included below to highlight the fact that
    121 a new behavior is being used. It also reminds those who would change to
    122 <quote>compatible</quote> mode that it should be the first setting in the
    123 configuration file. This is necessary because it changes other settings, and
    124 overrides must come after this setting. Create a default <command>vim</command>
    125 configuration file by running the following:</para>
     124    <para>If an X Window System is going to be installed on the LFS
     125    system, it may be necessary to recompile Vim after installing X. Vim
     126    comes with a GUI version of the editor that requires X and some
     127    additional libraries to be installed. For more information on this
     128    process, refer to the Vim documentation and the Vim installation page
     129    in the BLFS book at <ulink
     130    url="&blfs-root;view/svn/postlfs/editors.html#postlfs-editors-vim"/>.</para>
     131
     132  </sect2>
     133
     134  <sect2 id="conf-vim" role="configuration">
     135    <title>Configuring Vim</title>
     136
     137    <indexterm zone="conf-vim">
     138      <primary sortas="e-/etc/vimrc">/etc/vimrc</primary>
     139    </indexterm>
     140
     141    <para>By default, <command>vim</command> runs in vi-incompatible mode.
     142    This may be new to users who have used other editors in the past. The
     143    <quote>nocompatible</quote> setting is included below to highlight the
     144    fact that a new behavior is being used. It also reminds those who would
     145    change to <quote>compatible</quote> mode that it should be the first
     146    setting in the configuration file. This is necessary because it changes
     147    other settings, and overrides must come after this setting. Create a default
     148    <command>vim</command> configuration file by running the following:</para>
    126149
    127150<screen><userinput>cat &gt; /etc/vimrc &lt;&lt; "EOF"
    … …  
    138161EOF</userinput></screen>
    139162
    140 <para>The <parameter>set nocompatible</parameter> makes
    141 <command>vim</command> behave in a more useful way (the default) than
    142 the vi-compatible manner. Remove the <quote>no</quote> to keep the
    143 old <command>vi</command> behavior. The <parameter>set
    144 backspace=2</parameter> allows backspacing over line breaks,
    145 autoindents, and the start of insert. The <parameter>syntax
    146 on</parameter> enables vim's syntax highlighting. Finally, the
    147 <emphasis>if</emphasis> statement with the <parameter>set
    148 background=dark</parameter> corrects <command>vim</command>'s guess
    149 about the background color of some terminal emulators. This gives the
    150 highlighting a better color scheme for use on the black background of
    151 these programs.</para>
    152 
    153 <para>Documentation for other available options can be obtained by
    154 running the following command:</para>
     163    <para>The <parameter>set nocompatible</parameter> makes
     164    <command>vim</command> behave in a more useful way (the default) than
     165    the vi-compatible manner. Remove the <quote>no</quote> to keep the
     166    old <command>vi</command> behavior. The <parameter>set
     167    backspace=2</parameter> allows backspacing over line breaks,
     168    autoindents, and the start of insert. The <parameter>syntax
     169    on</parameter> enables vim's syntax highlighting. Finally, the
     170    <emphasis>if</emphasis> statement with the <parameter>set
     171    background=dark</parameter> corrects <command>vim</command>'s guess
     172    about the background color of some terminal emulators. This gives the
     173    highlighting a better color scheme for use on the black background of
     174    these programs.</para>
     175
     176    <para>Documentation for other available options can be obtained by
     177    running the following command:</para>
    155178
    156179<screen role="nodump"><userinput>vim -c ':options'</userinput></screen>
    157180
    158 </sect2>
    159 
    160 <sect2 id="contents-vim" role="content"><title>Contents of Vim</title>
    161 
    162 <segmentedlist>
    163 <segtitle>Installed programs</segtitle>
    164 <seglistitem><seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
    165 pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl, tcltags, vi (link to vim),
    166 view (link to vim), vim, vim132, vim2html.pl, vimdiff (link to vim), vimm, vimspell.sh,
    167 vimtutor, and xxd</seg></seglistitem>
    168 </segmentedlist>
    169 
    170 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    171 <?dbfo list-presentation="list"?>
    172 <?dbhtml list-presentation="table"?>
    173 
    174 <varlistentry id="efm_filter.pl">
    175 <term><command>efm_filter.pl</command></term>
    176 <listitem>
    177 <para>A filter for creating an error file that can be read by <command>vim</command></para>
    178 <indexterm zone="ch-system-vim efm_filter.pl"><primary sortas="b-efm_filter.pl">efm_filter.pl</primary></indexterm>
    179 </listitem>
    180 </varlistentry>
    181 
    182 <varlistentry id="efm_perl.pl">
    183 <term><command>efm_perl.pl</command></term>
    184 <listitem>
    185 <para>Reformats the error messages of the
    186 Perl interpreter for use with the <quote>quickfix</quote> mode of <command>vim</command></para>
    187 <indexterm zone="ch-system-vim efm_perl.pl"><primary sortas="b-efm_perl.pl">efm_perl.pl</primary></indexterm>
    188 </listitem>
    189 </varlistentry>
    190 
    191 <varlistentry id="ex">
    192 <term><command>ex</command></term>
    193 <listitem>
    194 <para>Starts <command>vim</command> in ex mode</para>
    195 <indexterm zone="ch-system-vim ex"><primary sortas="b-ex">ex</primary></indexterm>
    196 </listitem>
    197 </varlistentry>
    198 
    199 <varlistentry id="less.sh">
    200 <term><command>less.sh</command></term>
    201 <listitem>
    202 <para>A script that starts <command>vim</command> with less.vim</para>
    203 <indexterm zone="ch-system-vim less.sh"><primary sortas="b-less.sh">less.sh</primary></indexterm>
    204 </listitem>
    205 </varlistentry>
    206 
    207 <varlistentry id="mve.awk">
    208 <term><command>mve.awk</command></term>
    209 <listitem>
    210 <para>Processes <command>vim</command> errors</para>
    211 <indexterm zone="ch-system-vim mve.awk"><primary sortas="b-mve.awk">mve.awk</primary></indexterm>
    212 </listitem>
    213 </varlistentry>
    214 
    215 <varlistentry id="pltags.pl">
    216 <term><command>pltags.pl</command></term>
    217 <listitem>
    218 <para>Creates a tags file for Perl code for use by <command>vim</command></para>
    219 <indexterm zone="ch-system-vim pltags.pl"><primary sortas="b-pltags.pl">pltags.pl</primary></indexterm>
    220 </listitem>
    221 </varlistentry>
    222 
    223 <varlistentry id="ref">
    224 <term><command>ref</command></term>
    225 <listitem>
    226 <para>Checks the spelling of arguments</para>
    227 <indexterm zone="ch-system-vim ref"><primary sortas="b-ref">ref</primary></indexterm>
    228 </listitem>
    229 </varlistentry>
    230 
    231 <varlistentry id="rview">
    232 <term><command>rview</command></term>
    233 <listitem>
    234 <para>Is a restricted version of <command>view</command>; no shell
    235 commands can be started and <command>view</command> cannot be suspended</para>
    236 <indexterm zone="ch-system-vim rview"><primary sortas="b-rview">rview</primary></indexterm>
    237 </listitem>
    238 </varlistentry>
    239 
    240 <varlistentry id="rvim">
    241 <term><command>rvim</command></term>
    242 <listitem>
    243 <para>Is a restricted version of <command>vim</command>; no shell
    244 commands can be started and <command>vim</command> cannot be suspended</para>
    245 <indexterm zone="ch-system-vim rvim"><primary sortas="b-rvim">rvim</primary></indexterm>
    246 </listitem>
    247 </varlistentry>
    248 
    249 <varlistentry id="shtags.pl">
    250 <term><command>shtags.pl</command></term>
    251 <listitem>
    252 <para>Generates a tags file for Perl scripts</para>
    253 <indexterm zone="ch-system-vim shtags.pl"><primary sortas="b-shtags.pl">shtags.pl</primary></indexterm>
    254 </listitem>
    255 </varlistentry>
    256 
    257 <varlistentry id="tcltags">
    258 <term><command>tcltags</command></term>
    259 <listitem>
    260 <para>Generates a tags file for TCL code</para>
    261 <indexterm zone="ch-system-vim tcltags"><primary sortas="b-tcltags">tcltags</primary></indexterm>
    262 </listitem>
    263 </varlistentry>
    264 
    265 <varlistentry id="view">
    266 <term><command>view</command></term>
    267 <listitem>
    268 <para>Starts <command>vim</command> in read-only mode</para>
    269 <indexterm zone="ch-system-vim view"><primary sortas="b-view">view</primary></indexterm>
    270 </listitem>
    271 </varlistentry>
    272 
    273 <varlistentry id="vi">
    274 <term><command>vi</command></term>
    275 <listitem>
    276 <para>Is the editor</para>
    277 <indexterm zone="ch-system-vim vi"><primary sortas="b-vi">vi</primary></indexterm>
    278 </listitem>
    279 </varlistentry>
    280 
    281 <varlistentry id="vim">
    282 <term><command>vim</command></term>
    283 <listitem>
    284 <para>Is the editor</para>
    285 <indexterm zone="ch-system-vim vim"><primary sortas="b-vim">vim</primary></indexterm>
    286 </listitem>
    287 </varlistentry>
    288 
    289 <varlistentry id="vim132">
    290 <term><command>vim132</command></term>
    291 <listitem>
    292 <para>Starts <command>vim</command> with the terminal in 132-column mode</para>
    293 <indexterm zone="ch-system-vim vim132"><primary sortas="b-vim132">vim132</primary></indexterm>
    294 </listitem>
    295 </varlistentry>
    296 
    297 <varlistentry id="vim2html.pl">
    298 <term><command>vim2html.pl</command></term>
    299 <listitem>
    300 <para>Converts Vim documentation to HypterText Markup Language (HTML)</para>
    301 <indexterm zone="ch-system-vim vim2html.pl"><primary sortas="b-vim2html.pl">vim2html.pl</primary></indexterm>
    302 </listitem>
    303 </varlistentry>
    304 
    305 <varlistentry id="vimdiff">
    306 <term><command>vimdiff</command></term>
    307 <listitem>
    308 <para>Edits two or three versions of a file with <command>vim</command> and show differences</para>
    309 <indexterm zone="ch-system-vim vimdiff"><primary sortas="b-vimdiff">vimdiff</primary></indexterm>
    310 </listitem>
    311 </varlistentry>
    312 
    313 <varlistentry id="vimm">
    314 <term><command>vimm</command></term>
    315 <listitem>
    316 <para>Enables the DEC locator input model on a remote terminal</para>
    317 <indexterm zone="ch-system-vim vimm"><primary sortas="b-vimm">vimm</primary></indexterm>
    318 </listitem>
    319 </varlistentry>
    320 
    321 <varlistentry id="vimspell.sh">
    322 <term><command>vimspell.sh</command></term>
    323 <listitem>
    324 <para>Spell checks a file and generates the syntax statements necessary to
    325 highlight in <command>vim</command>. This script requires the old Unix
    326 <command>spell</command> command, which is provided neither in LFS nor in
    327 BLFS</para>
    328 <indexterm zone="ch-system-vim vimspell.sh"><primary sortas="b-vimspell.sh">vimspell.sh</primary></indexterm>
    329 </listitem>
    330 </varlistentry>
    331 
    332 <varlistentry id="vimtutor">
    333 <term><command>vimtutor</command></term>
    334 <listitem>
    335 <para>Teaches the basic keys and commands of <command>vim</command></para>
    336 <indexterm zone="ch-system-vim vimtutor"><primary sortas="b-vimtutor">vimtutor</primary></indexterm>
    337 </listitem>
    338 </varlistentry>
    339 
    340 <varlistentry id="xxd">
    341 <term><command>xxd</command></term>
    342 <listitem>
    343 <para>Creates a hex dump of the given file; it can
    344 also do the reverse, so it can be used for binary patching</para>
    345 <indexterm zone="ch-system-vim xxd"><primary sortas="b-xxd">xxd</primary></indexterm>
    346 </listitem>
    347 </varlistentry>
    348 </variablelist>
    349 
    350 </sect2>
     181  </sect2>
     182
     183  <sect2 id="contents-vim" role="content">
     184    <title>Contents of Vim</title>
     185
     186    <segmentedlist>
     187      <segtitle>Installed programs</segtitle>
     188
     189      <seglistitem>
     190        <seg>efm_filter.pl, efm_perl.pl, ex (link to vim), less.sh, mve.awk,
     191        pltags.pl, ref, rview (link to vim), rvim (link to vim), shtags.pl,
     192        tcltags, vi (link to vim), view (link to vim), vim, vim132, vim2html.pl,
     193        vimdiff (link to vim), vimm, vimspell.sh, vimtutor, and xxd</seg>
     194      </seglistitem>
     195    </segmentedlist>
     196
     197    <variablelist>
     198      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     199      <?dbfo list-presentation="list"?>
     200      <?dbhtml list-presentation="table"?>
     201
     202      <varlistentry id="efm_filter.pl">
     203        <term><command>efm_filter.pl</command></term>
     204        <listitem>
     205          <para>A filter for creating an error file that can be read
     206          by <command>vim</command></para>
     207          <indexterm zone="ch-system-vim efm_filter.pl">
     208            <primary sortas="b-efm_filter.pl">efm_filter.pl</primary>
     209          </indexterm>
     210        </listitem>
     211      </varlistentry>
     212
     213      <varlistentry id="efm_perl.pl">
     214        <term><command>efm_perl.pl</command></term>
     215        <listitem>
     216          <para>Reformats the error messages of the Perl interpreter for use
     217          with the <quote>quickfix</quote> mode of <command>vim</command></para>
     218          <indexterm zone="ch-system-vim efm_perl.pl">
     219            <primary sortas="b-efm_perl.pl">efm_perl.pl</primary>
     220          </indexterm>
     221        </listitem>
     222      </varlistentry>
     223
     224      <varlistentry id="ex">
     225        <term><command>ex</command></term>
     226        <listitem>
     227          <para>Starts <command>vim</command> in ex mode</para>
     228          <indexterm zone="ch-system-vim ex">
     229            <primary sortas="b-ex">ex</primary>
     230          </indexterm>
     231        </listitem>
     232      </varlistentry>
     233
     234      <varlistentry id="less.sh">
     235        <term><command>less.sh</command></term>
     236        <listitem>
     237          <para>A script that starts <command>vim</command> with less.vim</para>
     238          <indexterm zone="ch-system-vim less.sh">
     239            <primary sortas="b-less.sh">less.sh</primary>
     240          </indexterm>
     241        </listitem>
     242      </varlistentry>
     243
     244      <varlistentry id="mve.awk">
     245        <term><command>mve.awk</command></term>
     246        <listitem>
     247          <para>Processes <command>vim</command> errors</para>
     248          <indexterm zone="ch-system-vim mve.awk">
     249            <primary sortas="b-mve.awk">mve.awk</primary>
     250          </indexterm>
     251        </listitem>
     252      </varlistentry>
     253
     254      <varlistentry id="pltags.pl">
     255        <term><command>pltags.pl</command></term>
     256        <listitem>
     257          <para>Creates a tags file for Perl code for use by
     258          <command>vim</command></para>
     259          <indexterm zone="ch-system-vim pltags.pl">
     260            <primary sortas="b-pltags.pl">pltags.pl</primary>
     261          </indexterm>
     262        </listitem>
     263      </varlistentry>
     264
     265      <varlistentry id="ref">
     266        <term><command>ref</command></term>
     267        <listitem>
     268          <para>Checks the spelling of arguments</para>
     269          <indexterm zone="ch-system-vim ref">
     270            <primary sortas="b-ref">ref</primary>
     271          </indexterm>
     272        </listitem>
     273      </varlistentry>
     274
     275      <varlistentry id="rview">
     276        <term><command>rview</command></term>
     277        <listitem>
     278          <para>Is a restricted version of <command>view</command>; no shell
     279          commands can be started and <command>view</command> cannot be
     280          suspended</para>
     281          <indexterm zone="ch-system-vim rview">
     282            <primary sortas="b-rview">rview</primary>
     283          </indexterm>
     284        </listitem>
     285      </varlistentry>
     286
     287      <varlistentry id="rvim">
     288        <term><command>rvim</command></term>
     289        <listitem>
     290          <para>Is a restricted version of <command>vim</command>; no shell
     291          commands can be started and <command>vim</command> cannot be
     292          suspended</para>
     293          <indexterm zone="ch-system-vim rvim">
     294            <primary sortas="b-rvim">rvim</primary>
     295          </indexterm>
     296        </listitem>
     297      </varlistentry>
     298
     299      <varlistentry id="shtags.pl">
     300        <term><command>shtags.pl</command></term>
     301        <listitem>
     302          <para>Generates a tags file for Perl scripts</para>
     303          <indexterm zone="ch-system-vim shtags.pl">
     304            <primary sortas="b-shtags.pl">shtags.pl</primary>
     305          </indexterm>
     306        </listitem>
     307      </varlistentry>
     308
     309      <varlistentry id="tcltags">
     310        <term><command>tcltags</command></term>
     311        <listitem>
     312          <para>Generates a tags file for TCL code</para>
     313          <indexterm zone="ch-system-vim tcltags">
     314            <primary sortas="b-tcltags">tcltags</primary>
     315          </indexterm>
     316        </listitem>
     317      </varlistentry>
     318
     319      <varlistentry id="view">
     320        <term><command>view</command></term>
     321        <listitem>
     322          <para>Starts <command>vim</command> in read-only mode</para>
     323          <indexterm zone="ch-system-vim view">
     324            <primary sortas="b-view">view</primary>
     325          </indexterm>
     326        </listitem>
     327      </varlistentry>
     328
     329      <varlistentry id="vi">
     330        <term><command>vi</command></term>
     331        <listitem>
     332          <para>Link to <command>vim</command></para>
     333          <indexterm zone="ch-system-vim vi">
     334            <primary sortas="b-vi">vi</primary>
     335          </indexterm>
     336        </listitem>
     337      </varlistentry>
     338
     339      <varlistentry id="vim">
     340        <term><command>vim</command></term>
     341        <listitem>
     342          <para>Is the editor</para>
     343          <indexterm zone="ch-system-vim vim">
     344            <primary sortas="b-vim">vim</primary>
     345          </indexterm>
     346        </listitem>
     347      </varlistentry>
     348
     349      <varlistentry id="vim132">
     350        <term><command>vim132</command></term>
     351        <listitem>
     352          <para>Starts <command>vim</command> with the terminal in 132-column
     353          mode</para>
     354          <indexterm zone="ch-system-vim vim132">
     355            <primary sortas="b-vim132">vim132</primary>
     356          </indexterm>
     357        </listitem>
     358      </varlistentry>
     359
     360      <varlistentry id="vim2html.pl">
     361        <term><command>vim2html.pl</command></term>
     362        <listitem>
     363          <para>Converts Vim documentation to HypterText Markup Language
     364          (HTML)</para>
     365          <indexterm zone="ch-system-vim vim2html.pl">
     366            <primary sortas="b-vim2html.pl">vim2html.pl</primary>
     367          </indexterm>
     368        </listitem>
     369      </varlistentry>
     370
     371      <varlistentry id="vimdiff">
     372        <term><command>vimdiff</command></term>
     373        <listitem>
     374          <para>Edits two or three versions of a file with <command>vim</command>
     375          and show differences</para>
     376          <indexterm zone="ch-system-vim vimdiff">
     377            <primary sortas="b-vimdiff">vimdiff</primary>
     378          </indexterm>
     379        </listitem>
     380      </varlistentry>
     381
     382      <varlistentry id="vimm">
     383        <term><command>vimm</command></term>
     384        <listitem>
     385          <para>Enables the DEC locator input model on a remote terminal</para>
     386          <indexterm zone="ch-system-vim vimm">
     387            <primary sortas="b-vimm">vimm</primary>
     388          </indexterm>
     389        </listitem>
     390      </varlistentry>
     391
     392      <varlistentry id="vimspell.sh">
     393        <term><command>vimspell.sh</command></term>
     394        <listitem>
     395          <para>Spell checks a file and generates the syntax statements
     396          necessary to highlight in <command>vim</command>. This script
     397          requires the old Unix <command>spell</command> command, which
     398          is provided neither in LFS nor in BLFS</para>
     399          <indexterm zone="ch-system-vim vimspell.sh">
     400            <primary sortas="b-vimspell.sh">vimspell.sh</primary>
     401          </indexterm>
     402        </listitem>
     403      </varlistentry>
     404
     405      <varlistentry id="vimtutor">
     406        <term><command>vimtutor</command></term>
     407        <listitem>
     408          <para>Teaches the basic keys and commands of
     409          <command>vim</command></para>
     410          <indexterm zone="ch-system-vim vimtutor">
     411            <primary sortas="b-vimtutor">vimtutor</primary>
     412          </indexterm>
     413        </listitem>
     414      </varlistentry>
     415
     416      <varlistentry id="xxd">
     417        <term><command>xxd</command></term>
     418        <listitem>
     419          <para>Creates a hex dump of the given file; it can
     420          also do the reverse, so it can be used for binary patching</para>
     421          <indexterm zone="ch-system-vim xxd">
     422            <primary sortas="b-xxd">xxd</primary>
     423          </indexterm>
     424        </listitem>
     425      </varlistentry>
     426
     427    </variablelist>
     428
     429  </sect2>
    351430
    352431</sect1>
    353 

  • chapter06/zlib.xml

    r3f3931b0 rddd5542  
    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-zlib" role="wrap">
    7 <title>Zlib-&zlib-version;</title>
    8 <?dbhtml filename="zlib.html"?>
     9  <?dbhtml filename="zlib.html"?>
    910
    10 <indexterm zone="ch-system-zlib"><primary sortas="a-Zlib">Zlib</primary></indexterm>
     11  <title>Zlib-&zlib-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Zlib package contains compression and decompression routines used by
    14 some programs.</para>
     13  <indexterm zone="ch-system-zlib">
     14    <primary sortas="a-Zlib">Zlib</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>2.7 MB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Binutils, Coreutils, GCC, Glibc, Make, and Sed</seg></seglistitem>
    25 </segmentedlist>
    26 </sect2>
     20    <para>The Zlib package contains compression and decompression routines used by
     21    some programs.</para>
    2722
    28 <sect2 role="installation">
    29 <title>Installation of Zlib</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3026
    31 <note><para>Zlib is known to build its shared library incorrectly if
    32 <envar>CFLAGS</envar> is specified in the environment. If using a
    33 specified <envar>CFLAGS</envar>
    34 variable, be sure to add the <parameter>-fPIC</parameter> directive to
    35 the <envar>CFLAGS</envar> variable for the duration of the
    36 configure command below, then remove it afterwards.</para></note>
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>2.7 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
    3732
    38 <para>Prepare Zlib for compilation:</para>
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Binutils, Coreutils, GCC, Glibc, Make, and Sed</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41  </sect2>
     42
     43  <sect2 role="installation">
     44    <title>Installation of Zlib</title>
     45
     46    <note>
     47      <para>Zlib is known to build its shared library incorrectly if
     48      <envar>CFLAGS</envar> is specified in the environment. If using
     49      a specified <envar>CFLAGS</envar> variable, be sure to add the
     50      <parameter>-fPIC</parameter> directive to the <envar>CFLAGS</envar>
     51      variable for the duration of the configure command below, then
     52      remove it afterwards.</para>
     53    </note>
     54
     55    <para>Prepare Zlib for compilation:</para>
    3956
    4057<screen><userinput>./configure --prefix=/usr --shared --libdir=/lib</userinput></screen>
    4158
    42 <para>Compile the package:</para>
     59    <para>Compile the package:</para>
    4360
    4461<screen><userinput>make</userinput></screen>
    4562
    46 <para>To test the results, issue:
    47 <userinput>make check</userinput>.</para>
     63    <para>To test the results, issue:
     64    <userinput>make check</userinput>.</para>
    4865
    49 <para>Install the shared library:</para>
     66    <para>Install the shared library:</para>
    5067
    5168<screen><userinput>make install</userinput></screen>
    5269
    53 <para>The previous command installed a <filename
    54 class="extension">.so</filename> file in <filename
    55 class="directory">/lib</filename>. We will remove it and relink it into
    56 <filename class="directory">/usr/lib</filename>:</para>
     70    <para>The previous command installed a <filename
     71    class="extension">.so</filename> file in <filename
     72    class="directory">/lib</filename>. We will remove it and relink it into
     73    <filename class="directory">/usr/lib</filename>:</para>
    5774
    5875<screen><userinput>rm -v /lib/libz.so
    5976ln -sfv ../../lib/libz.so.&zlib-version; /usr/lib/libz.so</userinput></screen>
    6077
    61 <para>Build the static library:</para>
     78    <para>Build the static library:</para>
    6279
    6380<screen><userinput>make clean
    … …  
    6582make</userinput></screen>
    6683
    67 <para>To test the results again, issue:
    68 <userinput>make check</userinput>.</para>
     84    <para>To test the results again, issue:
     85    <userinput>make check</userinput>.</para>
    6986
    70 <para>Install the static library:</para>
     87    <para>Install the static library:</para>
    7188
    7289<screen><userinput>make install</userinput></screen>
    7390
    74 <para>Fix the permissions on the static library:</para>
     91    <para>Fix the permissions on the static library:</para>
    7592
    7693<screen><userinput>chmod -v 644 /usr/lib/libz.a</userinput></screen>
    7794
    78 </sect2>
     95  </sect2>
    7996
     97  <sect2 id="contents-zlib" role="content">
     98    <title>Contents of Zlib</title>
    8099
    81 <sect2 id="contents-zlib" role="content"><title>Contents of Zlib</title>
     100    <segmentedlist>
     101      <segtitle>Installed libraries</segtitle>
    82102
    83 <segmentedlist>
    84 <segtitle>Installed libraries</segtitle>
    85 <seglistitem><seg>libz.[a,so]</seg></seglistitem>
    86 </segmentedlist>
     103      <seglistitem>
     104        <seg>libz.[a,so]</seg>
     105      </seglistitem>
     106    </segmentedlist>
    87107
    88 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    89 <?dbfo list-presentation="list"?>
    90 <?dbhtml list-presentation="table"?>
     108    <variablelist>
     109      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     110      <?dbfo list-presentation="list"?>
     111      <?dbhtml list-presentation="table"?>
    91112
    92 <varlistentry id="libz">
    93 <term><filename class="libraryfile">libz</filename></term>
    94 <listitem>
    95 <para>Contains compression and decompression
    96 functions used by some programs</para>
    97 <indexterm zone="ch-system-zlib libz"><primary sortas="c-libz">libz</primary></indexterm>
    98 </listitem>
    99 </varlistentry>
    100 </variablelist>
     113      <varlistentry id="libz">
     114        <term><filename class="libraryfile">libz</filename></term>
     115        <listitem>
     116          <para>Contains compression and decompression functions used by
     117          some programs</para>
     118          <indexterm zone="ch-system-zlib libz">
     119            <primary sortas="c-libz">libz</primary>
     120          </indexterm>
     121        </listitem>
     122      </varlistentry>
    101123
    102 </sect2>
     124    </variablelist>
     125
     126  </sect2>
    103127
    104128</sect1>
    105 

  • general.ent

    r3f3931b0 rddd5542  
    11<?xml version="1.0" encoding="ISO-8859-1"?>
    2 <!ENTITY version "SVN-20060207">
    3 <!ENTITY releasedate "Febraury 7, 2006">
     2<!ENTITY version "SVN-20060210">
     3<!ENTITY releasedate "Febraury 10, 2006">
    44<!ENTITY milestone "6.2">
    55<!ENTITY generic-version "development"> <!-- Use "development", "testing", or "x.y[-pre{x}]" -->
Note: See TracChangeset for help on using the changeset viewer.