Rewrote diffutils + fileutils installation pages, added previously not 'cvs add'ed files

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

17 files changed, 107 insertions, 50 deletions

diff --git a/appendixa/bzip2-shortdesc.xml b/appendixa/bzip2-shortdesc.xml
new file mode 100644
index 000000000..e885796fc
--- /dev/null
+++ b/appendixa/bzip2-shortdesc.xml
@@ -0,0 +1,19 @@
+<sect2><title>Contents of Bzip2</title>
+
+<para>Last checked against version &bzip2-contversion;</para>
+
+<para>Bzip2 is a block-sorting file compressor which generally achieves a
+better compression than the traditional <userinput>gzip</userinput>
+does.</para>
+
+<para>Bzip2 installs the following files:</para>
+
+<sect3><title>Program Files</title>
+<para>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff, bzegrep,
+bzfgrep, bzgrep, bzip2, bzip2recover, bzless and bzmore</para></sect3>
+
+<sect3><title>Library Files</title>
+<para>libbz2.a, libbz2.so (link to libbz2.so.1.0), libbz2.so.1.0 (link to
+libbz2.so.1.0.2) and libbz2.so.1.0.2</para></sect3>
+
+</sect2>
diff --git a/appendixa/diffutils-dep.xml b/appendixa/diffutils-dep.xml
index 4d0ac2f7f..9905ad23f 100644
--- a/appendixa/diffutils-dep.xml
+++ b/appendixa/diffutils-dep.xml
@@ -1,3 +1,5 @@
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
+
 <sect2>
 <title>Diffutils Installation Dependencies</title>
 
diff --git a/appendixa/diffutils-desc.xml b/appendixa/diffutils-desc.xml
index a30438526..188f9dfe6 100644
--- a/appendixa/diffutils-desc.xml
+++ b/appendixa/diffutils-desc.xml
@@ -1,11 +1,10 @@
-<sect2><title>Contents of Diffutils</title>
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
 
-<para>Last checked against version &diffutils-contversion;.</para>
+<sect2><title>Descriptions</title>
 
-<sect3><title>Program Files</title>
-<para>cmp, diff, diff3 and sdiff</para></sect3>
+<para>Last checked against version &diffutils-contversion;.</para>
 
-<sect3><title>Descriptions</title>
+<sect3><title>Program files descriptions</title>
 
 <sect4><title>cmp and diff</title>
 <para>cmp and diff both compare two files and report their differences. Both
diff --git a/appendixa/diffutils-shortdesc.xml b/appendixa/diffutils-shortdesc.xml
new file mode 100644
index 000000000..b052e1384
--- /dev/null
+++ b/appendixa/diffutils-shortdesc.xml
@@ -0,0 +1,15 @@
+<sect2><title>Contents of Diffutils</title>
+
+<para>Last checked against version &diffutils-contversion;.</para>
+
+<para>The programs from this package show you the differences between two
+files or directories. It's most common use is to create software
+patches.</para>
+
+<para>Diffutils installs the following files:</para>
+
+<sect3><title>Program Files</title>
+<para>cmp, diff, diff3 and sdiff</para></sect3>
+
+</sect2>
+
diff --git a/appendixa/diffutils.xml b/appendixa/diffutils.xml
index 06ed6d7ef..bca2c6a96 100644
--- a/appendixa/diffutils.xml
+++ b/appendixa/diffutils.xml
@@ -3,6 +3,7 @@
 <?dbhtml filename="diffutils.html" dir="appendixa"?>
 
 &aa-diffutils-down;
+&aa-diffutils-shortdesc;
 &aa-diffutils-desc;
 &aa-diffutils-dep;
 
diff --git a/appendixa/fileutils-dep.xml b/appendixa/fileutils-dep.xml
index 66808dfe3..5a47139a8 100644
--- a/appendixa/fileutils-dep.xml
+++ b/appendixa/fileutils-dep.xml
@@ -1,3 +1,5 @@
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
+
 <sect2>
 <title>Fileutils Installation Dependencies</title>
 
diff --git a/appendixa/fileutils-desc.xml b/appendixa/fileutils-desc.xml
index 1db269027..a7ee4281a 100644
--- a/appendixa/fileutils-desc.xml
+++ b/appendixa/fileutils-desc.xml
@@ -1,13 +1,10 @@
-<sect2><title>Contents of Fileutils</title>
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
 
-<para>Last checked against version &fileutils-contversion;.</para>
+<sect2><title>Descriptions</title>
 
-<sect3><title>Program Files</title>
-<para>chgrp, chmod, chown, cp, dd, df, dir, dircolors, du, install, ln, 
-ls, mkdir, mkfifo, mknod, mv, rm, rmdir, shred, sync, touch 
-and vdir</para></sect3>
+<para>Last checked against version &fileutils-contversion;.</para>
 
-<sect3><title>Descriptions</title>
+<sect3><title>Program files descriptions</title>
 
 <sect4><title>chgrp</title>
 <para>chgrp changes the group ownership of each given file to the named group, 
