source: final-system/common/man.xml @ 0f06076

Last change on this file since 0f06076 was 0f06076, checked in by Jim Gifford <clfs@…>, 16 years ago

r3371@server (orig r1554): chris | 2006-05-10 14:03:44 -0700
Removed dependency info from individual package instructions

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