diff --git a/chapter01/changelog.xml b/chapter01/changelog.xml index 608b90a45..dc4a7c3e2 100644 --- a/chapter01/changelog.xml +++ b/chapter01/changelog.xml @@ -87,6 +87,11 @@ First a summary, then a detailed log. +July 4th, 2005 [archaic]: Brought (hopefully) all references of +man/info pages into conformity. Man page conformity was based on if referring to +a specific man page or man pages in general. Updated typography to reflect +this. + July 2nd, 2005 [archaic]: Several minor wording changes in chapters 8 and 9 (matt). Also removed the paragraph about compressing kernel modules as it is hint material at best. diff --git a/chapter02/creatingpartition.xml b/chapter02/creatingpartition.xml index eca35bd95..181513a13 100644 --- a/chapter02/creatingpartition.xml +++ b/chapter02/creatingpartition.xml @@ -42,8 +42,8 @@ one. line option naming the hard disk on which the new partition will be created—for example /dev/hda for the primary Integrated Drive Electronics (IDE) disk. Create a Linux native -partition and a swap partition, if needed. Please refer to the man -pages of cfdisk or fdisk if you +partition and a swap partition, if needed. Please refer to +cfdisk(8) or fdisk(8) if you do not yet know how to use the programs. Remember the designation of the new partition (e.g., diff --git a/chapter04/addinguser.xml b/chapter04/addinguser.xml index d5ecc8336..67b9f44d6 100644 --- a/chapter04/addinguser.xml +++ b/chapter04/addinguser.xml @@ -83,8 +83,8 @@ following substitute user command: The - instructs su to start a login shell as opposed to a non-login shell. -The difference between these two types of shells can be found in detail in the -man and info pages for Bash. +The difference between these two types of shells can be found in detail in +bash(1) and info bash. diff --git a/chapter04/creatingtoolsdir.xml b/chapter04/creatingtoolsdir.xml index b6af96d15..15d1cbe4b 100644 --- a/chapter04/creatingtoolsdir.xml +++ b/chapter04/creatingtoolsdir.xml @@ -31,8 +31,8 @@ well: ln -s $LFS/tools / The above command is correct. The ln command has -a few syntactic variations, so be sure to check the info and -man pages before reporting what you may think is an +a few syntactic variations, so be sure to check info coreutils ln and +ln(1) before reporting what you may think is an error. The created symlink enables the toolchain to be compiled so that diff --git a/chapter05/flex.xml b/chapter05/flex.xml index 6e71c7b60..878e05263 100644 --- a/chapter05/flex.xml +++ b/chapter05/flex.xml @@ -33,7 +33,7 @@ following patch: patch -Np1 -i ../flex-&flex-version;-debian_fixes-3.patch The GNU autotools will detect that the Flex source code has been -modified by the previous patch and tries to update the manual page +modified by the previous patch and tries to update the man page accordingly. This does not work on many systems, and the default page is fine, so make sure it does not get regenerated: diff --git a/chapter05/toolchaintechnotes.xml b/chapter05/toolchaintechnotes.xml index 4f73ab9b0..ececb2a11 100644 --- a/chapter05/toolchaintechnotes.xml +++ b/chapter05/toolchaintechnotes.xml @@ -198,8 +198,8 @@ included in the executable, resulting in a rather bulky program. When a program is dynamically linked, it includes a reference to the dynamic linker, the name of the library, and the name of the function, resulting in a much smaller executable. A third option is to use the -programming interface of the dynamic linker (see the -dlopen man page for more information). +programming interface of the dynamic linker (see dlopen(3) +for more information). Dynamic linking is the default on Linux and has three major advantages over static linking. First, only one copy of the executable diff --git a/chapter06/flex.xml b/chapter06/flex.xml index e56ebc776..a051e5bf7 100644 --- a/chapter06/flex.xml +++ b/chapter06/flex.xml @@ -34,7 +34,7 @@ GCC, Gettext, Glibc, Grep, M4, Make, and Sed patch -Np1 -i ../flex-&flex-version;-debian_fixes-3.patch The GNU autotools detects that the Flex source code has been -modified by the previous patch and tries to update the manual page +modified by the previous patch and tries to update the man page accordingly. This does not work correctly on many systems, and the default page is fine, so make sure it does not get regenerated: diff --git a/chapter06/man-pages.xml b/chapter06/man-pages.xml index 70f8eb9e5..cb60065f4 100644 --- a/chapter06/man-pages.xml +++ b/chapter06/man-pages.xml @@ -10,7 +10,7 @@ Man-pages -<para>The Man-pages package contains over 1,200 manual pages.</para> +<para>The Man-pages package contains over 1,200 man pages.</para> <segmentedlist> <segtitle>&buildtime;</segtitle> @@ -38,19 +38,19 @@ <segmentedlist> <segtitle>Installed files</segtitle> -<seglistitem><seg>various manual pages</seg></seglistitem> +<seglistitem><seg>various man pages</seg></seglistitem> </segmentedlist> <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> <?dbfo list-presentation="list"?> <?dbhtml list-presentation="table"?> -<varlistentry id="manual-pages"> -<term><filename>manual pages</filename></term> +<varlistentry id="man-pages"> +<term><filename>man pages</filename></term> <listitem> <para>Describe the C and C++ functions, important device files, and significant configuration files</para> -<indexterm zone="ch-system-man-pages manual-pages"><primary sortas="e-manual-pages">manual pages</primary></indexterm> +<indexterm zone="ch-system-man-pages man-pages"><primary sortas="e-man-pages">man pages</primary></indexterm> </listitem> </varlistentry> </variablelist> diff --git a/chapter06/man.xml b/chapter06/man.xml index 57cf3e6a2..72bb784b3 100644 --- a/chapter06/man.xml +++ b/chapter06/man.xml @@ -10,7 +10,7 @@ <indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm> <sect2 role="package"><title/> -<para>The Man package contains programs for finding and viewing manual pages.</para> +<para>The Man package contains programs for finding and viewing man pages.</para> <segmentedlist> <segtitle>&buildtime;</segtitle> @@ -86,7 +86,7 @@ and verify that it matches the following:</para> the character set of the locale. The reason is that, according to the specification, <command>groff</command> has no means of typesetting characters outside International Organization for Standards -(ISO) 8859-1 without some strange escape codes. When formatting manual +(ISO) 8859-1 without some strange escape codes. When formatting man pages, <command>groff</command> thinks that they are in the ISO 8859-1 encoding and this <parameter>-Tlatin1</parameter> switch tells <command>groff</command> to use the same encoding for output. Since @@ -95,7 +95,7 @@ formatted result is really in the same encoding as input, and therefore it is usable as the input for a pager.</para> <para>This does not solve the problem of a non-working -<command>man2dvi</command> program for localized manual pages in +<command>man2dvi</command> program for localized man pages in non-ISO 8859-1 locales. Also, it does not work with multibyte character sets. The first problem does not currently have a solution. The second issue is not of concern because the LFS installation does @@ -123,7 +123,7 @@ man2dvi, man2html, and whatis</seg></seglistitem> <varlistentry id="apropos"> <term><command>apropos</command></term> <listitem> -<para>Searches the whatis database and displays the short descriptions +<para>Searches the <command>whatis</command> database and displays the short descriptions of system commands that contain a given string</para> <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm> </listitem> @@ -132,9 +132,9 @@ of system commands that contain a given string</para> <varlistentry id="makewhatis"> <term><command>makewhatis</command></term> <listitem> -<para>Builds the whatis database; it reads all the manual pages in the -manpath and writes the name and a short description in the whatis -database for each page</para> +<para>Builds the <command>whatis</command> database; it reads all the man pages +in the <envar>MANPATH</envar> and writes the name and a short description in the +<command>whatis</command> database for each page</para> <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm> </listitem> </varlistentry> @@ -142,7 +142,7 @@ database for each page</para> <varlistentry id="man"> <term><command>man</command></term> <listitem> -<para>Formats and displays the requested on-line manual page</para> +<para>Formats and displays the requested on-line man page</para> <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm> </listitem> </varlistentry> @@ -150,7 +150,7 @@ database for each page</para> <varlistentry id="man2dvi"> <term><command>man2dvi</command></term> <listitem> -<para>Converts a manual page into dvi format</para> +<para>Converts a man page into dvi format</para> <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm> </listitem> </varlistentry> @@ -158,7 +158,7 @@ database for each page</para> <varlistentry id="man2html"> <term><command>man2html</command></term> <listitem> -<para>Converts a manual page into HTML</para> +<para>Converts a man page into HTML</para> <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm> </listitem> </varlistentry> @@ -166,7 +166,7 @@ database for each page</para> <varlistentry id="whatis"> <term><command>whatis</command></term> <listitem> -<para>Searches the whatis database and displays the short descriptions +<para>Searches the <command>whatis</command> database and displays the short descriptions of system commands that contain the given keyword as a separate word</para> <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm> diff --git a/chapter06/texinfo.xml b/chapter06/texinfo.xml index 46cc633c7..faa8950e9 100644 --- a/chapter06/texinfo.xml +++ b/chapter06/texinfo.xml @@ -11,7 +11,7 @@ <sect2 role="package"><title/> <para>The Texinfo package contains programs for reading, writing, and -converting Info documents.</para> +converting info pages.</para> <segmentedlist> <segtitle>&buildtime;</segtitle> @@ -63,7 +63,7 @@ later.</para></listitem> list of menu entries. The file is located at <filename>/usr/share/info/dir</filename>. Unfortunately, due to occasional problems in the Makefiles of various packages, it can -sometimes get out of step with the Info manuals installed on the +sometimes get out of sync with the info pages installed on the system. If the <filename>/usr/share/info/dir</filename> file ever needs to be recreated, the following optional commands will accomplish the task:</para> @@ -93,10 +93,9 @@ makeinfo, texi2dvi, and texindex</seg></seglistitem> <varlistentry id="info"> <term><command>info</command></term> <listitem> -<para>Used to read Info documents which are similar to man -pages, but often go much deeper than just explaining all the command -line options. For example, compare <command>man bison</command> and -<command>info bison</command>.</para> +<para>Used to read info pages which are similar to man pages, but often go much +deeper than just explaining all the available command line options. For example, +compare <command>man bison</command> and <command>info bison</command>.</para> <indexterm zone="ch-system-texinfo info"><primary sortas="b-info">info</primary></indexterm> </listitem> </varlistentry> @@ -113,8 +112,8 @@ binary format</para> <varlistentry id="install-info"> <term><command>install-info</command></term> <listitem> -<para>Used to install Info files; it updates entries in the Info index -file</para> +<para>Used to install info pages; it updates entries in the +<command>info</command> index file</para> <indexterm zone="ch-system-texinfo install-info"><primary sortas="b-install-info">install-info</primary></indexterm> </listitem> </varlistentry> @@ -123,7 +122,7 @@ file</para> <term><command>makeinfo</command></term> <listitem> <para>Translates the given Texinfo source documents into -Info files, plain text, or HTML</para> +info pages, plain text, or HTML</para> <indexterm zone="ch-system-texinfo makeinfo"><primary sortas="b-makeinfo">makeinfo</primary></indexterm> </listitem> </varlistentry> diff --git a/chapter06/util-linux.xml b/chapter06/util-linux.xml index de2a8d170..2daa05c85 100644 --- a/chapter06/util-linux.xml +++ b/chapter06/util-linux.xml @@ -607,7 +607,7 @@ escape sequences indicating underlining for the terminal in use</para> <varlistentry id="whereis"> <term><command>whereis</command></term> <listitem> -<para>Reports the location of binary, the source, and the manual page +<para>Reports the location of the binary, source, and man page for the given command</para> <indexterm zone="ch-system-util-linux whereis"><primary sortas="b-whereis">whereis</primary></indexterm> </listitem> diff --git a/chapter07/console.xml b/chapter07/console.xml index 71d9f7c1a..218123f89 100644 --- a/chapter07/console.xml +++ b/chapter07/console.xml @@ -26,8 +26,8 @@ url="http://www.tldp.org/HOWTO/HOWTO-INDEX/other-lang.html"/>. A pre-made countries was installed with the LFS-Bootscripts package, so the relevant section can be uncommented if the country is supported. If still in doubt, look in the <filename class="directory">/usr/share/kbd</filename> directory for valid -keymaps and screen fonts. Read the <command>loadkeys</command> and -<command>setfont</command> manual pages and determine the correct arguments for +keymaps and screen fonts. Read <filename>loadkeys(1)</filename> and +<filename>setfont(8)</filename> to determine the correct arguments for these programs. Once decided, create the configuration file with the following command:</para> diff --git a/chapter07/usage.xml b/chapter07/usage.xml index 3f7862daa..4ff169ee8 100644 --- a/chapter07/usage.xml +++ b/chapter07/usage.xml @@ -20,7 +20,7 @@ own way of doing things, but it respects generally accepted standards.</para> <para>SysVinit (which will be referred to as <quote>init</quote> from now on) works using a run-levels scheme. There are seven (numbered 0 to 6) run-levels (actually, there are more run-levels, but they are for special cases and are -generally not used. The init manual page describes those details), and each one +generally not used. See <filename>init(8)</filename> for more details), and each one of those corresponds to the actions the computer is supposed to perform when it starts up. The default run-level is 3. Here are the descriptions of the different run-levels as they are implemented:</para> diff --git a/chapter08/kernel.xml b/chapter08/kernel.xml index 8fe6e2564..11cb5ba9d 100644 --- a/chapter08/kernel.xml +++ b/chapter08/kernel.xml @@ -93,9 +93,8 @@ with gcc 2.95.x.</para></note> <para>If using kernel modules, an <filename>/etc/modprobe.conf</filename> file may be needed. Information pertaining to modules and kernel configuration is located in the kernel documentation in the <filename -class="directory">linux-&linux-version;/Documentation</filename> directory. The -<emphasis>modprobe.conf</emphasis> <command>man</command> page may also be of -interest.</para> +class="directory">linux-&linux-version;/Documentation</filename> directory. +Also, <filename>modprobe.conf(5)</filename> may be of interest.</para> <para>Be very careful when reading other documentation relating to kernel modules because it usually applies to 2.4.x kernels only. As far as we know, diff --git a/prologue/typography.xml b/prologue/typography.xml index 3a74378a4..6f75e08b0 100644 --- a/prologue/typography.xml +++ b/prologue/typography.xml @@ -54,5 +54,24 @@ Therefore, this entire section is generally typed as seen.</para> <para>This format is used to encapsulate text that is not to be typed as seen<phrase condition="html"> or copy-and-pasted</phrase>.</para> +<para><filename>passwd(5)</filename></para> + +<para>This format is used to refer to a specific manual page (hereinafter +referred to simply as a <quote>man</quote> page). The number inside parentheses +indicates a specific section inside of <command>man</command>. For example, +<command>passwd</command> has two man pages. Per LFS installation instructions, +those two man pages will be located at +<filename>/usr/share/man/man1/passwd.1</filename> and +<filename>/usr/share/man/man5/passwd.5</filename>. Both man pages have different +information in them. When the book uses <filename>passwd(5)</filename> it is +specifically referring to <filename>/usr/share/man/man5/passwd.5</filename>. +<command>man passwd</command> will print the first man page it finds that +matches <quote>passwd</quote>, which will be +<filename>/usr/share/man/man1/passwd.1</filename>. For this example, you will +need to run <command>man 5 passwd</command> in order to read the specific page +being referred to. It should be noted that most man pages do not have duplicate +page names in different sections. Therefore, <command>man <replaceable>[program +name]</replaceable></command> is generally sufficient.</para> + </sect1>