r5462 - branches/cross-lfs/BOOK/final-system/common

manuel at linuxfromscratch.org manuel at linuxfromscratch.org
Fri May 27 15:00:55 PDT 2005


Author: manuel
Date: 2005-05-27 16:00:54 -0600 (Fri, 27 May 2005)
New Revision: 5462

Modified:
   branches/cross-lfs/BOOK/final-system/common/man.xml
Log:
Indented man.xml

Modified: branches/cross-lfs/BOOK/final-system/common/man.xml
===================================================================
--- branches/cross-lfs/BOOK/final-system/common/man.xml	2005-05-27 19:50:00 UTC (rev 5461)
+++ branches/cross-lfs/BOOK/final-system/common/man.xml	2005-05-27 22:00:54 UTC (rev 5462)
@@ -7,174 +7,204 @@
 ]>
 
 <sect1 id="ch-system-man" role="wrap">
-<title>Man-&man-version;</title>
-<?dbhtml filename="man.html"?>
+  <?dbhtml filename="man.html"?>
 
-<indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm>
+  <title>Man-&man-version;</title>
 
-<sect2 role="package"><title/>
-<para>The Man package contains programs for finding and viewing manual pages.</para>
+  <indexterm zone="ch-system-man">
+    <primary sortas="a-Man">Man</primary>
+  </indexterm>
 
-<segmentedlist>
-<segtitle>&buildtime;</segtitle>
-<segtitle>&diskspace;</segtitle>
-<seglistitem><seg>0.1 SBU</seg><seg>1.9MB</seg></seglistitem>
-</segmentedlist>
+  <sect2 role="package">
+    <title/>
 
-<segmentedlist>
-<segtitle>&dependencies;</segtitle>
-<seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC,
-Glibc, Grep, Make, and Sed</seg></seglistitem>
-</segmentedlist>
-</sect2>
+    <para>The Man package contains programs for finding and viewing manual
+    pages.</para>
 
-<sect2 role="installation">
-<title>Installation of Man</title>
+    <segmentedlist>
+      <segtitle>&buildtime;</segtitle>
+      <segtitle>&diskspace;</segtitle>
 
-<para>A few adjustments need to be made to the sources of Man.</para>
+      <seglistitem>
+        <seg>Not checked yet</seg>
+        <seg>Not checked yet</seg>
+      </seglistitem>
+    </segmentedlist>
 
-<para>This a sed substitution to add the
-<parameter>-R</parameter> switch to the <envar>PAGER</envar>
-variable so that escape sequences are properly handled by Less:</para>
+    <segmentedlist>
+      <segtitle>&dependencies;</segtitle>
 
+      <seglistitem>
+        <seg>Bash, Binutils, Coreutils, Gawk, GCC, Glibc, Grep,
+        Make, and Sed</seg>
+      </seglistitem>
+    </segmentedlist>
+
+  </sect2>
+
+  <sect2 role="installation">
+    <title>Installation of Man</title>
+
+    <para>A few adjustments need to be made to the sources of Man.</para>
+
+    <para>This a sed substitution to add the <option>-R</option> switch to
+    the <envar>PAGER</envar> variable so that escape sequences are properly
+    handled by Less:</para>
+
 <screen><userinput>sed -i 's at -is@&R at g' configure</userinput></screen>
 
-<para>This a sed substitution to comment out the
-<quote>MANPATH /usr/man</quote> line in the
-<filename>man.conf</filename> file to prevent redundant results when
-using programs such as <command>whatis</command>:</para>
+    <para>This a sed substitution to comment out the
+    <quote>MANPATH /usr/man</quote> line in the <filename>man.conf</filename>
+    file to prevent redundant results when using programs such as
+    <command>whatis</command>:</para>
 
 <screen><userinput>sed -i 's at MANPATH./usr/man@#&@g' src/man.conf.in</userinput></screen>
- 
-<para>Prepare Man for compilation:</para>
 
+    <para>Prepare Man for compilation:</para>
+
 <screen><userinput>./configure -confdir=/etc</userinput></screen>
 
-<para>The meaning of the configure options:</para>
+    <variablelist>
+      <title>The meaning of the configure options:</title>
 
-<variablelist>
-<varlistentry>
-<term><parameter>-confdir=/etc</parameter></term>
-<listitem><para>This tells the <command>man</command> program to look for the
-<filename>man.conf</filename> configuration file in the <filename
-class="directory">/etc</filename> directory.</para></listitem>
-</varlistentry>
-</variablelist>
+      <varlistentry>
+      <term><parameter>-confdir=/etc</parameter></term>
+      <listitem>
+        <para>This tells the <command>man</command> program to look for the
+        <filename>man.conf</filename> configuration file in the <filename
+        class="directory">/etc</filename> directory.</para>
+      </listitem>
+      </varlistentry>
+    </variablelist>
 
-<para>Compile the package:</para>
+    <para>Compile the package:</para>
 
 <screen><userinput>make</userinput></screen>
 
-<para>Install the package:</para>
+    <para>Install the package:</para>
 
 <screen><userinput>make install</userinput></screen>
 
