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

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

Add command to edit man-db.conf tmpfile as we have no man user.

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