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