[673b0d8] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[1770019] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[673b0d8] | 3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 4 | %general-entities;
|
---|
| 5 | ]>
|
---|
[81fd230] | 6 | <sect1 id="ch-system-man" role="wrap">
|
---|
[673b0d8] | 7 | <title>Man-&man-version;</title>
|
---|
| 8 | <?dbhtml filename="man.html"?>
|
---|
| 9 |
|
---|
| 10 | <indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm>
|
---|
[6370fa6] | 11 |
|
---|
[a001133] | 12 | <sect2 role="package"><title/>
|
---|
[81fd230] | 13 | <para>The Man package contains programs for finding and viewing manual pages.</para>
|
---|
[5888299] | 14 |
|
---|
[a001133] | 15 | <segmentedlist>
|
---|
| 16 | <segtitle>&buildtime;</segtitle>
|
---|
| 17 | <segtitle>&diskspace;</segtitle>
|
---|
[2b7de70] | 18 | <seglistitem><seg>0.1 SBU</seg><seg>2.9 MB</seg></seglistitem>
|
---|
[a001133] | 19 | </segmentedlist>
|
---|
[673b0d8] | 20 |
|
---|
[81fd230] | 21 | <segmentedlist>
|
---|
[45992ae] | 22 | <segtitle>&dependencies;</segtitle>
|
---|
[81fd230] | 23 | <seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC,
|
---|
| 24 | Glibc, Grep, Make, and Sed</seg></seglistitem>
|
---|
| 25 | </segmentedlist>
|
---|
[a001133] | 26 | </sect2>
|
---|
[3554fa3a] | 27 |
|
---|
[a001133] | 28 | <sect2 role="installation">
|
---|
[73aedd1d] | 29 | <title>Installation of Man</title>
|
---|
| 30 |
|
---|
[81fd230] | 31 | <para>Two adjustments need to be made to the sources of Man.</para>
|
---|
| 32 |
|
---|
[a50efbf] | 33 | <para>The first is a <command>sed</command> substitution to add the
|
---|
[81fd230] | 34 | <parameter>-R</parameter> switch to the <envar>PAGER</envar>
|
---|
| 35 | variable so that escape sequences are properly handled by Less:</para>
|
---|
[73aedd1d] | 36 |
|
---|
[8dffa04] | 37 | <screen><userinput>sed -i 's@-is@&R@g' configure</userinput></screen>
|
---|
[73aedd1d] | 38 |
|
---|
[a50efbf] | 39 | <para>The second is also a <command>sed</command> substitution to comment out the
|
---|
[81fd230] | 40 | <quote>MANPATH /usr/man</quote> line in the
|
---|
| 41 | <filename>man.conf</filename> file to prevent redundant results when
|
---|
| 42 | using programs such as <command>whatis</command>:</para>
|
---|
[73aedd1d] | 43 |
|
---|
[2ec4b60] | 44 | <screen><userinput>sed -i 's@MANPATH./usr/man@#&@g' src/man.conf.in</userinput></screen>
|
---|
[2b7de70] | 45 |
|
---|
[81fd230] | 46 | <para>Prepare Man for compilation:</para>
|
---|
[73aedd1d] | 47 |
|
---|
[e5f8a42] | 48 | <screen><userinput>./configure -confdir=/etc</userinput></screen>
|
---|
[73aedd1d] | 49 |
|
---|
[81fd230] | 50 | <para>The meaning of the configure options:</para>
|
---|
| 51 |
|
---|
| 52 | <variablelist>
|
---|
| 53 | <varlistentry>
|
---|
| 54 | <term><parameter>-confdir=/etc</parameter></term>
|
---|
| 55 | <listitem><para>This tells the <command>man</command> program to look for the
|
---|
| 56 | <filename>man.conf</filename> configuration file in the <filename
|
---|
| 57 | class="directory">/etc</filename> directory.</para></listitem>
|
---|
| 58 | </varlistentry>
|
---|
| 59 | </variablelist>
|
---|
| 60 |
|
---|
[73aedd1d] | 61 | <para>Compile the package:</para>
|
---|
| 62 |
|
---|
| 63 | <screen><userinput>make</userinput></screen>
|
---|
| 64 |
|
---|
[81fd230] | 65 | <para>Install the package:</para>
|
---|
[73aedd1d] | 66 |
|
---|
| 67 | <screen><userinput>make install</userinput></screen>
|
---|
| 68 |
|
---|
[81fd230] | 69 | <note><para>To disable Select Graphic Rendition (SGR) escape
|
---|
| 70 | sequences, edit the <filename>man.conf</filename> file and
|
---|
| 71 | add the <parameter>-c</parameter> switch to
|
---|
| 72 | the <envar>NROFF</envar> variable.</para></note>
|
---|
| 73 |
|
---|
| 74 | <para>If the character set uses 8-bit characters, search for the line
|
---|
| 75 | beginning with <quote>NROFF</quote> in
|
---|
| 76 | <filename>/etc/man.conf</filename>, and verify that it looks as
|
---|
| 77 | follows:</para>
|
---|
| 78 |
|
---|
| 79 | <screen>NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen>
|
---|
| 80 |
|
---|
[57ef036] | 81 | <beginpage/>
|
---|
| 82 |
|
---|
[81fd230] | 83 | <para>Note that <quote>latin1</quote> should be used even if it is not
|
---|
| 84 | the character set of the locale. The reason is that, according to the
|
---|
| 85 | specification, <command>groff</command> has no means of typesetting
|
---|
| 86 | characters outside International Organization for Standards
|
---|
| 87 | (ISO) 8859-1 without some strange escape codes. When formatting manual
|
---|
| 88 | pages, <command>groff</command> thinks that they are in the ISO 8859-1
|
---|
| 89 | encoding and this <parameter>-Tlatin1</parameter> switch tells
|
---|
| 90 | <command>groff</command> to use the same encoding for output. Since
|
---|
| 91 | <command>groff</command> does no recoding of input characters, the
|
---|
| 92 | formatted result is really in the same encoding as input, and therefore
|
---|
| 93 | it is usable as the input for a pager.</para>
|
---|
| 94 |
|
---|
| 95 | <para>This does not solve the problem of a non-working
|
---|
| 96 | <command>man2dvi</command> program for localized manual pages in
|
---|
| 97 | non-ISO 8859-1 locales. Also, it does not work with multibyte
|
---|
| 98 | character sets. The first problem does not currently have a solution.
|
---|
| 99 | The second issue is not of concern because the LFS installation does
|
---|
| 100 | not support multibyte character sets.</para>
|
---|
| 101 |
|
---|
| 102 | <para>Additional information with regards to the compression of
|
---|
| 103 | man and info pages can be found in the BLFS book at
|
---|
[845846e0] | 104 | <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
|
---|
[d72e04a] | 105 |
|
---|
[73aedd1d] | 106 | </sect2>
|
---|
[6370fa6] | 107 |
|
---|
[5888299] | 108 |
|
---|
[c6cb3aa] | 109 | <sect2 id="contents-man" role="content"><title>Contents of Man</title>
|
---|
[673b0d8] | 110 |
|
---|
[81fd230] | 111 | <segmentedlist>
|
---|
| 112 | <segtitle>Installed programs</segtitle>
|
---|
| 113 | <seglistitem><seg>apropos, makewhatis, man,
|
---|
| 114 | man2dvi, man2html, and whatis</seg></seglistitem>
|
---|
| 115 | </segmentedlist>
|
---|
| 116 |
|
---|
| 117 | <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 118 | <?dbfo list-presentation="list"?>
|
---|
[8f97096] | 119 | <?dbhtml list-presentation="table"?>
|
---|
[81fd230] | 120 |
|
---|
| 121 | <varlistentry id="apropos">
|
---|
| 122 | <term><command>apropos</command></term>
|
---|
| 123 | <listitem>
|
---|
| 124 | <para>Searches the whatis database and displays the short descriptions
|
---|
| 125 | of system commands that contain a given string</para>
|
---|
| 126 | <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
|
---|
| 127 | </listitem>
|
---|
| 128 | </varlistentry>
|
---|
| 129 |
|
---|
| 130 | <varlistentry id="makewhatis">
|
---|
| 131 | <term><command>makewhatis</command></term>
|
---|
| 132 | <listitem>
|
---|
| 133 | <para>Builds the whatis database; it reads all the manual pages in the
|
---|
| 134 | manpath and writes the name and a short description in the whatis
|
---|
| 135 | database for each page</para>
|
---|
| 136 | <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
|
---|
| 137 | </listitem>
|
---|
| 138 | </varlistentry>
|
---|
| 139 |
|
---|
| 140 | <varlistentry id="man">
|
---|
| 141 | <term><command>man</command></term>
|
---|
| 142 | <listitem>
|
---|
| 143 | <para>Formats and displays the requested on-line manual page</para>
|
---|
| 144 | <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
|
---|
| 145 | </listitem>
|
---|
| 146 | </varlistentry>
|
---|
| 147 |
|
---|
| 148 | <varlistentry id="man2dvi">
|
---|
| 149 | <term><command>man2dvi</command></term>
|
---|
| 150 | <listitem>
|
---|
| 151 | <para>Converts a manual page into dvi format</para>
|
---|
| 152 | <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
|
---|
| 153 | </listitem>
|
---|
| 154 | </varlistentry>
|
---|
| 155 |
|
---|
| 156 | <varlistentry id="man2html">
|
---|
| 157 | <term><command>man2html</command></term>
|
---|
| 158 | <listitem>
|
---|
| 159 | <para>Converts a manual page into HTML</para>
|
---|
| 160 | <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
|
---|
| 161 | </listitem>
|
---|
| 162 | </varlistentry>
|
---|
| 163 |
|
---|
| 164 | <varlistentry id="whatis">
|
---|
| 165 | <term><command>whatis</command></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>Searches the whatis database and displays the short descriptions
|
---|
| 168 | of system commands that contain the given keyword as a separate
|
---|
| 169 | word</para>
|
---|
| 170 | <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 | </variablelist>
|
---|
[673b0d8] | 174 |
|
---|
| 175 | </sect2>
|
---|
| 176 |
|
---|
| 177 | </sect1>
|
---|
[81fd230] | 178 |
|
---|