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

systemd
Last change on this file since f745574 was f745574, checked in by William Harrington <kb0iic@…>, 2 years ago

Update Man-DB to 2.7.6.1 and update install commmands.

  • Property mode set to 100644
File size: 13.1 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 \
31    --prefix=/usr \
32    --libexecdir=/usr/lib \
33    --docdir=/usr/share/doc/man-db-&man-db-version; \
34    --sysconfdir=/etc \
35    --disable-setuid \
36    --enable-cache-owner=bin \
37    --with-browser=/usr/bin/lynx \
38    --with-vgrind=/usr/bin/vgrind \
39    --with-grap=/usr/bin/grap</userinput></screen>
40
41    <variablelist os="c">
42      <title>The meaning of the configure options:</title>
43
44      <varlistentry>
45        <term><parameter>--disable-setuid</parameter></term>
46        <listitem>
47          <para>This disables making the <command>man</command> program setuid
48          to user <systemitem class="username">man</systemitem>.</para>
49        </listitem>
50      </varlistentry>
51
52      <varlistentry>
53        <term><parameter>--with-...</parameter></term>
54        <listitem>
55          <para>These three parameters are used to set some default programs.
56          <command>lynx</command> is a text-based web browser (see
57          CBLFS for installation instructions), <command>vgrind</command>
58          converts program sources to Groff input, and <command>grap</command>
59          is useful for typesetting graphs in Groff documents. The
60          <command>vgrind</command> and <command>grap</command> programs are
61          not normally needed for viewing manual pages. They are not part of
62          CLFS or CBLFS, but you should be able to install them yourself after
63          finishing CLFS if you wish to do so.</para>
64        </listitem>
65      </varlistentry>
66
67    </variablelist>
68
69    <para os="d">Compile the package:</para>
70
71<screen os="e"><userinput>make</userinput></screen>
72
73    <para os="f">To test the results, issue:</para>
74
75<screen os="g"><userinput remap="test">make check</userinput></screen>
76
77    <para os="h">Install the package:</para>
78
79<screen os="i"><userinput>make install</userinput></screen>
80
81    <para os="j">Edit the installed tmpfile as we have no <systemitem class="username">man</systemitem> user:</para>
82
83<screen os="k"><userinput>sed -i "s:man man:root root:g" /usr/lib/tmpfiles.d/man-db.conf</userinput></screen>
84  </sect2>
85
86  <sect2 id="encoding-man-db" role="encoding">
87    <title>Non-English Manual Pages in CLFS</title>
88
89    <para>The following table shows the character set that Man-DB assumes
90    manual pages installed under
91    <filename class="directory">/usr/share/man/&lt;ll&gt;</filename> will be
92    encoded with.  In addition to this, Man-DB correctly determines if manual
93    pages installed in that directory are UTF-8 encoded.</para>
94
95    <!-- Origin: man-db-2.5.9/lib/encodings.c -->
96    <table>
97<title>Expected character encoding of legacy 8-bit manual pages</title>
98      <?dbfo table-width="6in" ?>
99
100      <tgroup cols="4">
101
102        <colspec colnum="1" colwidth="1.5in"/>
103        <colspec colnum="2" colwidth="1in"/>
104        <colspec colnum="3" colwidth="2.5in"/>
105        <colspec colnum="4" colwidth="1in"/>
106
107        <thead>
108          <row>
109            <entry>Language (code)</entry>
110            <entry>Encoding</entry>
111            <entry>Language (code)</entry>
112            <entry>Encoding</entry>
113          </row>
114        </thead>
115
116        <tbody>
117          <row>
118            <entry>Danish (da)</entry>
119            <entry>ISO-8859-1</entry>
120            <entry>Croatian (hr)</entry>
121            <entry>ISO-8859-2</entry>
122          </row>
123          <row>
124            <entry>German (de)</entry>
125            <entry>ISO-8859-1</entry>
126            <entry>Hungarian (hu)</entry>
127            <entry>ISO-8859-2</entry>
128          </row>
129          <row>
130            <entry>English (en)</entry>
131            <entry>ISO-8859-1</entry>
132            <entry>Japanese (ja)</entry>
133            <entry>EUC-JP</entry>
134          </row>
135          <row>
136            <entry>Spanish (es)</entry>
137            <entry>ISO-8859-1</entry>
138            <entry>Korean (ko)</entry>
139            <entry>EUC-KR</entry>
140          </row>
141          <row>
142            <entry>Estonian (et)</entry>
143            <entry>ISO-8859-1</entry>
144            <entry>Lithuanian (lt)</entry>
145            <entry>ISO-8859-13</entry>
146          </row>
147          <row>
148            <entry>Finnish (fi)</entry>
149            <entry>ISO-8859-1</entry>
150            <entry>Latvian (lv)</entry>
151            <entry>ISO-8859-13</entry>
152          </row>
153          <row>
154            <entry>French (fr)</entry>
155            <entry>ISO-8859-1</entry>
156            <entry>Macedonian (mk)</entry>
157            <entry>ISO-8859-5</entry>
158          </row>
159          <row>
160            <entry>Irish (ga)</entry>
161            <entry>ISO-8859-1</entry>
162            <entry>Polish (pl)</entry>
163            <entry>ISO-8859-2</entry>
164          </row>
165          <row>
166            <entry>Galician (gl)</entry>
167            <entry>ISO-8859-1</entry>
168            <entry>Romanian (ro)</entry>
169            <entry>ISO-8859-2</entry>
170          </row>
171          <row>
172            <entry>Indonesian (id)</entry>
173            <entry>ISO-8859-1</entry>
174            <entry>Russian (ru)</entry>
175            <entry>KOI8-R</entry>
176          </row>
177          <row>
178            <entry>Icelandic (is)</entry>
179            <entry>ISO-8859-1</entry>
180            <entry>Slovak (sk)</entry>
181            <entry>ISO-8859-2</entry>
182          </row>
183          <row>
184            <entry>Italian (it)</entry>
185            <entry>ISO-8859-1</entry>
186            <entry>Slovenian (sl)</entry>
187            <entry>ISO-8859-2</entry>
188          </row>
189          <row>
190            <entry>Norwegian Bokmal (nb)</entry>
191            <entry>ISO-8859-1</entry>
192            <entry>Serbian Latin (sr@latin)</entry>
193            <entry>ISO-8859-2</entry>
194          </row>
195          <row>
196            <entry>Dutch (nl)</entry>
197            <entry>ISO-8859-1</entry>
198            <entry>Serbian (sr)</entry>
199            <entry>ISO-8859-5</entry>
200          </row>
201          <row>
202            <entry>Norwegian Nynorsk (nn)</entry>
203            <entry>ISO-8859-1</entry>
204            <entry>Turkish (tr)</entry>
205            <entry>ISO-8859-9</entry>
206          </row>
207          <row>
208            <entry>Norwegian (no)</entry>
209            <entry>ISO-8859-1</entry>
210            <entry>Ukrainian (uk)</entry>
211            <entry>KOI8-U</entry>
212          </row>
213          <row>
214            <entry>Portuguese (pt)</entry>
215            <entry>ISO-8859-1</entry>
216            <entry>Vietnamese (vi)</entry>
217            <entry>TCVN5712-1</entry>
218          </row>
219          <row>
220            <entry>Swedish (sv)</entry>
221            <entry>ISO-8859-1</entry>
222            <entry>Simplified Chinese (zh_CN)</entry>
223            <entry>GBK</entry>
224          </row>
225          <row>
226            <entry>Belarusian (be)</entry>
227            <entry>CP1251</entry>
228            <entry>Simplified Chinese, Singapore (zh_SG)</entry>
229            <entry>GBK</entry>
230          </row>
231          <row>
232            <entry>Bulgarian (bg)</entry>
233            <entry>CP1251</entry>
234            <entry>Traditional Chinese, Hong Kong (zh_HK)</entry>
235            <entry>BIG5HKSCS</entry>
236          </row>
237          <row>
238            <entry>Czech (cs)</entry>
239            <entry>ISO-8859-2</entry>
240            <entry>Traditional Chinese (zh_TW)</entry>
241            <entry>BIG5</entry>
242          </row>
243          <row>
244            <entry>Greek (el)</entry>
245            <entry>ISO-8859-7</entry>
246            <entry></entry>
247            <entry></entry>
248          </row>
249
250        </tbody>
251
252      </tgroup>
253
254    </table>
255
256    <note>
257      <para>Manual pages in languages not in the list are not supported.</para>
258    </note>
259
260  </sect2>
261
262  <sect2 id="contents-man-db" role="content">
263    <title>Contents of Man-DB</title>
264
265    <segmentedlist>
266      <segtitle>Installed programs</segtitle>
267      <segtitle>Installed libraries</segtitle>
268      <segtitle>Installed directories</segtitle>
269
270      <seglistitem>
271        <seg>accessdb, apropos (link to whatis), catman, lexgrog, man, mandb,
272        manpath, whatis, zsoelim</seg>
273        <seg>libman.so, libmandb.so</seg>
274        <seg>/usr/lib/man-db, /usr/share/doc/man-db-&man-db-version;</seg>
275      </seglistitem>
276    </segmentedlist>
277
278    <variablelist>
279      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
280      <?dbfo list-presentation="list"?>
281      <?dbhtml list-presentation="table"?>
282
283      <varlistentry id="accessdb">
284        <term><command>accessdb</command></term>
285        <listitem>
286          <para>Dumps the <command>whatis</command> database contents in
287          human-readable form</para>
288          <indexterm zone="ch-system-man-db accessdb">
289            <primary sortas="b-accessdb">accessdb</primary>
290          </indexterm>
291        </listitem>
292      </varlistentry>
293
294      <varlistentry id="apropos">
295        <term><command>apropos</command></term>
296        <listitem>
297          <para>Searches the <command>whatis</command> database and displays
298          the short descriptions of system commands that contain a given
299          string</para>
300          <indexterm zone="ch-system-man-db apropos">
301            <primary sortas="b-apropos">apropos</primary>
302          </indexterm>
303        </listitem>
304      </varlistentry>
305
306      <varlistentry id="catman">
307        <term><command>catman</command></term>
308        <listitem>
309          <para>Creates or updates the pre-formatted manual pages</para>
310          <indexterm zone="ch-system-man-db catman">
311            <primary sortas="b-catman">catman</primary>
312          </indexterm>
313        </listitem>
314      </varlistentry>
315
316      <varlistentry id="lexgrog">
317        <term><command>lexgrog</command></term>
318        <listitem>
319          <para>Displays one-line summary information about a given manual
320          page</para>
321          <indexterm zone="ch-system-man-db lexgrog">
322            <primary sortas="b-lexgrog">lexgrog</primary>
323          </indexterm>
324        </listitem>
325      </varlistentry>
326
327      <varlistentry id="man">
328        <term><command>man</command></term>
329        <listitem>
330          <para>Formats and displays the requested manual page</para>
331          <indexterm zone="ch-system-man-db man">
332            <primary sortas="b-man">man</primary>
333          </indexterm>
334        </listitem>
335      </varlistentry>
336
337      <varlistentry id="mandb">
338        <term><command>mandb</command></term>
339        <listitem>
340          <para>Creates or updates the <command>whatis</command> database</para>
341          <indexterm zone="ch-system-man-db mandb">
342            <primary sortas="b-mandb">mandb</primary>
343          </indexterm>
344        </listitem>
345      </varlistentry>
346
347      <varlistentry id="manpath">
348        <term><command>manpath</command></term>
349        <listitem>
350          <para>Displays the contents of $MANPATH or (if $MANPATH is not set)
351          a suitable search path based on the settings in man.conf and the
352          user's environment</para>
353          <indexterm zone="ch-system-man-db manpath">
354            <primary sortas="b-manpath">manpath</primary>
355          </indexterm>
356        </listitem>
357      </varlistentry>
358
359      <varlistentry id="whatis">
360        <term><command>whatis</command></term>
361        <listitem>
362          <para>Searches the <command>whatis</command> database and displays
363          the short descriptions of system commands that contain the given
364          keyword as a separate word</para>
365          <indexterm zone="ch-system-man-db whatis">
366            <primary sortas="b-whatis">whatis</primary>
367          </indexterm>
368        </listitem>
369      </varlistentry>
370
371      <varlistentry id="zsoelim">
372        <term><command>zsoelim</command></term>
373        <listitem>
374          <para>Reads files and replaces lines of the form <emphasis>.so
375          file</emphasis> by the contents of the mentioned
376          <emphasis>file</emphasis></para>
377          <indexterm zone="ch-system-man-db zsoelim">
378            <primary sortas="b-zsoelim">zsoelim</primary>
379          </indexterm>
380        </listitem>
381      </varlistentry>
382
383      <varlistentry id="libman">
384        <term><filename class="libraryfile">libman</filename></term>
385        <listitem>
386          <para>Contains run-time support for <command>man</command></para>
387          <indexterm zone="ch-system-man-db libman">
388            <primary sortas="c-libman">libman</primary>
389          </indexterm>
390        </listitem>
391      </varlistentry>
392
393      <varlistentry id="libmandb">
394        <term><filename class="libraryfile">libmandb</filename></term>
395        <listitem>
396          <para>Contains run-time support for <command>man</command></para>
397          <indexterm zone="ch-system-man-db libmandb">
398            <primary sortas="c-libmandb">libmandb</primary>
399          </indexterm>
400        </listitem>
401      </varlistentry>
402
403    </variablelist>
404
405  </sect2>
406
407</sect1>
Note: See TracBrowser for help on using the repository browser.