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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 466d0930 was 3f8be484, checked in by Jim Gifford <clfs@…>, 19 years ago

r627@server (orig r625): jim | 2005-10-31 12:59:34 -0800
Import of Cross-LFS Book

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