source: final-system/common/man.xml@ 75e10d2

Last change on this file since 75e10d2 was 0636f6c, checked in by Jim Gifford <clfs@…>, 19 years ago

r981@server (orig r979): jim | 2005-12-30 10:11:32 -0800

r1226@server: cstaub | 2005-12-30 08:35:37 -0800
Updated package deps, removed explanation of cross-compiling from final-system binutils, and removed note about GRUB's testsuite failure


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