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

clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 47eeca5 was b8bd862, checked in by Chris Staub <chris@…>, 10 years ago

Remove documentation symlinks

  • 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.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.5/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="p1">This patch adds support for Internationalization:</para>
29
30<screen os="p2"><userinput>patch -Np1 -i ../&man-i18n-patch;</userinput></screen>
31
32    <para os="a">A few adjustments need to be made to the sources of Man.</para>
33
34    <para os="b">First, a <command>sed</command> substitution is
35    needed to add the <option>-R</option> switch to the
36    <envar>PAGER</envar> variable so that escape sequences are
37    properly handled by Less:</para>
38
39<screen os="c"><userinput>sed -i 's@-is@&amp;R@g' configure</userinput></screen>
40
41    <para os="d">Another couple of <command>sed</command> substitutions
42    comment out the <quote>MANPATH /usr/man</quote> and
43    <quote>MANPATH /usr/local/man</quote> lines in the
44    <filename>man.conf</filename> file to prevent redundant
45    results when using programs such as <command>whatis</command>:</para>
46
47<screen os="e"><userinput>sed -i 's@MANPATH./usr/man@#&amp;@g' src/man.conf.in
48sed -i 's@MANPATH./usr/local/man@#&amp;@g' src/man.conf.in</userinput></screen>
49
50    <para os="h">Prepare Man for compilation:</para>
51
52<screen os="i"><userinput>./configure -confdir=/etc -mandir=/usr/share/man</userinput></screen>
53
54    <variablelist os="j">
55      <title>The meaning of the configure options:</title>
56
57      <varlistentry>
58      <term><parameter>-confdir=/etc</parameter></term>
59      <listitem>
60        <para>This tells the <command>man</command> program to look for the
61        <filename>man.conf</filename> configuration file in the <filename
62        class="directory">/etc</filename> directory.</para>
63      </listitem>
64      </varlistentry>
65    </variablelist>
66
67    <para os="k">Compile the package:</para>
68
69<screen os="l"><userinput>make</userinput></screen>
70
71    <para os="m">This package does not come with a test suite.</para>
72
73    <para os="n">Install the package:</para>
74
75<screen os="o"><userinput>make install</userinput></screen>
76
77    <note os="p">
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="q">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="r">NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen>
94
95    <para os="s">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="t">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 CLFS installation does
112    not support multibyte character sets.</para>
113
114  </sect2>
115
116  <sect2 id="contents-man" role="content">
117    <title>Contents of Man</title>
118
119    <segmentedlist>
120      <segtitle>Installed programs</segtitle>
121
122      <seglistitem>
123        <seg>apropos, makewhatis, man, man2dvi, man2html, and whatis</seg>
124      </seglistitem>
125    </segmentedlist>
126
127    <variablelist>
128      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
129      <?dbfo list-presentation="list"?>
130      <?dbhtml list-presentation="table"?>
131
132      <varlistentry id="apropos">
133        <term><command>apropos</command></term>
134        <listitem>
135          <para>Searches the <command>whatis</command> database and
136          displays the short descriptions of system commands that contain
137          a given string</para>
138          <indexterm zone="ch-system-man apropos">
139            <primary sortas="b-apropos">apropos</primary>
140          </indexterm>
141        </listitem>
142      </varlistentry>
143
144      <varlistentry id="makewhatis">
145        <term><command>makewhatis</command></term>
146        <listitem>
147          <para>Builds the <command>whatis</command> database; it reads all
148          the man pages in the <envar>MANPATH</envar> and writes the name
149          and a short description in the <command>whatis</command> database
150          for each page</para>
151          <indexterm zone="ch-system-man makewhatis">
152            <primary sortas="b-makewhatis">makewhatis</primary>
153          </indexterm>
154        </listitem>
155      </varlistentry>
156
157      <varlistentry id="man">
158        <term><command>man</command></term>
159        <listitem>
160          <para>Formats and displays the requested on-line man page</para>
161          <indexterm zone="ch-system-man man">
162            <primary sortas="b-man">man</primary>
163          </indexterm>
164        </listitem>
165      </varlistentry>
166
167      <varlistentry id="man2dvi">
168        <term><command>man2dvi</command></term>
169        <listitem>
170          <para>Converts a man page into dvi format</para>
171          <indexterm zone="ch-system-man man2dvi">
172            <primary sortas="b-man2dvi">man2dvi</primary>
173          </indexterm>
174        </listitem>
175      </varlistentry>
176
177      <varlistentry id="man2html">
178        <term><command>man2html</command></term>
179        <listitem>
180          <para>Converts a man page into HTML</para>
181          <indexterm zone="ch-system-man man2html">
182            <primary sortas="b-man2html">man2html</primary>
183          </indexterm>
184        </listitem>
185      </varlistentry>
186
187      <varlistentry id="whatis">
188        <term><command>whatis</command></term>
189        <listitem>
190          <para>Searches the <command>whatis</command> database and
191          displays the short descriptions of system commands that
192          contain the given keyword as a separate word</para>
193          <indexterm zone="ch-system-man whatis">
194            <primary sortas="b-whatis">whatis</primary>
195          </indexterm>
196        </listitem>
197      </varlistentry>
198
199    </variablelist>
200
201  </sect2>
202
203</sect1>
Note: See TracBrowser for help on using the repository browser.