Changeset a1a7f4f

Timestamp:

07/04/2005 09:32:47 PM (19 years ago)

Author:

Archaic <archaic@…>

Branches:

10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc

Children:

afe7ecef

Parents:

ae31883

Message:

Brought (hopefully) all references of man/info pages into conformity. Updated typography to reflect this.

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

Files:

• chapter01/changelog.xml (modified) (1 diff)
• chapter02/creatingpartition.xml (modified) (1 diff)
• chapter04/addinguser.xml (modified) (1 diff)
• chapter04/creatingtoolsdir.xml (modified) (1 diff)
• chapter05/flex.xml (modified) (1 diff)
• chapter05/toolchaintechnotes.xml (modified) (1 diff)
• chapter06/flex.xml (modified) (1 diff)
• chapter06/man-pages.xml (modified) (3 diffs)
• chapter06/man.xml (modified) (9 diffs)
• chapter06/texinfo.xml (modified) (5 diffs)
• chapter06/util-linux.xml (modified) (1 diff)
• chapter07/console.xml (modified) (1 diff)
• chapter07/usage.xml (modified) (1 diff)
• chapter08/kernel.xml (modified) (1 diff)
• prologue/typography.xml (modified) (1 diff)

chapter01/changelog.xml

@@ -92 +92 @@
 </listitem>
 
+<listitem><para>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.</para></listitem>
+
 <listitem><para>July  2nd, 2005 [matt]: Re-added the inetutils kernel-headers
 patch that erroneously got dropped during r5402.</para></listitem>

chapter02/creatingpartition.xml

@@ -42 +42 @@
 created&mdash;for example <filename class="devicefile">/dev/hda</filename> 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 <command>cfdisk</command> or <command>fdisk</command> if you
+partition and a swap partition, if needed. Please refer to 
+<filename>cfdisk(8)</filename> or <filename>fdisk(8)</filename> if you
 do not yet know how to use the programs.</para>
 

chapter04/addinguser.xml

@@ -84 +84 @@
 <para>The <quote><parameter>-</parameter></quote> instructs
 <command>su</command> 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
-<command>man</command> and <command>info</command> pages for Bash.</para>
+The difference between these two types of shells can be found in detail in
+<filename>bash(1)</filename> and <command>info bash</command>.</para>
 
 </sect1>

chapter04/creatingtoolsdir.xml

@@ -32 +32 @@
 
 <note><para>The above command is correct. The <command>ln</command> command has
-a few syntactic variations, so be sure to check the <command>info</command> and
-<command>man</command> pages before reporting what you may think is an
+a few syntactic variations, so be sure to check <command>info coreutils ln</command> and
+<filename>ln(1)</filename> before reporting what you may think is an
 error.</para></note>
 

chapter05/flex.xml

@@ -36 +36 @@
 
 <para>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:</para>

chapter05/toolchaintechnotes.xml

@@ -195 +195 @@
 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
-<emphasis>dlopen</emphasis> man page for more information).</para>
+programming interface of the dynamic linker (see <filename>dlopen(3)</filename>
+for more information).</para>
 
 <para>Dynamic linking is the default on Linux and has three major

chapter06/flex.xml

@@ -37 +37 @@
 
 <para>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:</para>

chapter06/man-pages.xml

@@ -13 +13 @@
 
 <sect2 role="package"><title/>
-<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>
@@ -41 +41 @@
 <segmentedlist>
 <segtitle>Installed files</segtitle>
-<seglistitem><seg>various manual pages</seg></seglistitem>
+<seglistitem><seg>various man pages</seg></seglistitem>
 </segmentedlist>
 
@@ -48 +48 @@
 <?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>

chapter06/man.xml

@@ -13 +13 @@
 
 <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>
@@ -87 +87 @@
 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
@@ -96 +96 @@
 
 <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.
@@ -124 +124 @@
 <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>
@@ -133 +133 @@
 <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>
@@ -143 +143 @@
 <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>
@@ -151 +151 @@
 <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>
@@ -159 +159 @@
 <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>
@@ -167 +167 @@
 <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>

chapter06/texinfo.xml

@@ -14 +14 @@
 <sect2 role="package"><title/>
 <para>The Texinfo package contains programs for reading, writing, and
-converting Info documents.</para>
+converting info pages.</para>
 
 <segmentedlist>
@@ -66 +66 @@
 <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
@@ -94 +94 @@
 <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>
@@ -114 +113 @@
 <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>
@@ -124 +123 @@
 <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>

chapter06/util-linux.xml

@@ -610 +610 @@
 <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>

chapter07/console.xml

@@ -27 +27 @@
 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>

chapter07/usage.xml

@@ -21 +21 @@
 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

chapter08/kernel.xml

@@ -92 +92 @@
 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

prologue/typography.xml

@@ -55 +55 @@
 as seen or copy-and-pasted.</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>