diff options
author | Manuel Canales Esparcia <manuel@linuxfromscratch.org> | 2006-02-05 11:42:02 +0000 |
---|---|---|
committer | Manuel Canales Esparcia <manuel@linuxfromscratch.org> | 2006-02-05 11:42:02 +0000 |
commit | 9506f8576eb6f832672e9228f054e76ed49b2571 (patch) | |
tree | fee60cff74a7fdbe6489c66675c7a931cfdbed36 | |
parent | 3a0a57c3c34fc35d0815b564541a1f1440c2d604 (diff) |
Ported r7348 from trunk to alphabetical branch.
git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/alphabetical/BOOK@7350 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
-rw-r--r-- | chapter06/groff.xml | 817 | ||||
-rw-r--r-- | chapter06/grub.xml | 228 | ||||
-rw-r--r-- | chapter06/gzip.xml | 403 | ||||
-rw-r--r-- | chapter06/hotplug.xml | 357 | ||||
-rw-r--r-- | chapter06/iana-etc.xml | 136 | ||||
-rw-r--r-- | chapter06/inetutils.xml | 339 | ||||
-rw-r--r-- | chapter06/introduction.xml | 106 |
7 files changed, 1332 insertions, 1054 deletions
diff --git a/chapter06/groff.xml b/chapter06/groff.xml index db13ad57e..9f41b2ae3 100644 --- a/chapter06/groff.xml +++ b/chapter06/groff.xml @@ -1,395 +1,494 @@ <?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-groff" role="wrap"> -<title>Groff-&groff-version;</title> -<?dbhtml filename="groff.html"?> + <?dbhtml filename="groff.html"?> + + <title>Groff-&groff-version;</title> + + <indexterm zone="ch-system-groff"> + <primary sortas="a-Groff">Groff</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-groff"><primary sortas="a-Groff">Groff</primary></indexterm> + <para>The Groff package contains programs for processing and formatting + text.</para> -<sect2 role="package"><title/> -<para>The Groff package contains programs for processing and formatting text.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.5 SBU</seg><seg>38.7 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.5 SBU</seg> + <seg>38.7 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Groff</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, Gawk, GCC, Glibc, Grep, + Make, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Apply the patch that adds the <quote>ascii8</quote> and -<quote>nippon</quote> devices to Groff:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Groff</title> + + <para>Apply the patch that adds the <quote>ascii8</quote> and + <quote>nippon</quote> devices to Groff:</para> <screen><userinput>zcat ../&groff-debian-patch; | patch -Np1</userinput></screen> -<note><para>These devices are used by Man-DB when formatting non-English manual -pages that are not in the ISO-8859-1 encoding. Currently, there is no working -patch for Groff-1.19.x that adds this functionality. -<!-- Details: http://bugs.debian.org/196762 --> -</para></note> + <note> + <para>These devices are used by Man-DB when formatting non-English manual + pages that are not in the ISO-8859-1 encoding. Currently, there is no + working patch for Groff-1.19.x that adds this functionality.</para> + <!-- Details: http://bugs.debian.org/196762 --> + </note> -<para>Many screen fonts don't have Unicode single quotes and dashes in them. -Tell Groff to use the ASCII equivalents instead:</para> + <para>Many screen fonts don't have Unicode single quotes and dashes in them. + Tell Groff to use the ASCII equivalents instead:</para> <screen><userinput>sed -i -e 's/2010/002D/' -e 's/2212/002D/' \ - -e 's/2018/0060/' -e 's/2019/0027/' font/devutf8/R.proto -</userinput></screen> + -e 's/2018/0060/' -e 's/2019/0027/' font/devutf8/R.proto</userinput></screen> -<para>Groff expects the environment variable <envar>PAGE</envar> -to contain the default paper size. For users in the United States, -<parameter>PAGE=letter</parameter> is appropriate. Elsewhere, -<parameter>PAGE=A4</parameter> may be more suitable. -While the default paper size is configured during compilation, it can be -overridden later by echoing either <quote>A4</quote> or <quote>letter</quote> -to the <filename>/etc/papersize</filename> file.</para> + <para>Groff expects the environment variable <envar>PAGE</envar> to + contain the default paper size. For users in the United States, + <parameter>PAGE=letter</parameter> is appropriate. Elsewhere, + <parameter>PAGE=A4</parameter> may be more suitable. While the default + paper size is configured during compilation, it can be overridden later + by echoing either <quote>A4</quote> or <quote>letter</quote> to the + <filename>/etc/papersize</filename> file.</para> -<para>Prepare Groff for compilation:</para> + <para>Prepare Groff for compilation:</para> <screen><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr --enable-multibyte</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> -<para>Some documentation programs, such as <command>xman</command>, -will not work properly without the following symlinks:</para> + <para>Some documentation programs, such as <command>xman</command>, + will not work properly without the following symlinks:</para> <screen><userinput>ln -sv soelim /usr/bin/zsoelim ln -sv eqn /usr/bin/geqn ln -sv tbl /usr/bin/gtbl</userinput></screen> -</sect2> - - -<sect2 id="contents-groff" role="content"><title>Contents of Groff</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, -grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit, -indxbib, lkbib, lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml, -pre-grohtml, refer, soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="addftinfo"> -<term><command>addftinfo</command></term> -<listitem> -<para>Reads a troff font file and adds some -additional font-metric information that is used by the <command>groff</command> system</para> -<indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="afmtodit"> -<term><command>afmtodit</command></term> -<listitem> -<para>Creates a font file for use with <command>groff</command> and <command>grops</command></para> -<indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="eqn"> -<term><command>eqn</command></term> -<listitem> -<para>Compiles descriptions of equations embedded -within troff input files into commands that are understood by <command>troff</command></para> -<indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="eqn2graph"> -<term><command>eqn2graph</command></term> -<listitem> -<para>Converts a troff EQN (equation) into a cropped image</para> -<indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="geqn"> -<term><command>geqn</command></term> -<listitem> -<para>A link to <command>eqn</command></para> -<indexterm zone="ch-system-groff geqn"><primary sortas="b-geqn">geqn</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grn"> -<term><command>grn</command></term> -<listitem> -<para>A <command>groff</command> preprocessor for gremlin files</para> -<indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grodvi"> -<term><command>grodvi</command></term> -<listitem> -<para>A driver for <command>groff</command> that produces TeX dvi format</para> -<indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="groff"> -<term><command>groff</command></term> -<listitem> -<para>A front-end to the groff document -formatting system; normally, it runs the <command>troff</command> program and a post-processor -appropriate for the selected device</para> -<indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="groffer"> -<term><command>groffer</command></term> -<listitem> -<para>Displays groff files and man pages on X and tty terminals</para> -<indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grog"> -<term><command>grog</command></term> -<listitem> -<para>Reads files and guesses which of the <command>groff</command> -options <parameter>-e</parameter>, <parameter>-man</parameter>, -<parameter>-me</parameter>, <parameter>-mm</parameter>, -<parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>, -and <parameter>-t</parameter> are required for printing -files, and reports the <command>groff</command> command including those options</para> -<indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grolbp"> -<term><command>grolbp</command></term> -<listitem> -<para>Is a <command>groff</command> driver for Canon CAPSL printers -(LBP-4 and LBP-8 series laser printers)</para> -<indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grolj4"> -<term><command>grolj4</command></term> -<listitem> -<para>Is a driver for <command>groff</command> that produces output -in PCL5 format suitable for an HP LaserJet 4 printer</para> -<indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grops"> -<term><command>grops</command></term> -<listitem> -<para>Translates the output of GNU <command>troff</command> to PostScript</para> -<indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grotty"> -<term><command>grotty</command></term> -<listitem> -<para>Translates the output of GNU <command>troff</command> into -a form suitable for typewriter-like devices</para> -<indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="gtbl"> -<term><command>gtbl</command></term> -<listitem> -<para>A link to <command>tbl</command></para> -<indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hpftodit"> -<term><command>hpftodit</command></term> -<listitem> -<para>Creates a font file for use with -<command>groff -Tlj4</command> from an HP-tagged font metric file</para> -<indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="indxbib"> -<term><command>indxbib</command></term> -<listitem> -<para>Creates an inverted index for the bibliographic databases with a specified file for -use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command></para> -<indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="lkbib"> -<term><command>lkbib</command></term> -<listitem> -<para>Searches bibliographic databases for references that contain -specified keys and reports any references found</para> -<indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="lookbib"> -<term><command>lookbib</command></term> -<listitem> -<para>Prints a prompt on the standard error (unless the standard input -is not a terminal), reads a line containing a -set of keywords from the standard input, searches the bibliographic databases in a specified -file for references containing those keywords, prints any references -found on the standard output, and repeats this process until the end -of input</para> -<indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mmroff"> -<term><command>mmroff</command></term> -<listitem> -<para>A simple preprocessor for <command>groff</command></para> -<indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="neqn"> -<term><command>neqn</command></term> -<listitem> -<para>Formats equations for American Standard Code for Information -Interchange (ASCII) output</para> -<indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="nroff"> -<term><command>nroff</command></term> -<listitem> -<para>A script that emulates the <command>nroff</command> command using <command>groff</command></para> -<indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="pfbtops"> -<term><command>pfbtops</command></term> -<listitem> -<para>Translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII</para> -<indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="pic"> -<term><command>pic</command></term> -<listitem> -<para>Compiles descriptions of pictures embedded -within troff or TeX input files into commands understood by TeX or <command>troff</command></para> -<indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="pic2graph"> -<term><command>pic2graph</command></term> -<listitem> -<para>Converts a PIC diagram into a cropped image</para> -<indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="post-grohtml"> -<term><command>post-grohtml</command></term> -<listitem> -<para>Translates the output of GNU <command>troff</command> to HTML</para> -<indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="pre-grohtml"> -<term><command>pre-grohtml </command></term> -<listitem> -<para>Translates the output of GNU <command>troff</command> to HTML</para> -<indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="refer"> -<term><command>refer</command></term> -<listitem> -<para>Copies the contents of a file to the standard output, except -that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> -are interpreted as citations, and lines between -<emphasis>.R1</emphasis> and <emphasis>.R2</emphasis> are interpreted -as commands for how citations are to be processed</para> -<indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="soelim"> -<term><command>soelim</command></term> -<listitem> -<para>Reads files and replaces lines of the form -<emphasis>.so file</emphasis> by the contents of the mentioned -<emphasis>file</emphasis></para> -<indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="tbl"> -<term><command>tbl</command></term> -<listitem> -<para>Compiles descriptions of tables embedded -within troff input files into commands that are understood by <command>troff</command></para> -<indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="tfmtodit"> -<term><command>tfmtodit</command></term> -<listitem> -<para>Creates a font file for use with <command>groff -Tdvi</command></para> -<indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="troff"> -<term><command>troff</command></term> -<listitem> -<para>Is highly compatible with Unix <command>troff</command>; it -should usually be invoked using the -<command>groff</command> command, which will also run preprocessors and post-processors in the -appropriate order and with the appropriate options</para> -<indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zsoelim"> -<term><command>zsoelim</command></term> -<listitem> -<para>A link to <command>soelim</command></para> -<indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + <sect2 id="contents-groff" role="content"> + <title>Contents of Groff</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn, + grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl + (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff, neqn, + nroff, pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, refer, + soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="addftinfo"> + <term><command>addftinfo</command></term> + <listitem> + <para>Reads a troff font file and adds some additional font-metric + information that is used by the <command>groff</command> system</para> + <indexterm zone="ch-system-groff addftinfo"> + <primary sortas="b-addftinfo">addftinfo</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="afmtodit"> + <term><command>afmtodit</command></term> + <listitem> + <para>Creates a font file for use with <command>groff</command> and + <command>grops</command></para> + <indexterm zone="ch-system-groff afmtodit"> + <primary sortas="b-afmtodit">afmtodit</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="eqn"> + <term><command>eqn</command></term> + <listitem> + <para>Compiles descriptions of equations embedded within troff + input files into commands that are understood by + <command>troff</command></para> + <indexterm zone="ch-system-groff eqn"> + <primary sortas="b-eqn">eqn</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="eqn2graph"> + <term><command>eqn2graph</command></term> + <listitem> + <para>Converts a troff EQN (equation) into a cropped image</para> + <indexterm zone="ch-system-groff eqn2graph"> + <primary sortas="b-eqn2graph">eqn2graph</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="geqn"> + <term><command>geqn</command></term> + <listitem> + <para>A link to <command>eqn</command></para> + <indexterm zone="ch-system-groff geqn"> + <primary sortas="b-geqn">geqn</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grn"> + <term><command>grn</command></term> + <listitem> + <para>A <command>groff</command> preprocessor for gremlin files</para> + <indexterm zone="ch-system-groff grn"> + <primary sortas="b-grn">grn</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grodvi"> + <term><command>grodvi</command></term> + <listitem> + <para>A driver for <command>groff</command> that produces TeX dvi + format</para> + <indexterm zone="ch-system-groff grodvi"> + <primary sortas="b-grodvi">grodvi</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="groff"> + <term><command>groff</command></term> + <listitem> + <para>A front-end to the groff document formatting system; normally, it + runs the <command>troff</command> program and a post-processor + appropriate for the selected device</para> + <indexterm zone="ch-system-groff groff"> + <primary sortas="b-groff">groff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="groffer"> + <term><command>groffer</command></term> + <listitem> + <para>Displays groff files and man pages on X and tty terminals</para> + <indexterm zone="ch-system-groff groffer"> + <primary sortas="b-groffer">groffer</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grog"> + <term><command>grog</command></term> + <listitem> + <para>Reads files and guesses which of the <command>groff</command> + options <option>-e</option>, <option>-man</option>, <option>-me</option>, + <option>-mm</option>, <option>-ms</option>, <option>-p</option>, + <option>-s</option>, and <option>-t</option> are required for printing + files, and reports the <command>groff</command> command including those + options</para> + <indexterm zone="ch-system-groff grog"> + <primary sortas="b-grog">grog</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grolbp"> + <term><command>grolbp</command></term> + <listitem> + <para>Is a <command>groff</command> driver for Canon CAPSL printers + (LBP-4 and LBP-8 series laser printers)</para> + <indexterm zone="ch-system-groff grolbp"> + <primary sortas="b-grolbp">grolbp</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grolj4"> + <term><command>grolj4</command></term> + <listitem> + <para>Is a driver for <command>groff</command> that produces output + in PCL5 format suitable for an HP LaserJet 4 printer</para> + <indexterm zone="ch-system-groff grolj4"> + <primary sortas="b-grolj4">grolj4</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grops"> + <term><command>grops</command></term> + <listitem> + <para>Translates the output of GNU <command>troff</command> to + PostScript</para> + <indexterm zone="ch-system-groff grops"> + <primary sortas="b-grops">grops</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grotty"> + <term><command>grotty</command></term> + <listitem> + <para>Translates the output of GNU <command>troff</command> into + a form suitable for typewriter-like devices</para> + <indexterm zone="ch-system-groff grotty"> + <primary sortas="b-grotty">grotty</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="gtbl"> + <term><command>gtbl</command></term> + <listitem> + <para>A link to <command>tbl</command></para> + <indexterm zone="ch-system-groff gtbl"> + <primary sortas="b-gtbl">gtbl</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hpftodit"> + <term><command>hpftodit</command></term> + <listitem> + <para>Creates a font file for use with <command>groff -Tlj4</command> + from an HP-tagged font metric file</para> + <indexterm zone="ch-system-groff hpftodit"> + <primary sortas="b-hpftodit">hpftodit</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="indxbib"> + <term><command>indxbib</command></term> + <listitem> + <para>Creates an inverted index for the bibliographic databases with a + specified file for use with <command>refer</command>, + <command>lookbib</command>, and <command>lkbib</command></para> + <indexterm zone="ch-system-groff indxbib"> + <primary sortas="b-indxbib">indxbib</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lkbib"> + <term><command>lkbib</command></term> + <listitem> + <para>Searches bibliographic databases for references that contain + specified keys and reports any references found</para> + <indexterm zone="ch-system-groff lkbib"> + <primary sortas="b-lkbib">lkbib</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lookbib"> + <term><command>lookbib</command></term> + <listitem> + <para>Prints a prompt on the standard error (unless the standard input + is not a terminal), reads a line containing a set of keywords from the + standard input, searches the bibliographic databases in a specified file + for references containing those keywords, prints any references found + on the standard output, and repeats this process until the end of + input</para> + <indexterm zone="ch-system-groff lookbib"> + <primary sortas="b-lookbib">lookbib</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mmroff"> + <term><command>mmroff</command></term> + <listitem> + <para>A simple preprocessor for <command>groff</command></para> + <indexterm zone="ch-system-groff mmroff"> + <primary sortas="b-mmroff">mmroff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="neqn"> + <term><command>neqn</command></term> + <listitem> + <para>Formats equations for American Standard Code for Information + Interchange (ASCII) output</para> + <indexterm zone="ch-system-groff neqn"> + <primary sortas="b-neqn">neqn</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="nroff"> + <term><command>nroff</command></term> + <listitem> + <para>A script that emulates the <command>nroff</command> command + using <command>groff</command></para> + <indexterm zone="ch-system-groff nroff"> + <primary sortas="b-nroff">nroff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="pfbtops"> + <term><command>pfbtops</command></term> + <listitem> + <para>Translates a PostScript font in <filename + class="extension">.pfb</filename> format to ASCII</para> + <indexterm zone="ch-system-groff pfbtops"> + <primary sortas="b-pfbtops">pfbtops</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="pic"> + <term><command>pic</command></term> + <listitem> + <para>Compiles descriptions of pictures embedded within troff or + TeX input files into commands understood by TeX or + <command>troff</command></para> + <indexterm zone="ch-system-groff pic"> + <primary sortas="b-pic">pic</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="pic2graph"> + <term><command>pic2graph</command></term> + <listitem> + <para>Converts a PIC diagram into a cropped image</para> + <indexterm zone="ch-system-groff pic2graph"> + <primary sortas="b-pic2graph">pic2graph</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="post-grohtml"> + <term><command>post-grohtml</command></term> + <listitem> + <para>Translates the output of GNU <command>troff</command> to + HTML</para> + <indexterm zone="ch-system-groff post-grohtml"> + <primary sortas="b-post-grohtml">post-grohtml</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="pre-grohtml"> + <term><command>pre-grohtml </command></term> + <listitem> + <para>Translates the output of GNU <command>troff</command> to + HTML</para> + <indexterm zone="ch-system-groff pre-grohtml"> + <primary sortas="b-pre-grohtml">pre-grohtml</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="refer"> + <term><command>refer</command></term> + <listitem> + <para>Copies the contents of a file to the standard output, except + that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> + are interpreted as citations, and lines between <emphasis>.R1</emphasis> + and <emphasis>.R2</emphasis> are interpreted as commands for how + citations are to be processed</para> + <indexterm zone="ch-system-groff refer"> + <primary sortas="b-refer">refer</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="soelim"> + <term><command>soelim</command></term> + <listitem> + <para>Reads files and replaces lines of the form <emphasis>.so + file</emphasis> by the contents of the mentioned + <emphasis>file</emphasis></para> + <indexterm zone="ch-system-groff soelim"> + <primary sortas="b-soelim">soelim</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="tbl"> + <term><command>tbl</command></term> + <listitem> + <para>Compiles descriptions of tables embedded within troff input + files into commands that are understood by + <command>troff</command></para> + <indexterm zone="ch-system-groff tbl"> + <primary sortas="b-tbl">tbl</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="tfmtodit"> + <term><command>tfmtodit</command></term> + <listitem> + <para>Creates a font file for use with <command>groff + -Tdvi</command></para> + <indexterm zone="ch-system-groff tfmtodit"> + <primary sortas="b-tfmtodit">tfmtodit</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="troff"> + <term><command>troff</command></term> + <listitem> + <para>Is highly compatible with Unix <command>troff</command>; it + should usually be invoked using the <command>groff</command> command, + which will also run preprocessors and post-processors in the + appropriate order and with the appropriate options</para> + <indexterm zone="ch-system-groff troff"> + <primary sortas="b-troff">troff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zsoelim"> + <term><command>zsoelim</command></term> + <listitem> + <para>A link to <command>soelim</command></para> + <indexterm zone="ch-system-groff zsoelim"> + <primary sortas="b-zsoelim">zsoelim</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/grub.xml b/chapter06/grub.xml index 3f643b04e..ebff3707d 100644 --- a/chapter06/grub.xml +++ b/chapter06/grub.xml @@ -1,126 +1,154 @@ <?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-grub" role="wrap"> -<title>GRUB-&grub-version;</title> -<?dbhtml filename="grub.html"?> + <?dbhtml filename="grub.html"?> + + <title>GRUB-&grub-version;</title> + + <indexterm zone="ch-system-grub"> + <primary sortas="a-Grub">GRUB</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-grub"><primary sortas="a-Grub">GRUB</primary></indexterm> + <para>The GRUB package contains the GRand Unified Bootloader.</para> -<sect2 role="package"><title/> -<para>The GRUB package contains the GRand Unified Bootloader.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.2 SBU</seg><seg>10.0 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.2 SBU</seg> + <seg>10.0 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of GRUB</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, + Ncurses, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>This package is known to have issues when its default -optimization flags (including the <parameter>-march</parameter> and -<parameter>-mcpu</parameter> options) are changed. If any environment -variables that override default optimizations have been defined, such -as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, -unset them when building GRUB.</para> + </sect2> -<para>Prepare GRUB for compilation:</para> + <sect2 role="installation"> + <title>Installation of GRUB</title> + + <para>This package is known to have issues when its default + optimization flags (including the <parameter>-march</parameter> and + <parameter>-mcpu</parameter> options) are changed. If any environment + variables that override default optimizations have been defined, such + as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, + unset them when building GRUB.</para> + + <para>Prepare GRUB 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 mkdir -v /boot/grub cp -v /usr/lib/grub/i386-pc/stage{1,2} /boot/grub</userinput></screen> -<para>Replace <filename class="directory">i386-pc</filename> with whatever -directory is appropriate for the hardware in use.</para> - -<para>The <filename class="directory">i386-pc</filename> directory -contains a number of <filename>*stage1_5</filename> files, different -ones for different file systems. Review the files available and copy -the appropriate ones to the <filename -class="directory">/boot/grub</filename> directory. Most users will -copy the <filename>e2fs_stage1_5</filename> and/or -<filename>reiserfs_stage1_5</filename> files.</para> - -</sect2> - - -<sect2 id="contents-gRUB" role="content"><title>Contents of GRUB</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>grub, grub-install, -grub-md5-crypt, grub-terminfo, and mbchk</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="grub"> -<term><command>grub</command></term> -<listitem> -<para>The Grand Unified Bootloader's command shell</para> -<indexterm zone="ch-system-grub grub"><primary sortas="b-grub">grub</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grub-install"> -<term><command>grub-install</command></term> -<listitem> -<para>Installs GRUB on the given device</para> -<indexterm zone="ch-system-grub grub-install"><primary sortas="b-grub-install">grub-install</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grub-md5-crypt"> -<term><command>grub-md5-crypt</command></term> -<listitem> -<para>Encrypts a password in MD5 format</para> -<indexterm zone="ch-system-grub grub-md5-crypt"><primary sortas="b-grub-md5-crypt">grub-md5-crypt</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="grub-terminfo"> -<term><command>grub-terminfo</command></term> -<listitem> -<para>Generates a terminfo command from a terminfo name; it can be -employed if an unknown terminal is being used</para> -<indexterm zone="ch-system-grub grub-terminfo"><primary sortas="b-grub-terminfo">grub-terminfo</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="mbchk"> -<term><command>mbchk</command></term> -<listitem> -<para>Checks the format of a multi-boot kernel</para> -<indexterm zone="ch-system-grub mbchk"><primary sortas="b-mbchk">mbchk</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + <para>Replace <filename class="directory">i386-pc</filename> with whatever + directory is appropriate for the hardware in use.</para> + + <para>The <filename class="directory">i386-pc</filename> directory + contains a number of <filename>*stage1_5</filename> files, different + ones for different file systems. Review the files available and copy + the appropriate ones to the <filename + class="directory">/boot/grub</filename> directory. Most users will + copy the <filename>e2fs_stage1_5</filename> and/or + <filename>reiserfs_stage1_5</filename> files.</para> + + </sect2> + + <sect2 id="contents-gRUB" role="content"> + <title>Contents of GRUB</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>grub, grub-install, grub-md5-crypt, grub-terminfo, and mbchk</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="grub"> + <term><command>grub</command></term> + <listitem> + <para>The Grand Unified Bootloader's command shell</para> + <indexterm zone="ch-system-grub grub"> + <primary sortas="b-grub">grub</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grub-install"> + <term><command>grub-install</command></term> + <listitem> + <para>Installs GRUB on the given device</para> + <indexterm zone="ch-system-grub grub-install"> + <primary sortas="b-grub-install">grub-install</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grub-md5-crypt"> + <term><command>grub-md5-crypt</command></term> + <listitem> + <para>Encrypts a password in MD5 format</para> + <indexterm zone="ch-system-grub grub-md5-crypt"> + <primary sortas="b-grub-md5-crypt">grub-md5-crypt</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="grub-terminfo"> + <term><command>grub-terminfo</command></term> + <listitem> + <para>Generates a terminfo command from a terminfo name; it can be + employed if an unknown terminal is being used</para> + <indexterm zone="ch-system-grub grub-terminfo"> + <primary sortas="b-grub-terminfo">grub-terminfo</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="mbchk"> + <term><command>mbchk</command></term> + <listitem> + <para>Checks the format of a multi-boot kernel</para> + <indexterm zone="ch-system-grub mbchk"> + <primary sortas="b-mbchk">mbchk</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/gzip.xml b/chapter06/gzip.xml index 81fa03c89..76b0b7f6d 100644 --- a/chapter06/gzip.xml +++ b/chapter06/gzip.xml @@ -1,63 +1,78 @@ <?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-gzip" role="wrap"> -<title>Gzip-&gzip-version;</title> -<?dbhtml filename="gzip.html"?> + <?dbhtml filename="gzip.html"?> + + <title>Gzip-&gzip-version;</title> + + <indexterm zone="ch-system-gzip"> + <primary sortas="a-Gzip">Gzip</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-gzip"><primary sortas="a-Gzip">Gzip</primary></indexterm> + <para>The Gzip package contains programs for compressing and decompressing + files.</para> -<sect2 role="package"><title/> -<para>The Gzip package contains programs for compressing and decompressing -files.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>2.2 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.1 SBU</seg> + <seg>2.2 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -GCC, Glibc, Grep, Make, Patch, and Sed</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Gzip</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, + Patch, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Gzip has 2 known security vulnerabilities. The following patch -addresses both of them:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Gzip</title> + + <para>Gzip has 2 known security vulnerabilities. The following patch + addresses both of them:</para> <screen><userinput>patch -Np1 -i ../&gzip-security_fix-patch;</userinput></screen> -<para>Prepare Gzip for compilation:</para> + <para>Prepare Gzip for compilation:</para> <screen><userinput>./configure --prefix=/usr</userinput></screen> -<para>The <command>gzexe</command> script has the location of the -<command>gzip</command> binary hard-wired into it. Because the -location of the binary is changed later, the following command ensures -that the new location gets placed into the script:</para> + <para>The <command>gzexe</command> script has the location of the + <command>gzip</command> binary hard-wired into it. Because the + location of the binary is changed later, the following command ensures + that the new location gets placed into the script:</para> <screen><userinput>sed -i 's@"BINDIR"@/bin@g' gzexe.in</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> -<para>Move the <command>gzip</command> program to the <filename -class="directory">/bin</filename> directory and create some commonly used -symlinks to it:</para> + <para>Move the <command>gzip</command> program to the <filename + class="directory">/bin</filename> directory and create some commonly used + symlinks to it:</para> <screen><userinput>mv -v /usr/bin/gzip /bin rm -v /usr/bin/{gunzip,zcat} @@ -66,148 +81,184 @@ ln -sv gzip /bin/zcat ln -sv gzip /bin/compress ln -sv gunzip /bin/uncompress</userinput></screen> -</sect2> - - -<sect2 id="contents-gzip" role="content"><title>Contents of Gzip</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>compress (link to gzip), gunzip (link to gzip), gzexe, -gzip, uncompress (link to gunzip), zcat (link to gzip), zcmp, zdiff, -zegrep, zfgrep, zforce, zgrep, zless, zmore, and znew</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="compress"> -<term><command>compress</command></term> -<listitem> -<para>Compresses and decompresses files</para> -<indexterm zone="ch-system-gzip compress"><primary sortas="b-compress">compress</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="gunzip"> -<term><command>gunzip</command></term> -<listitem> -<para>Decompresses gzipped files</para> -<indexterm zone="ch-system-gzip gunzip"><primary sortas="b-gunzip">gunzip</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="gzexe"> -<term><command>gzexe</command></term> -<listitem> -<para>Creates self-decompressing executable files</para> -<indexterm zone="ch-system-gzip gzexe"><primary sortas="b-gzexe">gzexe</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="gzip"> -<term><command>gzip</command></term> -<listitem> -<para>Compresses the given files using Lempel-Ziv (LZ77) coding</para> -<indexterm zone="ch-system-gzip gzip"><primary sortas="b-gzip">gzip</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="uncompress"> -<term><command>uncompress</command></term> -<listitem> -<para>Decompresses compressed files</para> -<indexterm zone="ch-system-gzip uncompress"><primary sortas="b-uncompress">uncompress</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zcat"> -<term><command>zcat</command></term> -<listitem> -<para>Decompresses the given gzipped files to standard output</para> -<indexterm zone="ch-system-gzip zcat"><primary sortas="b-zcat">zcat</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zcmp"> -<term><command>zcmp</command></term> -<listitem> -<para>Runs <command>cmp</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zcmp"><primary sortas="b-zcmp">zcmp</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zdiff"> -<term><command>zdiff</command></term> -<listitem> -<para>Runs <command>diff</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zdiff"><primary sortas="b-zdiff">zdiff</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zegrep"> -<term><command>zegrep</command></term> -<listitem> -<para>Runs <command>egrep</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zegrep"><primary sortas="b-zegrep">zegrep</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zfgrep"> -<term><command>zfgrep</command></term> -<listitem> -<para>Runs <command>fgrep</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zfgrep"><primary sortas="b-zfgrep">zfgrep</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zforce"> -<term><command>zforce</command></term> -<listitem> -<para>Forces a <filename class="extension">.gz</filename> extension on all given files -that are gzipped files, so that <command>gzip</command> will not compress them again; this can be -useful when file names were truncated during a file transfer</para> -<indexterm zone="ch-system-gzip zforce"><primary sortas="b-zforce">zforce</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zgrep"> -<term><command>zgrep</command></term> -<listitem> -<para>Runs <command>grep</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zgrep"><primary sortas="b-zgrep">zgrep</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zless"> -<term><command>zless</command></term> -<listitem> -<para>Runs <command>less</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zless"><primary sortas="b-zless">zless</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="zmore"> -<term><command>zmore</command></term> -<listitem> -<para>Runs <command>more</command> on gzipped files</para> -<indexterm zone="ch-system-gzip zmore"><primary sortas="b-zmore">zmore</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="znew"> -<term><command>znew</command></term> -<listitem> -<para>Re-compresses files from <command>compress</command> format to -<command>gzip</command> format—<filename class="extension">.Z</filename> -to <filename class="extension">.gz</filename></para> -<indexterm zone="ch-system-gzip znew"><primary sortas="b-znew">znew</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + <sect2 id="contents-gzip" role="content"> + <title>Contents of Gzip</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>compress (link to gzip), gunzip (link to gzip), gzexe, gzip, + uncompress (link to gunzip), zcat (link to gzip), zcmp, zdiff, + zegrep, zfgrep, zforce, zgrep, zless, zmore, and znew</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="compress"> + <term><command>compress</command></term> + <listitem> + <para>Compresses and decompresses files</para> + <indexterm zone="ch-system-gzip compress"> + <primary sortas="b-compress">compress</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="gunzip"> + <term><command>gunzip</command></term> + <listitem> + <para>Decompresses gzipped files</para> + <indexterm zone="ch-system-gzip gunzip"> + <primary sortas="b-gunzip">gunzip</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="gzexe"> + <term><command>gzexe</command></term> + <listitem> + <para>Creates self-decompressing executable files</para> + <indexterm zone="ch-system-gzip gzexe"> + <primary sortas="b-gzexe">gzexe</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="gzip"> + <term><command>gzip</command></term> + <listitem> + <para>Compresses the given files using Lempel-Ziv (LZ77) coding</para> + <indexterm zone="ch-system-gzip gzip"> + <primary sortas="b-gzip">gzip</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="uncompress"> + <term><command>uncompress</command></term> + <listitem> + <para>Decompresses compressed files</para> + <indexterm zone="ch-system-gzip uncompress"> + <primary sortas="b-uncompress">uncompress</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zcat"> + <term><command>zcat</command></term> + <listitem> + <para>Decompresses the given gzipped files to standard output</para> + <indexterm zone="ch-system-gzip zcat"> + <primary sortas="b-zcat">zcat</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zcmp"> + <term><command>zcmp</command></term> + <listitem> + <para>Runs <command>cmp</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zcmp"> + <primary sortas="b-zcmp">zcmp</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zdiff"> + <term><command>zdiff</command></term> + <listitem> + <para>Runs <command>diff</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zdiff"> + <primary sortas="b-zdiff">zdiff</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zegrep"> + <term><command>zegrep</command></term> + <listitem> + <para>Runs <command>egrep</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zegrep"> + <primary sortas="b-zegrep">zegrep</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zfgrep"> + <term><command>zfgrep</command></term> + <listitem> + <para>Runs <command>fgrep</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zfgrep"> + <primary sortas="b-zfgrep">zfgrep</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zforce"> + <term><command>zforce</command></term> + <listitem> + <para>Forces a <filename class="extension">.gz</filename> extension on + all given files that are gzipped files, so that <command>gzip</command> + will not compress them again; this can be useful when file names were + truncated during a file transfer</para> + <indexterm zone="ch-system-gzip zforce"> + <primary sortas="b-zforce">zforce</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zgrep"> + <term><command>zgrep</command></term> + <listitem> + <para>Runs <command>grep</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zgrep"> + <primary sortas="b-zgrep">zgrep</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zless"> + <term><command>zless</command></term> + <listitem> + <para>Runs <command>less</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zless"> + <primary sortas="b-zless">zless</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="zmore"> + <term><command>zmore</command></term> + <listitem> + <para>Runs <command>more</command> on gzipped files</para> + <indexterm zone="ch-system-gzip zmore"> + <primary sortas="b-zmore">zmore</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="znew"> + <term><command>znew</command></term> + <listitem> + <para>Re-compresses files from <command>compress</command> format to + <command>gzip</command> format—<filename + class="extension">.Z</filename> to <filename + class="extension">.gz</filename></para> + <indexterm zone="ch-system-gzip znew"> + <primary sortas="b-znew">znew</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/hotplug.xml b/chapter06/hotplug.xml index 3135342a2..d66e0c7e7 100644 --- a/chapter06/hotplug.xml +++ b/chapter06/hotplug.xml @@ -1,188 +1,223 @@ <?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-hotplug" xreflabel="Hotplug" role="wrap"> -<title>Hotplug-&hotplug-version;</title> -<?dbhtml filename="hotplug.html"?> -<indexterm zone="ch-system-hotplug"><primary sortas="a-Hotplug">Hotplug</primary></indexterm> +<sect1 id="ch-system-hotplug" role="wrap"> + <?dbhtml filename="hotplug.html"?> -<sect2 role="package"><title/> -<para>The Hotplug package contains scripts that react upon hotplug events -generated by the kernel. Such events correspond to every change in the kernel -state visible in the <systemitem class="filesystem">sysfs</systemitem> -filesystem, e.g., the addition and removal of hardware. This package also -detects existing hardware during boot and inserts the relevant modules into the -running kernel.</para> + <title>Hotplug-&hotplug-version;</title> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.01 SBU</seg><seg>460 KB</seg></seglistitem> -</segmentedlist> + <indexterm zone="ch-system-hotplug"> + <primary sortas="a-Hotplug">Hotplug</primary> + </indexterm> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Coreutils, Findutils, Gawk, and Make</seg></seglistitem> -</segmentedlist> -</sect2> + <sect2 role="package"> + <title/> -<sect2 role="installation"> -<title>Installation of Hotplug</title> + <para>The Hotplug package contains scripts that react upon hotplug events + generated by the kernel. Such events correspond to every change in the kernel + state visible in the <systemitem class="filesystem">sysfs</systemitem> + filesystem, e.g., the addition and removal of hardware. This package also + detects existing hardware during boot and inserts the relevant modules into the + running kernel.</para> -<para>This package does not come with a test suite.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<para>Install the Hotplug package:</para> + <seglistitem> + <seg>0.01 SBU</seg> + <seg>460 KB</seg> + </seglistitem> + </segmentedlist> + + <segmentedlist> + <segtitle>&dependencies;</segtitle> + + <seglistitem> + <seg>Bash, Coreutils, Findutils, Gawk, and Make</seg> + </seglistitem> + </segmentedlist> + + </sect2> + + <sect2 role="installation"> + <title>Installation of Hotplug</title> + + <para>This package does not come with a test suite.</para> + + <para>Install the Hotplug package:</para> <screen><userinput>make install</userinput></screen> -<para>Copy a file that the <quote>install</quote> target omits.</para> + <para>Copy a file that the <quote>install</quote> target omits.</para> <screen><userinput>cp -v etc/hotplug/pnp.distmap /etc/hotplug</userinput></screen> -<para>Remove the init script that Hotplug installs since we are going to be -using the script included in the LFS-Bootscripts package:</para> + <para>Remove the init script that Hotplug installs since we are going to be + using the script included in the LFS-Bootscripts package:</para> <screen><userinput>rm -rfv /etc/init.d</userinput></screen> -<para>Network device hotplugging is not yet supported by the LFS-Bootscripts -package. For that reason, remove the network hotplug agent:</para> + <para>Network device hotplugging is not yet supported by the LFS-Bootscripts + package. For that reason, remove the network hotplug agent:</para> <screen><userinput>rm -fv /etc/hotplug/net.agent</userinput></screen> -<para>Create a directory for storing firmware that can be loaded by -<command>hotplug</command>:</para> + <para>Create a directory for storing firmware that can be loaded by + <command>hotplug</command>:</para> <screen><userinput>mkdir -v /lib/firmware</userinput></screen> -</sect2> - - -<sect2 id="contents-hotplug" role="content"><title>Contents of Hotplug</title> - -<segmentedlist> -<segtitle>Installed program</segtitle> -<segtitle>Installed scripts</segtitle> -<segtitle>Installed files</segtitle> -<seglistitem><seg>hotplug</seg> -<seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> -<seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, /etc/hotplug/{pci,usb}, -/etc/hotplug/usb.usermap, /etc/hotplug.d, and /var/log/hotplug/events</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="hotplug"> -<term><command>hotplug</command></term> -<listitem> -<para>This script is called by default by the Linux kernel when something -changes in its internal state (e.g., a new device is added or an existing device -is removed)</para> -<indexterm zone="ch-system-hotplug hotplug"><primary -sortas="b-hotplug">hotplug</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-rc"> -<term><command>/etc/hotplug/*.rc</command></term> -<listitem> -<para>These scripts are used for cold plugging, i.e., detecting and acting upon -hardware already present during system startup. They are called by the -<filename>hotplug</filename> initscript included in the LFS-Bootscripts package. -The <command>*.rc</command> scripts try to recover hotplug events that were lost -during system boot because, for example, the root filesystem was not mounted by -the kernel</para> -<indexterm zone="ch-system-hotplug hotplug-rc"><primary -sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-agent"> -<term><command>/etc/hotplug/*.agent</command></term> -<listitem> -<para>These scripts are called by <command>hotplug</command> -in response to different types of hotplug events generated by the kernel. -Their action is to insert corresponding kernel modules and call any -user-provided scripts</para> -<indexterm zone="ch-system-hotplug hotplug-agent"><primary -sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-blacklist"> -<term><filename>/etc/hotplug/blacklist</filename></term> -<listitem> -<para>This file contains the list of modules that should never be inserted into -the kernel by the Hotplug scripts</para> -<indexterm zone="ch-system-hotplug hotplug-blacklist"><primary -sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-functions"> -<term><filename>/etc/hotplug/hotplug.functions</filename></term> -<listitem> -<para>This file contains common functions used by other scripts in the Hotplug -package</para> -<indexterm zone="ch-system-hotplug hotplug-functions"><primary -sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-subdirs"> -<term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> -<listitem> -<para>These directories contain user-written handlers for hotplug events</para> -<indexterm zone="ch-system-hotplug hotplug-subdirs"><primary -sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-usb.usermap"> -<term><filename>/etc/hotplug/usb.usermap</filename></term> -<listitem> -<para>This file contains rules that determine which user-defined handlers to -call for each USB device, based on its vendor ID and other attributes</para> -<indexterm zone="ch-system-hotplug hotplug-usb.usermap"><primary -sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-hotplug.d"> -<term><filename class="directory">/etc/hotplug.d</filename></term> -<listitem> -<para>This directory contains programs (or symlinks to them) that are interested -in receiving hotplug events. For example, Udev puts its symlink here during -installation</para> -<indexterm zone="ch-system-hotplug hotplug-hotplug.d"><primary -sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-firmware"> -<term><filename class="directory">/lib/firmware</filename></term> -<listitem> -<para>This directory contains the firmware for devices that need to have their -firmware loaded before use</para> -<indexterm zone="ch-system-hotplug hotplug-firmware"><primary -sortas="e-/lib/firmware">/lib/firmware</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="hotplug-events"> -<term><filename>/var/log/hotplug/events</filename></term> -<listitem> -<para>This file contains all the events that <command>hotplug</command> has -called since bootup</para> -<indexterm zone="ch-system-hotplug hotplug-events"><primary -sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary></indexterm> -</listitem> -</varlistentry> - -</variablelist> -</sect2> + </sect2> + + + <sect2 id="contents-hotplug" role="content"> + <title>Contents of Hotplug</title> + + <segmentedlist> + <segtitle>Installed program</segtitle> + <segtitle>Installed scripts</segtitle> + <segtitle>Installed files</segtitle> + + <seglistitem> + <seg>hotplug</seg> + <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> + <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, + /etc/hotplug/{pci,usb}, /etc/hotplug/usb.usermap, /etc/hotplug.d, + and /var/log/hotplug/events</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="hotplug"> + <term><command>hotplug</command></term> + <listitem> + <para>This script is called by default by the Linux kernel when + something changes in its internal state (e.g., a new device is + added or an existing device is removed)</para> + <indexterm zone="ch-system-hotplug hotplug"> + <primary sortas="b-hotplug">hotplug</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-rc"> + <term><command>/etc/hotplug/*.rc</command></term> + <listitem> + <para>These scripts are used for cold plugging, i.e., detecting and + acting upon hardware already present during system startup. They are + called by the <filename>hotplug</filename> initscript included in + the LFS-Bootscripts package. The <command>*.rc</command> scripts try + to recover hotplug events that were lost during system boot because, + for example, the root filesystem was not mounted by the kernel</para> + <indexterm zone="ch-system-hotplug hotplug-rc"> + <primary sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-agent"> + <term><command>/etc/hotplug/*.agent</command></term> + <listitem> + <para>These scripts are called by <command>hotplug</command> in response + to different types of hotplug events generated by the kernel. Their + action is to insert corresponding kernel modules and call any + user-provided scripts</para> + <indexterm zone="ch-system-hotplug hotplug-agent"> + <primary sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-blacklist"> + <term><filename>/etc/hotplug/blacklist</filename></term> + <listitem> + <para>This file contains the list of modules that should never be + inserted into the kernel by the Hotplug scripts</para> + <indexterm zone="ch-system-hotplug hotplug-blacklist"> + <primary sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-functions"> + <term><filename>/etc/hotplug/hotplug.functions</filename></term> + <listitem> + <para>This file contains common functions used by other scripts in the + Hotplug package</para> + <indexterm zone="ch-system-hotplug hotplug-functions"> + <primary sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-subdirs"> + <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> + <listitem> + <para>These directories contain user-written handlers for hotplug + events</para> + <indexterm zone="ch-system-hotplug hotplug-subdirs"> + <primary sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-usb.usermap"> + <term><filename>/etc/hotplug/usb.usermap</filename></term> + <listitem> + <para>This file contains rules that determine which user-defined handlers to + call for each USB device, based on its vendor ID and other + attributes</para> + <indexterm zone="ch-system-hotplug hotplug-usb.usermap"> + <primary sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-hotplug.d"> + <term><filename class="directory">/etc/hotplug.d</filename></term> + <listitem> + <para>This directory contains programs (or symlinks to them) that are + interested in receiving hotplug events. For example, Udev puts its + symlink here during installation</para> + <indexterm zone="ch-system-hotplug hotplug-hotplug.d"> + <primary sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-firmware"> + <term><filename class="directory">/lib/firmware</filename></term> + <listitem> + <para>This directory contains the firmware for devices that need to + have their firmware loaded before use</para> + <indexterm zone="ch-system-hotplug hotplug-firmware"> + <primary sortas="e-/lib/firmware">/lib/firmware</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="hotplug-events"> + <term><filename>/var/log/hotplug/events</filename></term> + <listitem> + <para>This file contains all the events that <command>hotplug</command> + has called since bootup</para> + <indexterm zone="ch-system-hotplug hotplug-events"> + <primary sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> + </sect1> diff --git a/chapter06/iana-etc.xml b/chapter06/iana-etc.xml index ebeb3bb30..bc0338995 100644 --- a/chapter06/iana-etc.xml +++ b/chapter06/iana-etc.xml @@ -1,79 +1,103 @@ <?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-iana-etc" role="wrap"> -<title>Iana-Etc-&iana-etc-version;</title> -<?dbhtml filename="iana-etc.html"?> - -<indexterm zone="ch-system-iana-etc"><primary sortas="a-Iana-Etc">Iana-Etc</primary></indexterm> -<sect2 role="package"><title/> -<para>The Iana-Etc package provides data for network services and protocols.</para> +<sect1 id="ch-system-iana-etc" role="wrap"> + <?dbhtml filename="iana-etc.html"?> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.1 SBU</seg><seg>2.0 MB</seg></seglistitem> -</segmentedlist> + <title>Iana-Etc-&iana-etc-version;</title> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Coreutils, Gawk, and Make</seg></seglistitem> -</segmentedlist> -</sect2> + <indexterm zone="ch-system-iana-etc"> + <primary sortas="a-Iana-Etc">Iana-Etc</primary> + </indexterm> -<sect2 role="installation"> -<title>Installation of Iana-Etc</title> + <sect2 role="package"> + <title/> -<para>The following command converts the raw data provided by IANA into the -correct formats for the <filename>/etc/protocols</filename> and -<filename>/etc/services</filename> data files:</para> + <para>The Iana-Etc package provides data for network services and + protocols.</para> -<screen><userinput>make</userinput></screen> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<para>This package does not come with a test suite.</para> + <seglistitem> + <seg>0.1 SBU</seg> + <seg>2.0 MB</seg> + </seglistitem> + </segmentedlist> -<para>Install the package:</para> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<screen><userinput>make install</userinput></screen> + <seglistitem> + <seg>Coreutils, Gawk, and Make</seg> + </seglistitem> + </segmentedlist> -</sect2> + </sect2> + <sect2 role="installation"> + <title>Installation of Iana-Etc</title> -<sect2 id="contents-iana-etc" role="content"><title>Contents of Iana-Etc</title> + <para>The following command converts the raw data provided by IANA into the + correct formats for the <filename>/etc/protocols</filename> and + <filename>/etc/services</filename> data files:</para> -<segmentedlist> -<segtitle>Installed files</segtitle> -<seglistitem><seg>/etc/protocols and /etc/services</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="protocols"> -<term><filename>/etc/protocols</filename></term> -<listitem> -<para>Describes the various DARPA Internet protocols that are -available from the TCP/IP subsystem</para> -<indexterm zone="ch-system-iana-etc"><primary sortas="e-/etc/protocols">/etc/protocols</primary></indexterm> -</listitem> -</varlistentry> + <para>Install the package:</para> -<varlistentry id="services"> -<term><filename>/etc/services</filename></term> -<listitem> -<para>Provides a mapping between friendly textual names for internet -services, and their underlying assigned port numbers and protocol -types</para> -<indexterm zone="ch-system-iana-etc"><primary sortas="e-/etc/services">/etc/services</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> +<screen><userinput>make install</userinput></screen> -</sect2> + </sect2> + + <sect2 id="contents-iana-etc" role="content"> + <title>Contents of Iana-Etc</title> + + <segmentedlist> + <segtitle>Installed files</segtitle> + + <seglistitem> + <seg>/etc/protocols and /etc/services</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="protocols"> + <term><filename>/etc/protocols</filename></term> + <listitem> + <para>Describes the various DARPA Internet protocols that are + available from the TCP/IP subsystem</para> + <indexterm zone="ch-system-iana-etc"> + <primary sortas="e-/etc/protocols">/etc/protocols</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="services"> + <term><filename>/etc/services</filename></term> + <listitem> + <para>Provides a mapping between friendly textual names for internet + services, and their underlying assigned port numbers and protocol + types</para> + <indexterm zone="ch-system-iana-etc"> + <primary sortas="e-/etc/services">/etc/services</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/inetutils.xml b/chapter06/inetutils.xml index 1cc5a6156..6e553f133 100644 --- a/chapter06/inetutils.xml +++ b/chapter06/inetutils.xml @@ -1,41 +1,57 @@ <?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-inetutils" role="wrap"> -<title>Inetutils-&inetutils-version;</title> -<?dbhtml filename="inetutils.html"?> + <?dbhtml filename="inetutils.html"?> + + <title>Inetutils-&inetutils-version;</title> + + <indexterm zone="ch-system-inetutils"> + <primary sortas="a-Inetutils">Inetutils</primary> + </indexterm> + + <sect2 role="package"> + <title/> -<indexterm zone="ch-system-inetutils"><primary sortas="a-Inetutils">Inetutils</primary></indexterm> + <para>The Inetutils package contains programs for basic networking.</para> -<sect2 role="package"><title/> -<para>The Inetutils package contains programs for basic networking.</para> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.2 SBU</seg><seg>8.7 MB</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>0.2 SBU</seg> + <seg>8.7 MB</seg> + </seglistitem> + </segmentedlist> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, -Diffutils, GCC, Glibc, Grep, Make, Ncurses, Patch, and Sed</seg></seglistitem> -</segmentedlist> -</sect2> + <segmentedlist> + <segtitle>&dependencies;</segtitle> -<sect2 role="installation"> -<title>Installation of Inetutils</title> + <seglistitem> + <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, + Ncurses, Patch, and Sed</seg> + </seglistitem> + </segmentedlist> -<para>Apply a patch to Inetutils to enable it to compile with GCC-&gcc-version;:</para> + </sect2> + + <sect2 role="installation"> + <title>Installation of Inetutils</title> + + <para>Apply a patch to Inetutils to enable it to compile with + GCC-&gcc-version;:</para> <screen><userinput>patch -Np1 -i ../&inetutils-gcc4_fixes-patch;</userinput></screen> -<para>All programs that come with Inetutils will not be installed. -However, the Inetutils build system will insist on installing all the -man pages anyway. The following patch will correct this -situation:</para> + <para>All programs that come with Inetutils will not be installed. + However, the Inetutils build system will insist on installing all the + man pages anyway. The following patch will correct this + situation:</para> <screen><userinput>patch -Np1 -i ../&inetutils-man_pages-patch;</userinput></screen> @@ -46,139 +62,166 @@ situation:</para> --disable-logger --disable-syslogd \ --disable-whois --disable-servers</userinput></screen> -<para>The meaning of the configure options:</para> - -<variablelist> -<varlistentry> -<term><parameter>--disable-logger</parameter></term> -<listitem><para>This option -prevents Inetutils from installing the <command>logger</command> program, which is used by -scripts to pass messages to the System Log Daemon. Do not install it -because Util-linux installs a better version later.</para></listitem> -</varlistentry> - -<varlistentry> -<term><parameter>--disable-syslogd</parameter></term> -<listitem><para>This option -prevents Inetutils from installing the System Log Daemon, which is -installed with the Sysklogd package.</para></listitem> -</varlistentry> - -<varlistentry> -<term><parameter>--disable-whois</parameter></term> -<listitem><para>This option disables -the building of the Inetutils <command>whois</command> client, which is out of date. -Instructions for a better <command>whois</command> client are in the BLFS book.</para></listitem> -</varlistentry> - -<varlistentry> -<term><parameter>--disable-servers</parameter></term> -<listitem><para>This disables the installation of the various network -servers included as part of the Inetutils package. These servers are -deemed not appropriate in a basic LFS system. Some are insecure by -nature and are only considered safe on trusted networks. More -information can be found at <ulink -url="&blfs-root;view/svn/basicnet/inetutils.html"/>. Note that -better replacements are available for many of these -servers.</para></listitem> -</varlistentry> -</variablelist> - -<para>Compile the package:</para> + <variablelist> + <title>The meaning of the configure options:</title> + + <varlistentry> + <term><parameter>--disable-logger</parameter></term> + <listitem> + <para>This option prevents Inetutils from installing the + <command>logger</command> program, which is used by scripts to + pass messages to the System Log Daemon. Do not install it because + Util-linux installs a better version later.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><parameter>--disable-syslogd</parameter></term> + <listitem> + <para>This option prevents Inetutils from installing the System Log + Daemon, which is installed with the Sysklogd package.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><parameter>--disable-whois</parameter></term> + <listitem> + <para>This option disables the building of the Inetutils + <command>whois</command> client, which is out of date. Instructions for + a better <command>whois</command> client are in the BLFS book.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><parameter>--disable-servers</parameter></term> + <listitem> + <para>This disables the installation of the various network servers + included as part of the Inetutils package. These servers are deemed not + appropriate in a basic LFS system. Some are insecure by nature and are + only considered safe on trusted networks. More information can be found + at <ulink url="&blfs-root;view/svn/basicnet/inetutils.html"/>. Note that + better replacements are available for many of these servers.</para> + </listitem> + </varlistentry> + + </variablelist> + + <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> -<para>Move the <command>ping</command> program to its FHS-compliant -place:</para> + <para>Move the <command>ping</command> program to its FHS-compliant + place:</para> <screen><userinput>mv -v /usr/bin/ping /bin</userinput></screen> -</sect2> - - -<sect2 id="contents-inetutils" role="content"><title>Contents of Inetutils</title> - -<segmentedlist> -<segtitle>Installed programs</segtitle> -<seglistitem><seg>ftp, ping, rcp, rlogin, rsh, talk, telnet, and tftp</seg></seglistitem> -</segmentedlist> - -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> - -<varlistentry id="ftp"> -<term><command>ftp</command></term> -<listitem> -<para>Is the file transfer protocol program</para> -<indexterm zone="ch-system-inetutils ftp"><primary sortas="b-ftp">ftp</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="ping"> -<term><command>ping</command></term> -<listitem> -<para>Sends echo-request packets and reports how long the replies take</para> -<indexterm zone="ch-system-inetutils ping"><primary sortas="b-ping">ping</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="rcp"> -<term><command>rcp</command></term> -<listitem> -<para>Performs remote file copy</para> -<indexterm zone="ch-system-inetutils rcp"><primary sortas="b-rcp">rcp</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="rlogin"> -<term><command>rlogin</command></term> -<listitem> -<para>Performs remote login</para> -<indexterm zone="ch-system-inetutils rlogin"><primary sortas="b-rlogin">rlogin</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="rsh"> -<term><command>rsh</command></term> -<listitem> -<para>Runs a remote shell</para> -<indexterm zone="ch-system-inetutils rsh"><primary sortas="b-rsh">rsh</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="talk"> -<term><command>talk</command></term> -<listitem> -<para>Is used to chat with another user</para> -<indexterm zone="ch-system-inetutils talk"><primary sortas="b-talk">talk</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="telnet"> -<term><command>telnet</command></term> -<listitem> -<para>An interface to the TELNET protocol</para> -<indexterm zone="ch-system-inetutils telnet"><primary sortas="b-telnet">telnet</primary></indexterm> -</listitem> -</varlistentry> - -<varlistentry id="tftp"> -<term><command>tftp</command></term> -<listitem> -<para>A trivial file transfer program</para> -<indexterm zone="ch-system-inetutils tftp"><primary sortas="b-tftp">tftp</primary></indexterm> -</listitem> -</varlistentry> -</variablelist> - -</sect2> + </sect2> + + <sect2 id="contents-inetutils" role="content"> + <title>Contents of Inetutils</title> + + <segmentedlist> + <segtitle>Installed programs</segtitle> + + <seglistitem> + <seg>ftp, ping, rcp, rlogin, rsh, talk, telnet, and tftp</seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="ftp"> + <term><command>ftp</command></term> + <listitem> + <para>Is the file transfer protocol program</para> + <indexterm zone="ch-system-inetutils ftp"> + <primary sortas="b-ftp">ftp</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="ping"> + <term><command>ping</command></term> + <listitem> + <para>Sends echo-request packets and reports how long the replies + take</para> + <indexterm zone="ch-system-inetutils ping"> + <primary sortas="b-ping">ping</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="rcp"> + <term><command>rcp</command></term> + <listitem> + <para>Performs remote file copy</para> + <indexterm zone="ch-system-inetutils rcp"> + <primary sortas="b-rcp">rcp</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="rlogin"> + <term><command>rlogin</command></term> + <listitem> + <para>Performs remote login</para> + <indexterm zone="ch-system-inetutils rlogin"> + <primary sortas="b-rlogin">rlogin</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="rsh"> + <term><command>rsh</command></term> + <listitem> + <para>Runs a remote shell</para> + <indexterm zone="ch-system-inetutils rsh"> + <primary sortas="b-rsh">rsh</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="talk"> + <term><command>talk</command></term> + <listitem> + <para>Is used to chat with another user</para> + <indexterm zone="ch-system-inetutils talk"> + <primary sortas="b-talk">talk</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="telnet"> + <term><command>telnet</command></term> + <listitem> + <para>An interface to the TELNET protocol</para> + <indexterm zone="ch-system-inetutils telnet"> + <primary sortas="b-telnet">telnet</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="tftp"> + <term><command>tftp</command></term> + <listitem> + <para>A trivial file transfer program</para> + <indexterm zone="ch-system-inetutils tftp"> + <primary sortas="b-tftp">tftp</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + + </sect2> </sect1> - diff --git a/chapter06/introduction.xml b/chapter06/introduction.xml index 065baeeed..5e9cfd5c3 100644 --- a/chapter06/introduction.xml +++ b/chapter06/introduction.xml @@ -1,67 +1,65 @@ <?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-introduction"> -<title>Introduction</title> -<?dbhtml filename="introduction.html"?> + <?dbhtml filename="introduction.html"?> -<para>In this chapter, we enter the building site and start -constructing the LFS system in earnest. That is, we chroot into the -temporary mini Linux system, make a few final preparations, and then -begin installing the packages.</para> + <title>Introduction</title> -<para>The installation of this software is straightforward. Although -in many cases the installation instructions could be made shorter and -more generic, we have opted to provide the full instructions for every -package to minimize the possibilities for mistakes. The key to -learning what makes a Linux system work is to know what each package -is used for and why the user (or the system) needs it. For every -installed package, a summary of its contents is given, followed by -concise descriptions of each program and library the package -installed.</para> + <para>In this chapter, we enter the building site and start constructing the + LFS system in earnest. That is, we chroot into the temporary mini Linux system, + make a few final preparations, and then begin installing the packages.</para> -<para>If using the compiler optimizations provided in this chapter, -please review the optimization hint at <ulink -url="&hints-root;optimization.txt"/>. Compiler optimizations can make -a program run slightly faster, but they may also cause compilation -difficulties and problems when running the program. If a package -refuses to compile when using optimization, try to compile it without -optimization and see if that fixes the problem. Even if the package -does compile when using optimization, there is the risk it may have -been compiled incorrectly because of the complex interactions between -the code and build tools. Also note that the <option>-march</option> -and <option>-mtune</option> options may cause problems with the -toolchain packages (Binutils, GCC and Glibc). The small potential -gains achieved in using compiler optimizations are often outweighed by -the risks. First-time builders of LFS are encouraged to build without -custom optimizations. The subsequent system will still run very fast -and be stable at the same time.</para> + <para>The installation of this software is straightforward. Although in many + cases the installation instructions could be made shorter and more generic, + we have opted to provide the full instructions for every package to minimize + the possibilities for mistakes. The key to learning what makes a Linux system + work is to know what each package is used for and why the user (or the system) + needs it. For every installed package, a summary of its contents is given, + followed by concise descriptions of each program and library the package + installed.</para> -<para>The order that packages are installed in this chapter needs to -be strictly followed to ensure that no program accidentally acquires a -path referring to <filename class="directory">/tools</filename> -hard-wired into it. For the same reason, do not compile packages in -parallel. Compiling in parallel may save time (especially on dual-CPU -machines), but it could result in a program containing a hard-wired -path to <filename class="directory">/tools</filename>, which will -cause the program to stop working when that directory is -removed.</para> + <para>If using the compiler optimizations provided in this chapter, please + review the optimization hint at <ulink url="&hints-root;optimization.txt"/>. + Compiler optimizations can make a program run slightly faster, but they may + also cause compilation difficulties and problems when running the program. + If a package refuses to compile when using optimization, try to compile it + without optimization and see if that fixes the problem. Even if the package + does compile when using optimization, there is the risk it may have been + compiled incorrectly because of the complex interactions between the code + and build tools. Also note that the <option>-march</option> and + <option>-mtune</option> options may cause problems with the toolchain packages + (Binutils, GCC and Glibc). The small potential gains achieved in using + compiler optimizations are often outweighed by the risks. First-time builders + of LFS are encouraged to build without custom optimizations. The subsequent + system will still run very fast and be stable at the same time.</para> -<para>Before the installation instructions, each installation page -provides information about the package, including a concise -description of what it contains, approximately how long it will take -to build, how much disk space is required during this building -process, and any other packages needed to successfully build the -package. Following the installation instructions, there is a list of -programs and libraries (along with brief descriptions of these) that -the package installs.</para> + <para>The order that packages are installed in this chapter needs to be + strictly followed to ensure that no program accidentally acquires a path + referring to <filename class="directory">/tools</filename> hard-wired into + it. For the same reason, do not compile packages in parallel. Compiling in + parallel may save time (especially on dual-CPU machines), but it could result + in a program containing a hard-wired path to <filename + class="directory">/tools</filename>, which will cause the program to stop + working when that directory is removed.</para> -<note><para>At this point, you may wish to keep your finished temporary -tools for use in future LFS builds by creating a tarball of the -<filename class="directory">/tools</filename> directory and -storing it in a safe location.</para></note> + <para>Before the installation instructions, each installation page provides + information about the package, including a concise description of what it + contains, approximately how long it will take to build, how much disk space + is required during this building process, and any other packages needed to + successfully build the package. Following the installation instructions, + there is a list of programs and libraries (along with brief descriptions of + these) that the package installs.</para> -</sect1> + <note> + <para>At this point, you may wish to keep your finished temporary + tools for use in future LFS builds by creating a tarball of the + <filename class="directory">/tools</filename> directory and + storing it in a safe location.</para> + </note> +</sect1> |