source: chapter08/man-db.xml@ 193913e

s6-init
Last change on this file since 193913e was 193913e, checked in by Thomas Trepl (Moody) <thomas@…>, 21 months ago

First commit to add S6 as init system (like systemd)

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