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

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

Add table for non english man pages for man-db.

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