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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since fb40919 was fb40919, checked in by Chris Staub <chris@…>, 13 years ago

Changed many 'LFS' references to 'CLFS'

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