gronod/lfs
1
0
Fork 0
mirror of https://git.linuxfromscratch.org/lfs.git synced 2025-07-10 14:24:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Indenting chapter 6, part 4

Browse Source 
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7340 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
This commit is contained in:
Manuel Canales Esparcia 2006-02-03 20:54:03 +00:00
parent 45b032ff25
commit 54e422c1d9
7 changed files with 1107 additions and 830 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

414
chapter06/db.xml
View File

@ -1,218 +1,278 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-db" role="wrap"> <sect1 id="ch-system-db" role="wrap">
<title>Berkeley DB-&db-version;</title> <?dbhtml filename="db.html"?>
<?dbhtml filename="db.html"?>
<indexterm zone="ch-system-db"><primary sortas="a-Berkeley-DB">Berkeley DB</primary></indexterm> <title>Berkeley DB-&db-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-db">
<para>The Berkeley DB package contains programs and utilities used by many other <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
applications for database related functions.</para> </indexterm>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>1.2 SBU</seg><seg>78 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The Berkeley DB package contains programs and utilities used by many
<segtitle>&dependencies;</segtitle> other applications for database related functions.</para>
<seglistitem><seg>Bash, Binutils, Coreutils,
Diffutils, GCC, Glibc, Make and Sed.</seg></seglistitem>
</segmentedlist>
<tip> <segmentedlist>
<title>Extra functionality for Berkeley DB in BLFS</title> <segtitle>&buildtime;</segtitle>
<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 <segtitle>&diskspace;</segtitle>
additional language bindings will require additional packages to be
installed. The BLFS instructions are located at
<ulink url="&blfs-root;view/svn/server/databases.html#db"/>
for suggested installation instructions.</para>
</tip>
</sect2> <seglistitem>
<seg>1.2 SBU</seg>
<seg>78 MB</seg>
</seglistitem>
</segmentedlist>
<sect2 role="installation"> <segmentedlist>
<title>Installation of Berkeley DB</title> <segtitle>&dependencies;</segtitle>
<para>Prepare Berkeley DB for compilation:</para> <seglistitem>
<seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Make and Sed.</seg>
</seglistitem>
</segmentedlist>
<tip>
<title>Extra functionality for Berkeley DB in BLFS</title>
<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 additional language bindings will require additional
packages to be installed. The BLFS instructions are located at
<ulink url="&blfs-root;view/svn/server/databases.html#db"/> for
suggested installation instructions.</para>
</tip>
</sect2>
<sect2 role="installation">
<title>Installation of Berkeley DB</title>
<para>Prepare Berkeley DB for compilation:</para>
<screen><userinput>cd build_unix &amp;&amp; <screen><userinput>cd build_unix &amp;&amp;
../dist/configure --prefix=/usr --enable-compat185 --enable-cxx</userinput></screen> ../dist/configure --prefix=/usr --enable-compat185 --enable-cxx</userinput></screen>
<para>The meaning of the configure options:</para> <variablelist>
<title>The meaning of the configure options:</title>
<variablelist> <varlistentry>
<varlistentry> <term><parameter>--enable-compat185</parameter></term>
<term><parameter>--enable-compat185</parameter></term> <listitem>
<listitem><para>This option enables building Berkeley DB 1.85 compatibility API.</para></listitem> <para>This option enables building Berkeley DB 1.85 compatibility
</varlistentry> API.</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><parameter>--enable-cxx</parameter></term> <term><parameter>--enable-cxx</parameter></term>
<listitem><para>This option enables building C++ API libraries.</para></listitem> <listitem>
</varlistentry> <para>This option enables building C++ API libraries.</para>
</variablelist> </listitem>
</varlistentry>
<para>Compile the package:</para> </variablelist>
<para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>It is not possible to test the package meaningfully, because that <para>It is not possible to test the package meaningfully, because
would involve building TCL bindings. TCL bindings cannot be built properly that would involve building TCL bindings. TCL bindings cannot be
now because TCL is linked against Glibc in <filename class="directory">/tools</filename>, built properly now because TCL is linked against Glibc in
not against Glibc in <filename class="directory">/usr</filename>.</para> <filename class="directory">/tools</filename>, not against Glibc in
<filename class="directory">/usr</filename>.</para>
<para>Install the package:</para> <para>Install the package:</para>
<screen><userinput>make docdir=/usr/share/doc/db-&db-version; install</userinput></screen> <screen><userinput>make docdir=/usr/share/doc/db-&db-version; install</userinput></screen>
<para>The meaning of the make option:</para> <variablelist>
<title>The meaning of the make parameter:</title>
<variablelist> <varlistentry>
<varlistentry> <term><parameter>docdir=...</parameter></term>
<term><parameter>docdir=...</parameter></term> <listitem>
<listitem><para>This variable specifies the correct place for the documentation.</para></listitem> <para>This variable specifies the correct place for the
</varlistentry> documentation.</para>
</variablelist> </listitem>
</varlistentry>
<para>Fix the ownerships of the installed files:</para> </variablelist>
<para>Fix the ownerships of the installed files:</para>
<screen><userinput>chown root:root /usr/bin/db_* \ <screen><userinput>chown root:root /usr/bin/db_* \
/usr/lib/libdb* /usr/include/db* &amp;&amp; /usr/lib/libdb* /usr/include/db* &amp;&amp;
chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen> chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-db" role="content">
<title>Contents of Berkeley DB</title>
<segmentedlist>
<segtitle>Installed programs</segtitle>
<segtitle>Installed libraries</segtitle>
<seglistitem>
<seg>db_archive, db_checkpoint, db_deadlock, db_dump, db_hotbackup,
db_load, db_printlog, db_recover, db_stat, db_upgrade, and db_verify</seg>
<seg>libdb.[so,a] and libdb_cxx.[so,a]</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="db_archive">
<term><command>db_archive</command></term>
<listitem>
<para>Prints the pathnames of log files that are no longer in use</para>
<indexterm zone="ch-system-db db_archive">
<primary sortas="b-db_archive">db_archive</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_checkpoint">
<term><command>db_checkpoint</command></term>
<listitem>
<para>A daemon used to monitor and checkpoint database logs</para>
<indexterm zone="ch-system-db db_checkpoint">
<primary sortas="b-db_checkpoint">db_checkpoint</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_deadlock">
<term><command>db_deadlock</command></term>
<listitem>
<para>A daemon used to abort lock requests when deadlocks are
detected</para>
<indexterm zone="ch-system-db db_deadlock">
<primary sortas="b-db_deadlock">db_deadlock</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_dump">
<term><command>db_dump</command></term>
<listitem>
<para>Converts database files to a plain-text file format readable
by <command>db_load</command></para>
<indexterm zone="ch-system-db db_dump">
<primary sortas="b-db_dump">db_dump</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_hotbackup">
<term><command>db_hotbackup</command></term>
<listitem>
<para>Creates <quote>hot backup</quote> or <quote>hot failover</quote>
snapshots of Berkeley DB databases</para>
<indexterm zone="ch-system-db db_hotbackup">
<primary sortas="b-db_hotbackup">db_hotbackup</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_load">
<term><command>db_load</command></term>
<listitem>
<para>Is used to create database files from plain-text files</para>
<indexterm zone="ch-system-db db_load">
<primary sortas="b-db_load">db_load</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_printlog">
<term><command>db_printlog</command></term>
<listitem>
<para>Converts database log files to human readable text</para>
<indexterm zone="ch-system-db db_printlog">
<primary sortas="b-db_printlog">db_printlog</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_recover">
<term><command>db_recover</command></term>
<listitem>
<para>Is used to restore a database to a consistent state after a
failure</para>
<indexterm zone="ch-system-db db_recover">
<primary sortas="b-db_recover">db_recover</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_stat">
<term><command>db_stat</command></term>
<listitem>
<para>Displays statistics for Berkeley databases</para>
<indexterm zone="ch-system-db db_stat">
<primary sortas="b-db_stat">db_stat</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_upgrade">
<term><command>db_upgrade</command></term>
<listitem>
<para>Is used to upgrade database files to a newer version of
Berkeley DB</para>
<indexterm zone="ch-system-db db_upgrade">
<primary sortas="b-db_upgrade">db_upgrade</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_verify">
<term><command>db_verify</command></term>
<listitem>
<para>Is used to run consistency checks on database files</para>
<indexterm zone="ch-system-db db_verify">
<primary sortas="b-db_verify">db_verify</primary>
</indexterm>
</listitem>
</varlistentry>
<sect2 id="contents-db" role="content"><title>Contents of Berkeley DB</title> <varlistentry id="libdb">
<segmentedlist> <term><filename class="libraryfile">libdb.[so,a]</filename></term>
<segtitle>Installed programs</segtitle> <listitem>
<seglistitem><seg>db_archive, db_checkpoint, db_deadlock, db_dump, <para>Contains functions to manipulate database files from C
db_hotbackup, db_load, db_printlog, db_recover, db_stat, db_upgrade and programs</para>
db_verify <indexterm zone="ch-system-db libdb">
</seg></seglistitem> <primary sortas="c-libdb">libdb</primary>
</segmentedlist> </indexterm>
</listitem>
</varlistentry>
<segmentedlist> <varlistentry id="libdb_cxx">
<segtitle>Installed libraries</segtitle> <term><filename class="libraryfile">libdb_cxx.[so,a]</filename></term>
<seglistitem><seg>libdb.[so,a] and libdb_cxx.[so,a]</seg></seglistitem> <listitem>
</segmentedlist> <para>Contains functions to manipulate database files from C++
programs</para>
<indexterm zone="ch-system-db libdb_cxx">
<primary sortas="c-libdb_cxx">libdb_cxx</primary>
</indexterm>
</listitem>
</varlistentry>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> </variablelist>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="db_archive"> </sect2>
<term><command>db_archive</command></term>
<listitem>
<para>Prints the pathnames of log files that are no longer in use</para>
<indexterm zone="ch-system-db db_archive"><primary sortas="b-db_archive">db_archive</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_checkpoint">
<term><command>db_checkpoint</command></term>
<listitem>
<para>A daemon used to monitor and checkpoint database logs</para>
<indexterm zone="ch-system-db db_checkpoint"><primary sortas="b-db_checkpoint">db_checkpoint</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_deadlock">
<term><command>db_deadlock</command></term>
<listitem>
<para>A daemon used to abort lock requests when deadlocks are detected</para>
<indexterm zone="ch-system-db db_deadlock"><primary sortas="b-db_deadlock">db_deadlock</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_dump">
<term><command>db_dump</command></term>
<listitem>
<para>Converts database files to a plain-text file format readable by <command>db_load</command></para>
<indexterm zone="ch-system-db db_dump"><primary sortas="b-db_dump">db_dump</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_hotbackup">
<term><command>db_hotbackup</command></term>
<listitem>
<para>Creates <quote>hot backup</quote> or <quote>hot failover</quote> snapshots of Berkeley DB databases</para>
<indexterm zone="ch-system-db db_hotbackup"><primary sortas="b-db_hotbackup">db_hotbackup</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_load">
<term><command>db_load</command></term>
<listitem>
<para>Is used to create database files from plain-text files</para>
<indexterm zone="ch-system-db db_load"><primary sortas="b-db_load">db_load</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_printlog">
<term><command>db_printlog</command></term>
<listitem>
<para>Converts database log files to human readable text</para>
<indexterm zone="ch-system-db db_printlog"><primary sortas="b-db_printlog">db_printlog</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_recover">
<term><command>db_recover</command></term>
<listitem>
<para>Is used to restore a database to a consistent state after a failure</para>
<indexterm zone="ch-system-db db_recover"><primary sortas="b-db_recover">db_recover</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_stat">
<term><command>db_stat</command></term>
<listitem>
<para>Displays statistics for Berkeley databases</para>
<indexterm zone="ch-system-db db_stat"><primary sortas="b-db_stat">db_stat</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_upgrade">
<term><command>db_upgrade</command></term>
<listitem>
<para>Is used to upgrade database files to a newer version of Berkeley DB</para>
<indexterm zone="ch-system-db db_upgrade"><primary sortas="b-db_upgrade">db_upgrade</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="db_verify">
<term><command>db_verify</command></term>
<listitem>
<para>Is used to run consistency checks on database files</para>
<indexterm zone="ch-system-db db_verify"><primary sortas="b-db_verify">db_verify</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="libdb">
<term><filename class="libraryfile">libdb.[so,a]</filename></term>
<listitem>
<para>Contains functions to manipulate database files from C programs</para>
<indexterm zone="ch-system-db libdb"><primary sortas="c-libdb">libdb</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="libdb_cxx">
<term><filename class="libraryfile">libdb_cxx.[so,a]</filename></term>
<listitem>
<para>Contains functions to manipulate database files from C++ programs</para>
<indexterm zone="ch-system-db libdb_cxx"><primary sortas="c-libdb_cxx">libdb_cxx</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1> </sect1>