diff --git a/appendixa/fileutils-shortdesc.xml b/appendixa/fileutils-shortdesc.xml
new file mode 100644
index 000000000..d0e0f6cfd
--- /dev/null
+++ b/appendixa/fileutils-shortdesc.xml
@@ -0,0 +1,17 @@
+<sect2><title>Contents of Fileutils</title>
+
+<para>Last checked against version &fileutils-contversion;.</para>
+
+<para>Fileutils is a package containing basic file manipulation programs.
+Including are programs to list directories, create directories, update
+timestamps, change permissions and so forth.</para>
+
+<para>Fileutils installs the following files:</para>
+
+<sect3><title>Program Files</title>
+<para>chgrp, chmod, chown, cp, dd, df, dir, dircolors, du, install, ln, 
+ls, mkdir, mkfifo, mknod, mv, rm, rmdir, shred, sync, touch 
+and vdir</para></sect3>
+
+</sect2>
+
diff --git a/appendixa/fileutils.xml b/appendixa/fileutils.xml
index 91711c60e..3fcb58d6c 100644
--- a/appendixa/fileutils.xml
+++ b/appendixa/fileutils.xml
@@ -3,6 +3,7 @@
 <?dbhtml filename="fileutils.html" dir="appendixa"?>
 
 &aa-fileutils-down;
+&aa-fileutils-shortdesc;
 &aa-fileutils-desc;
 &aa-fileutils-dep;
 
diff --git a/chapter05/diffutils-exp.xml b/chapter05/diffutils-exp.xml
deleted file mode 100644
index 4dc40ea07..000000000
--- a/chapter05/diffutils-exp.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<sect2>
-<title>Command explanations</title>
-
-<para><userinput>CPPFLAGS=-Dre_max_failures=re_max_failures2:</userinput> The
-CPPFLAGS variable is a variable that's read by the cpp program (C 
-PreProcessor). The value of this variable tells the preprocessor to 
-replace every instance of re_max_failures it finds by re_max_failures2 
-before handing the source file to the compiler itself for compilation. This 
-package has problems linking statically on systems that run an older
-Glibc version and this construction fixes that problem.</para>
-
-</sect2>
-
diff --git a/chapter05/diffutils-inst.xml b/chapter05/diffutils-inst.xml
index cb387de49..e197fa674 100644
--- a/chapter05/diffutils-inst.xml
+++ b/chapter05/diffutils-inst.xml
@@ -1,11 +1,37 @@
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
+
 <sect2>
 <title>Installation of Diffutils</title>
 
-<para>Install Diffutils by running the following commands:</para>
+<para>Prepare Diffutils to be compiled:</para>
 
 <para><screen><userinput>LDFLAGS="-static" CPPFLAGS=-Dre_max_failures=re_max_failures2 \
-&nbsp;&nbsp;&nbsp;&nbsp;./configure --prefix=$LFS/static --disable-nls &amp;&amp;
-make &amp;&amp;
+&nbsp;&nbsp;&nbsp;&nbsp;./configure --prefix=$LFS/static --disable-nls</userinput></screen></para>
+
+<para>The meaning of the configure options are:</para>
+
+<itemizedlist>
+<listitem><para><userinput>LDFLAGS="-static":</userinput> This is the most
+common way to tell a package that all programs should be statically linked.
+This way the <emphasis>LDFLAGS</emphasis> environment variable is set but
+only in the subshell that the <filename>configure</filename> script runs
+in. When <userinput>configure</userinput> is done its job, the
+<emphasis>LDFLAGS</emphasis> variable won't exist
+anymore.</para></listitem>
+
+<listitem><para><userinput>CPPFLAGS=-Dre_max_failures=re_max_failures2:</userinput>
+The <emphasis>CPPFLAGS</emphasis> variable is a variable that's read by the
+cpp program (C PreProcessor). The value of this variable tells the
+preprocessor to replace every instance of <emphasis>re_max_failures</emphasis>
+it finds with <emphasis>re_max_failures2</emphasis> before handing the source
+file to the compiler itself for compilation. This package has problems
+linking statically on systems that run an older Glibc version and this
+construction fixes that problem.</para></listitem>
+</itemizedlist>
+
+<para>Finish off by compiling and installing the package:</para>
+
+<para><screen><userinput>make
 make install</userinput></screen></para>
 
 </sect2>
diff --git a/chapter05/diffutils.xml b/chapter05/diffutils.xml
index 7e7411247..3156c340c 100644
--- a/chapter05/diffutils.xml
+++ b/chapter05/diffutils.xml
@@ -5,10 +5,9 @@
 <screen>Estimated build time:           &diffutils-time-static;
 Estimated required disk space:  &diffutils-compsize-static;</screen>
 
-&c5-diffutils-inst;
-&c5-diffutils-exp;
-&aa-diffutils-desc;
+&aa-diffutils-shortdesc;
 &aa-diffutils-dep;
+&c5-diffutils-inst;
 
 </sect1>
 