-<note><para>To disable Select Graphic Rendition (SGR) escape
-sequences, edit the <filename>man.conf</filename> file and
-add the <parameter>-c</parameter> switch to
-the <envar>NROFF</envar> variable.</para></note>
+    <note>
+      <para>To disable Select Graphic Rendition (SGR) escape sequences, edit
+      the <filename>man.conf</filename> file and add the <option>-c</option>
+      switch to the <envar>NROFF</envar> variable.</para>
+    </note>
 
-<para>If the character set uses 8-bit characters, search for the line
-beginning with <quote>NROFF</quote> in
-<filename>/etc/man.conf</filename>, and verify that it looks as
-follows:</para>
+    <para>If the character set uses 8-bit characters, search for the line
+    beginning with <quote>NROFF</quote> in <filename>/etc/man.conf</filename>,
+    and verify that it looks as follows:</para>
 
 <screen>NROFF  /usr/bin/nroff -Tlatin1 -mandoc</screen>
 
-<para>Note that <quote>latin1</quote> should be used even if it is not
-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
-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
-<command>groff</command> does no recoding of input characters, the
-formatted result is really in the same encoding as input, and therefore
-it is usable as the input for a pager.</para>
+    <para>Note that <quote>latin1</quote> should be used even if it is not
+    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 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
+    <command>groff</command> does no recoding of input characters, the f
+    ormatted 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
-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
-not support multibyte character sets.</para>
+    <para>This does not solve the problem of a non-working
+    <command>man2dvi</command> program for localized manual 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
+    not support multibyte character sets.</para>
 
-<para>Additional information with regards to the compression of
-man and info pages can be found in the BLFS book at
-<ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
+    <para>Additional information with regards to the compression of
+    man and info pages can be found in the BLFS book at
+    <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
 
+  </sect2>
 
-</sect2>
+  <sect2 id="contents-man" role="content">
+    <title>Contents of Man</title>
 
+    <segmentedlist>
+      <segtitle>Installed programs</segtitle>
 
-<sect2 id="contents-man" role="content"><title>Contents of Man</title>
+      <seglistitem>
+        <seg>apropos, makewhatis, man, man2dvi, man2html, and whatis</seg>
+      </seglistitem>
+    </segmentedlist>
 
-<segmentedlist>
-<segtitle>Installed programs</segtitle>
-<seglistitem><seg>apropos, makewhatis, man,
-man2dvi, man2html, and whatis</seg></seglistitem>
-</segmentedlist>
+    <variablelist>
+      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
+      <?dbfo list-presentation="list"?>
+      <?dbhtml list-presentation="table"?>
 
-<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
-<?dbfo list-presentation="list"?>
-<?dbhtml list-presentation="table"?>
+      <varlistentry id="apropos">
+        <term><command>apropos</command></term>
+        <listitem>
+          <para>Searches the whatis 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>
+      </varlistentry>
 
-<varlistentry id="apropos">
-<term><command>apropos</command></term>
-<listitem>
-<para>Searches the whatis 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>
-</varlistentry>
+      <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>
+          <indexterm zone="ch-system-man makewhatis">
+            <primary sortas="b-makewhatis">makewhatis</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
 
-<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>
-<indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
-</listitem>
-</varlistentry>
+      <varlistentry id="man">
+        <term><command>man</command></term>
+        <listitem>
+          <para>Formats and displays the requested on-line manual page</para>
+          <indexterm zone="ch-system-man man">
+            <primary sortas="b-man">man</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
 
-<varlistentry id="man">
-<term><command>man</command></term>
-<listitem>
-<para>Formats and displays the requested on-line manual page</para>
-<indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
-</listitem>
-</varlistentry>
+      <varlistentry id="man2dvi">
+        <term><command>man2dvi</command></term>
+        <listitem>
+          <para>Converts a manual page into dvi format</para>
+          <indexterm zone="ch-system-man man2dvi">
+            <primary sortas="b-man2dvi">man2dvi</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
 
-<varlistentry id="man2dvi">
-<term><command>man2dvi</command></term>
-<listitem>
-<para>Converts a manual page into dvi format</para>
-<indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
-</listitem>
-</varlistentry>
+      <varlistentry id="man2html">
+        <term><command>man2html</command></term>
+        <listitem>
+          <para>Converts a manual page into HTML</para>
+          <indexterm zone="ch-system-man man2html">
+            <primary sortas="b-man2html">man2html</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
 
-<varlistentry id="man2html">
-<term><command>man2html</command></term>
-<listitem>
-<para>Converts a manual page into HTML</para>
-<indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
-</listitem>
-</varlistentry>
+      <varlistentry id="whatis">
+        <term><command>whatis</command></term>
+        <listitem>
+          <para>Searches the whatis 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>
+        </listitem>
+      </varlistentry>
 
-<varlistentry id="whatis">
-<term><command>whatis</command></term>
-<listitem>
-<para>Searches the whatis 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>
-</listitem>
-</varlistentry>
-</variablelist>
+    </variablelist>
 
-</sect2>
+  </sect2>
 
 </sect1>
-




More information about the lfs-book mailing list