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