diff --git a/chapter05/fileutils-exp.xml b/chapter05/fileutils-exp.xml
deleted file mode 100644
index ec4647069..000000000
--- a/chapter05/fileutils-exp.xml
+++ /dev/null
@@ -1,10 +0,0 @@
-<sect2>
-<title>Command explanations</title>
-
-<para><userinput>patch -Np1 -i ../fileutils-&fileutils-version;.patch:</userinput> This is used to fix a problem with building fileutils statically on
-glibc 2.2.3 systems. If this isn't done, then there is the possibility of
-all of the fileutils programs causing segmentation faults once chroot is
-entered in Chapter 6.</para>
-
-</sect2>
-
diff --git a/chapter05/fileutils-inst.xml b/chapter05/fileutils-inst.xml
index a37c01261..7e6275aeb 100644
--- a/chapter05/fileutils-inst.xml
+++ b/chapter05/fileutils-inst.xml
@@ -1,3 +1,5 @@
+<sect2><title>&nbsp;</title><para>&nbsp;</para></sect2>
+
 <sect2>
 <title>Installation of Fileutils</title>
 
@@ -17,7 +19,7 @@ your distribution has altered Glibc-2.2.3 somehow, but details are
 unavailable at this time.</para>
 
 <para>To fix this package to compile properly on AMD/Glibc-2.2.3
-machines, run the following command. Do <emphasis>not</emphasis>
+machines, run the following command. Do <emphasis>NOT</emphasis>
 attempt this fix if you don't have Glibc-2.2.3 installed. It will more 
 than likely result in all kinds of compile time problems.</para>
 
@@ -26,16 +28,15 @@ than likely result in all kinds of compile time problems.</para>
 <para>Install Fileutils by running the following commands:</para>
 
 <para><screen><userinput>LDFLAGS="-static" \
-&nbsp;&nbsp;&nbsp;&nbsp;./configure --disable-nls --prefix=$LFS/static &amp;&amp;
-make &amp;&amp;
+&nbsp;&nbsp;&nbsp;&nbsp;./configure --disable-nls --prefix=$LFS/static
+make
 make install</userinput></screen></para>
 
 <para>Once you have installed Fileutils, you can test whether the
 segmentation fault problem has been avoided by running
 <userinput>$LFS/static/bin/ls</userinput>. If this works, then you are OK. If
-not, then you need to re-do the installation with the patch if 
-you didn't use it, or without the patch if you did use 
-it.</para>
+not, then you need to re-do the installation with the patch if you didn't
+use it, or without the patch if you did use it.</para>
 
 </sect2>
 
diff --git a/chapter05/fileutils.xml b/chapter05/fileutils.xml
index cccbe9dc9..19cbd8cd7 100644
--- a/chapter05/fileutils.xml
+++ b/chapter05/fileutils.xml
@@ -5,10 +5,9 @@
 <screen>Estimated build time:           &fileutils-time-static;
 Estimated required disk space:  &fileutils-compsize-static;</screen>
 
-&c5-fileutils-inst;
-&c5-fileutils-exp;
-&aa-fileutils-desc;
+&aa-fileutils-shortdesc;
 &aa-fileutils-dep;
+&c5-fileutils-inst;
 
 </sect1>
 
diff --git a/entities/diffutils.ent b/entities/diffutils.ent
index e6099b6c0..de5aae6ca 100644
--- a/entities/diffutils.ent
+++ b/entities/diffutils.ent
@@ -8,6 +8,7 @@
 <!ENTITY c6-diffutils-inst SYSTEM "../chapter06/diffutils-inst.xml">
 
 <!ENTITY aa-diffutils SYSTEM "../appendixa/diffutils.xml">
+<!ENTITY aa-diffutils-shortdesc SYSTEM "../appendixa/diffutils-shortdesc.xml">
 <!ENTITY aa-diffutils-desc SYSTEM "../appendixa/diffutils-desc.xml">
 <!ENTITY aa-diffutils-dep SYSTEM "../appendixa/diffutils-dep.xml">
 <!ENTITY aa-diffutils-down SYSTEM "../appendixa/diffutils-down.xml">
diff --git a/entities/fileutils.ent b/entities/fileutils.ent
index 4129fe06d..a80912250 100644
--- a/entities/fileutils.ent
+++ b/entities/fileutils.ent
@@ -9,6 +9,7 @@
 <!ENTITY c6-fileutils-inst SYSTEM "../chapter06/fileutils-inst.xml">
 
 <!ENTITY aa-fileutils SYSTEM "../appendixa/fileutils.xml">
+<!ENTITY aa-fileutils-shortdesc SYSTEM "../appendixa/fileutils-shortdesc.xml">
 <!ENTITY aa-fileutils-desc SYSTEM "../appendixa/fileutils-desc.xml">
 <!ENTITY aa-fileutils-dep SYSTEM "../appendixa/fileutils-dep.xml">
 <!ENTITY aa-fileutils-down SYSTEM "../appendixa/fileutils-down.xml">