1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
4 | %general-entities;
|
---|
5 | ]>
|
---|
6 | <sect1 id="ch-system-man" xreflabel="Man" role="wrap">
|
---|
7 | <title>Man-&man-version;</title>
|
---|
8 | <?dbhtml filename="man.html"?>
|
---|
9 |
|
---|
10 | <indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm>
|
---|
11 |
|
---|
12 | <sect2 role="package"><title/>
|
---|
13 | <para>The Man package contains programs for finding and viewing manual pages.</para>
|
---|
14 |
|
---|
15 | <segmentedlist>
|
---|
16 | <segtitle>&buildtime;</segtitle>
|
---|
17 | <segtitle>&diskspace;</segtitle>
|
---|
18 | <seglistitem><seg>0.1 SBU</seg><seg>1.9MB</seg></seglistitem>
|
---|
19 | </segmentedlist>
|
---|
20 |
|
---|
21 | <segmentedlist>
|
---|
22 | <segtitle>Man installation depends on</segtitle>
|
---|
23 | <seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC,
|
---|
24 | Glibc, Grep, Make, Sed</seg></seglistitem>
|
---|
25 | </segmentedlist>
|
---|
26 | </sect2>
|
---|
27 |
|
---|
28 | <sect2 role="installation">
|
---|
29 | <title>Installation of Man</title>
|
---|
30 |
|
---|
31 | <para>We'll make three adjustments to the sources of Man.</para>
|
---|
32 |
|
---|
33 | <para>The first is a patch which allows Man to work better with recent releases
|
---|
34 | of Groff. In particular, man pages will now display using the full terminal
|
---|
35 | width instead of being limited to 80 characters:</para>
|
---|
36 |
|
---|
37 | <screen><userinput>patch -Np1 -i ../man-&man-version;-80cols-1.patch</userinput></screen>
|
---|
38 |
|
---|
39 | <para>The second is a sed substitution to add the <parameter>-R</parameter>
|
---|
40 | switch to the <emphasis>PAGER</emphasis> variable so that escape sequences are
|
---|
41 | properly handled by Less:</para>
|
---|
42 |
|
---|
43 | <screen><userinput>sed -i 's@-is@&R@g' configure</userinput></screen>
|
---|
44 |
|
---|
45 | <para>The third is also a sed substitution to comment out the <quote>MANPATH
|
---|
46 | /usr/man</quote> line in the <filename>man.conf</filename> file to prevent
|
---|
47 | redundant results when using programs such as <command>whatis</command>:</para>
|
---|
48 |
|
---|
49 | <screen><userinput>sed -i 's@MANPATH./usr/man@#&@g' src/man.conf.in</userinput></screen>
|
---|
50 |
|
---|
51 | <para>Now prepare Man for compilation:</para>
|
---|
52 |
|
---|
53 | <screen><userinput>./configure -confdir=/etc</userinput></screen>
|
---|
54 |
|
---|
55 | <para>The meaning of the configure options:</para>
|
---|
56 |
|
---|
57 | <variablelist>
|
---|
58 | <varlistentry>
|
---|
59 | <term><parameter>-confdir=/etc</parameter></term>
|
---|
60 | <listitem><para>This tells the
|
---|
61 | <command>man</command> program to look for the <filename>man.conf</filename>
|
---|
62 | configuration file in the <filename class="directory">/etc</filename> directory.</para></listitem>
|
---|
63 | </varlistentry>
|
---|
64 | </variablelist>
|
---|
65 |
|
---|
66 | <para>Compile the package:</para>
|
---|
67 |
|
---|
68 | <screen><userinput>make</userinput></screen>
|
---|
69 |
|
---|
70 | <para>Lastly, install it:</para>
|
---|
71 |
|
---|
72 | <screen><userinput>make install</userinput></screen>
|
---|
73 |
|
---|
74 | <note><para>If you wish to disable SGR (Select Graphic Rendition) escape sequences, you should edit the
|
---|
75 | <filename>man.conf</filename> file and add the <parameter>-c</parameter> switch
|
---|
76 | to NROFF.</para></note>
|
---|
77 |
|
---|
78 | <para>If your character set uses 8-bit characters, search for the line
|
---|
79 | beginning with <quote>NROFF</quote> in <filename>/etc/man.conf</filename>, and verify that it coincides
|
---|
80 | with the following:</para>
|
---|
81 |
|
---|
82 | <screen>NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen>
|
---|
83 |
|
---|
84 | <para>Note that you should use <quote>latin1</quote> even if it is not the character set
|
---|
85 | of your locale. The reason is that,
|
---|
86 | according to the specification, <application>groff</application> has
|
---|
87 | no means of typesetting characters outside ISO-8859-1
|
---|
88 | without some strange escape codes, and localized manual
|
---|
89 | pages are therefore really a hack. When formatting manual pages,
|
---|
90 | <application>groff</application> thinks that they are in the ISO-8859-1
|
---|
91 | encoding and this <parameter>-Tlatin1</parameter> switch tells
|
---|
92 | <application>groff</application> to use the same encoding for output.
|
---|
93 | Since <application>groff</application> does no recoding of input characters,
|
---|
94 | the formatted result is really in the same encoding as input (although
|
---|
95 | <application>groff</application> doesn't know that it is not ISO-8859-1)
|
---|
96 | and therefore it is usable as the input for a pager.</para>
|
---|
97 |
|
---|
98 | <para>Of course, this hack does not solve the problem of non-working
|
---|
99 | <command>man2dvi</command> program for localized manual
|
---|
100 | pages in non-ISO-8859-1 locales.
|
---|
101 | Also, it does not work at all with multibyte character sets.
|
---|
102 | The first problem does not have a solution currently. The second
|
---|
103 | one is not of a concern because the LFS installation does not support
|
---|
104 | multibyte character sets properly anyway. You may want to look at
|
---|
105 | internationalization related hints, though.</para>
|
---|
106 |
|
---|
107 | <para>You may want to also take a look at the BLFS page at
|
---|
108 | <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/> which deals with
|
---|
109 | formatting and compression issues for man pages.</para>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 |
|
---|
114 | <sect2 id="contents-man" role="content"><title>Contents of Man</title>
|
---|
115 |
|
---|
116 | <segmentedlist>
|
---|
117 | <segtitle>Installed programs</segtitle>
|
---|
118 | <seglistitem><seg>apropos, makewhatis, man,
|
---|
119 | man2dvi, man2html and whatis</seg></seglistitem>
|
---|
120 | </segmentedlist>
|
---|
121 |
|
---|
122 | <variablelist><title>Short descriptions</title>
|
---|
123 |
|
---|
124 | <varlistentry id="apropos">
|
---|
125 | <term><command>apropos</command></term>
|
---|
126 | <listitem>
|
---|
127 | <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
|
---|
128 | <para>searches the whatis database and displays
|
---|
129 | the short descriptions of system commands that contain a given string.</para>
|
---|
130 | </listitem>
|
---|
131 | </varlistentry>
|
---|
132 |
|
---|
133 | <varlistentry id="makewhatis">
|
---|
134 | <term><command>makewhatis</command></term>
|
---|
135 | <listitem>
|
---|
136 | <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
|
---|
137 | <para>builds the whatis database. It reads
|
---|
138 | all the manual pages in the manpath and for each page writes the name and a
|
---|
139 | short description in the whatis database.</para>
|
---|
140 | </listitem>
|
---|
141 | </varlistentry>
|
---|
142 |
|
---|
143 | <varlistentry id="man">
|
---|
144 | <term><command>man</command></term>
|
---|
145 | <listitem>
|
---|
146 | <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
|
---|
147 | <para>formats and displays the requested on-line manual page.</para>
|
---|
148 | </listitem>
|
---|
149 | </varlistentry>
|
---|
150 |
|
---|
151 | <varlistentry id="man2dvi">
|
---|
152 | <term><command>man2dvi</command></term>
|
---|
153 | <listitem>
|
---|
154 | <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
|
---|
155 | <para>converts a manual page into dvi format.</para>
|
---|
156 | </listitem>
|
---|
157 | </varlistentry>
|
---|
158 |
|
---|
159 | <varlistentry id="man2html">
|
---|
160 | <term><command>man2html</command></term>
|
---|
161 | <listitem>
|
---|
162 | <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
|
---|
163 | <para>converts a manual page into html.</para>
|
---|
164 | </listitem>
|
---|
165 | </varlistentry>
|
---|
166 |
|
---|
167 | <varlistentry id="whatis">
|
---|
168 | <term><command>whatis</command></term>
|
---|
169 | <listitem>
|
---|
170 | <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
|
---|
171 | <para>searches the whatis database and displays the short descriptions of system
|
---|
172 | commands that contain the given keyword as a separate word.</para>
|
---|
173 | </listitem>
|
---|
174 | </varlistentry>
|
---|
175 | </variablelist>
|
---|
176 |
|
---|
177 | </sect2>
|
---|
178 |
|
---|
179 | </sect1>
|
---|