diff options
| -rw-r--r-- | chapter06/db.xml | 424 | ||||
| -rw-r--r-- | chapter06/devices.xml | 91 | ||||
| -rw-r--r-- | chapter06/diffutils.xml | 182 | ||||
| -rw-r--r-- | chapter06/e2fsprogs.xml | 787 | ||||
| -rw-r--r-- | chapter06/file.xml | 143 | ||||
| -rw-r--r-- | chapter06/findutils.xml | 268 | ||||
| -rw-r--r-- | chapter06/flex.xml | 196 |
7 files changed, 1184 insertions, 907 deletions
diff --git a/chapter06/db.xml b/chapter06/db.xml index b133a254d..5bd81d27b 100644 --- a/chapter06/db.xml +++ b/chapter06/db.xml @@ -1,218 +1,278 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-db" role="wrap"> -<title>Berkeley DB-&db-version;</title> -<?dbhtml filename="db.html"?> + <?dbhtml filename="db.html"?> + + <title>Berkeley DB-&db-version;</title> + + <indexterm zone="ch-system-db"> + <primary sortas="a-Berkeley-DB">Berkeley DB</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-db"><primary sortas="a-Berkeley-DB">Berkeley DB</primary></indexterm> + <para>The Berkeley DB package contains programs and utilities used by many + other applications for database related functions.</para> -<sect2 role="package"><title/> -<para>The Berkeley DB package contains programs and utilities used by many other -applications for database related functions.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>1.2 SBU</seg><seg>78 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>1.2 SBU</seg> + <seg>78 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, -Diffutils, GCC, Glibc, Make and Sed.</seg></seglistitem> -</segmentedlist> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<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> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Make and Sed.</seg> + </seglistitem> + </segmentedlist> -</sect2> + <tip> + <title>Extra functionality for Berkeley DB in BLFS</title> -<sect2 role="installation"> -<title>Installation of Berkeley DB</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> -<para>Prepare Berkeley DB for compilation:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Berkeley DB</title> + + <para>Prepare Berkeley DB for compilation:</para> <screen><userinput>cd build_unix && ../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> -<term><parameter>--enable-compat185</parameter></term> -<listitem><para>This option enables building Berkeley DB 1.85 compatibility API.</para></listitem> -</varlistentry> + <varlistentry> + <term><parameter>--enable-compat185</parameter></term> + <listitem> + <para>This option enables building Berkeley DB 1.85 compatibility + API.</para> + </listitem> + </varlistentry> -<varlistentry> -<term><parameter>--enable-cxx</parameter></term> -<listitem><para>This option enables building C++ API libraries.</para></listitem> -</varlistentry> -</variablelist> + <varlistentry> + <term><parameter>--enable-cxx</parameter></term> + <listitem> + <para>This option enables building C++ API libraries.</para> + </listitem> + </varlistentry> -<para>Compile the package:</para> + </variablelist> + + <para>Compile the package:</para> <screen><userinput>make</userinput></screen> -<para>It is not possible to test the package meaningfully, because that -would involve building TCL bindings. TCL bindings cannot be built properly -now because TCL is linked against Glibc in <filename class="directory">/tools</filename>, -not against Glibc in <filename class="directory">/usr</filename>.</para> + <para>It is not possible to test the package meaningfully, because + that would involve building TCL bindings. TCL bindings cannot be + built properly now because TCL is linked against Glibc in + <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> -<para>The meaning of the make option:</para> + <variablelist> + <title>The meaning of the make parameter:</title> + + <varlistentry> + <term><parameter>docdir=...</parameter></term> + <listitem> + <para>This variable specifies the correct place for the + documentation.</para> + </listitem> + </varlistentry> -<variablelist> -<varlistentry> -<term><parameter>docdir=...</parameter></term> -<listitem><para>This variable specifies the correct place for the documentation.</para></listitem> -</varlistentry> -</variablelist> + </variablelist> -<para>Fix the ownerships of the installed files:</para> + <para>Fix the ownerships of the installed files:</para> <screen><userinput>chown root:root /usr/bin/db_* \ /usr/lib/libdb* /usr/include/db* && chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen> -</sect2> - - -<sect2 id="contents-db" role="content"><title>Contents of Berkeley DB</title> -<segmentedlist> -<segtitle>Installed programs</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></seglistitem> -</segmentedlist> - -<segmentedlist> -<segtitle>Installed libraries</segtitle> -<seglistitem><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> - - -<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> + </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> + + + <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> diff --git a/chapter06/devices.xml b/chapter06/devices.xml index da4af0a17..51821fe84 100644 --- a/chapter06/devices.xml +++ b/chapter06/devices.xml @@ -1,48 +1,55 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-devices"> -<title>Populating /dev</title> -<?dbhtml filename="devices.html"?> + <?dbhtml filename="devices.html"?> + + <title>Populating /dev</title> -<indexterm zone="ch-system-devices"><primary sortas="e-/dev/">/dev/*</primary></indexterm> + <indexterm zone="ch-system-devices"> + <primary sortas="e-/dev/">/dev/*</primary> + </indexterm> -<sect2> -<title>Creating Initial Device Nodes</title> + <sect2> + <title>Creating Initial Device Nodes</title> -<para>When the kernel boots the system, it requires the presence of a few device -nodes, in particular the <filename class="devicefile">console</filename> and -<filename class="devicefile">null</filename> devices. The device nodes will -be created on the hard disk so that they are available before -<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> + <para>When the kernel boots the system, it requires the presence of a few + device nodes, in particular the <filename class="devicefile">console</filename> + and <filename class="devicefile">null</filename> devices. The device nodes + will be created on the hard disk so that they are available before + <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 mknod -m 666 /dev/null c 1 3</userinput></screen> -</sect2> -<sect2> -<title>Mounting tmpfs and Populating /dev</title> + </sect2> + + <sect2> + <title>Mounting tmpfs and Populating /dev</title> -<para>The recommended method of populating the <filename -class="directory">/dev</filename> directory with devices is to mount a virtual -filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>) on the -<filename class="directory">/dev</filename> directory, and allow the 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> + <para>The recommended method of populating the <filename + class="directory">/dev</filename> directory with devices is to mount a + virtual filesystem (such as <systemitem class="filesystem">tmpfs</systemitem>) + on the <filename class="directory">/dev</filename> directory, and allow the + 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> -<para>The Udev package is what actually creates the devices in the <filename -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 -needed to complete the building of this system:</para> + <para>The Udev package is what actually creates the devices in the <filename + 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 + needed to complete the building of this system:</para> <screen><userinput>mknod -m 622 /dev/console c 5 1 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 chown -v root:tty /dev/{console,ptmx,tty}</userinput></screen> -<para>There are some symlinks and directories required by LFS that are created -during system startup by the LFS-Bootscripts package. Since this is a chroot -environment and not a booted environment, those symlinks and directories need to -be created here:</para> + <para>There are some symlinks and directories required by LFS that are + created during system startup by the LFS-Bootscripts package. Since this + is a chroot environment and not a booted environment, those symlinks and + directories need to be created here:</para> <screen><userinput>ln -sv /proc/self/fd /dev/fd 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/shm</userinput></screen> -<para>Finally, mount the proper virtual (kernel) file systems on the -newly-created directories:</para> + <para>Finally, mount the proper virtual (kernel) file systems on the + newly-created directories:</para> <screen><userinput>mount -vt devpts -o gid=4,mode=620 none /dev/pts mount -vt tmpfs none /dev/shm</userinput></screen> -<para>The <command>mount</command> commands executed above may result -in the following warning message:</para> + <para>The <command>mount</command> commands executed above may result + in the following warning message:</para> <screen><computeroutput>can't open /etc/fstab: No such file or directory.</computeroutput></screen> -<para>This file—<filename>/etc/fstab</filename>—has not -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> -</sect2> + <para>This file—<filename>/etc/fstab</filename>—has not + 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> -</sect1> + </sect2> +</sect1> diff --git a/chapter06/diffutils.xml b/chapter06/diffutils.xml index 5234bd6c7..167709fa3 100644 --- a/chapter06/diffutils.xml +++ b/chapter06/diffutils.xml @@ -1,102 +1,132 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-diffutils" role="wrap"> -<title>Diffutils-&diffutils-version;</title> -<?dbhtml filename="diffutils.html"?> + <?dbhtml filename="diffutils.html"?> + + <title>Diffutils-&diffutils-version;</title> + + <indexterm zone="ch-system-diffutils"> + <primary sortas="a-Diffutils">Diffutils</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-diffutils"><primary sortas="a-Diffutils">Diffutils</primary></indexterm> + <para>The Diffutils package contains programs that show the differences + between files or directories.</para> -<sect2 role="package"><title/> -<para>The Diffutils package contains programs that show the differences -between files or directories.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>5.6 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.1 SBU</seg> + <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> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Diffutils</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, + Grep, Make, and Sed</seg> + </seglistitem> + </segmentedlist> -<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> + </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> -<para>Prepare Diffutils for compilation:</para> + <para>Prepare Diffutils for compilation:</para> <screen><userinput>./configure --prefix=/usr</userinput></screen> -<para>Compile the package:</para> + <para>Compile the package:</para> <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> -</sect2> - - -<sect2 id="contents-diffutils" role="content"><title>Contents of Diffutils</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>cmp, diff, diff3, and sdiff</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="cmp"> -<term><command>cmp</command></term> -<listitem> -<para>Compares two files and reports whether or in which bytes they differ</para> -<indexterm zone="ch-system-diffutils cmp"><primary sortas="b-cmp">cmp</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="diff"> -<term><command>diff</command></term> -<listitem> -<para>Compares two files or directories and reports which lines in the files differ</para> -<indexterm zone="ch-system-diffutils diff"><primary sortas="b-diff">diff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="diff3"> -<term><command>diff3</command></term> -<listitem> -<para>Compares three files line by line</para> -<indexterm zone="ch-system-diffutils diff3"><primary sortas="b-diff3">diff3</primary></indexterm> -</listitem> -</varlistentry> - -<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> + </sect2> + + + <sect2 id="contents-diffutils" role="content"> + <title>Contents of Diffutils</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>cmp, diff, diff3, and sdiff</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="cmp"> + <term><command>cmp</command></term> + <listitem> + <para>Compares two files and reports whether or in which bytes they + differ</para> + <indexterm zone="ch-system-diffutils cmp"> + <primary sortas="b-cmp">cmp</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="diff"> + <term><command>diff</command></term> + <listitem> + <para>Compares two files or directories and reports which lines in + the files differ</para> + <indexterm zone="ch-system-diffutils diff"> + <primary sortas="b-diff">diff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="diff3"> + <term><command>diff3</command></term> + <listitem> + <para>Compares three files line by line</para> + <indexterm zone="ch-system-diffutils diff3"> + <primary sortas="b-diff3">diff3</primary> + </indexterm> + </listitem> + </varlistentry> + + <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> - diff --git a/chapter06/e2fsprogs.xml b/chapter06/e2fsprogs.xml index 9995b2ed4..60c1cc5a6 100644 --- a/chapter06/e2fsprogs.xml +++ b/chapter06/e2fsprogs.xml @@ -1,380 +1,469 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-e2fsprogs" role="wrap"> -<title>E2fsprogs-&e2fsprogs-version;</title> -<?dbhtml filename="e2fsprogs.html"?> + <?dbhtml filename="e2fsprogs.html"?> + + <title>E2fsprogs-&e2fsprogs-version;</title> + + <indexterm zone="ch-system-e2fsprogs"> + <primary sortas="a-E2fsprogs">E2fsprogs</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-e2fsprogs"><primary sortas="a-E2fsprogs">E2fsprogs</primary></indexterm> + <para>The E2fsprogs package contains the utilities for handling the + <systemitem class="filesystem">ext2</systemitem> file system. It also + supports the <systemitem class="filesystem">ext3</systemitem> journaling + file system.</para> -<sect2 role="package"><title/> -<para>The E2fsprogs package contains the utilities for handling the -<systemitem class="filesystem">ext2</systemitem> file system. It also supports -the <systemitem class="filesystem">ext3</systemitem> journaling file system.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.6 SBU</seg><seg>40.0 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <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> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of E2fsprogs</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Gettext, Glibc, + Grep, Make, Sed, and Texinfo</seg> + </seglistitem> + </segmentedlist> -<para>It is recommended that E2fsprogs be built in a subdirectory of the source tree: -</para> + </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 cd build</userinput></screen> -<para>Prepare E2fsprogs for compilation:</para> + <para>Prepare E2fsprogs for compilation:</para> <screen><userinput>../configure --prefix=/usr --with-root-prefix="" \ --enable-elf-shlibs --disable-evms</userinput></screen> -<para>The meaning of the configure options:</para> - -<variablelist> -<varlistentry> -<term><parameter>--with-root-prefix=""</parameter></term> -<listitem><para>Certain programs (such as the <command>e2fsck</command> program) -are considered essential programs. When, for example, <filename -class="directory">/usr</filename> is not mounted, these programs still need -to be available. They belong in directories like <filename -class="directory">/lib</filename> and <filename -class="directory">/sbin</filename>. If this option is not passed to E2fsprogs' -configure, the programs are installed into the <filename -class="directory">/usr</filename> directory.</para></listitem> - -</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> -<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> + <variablelist> + <title>The meaning of the configure options:</title> + + <varlistentry> + <term><parameter>--with-root-prefix=""</parameter></term> + <listitem> + <para>Certain programs (such as the <command>e2fsck</command> + program) are considered essential programs. When, for example, + <filename class="directory">/usr</filename> is not mounted, these + programs still need to be available. They belong in directories + like <filename class="directory">/lib</filename> and <filename + class="directory">/sbin</filename>. If this option is not passed + to E2fsprogs' configure, the programs are installed into the + <filename class="directory">/usr</filename> directory.</para> + </listitem> + </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> + <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> <screen><userinput>make</userinput></screen> -<para>To test the results, issue: -<userinput>make check</userinput>.</para> + <para>To test the results, issue: + <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> -<para>Install the shared libraries:</para> + <para>Install the shared libraries:</para> <screen><userinput>make install-libs</userinput></screen> -</sect2> - - - -<sect2 id="contents-e2fsprogs" role="content"><title>Contents of E2fsprogs</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<segtitle>Installed libraries</segtitle> -<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> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="badblocks"> -<term><command>badblocks</command></term> -<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="blkid"> -<term><command>blkid</command></term> -<listitem> -<para>A command line utility to locate and print block device attributes</para> -<indexterm zone="ch-system-e2fsprogs blkid"><primary sortas="b-blkid">blkid</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="chattr"> -<term><command>chattr</command></term> -<listitem> -<para>Changes the attributes of files on an <systemitem -class="filesystem">ext2</systemitem> file system; it also changes <systemitem -class="filesystem">ext3</systemitem> 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="compile_et"> -<term><command>compile_et</command></term> -<listitem> -<para>An error table compiler; it converts a table of error-code names and -messages into a C source file suitable for use with the <filename -class="libraryfile">com_err</filename> library</para> -<indexterm zone="ch-system-e2fsprogs compile_et"><primary sortas="b-compile_et">compile_et</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="debugfs"> -<term><command>debugfs</command></term> -<listitem> -<para>A file system debugger; it can be used to examine and change the -state of an <systemitem class="filesystem">ext2</systemitem> file system</para> -<indexterm zone="ch-system-e2fsprogs debugfs"><primary sortas="b-debugfs">debugfs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="dumpe2fs"> -<term><command>dumpe2fs</command></term> -<listitem> -<para>Prints the super block and blocks group information for the file -system present on a given device</para> -<indexterm zone="ch-system-e2fsprogs dumpe2fs"><primary sortas="b-dumpe2fs">dumpe2fs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="e2fsck"> -<term><command>e2fsck</command></term> -<listitem> -<para>Is used to check, and optionally repair <systemitem -class="filesystem">ext2</systemitem> file systems and <systemitem -class="filesystem">ext3</systemitem> file systems</para> -<indexterm zone="ch-system-e2fsprogs e2fsck"><primary sortas="b-e2fsck">e2fsck</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="e2image"> -<term><command>e2image</command></term> -<listitem> -<para>Is used to save critical <systemitem class="filesystem">ext2</systemitem> -file system data to a file</para> -<indexterm zone="ch-system-e2fsprogs e2image"><primary sortas="b-e2image">e2image</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="e2label"> -<term><command>e2label</command></term> -<listitem> -<para>Displays or changes the file system label on the <systemitem -class="filesystem">ext2</systemitem> file system present on a given device</para> -<indexterm zone="ch-system-e2fsprogs e2label"><primary sortas="b-e2label">e2label</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="findfs"> -<term><command>findfs</command></term> -<listitem> -<para>Finds a file system by label or Universally Unique Identifier (UUID)</para> -<indexterm zone="ch-system-e2fsprogs findfs"><primary sortas="b-findfs">findfs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="fsck"> -<term><command>fsck</command></term> -<listitem> -<para>Is used to check, and optionally repair, file systems</para> -<indexterm zone="ch-system-e2fsprogs fsck"><primary sortas="b-fsck">fsck</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="fsck.ext2"> -<term><command>fsck.ext2</command></term> -<listitem> -<para>By default checks <systemitem class="filesystem">ext2</systemitem> -file systems</para> -<indexterm zone="ch-system-e2fsprogs fsck.ext2"><primary -sortas="b-fsck.ext2">fsck.ext2</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="fsck.ext3"> -<term><command>fsck.ext3</command></term> -<listitem> -<para>By default checks <systemitem class="filesystem">ext3</systemitem> -file systems</para> -<indexterm zone="ch-system-e2fsprogs fsck.ext3"><primary -sortas="b-fsck.ext3">fsck.ext3</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="logsave"> -<term><command>logsave</command></term> -<listitem> -<para>Saves the output of a command in a log file</para> -<indexterm zone="ch-system-e2fsprogs logsave"><primary sortas="b-logsave">logsave</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="lsattr"> -<term><command>lsattr</command></term> -<listitem> -<para>Lists the attributes of files on a second extended file system</para> -<indexterm zone="ch-system-e2fsprogs lsattr"><primary sortas="b-lsattr">lsattr</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mk_cmds"> -<term><command>mk_cmds</command></term> -<listitem> -<para>Converts a table of command names and help messages into a C -source file suitable for use with the <filename -class="libraryfile">libss</filename> subsystem library</para> -<indexterm zone="ch-system-e2fsprogs mk_cmds"><primary sortas="b-mk_cmds">mk_cmds</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mke2fs"> -<term><command>mke2fs</command></term> -<listitem> -<para>Creates an ext2 or ext3 file system on the given device</para> -<indexterm zone="ch-system-e2fsprogs mke2fs"><primary sortas="b-mke2fs">mke2fs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mkfs.ext2"> -<term><command>mkfs.ext2</command></term> -<listitem> -<para>By default creates <systemitem class="filesystem">ext2</systemitem> -file systems</para> -<indexterm zone="ch-system-e2fsprogs mkfs.ext2"><primary -sortas="b-mkfs.ext2">mkfs.ext2</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mkfs.ext3"> -<term><command>mkfs.ext3</command></term> -<listitem> -<para>By default creates <systemitem class="filesystem">ext3</systemitem> -file systems</para> -<indexterm zone="ch-system-e2fsprogs mkfs.ext3"><primary -sortas="b-mkfs.ext3">mkfs.ext3</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mklost-found"> -<term><command>mklost+found</command></term> -<listitem> -<para>Used to create a <filename class="directory">lost+found</filename> -directory on an <systemitem class="filesystem">ext2</systemitem> file system; -it pre-allocates disk blocks to this directory to lighten the task of -<command>e2fsck</command></para> -<indexterm zone="ch-system-e2fsprogs mklost-found"><primary sortas="b-mklost+found">mklost+found</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="resize2fs"> -<term><command>resize2fs</command></term> -<listitem> -<para>Can be used to enlarge or shrink an <systemitem -class="filesystem">ext2</systemitem> file system</para> -<indexterm zone="ch-system-e2fsprogs resize2fs"><primary sortas="b-resize2fs">resize2fs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="tune2fs"> -<term><command>tune2fs</command></term> -<listitem> -<para>Adjusts tunable file system parameters on an <systemitem -class="filesystem">ext2</systemitem> file system</para> -<indexterm zone="ch-system-e2fsprogs tune2fs"><primary sortas="b-tune2fs">tune2fs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="uuidgen"> -<term><command>uuidgen</command></term> -<listitem> -<para>Creates new UUIDs. Each new UUID can reasonably be considered unique -among all UUIDs created, on the local system and on other systems, in the -past and in the future</para> -<indexterm zone="ch-system-e2fsprogs uuidgen"><primary sortas="b-uuidgen">uuidgen</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libblkid"> -<term><filename class="libraryfile">libblkid</filename></term> -<listitem> -<para>Contains routines for device identification and token extraction</para> -<indexterm zone="ch-system-e2fsprogs libblkid"><primary sortas="c-libblkid">libblkid</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libcom_err"> -<term><filename class="libraryfile">libcom_err</filename></term> -<listitem> -<para>The common error display routine</para> -<indexterm zone="ch-system-e2fsprogs libcom_err"><primary sortas="c-libcom_err">libcom_err</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libe2p"> -<term><filename class="libraryfile">libe2p</filename></term> -<listitem> -<para>Used by <command>dumpe2fs</command>, <command>chattr</command>, -and <command>lsattr</command></para> -<indexterm zone="ch-system-e2fsprogs libe2p"><primary sortas="c-libe2p">libe2p</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libext2fs"> -<term><filename class="libraryfile">libext2fs</filename></term> -<listitem> -<para>Contains routines to enable user-level programs to manipulate an -<systemitem class="filesystem">ext2</systemitem> file system</para> -<indexterm zone="ch-system-e2fsprogs libext2fs"><primary sortas="c-libext2fs">libext2fs</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libss"> -<term><filename class="libraryfile">libss</filename></term> -<listitem> -<para>Used by <command>debugfs</command></para> -<indexterm zone="ch-system-e2fsprogs libss"><primary sortas="c-libss">libss</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libuuid"> -<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> + + <sect2 id="contents-e2fsprogs" role="content"> + <title>Contents of E2fsprogs</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + <segtitle>Installed libraries</segtitle> + + <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> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="badblocks"> + <term><command>badblocks</command></term> + <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="blkid"> + <term><command>blkid</command></term> + <listitem> + <para>A command line utility to locate and print block device + attributes</para> + <indexterm zone="ch-system-e2fsprogs blkid"> + <primary sortas="b-blkid">blkid</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="chattr"> + <term><command>chattr</command></term> + <listitem> + <para>Changes the attributes of files on an <systemitem + class="filesystem">ext2</systemitem> file system; it also + changes <systemitem class="filesystem">ext3</systemitem> + 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="compile_et"> + <term><command>compile_et</command></term> + <listitem> + <para>An error table compiler; it converts a table of error-code + names and messages into a C source file suitable for use with the + <filename class="libraryfile">com_err</filename> library</para> + <indexterm zone="ch-system-e2fsprogs compile_et"> + <primary sortas="b-compile_et">compile_et</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="debugfs"> + <term><command>debugfs</command></term> + <listitem> + <para>A file system debugger; it can be used to examine and change + the state of an <systemitem class="filesystem">ext2</systemitem> + file system</para> + <indexterm zone="ch-system-e2fsprogs debugfs"> + <primary sortas="b-debugfs">debugfs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="dumpe2fs"> + <term><command>dumpe2fs</command></term> + <listitem> + <para>Prints the super block and blocks group information for the + file system present on a given device</para> + <indexterm zone="ch-system-e2fsprogs dumpe2fs"> + <primary sortas="b-dumpe2fs">dumpe2fs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="e2fsck"> + <term><command>e2fsck</command></term> + <listitem> + <para>Is used to check, and optionally repair <systemitem + class="filesystem">ext2</systemitem> file systems and <systemitem + class="filesystem">ext3</systemitem> file systems</para> + <indexterm zone="ch-system-e2fsprogs e2fsck"> + <primary sortas="b-e2fsck">e2fsck</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="e2image"> + <term><command>e2image</command></term> + <listitem> + <para>Is used to save critical <systemitem + class="filesystem">ext2</systemitem> file system data to a file</para> + <indexterm zone="ch-system-e2fsprogs e2image"> + <primary sortas="b-e2image">e2image</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="e2label"> + <term><command>e2label</command></term> + <listitem> + <para>Displays or changes the file system label on the <systemitem + class="filesystem">ext2</systemitem> file system present on a given + device</para> + <indexterm zone="ch-system-e2fsprogs e2label"> + <primary sortas="b-e2label">e2label</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="findfs"> + <term><command>findfs</command></term> + <listitem> + <para>Finds a file system by label or Universally Unique Identifier + (UUID)</para> + <indexterm zone="ch-system-e2fsprogs findfs"> + <primary sortas="b-findfs">findfs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="fsck"> + <term><command>fsck</command></term> + <listitem> + <para>Is used to check, and optionally repair, file systems</para> + <indexterm zone="ch-system-e2fsprogs fsck"> + <primary sortas="b-fsck">fsck</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="fsck.ext2"> + <term><command>fsck.ext2</command></term> + <listitem> + <para>By default checks <systemitem class="filesystem">ext2</systemitem> + file systems</para> + <indexterm zone="ch-system-e2fsprogs fsck.ext2"> + <primary sortas="b-fsck.ext2">fsck.ext2</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="fsck.ext3"> + <term><command>fsck.ext3</command></term> + <listitem> + <para>By default checks <systemitem class="filesystem">ext3</systemitem> + file systems</para> + <indexterm zone="ch-system-e2fsprogs fsck.ext3"> + <primary sortas="b-fsck.ext3">fsck.ext3</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="logsave"> + <term><command>logsave</command></term> + <listitem> + <para>Saves the output of a command in a log file</para> + <indexterm zone="ch-system-e2fsprogs logsave"> + <primary sortas="b-logsave">logsave</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lsattr"> + <term><command>lsattr</command></term> + <listitem> + <para>Lists the attributes of files on a second extended file + system</para> + <indexterm zone="ch-system-e2fsprogs lsattr"> + <primary sortas="b-lsattr">lsattr</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mk_cmds"> + <term><command>mk_cmds</command></term> + <listitem> + <para>Converts a table of command names and help messages into a C + source file suitable for use with the <filename + class="libraryfile">libss</filename> subsystem library</para> + <indexterm zone="ch-system-e2fsprogs mk_cmds"> + <primary sortas="b-mk_cmds">mk_cmds</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mke2fs"> + <term><command>mke2fs</command></term> + <listitem> + <para>Creates an <systemitem class="filesystem">ext2</systemitem> + or <systemitem class="filesystem">ext3</systemitem> file system on + the given device</para> + <indexterm zone="ch-system-e2fsprogs mke2fs"> + <primary sortas="b-mke2fs">mke2fs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mkfs.ext2"> + <term><command>mkfs.ext2</command></term> + <listitem> + <para>By default creates <systemitem class="filesystem">ext2</systemitem> + file systems</para> + <indexterm zone="ch-system-e2fsprogs mkfs.ext2"> + <primary sortas="b-mkfs.ext2">mkfs.ext2</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mkfs.ext3"> + <term><command>mkfs.ext3</command></term> + <listitem> + <para>By default creates <systemitem class="filesystem">ext3</systemitem> + file systems</para> + <indexterm zone="ch-system-e2fsprogs mkfs.ext3"> + <primary sortas="b-mkfs.ext3">mkfs.ext3</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mklost-found"> + <term><command>mklost+found</command></term> + <listitem> + <para>Used to create a <filename class="directory">lost+found</filename> + directory on an <systemitem class="filesystem">ext2</systemitem> file + system; it pre-allocates disk blocks to this directory to lighten the + task of <command>e2fsck</command></para> + <indexterm zone="ch-system-e2fsprogs mklost-found"> + <primary sortas="b-mklost+found">mklost+found</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="resize2fs"> + <term><command>resize2fs</command></term> + <listitem> + <para>Can be used to enlarge or shrink an <systemitem + class="filesystem">ext2</systemitem> file system</para> + <indexterm zone="ch-system-e2fsprogs resize2fs"> + <primary sortas="b-resize2fs">resize2fs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="tune2fs"> + <term><command>tune2fs</command></term> + <listitem> + <para>Adjusts tunable file system parameters on an <systemitem + class="filesystem">ext2</systemitem> file system</para> + <indexterm zone="ch-system-e2fsprogs tune2fs"> + <primary sortas="b-tune2fs">tune2fs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="uuidgen"> + <term><command>uuidgen</command></term> + <listitem> + <para>Creates new UUIDs. Each new UUID can reasonably be considered + unique among all UUIDs created, on the local system and on other + systems, in the past and in the future</para> + <indexterm zone="ch-system-e2fsprogs uuidgen"> + <primary sortas="b-uuidgen">uuidgen</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libblkid"> + <term><filename class="libraryfile">libblkid</filename></term> + <listitem> + <para>Contains routines for device identification and token + extraction</para> + <indexterm zone="ch-system-e2fsprogs libblkid"> + <primary sortas="c-libblkid">libblkid</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libcom_err"> + <term><filename class="libraryfile">libcom_err</filename></term> + <listitem> + <para>The common error display routine</para> + <indexterm zone="ch-system-e2fsprogs libcom_err"> + <primary sortas="c-libcom_err">libcom_err</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libe2p"> + <term><filename class="libraryfile">libe2p</filename></term> + <listitem> + <para>Used by <command>dumpe2fs</command>, <command>chattr</command>, + and <command>lsattr</command></para> + <indexterm zone="ch-system-e2fsprogs libe2p"> + <primary sortas="c-libe2p">libe2p</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libext2fs"> + <term><filename class="libraryfile">libext2fs</filename></term> + <listitem> + <para>Contains routines to enable user-level programs to manipulate an + <systemitem class="filesystem">ext2</systemitem> file system</para> + <indexterm zone="ch-system-e2fsprogs libext2fs"> + <primary sortas="c-libext2fs">libext2fs</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libss"> + <term><filename class="libraryfile">libss</filename></term> + <listitem> + <para>Used by <command>debugfs</command></para> + <indexterm zone="ch-system-e2fsprogs libss"> + <primary sortas="c-libss">libss</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libuuid"> + <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> </sect1> - diff --git a/chapter06/file.xml b/chapter06/file.xml index f89f7674b..cae4324f7 100644 --- a/chapter06/file.xml +++ b/chapter06/file.xml @@ -1,84 +1,109 @@ <?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"> %general-entities; ]> -<sect1 id="ch-system-file" role="wrap"> -<title>File-&file-version;</title> -<?dbhtml filename="file.html"?> - -<indexterm zone="ch-system-file"><primary sortas="a-File">File</primary></indexterm> -<sect2 role="package"><title/> -<para>The File package contains a utility for determining the type of a given -file or files.</para> +<sect1 id="ch-system-file" role="wrap"> + <?dbhtml filename="file.html"?> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>6.2 MB</seg></seglistitem> -</segmentedlist> + <title>File-&file-version;</title> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -GCC, Glibc, Grep, Make, Sed, and Zlib</seg></seglistitem> -</segmentedlist> -</sect2> + <indexterm zone="ch-system-file"> + <primary sortas="a-File">File</primary> + </indexterm> -<sect2 role="installation"> -<title>Installation of File</title> + <sect2 role="package"> + <title/> -<para>Prepare File for compilation:</para> + <para>The File package contains a utility for determining the type of a given + file or files.</para> -<screen><userinput>./configure --prefix=/usr</userinput></screen> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<para>Compile the package:</para> + <seglistitem> + <seg>0.1 SBU</seg> + <seg>6.2 MB</seg> + </seglistitem> + </segmentedlist> -<screen><userinput>make</userinput></screen> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<para>This package does not come with a test suite.</para> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, + Sed, and Zlib</seg> + </seglistitem> + </segmentedlist> -<para>Install the package:</para> + </sect2> -<screen><userinput>make install</userinput></screen> + <sect2 role="installation"> + <title>Installation of File</title> -</sect2> + <para>Prepare File for compilation:</para> +<screen><userinput>./configure --prefix=/usr</userinput></screen> -<sect2 id="contents-file" role="content"><title>Contents of File</title> + <para>Compile the package:</para> -<segmentedlist> -<segtitle>Installed programs</segtitle> -<segtitle>Installed library</segtitle> -<seglistitem><seg>file</seg><seg>libmagic.[a,so]</seg></seglistitem> -</segmentedlist> +<screen><userinput>make</userinput></screen> -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> + <para>This package does not come with a test suite.</para> -<varlistentry id="file"> -<term><command>file</command></term> -<listitem> -<para>Tries to classify each given file; it does this by performing -several tests—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> + <para>Install the package:</para> -<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> +<screen><userinput>make install</userinput></screen> -</sect2> + </sect2> + + + <sect2 id="contents-file" role="content"> + <title>Contents of File</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + <segtitle>Installed library</segtitle> + + <seglistitem> + <seg>file</seg> + <seg>libmagic.[a,so]</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="file"> + <term><command>file</command></term> + <listitem> + <para>Tries to classify each given file; it does this by performing + several tests—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"> + <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> - diff --git a/chapter06/findutils.xml b/chapter06/findutils.xml index 8112a4e46..ae379d04d 100644 --- a/chapter06/findutils.xml +++ b/chapter06/findutils.xml @@ -1,140 +1,180 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-findutils" role="wrap"> -<title>Findutils-&findutils-version;</title> -<?dbhtml filename="findutils.html"?> + <?dbhtml filename="findutils.html"?> + + <title>Findutils-&findutils-version;</title> + + <indexterm zone="ch-system-findutils"> + <primary sortas="a-Findutils">Findutils</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-findutils"><primary sortas="a-Findutils">Findutils</primary></indexterm> + <para>The Findutils package contains programs to find files. These programs + are provided to recursively search through a directory tree and to + create, maintain, and search a database (often faster than the recursive + find, but unreliable if the database has not been recently updated).</para> -<sect2 role="package"><title/> -<para>The Findutils package contains programs to find files. These programs -are provided to recursively search through a directory tree and to -create, maintain, and search a database (often faster than the recursive -find, but unreliable if the database has not been recently updated).</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>9.4 MB</seg></seglistitem> -</segmentedlist> + <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> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Findutils</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext, Glibc, Grep, + Make and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Prepare Findutils for compilation:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Findutils</title> + + <para>Prepare Findutils for compilation:</para> <screen><userinput>./configure --prefix=/usr --libexecdir=/usr/lib/findutils \ --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> -<term><parameter>--localstatedir</parameter></term> -<listitem><para>This option changes the location of the <command>locate</command> -database to be in <filename class="directory">/var/lib/locate</filename>, which -is FHS-compliant.</para></listitem> -</varlistentry> -</variablelist> + <varlistentry> + <term><parameter>--localstatedir</parameter></term> + <listitem> + <para>This option changes the location of the <command>locate</command> + database to be in <filename class="directory">/var/lib/locate</filename>, + which is FHS-compliant.</para> + </listitem> + </varlistentry> -<para>Compile the package:</para> + </variablelist> + + <para>Compile the package:</para> <screen><userinput>make</userinput></screen> -<para>To test the results, issue: -<userinput>make check</userinput>.</para> + <para>To test the results, issue: + <userinput>make check</userinput>.</para> -<para>Install the package:</para> + <para>Install the package:</para> <screen><userinput>make install</userinput></screen> -</sect2> - -<sect2 id="contents-findutils" role="content"><title>Contents of Findutils</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="bigram"> -<term><command>bigram</command></term> -<listitem> -<para>Was formerly used to produce <command>locate</command> databases</para> -<indexterm zone="ch-system-findutils bigram"><primary sortas="b-bigram">bigram</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="code"> -<term><command>code</command></term> -<listitem> -<para>Was formerly used to produce <command>locate</command> -databases; it is the ancestor of <command>frcode</command>.</para> -<indexterm zone="ch-system-findutils code"><primary sortas="b-code">code</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="find"> -<term><command>find</command></term> -<listitem> -<para>Searches given directory trees for files matching the specified criteria</para> -<indexterm zone="ch-system-findutils find"><primary sortas="b-find">find</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="frcode"> -<term><command>frcode</command></term> -<listitem> -<para>Is called by <command>updatedb</command> to compress the list of file names; it uses -front-compression, reducing the database size by a factor of four to -five.</para> -<indexterm zone="ch-system-findutils frcode"><primary sortas="b-frcode">frcode</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="locate"> -<term><command>locate</command></term> -<listitem> -<para>Searches through a database of file names and reports the names -that contain a given string or match a given pattern</para> -<indexterm zone="ch-system-findutils locate"><primary sortas="b-locate">locate</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="updatedb"> -<term><command>updatedb</command></term> -<listitem> -<para>Updates the <command>locate</command> database; it scans -the entire file system (including other file systems that are currently mounted, -unless told not to) and puts every file name it finds into the database</para> -<indexterm zone="ch-system-findutils updatedb"><primary sortas="b-updatedb">updatedb</primary></indexterm> -</listitem> -</varlistentry> - -<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> + </sect2> + + <sect2 id="contents-findutils" role="content"> + <title>Contents of Findutils</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>bigram, code, find, frcode, locate, updatedb, and xargs</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="bigram"> + <term><command>bigram</command></term> + <listitem> + <para>Was formerly used to produce <command>locate</command> + databases</para> + <indexterm zone="ch-system-findutils bigram"> + <primary sortas="b-bigram">bigram</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="code"> + <term><command>code</command></term> + <listitem> + <para>Was formerly used to produce <command>locate</command> + databases; it is the ancestor of <command>frcode</command>.</para> + <indexterm zone="ch-system-findutils code"> + <primary sortas="b-code">code</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="find"> + <term><command>find</command></term> + <listitem> + <para>Searches given directory trees for files matching the specified + criteria</para> + <indexterm zone="ch-system-findutils find"> + <primary sortas="b-find">find</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="frcode"> + <term><command>frcode</command></term> + <listitem> + <para>Is called by <command>updatedb</command> to compress the list + of file names; it uses front-compression, reducing the database size + by a factor of four to five.</para> + <indexterm zone="ch-system-findutils frcode"> + <primary sortas="b-frcode">frcode</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="locate"> + <term><command>locate</command></term> + <listitem> + <para>Searches through a database of file names and reports the names + that contain a given string or match a given pattern</para> + <indexterm zone="ch-system-findutils locate"> + <primary sortas="b-locate">locate</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="updatedb"> + <term><command>updatedb</command></term> + <listitem> + <para>Updates the <command>locate</command> database; it scans the + entire file system (including other file systems that are currently + mounted, unless told not to) and puts every file name it finds into + the database</para> + <indexterm zone="ch-system-findutils updatedb"> + <primary sortas="b-updatedb">updatedb</primary> + </indexterm> + </listitem> + </varlistentry> + + <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> - diff --git a/chapter06/flex.xml b/chapter06/flex.xml index 7d4b30796..3d375d311 100644 --- a/chapter06/flex.xml +++ b/chapter06/flex.xml @@ -1,71 +1,88 @@ <?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"> %general-entities; ]> + <sect1 id="ch-system-flex" role="wrap"> -<title>Flex-&flex-version;</title> -<?dbhtml filename="flex.html"?> + <?dbhtml filename="flex.html"?> + + <title>Flex-&flex-version;</title> + + <indexterm zone="ch-system-flex"> + <primary sortas="a-Flex">Flex</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-flex"><primary sortas="a-Flex">Flex</primary></indexterm> + <para>The Flex package contains a utility for generating programs that + recognize patterns in text.</para> -<sect2 role="package"><title/> -<para>The Flex package contains a utility for generating programs that -recognize patterns in text.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>22.5 MB</seg></seglistitem> -</segmentedlist> + <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> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Flex</title> + <seglistitem> + <seg>Bash, Binutils, Bison, Coreutils, Diffutils, GCC, Gettext, + Glibc, Grep, M4, Make, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Flex contains several known bugs. Fix these with the following patch:</para> + </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> -<para>The GNU autotools detects that the Flex source code has been -modified by the previous patch and tries to update the man page -accordingly. This does not work correctly on many systems, and the -default page is fine, so make sure it does not get regenerated:</para> + <para>The GNU autotools detects that the Flex source code has been + modified by the previous patch and tries to update the man page + accordingly. This does not work correctly on many systems, and the + default page is fine, so make sure it does not get regenerated:</para> <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> -<para>Compile the package:</para> + <para>Compile the package:</para> <screen><userinput>make</userinput></screen> -<para>To test the results, issue: -<userinput>make check</userinput>.</para> + <para>To test the results, issue: + <userinput>make check</userinput>.</para> -<para>Install the package:</para> + <para>Install the package:</para> <screen><userinput>make install</userinput></screen> -<para>There are some packages that expect to find the -<filename class="libraryfile">lex</filename> library in <filename -class="directory">/usr/lib</filename>. Create a symlink to account for -this:</para> + <para>There are some packages that expect to find the + <filename class="libraryfile">lex</filename> library in <filename + class="directory">/usr/lib</filename>. Create a symlink to account for + this:</para> <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 -try to run its predecessor, <command>lex</command>. To support those -programs, create a wrapper script named <filename>lex</filename> that -calls <filename>flex</filename> in <command>lex</command> emulation mode:</para> + <para>A few programs do not know about <command>flex</command> yet and + try to run its predecessor, <command>lex</command>. To support those + programs, create a wrapper script named <filename>lex</filename> that + calls <filename>flex</filename> in <command>lex</command> emulation + mode:</para> <screen><userinput>cat > /usr/bin/lex << "EOF" <literal>#!/bin/sh @@ -77,52 +94,61 @@ exec /usr/bin/flex -l "$@" EOF chmod -v 755 /usr/bin/lex</userinput></screen> -</sect2> - - -<sect2 id="contents-flex" role="content"><title>Contents of Flex</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<segtitle>Installed library</segtitle> -<seglistitem><seg>flex and lex</seg> -<seg>libfl.a</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="flex"> -<term><command>flex</command></term> -<listitem> -<para>A tool for generating programs that recognize patterns in text; -it allows for the versatility to specify the rules for -pattern-finding, eradicating the need to develop a specialized -program</para> -<indexterm zone="ch-system-flex flex"><primary sortas="b-flex">flex</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="lex"> -<term><command>lex</command></term> -<listitem> -<para>A script that runs <command>flex</command> in <command>lex</command> -emulation mode</para> -<indexterm zone="ch-system-flex lex"><primary sortas="b-lex">lex</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="libfl.a"> -<term><filename class="libraryfile">libfl.a</filename></term> -<listitem> -<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> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + <sect2 id="contents-flex" role="content"> + <title>Contents of Flex</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + <segtitle>Installed library</segtitle> + + <seglistitem> + <seg>flex and lex</seg> + <seg>libfl.a</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="flex"> + <term><command>flex</command></term> + <listitem> + <para>A tool for generating programs that recognize patterns in text; + it allows for the versatility to specify the rules for pattern-finding, + eradicating the need to develop a specialized program</para> + <indexterm zone="ch-system-flex flex"> + <primary sortas="b-flex">flex</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lex"> + <term><command>lex</command></term> + <listitem> + <para>A script that runs <command>flex</command> in + <command>lex</command> emulation mode</para> + <indexterm zone="ch-system-flex lex"> + <primary sortas="b-lex">lex</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libfl.a"> + <term><filename class="libraryfile">libfl.a</filename></term> + <listitem> + <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> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - |