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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 3aeeba02 was 0d4607d, checked in by Jim Gifford <clfs@…>, 17 years ago

Removed References to BLFS

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