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

systemd
Last change on this file since 7cd7f99 was 7cd7f99, checked in by Chris Staub <chris@…>, 4 years ago

Put one configure option per line

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