Changeset fa994c9


Ignore:
Timestamp:
02/03/2006 09:04:48 PM (18 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
Children:
73c180db
Parents:
e6ab4b5
Message:

Ported r7340 from trunk to alphabetical branch.

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

Location:
chapter06
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • chapter06/db.xml

    re6ab4b5 rfa994c9  
    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-db" role="wrap">
    7 <title>Berkeley DB-&db-version;</title>
    8 <?dbhtml filename="db.html"?>
    9 
    10 <indexterm zone="ch-system-db"><primary sortas="a-Berkeley-DB">Berkeley DB</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The Berkeley DB package contains programs and utilities used by many other
    14 applications for database related functions.</para>
    15 
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>1.2 SBU</seg><seg>78 MB</seg></seglistitem>
    20 </segmentedlist>
    21 
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Coreutils,
    25 Diffutils, GCC, Glibc, Make and Sed.</seg></seglistitem>
    26 </segmentedlist>
    27 
    28 <tip>
    29 <title>Extra functionality for Berkeley DB in BLFS</title>
    30 <para>There are instructions to build this package in the BLFS book if you                          need to build the RPC server or additional language bindings. The                                   
    31 additional language bindings will require additional packages to be                                 
    32 installed. The BLFS instructions are located at
    33 <ulink url="&blfs-root;view/svn/server/databases.html#db"/>
    34 for suggested installation instructions.</para>
    35 </tip>
    36 
    37 </sect2>
    38 
    39 <sect2 role="installation">
    40 <title>Installation of Berkeley DB</title>
    41 
    42 <para>Prepare Berkeley DB for compilation:</para>
     9  <?dbhtml filename="db.html"?>
     10
     11  <title>Berkeley DB-&db-version;</title>
     12
     13  <indexterm zone="ch-system-db">
     14    <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The Berkeley DB package contains programs and utilities used by many
     21    other applications for database related functions.</para>
     22
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
     26
     27      <seglistitem>
     28        <seg>1.2 SBU</seg>
     29        <seg>78 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
     32
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
     35
     36      <seglistitem>
     37        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Make and Sed.</seg>
     38      </seglistitem>
     39    </segmentedlist>
     40
     41    <tip>
     42      <title>Extra functionality for Berkeley DB in BLFS</title>
     43
     44      <para>There are instructions to build this package in the BLFS
     45      book if you need to build the RPC server or additional language
     46      bindings. The additional language bindings will require additional
     47      packages to be installed. The BLFS instructions are located at
     48      <ulink url="&blfs-root;view/svn/server/databases.html#db"/> for
     49      suggested installation instructions.</para>
     50    </tip>
     51
     52  </sect2>
     53
     54  <sect2 role="installation">
     55    <title>Installation of Berkeley DB</title>
     56
     57    <para>Prepare Berkeley DB for compilation:</para>
    4358
    4459<screen><userinput>cd build_unix &amp;&amp;
    4560../dist/configure --prefix=/usr --enable-compat185 --enable-cxx</userinput></screen>
    4661
    47 <para>The meaning of the configure options:</para>
    48 
    49 <variablelist>
    50 <varlistentry>
    51 <term><parameter>--enable-compat185</parameter></term>
    52 <listitem><para>This option enables building Berkeley DB 1.85 compatibility API.</para></listitem>
    53 </varlistentry>
    54 
    55 <varlistentry>
    56 <term><parameter>--enable-cxx</parameter></term>
    57 <listitem><para>This option enables building C++ API libraries.</para></listitem>
    58 </varlistentry>
    59 </variablelist>
    60 
    61 <para>Compile the package:</para>
     62    <variablelist>
     63      <title>The meaning of the configure options:</title>
     64
     65      <varlistentry>
     66        <term><parameter>--enable-compat185</parameter></term>
     67        <listitem>
     68          <para>This option enables building Berkeley DB 1.85 compatibility
     69          API.</para>
     70        </listitem>
     71      </varlistentry>
     72
     73      <varlistentry>
     74        <term><parameter>--enable-cxx</parameter></term>
     75        <listitem>
     76          <para>This option enables building C++ API libraries.</para>
     77        </listitem>
     78      </varlistentry>
     79
     80    </variablelist>
     81
     82    <para>Compile the package:</para>
    6283
    6384<screen><userinput>make</userinput></screen>
    6485
    65 <para>It is not possible to test the package meaningfully, because that
    66 would involve building TCL bindings. TCL bindings cannot be built properly
    67 now because TCL is linked against Glibc in <filename class="directory">/tools</filename>,
    68 not against Glibc in <filename class="directory">/usr</filename>.</para>
    69 
    70 <para>Install the package:</para>
     86    <para>It is not possible to test the package meaningfully, because
     87    that would involve building TCL bindings. TCL bindings cannot be
     88    built properly now because TCL is linked against Glibc in
     89    <filename class="directory">/tools</filename>, not against Glibc in
     90    <filename class="directory">/usr</filename>.</para>
     91
     92    <para>Install the package:</para>
    7193
    7294<screen><userinput>make docdir=/usr/share/doc/db-&db-version; install</userinput></screen>
    7395
    74 <para>The meaning of the make option:</para>
    75 
    76 <variablelist>
    77 <varlistentry>
    78 <term><parameter>docdir=...</parameter></term>
    79 <listitem><para>This variable specifies the correct place for the documentation.</para></listitem>
    80 </varlistentry>
    81 </variablelist>
    82 
    83 <para>Fix the ownerships of the installed files:</para>
     96    <variablelist>
     97      <title>The meaning of the make parameter:</title>
     98
     99      <varlistentry>
     100        <term><parameter>docdir=...</parameter></term>
     101        <listitem>
     102          <para>This variable specifies the correct place for the
     103          documentation.</para>
     104        </listitem>
     105      </varlistentry>
     106
     107    </variablelist>
     108
     109    <para>Fix the ownerships of the installed files:</para>
    84110
    85111<screen><userinput>chown root:root /usr/bin/db_* \
    … …  
    87113chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen>
    88114
    89 </sect2>
    90 
    91 
    92 <sect2 id="contents-db" role="content"><title>Contents of Berkeley DB</title>
    93 <segmentedlist>
    94 <segtitle>Installed programs</segtitle>
    95 <seglistitem><seg>db_archive, db_checkpoint, db_deadlock, db_dump,
    96 db_hotbackup, db_load, db_printlog, db_recover, db_stat, db_upgrade and
    97 db_verify
    98 </seg></seglistitem>
    99 </segmentedlist>
    100 
    101 <segmentedlist>
    102 <segtitle>Installed libraries</segtitle>
    103 <seglistitem><seg>libdb.[so,a] and libdb_cxx.[so,a]</seg></seglistitem>
    104 </segmentedlist>
    105 
    106 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    107 <?dbfo list-presentation="list"?>
    108 <?dbhtml list-presentation="table"?>
    109 
    110 <varlistentry id="db_archive">
    111 <term><command>db_archive</command></term>
    112 <listitem>
    113 <para>Prints the pathnames of log files that are no longer in use</para>
    114 <indexterm zone="ch-system-db db_archive"><primary sortas="b-db_archive">db_archive</primary></indexterm>
    115 </listitem>
    116 </varlistentry>
    117 
    118 <varlistentry id="db_checkpoint">
    119 <term><command>db_checkpoint</command></term>
    120 <listitem>
    121 <para>A daemon used to monitor and checkpoint database logs</para>
    122 <indexterm zone="ch-system-db db_checkpoint"><primary sortas="b-db_checkpoint">db_checkpoint</primary></indexterm>
    123 </listitem>
    124 </varlistentry>
    125 
    126 <varlistentry id="db_deadlock">
    127 <term><command>db_deadlock</command></term>
    128 <listitem>
    129 <para>A daemon used to abort lock requests when deadlocks are detected</para>
    130 <indexterm zone="ch-system-db db_deadlock"><primary sortas="b-db_deadlock">db_deadlock</primary></indexterm>
    131 </listitem>
    132 </varlistentry>
    133 
    134 <varlistentry id="db_dump">
    135 <term><command>db_dump</command></term>
    136 <listitem>
    137 <para>Converts database files to a plain-text file format readable by <command>db_load</command></para>
    138 <indexterm zone="ch-system-db db_dump"><primary sortas="b-db_dump">db_dump</primary></indexterm>
    139 </listitem>
    140 </varlistentry>
    141 
    142 <varlistentry id="db_hotbackup">
    143 <term><command>db_hotbackup</command></term>
    144 <listitem>
    145 <para>Creates <quote>hot backup</quote> or <quote>hot failover</quote> snapshots of Berkeley DB databases</para>
    146 <indexterm zone="ch-system-db db_hotbackup"><primary sortas="b-db_hotbackup">db_hotbackup</primary></indexterm>
    147 </listitem>
    148 </varlistentry>
    149 
    150 <varlistentry id="db_load">
    151 <term><command>db_load</command></term>
    152 <listitem>
    153 <para>Is used to create database files from plain-text files</para>
    154 <indexterm zone="ch-system-db db_load"><primary sortas="b-db_load">db_load</primary></indexterm>
    155 </listitem>
    156 </varlistentry>
    157 
    158 <varlistentry id="db_printlog">
    159 <term><command>db_printlog</command></term>
    160 <listitem>
    161 <para>Converts database log files to human readable text</para>
    162 <indexterm zone="ch-system-db db_printlog"><primary sortas="b-db_printlog">db_printlog</primary></indexterm>
    163 </listitem>
    164 </varlistentry>
    165 
    166 <varlistentry id="db_recover">
    167 <term><command>db_recover</command></term>
    168 <listitem>
    169 <para>Is used to restore a database to a consistent state after a failure</para>
    170 <indexterm zone="ch-system-db db_recover"><primary sortas="b-db_recover">db_recover</primary></indexterm>
    171 </listitem>
    172 </varlistentry>
    173 
    174 <varlistentry id="db_stat">
    175 <term><command>db_stat</command></term>
    176 <listitem>
    177 <para>Displays statistics for Berkeley databases</para>
    178 <indexterm zone="ch-system-db db_stat"><primary sortas="b-db_stat">db_stat</primary></indexterm>
    179 </listitem>
    180 </varlistentry>
    181 
    182 <varlistentry id="db_upgrade">
    183 <term><command>db_upgrade</command></term>
    184 <listitem>
    185 <para>Is used to upgrade database files to a newer version of Berkeley DB</para>
    186 <indexterm zone="ch-system-db db_upgrade"><primary sortas="b-db_upgrade">db_upgrade</primary></indexterm>
    187 </listitem>
    188 </varlistentry>
    189 
    190 <varlistentry id="db_verify">
    191 <term><command>db_verify</command></term>
    192 <listitem>
    193 <para>Is used to run consistency checks on database files</para>
    194 <indexterm zone="ch-system-db db_verify"><primary sortas="b-db_verify">db_verify</primary></indexterm>
    195 </listitem>
    196 </varlistentry>
    197 
    198 
    199 <varlistentry id="libdb">
    200 <term><filename class="libraryfile">libdb.[so,a]</filename></term>
    201 <listitem>
    202 <para>Contains functions to manipulate database files from C programs</para>
    203 <indexterm zone="ch-system-db libdb"><primary sortas="c-libdb">libdb</primary></indexterm>
    204 </listitem>
    205 </varlistentry>
    206 
    207 <varlistentry id="libdb_cxx">
    208 <term><filename class="libraryfile">libdb_cxx.[so,a]</filename></term>
    209 <listitem>
    210 <para>Contains functions to manipulate database files from C++ programs</para>
    211 <indexterm zone="ch-system-db libdb_cxx"><primary sortas="c-libdb_cxx">libdb_cxx</primary></indexterm>
    212 </listitem>
    213 </varlistentry>
    214 </variablelist>
    215 
    216 </sect2>
     115  </sect2>
     116
     117  <sect2 id="contents-db" role="content">
     118    <title>Contents of Berkeley DB</title>
     119
     120    <segmentedlist>
     121      <segtitle>Installed programs</segtitle>
     122      <segtitle>Installed libraries</segtitle>
     123
     124      <seglistitem>
     125        <seg>db_archive, db_checkpoint, db_deadlock, db_dump, db_hotbackup,
     126        db_load, db_printlog, db_recover, db_stat, db_upgrade, and db_verify</seg>
     127        <seg>libdb.[so,a] and libdb_cxx.[so,a]</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="db_archive">
     137        <term><command>db_archive</command></term>
     138        <listitem>
     139          <para>Prints the pathnames of log files that are no longer in use</para>
     140          <indexterm zone="ch-system-db db_archive">
     141            <primary sortas="b-db_archive">db_archive</primary>
     142          </indexterm>
     143        </listitem>
     144      </varlistentry>
     145
     146      <varlistentry id="db_checkpoint">
     147        <term><command>db_checkpoint</command></term>
     148        <listitem>
     149          <para>A daemon used to monitor and checkpoint database logs</para>
     150          <indexterm zone="ch-system-db db_checkpoint">
     151            <primary sortas="b-db_checkpoint">db_checkpoint</primary>
     152          </indexterm>
     153        </listitem>
     154      </varlistentry>
     155
     156      <varlistentry id="db_deadlock">
     157        <term><command>db_deadlock</command></term>
     158        <listitem>
     159          <para>A daemon used to abort lock requests when deadlocks are
     160          detected</para>
     161          <indexterm zone="ch-system-db db_deadlock">
     162            <primary sortas="b-db_deadlock">db_deadlock</primary>
     163          </indexterm>
     164        </listitem>
     165      </varlistentry>
     166
     167      <varlistentry id="db_dump">
     168        <term><command>db_dump</command></term>
     169        <listitem>
     170          <para>Converts database files to a plain-text file format readable
     171          by <command>db_load</command></para>
     172          <indexterm zone="ch-system-db db_dump">
     173            <primary sortas="b-db_dump">db_dump</primary>
     174          </indexterm>
     175        </listitem>
     176      </varlistentry>
     177
     178      <varlistentry id="db_hotbackup">
     179        <term><command>db_hotbackup</command></term>
     180        <listitem>
     181          <para>Creates <quote>hot backup</quote> or <quote>hot failover</quote>
     182          snapshots of Berkeley DB databases</para>
     183          <indexterm zone="ch-system-db db_hotbackup">
     184            <primary sortas="b-db_hotbackup">db_hotbackup</primary>
     185          </indexterm>
     186        </listitem>
     187      </varlistentry>
     188
     189      <varlistentry id="db_load">
     190        <term><command>db_load</command></term>
     191        <listitem>
     192          <para>Is used to create database files from plain-text files</para>
     193          <indexterm zone="ch-system-db db_load">
     194            <primary sortas="b-db_load">db_load</primary>
     195          </indexterm>
     196        </listitem>
     197      </varlistentry>
     198
     199      <varlistentry id="db_printlog">
     200        <term><command>db_printlog</command></term>
     201        <listitem>
     202          <para>Converts database log files to human readable text</para>
     203          <indexterm zone="ch-system-db db_printlog">
     204            <primary sortas="b-db_printlog">db_printlog</primary>
     205          </indexterm>
     206        </listitem>
     207      </varlistentry>
     208
     209      <varlistentry id="db_recover">
     210        <term><command>db_recover</command></term>
     211        <listitem>
     212          <para>Is used to restore a database to a consistent state after a
     213          failure</para>
     214          <indexterm zone="ch-system-db db_recover">
     215            <primary sortas="b-db_recover">db_recover</primary>
     216          </indexterm>
     217        </listitem>
     218      </varlistentry>
     219
     220      <varlistentry id="db_stat">
     221        <term><command>db_stat</command></term>
     222        <listitem>
     223          <para>Displays statistics for Berkeley databases</para>
     224          <indexterm zone="ch-system-db db_stat">
     225            <primary sortas="b-db_stat">db_stat</primary>
     226          </indexterm>
     227        </listitem>
     228      </varlistentry>
     229
     230      <varlistentry id="db_upgrade">
     231        <term><command>db_upgrade</command></term>
     232        <listitem>
     233          <para>Is used to upgrade database files to a newer version of
     234          Berkeley DB</para>
     235          <indexterm zone="ch-system-db db_upgrade">
     236            <primary sortas="b-db_upgrade">db_upgrade</primary>
     237          </indexterm>
     238        </listitem>
     239      </varlistentry>
     240
     241      <varlistentry id="db_verify">
     242        <term><command>db_verify</command></term>
     243        <listitem>
     244          <para>Is used to run consistency checks on database files</para>
     245          <indexterm zone="ch-system-db db_verify">
     246            <primary sortas="b-db_verify">db_verify</primary>
     247          </indexterm>
     248        </listitem>
     249      </varlistentry>
     250
     251
     252      <varlistentry id="libdb">
     253        <term><filename class="libraryfile">libdb.[so,a]</filename></term>
     254        <listitem>
     255          <para>Contains functions to manipulate database files from C
     256          programs</para>
     257          <indexterm zone="ch-system-db libdb">
     258            <primary sortas="c-libdb">libdb</primary>
     259          </indexterm>
     260        </listitem>
     261      </varlistentry>
     262
     263      <varlistentry id="libdb_cxx">
     264        <term><filename class="libraryfile">libdb_cxx.[so,a]</filename></term>
     265        <listitem>
     266          <para>Contains functions to manipulate database files from C++
     267          programs</para>
     268          <indexterm zone="ch-system-db libdb_cxx">
     269            <primary sortas="c-libdb_cxx">libdb_cxx</primary>
     270          </indexterm>
     271        </listitem>
     272      </varlistentry>
     273
     274    </variablelist>
     275
     276  </sect2>
    217277
    218278</sect1>

  • chapter06/devices.xml

    re6ab4b5 rfa994c9  
    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-devices">
    7 <title>Populating /dev</title>
    8 <?dbhtml filename="devices.html"?>
     9  <?dbhtml filename="devices.html"?>
    910
    10 <indexterm zone="ch-system-devices"><primary sortas="e-/dev/">/dev/*</primary></indexterm>
     11  <title>Populating /dev</title>
    1112
    12 <sect2>
    13 <title>Creating Initial Device Nodes</title>
     13  <indexterm zone="ch-system-devices">
     14    <primary sortas="e-/dev/">/dev/*</primary>
     15  </indexterm>
    1416
    15 <para>When the kernel boots the system, it requires the presence of a few device
    16 nodes, in particular the <filename class="devicefile">console</filename> and
    17 <filename class="devicefile">null</filename> devices.  The device nodes will
    18 be created on the hard disk so that they are available before
    19 <command>udev</command> has been started, and additionally when Linux is started
    20 in single user mode (hence the restrictive permissions on
    21 <filename class="devicefile">console</filename>).  Create the devices by running
    22 the following commands:</para>
     17  <sect2>
     18    <title>Creating Initial Device Nodes</title>
     19
     20    <para>When the kernel boots the system, it requires the presence of a few
     21    device nodes, in particular the <filename class="devicefile">console</filename>
     22    and <filename class="devicefile">null</filename> devices. The device nodes
     23    will be created on the hard disk so that they are available before
     24    <command>udev</command> has been started, and additionally when Linux is
     25    started in single user mode (hence the restrictive permissions on
     26    <filename class="devicefile">console</filename>). Create the devices by
     27    running the following commands:</para>
    2328
    2429<screen><userinput>mknod -m 600 /dev/console c 5 1
    2530mknod -m 666 /dev/null c 1 3</userinput></screen>
    26 </sect2>
    2731
    28 <sect2>
    29 <title>Mounting tmpfs and Populating /dev</title>
     32  </sect2>
    3033
    31 <para>The recommended method of populating the <filename
    32 class="directory">/dev</filename> directory with devices is to mount a virtual
    33 filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>) on the
    34 <filename class="directory">/dev</filename> directory, and allow the devices to
    35 be created dynamically on that virtual filesystem as they are detected or
    36 accessed. This is generally done during the boot process. Since this new system
    37 has not been booted, it is necessary to do what the LFS-Bootscripts package would
    38 otherwise do by mounting <filename class="directory">/dev</filename>:</para>
     34  <sect2>
     35    <title>Mounting tmpfs and Populating /dev</title>
     36
     37    <para>The recommended method of populating the <filename
     38    class="directory">/dev</filename> directory with devices is to mount a
     39    virtual filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>)
     40    on the <filename class="directory">/dev</filename> directory, and allow the
     41    devices to be created dynamically on that virtual filesystem as they are
     42    detected or accessed. This is generally done during the boot process. Since
     43    this new system has not been booted, it is necessary to do what the
     44    LFS-Bootscripts package would otherwise do by mounting <filename
     45    class="directory">/dev</filename>:</para>
    3946
    4047<screen><userinput>mount -nvt tmpfs none /dev</userinput></screen>
    4148
    42 <para>The Udev package is what actually creates the devices in the <filename
    43 class="directory">/dev</filename> directory. Since it will not be installed
    44 until later on in the process, manually create the minimal set of device nodes
    45 needed to complete the building of this system:</para>
     49    <para>The Udev package is what actually creates the devices in the <filename
     50    class="directory">/dev</filename> directory. Since it will not be installed
     51    until later on in the process, manually create the minimal set of device nodes
     52    needed to complete the building of this system:</para>
    4653
    4754<screen><userinput>mknod -m 622 /dev/console c 5 1
    … …  
    5461chown -v root:tty /dev/{console,ptmx,tty}</userinput></screen>
    5562
    56 <para>There are some symlinks and directories required by LFS that are created
    57 during system startup by the LFS-Bootscripts package. Since this is a chroot
    58 environment and not a booted environment, those symlinks and directories need to
    59 be created here:</para>
     63    <para>There are some symlinks and directories required by LFS that are
     64    created during system startup by the LFS-Bootscripts package. Since this
     65    is a chroot environment and not a booted environment, those symlinks and
     66    directories need to be created here:</para>
    6067
    6168<screen><userinput>ln -sv /proc/self/fd /dev/fd
    … …  
    6774mkdir -v /dev/shm</userinput></screen>
    6875
    69 <para>Finally, mount the proper virtual (kernel) file systems on the
    70 newly-created directories:</para>
     76    <para>Finally, mount the proper virtual (kernel) file systems on the
     77    newly-created directories:</para>
    7178
    7279<screen><userinput>mount -vt devpts -o gid=4,mode=620 none /dev/pts
    7380mount -vt tmpfs none /dev/shm</userinput></screen>
    7481
    75 <para>The <command>mount</command> commands executed above may result
    76 in the following warning message:</para>
     82    <para>The <command>mount</command> commands executed above may result
     83    in the following warning message:</para>
    7784
    7885<screen><computeroutput>can't open /etc/fstab: No such file or directory.</computeroutput></screen>
    7986
    80 <para>This file&mdash;<filename>/etc/fstab</filename>&mdash;has not
    81 been created yet but is also not required for the file systems to be
    82 properly mounted. As such, the warning can be safely ignored.</para>
    83 </sect2>
     87    <para>This file&mdash;<filename>/etc/fstab</filename>&mdash;has not
     88    been created yet but is also not required for the file systems to be
     89    properly mounted. As such, the warning can be safely ignored.</para>
     90
     91  </sect2>
    8492
    8593</sect1>
    86 

  • chapter06/diffutils.xml

    re6ab4b5 rfa994c9  
    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-diffutils" role="wrap">
    7 <title>Diffutils-&diffutils-version;</title>
    8 <?dbhtml filename="diffutils.html"?>
     9  <?dbhtml filename="diffutils.html"?>
    910
    10 <indexterm zone="ch-system-diffutils"><primary sortas="a-Diffutils">Diffutils</primary></indexterm>
     11  <title>Diffutils-&diffutils-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Diffutils package contains programs that show the differences
    14 between files or directories.</para>
     13  <indexterm zone="ch-system-diffutils">
     14    <primary sortas="a-Diffutils">Diffutils</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>5.6 MB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, GCC,
    25 Gettext, Glibc, Grep, Make, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
     20    <para>The Diffutils package contains programs that show the differences
     21    between files or directories.</para>
    2822
    29 <sect2 role="installation">
    30 <title>Installation of Diffutils</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3126
    32 <para>POSIX requires the <command>diff</command> command to treat whitespace
    33 characters according to the current locale. The following patch fixes the
    34 non-compliance issue:</para>
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>5.6 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, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Diffutils</title>
     46
     47    <para>POSIX requires the <command>diff</command> command to treat whitespace
     48    characters according to the current locale. The following patch fixes the
     49    non-compliance issue:</para>
    3550
    3651<screen><userinput>patch -Np1 -i ../&diffutils-i18n-patch;</userinput></screen>
    3752
    38 <para>Prepare Diffutils for compilation:</para>
     53    <para>Prepare Diffutils for compilation:</para>
    3954
    4055<screen><userinput>./configure --prefix=/usr</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
    5469
    55 <sect2 id="contents-diffutils" role="content"><title>Contents of Diffutils</title>
     70  <sect2 id="contents-diffutils" role="content">
     71    <title>Contents of Diffutils</title>
    5672
    57 <segmentedlist>
    58 <segtitle>Installed programs</segtitle>
    59 <seglistitem><seg>cmp, diff, diff3, and sdiff</seg></seglistitem>
    60 </segmentedlist>
     73    <segmentedlist>
     74      <segtitle>Installed programs</segtitle>
    6175
    62 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    63 <?dbfo list-presentation="list"?>
    64 <?dbhtml list-presentation="table"?>
     76      <seglistitem>
     77        <seg>cmp, diff, diff3, and sdiff</seg>
     78      </seglistitem>
     79    </segmentedlist>
    6580
    66 <varlistentry id="cmp">
    67 <term><command>cmp</command></term>
    68 <listitem>
    69 <para>Compares two files and reports whether or in which bytes they differ</para>
    70 <indexterm zone="ch-system-diffutils cmp"><primary sortas="b-cmp">cmp</primary></indexterm>
    71 </listitem>
    72 </varlistentry>
     81    <variablelist>
     82      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     83      <?dbfo list-presentation="list"?>
     84      <?dbhtml list-presentation="table"?>
    7385
    74 <varlistentry id="diff">
    75 <term><command>diff</command></term>
    76 <listitem>
    77 <para>Compares two files or directories and reports which lines in the files differ</para>
    78 <indexterm zone="ch-system-diffutils diff"><primary sortas="b-diff">diff</primary></indexterm>
    79 </listitem>
    80 </varlistentry>
     86      <varlistentry id="cmp">
     87        <term><command>cmp</command></term>
     88        <listitem>
     89          <para>Compares two files and reports whether or in which bytes they
     90          differ</para>
     91          <indexterm zone="ch-system-diffutils cmp">
     92            <primary sortas="b-cmp">cmp</primary>
     93          </indexterm>
     94        </listitem>
     95      </varlistentry>
    8196
    82 <varlistentry id="diff3">
    83 <term><command>diff3</command></term>
    84 <listitem>
    85 <para>Compares three files line by line</para>
    86 <indexterm zone="ch-system-diffutils diff3"><primary sortas="b-diff3">diff3</primary></indexterm>
    87 </listitem>
    88 </varlistentry>
     97      <varlistentry id="diff">
     98        <term><command>diff</command></term>
     99        <listitem>
     100          <para>Compares two files or directories and reports which lines in
     101          the files differ</para>
     102          <indexterm zone="ch-system-diffutils diff">
     103            <primary sortas="b-diff">diff</primary>
     104          </indexterm>
     105        </listitem>
     106      </varlistentry>
    89107
    90 <varlistentry id="sdiff">
    91 <term><command>sdiff</command></term>
    92 <listitem>
    93 <para>Merges two files and interactively outputs the results</para>
    94 <indexterm zone="ch-system-diffutils sdiff"><primary sortas="b-sdiff">sdiff</primary></indexterm>
    95 </listitem>
    96 </varlistentry>
    97 </variablelist>
     108      <varlistentry id="diff3">
     109        <term><command>diff3</command></term>
     110        <listitem>
     111            <para>Compares three files line by line</para>
     112            <indexterm zone="ch-system-diffutils diff3">
     113              <primary sortas="b-diff3">diff3</primary>
     114            </indexterm>
     115        </listitem>
     116      </varlistentry>
    98117
    99 </sect2>
     118      <varlistentry id="sdiff">
     119        <term><command>sdiff</command></term>
     120        <listitem>
     121          <para>Merges two files and interactively outputs the results</para>
     122          <indexterm zone="ch-system-diffutils sdiff">
     123            <primary sortas="b-sdiff">sdiff</primary>
     124          </indexterm>
     125        </listitem>
     126      </varlistentry>
     127
     128    </variablelist>
     129
     130  </sect2>
    100131
    101132</sect1>
    102 

  • chapter06/e2fsprogs.xml

    re6ab4b5 rfa994c9  
    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-e2fsprogs" role="wrap">
    7 <title>E2fsprogs-&e2fsprogs-version;</title>
    8 <?dbhtml filename="e2fsprogs.html"?>
    9 
    10 <indexterm zone="ch-system-e2fsprogs"><primary sortas="a-E2fsprogs">E2fsprogs</primary></indexterm>
    11 
    12 <sect2 role="package"><title/>
    13 <para>The E2fsprogs package contains the utilities for handling the
    14 <systemitem class="filesystem">ext2</systemitem> file system. It also supports
    15 the <systemitem class="filesystem">ext3</systemitem> journaling file system.</para>
    16 
    17 <segmentedlist>
    18 <segtitle>&buildtime;</segtitle>
    19 <segtitle>&diskspace;</segtitle>
    20 <seglistitem><seg>0.6 SBU</seg><seg>40.0 MB</seg></seglistitem>
    21 </segmentedlist>
    22 
    23 <segmentedlist>
    24 <segtitle>&dependencies;</segtitle>
    25 <seglistitem><seg>Bash, Binutils, Coreutils,
    26 Diffutils, Gawk, GCC, Gettext, Glibc, Grep, Make, Sed, and Texinfo</seg></seglistitem>
    27 </segmentedlist>
    28 </sect2>
    29 
    30 <sect2 role="installation">
    31 <title>Installation of E2fsprogs</title>
    32 
    33 <para>It is recommended that E2fsprogs be built in a subdirectory of the source tree:
    34 </para>
     9  <?dbhtml filename="e2fsprogs.html"?>
     10
     11  <title>E2fsprogs-&e2fsprogs-version;</title>
     12
     13  <indexterm zone="ch-system-e2fsprogs">
     14    <primary sortas="a-E2fsprogs">E2fsprogs</primary>
     15  </indexterm>
     16
     17  <sect2 role="package">
     18    <title/>
     19
     20    <para>The E2fsprogs package contains the utilities for handling the
     21    <systemitem class="filesystem">ext2</systemitem> file system. It also
     22    supports the <systemitem class="filesystem">ext3</systemitem> journaling
     23    file system.</para>
     24
     25    <segmentedlist>
     26      <segtitle>&buildtime;</segtitle>
     27      <segtitle>&diskspace;</segtitle>
     28
     29      <seglistitem>
     30        <seg>0.6 SBU</seg>
     31        <seg>40.0 MB</seg>
     32      </seglistitem>
     33    </segmentedlist>
     34
     35    <segmentedlist>
     36      <segtitle>&dependencies;</segtitle>
     37
     38      <seglistitem>
     39        <seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Gettext, Glibc,
     40        Grep, Make, Sed, and Texinfo</seg>
     41      </seglistitem>
     42    </segmentedlist>
     43
     44  </sect2>
     45
     46  <sect2 role="installation">
     47    <title>Installation of E2fsprogs</title>
     48
     49    <para>It is recommended that E2fsprogs be built in a subdirectory of
     50    the source tree: </para>
    3551
    3652<screen><userinput>mkdir -v build
    3753cd build</userinput></screen>
    3854
    39 <para>Prepare E2fsprogs for compilation:</para>
     55    <para>Prepare E2fsprogs for compilation:</para>
    4056
    4157<screen><userinput>../configure --prefix=/usr --with-root-prefix="" \
    4258    --enable-elf-shlibs --disable-evms</userinput></screen>
    4359
    44 <para>The meaning of the configure options:</para>
    45 
    46 <variablelist>
    47 <varlistentry>
    48 <term><parameter>--with-root-prefix=""</parameter></term>
    49 <listitem><para>Certain programs (such as the <command>e2fsck</command> program)
    50 are considered essential programs.  When, for example, <filename
    51 class="directory">/usr</filename> is not mounted, these programs still need
    52 to be available. They belong in directories like <filename
    53 class="directory">/lib</filename> and <filename
    54 class="directory">/sbin</filename>. If this option is not passed to E2fsprogs'
    55 configure, the programs are installed into the <filename
    56 class="directory">/usr</filename> directory.</para></listitem>
    57 
    58 </varlistentry>
    59 
    60 <varlistentry>
    61 <term><parameter>--enable-elf-shlibs</parameter></term>
    62 <listitem><para>This creates the shared libraries which some programs
    63 in this package use.</para></listitem>
    64 </varlistentry>
    65 
    66 <varlistentry>
    67 <term><parameter>--disable-evms</parameter></term>
    68 <listitem><para>This disables the building of the Enterprise Volume
    69 Management System (EVMS) plugin. This plugin is not up-to-date with
    70 the latest EVMS internal interfaces and EVMS is not installed as part
    71 of a base LFS system, so the plugin is not required. See the EVMS
    72 website at <ulink url="http://evms.sourceforge.net/"/> for more
    73 information regarding EVMS.</para></listitem>
    74 </varlistentry>
    75 </variablelist>
    76 
    77 <para>Compile the package:</para>
     60    <variablelist>
     61      <title>The meaning of the configure options:</title>
     62
     63      <varlistentry>
     64        <term><parameter>--with-root-prefix=""</parameter></term>
     65        <listitem>
     66          <para>Certain programs (such as the <command>e2fsck</command>
     67          program) are considered essential programs.  When, for example,
     68          <filename class="directory">/usr</filename> is not mounted, these
     69          programs still need to be available. They belong in directories
     70          like <filename class="directory">/lib</filename> and <filename
     71          class="directory">/sbin</filename>. If this option is not passed
     72          to E2fsprogs' configure, the programs are installed into the
     73          <filename class="directory">/usr</filename> directory.</para>
     74        </listitem>
     75      </varlistentry>
     76
     77      <varlistentry>
     78        <term><parameter>--enable-elf-shlibs</parameter></term>
     79        <listitem>
     80          <para>This creates the shared libraries which some programs
     81          in this package use.</para>
     82        </listitem>
     83      </varlistentry>
     84
     85      <varlistentry>
     86        <term><parameter>--disable-evms</parameter></term>
     87        <listitem>
     88          <para>This disables the building of the Enterprise Volume
     89          Management System (EVMS) plugin. This plugin is not up-to-date with
     90          the latest EVMS internal interfaces and EVMS is not installed as part
     91          of a base LFS system, so the plugin is not required. See the EVMS
     92          website at <ulink url="http://evms.sourceforge.net/"/> for more
     93          information regarding EVMS.</para>
     94        </listitem>
     95      </varlistentry>
     96
     97    </variablelist>
     98
     99    <para>Compile the package:</para>
    78100
    79101<screen><userinput>make</userinput></screen>
    80102
    81 <para>To test the results, issue:
    82 <userinput>make check</userinput>.</para>
    83 
    84 <para>Install the binaries and documentation:</para>
     103    <para>To test the results, issue:
     104    <userinput>make check</userinput>.</para>
     105
     106    <para>Install the binaries and documentation:</para>
    85107
    86108<screen><userinput>make install</userinput></screen>
    87109
    88 <para>Install the shared libraries:</para>
     110    <para>Install the shared libraries:</para>
    89111
    90112<screen><userinput>make install-libs</userinput></screen>
    91113
    92 </sect2>
    93 
    94 
    95 
    96 <sect2 id="contents-e2fsprogs" role="content"><title>Contents of E2fsprogs</title>
    97 
    98 <segmentedlist>
    99 <segtitle>Installed programs</segtitle>
    100 <segtitle>Installed libraries</segtitle>
    101 <seglistitem><seg>badblocks, blkid, chattr,
    102 compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck,
    103 fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
    104 mklost+found, resize2fs, tune2fs, and uuidgen.</seg>
    105 <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
    106 libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg></seglistitem>
    107 </segmentedlist>
    108 
    109 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    110 <?dbfo list-presentation="list"?>
    111 <?dbhtml list-presentation="table"?>
    112 
    113 <varlistentry id="badblocks">
    114 <term><command>badblocks</command></term>
    115 <listitem>
    116 <para>Searches a device (usually a disk partition) for bad blocks</para>
    117 <indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm>
    118 </listitem>
    119 </varlistentry>
    120 
    121 <varlistentry id="blkid">
    122 <term><command>blkid</command></term>
    123 <listitem>
    124 <para>A command line utility to locate and print block device attributes</para>
    125 <indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm>
    126 </listitem>
    127 </varlistentry>
    128 
    129 <varlistentry id="chattr">
    130 <term><command>chattr</command></term>
    131 <listitem>
    132 <para>Changes the attributes of files on an <systemitem
    133 class="filesystem">ext2</systemitem> file system; it also changes <systemitem
    134 class="filesystem">ext3</systemitem> file systems, the journaling version of
    135 <systemitem class="filesystem">ext2</systemitem> file systems</para>
    136 <indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm>
    137 </listitem>
    138 </varlistentry>
    139 
    140 <varlistentry id="compile_et">
    141 <term><command>compile_et</command></term>
    142 <listitem>
    143 <para>An error table compiler; it converts a table of error-code names and
    144 messages into a C source file suitable for use with the <filename
    145 class="libraryfile">com_err</filename> library</para>
    146 <indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm>
    147 </listitem>
    148 </varlistentry>
    149 
    150 <varlistentry id="debugfs">
    151 <term><command>debugfs</command></term>
    152 <listitem>
    153 <para>A file system debugger; it can be used to examine and change the
    154 state of an <systemitem class="filesystem">ext2</systemitem> file system</para>
    155 <indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm>
    156 </listitem>
    157 </varlistentry>
    158 
    159 <varlistentry id="dumpe2fs">
    160 <term><command>dumpe2fs</command></term>
    161 <listitem>
    162 <para>Prints the super block and blocks group information for the file
    163 system present on a given device</para>
    164 <indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm>
    165 </listitem>
    166 </varlistentry>
    167 
    168 <varlistentry id="e2fsck">
    169 <term><command>e2fsck</command></term>
    170 <listitem>
    171 <para>Is used to check, and optionally repair <systemitem
    172 class="filesystem">ext2</systemitem> file systems and <systemitem
    173 class="filesystem">ext3</systemitem> file systems</para>
    174 <indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm>
    175 </listitem>
    176 </varlistentry>
    177 
    178 <varlistentry id="e2image">
    179 <term><command>e2image</command></term>
    180 <listitem>
    181 <para>Is used to save critical <systemitem class="filesystem">ext2</systemitem>
    182 file system data to a file</para>
    183 <indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm>
    184 </listitem>
    185 </varlistentry>
    186 
    187 <varlistentry id="e2label">
    188 <term><command>e2label</command></term>
    189 <listitem>
    190 <para>Displays or changes the file system label on the <systemitem
    191 class="filesystem">ext2</systemitem> file system present on a given device</para>
    192 <indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm>
    193 </listitem>
    194 </varlistentry>
    195 
    196 <varlistentry id="findfs">
    197 <term><command>findfs</command></term>
    198 <listitem>
    199 <para>Finds a file system by label or Universally Unique Identifier (UUID)</para>
    200 <indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm>
    201 </listitem>
    202 </varlistentry>
    203 
    204 <varlistentry id="fsck">
    205 <term><command>fsck</command></term>
    206 <listitem>
    207 <para>Is used to check, and optionally repair, file systems</para>
    208 <indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm>
    209 </listitem>
    210 </varlistentry>
    211 
    212 <varlistentry id="fsck.ext2">
    213 <term><command>fsck.ext2</command></term>
    214 <listitem>
    215 <para>By default checks <systemitem class="filesystem">ext2</systemitem>
    216 file systems</para>
    217 <indexterm zone="ch-system-e2fsprogs fsck.ext2"><primary
    218 sortas="b-fsck.ext2">fsck.ext2</primary></indexterm>
    219 </listitem>
    220 </varlistentry>
    221 
    222 <varlistentry id="fsck.ext3">
    223 <term><command>fsck.ext3</command></term>
    224 <listitem>
    225 <para>By default checks <systemitem class="filesystem">ext3</systemitem>
    226 file systems</para>
    227 <indexterm zone="ch-system-e2fsprogs fsck.ext3"><primary
    228 sortas="b-fsck.ext3">fsck.ext3</primary></indexterm>
    229 </listitem>
    230 </varlistentry>
    231 
    232 <varlistentry id="logsave">
    233 <term><command>logsave</command></term>
    234 <listitem>
    235 <para>Saves the output of a command in a log file</para>
    236 <indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm>
    237 </listitem>
    238 </varlistentry>
    239 
    240 <varlistentry id="lsattr">
    241 <term><command>lsattr</command></term>
    242 <listitem>
    243 <para>Lists the attributes of files on a second extended file system</para>
    244 <indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm>
    245 </listitem>
    246 </varlistentry>
    247 
    248 <varlistentry id="mk_cmds">
    249 <term><command>mk_cmds</command></term>
    250 <listitem>
    251 <para>Converts a table of command names and help messages into a C
    252 source file suitable for use with the <filename
    253 class="libraryfile">libss</filename> subsystem library</para>
    254 <indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm>
    255 </listitem>
    256 </varlistentry>
    257 
    258 <varlistentry id="mke2fs">
    259 <term><command>mke2fs</command></term>
    260 <listitem>
    261 <para>Creates an ext2 or ext3 file system on the given device</para>
    262 <indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm>
    263 </listitem>
    264 </varlistentry>
    265 
    266 <varlistentry id="mkfs.ext2">
    267 <term><command>mkfs.ext2</command></term>
    268 <listitem>
    269 <para>By default creates <systemitem class="filesystem">ext2</systemitem>
    270 file systems</para>
    271 <indexterm zone="ch-system-e2fsprogs mkfs.ext2"><primary
    272 sortas="b-mkfs.ext2">mkfs.ext2</primary></indexterm>
    273 </listitem>
    274 </varlistentry>
    275 
    276 <varlistentry id="mkfs.ext3">
    277 <term><command>mkfs.ext3</command></term>
    278 <listitem>
    279 <para>By default creates <systemitem class="filesystem">ext3</systemitem>
    280 file systems</para>
    281 <indexterm zone="ch-system-e2fsprogs mkfs.ext3"><primary
    282 sortas="b-mkfs.ext3">mkfs.ext3</primary></indexterm>
    283 </listitem>
    284 </varlistentry>
    285 
    286 <varlistentry id="mklost-found">
    287 <term><command>mklost+found</command></term>
    288 <listitem>
    289 <para>Used to create a <filename class="directory">lost+found</filename>
    290 directory on an <systemitem class="filesystem">ext2</systemitem> file system;
    291 it pre-allocates disk blocks to this directory to lighten the task of
    292 <command>e2fsck</command></para>
    293 <indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm>
    294 </listitem>
    295 </varlistentry>
    296 
    297 <varlistentry id="resize2fs">
    298 <term><command>resize2fs</command></term>
    299 <listitem>
    300 <para>Can be used to enlarge or shrink an <systemitem
    301 class="filesystem">ext2</systemitem> file system</para>
    302 <indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm>
    303 </listitem>
    304 </varlistentry>
    305 
    306 <varlistentry id="tune2fs">
    307 <term><command>tune2fs</command></term>
    308 <listitem>
    309 <para>Adjusts tunable file system parameters on an <systemitem
    310 class="filesystem">ext2</systemitem> file system</para>
    311 <indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm>
    312 </listitem>
    313 </varlistentry>
    314 
    315 <varlistentry id="uuidgen">
    316 <term><command>uuidgen</command></term>
    317 <listitem>
    318 <para>Creates new UUIDs. Each new UUID can reasonably be considered unique
    319 among all UUIDs created, on the local system and on other systems, in the
    320 past and in the future</para>
    321 <indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm>
    322 </listitem>
    323 </varlistentry>
    324 
    325 <varlistentry id="libblkid">
    326 <term><filename class="libraryfile">libblkid</filename></term>
    327 <listitem>
    328 <para>Contains routines for device identification and token extraction</para>
    329 <indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm>
    330 </listitem>
    331 </varlistentry>
    332 
    333 <varlistentry id="libcom_err">
    334 <term><filename class="libraryfile">libcom_err</filename></term>
    335 <listitem>
    336 <para>The common error display routine</para>
    337 <indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm>
    338 </listitem>
    339 </varlistentry>
    340 
    341 <varlistentry id="libe2p">
    342 <term><filename class="libraryfile">libe2p</filename></term>
    343 <listitem>
    344 <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
    345 and <command>lsattr</command></para>
    346 <indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm>
    347 </listitem>
    348 </varlistentry>
    349 
    350 <varlistentry id="libext2fs">
    351 <term><filename class="libraryfile">libext2fs</filename></term>
    352 <listitem>
    353 <para>Contains routines to enable user-level programs to manipulate an
    354 <systemitem class="filesystem">ext2</systemitem> file system</para>
    355 <indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm>
    356 </listitem>
    357 </varlistentry>
    358 
    359 <varlistentry id="libss">
    360 <term><filename class="libraryfile">libss</filename></term>
    361 <listitem>
    362 <para>Used by <command>debugfs</command></para>
    363 <indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm>
    364 </listitem>
    365 </varlistentry>
    366 
    367 <varlistentry id="libuuid">
    368 <term><filename class="libraryfile">libuuid</filename></term>
    369 <listitem>
    370 <para>Contains routines for generating unique identifiers for objects
    371 that may be accessible beyond the local system</para>
    372 <indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm>
    373 </listitem>
    374 </varlistentry>
    375 </variablelist>
    376 
    377 </sect2>
     114  </sect2>
     115
     116  <sect2 id="contents-e2fsprogs" role="content">
     117    <title>Contents of E2fsprogs</title>
     118
     119    <segmentedlist>
     120      <segtitle>Installed programs</segtitle>
     121      <segtitle>Installed libraries</segtitle>
     122
     123      <seglistitem>
     124        <seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck,
     125        e2image, e2label, findfs, fsck, fsck.ext2, fsck.ext3, logsave, lsattr,
     126        mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mklost+found, resize2fs,
     127        tune2fs, and uuidgen.</seg>
     128        <seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
     129        libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
     130      </seglistitem>
     131    </segmentedlist>
     132
     133    <variablelist>
     134      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     135      <?dbfo list-presentation="list"?>
     136      <?dbhtml list-presentation="table"?>
     137
     138      <varlistentry id="badblocks">
     139        <term><command>badblocks</command></term>
     140        <listitem>
     141          <para>Searches a device (usually a disk partition) for bad
     142          blocks</para>
     143          <indexterm zone="ch-system-e2fsprogs badblocks">
     144            <primary sortas="b-badblocks">badblocks</primary>
     145          </indexterm>
     146        </listitem>
     147      </varlistentry>
     148
     149      <varlistentry id="blkid">
     150        <term><command>blkid</command></term>
     151        <listitem>
     152          <para>A command line utility to locate and print block device
     153          attributes</para>
     154          <indexterm zone="ch-system-e2fsprogs blkid">
     155            <primary sortas="b-blkid">blkid</primary>
     156          </indexterm>
     157        </listitem>
     158      </varlistentry>
     159
     160      <varlistentry id="chattr">
     161        <term><command>chattr</command></term>
     162        <listitem>
     163          <para>Changes the attributes of files on an <systemitem
     164          class="filesystem">ext2</systemitem> file system; it also
     165          changes <systemitem class="filesystem">ext3</systemitem>
     166          file systems, the journaling version of <systemitem
     167          class="filesystem">ext2</systemitem> file systems</para>
     168          <indexterm zone="ch-system-e2fsprogs chattr">
     169            <primary sortas="b-chattr">chattr</primary>
     170          </indexterm>
     171        </listitem>
     172      </varlistentry>
     173
     174      <varlistentry id="compile_et">
     175        <term><command>compile_et</command></term>
     176        <listitem>
     177          <para>An error table compiler; it converts a table of error-code
     178          names and messages into a C source file suitable for use with the
     179          <filename class="libraryfile">com_err</filename> library</para>
     180          <indexterm zone="ch-system-e2fsprogs compile_et">
     181            <primary sortas="b-compile_et">compile_et</primary>
     182          </indexterm>
     183        </listitem>
     184      </varlistentry>
     185
     186      <varlistentry id="debugfs">
     187        <term><command>debugfs</command></term>
     188        <listitem>
     189          <para>A file system debugger; it can be used to examine and change
     190          the state of an <systemitem class="filesystem">ext2</systemitem>
     191          file system</para>
     192          <indexterm zone="ch-system-e2fsprogs debugfs">
     193            <primary sortas="b-debugfs">debugfs</primary>
     194          </indexterm>
     195        </listitem>
     196      </varlistentry>
     197
     198      <varlistentry id="dumpe2fs">
     199        <term><command>dumpe2fs</command></term>
     200        <listitem>
     201          <para>Prints the super block and blocks group information for the
     202          file system present on a given device</para>
     203          <indexterm zone="ch-system-e2fsprogs dumpe2fs">
     204            <primary sortas="b-dumpe2fs">dumpe2fs</primary>
     205          </indexterm>
     206        </listitem>
     207      </varlistentry>
     208
     209      <varlistentry id="e2fsck">
     210        <term><command>e2fsck</command></term>
     211        <listitem>
     212          <para>Is used to check, and optionally repair <systemitem
     213          class="filesystem">ext2</systemitem> file systems and <systemitem
     214          class="filesystem">ext3</systemitem> file systems</para>
     215          <indexterm zone="ch-system-e2fsprogs e2fsck">
     216            <primary sortas="b-e2fsck">e2fsck</primary>
     217          </indexterm>
     218        </listitem>
     219      </varlistentry>
     220
     221      <varlistentry id="e2image">
     222        <term><command>e2image</command></term>
     223        <listitem>
     224          <para>Is used to save critical <systemitem
     225          class="filesystem">ext2</systemitem> file system data to a file</para>
     226          <indexterm zone="ch-system-e2fsprogs e2image">
     227            <primary sortas="b-e2image">e2image</primary>
     228          </indexterm>
     229        </listitem>
     230      </varlistentry>
     231
     232      <varlistentry id="e2label">
     233        <term><command>e2label</command></term>
     234        <listitem>
     235          <para>Displays or changes the file system label on the <systemitem
     236          class="filesystem">ext2</systemitem> file system present on a given
     237          device</para>
     238          <indexterm zone="ch-system-e2fsprogs e2label">
     239            <primary sortas="b-e2label">e2label</primary>
     240          </indexterm>
     241        </listitem>
     242      </varlistentry>
     243
     244      <varlistentry id="findfs">
     245        <term><command>findfs</command></term>
     246        <listitem>
     247          <para>Finds a file system by label or Universally Unique Identifier
     248          (UUID)</para>
     249          <indexterm zone="ch-system-e2fsprogs findfs">
     250            <primary sortas="b-findfs">findfs</primary>
     251          </indexterm>
     252        </listitem>
     253      </varlistentry>
     254
     255      <varlistentry id="fsck">
     256        <term><command>fsck</command></term>
     257        <listitem>
     258          <para>Is used to check, and optionally repair, file systems</para>
     259          <indexterm zone="ch-system-e2fsprogs fsck">
     260            <primary sortas="b-fsck">fsck</primary>
     261          </indexterm>
     262        </listitem>
     263      </varlistentry>
     264
     265      <varlistentry id="fsck.ext2">
     266        <term><command>fsck.ext2</command></term>
     267        <listitem>
     268          <para>By default checks <systemitem class="filesystem">ext2</systemitem>
     269          file systems</para>
     270          <indexterm zone="ch-system-e2fsprogs fsck.ext2">
     271            <primary sortas="b-fsck.ext2">fsck.ext2</primary>
     272          </indexterm>
     273        </listitem>
     274      </varlistentry>
     275
     276      <varlistentry id="fsck.ext3">
     277        <term><command>fsck.ext3</command></term>
     278        <listitem>
     279          <para>By default checks <systemitem class="filesystem">ext3</systemitem>
     280          file systems</para>
     281          <indexterm zone="ch-system-e2fsprogs fsck.ext3">
     282            <primary sortas="b-fsck.ext3">fsck.ext3</primary>
     283          </indexterm>
     284        </listitem>
     285      </varlistentry>
     286
     287      <varlistentry id="logsave">
     288        <term><command>logsave</command></term>
     289        <listitem>
     290          <para>Saves the output of a command in a log file</para>
     291          <indexterm zone="ch-system-e2fsprogs logsave">
     292            <primary sortas="b-logsave">logsave</primary>
     293          </indexterm>
     294        </listitem>
     295      </varlistentry>
     296
     297      <varlistentry id="lsattr">
     298        <term><command>lsattr</command></term>
     299        <listitem>
     300          <para>Lists the attributes of files on a second extended file
     301          system</para>
     302          <indexterm zone="ch-system-e2fsprogs lsattr">
     303            <primary sortas="b-lsattr">lsattr</primary>
     304          </indexterm>
     305        </listitem>
     306      </varlistentry>
     307
     308      <varlistentry id="mk_cmds">
     309        <term><command>mk_cmds</command></term>
     310        <listitem>
     311          <para>Converts a table of command names and help messages into a C
     312          source file suitable for use with the <filename
     313          class="libraryfile">libss</filename> subsystem library</para>
     314          <indexterm zone="ch-system-e2fsprogs mk_cmds">
     315            <primary sortas="b-mk_cmds">mk_cmds</primary>
     316          </indexterm>
     317        </listitem>
     318      </varlistentry>
     319
     320      <varlistentry id="mke2fs">
     321        <term><command>mke2fs</command></term>
     322        <listitem>
     323          <para>Creates an <systemitem class="filesystem">ext2</systemitem>
     324          or <systemitem class="filesystem">ext3</systemitem> file system on
     325          the given device</para>
     326          <indexterm zone="ch-system-e2fsprogs mke2fs">
     327            <primary sortas="b-mke2fs">mke2fs</primary>
     328          </indexterm>
     329        </listitem>
     330      </varlistentry>
     331
     332      <varlistentry id="mkfs.ext2">
     333        <term><command>mkfs.ext2</command></term>
     334        <listitem>
     335          <para>By default creates <systemitem class="filesystem">ext2</systemitem>
     336          file systems</para>
     337          <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
     338            <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
     339          </indexterm>
     340        </listitem>
     341      </varlistentry>
     342
     343      <varlistentry id="mkfs.ext3">
     344        <term><command>mkfs.ext3</command></term>
     345        <listitem>
     346          <para>By default creates <systemitem class="filesystem">ext3</systemitem>
     347          file systems</para>
     348          <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
     349            <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
     350          </indexterm>
     351        </listitem>
     352      </varlistentry>
     353
     354      <varlistentry id="mklost-found">
     355        <term><command>mklost+found</command></term>
     356        <listitem>
     357          <para>Used to create a <filename class="directory">lost+found</filename>
     358          directory on an <systemitem class="filesystem">ext2</systemitem> file
     359          system; it pre-allocates disk blocks to this directory to lighten the
     360          task of <command>e2fsck</command></para>
     361          <indexterm zone="ch-system-e2fsprogs mklost-found">
     362            <primary sortas="b-mklost+found">mklost+found</primary>
     363          </indexterm>
     364        </listitem>
     365      </varlistentry>
     366
     367      <varlistentry id="resize2fs">
     368        <term><command>resize2fs</command></term>
     369        <listitem>
     370          <para>Can be used to enlarge or shrink an <systemitem
     371          class="filesystem">ext2</systemitem> file system</para>
     372          <indexterm zone="ch-system-e2fsprogs resize2fs">
     373            <primary sortas="b-resize2fs">resize2fs</primary>
     374          </indexterm>
     375        </listitem>
     376      </varlistentry>
     377
     378      <varlistentry id="tune2fs">
     379        <term><command>tune2fs</command></term>
     380        <listitem>
     381          <para>Adjusts tunable file system parameters on an <systemitem
     382          class="filesystem">ext2</systemitem> file system</para>
     383          <indexterm zone="ch-system-e2fsprogs tune2fs">
     384            <primary sortas="b-tune2fs">tune2fs</primary>
     385          </indexterm>
     386        </listitem>
     387      </varlistentry>
     388
     389      <varlistentry id="uuidgen">
     390        <term><command>uuidgen</command></term>
     391        <listitem>
     392          <para>Creates new UUIDs. Each new UUID can reasonably be considered
     393          unique among all UUIDs created, on the local system and on other
     394          systems, in the past and in the future</para>
     395          <indexterm zone="ch-system-e2fsprogs uuidgen">
     396            <primary sortas="b-uuidgen">uuidgen</primary>
     397          </indexterm>
     398        </listitem>
     399      </varlistentry>
     400
     401      <varlistentry id="libblkid">
     402        <term><filename class="libraryfile">libblkid</filename></term>
     403        <listitem>
     404          <para>Contains routines for device identification and token
     405          extraction</para>
     406          <indexterm zone="ch-system-e2fsprogs libblkid">
     407            <primary sortas="c-libblkid">libblkid</primary>
     408          </indexterm>
     409        </listitem>
     410      </varlistentry>
     411
     412      <varlistentry id="libcom_err">
     413        <term><filename class="libraryfile">libcom_err</filename></term>
     414        <listitem>
     415          <para>The common error display routine</para>
     416          <indexterm zone="ch-system-e2fsprogs libcom_err">
     417            <primary sortas="c-libcom_err">libcom_err</primary>
     418          </indexterm>
     419        </listitem>
     420      </varlistentry>
     421
     422      <varlistentry id="libe2p">
     423        <term><filename class="libraryfile">libe2p</filename></term>
     424        <listitem>
     425          <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
     426          and <command>lsattr</command></para>
     427          <indexterm zone="ch-system-e2fsprogs libe2p">
     428            <primary sortas="c-libe2p">libe2p</primary>
     429          </indexterm>
     430        </listitem>
     431      </varlistentry>
     432
     433      <varlistentry id="libext2fs">
     434        <term><filename class="libraryfile">libext2fs</filename></term>
     435        <listitem>
     436          <para>Contains routines to enable user-level programs to manipulate an
     437          <systemitem class="filesystem">ext2</systemitem> file system</para>
     438          <indexterm zone="ch-system-e2fsprogs libext2fs">
     439            <primary sortas="c-libext2fs">libext2fs</primary>
     440          </indexterm>
     441        </listitem>
     442      </varlistentry>
     443
     444      <varlistentry id="libss">
     445        <term><filename class="libraryfile">libss</filename></term>
     446        <listitem>
     447          <para>Used by <command>debugfs</command></para>
     448          <indexterm zone="ch-system-e2fsprogs libss">
     449            <primary sortas="c-libss">libss</primary>
     450          </indexterm>
     451        </listitem>
     452      </varlistentry>
     453
     454      <varlistentry id="libuuid">
     455        <term><filename class="libraryfile">libuuid</filename></term>
     456        <listitem>
     457          <para>Contains routines for generating unique identifiers for objects
     458          that may be accessible beyond the local system</para>
     459          <indexterm zone="ch-system-e2fsprogs libuuid">
     460            <primary sortas="c-libuuid">libuuid</primary>
     461          </indexterm>
     462        </listitem>
     463      </varlistentry>
     464
     465    </variablelist>
     466
     467  </sect2>
    378468
    379469</sect1>
    380 

  • chapter06/file.xml

    re6ab4b5 rfa994c9  
    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-file" role="wrap">
    7 <title>File-&file-version;</title>
    8 <?dbhtml filename="file.html"?>
     9  <?dbhtml filename="file.html"?>
    910
    10 <indexterm zone="ch-system-file"><primary sortas="a-File">File</primary></indexterm>
     11  <title>File-&file-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The File package contains a utility for determining the type of a given
    14 file or files.</para>
     13  <indexterm zone="ch-system-file">
     14    <primary sortas="a-File">File</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>6.2 MB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
    25 GCC, Glibc, Grep, Make, Sed, and Zlib</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
     20    <para>The File package contains a utility for determining the type of a given
     21    file or files.</para>
    2822
    29 <sect2 role="installation">
    30 <title>Installation of File</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3126
    32 <para>Prepare File for compilation:</para>
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>6.2 MB</seg>
     30      </seglistitem>
     31    </segmentedlist>
    3332
    34 <screen><userinput>./configure --prefix=/usr</userinput></screen>
     33    <segmentedlist>
     34      <segtitle>&dependencies;</segtitle>
    3535
    36 <para>Compile the package:</para>
     36      <seglistitem>
     37        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make,
     38        Sed, and Zlib</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of File</title>
     46
     47    <para>Prepare File for compilation:</para>
     48
     49<screen><userinput>./configure --prefix=/usr</userinput></screen>
     50
     51    <para>Compile the package:</para>
    3752
    3853<screen><userinput>make</userinput></screen>
    3954
    40 <para>This package does not come with a test suite.</para>
     55    <para>This package does not come with a test suite.</para>
    4156
    42 <para>Install the package:</para>
     57    <para>Install the package:</para>
    4358
    4459<screen><userinput>make install</userinput></screen>
    4560
    46 </sect2>
     61  </sect2>
    4762
    4863
    49 <sect2 id="contents-file" role="content"><title>Contents of File</title>
     64  <sect2 id="contents-file" role="content">
     65    <title>Contents of File</title>
    5066
    51 <segmentedlist>
    52 <segtitle>Installed programs</segtitle>
    53 <segtitle>Installed library</segtitle>
    54 <seglistitem><seg>file</seg><seg>libmagic.[a,so]</seg></seglistitem>
    55 </segmentedlist>
     67    <segmentedlist>
     68      <segtitle>Installed programs</segtitle>
     69      <segtitle>Installed library</segtitle>
    5670
    57 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    58 <?dbfo list-presentation="list"?>
    59 <?dbhtml list-presentation="table"?>
     71      <seglistitem>
     72        <seg>file</seg>
     73        <seg>libmagic.[a,so]</seg>
     74      </seglistitem>
     75    </segmentedlist>
    6076
    61 <varlistentry id="file">
    62 <term><command>file</command></term>
    63 <listitem>
    64 <para>Tries to classify each given file; it does this by performing
    65 several tests&mdash;file system tests, magic number tests, and language
    66 tests</para>
    67 <indexterm zone="ch-system-file file"><primary sortas="b-file">file</primary></indexterm>
    68 </listitem>
    69 </varlistentry>
     77    <variablelist>
     78      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     79      <?dbfo list-presentation="list"?>
     80      <?dbhtml list-presentation="table"?>
    7081
    71 <varlistentry id="libmagic">
    72 <term><filename class="libraryfile">libmagic</filename></term>
    73 <listitem>
    74 <para>Contains routines for magic number recognition, used by the
    75 <command>file</command> program</para>
    76 <indexterm zone="ch-system-file libmagic"><primary sortas="c-libmagic">libmagic</primary></indexterm>
    77 </listitem>
    78 </varlistentry>
    79 </variablelist>
     82      <varlistentry id="file">
     83        <term><command>file</command></term>
     84        <listitem>
     85          <para>Tries to classify each given file; it does this by performing
     86          several tests&mdash;file system tests, magic number tests, and language
     87          tests</para>
     88          <indexterm zone="ch-system-file file">
     89            <primary sortas="b-file">file</primary>
     90          </indexterm>
     91        </listitem>
     92      </varlistentry>
    8093
    81 </sect2>
     94      <varlistentry id="libmagic">
     95        <term><filename class="libraryfile">libmagic</filename></term>
     96        <listitem>
     97          <para>Contains routines for magic number recognition, used by the
     98          <command>file</command> program</para>
     99          <indexterm zone="ch-system-file libmagic">
     100            <primary sortas="c-libmagic">libmagic</primary>
     101          </indexterm>
     102        </listitem>
     103      </varlistentry>
     104
     105    </variablelist>
     106
     107  </sect2>
    82108
    83109</sect1>
    84 

  • chapter06/findutils.xml

    re6ab4b5 rfa994c9  
    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-findutils" role="wrap">
    7 <title>Findutils-&findutils-version;</title>
    8 <?dbhtml filename="findutils.html"?>
     9  <?dbhtml filename="findutils.html"?>
    910
    10 <indexterm zone="ch-system-findutils"><primary sortas="a-Findutils">Findutils</primary></indexterm>
     11  <title>Findutils-&findutils-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Findutils package contains programs to find files. These programs
    14 are provided to recursively search through a directory tree and to
    15 create, maintain, and search a database (often faster than the recursive
    16 find, but unreliable if the database has not been recently updated).</para>
     13  <indexterm zone="ch-system-findutils">
     14    <primary sortas="a-Findutils">Findutils</primary>
     15  </indexterm>
    1716
    18 <segmentedlist>
    19 <segtitle>&buildtime;</segtitle>
    20 <segtitle>&diskspace;</segtitle>
    21 <seglistitem><seg>0.1 SBU</seg><seg>9.4 MB</seg></seglistitem>
    22 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2319
    24 <segmentedlist>
    25 <segtitle>&dependencies;</segtitle>
    26 <seglistitem><seg>Bash, Binutils, Coreutils,
    27 Diffutils, GCC, Gettext, Glibc, Grep, Make and Sed</seg></seglistitem>
    28 </segmentedlist>
    29 </sect2>
     20    <para>The Findutils package contains programs to find files. These programs
     21    are provided to recursively search through a directory tree and to
     22    create, maintain, and search a database (often faster than the recursive
     23    find, but unreliable if the database has not been recently updated).</para>
    3024
    31 <sect2 role="installation">
    32 <title>Installation of Findutils</title>
     25    <segmentedlist>
     26      <segtitle>&buildtime;</segtitle>
     27      <segtitle>&diskspace;</segtitle>
    3328
    34 <para>Prepare Findutils for compilation:</para>
     29      <seglistitem>
     30        <seg>0.1 SBU</seg>
     31        <seg>9.4 MB</seg>
     32      </seglistitem>
     33    </segmentedlist>
     34
     35    <segmentedlist>
     36      <segtitle>&dependencies;</segtitle>
     37
     38      <seglistitem>
     39        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, Grep,
     40        Make and Sed</seg>
     41      </seglistitem>
     42    </segmentedlist>
     43
     44  </sect2>
     45
     46  <sect2 role="installation">
     47    <title>Installation of Findutils</title>
     48
     49    <para>Prepare Findutils for compilation:</para>
    3550
    3651<screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib/findutils \
    3752    --localstatedir=/var/lib/locate</userinput></screen>
    3853
    39 <para>The meaning of the configure options:</para>
     54    <variablelist>
     55      <title>The meaning of the configure options:</title>
    4056
    41 <variablelist>
    42 <varlistentry>
    43 <term><parameter>--localstatedir</parameter></term>
    44 <listitem><para>This option changes the location of the <command>locate</command>
    45 database to be in <filename class="directory">/var/lib/locate</filename>, which
    46 is FHS-compliant.</para></listitem>
    47 </varlistentry>
    48 </variablelist>
     57      <varlistentry>
     58        <term><parameter>--localstatedir</parameter></term>
     59        <listitem>
     60          <para>This option changes the location of the <command>locate</command>
     61          database to be in <filename class="directory">/var/lib/locate</filename>,
     62          which is FHS-compliant.</para>
     63        </listitem>
     64      </varlistentry>
    4965
    50 <para>Compile the package:</para>
     66    </variablelist>
     67
     68    <para>Compile the package:</para>
    5169
    5270<screen><userinput>make</userinput></screen>
    5371
    54 <para>To test the results, issue:
    55 <userinput>make check</userinput>.</para>
     72    <para>To test the results, issue:
     73    <userinput>make check</userinput>.</para>
    5674
    57 <para>Install the package:</para>
     75    <para>Install the package:</para>
    5876
    5977<screen><userinput>make install</userinput></screen>
    6078
    61 </sect2>
     79  </sect2>
    6280
    63 <sect2 id="contents-findutils" role="content"><title>Contents of Findutils</title>
     81  <sect2 id="contents-findutils" role="content">
     82    <title>Contents of Findutils</title>
    6483
    65 <segmentedlist>
    66 <segtitle>Installed programs</segtitle>
    67 <seglistitem><seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg></seglistitem>
    68 </segmentedlist>
     84    <segmentedlist>
     85      <segtitle>Installed programs</segtitle>
    6986
    70 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    71 <?dbfo list-presentation="list"?>
    72 <?dbhtml list-presentation="table"?>
     87      <seglistitem>
     88        <seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg>
     89      </seglistitem>
     90    </segmentedlist>
    7391
    74 <varlistentry id="bigram">
    75 <term><command>bigram</command></term>
    76 <listitem>
    77 <para>Was formerly used to produce <command>locate</command> databases</para>
    78 <indexterm zone="ch-system-findutils bigram"><primary sortas="b-bigram">bigram</primary></indexterm>
    79 </listitem>
    80 </varlistentry>
     92    <variablelist>
     93      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     94      <?dbfo list-presentation="list"?>
     95      <?dbhtml list-presentation="table"?>
    8196
    82 <varlistentry id="code">
    83 <term><command>code</command></term>
    84 <listitem>
    85 <para>Was formerly used to produce <command>locate</command>
    86 databases; it is the ancestor of <command>frcode</command>.</para>
    87 <indexterm zone="ch-system-findutils code"><primary sortas="b-code">code</primary></indexterm>
    88 </listitem>
    89 </varlistentry>
     97      <varlistentry id="bigram">
     98        <term><command>bigram</command></term>
     99        <listitem>
     100          <para>Was formerly used to produce <command>locate</command>
     101          databases</para>
     102          <indexterm zone="ch-system-findutils bigram">
     103            <primary sortas="b-bigram">bigram</primary>
     104          </indexterm>
     105        </listitem>
     106      </varlistentry>
    90107
    91 <varlistentry id="find">
    92 <term><command>find</command></term>
    93 <listitem>
    94 <para>Searches given directory trees for files matching the specified criteria</para>
    95 <indexterm zone="ch-system-findutils find"><primary sortas="b-find">find</primary></indexterm>
    96 </listitem>
    97 </varlistentry>
     108      <varlistentry id="code">
     109        <term><command>code</command></term>
     110        <listitem>
     111          <para>Was formerly used to produce <command>locate</command>
     112          databases; it is the ancestor of <command>frcode</command>.</para>
     113          <indexterm zone="ch-system-findutils code">
     114            <primary sortas="b-code">code</primary>
     115          </indexterm>
     116        </listitem>
     117      </varlistentry>
    98118
    99 <varlistentry id="frcode">
    100 <term><command>frcode</command></term>
    101 <listitem>
    102 <para>Is called by <command>updatedb</command> to compress the list of file names; it uses
    103 front-compression, reducing the database size by a factor of four to
    104 five.</para>
    105 <indexterm zone="ch-system-findutils frcode"><primary sortas="b-frcode">frcode</primary></indexterm>
    106 </listitem>
    107 </varlistentry>
     119      <varlistentry id="find">
     120        <term><command>find</command></term>
     121        <listitem>
     122          <para>Searches given directory trees for files matching the specified
     123          criteria</para>
     124          <indexterm zone="ch-system-findutils find">
     125            <primary sortas="b-find">find</primary>
     126          </indexterm>
     127        </listitem>
     128      </varlistentry>
    108129
    109 <varlistentry id="locate">
    110 <term><command>locate</command></term>
    111 <listitem>
    112 <para>Searches through a database of file names and reports the names
    113 that contain a given string or match a given pattern</para>
    114 <indexterm zone="ch-system-findutils locate"><primary sortas="b-locate">locate</primary></indexterm>
    115 </listitem>
    116 </varlistentry>
     130      <varlistentry id="frcode">
     131        <term><command>frcode</command></term>
     132        <listitem>
     133          <para>Is called by <command>updatedb</command> to compress the list
     134          of file names; it uses front-compression, reducing the database size
     135          by a factor of four to five.</para>
     136          <indexterm zone="ch-system-findutils frcode">
     137            <primary sortas="b-frcode">frcode</primary>
     138          </indexterm>
     139        </listitem>
     140      </varlistentry>
    117141
    118 <varlistentry id="updatedb">
    119 <term><command>updatedb</command></term>
    120 <listitem>
    121 <para>Updates the <command>locate</command> database; it scans
    122 the entire file system (including other file systems that are currently mounted,
    123 unless told not to) and puts every file name it finds into the database</para>
    124 <indexterm zone="ch-system-findutils updatedb"><primary sortas="b-updatedb">updatedb</primary></indexterm>
    125 </listitem>
    126 </varlistentry>
     142      <varlistentry id="locate">
     143        <term><command>locate</command></term>
     144        <listitem>
     145          <para>Searches through a database of file names and reports the names
     146          that contain a given string or match a given pattern</para>
     147          <indexterm zone="ch-system-findutils locate">
     148            <primary sortas="b-locate">locate</primary>
     149          </indexterm>
     150        </listitem>
     151      </varlistentry>
    127152
    128 <varlistentry id="xargs">
    129 <term><command>xargs</command></term>
    130 <listitem>
    131 <para>Can be used to apply a given command to a list of files</para>
    132 <indexterm zone="ch-system-findutils xargs"><primary sortas="b-xargs">xargs</primary></indexterm>
    133 </listitem>
    134 </varlistentry>
    135 </variablelist>
     153      <varlistentry id="updatedb">
     154      <term><command>updatedb</command></term>
     155        <listitem>
     156          <para>Updates the <command>locate</command> database; it scans the
     157          entire file system (including other file systems that are currently
     158          mounted, unless told not to) and puts every file name it finds into
     159          the database</para>
     160          <indexterm zone="ch-system-findutils updatedb">
     161            <primary sortas="b-updatedb">updatedb</primary>
     162          </indexterm>
     163        </listitem>
     164      </varlistentry>
    136165
    137 </sect2>
     166      <varlistentry id="xargs">
     167        <term><command>xargs</command></term>
     168        <listitem>
     169          <para>Can be used to apply a given command to a list of files</para>
     170          <indexterm zone="ch-system-findutils xargs">
     171            <primary sortas="b-xargs">xargs</primary>
     172          </indexterm>
     173        </listitem>
     174      </varlistentry>
     175
     176    </variablelist>
     177
     178  </sect2>
    138179
    139180</sect1>
    140 

  • chapter06/flex.xml

    re6ab4b5 rfa994c9  
    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-flex" role="wrap">
    7 <title>Flex-&flex-version;</title>
    8 <?dbhtml filename="flex.html"?>
     9  <?dbhtml filename="flex.html"?>
    910
    10 <indexterm zone="ch-system-flex"><primary sortas="a-Flex">Flex</primary></indexterm>
     11  <title>Flex-&flex-version;</title>
    1112
    12 <sect2 role="package"><title/>
    13 <para>The Flex package contains a utility for generating programs that
    14 recognize patterns in text.</para>
     13  <indexterm zone="ch-system-flex">
     14    <primary sortas="a-Flex">Flex</primary>
     15  </indexterm>
    1516
    16 <segmentedlist>
    17 <segtitle>&buildtime;</segtitle>
    18 <segtitle>&diskspace;</segtitle>
    19 <seglistitem><seg>0.1 SBU</seg><seg>22.5 MB</seg></seglistitem>
    20 </segmentedlist>
     17  <sect2 role="package">
     18    <title/>
    2119
    22 <segmentedlist>
    23 <segtitle>&dependencies;</segtitle>
    24 <seglistitem><seg>Bash, Binutils, Bison, Coreutils, Diffutils,
    25 GCC, Gettext, Glibc, Grep, M4, Make, Patch, and Sed</seg></seglistitem>
    26 </segmentedlist>
    27 </sect2>
     20    <para>The Flex package contains a utility for generating programs that
     21    recognize patterns in text.</para>
    2822
    29 <sect2 role="installation">
    30 <title>Installation of Flex</title>
     23    <segmentedlist>
     24      <segtitle>&buildtime;</segtitle>
     25      <segtitle>&diskspace;</segtitle>
    3126
    32 <para>Flex contains several known bugs. Fix these with the following patch:</para>
     27      <seglistitem>
     28        <seg>0.1 SBU</seg>
     29        <seg>22.5 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, M4, Make, Patch, and Sed</seg>
     39      </seglistitem>
     40    </segmentedlist>
     41
     42  </sect2>
     43
     44  <sect2 role="installation">
     45    <title>Installation of Flex</title>
     46
     47    <para>Flex contains several known bugs. Fix these with the following
     48    patch:</para>
    3349
    3450<screen><userinput>patch -Np1 -i ../&flex-fixes-patch;</userinput></screen>
    3551
    36 <para>The GNU autotools detects that the Flex source code has been
    37 modified by the previous patch and tries to update the man page
    38 accordingly. This does not work correctly on many systems, and the
    39 default page is fine, so make sure it does not get regenerated:</para>
     52    <para>The GNU autotools detects that the Flex source code has been
     53    modified by the previous patch and tries to update the man page
     54    accordingly. This does not work correctly on many systems, and the
     55    default page is fine, so make sure it does not get regenerated:</para>
    4056
    4157<screen><userinput>touch doc/flex.1</userinput></screen>
    4258
    43 <para>Prepare Flex for compilation:</para>
     59    <para>Prepare Flex for compilation:</para>
    4460
    4561<screen><userinput>./configure --prefix=/usr</userinput></screen>
    4662
    47 <para>Compile the package:</para>
     63    <para>Compile the package:</para>
    4864
    4965<screen><userinput>make</userinput></screen>
    5066
    51 <para>To test the results, issue:
    52 <userinput>make check</userinput>.</para>
     67    <para>To test the results, issue:
     68    <userinput>make check</userinput>.</para>
    5369
    54 <para>Install the package:</para>
     70    <para>Install the package:</para>
    5571
    5672<screen><userinput>make install</userinput></screen>
    5773
    58 <para>There are some packages that expect to find the
    59 <filename class="libraryfile">lex</filename> library in <filename
    60 class="directory">/usr/lib</filename>. Create a symlink to account for
    61 this:</para>
     74    <para>There are some packages that expect to find the
     75    <filename class="libraryfile">lex</filename> library in <filename
     76    class="directory">/usr/lib</filename>. Create a symlink to account for
     77    this:</para>
    6278
    6379<screen><userinput>ln -sv libfl.a /usr/lib/libl.a</userinput></screen>
    6480
    65 <para>A few programs do not know about <command>flex</command> yet and
    66 try to run its predecessor, <command>lex</command>. To support those
    67 programs, create a wrapper script named <filename>lex</filename> that
    68 calls <filename>flex</filename> in <command>lex</command> emulation mode:</para>
     81    <para>A few programs do not know about <command>flex</command> yet and
     82    try to run its predecessor, <command>lex</command>. To support those
     83    programs, create a wrapper script named <filename>lex</filename> that
     84    calls <filename>flex</filename> in <command>lex</command> emulation
     85    mode:</para>
    6986
    7087<screen><userinput>cat &gt; /usr/bin/lex &lt;&lt; "EOF"
    … …  
    7895chmod -v 755 /usr/bin/lex</userinput></screen>
    7996
    80 </sect2>
     97  </sect2>
    8198
     99  <sect2 id="contents-flex" role="content">
     100    <title>Contents of Flex</title>
    82101
    83 <sect2 id="contents-flex" role="content"><title>Contents of Flex</title>
     102    <segmentedlist>
     103      <segtitle>Installed programs</segtitle>
     104      <segtitle>Installed library</segtitle>
    84105
    85 <segmentedlist>
    86 <segtitle>Installed programs</segtitle>
    87 <segtitle>Installed library</segtitle>
    88 <seglistitem><seg>flex and lex</seg>
    89 <seg>libfl.a</seg></seglistitem>
    90 </segmentedlist>
     106      <seglistitem>
     107        <seg>flex and lex</seg>
     108        <seg>libfl.a</seg>
     109      </seglistitem>
     110    </segmentedlist>
    91111
    92 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
    93 <?dbfo list-presentation="list"?>
    94 <?dbhtml list-presentation="table"?>
     112    <variablelist>
     113      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     114      <?dbfo list-presentation="list"?>
     115      <?dbhtml list-presentation="table"?>
    95116
    96 <varlistentry id="flex">
    97 <term><command>flex</command></term>
    98 <listitem>
    99 <para>A tool for generating programs that recognize patterns in text;
    100 it allows for the versatility to specify the rules for
    101 pattern-finding, eradicating the need to develop a specialized
    102 program</para>
    103 <indexterm zone="ch-system-flex flex"><primary sortas="b-flex">flex</primary></indexterm>
    104 </listitem>
    105 </varlistentry>
     117      <varlistentry id="flex">
     118        <term><command>flex</command></term>
     119        <listitem>
     120          <para>A tool for generating programs that recognize patterns in text;
     121          it allows for the versatility to specify the rules for pattern-finding,
     122          eradicating the need to develop a specialized program</para>
     123          <indexterm zone="ch-system-flex flex">
     124            <primary sortas="b-flex">flex</primary>
     125          </indexterm>
     126        </listitem>
     127      </varlistentry>
    106128
    107 <varlistentry id="lex">
    108 <term><command>lex</command></term>
    109 <listitem>
    110 <para>A script that runs <command>flex</command> in <command>lex</command>
    111 emulation mode</para>
    112 <indexterm zone="ch-system-flex lex"><primary sortas="b-lex">lex</primary></indexterm>
    113 </listitem>
    114 </varlistentry>
     129      <varlistentry id="lex">
     130        <term><command>lex</command></term>
     131        <listitem>
     132          <para>A script that runs <command>flex</command> in
     133          <command>lex</command> emulation mode</para>
     134          <indexterm zone="ch-system-flex lex">
     135            <primary sortas="b-lex">lex</primary>
     136          </indexterm>
     137        </listitem>
     138      </varlistentry>
    115139
    116 <varlistentry id="libfl.a">
    117 <term><filename class="libraryfile">libfl.a</filename></term>
    118 <listitem>
    119 <para>The <filename class="libraryfile">flex</filename> library</para>
    120 <indexterm zone="ch-system-flex libfl.a"><primary sortas="c-libfl.a">libfl.a</primary></indexterm>
    121 </listitem>
    122 </varlistentry>
    123 </variablelist>
     140      <varlistentry id="libfl.a">
     141        <term><filename class="libraryfile">libfl.a</filename></term>
     142        <listitem>
     143          <para>The <filename class="libraryfile">flex</filename> library</para>
     144          <indexterm zone="ch-system-flex libfl.a">
     145            <primary sortas="c-libfl.a">libfl.a</primary>
     146          </indexterm>
     147        </listitem>
     148      </varlistentry>
    124149
    125 </sect2>
     150    </variablelist>
     151
     152  </sect2>
    126153
    127154</sect1>
    128 
Note: See TracChangeset for help on using the changeset viewer.