91
chapter06/devices.xml
View File

@ -1,48 +1,55 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-devices"> <sect1 id="ch-system-devices">
<title>Populating /dev</title> <?dbhtml filename="devices.html"?>
<?dbhtml filename="devices.html"?>
<indexterm zone="ch-system-devices"><primary sortas="e-/dev/">/dev/*</primary></indexterm> <title>Populating /dev</title>
<sect2> <indexterm zone="ch-system-devices">
<title>Creating Initial Device Nodes</title> <primary sortas="e-/dev/">/dev/*</primary>
</indexterm>
<para>When the kernel boots the system, it requires the presence of a few device <sect2>
nodes, in particular the <filename class="devicefile">console</filename> and <title>Creating Initial Device Nodes</title>
<filename class="devicefile">null</filename> devices. The device nodes will
be created on the hard disk so that they are available before <para>When the kernel boots the system, it requires the presence of a few
<command>udev</command> has been started, and additionally when Linux is started device nodes, in particular the <filename class="devicefile">console</filename>
in single user mode (hence the restrictive permissions on and <filename class="devicefile">null</filename> devices. The device nodes
<filename class="devicefile">console</filename>). Create the devices by running will be created on the hard disk so that they are available before
the following commands:</para> <command>udev</command> has been started, and additionally when Linux is
started in single user mode (hence the restrictive permissions on
<filename class="devicefile">console</filename>). Create the devices by
running the following commands:</para>
<screen><userinput>mknod -m 600 /dev/console c 5 1 <screen><userinput>mknod -m 600 /dev/console c 5 1
mknod -m 666 /dev/null c 1 3</userinput></screen> mknod -m 666 /dev/null c 1 3</userinput></screen>
</sect2>
<sect2> </sect2>
<title>Mounting tmpfs and Populating /dev</title>
<para>The recommended method of populating the <filename <sect2>
class="directory">/dev</filename> directory with devices is to mount a virtual <title>Mounting tmpfs and Populating /dev</title>
filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>) on the
<filename class="directory">/dev</filename> directory, and allow the devices to <para>The recommended method of populating the <filename
be created dynamically on that virtual filesystem as they are detected or class="directory">/dev</filename> directory with devices is to mount a
accessed. This is generally done during the boot process. Since this new system virtual filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>)
has not been booted, it is necessary to do what the LFS-Bootscripts package would on the <filename class="directory">/dev</filename> directory, and allow the
otherwise do by mounting <filename class="directory">/dev</filename>:</para> devices to be created dynamically on that virtual filesystem as they are
detected or accessed. This is generally done during the boot process. Since
this new system has not been booted, it is necessary to do what the
LFS-Bootscripts package would otherwise do by mounting <filename
class="directory">/dev</filename>:</para>
<screen><userinput>mount -nvt tmpfs none /dev</userinput></screen> <screen><userinput>mount -nvt tmpfs none /dev</userinput></screen>
<para>The Udev package is what actually creates the devices in the <filename <para>The Udev package is what actually creates the devices in the <filename
class="directory">/dev</filename> directory. Since it will not be installed class="directory">/dev</filename> directory. Since it will not be installed
until later on in the process, manually create the minimal set of device nodes until later on in the process, manually create the minimal set of device nodes
needed to complete the building of this system:</para> needed to complete the building of this system:</para>
<screen><userinput>mknod -m 622 /dev/console c 5 1 <screen><userinput>mknod -m 622 /dev/console c 5 1
mknod -m 666 /dev/null c 1 3 mknod -m 666 /dev/null c 1 3
@ -53,10 +60,10 @@ mknod -m 444 /dev/random c 1 8
mknod -m 444 /dev/urandom c 1 9 mknod -m 444 /dev/urandom c 1 9
chown -v root:tty /dev/{console,ptmx,tty}</userinput></screen> chown -v root:tty /dev/{console,ptmx,tty}</userinput></screen>
<para>There are some symlinks and directories required by LFS that are created <para>There are some symlinks and directories required by LFS that are
during system startup by the LFS-Bootscripts package. Since this is a chroot created during system startup by the LFS-Bootscripts package. Since this
environment and not a booted environment, those symlinks and directories need to is a chroot environment and not a booted environment, those symlinks and
be created here:</para> directories need to be created here:</para>
<screen><userinput>ln -sv /proc/self/fd /dev/fd <screen><userinput>ln -sv /proc/self/fd /dev/fd
ln -sv /proc/self/fd/0 /dev/stdin ln -sv /proc/self/fd/0 /dev/stdin
@ -66,21 +73,21 @@ ln -sv /proc/kcore /dev/core
mkdir -v /dev/pts mkdir -v /dev/pts
mkdir -v /dev/shm</userinput></screen> mkdir -v /dev/shm</userinput></screen>
<para>Finally, mount the proper virtual (kernel) file systems on the <para>Finally, mount the proper virtual (kernel) file systems on the
newly-created directories:</para> newly-created directories:</para>
<screen><userinput>mount -vt devpts -o gid=4,mode=620 none /dev/pts <screen><userinput>mount -vt devpts -o gid=4,mode=620 none /dev/pts
mount -vt tmpfs none /dev/shm</userinput></screen> mount -vt tmpfs none /dev/shm</userinput></screen>
<para>The <command>mount</command> commands executed above may result <para>The <command>mount</command> commands executed above may result
in the following warning message:</para> in the following warning message:</para>
<screen><computeroutput>can't open /etc/fstab: No such file or directory.</computeroutput></screen> <screen><computeroutput>can't open /etc/fstab: No such file or directory.</computeroutput></screen>
<para>This file&mdash;<filename>/etc/fstab</filename>&mdash;has not <para>This file&mdash;<filename>/etc/fstab</filename>&mdash;has not
been created yet but is also not required for the file systems to be been created yet but is also not required for the file systems to be
properly mounted. As such, the warning can be safely ignored.</para> properly mounted. As such, the warning can be safely ignored.</para>
</sect2>
</sect2>
</sect1> </sect1>

164
chapter06/diffutils.xml
View File

@ -1,102 +1,132 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-diffutils" role="wrap"> <sect1 id="ch-system-diffutils" role="wrap">
<title>Diffutils-&diffutils-version;</title> <?dbhtml filename="diffutils.html"?>
<?dbhtml filename="diffutils.html"?>
<indexterm zone="ch-system-diffutils"><primary sortas="a-Diffutils">Diffutils</primary></indexterm> <title>Diffutils-&diffutils-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-diffutils">
<para>The Diffutils package contains programs that show the differences <primary sortas="a-Diffutils">Diffutils</primary>
between files or directories.</para> </indexterm>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>5.6 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The Diffutils package contains programs that show the differences
<segtitle>&dependencies;</segtitle> between files or directories.</para>
<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, GCC,
Gettext, Glibc, Grep, Make, and Sed</seg></seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation"> <segmentedlist>
<title>Installation of Diffutils</title> <segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<para>POSIX requires the <command>diff</command> command to treat whitespace <seglistitem>
characters according to the current locale. The following patch fixes the <seg>0.1 SBU</seg>
non-compliance issue:</para> <seg>5.6 MB</seg>
</seglistitem>
</segmentedlist>
<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem>
<seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc,
Grep, Make, and Sed</seg>
</seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of Diffutils</title>
<para>POSIX requires the <command>diff</command> command to treat whitespace
characters according to the current locale. The following patch fixes the
non-compliance issue:</para>
<screen><userinput>patch -Np1 -i ../&diffutils-i18n-patch;</userinput></screen> <screen><userinput>patch -Np1 -i ../&diffutils-i18n-patch;</userinput></screen>
<para>Prepare Diffutils for compilation:</para> <para>Prepare Diffutils for compilation:</para>
<screen><userinput>./configure --prefix=/usr</userinput></screen> <screen><userinput>./configure --prefix=/usr</userinput></screen>
<para>Compile the package:</para> <para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>This package does not come with a test suite.</para> <para>This package does not come with a test suite.</para>
<para>Install the package:</para> <para>Install the package:</para>
<screen><userinput>make install</userinput></screen> <screen><userinput>make install</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-diffutils" role="content"><title>Contents of Diffutils</title> <sect2 id="contents-diffutils" role="content">
<title>Contents of Diffutils</title>
<segmentedlist> <segmentedlist>
<segtitle>Installed programs</segtitle> <segtitle>Installed programs</segtitle>
<seglistitem><seg>cmp, diff, diff3, and sdiff</seg></seglistitem>
</segmentedlist>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <seglistitem>
<?dbfo list-presentation="list"?> <seg>cmp, diff, diff3, and sdiff</seg>
<?dbhtml list-presentation="table"?> </seglistitem>
</segmentedlist>
<varlistentry id="cmp"> <variablelist>
<term><command>cmp</command></term> <bridgehead renderas="sect3">Short Descriptions</bridgehead>
<listitem> <?dbfo list-presentation="list"?>
<para>Compares two files and reports whether or in which bytes they differ</para> <?dbhtml list-presentation="table"?>
<indexterm zone="ch-system-diffutils cmp"><primary sortas="b-cmp">cmp</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="diff"> <varlistentry id="cmp">
<term><command>diff</command></term> <term><command>cmp</command></term>
<listitem> <listitem>
<para>Compares two files or directories and reports which lines in the files differ</para> <para>Compares two files and reports whether or in which bytes they
<indexterm zone="ch-system-diffutils diff"><primary sortas="b-diff">diff</primary></indexterm> differ</para>
</listitem> <indexterm zone="ch-system-diffutils cmp">
</varlistentry> <primary sortas="b-cmp">cmp</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="diff3"> <varlistentry id="diff">
<term><command>diff3</command></term> <term><command>diff</command></term>
<listitem> <listitem>
<para>Compares three files line by line</para> <para>Compares two files or directories and reports which lines in
<indexterm zone="ch-system-diffutils diff3"><primary sortas="b-diff3">diff3</primary></indexterm> the files differ</para>
</listitem> <indexterm zone="ch-system-diffutils diff">
</varlistentry> <primary sortas="b-diff">diff</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sdiff"> <varlistentry id="diff3">
<term><command>sdiff</command></term> <term><command>diff3</command></term>
<listitem> <listitem>
<para>Merges two files and interactively outputs the results</para> <para>Compares three files line by line</para>
<indexterm zone="ch-system-diffutils sdiff"><primary sortas="b-sdiff">sdiff</primary></indexterm> <indexterm zone="ch-system-diffutils diff3">
</listitem> <primary sortas="b-diff3">diff3</primary>
</varlistentry> </indexterm>
</variablelist> </listitem>
</varlistentry>
</sect2> <varlistentry id="sdiff">
<term><command>sdiff</command></term>
<listitem>
<para>Merges two files and interactively outputs the results</para>
<indexterm zone="ch-system-diffutils sdiff">
<primary sortas="b-sdiff">sdiff</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1> </sect1>

707
chapter06/e2fsprogs.xml
View File

@ -1,380 +1,469 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-e2fsprogs" role="wrap"> <sect1 id="ch-system-e2fsprogs" role="wrap">
<title>E2fsprogs-&e2fsprogs-version;</title> <?dbhtml filename="e2fsprogs.html"?>
<?dbhtml filename="e2fsprogs.html"?>
<indexterm zone="ch-system-e2fsprogs"><primary sortas="a-E2fsprogs">E2fsprogs</primary></indexterm> <title>E2fsprogs-&e2fsprogs-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-e2fsprogs">
<para>The E2fsprogs package contains the utilities for handling the <primary sortas="a-E2fsprogs">E2fsprogs</primary>
<systemitem class="filesystem">ext2</systemitem> file system. It also supports </indexterm>
the <systemitem class="filesystem">ext3</systemitem> journaling file system.</para>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.6 SBU</seg><seg>40.0 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The E2fsprogs package contains the utilities for handling the
<segtitle>&dependencies;</segtitle> <systemitem class="filesystem">ext2</systemitem> file system. It also
<seglistitem><seg>Bash, Binutils, Coreutils, supports the <systemitem class="filesystem">ext3</systemitem> journaling
Diffutils, Gawk, GCC, Gettext, Glibc, Grep, Make, Sed, and Texinfo</seg></seglistitem> file system.</para>
</segmentedlist>
</sect2>
<sect2 role="installation"> <segmentedlist>
<title>Installation of E2fsprogs</title> <segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<para>It is recommended that E2fsprogs be built in a subdirectory of the source tree: <seglistitem>
</para> <seg>0.6 SBU</seg>
<seg>40.0 MB</seg>
</seglistitem>
</segmentedlist>
<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem>
<seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Gettext, Glibc,
Grep, Make, Sed, and Texinfo</seg>
</seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of E2fsprogs</title>
<para>It is recommended that E2fsprogs be built in a subdirectory of
the source tree: </para>
<screen><userinput>mkdir -v build <screen><userinput>mkdir -v build
cd build</userinput></screen> cd build</userinput></screen>
<para>Prepare E2fsprogs for compilation:</para> <para>Prepare E2fsprogs for compilation:</para>
<screen><userinput>../configure --prefix=/usr --with-root-prefix="" \ <screen><userinput>../configure --prefix=/usr --with-root-prefix="" \
--enable-elf-shlibs --disable-evms</userinput></screen> --enable-elf-shlibs --disable-evms</userinput></screen>
<para>The meaning of the configure options:</para> <variablelist>
<title>The meaning of the configure options:</title>
<variablelist> <varlistentry>
<varlistentry> <term><parameter>--with-root-prefix=""</parameter></term>
<term><parameter>--with-root-prefix=""</parameter></term> <listitem>
<listitem><para>Certain programs (such as the <command>e2fsck</command> program) <para>Certain programs (such as the <command>e2fsck</command>
are considered essential programs. When, for example, <filename program) are considered essential programs. When, for example,
class="directory">/usr</filename> is not mounted, these programs still need <filename class="directory">/usr</filename> is not mounted, these
to be available. They belong in directories like <filename programs still need to be available. They belong in directories
class="directory">/lib</filename> and <filename like <filename class="directory">/lib</filename> and <filename
class="directory">/sbin</filename>. If this option is not passed to E2fsprogs' class="directory">/sbin</filename>. If this option is not passed
configure, the programs are installed into the <filename to E2fsprogs' configure, the programs are installed into the
class="directory">/usr</filename> directory.</para></listitem> <filename class="directory">/usr</filename> directory.</para>
</listitem>
</varlistentry>
</varlistentry> <varlistentry>
<term><parameter>--enable-elf-shlibs</parameter></term>
<listitem>
<para>This creates the shared libraries which some programs
in this package use.</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><parameter>--enable-elf-shlibs</parameter></term> <term><parameter>--disable-evms</parameter></term>
<listitem><para>This creates the shared libraries which some programs <listitem>
in this package use.</para></listitem> <para>This disables the building of the Enterprise Volume
</varlistentry> Management System (EVMS) plugin. This plugin is not up-to-date with
the latest EVMS internal interfaces and EVMS is not installed as part
of a base LFS system, so the plugin is not required. See the EVMS
website at <ulink url="http://evms.sourceforge.net/"/> for more
information regarding EVMS.</para>
</listitem>
</varlistentry>
<varlistentry> </variablelist>
<term><parameter>--disable-evms</parameter></term>
<listitem><para>This disables the building of the Enterprise Volume
Management System (EVMS) plugin. This plugin is not up-to-date with
the latest EVMS internal interfaces and EVMS is not installed as part
of a base LFS system, so the plugin is not required. See the EVMS
website at <ulink url="http://evms.sourceforge.net/"/> for more
information regarding EVMS.</para></listitem>
</varlistentry>
</variablelist>
<para>Compile the package:</para> <para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>To test the results, issue: <para>To test the results, issue:
<userinput>make check</userinput>.</para> <userinput>make check</userinput>.</para>
<para>Install the binaries and documentation:</para> <para>Install the binaries and documentation:</para>
<screen><userinput>make install</userinput></screen> <screen><userinput>make install</userinput></screen>
<para>Install the shared libraries:</para> <para>Install the shared libraries:</para>
<screen><userinput>make install-libs</userinput></screen> <screen><userinput>make install-libs</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-e2fsprogs" role="content">
<title>Contents of E2fsprogs</title>
<segmentedlist>
<segtitle>Installed programs</segtitle>
<segtitle>Installed libraries</segtitle>
<sect2 id="contents-e2fsprogs" role="content"><title>Contents of E2fsprogs</title> <seglistitem>
<seg>badblocks, blkid, chattr, compile_et, debugfs, dumpe2fs, e2fsck,
e2image, e2label, findfs, fsck, fsck.ext2, fsck.ext3, logsave, lsattr,
mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mklost+found, resize2fs,
tune2fs, and uuidgen.</seg>
<seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
</seglistitem>
</segmentedlist>
<segmentedlist> <variablelist>
<segtitle>Installed programs</segtitle> <bridgehead renderas="sect3">Short Descriptions</bridgehead>
<segtitle>Installed libraries</segtitle> <?dbfo list-presentation="list"?>
<seglistitem><seg>badblocks, blkid, chattr, <?dbhtml list-presentation="table"?>
compile_et, debugfs, dumpe2fs, e2fsck, e2image, e2label, findfs, fsck,
fsck.ext2, fsck.ext3, logsave, lsattr, mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3,
mklost+found, resize2fs, tune2fs, and uuidgen.</seg>
<seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg></seglistitem>
</segmentedlist>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <varlistentry id="badblocks">
<?dbfo list-presentation="list"?> <term><command>badblocks</command></term>
<?dbhtml list-presentation="table"?> <listitem>
<para>Searches a device (usually a disk partition) for bad
blocks</para>
<indexterm zone="ch-system-e2fsprogs badblocks">
<primary sortas="b-badblocks">badblocks</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="badblocks"> <varlistentry id="blkid">
<term><command>badblocks</command></term> <term><command>blkid</command></term>
<listitem> <listitem>
<para>Searches a device (usually a disk partition) for bad blocks</para> <para>A command line utility to locate and print block device
<indexterm zone="ch-system-e2fsprogs badblocks"><primary sortas="b-badblocks">badblocks</primary></indexterm> attributes</para>
</listitem> <indexterm zone="ch-system-e2fsprogs blkid">
</varlistentry> <primary sortas="b-blkid">blkid</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="blkid"> <varlistentry id="chattr">
<term><command>blkid</command></term> <term><command>chattr</command></term>
<listitem> <listitem>
<para>A command line utility to locate and print block device attributes</para> <para>Changes the attributes of files on an <systemitem
<indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm> class="filesystem">ext2</systemitem> file system; it also
</listitem> changes <systemitem class="filesystem">ext3</systemitem>
</varlistentry> file systems, the journaling version of <systemitem
class="filesystem">ext2</systemitem> file systems</para>
<indexterm zone="ch-system-e2fsprogs chattr">
<primary sortas="b-chattr">chattr</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="chattr"> <varlistentry id="compile_et">
<term><command>chattr</command></term> <term><command>compile_et</command></term>
<listitem> <listitem>
<para>Changes the attributes of files on an <systemitem <para>An error table compiler; it converts a table of error-code
class="filesystem">ext2</systemitem> file system; it also changes <systemitem names and messages into a C source file suitable for use with the
class="filesystem">ext3</systemitem> file systems, the journaling version of <filename class="libraryfile">com_err</filename> library</para>
<systemitem class="filesystem">ext2</systemitem> file systems</para> <indexterm zone="ch-system-e2fsprogs compile_et">
<indexterm zone="ch-system-e2fsprogs chattr"><primary sortas="b-chattr">chattr</primary></indexterm> <primary sortas="b-compile_et">compile_et</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="compile_et"> <varlistentry id="debugfs">
<term><command>compile_et</command></term> <term><command>debugfs</command></term>
<listitem> <listitem>
<para>An error table compiler; it converts a table of error-code names and <para>A file system debugger; it can be used to examine and change
messages into a C source file suitable for use with the <filename the state of an <systemitem class="filesystem">ext2</systemitem>
class="libraryfile">com_err</filename> library</para> file system</para>
<indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm> <indexterm zone="ch-system-e2fsprogs debugfs">
</listitem> <primary sortas="b-debugfs">debugfs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="debugfs"> <varlistentry id="dumpe2fs">
<term><command>debugfs</command></term> <term><command>dumpe2fs</command></term>
<listitem> <listitem>
<para>A file system debugger; it can be used to examine and change the <para>Prints the super block and blocks group information for the
state of an <systemitem class="filesystem">ext2</systemitem> file system</para> file system present on a given device</para>
<indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm> <indexterm zone="ch-system-e2fsprogs dumpe2fs">
</listitem> <primary sortas="b-dumpe2fs">dumpe2fs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="dumpe2fs"> <varlistentry id="e2fsck">
<term><command>dumpe2fs</command></term> <term><command>e2fsck</command></term>
<listitem> <listitem>
<para>Prints the super block and blocks group information for the file <para>Is used to check, and optionally repair <systemitem
system present on a given device</para> class="filesystem">ext2</systemitem> file systems and <systemitem
<indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm> class="filesystem">ext3</systemitem> file systems</para>
</listitem> <indexterm zone="ch-system-e2fsprogs e2fsck">
</varlistentry> <primary sortas="b-e2fsck">e2fsck</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="e2fsck"> <varlistentry id="e2image">
<term><command>e2fsck</command></term> <term><command>e2image</command></term>
<listitem> <listitem>
<para>Is used to check, and optionally repair <systemitem <para>Is used to save critical <systemitem
class="filesystem">ext2</systemitem> file systems and <systemitem class="filesystem">ext2</systemitem> file system data to a file</para>
class="filesystem">ext3</systemitem> file systems</para> <indexterm zone="ch-system-e2fsprogs e2image">
<indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm> <primary sortas="b-e2image">e2image</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="e2image"> <varlistentry id="e2label">
<term><command>e2image</command></term> <term><command>e2label</command></term>
<listitem> <listitem>
<para>Is used to save critical <systemitem class="filesystem">ext2</systemitem> <para>Displays or changes the file system label on the <systemitem
file system data to a file</para> class="filesystem">ext2</systemitem> file system present on a given
<indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm> device</para>
</listitem> <indexterm zone="ch-system-e2fsprogs e2label">
</varlistentry> <primary sortas="b-e2label">e2label</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="e2label"> <varlistentry id="findfs">
<term><command>e2label</command></term> <term><command>findfs</command></term>
<listitem> <listitem>
<para>Displays or changes the file system label on the <systemitem <para>Finds a file system by label or Universally Unique Identifier
class="filesystem">ext2</systemitem> file system present on a given device</para> (UUID)</para>
<indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm> <indexterm zone="ch-system-e2fsprogs findfs">
</listitem> <primary sortas="b-findfs">findfs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="findfs"> <varlistentry id="fsck">
<term><command>findfs</command></term> <term><command>fsck</command></term>
<listitem> <listitem>
<para>Finds a file system by label or Universally Unique Identifier (UUID)</para> <para>Is used to check, and optionally repair, file systems</para>
<indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm> <indexterm zone="ch-system-e2fsprogs fsck">
</listitem> <primary sortas="b-fsck">fsck</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="fsck"> <varlistentry id="fsck.ext2">
<term><command>fsck</command></term> <term><command>fsck.ext2</command></term>
<listitem> <listitem>
<para>Is used to check, and optionally repair, file systems</para> <para>By default checks <systemitem class="filesystem">ext2</systemitem>
<indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm> file systems</para>
</listitem> <indexterm zone="ch-system-e2fsprogs fsck.ext2">
</varlistentry> <primary sortas="b-fsck.ext2">fsck.ext2</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="fsck.ext2"> <varlistentry id="fsck.ext3">
<term><command>fsck.ext2</command></term> <term><command>fsck.ext3</command></term>
<listitem> <listitem>
<para>By default checks <systemitem class="filesystem">ext2</systemitem> <para>By default checks <systemitem class="filesystem">ext3</systemitem>
file systems</para> file systems</para>
<indexterm zone="ch-system-e2fsprogs fsck.ext2"><primary <indexterm zone="ch-system-e2fsprogs fsck.ext3">
sortas="b-fsck.ext2">fsck.ext2</primary></indexterm> <primary sortas="b-fsck.ext3">fsck.ext3</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="fsck.ext3"> <varlistentry id="logsave">
<term><command>fsck.ext3</command></term> <term><command>logsave</command></term>
<listitem> <listitem>
<para>By default checks <systemitem class="filesystem">ext3</systemitem> <para>Saves the output of a command in a log file</para>
file systems</para> <indexterm zone="ch-system-e2fsprogs logsave">
<indexterm zone="ch-system-e2fsprogs fsck.ext3"><primary <primary sortas="b-logsave">logsave</primary>
sortas="b-fsck.ext3">fsck.ext3</primary></indexterm> </indexterm>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="logsave"> <varlistentry id="lsattr">
<term><command>logsave</command></term> <term><command>lsattr</command></term>
<listitem> <listitem>
<para>Saves the output of a command in a log file</para> <para>Lists the attributes of files on a second extended file
<indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm> system</para>
</listitem> <indexterm zone="ch-system-e2fsprogs lsattr">
</varlistentry> <primary sortas="b-lsattr">lsattr</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="lsattr"> <varlistentry id="mk_cmds">
<term><command>lsattr</command></term> <term><command>mk_cmds</command></term>
<listitem> <listitem>
<para>Lists the attributes of files on a second extended file system</para> <para>Converts a table of command names and help messages into a C
<indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm> source file suitable for use with the <filename
</listitem> class="libraryfile">libss</filename> subsystem library</para>
</varlistentry> <indexterm zone="ch-system-e2fsprogs mk_cmds">
<primary sortas="b-mk_cmds">mk_cmds</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mk_cmds"> <varlistentry id="mke2fs">
<term><command>mk_cmds</command></term> <term><command>mke2fs</command></term>
<listitem> <listitem>
<para>Converts a table of command names and help messages into a C <para>Creates an <systemitem class="filesystem">ext2</systemitem>
source file suitable for use with the <filename or <systemitem class="filesystem">ext3</systemitem> file system on
class="libraryfile">libss</filename> subsystem library</para> the given device</para>
<indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm> <indexterm zone="ch-system-e2fsprogs mke2fs">
</listitem> <primary sortas="b-mke2fs">mke2fs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="mke2fs"> <varlistentry id="mkfs.ext2">
<term><command>mke2fs</command></term> <term><command>mkfs.ext2</command></term>
<listitem> <listitem>
<para>Creates an ext2 or ext3 file system on the given device</para> <para>By default creates <systemitem class="filesystem">ext2</systemitem>
<indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm> file systems</para>
</listitem> <indexterm zone="ch-system-e2fsprogs mkfs.ext2">
</varlistentry> <primary sortas="b-mkfs.ext2">mkfs.ext2</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mkfs.ext2"> <varlistentry id="mkfs.ext3">
<term><command>mkfs.ext2</command></term> <term><command>mkfs.ext3</command></term>
<listitem> <listitem>
<para>By default creates <systemitem class="filesystem">ext2</systemitem> <para>By default creates <systemitem class="filesystem">ext3</systemitem>
file systems</para> file systems</para>
<indexterm zone="ch-system-e2fsprogs mkfs.ext2"><primary <indexterm zone="ch-system-e2fsprogs mkfs.ext3">
sortas="b-mkfs.ext2">mkfs.ext2</primary></indexterm> <primary sortas="b-mkfs.ext3">mkfs.ext3</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="mkfs.ext3"> <varlistentry id="mklost-found">
<term><command>mkfs.ext3</command></term> <term><command>mklost+found</command></term>
<listitem> <listitem>
<para>By default creates <systemitem class="filesystem">ext3</systemitem> <para>Used to create a <filename class="directory">lost+found</filename>
file systems</para> directory on an <systemitem class="filesystem">ext2</systemitem> file
<indexterm zone="ch-system-e2fsprogs mkfs.ext3"><primary system; it pre-allocates disk blocks to this directory to lighten the
sortas="b-mkfs.ext3">mkfs.ext3</primary></indexterm> task of <command>e2fsck</command></para>
</listitem> <indexterm zone="ch-system-e2fsprogs mklost-found">
</varlistentry> <primary sortas="b-mklost+found">mklost+found</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mklost-found"> <varlistentry id="resize2fs">
<term><command>mklost+found</command></term> <term><command>resize2fs</command></term>
<listitem> <listitem>
<para>Used to create a <filename class="directory">lost+found</filename> <para>Can be used to enlarge or shrink an <systemitem
directory on an <systemitem class="filesystem">ext2</systemitem> file system; class="filesystem">ext2</systemitem> file system</para>
it pre-allocates disk blocks to this directory to lighten the task of <indexterm zone="ch-system-e2fsprogs resize2fs">
<command>e2fsck</command></para> <primary sortas="b-resize2fs">resize2fs</primary>
<indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm> </indexterm>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="resize2fs"> <varlistentry id="tune2fs">
<term><command>resize2fs</command></term> <term><command>tune2fs</command></term>
<listitem> <listitem>
<para>Can be used to enlarge or shrink an <systemitem <para>Adjusts tunable file system parameters on an <systemitem
class="filesystem">ext2</systemitem> file system</para> class="filesystem">ext2</systemitem> file system</para>
<indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm> <indexterm zone="ch-system-e2fsprogs tune2fs">
</listitem> <primary sortas="b-tune2fs">tune2fs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="tune2fs"> <varlistentry id="uuidgen">
<term><command>tune2fs</command></term> <term><command>uuidgen</command></term>
<listitem> <listitem>
<para>Adjusts tunable file system parameters on an <systemitem <para>Creates new UUIDs. Each new UUID can reasonably be considered
class="filesystem">ext2</systemitem> file system</para> unique among all UUIDs created, on the local system and on other
<indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm> systems, in the past and in the future</para>
</listitem> <indexterm zone="ch-system-e2fsprogs uuidgen">
</varlistentry> <primary sortas="b-uuidgen">uuidgen</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="uuidgen"> <varlistentry id="libblkid">
<term><command>uuidgen</command></term> <term><filename class="libraryfile">libblkid</filename></term>
<listitem> <listitem>
<para>Creates new UUIDs. Each new UUID can reasonably be considered unique <para>Contains routines for device identification and token
among all UUIDs created, on the local system and on other systems, in the extraction</para>
past and in the future</para> <indexterm zone="ch-system-e2fsprogs libblkid">
<indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm> <primary sortas="c-libblkid">libblkid</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="libblkid"> <varlistentry id="libcom_err">
<term><filename class="libraryfile">libblkid</filename></term> <term><filename class="libraryfile">libcom_err</filename></term>
<listitem> <listitem>
<para>Contains routines for device identification and token extraction</para> <para>The common error display routine</para>
<indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm> <indexterm zone="ch-system-e2fsprogs libcom_err">
</listitem> <primary sortas="c-libcom_err">libcom_err</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="libcom_err"> <varlistentry id="libe2p">
<term><filename class="libraryfile">libcom_err</filename></term> <term><filename class="libraryfile">libe2p</filename></term>
<listitem> <listitem>
<para>The common error display routine</para> <para>Used by <command>dumpe2fs</command>, <command>chattr</command>,
<indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm> and <command>lsattr</command></para>
</listitem> <indexterm zone="ch-system-e2fsprogs libe2p">
</varlistentry> <primary sortas="c-libe2p">libe2p</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libe2p"> <varlistentry id="libext2fs">
<term><filename class="libraryfile">libe2p</filename></term> <term><filename class="libraryfile">libext2fs</filename></term>
<listitem> <listitem>
<para>Used by <command>dumpe2fs</command>, <command>chattr</command>, <para>Contains routines to enable user-level programs to manipulate an
and <command>lsattr</command></para> <systemitem class="filesystem">ext2</systemitem> file system</para>
<indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm> <indexterm zone="ch-system-e2fsprogs libext2fs">
</listitem> <primary sortas="c-libext2fs">libext2fs</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="libext2fs"> <varlistentry id="libss">
<term><filename class="libraryfile">libext2fs</filename></term> <term><filename class="libraryfile">libss</filename></term>
<listitem> <listitem>
<para>Contains routines to enable user-level programs to manipulate an <para>Used by <command>debugfs</command></para>
<systemitem class="filesystem">ext2</systemitem> file system</para> <indexterm zone="ch-system-e2fsprogs libss">
<indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm> <primary sortas="c-libss">libss</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="libss"> <varlistentry id="libuuid">
<term><filename class="libraryfile">libss</filename></term> <term><filename class="libraryfile">libuuid</filename></term>
<listitem> <listitem>
<para>Used by <command>debugfs</command></para> <para>Contains routines for generating unique identifiers for objects
<indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm> that may be accessible beyond the local system</para>
</listitem> <indexterm zone="ch-system-e2fsprogs libuuid">
</varlistentry> <primary sortas="c-libuuid">libuuid</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libuuid"> </variablelist>
<term><filename class="libraryfile">libuuid</filename></term>
<listitem>
<para>Contains routines for generating unique identifiers for objects
that may be accessible beyond the local system</para>
<indexterm zone="ch-system-e2fsprogs libuuid"><primary sortas="c-libuuid">libuuid</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2> </sect2>
</sect1> </sect1>

135
chapter06/file.xml
View File

@ -1,84 +1,109 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-file" role="wrap"> <sect1 id="ch-system-file" role="wrap">
<title>File-&file-version;</title> <?dbhtml filename="file.html"?>
<?dbhtml filename="file.html"?>
<indexterm zone="ch-system-file"><primary sortas="a-File">File</primary></indexterm> <title>File-&file-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-file">
<para>The File package contains a utility for determining the type of a given <primary sortas="a-File">File</primary>
file or files.</para> </indexterm>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>6.2 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The File package contains a utility for determining the type of a given
<segtitle>&dependencies;</segtitle> file or files.</para>
<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
GCC, Glibc, Grep, Make, Sed, and Zlib</seg></seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation"> <segmentedlist>
<title>Installation of File</title> <segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<para>Prepare File for compilation:</para> <seglistitem>
<seg>0.1 SBU</seg>
<seg>6.2 MB</seg>
</seglistitem>
</segmentedlist>
<screen><userinput>./configure --prefix=/usr</userinput></screen> <segmentedlist>
<segtitle>&dependencies;</segtitle>
<para>Compile the package:</para> <seglistitem>
<seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make,
Sed, and Zlib</seg>
</seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of File</title>
<para>Prepare File for compilation:</para>
<screen><userinput>./configure --prefix=/usr</userinput></screen>
<para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>This package does not come with a test suite.</para> <para>This package does not come with a test suite.</para>
<para>Install the package:</para> <para>Install the package:</para>
<screen><userinput>make install</userinput></screen> <screen><userinput>make install</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-file" role="content"><title>Contents of File</title> <sect2 id="contents-file" role="content">
<title>Contents of File</title>
<segmentedlist> <segmentedlist>
<segtitle>Installed programs</segtitle> <segtitle>Installed programs</segtitle>
<segtitle>Installed library</segtitle> <segtitle>Installed library</segtitle>
<seglistitem><seg>file</seg><seg>libmagic.[a,so]</seg></seglistitem>
</segmentedlist>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <seglistitem>
<?dbfo list-presentation="list"?> <seg>file</seg>
<?dbhtml list-presentation="table"?> <seg>libmagic.[a,so]</seg>
</seglistitem>
</segmentedlist>
<varlistentry id="file"> <variablelist>
<term><command>file</command></term> <bridgehead renderas="sect3">Short Descriptions</bridgehead>
<listitem> <?dbfo list-presentation="list"?>
<para>Tries to classify each given file; it does this by performing <?dbhtml list-presentation="table"?>
several tests&mdash;file system tests, magic number tests, and language
tests</para>
<indexterm zone="ch-system-file file"><primary sortas="b-file">file</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="libmagic"> <varlistentry id="file">
<term><filename class="libraryfile">libmagic</filename></term> <term><command>file</command></term>
<listitem> <listitem>
<para>Contains routines for magic number recognition, used by the <para>Tries to classify each given file; it does this by performing
<command>file</command> program</para> several tests&mdash;file system tests, magic number tests, and language
<indexterm zone="ch-system-file libmagic"><primary sortas="c-libmagic">libmagic</primary></indexterm> tests</para>
</listitem> <indexterm zone="ch-system-file file">
</varlistentry> <primary sortas="b-file">file</primary>
</variablelist> </indexterm>
</listitem>
</varlistentry>
</sect2> <varlistentry id="libmagic">
<term><filename class="libraryfile">libmagic</filename></term>
<listitem>
<para>Contains routines for magic number recognition, used by the
<command>file</command> program</para>
<indexterm zone="ch-system-file libmagic">
<primary sortas="c-libmagic">libmagic</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1> </sect1>

246
chapter06/findutils.xml
View File

@ -1,140 +1,180 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-findutils" role="wrap"> <sect1 id="ch-system-findutils" role="wrap">
<title>Findutils-&findutils-version;</title> <?dbhtml filename="findutils.html"?>
<?dbhtml filename="findutils.html"?>
<indexterm zone="ch-system-findutils"><primary sortas="a-Findutils">Findutils</primary></indexterm> <title>Findutils-&findutils-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-findutils">
<para>The Findutils package contains programs to find files. These programs <primary sortas="a-Findutils">Findutils</primary>
are provided to recursively search through a directory tree and to </indexterm>
create, maintain, and search a database (often faster than the recursive
find, but unreliable if the database has not been recently updated).</para>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>9.4 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The Findutils package contains programs to find files. These programs
<segtitle>&dependencies;</segtitle> are provided to recursively search through a directory tree and to
<seglistitem><seg>Bash, Binutils, Coreutils, create, maintain, and search a database (often faster than the recursive
Diffutils, GCC, Gettext, Glibc, Grep, Make and Sed</seg></seglistitem> find, but unreliable if the database has not been recently updated).</para>
</segmentedlist>
</sect2>
<sect2 role="installation"> <segmentedlist>
<title>Installation of Findutils</title> <segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<para>Prepare Findutils for compilation:</para> <seglistitem>
<seg>0.1 SBU</seg>
<seg>9.4 MB</seg>
</seglistitem>
</segmentedlist>
<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem>
<seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, Grep,
Make and Sed</seg>
</seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of Findutils</title>
<para>Prepare Findutils for compilation:</para>
<screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib/findutils \ <screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib/findutils \
--localstatedir=/var/lib/locate</userinput></screen> --localstatedir=/var/lib/locate</userinput></screen>
<para>The meaning of the configure options:</para> <variablelist>
<title>The meaning of the configure options:</title>
<variablelist> <varlistentry>
<varlistentry> <term><parameter>--localstatedir</parameter></term>
<term><parameter>--localstatedir</parameter></term> <listitem>
<listitem><para>This option changes the location of the <command>locate</command> <para>This option changes the location of the <command>locate</command>
database to be in <filename class="directory">/var/lib/locate</filename>, which database to be in <filename class="directory">/var/lib/locate</filename>,
is FHS-compliant.</para></listitem> which is FHS-compliant.</para>
</varlistentry> </listitem>
</variablelist> </varlistentry>
<para>Compile the package:</para> </variablelist>
<para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>To test the results, issue: <para>To test the results, issue:
<userinput>make check</userinput>.</para> <userinput>make check</userinput>.</para>
<para>Install the package:</para> <para>Install the package:</para>
<screen><userinput>make install</userinput></screen> <screen><userinput>make install</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-findutils" role="content"><title>Contents of Findutils</title> <sect2 id="contents-findutils" role="content">
<title>Contents of Findutils</title>
<segmentedlist> <segmentedlist>
<segtitle>Installed programs</segtitle> <segtitle>Installed programs</segtitle>
<seglistitem><seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg></seglistitem>
</segmentedlist>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <seglistitem>
<?dbfo list-presentation="list"?> <seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg>
<?dbhtml list-presentation="table"?> </seglistitem>
</segmentedlist>
<varlistentry id="bigram"> <variablelist>
<term><command>bigram</command></term> <bridgehead renderas="sect3">Short Descriptions</bridgehead>
<listitem> <?dbfo list-presentation="list"?>
<para>Was formerly used to produce <command>locate</command> databases</para> <?dbhtml list-presentation="table"?>
<indexterm zone="ch-system-findutils bigram"><primary sortas="b-bigram">bigram</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="code"> <varlistentry id="bigram">
<term><command>code</command></term> <term><command>bigram</command></term>
<listitem> <listitem>
<para>Was formerly used to produce <command>locate</command> <para>Was formerly used to produce <command>locate</command>
databases; it is the ancestor of <command>frcode</command>.</para> databases</para>
<indexterm zone="ch-system-findutils code"><primary sortas="b-code">code</primary></indexterm> <indexterm zone="ch-system-findutils bigram">
</listitem> <primary sortas="b-bigram">bigram</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="find"> <varlistentry id="code">
<term><command>find</command></term> <term><command>code</command></term>
<listitem> <listitem>
<para>Searches given directory trees for files matching the specified criteria</para> <para>Was formerly used to produce <command>locate</command>
<indexterm zone="ch-system-findutils find"><primary sortas="b-find">find</primary></indexterm> databases; it is the ancestor of <command>frcode</command>.</para>
</listitem> <indexterm zone="ch-system-findutils code">
</varlistentry> <primary sortas="b-code">code</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="frcode"> <varlistentry id="find">
<term><command>frcode</command></term> <term><command>find</command></term>
<listitem> <listitem>
<para>Is called by <command>updatedb</command> to compress the list of file names; it uses <para>Searches given directory trees for files matching the specified
front-compression, reducing the database size by a factor of four to criteria</para>
five.</para> <indexterm zone="ch-system-findutils find">
<indexterm zone="ch-system-findutils frcode"><primary sortas="b-frcode">frcode</primary></indexterm> <primary sortas="b-find">find</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="locate"> <varlistentry id="frcode">
<term><command>locate</command></term> <term><command>frcode</command></term>
<listitem> <listitem>
<para>Searches through a database of file names and reports the names <para>Is called by <command>updatedb</command> to compress the list
that contain a given string or match a given pattern</para> of file names; it uses front-compression, reducing the database size
<indexterm zone="ch-system-findutils locate"><primary sortas="b-locate">locate</primary></indexterm> by a factor of four to five.</para>
</listitem> <indexterm zone="ch-system-findutils frcode">
</varlistentry> <primary sortas="b-frcode">frcode</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="updatedb"> <varlistentry id="locate">
<term><command>updatedb</command></term> <term><command>locate</command></term>
<listitem> <listitem>
<para>Updates the <command>locate</command> database; it scans <para>Searches through a database of file names and reports the names
the entire file system (including other file systems that are currently mounted, that contain a given string or match a given pattern</para>
unless told not to) and puts every file name it finds into the database</para> <indexterm zone="ch-system-findutils locate">
<indexterm zone="ch-system-findutils updatedb"><primary sortas="b-updatedb">updatedb</primary></indexterm> <primary sortas="b-locate">locate</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="xargs"> <varlistentry id="updatedb">
<term><command>xargs</command></term> <term><command>updatedb</command></term>
<listitem> <listitem>
<para>Can be used to apply a given command to a list of files</para> <para>Updates the <command>locate</command> database; it scans the
<indexterm zone="ch-system-findutils xargs"><primary sortas="b-xargs">xargs</primary></indexterm> entire file system (including other file systems that are currently
</listitem> mounted, unless told not to) and puts every file name it finds into
</varlistentry> the database</para>
</variablelist> <indexterm zone="ch-system-findutils updatedb">
<primary sortas="b-updatedb">updatedb</primary>
</indexterm>
</listitem>
</varlistentry>
</sect2> <varlistentry id="xargs">
<term><command>xargs</command></term>
<listitem>
<para>Can be used to apply a given command to a list of files</para>
<indexterm zone="ch-system-findutils xargs">
<primary sortas="b-xargs">xargs</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1> </sect1>

180
chapter06/flex.xml
View File

@ -1,71 +1,88 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../general.ent"> <!ENTITY % general-entities SYSTEM "../general.ent">
%general-entities; %general-entities;
]> ]>
<sect1 id="ch-system-flex" role="wrap"> <sect1 id="ch-system-flex" role="wrap">
<title>Flex-&flex-version;</title> <?dbhtml filename="flex.html"?>
<?dbhtml filename="flex.html"?>
<indexterm zone="ch-system-flex"><primary sortas="a-Flex">Flex</primary></indexterm> <title>Flex-&flex-version;</title>
<sect2 role="package"><title/> <indexterm zone="ch-system-flex">
<para>The Flex package contains a utility for generating programs that <primary sortas="a-Flex">Flex</primary>
recognize patterns in text.</para> </indexterm>
<segmentedlist> <sect2 role="package">
<segtitle>&buildtime;</segtitle> <title/>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>22.5 MB</seg></seglistitem>
</segmentedlist>
<segmentedlist> <para>The Flex package contains a utility for generating programs that
<segtitle>&dependencies;</segtitle> recognize patterns in text.</para>
<seglistitem><seg>Bash, Binutils, Bison, Coreutils, Diffutils,
GCC, Gettext, Glibc, Grep, M4, Make, and Sed</seg></seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation"> <segmentedlist>
<title>Installation of Flex</title> <segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<para>Flex contains several known bugs. Fix these with the following patch:</para> <seglistitem>
<seg>0.1 SBU</seg>
<seg>22.5 MB</seg>
</seglistitem>
</segmentedlist>
<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem>
<seg>Bash, Binutils, Bison, Coreutils, Diffutils, GCC, Gettext,
Glibc, Grep, M4, Make, and Sed</seg>
</seglistitem>
</segmentedlist>
</sect2>
<sect2 role="installation">
<title>Installation of Flex</title>
<para>Flex contains several known bugs. Fix these with the following
patch:</para>
<screen><userinput>patch -Np1 -i ../&flex-fixes-patch;</userinput></screen> <screen><userinput>patch -Np1 -i ../&flex-fixes-patch;</userinput></screen>
<para>The GNU autotools detects that the Flex source code has been <para>The GNU autotools detects that the Flex source code has been
modified by the previous patch and tries to update the man page modified by the previous patch and tries to update the man page
accordingly. This does not work correctly on many systems, and the accordingly. This does not work correctly on many systems, and the
default page is fine, so make sure it does not get regenerated:</para> default page is fine, so make sure it does not get regenerated:</para>
<screen><userinput>touch doc/flex.1</userinput></screen> <screen><userinput>touch doc/flex.1</userinput></screen>
<para>Prepare Flex for compilation:</para> <para>Prepare Flex for compilation:</para>
<screen><userinput>./configure --prefix=/usr</userinput></screen> <screen><userinput>./configure --prefix=/usr</userinput></screen>
<para>Compile the package:</para> <para>Compile the package:</para>
<screen><userinput>make</userinput></screen> <screen><userinput>make</userinput></screen>
<para>To test the results, issue: <para>To test the results, issue:
<userinput>make check</userinput>.</para> <userinput>make check</userinput>.</para>
<para>Install the package:</para> <para>Install the package:</para>
<screen><userinput>make install</userinput></screen> <screen><userinput>make install</userinput></screen>
<para>There are some packages that expect to find the <para>There are some packages that expect to find the
<filename class="libraryfile">lex</filename> library in <filename <filename class="libraryfile">lex</filename> library in <filename
class="directory">/usr/lib</filename>. Create a symlink to account for class="directory">/usr/lib</filename>. Create a symlink to account for
this:</para> this:</para>
<screen><userinput>ln -sv libfl.a /usr/lib/libl.a</userinput></screen> <screen><userinput>ln -sv libfl.a /usr/lib/libl.a</userinput></screen>
<para>A few programs do not know about <command>flex</command> yet and <para>A few programs do not know about <command>flex</command> yet and
try to run its predecessor, <command>lex</command>. To support those try to run its predecessor, <command>lex</command>. To support those
programs, create a wrapper script named <filename>lex</filename> that programs, create a wrapper script named <filename>lex</filename> that
calls <filename>flex</filename> in <command>lex</command> emulation mode:</para> calls <filename>flex</filename> in <command>lex</command> emulation
mode:</para>
<screen><userinput>cat &gt; /usr/bin/lex &lt;&lt; "EOF" <screen><userinput>cat &gt; /usr/bin/lex &lt;&lt; "EOF"
<literal>#!/bin/sh <literal>#!/bin/sh
@ -77,52 +94,61 @@ exec /usr/bin/flex -l "$@"
EOF EOF
chmod -v 755 /usr/bin/lex</userinput></screen> chmod -v 755 /usr/bin/lex</userinput></screen>
</sect2> </sect2>
<sect2 id="contents-flex" role="content">
<title>Contents of Flex</title>
<sect2 id="contents-flex" role="content"><title>Contents of Flex</title> <segmentedlist>
<segtitle>Installed programs</segtitle>
<segtitle>Installed library</segtitle>
<segmentedlist> <seglistitem>
<segtitle>Installed programs</segtitle> <seg>flex and lex</seg>
<segtitle>Installed library</segtitle> <seg>libfl.a</seg>
<seglistitem><seg>flex and lex</seg> </seglistitem>
<seg>libfl.a</seg></seglistitem> </segmentedlist>
</segmentedlist>
<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <variablelist>
<?dbfo list-presentation="list"?> <bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbhtml list-presentation="table"?> <?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="flex"> <varlistentry id="flex">
<term><command>flex</command></term> <term><command>flex</command></term>
<listitem> <listitem>
<para>A tool for generating programs that recognize patterns in text; <para>A tool for generating programs that recognize patterns in text;
it allows for the versatility to specify the rules for it allows for the versatility to specify the rules for pattern-finding,
pattern-finding, eradicating the need to develop a specialized eradicating the need to develop a specialized program</para>
program</para> <indexterm zone="ch-system-flex flex">
<indexterm zone="ch-system-flex flex"><primary sortas="b-flex">flex</primary></indexterm> <primary sortas="b-flex">flex</primary>
</listitem> </indexterm>
</varlistentry> </listitem>
</varlistentry>
<varlistentry id="lex"> <varlistentry id="lex">
<term><command>lex</command></term> <term><command>lex</command></term>
<listitem> <listitem>
<para>A script that runs <command>flex</command> in <command>lex</command> <para>A script that runs <command>flex</command> in
emulation mode</para> <command>lex</command> emulation mode</para>
<indexterm zone="ch-system-flex lex"><primary sortas="b-lex">lex</primary></indexterm> <indexterm zone="ch-system-flex lex">
</listitem> <primary sortas="b-lex">lex</primary>
</varlistentry> </indexterm>
</listitem>
</varlistentry>
<varlistentry id="libfl.a"> <varlistentry id="libfl.a">
<term><filename class="libraryfile">libfl.a</filename></term> <term><filename class="libraryfile">libfl.a</filename></term>
<listitem> <listitem>
<para>The <filename class="libraryfile">flex</filename> library</para> <para>The <filename class="libraryfile">flex</filename> library</para>
<indexterm zone="ch-system-flex libfl.a"><primary sortas="c-libfl.a">libfl.a</primary></indexterm> <indexterm zone="ch-system-flex libfl.a">
</listitem> <primary sortas="c-libfl.a">libfl.a</primary>
</varlistentry> </indexterm>
</variablelist> </listitem>
</varlistentry>
</sect2> </variablelist>
</sect2>
</sect1> </sect1>