source: BOOK/final-system/common/man.xml@ a323f57

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since a323f57 was ea24374, checked in by Chris Staub <chris@…>, 18 years ago

Added command to man instructions to comment out /usr/local/man

  • Property mode set to 100644
File size: 7.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-man" role="wrap">
9 <?dbhtml filename="man.html"?>
10
11 <title>Man-&man-version;</title>
12
13 <indexterm zone="ch-system-man">
14 <primary sortas="a-Man">Man</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Man package contains programs for finding and viewing man
21 pages.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Man</title>
27
28 <para os="a">A few adjustments need to be made to the sources of Man.</para>
29
30 <para os="b">First, a <command>sed</command> substitution is
31 needed to add the <option>-R</option> switch to the
32 <envar>PAGER</envar> variable so that escape sequences are
33 properly handled by Less:</para>
34
35<screen os="c"><userinput>sed -i 's@-is@&amp;R@g' configure</userinput></screen>
36
37 <para os="d">Another <command>sed</command> substitution comments out the
38 <quote>MANPATH /usr/man</quote> and <quote>MANPATH /usr/local/man</quote>
39 lines in the <filename>man.conf</filename> file to prevent redundant
40 results when using programs such as <command>whatis</command>:</para>
41
42<screen os="e"><userinput>sed -i 's@MANPATH./usr/man@#&amp;@g' src/man.conf.in
43sed -i 's@MANPATH./usr/local/man@#&amp;@g' src/man.conf.in</userinput></screen>
44
45 <para os="h">Prepare Man for compilation:</para>
46
47<screen os="i"><userinput>./configure -confdir=/etc</userinput></screen>
48
49 <variablelist os="j">
50 <title>The meaning of the configure options:</title>
51
52 <varlistentry>
53 <term><parameter>-confdir=/etc</parameter></term>
54 <listitem>
55 <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>
58 </listitem>
59 </varlistentry>
60 </variablelist>
61
62 <para os="k">Compile the package:</para>
63
64<screen os="l"><userinput>make</userinput></screen>
65
66 <para os="m">This package does not come with a test suite.</para>
67
68 <para os="n">Install the package:</para>
69
70<screen os="o"><userinput>make install</userinput></screen>
71
72 <note os="p">
73 <para>If you will be working on a terminal that does not support
74 text attributes such as color and bold, you can disable Select
75 Graphic Rendition (SGR) escape sequences by editing the
76 <filename>man.conf</filename> file and adding the <option>-c</option>
77 option to the <envar>NROFF</envar> variable. If you use multiple
78 terminal types for one computer it may be better to selectively add
79 the <envar>GROFF_NO_SGR</envar> environment variable for the terminals
80 that do not support SGR.</para>
81 </note>
82
83 <para os="q">If the character set of the locale uses 8-bit characters, search
84 for the line beginning with <quote>NROFF</quote> in
85 <filename>/etc/man.conf</filename>, and verify that it matches the
86 following:</para>
87
88<screen os="r">NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen>
89
90 <para os="s">Note that <quote>latin1</quote> should be used even if it is not
91 the character set of the locale. The reason is that, according to the
92 specification, <command>groff</command> has no means of typesetting
93 characters outside International Organization for Standards (ISO) 8859-1
94 without some strange escape codes. When formatting man pages,
95 <command>groff</command> thinks that they are in the ISO 8859-1 encoding
96 and this <parameter>-Tlatin1</parameter> switch tells
97 <command>groff</command> to use the same encoding for output. Since
98 <command>groff</command> does no recoding of input characters, the f
99 ormatted result is really in the same encoding as input, and therefore
100 it is usable as the input for a pager.</para>
101
102 <para os="t">This does not solve the problem of a non-working
103 <command>man2dvi</command> program for localized man pages in
104 non-ISO 8859-1 locales. Also, it does not work with multibyte
105 character sets. The first problem does not currently have a solution.
106 The second issue is not of concern because the CLFS installation does
107 not support multibyte character sets.</para>
108
109 <para os="u">Additional information with regards to the compression of
110 man and info pages can be found in the BLFS book at
111 <ulink url="&blfs-root;view/svn/postlfs/compressdoc.html"/>.</para>
112
113 </sect2>
114
115 <sect2 id="contents-man" role="content">
116 <title>Contents of Man</title>
117
118 <segmentedlist>
119 <segtitle>Installed programs</segtitle>
120
121 <seglistitem>
122 <seg>apropos, makewhatis, man, man2dvi, man2html, and whatis</seg>
123 </seglistitem>
124 </segmentedlist>
125
126 <variablelist>
127 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
128 <?dbfo list-presentation="list"?>
129 <?dbhtml list-presentation="table"?>
130
131 <varlistentry id="apropos">
132 <term><command>apropos</command></term>
133 <listitem>
134 <para>Searches the <command>whatis</command> database and
135 displays the short descriptions of system commands that contain
136 a given string</para>
137 <indexterm zone="ch-system-man apropos">
138 <primary sortas="b-apropos">apropos</primary>
139 </indexterm>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry id="makewhatis">
144 <term><command>makewhatis</command></term>
145 <listitem>
146 <para>Builds the <command>whatis</command> database; it reads all
147 the man pages in the <envar>MANPATH</envar> and writes the name
148 and a short description in the <command>whatis</command> database
149 for each page</para>
150 <indexterm zone="ch-system-man makewhatis">
151 <primary sortas="b-makewhatis">makewhatis</primary>
152 </indexterm>
153 </listitem>
154 </varlistentry>
155
156 <varlistentry id="man">
157 <term><command>man</command></term>
158 <listitem>
159 <para>Formats and displays the requested on-line man page</para>
160 <indexterm zone="ch-system-man man">
161 <primary sortas="b-man">man</primary>
162 </indexterm>
163 </listitem>
164 </varlistentry>
165
166 <varlistentry id="man2dvi">
167 <term><command>man2dvi</command></term>
168 <listitem>
169 <para>Converts a man page into dvi format</para>
170 <indexterm zone="ch-system-man man2dvi">
171 <primary sortas="b-man2dvi">man2dvi</primary>
172 </indexterm>
173 </listitem>
174 </varlistentry>
175
176 <varlistentry id="man2html">
177 <term><command>man2html</command></term>
178 <listitem>
179 <para>Converts a man page into HTML</para>
180 <indexterm zone="ch-system-man man2html">
181 <primary sortas="b-man2html">man2html</primary>
182 </indexterm>
183 </listitem>
184 </varlistentry>
185
186 <varlistentry id="whatis">
187 <term><command>whatis</command></term>
188 <listitem>
189 <para>Searches the <command>whatis</command> database and
190 displays the short descriptions of system commands that
191 contain the given keyword as a separate word</para>
192 <indexterm zone="ch-system-man whatis">
193 <primary sortas="b-whatis">whatis</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 </variablelist>
199
200 </sect2>
201
202</sect1>
Note: See TracBrowser for help on using the repository browser.