source: BOOK/final-system/common/man-db.xml @ 200f1853

clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 200f1853 was 200f1853, checked in by William Harrington <kb0iic@…>, 8 years ago

Uncomment some contents after removing man.

  • 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.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-db" role="wrap">
9  <?dbhtml filename="man-db.html"?>
10
11  <title>Man-DB-&man-db-version;</title>
12
13  <indexterm zone="ch-system-man-db">
14    <primary sortas="a-Man-DB">Man-DB</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Man-DB package contains programs for finding and viewing man
21    pages.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Man-DB</title>
27
28    <para os="a">Prepare Man-DB for compilation:</para>
29
30<screen os="b"><userinput>./configure --prefix=/usr \
31    --docdir=/usr/share/doc/man-db-&man-db-version; --sysconfdir=/etc \
32    --disable-setuid --with-browser=/usr/bin/lynx \
33    --with-vgrind=/usr/bin/vgrind --with-grep=/bin/grep</userinput></screen>
34
35    <variablelist os="c">
36      <title>The meaning of the configure options:</title>
37
38      <varlistentry>
39        <term><parameter>--disable-setuid</parameter></term>
40        <listitem>
41          <para>This disables making the <command>man</command> program setuid
42          to user <systemitem class="username">man</systemitem>.</para>
43        </listitem>
44      </varlistentry>
45
46      <varlistentry>
47        <term><parameter>--with-...</parameter></term>
48        <listitem>
49          <para>These three parameters are used to set some default programs.
50          <command>lynx</command> is a text-based web browser (see
51          BLFS for installation instructions), <command>vgrind</command>
52          converts program sources to Groff input, and <command>grap</command>
53          is useful for typesetting graphs in Groff documents. The
54          <command>vgrind</command> and <command>grap</command> programs are
55          not normally needed for viewing manual pages. They are not part of
56          LFS or BLFS, but you should be able to install them yourself after
57          finishing LFS if you wish to do so.</para>
58        </listitem>
59      </varlistentry>
60
61    </variablelist>
62
63    <para os="d">Compile the package:</para>
64
65<screen os="e"><userinput>make</userinput></screen>
66
67    <para os="f">To test the results, issue:</para>
68
69<screen os="g"><userinput remap="test">make check</userinput></screen>
70
71    <para os="h">Install the package:</para>
72
73<screen os="i"><userinput>make install</userinput></screen>
74
75  </sect2>
76
77  <sect2 id="contents-man-db" role="content">
78    <title>Contents of Man-DB</title>
79
80    <segmentedlist>
81      <segtitle>Installed programs</segtitle>
82      <segtitle>Installed libraries</segtitle>
83      <segtitle>Installed directories</segtitle>
84
85      <seglistitem>
86        <seg>accessdb, apropos (link to whatis), catman, lexgrog, man, mandb,
87        manpath, whatis, and zsoelim</seg>
88        <seg>libman.so, libmandb.so</seg>
89        <seg>/usr/lib/man-db, /usr/libexec/man-db, /usr/share/doc/man-db-&man-db-version;</seg>
90      </seglistitem>
91    </segmentedlist>
92
93    <variablelist>
94      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
95      <?dbfo list-presentation="list"?>
96      <?dbhtml list-presentation="table"?>
97
98      <varlistentry id="accessdb">
99        <term><command>accessdb</command></term>
100        <listitem>
101          <para>Dumps the <command>whatis</command> database contents in
102          human-readable form</para>
103          <indexterm zone="ch-system-man-db accessdb">
104            <primary sortas="b-accessdb">accessdb</primary>
105          </indexterm>
106        </listitem>
107      </varlistentry>
108
109      <varlistentry id="apropos">
110        <term><command>apropos</command></term>
111        <listitem>
112          <para>Searches the <command>whatis</command> database and displays
113          the short descriptions of system commands that contain a given
114          string</para>
115          <indexterm zone="ch-system-man-db apropos">
116            <primary sortas="b-apropos">apropos</primary>
117          </indexterm>
118        </listitem>
119      </varlistentry>
120
121      <varlistentry id="catman">
122        <term><command>catman</command></term>
123        <listitem>
124          <para>Creates or updates the pre-formatted manual pages</para>
125          <indexterm zone="ch-system-man-db catman">
126            <primary sortas="b-catman">catman</primary>
127          </indexterm>
128        </listitem>
129      </varlistentry>
130
131      <varlistentry id="lexgrog">
132        <term><command>lexgrog</command></term>
133        <listitem>
134          <para>Displays one-line summary information about a given manual
135          page</para>
136          <indexterm zone="ch-system-man-db lexgrog">
137            <primary sortas="b-lexgrog">lexgrog</primary>
138          </indexterm>
139        </listitem>
140      </varlistentry>
141
142      <varlistentry id="man">
143        <term><command>man</command></term>
144        <listitem>
145          <para>Formats and displays the requested manual page</para>
146          <indexterm zone="ch-system-man-db man">
147            <primary sortas="b-man">man</primary>
148          </indexterm>
149        </listitem>
150      </varlistentry>
151
152      <varlistentry id="mandb">
153        <term><command>mandb</command></term>
154        <listitem>
155          <para>Creates or updates the <command>whatis</command> database</para>
156          <indexterm zone="ch-system-man-db mandb">
157            <primary sortas="b-mandb">mandb</primary>
158          </indexterm>
159        </listitem>
160      </varlistentry>
161
162      <varlistentry id="manpath">
163        <term><command>manpath</command></term>
164        <listitem>
165          <para>Displays the contents of $MANPATH or (if $MANPATH is not set)
166          a suitable search path based on the settings in man.conf and the
167          user's environment</para>
168          <indexterm zone="ch-system-man-db manpath">
169            <primary sortas="b-manpath">manpath</primary>
170          </indexterm>
171        </listitem>
172      </varlistentry>
173
174      <varlistentry id="whatis">
175        <term><command>whatis</command></term>
176        <listitem>
177          <para>Searches the <command>whatis</command> database and displays
178          the short descriptions of system commands that contain the given
179          keyword as a separate word</para>
180          <indexterm zone="ch-system-man-db whatis">
181            <primary sortas="b-whatis">whatis</primary>
182          </indexterm>
183        </listitem>
184      </varlistentry>
185
186      <varlistentry id="zsoelim">
187        <term><command>zsoelim</command></term>
188        <listitem>
189          <para>Reads files and replaces lines of the form <emphasis>.so
190          file</emphasis> by the contents of the mentioned
191          <emphasis>file</emphasis></para>
192          <indexterm zone="ch-system-man-db zsoelim">
193            <primary sortas="b-zsoelim">zsoelim</primary>
194          </indexterm>
195        </listitem>
196      </varlistentry>
197
198      <varlistentry id="libman">
199        <term><filename class="libraryfile">libman</filename></term>
200        <listitem>
201          <para>Contains run-time support for <command>man</command></para>
202          <indexterm zone="ch-system-man-db libman">
203            <primary sortas="c-libman">libman</primary>
204          </indexterm>
205        </listitem>
206      </varlistentry>
207
208      <varlistentry id="libmandb">
209        <term><filename class="libraryfile">libmandb</filename></term>
210        <listitem>
211          <para>Contains run-time support for <command>man</command></para>
212          <indexterm zone="ch-system-man-db libmandb">
213            <primary sortas="c-libmandb">libmandb</primary>
214          </indexterm>
215        </listitem>
216      </varlistentry>
217
218    </variablelist>
219
220  </sect2>
221
222</sect1>
Note: See TracBrowser for help on using the repository browser.