source: chapter08/man-db.xml@ 9f1ab84

xry111/usr-move
Last change on this file since 9f1ab84 was 9f1ab84, checked in by Xi Ruoyao <xry111@…>, 8 months ago

usr-move: man-db: remove an unneeded workaround for systemd

  • Property mode set to 100644
File size: 14.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 <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"><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">
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>Russian (ru)</entry>
213 <entry>KOI8-R</entry>
214 </row>
215 <row>
216 <entry>Icelandic (is)</entry>
217 <entry>ISO-8859-1</entry>
218 <entry>Slovak (sk)</entry>
219 <entry>ISO-8859-2</entry>
220 </row>
221 <row>
222 <entry>Italian (it)</entry>
223 <entry>ISO-8859-1</entry>
224 <entry>Slovenian (sl)</entry>
225 <entry>ISO-8859-2</entry>
226 </row>
227 <row>
228 <entry>Norwegian Bokmal (nb)</entry>
229 <entry>ISO-8859-1</entry>
230 <entry>Serbian Latin (sr@latin)</entry>
231 <entry>ISO-8859-2</entry>
232 </row>
233 <row>
234 <entry>Dutch (nl)</entry>
235 <entry>ISO-8859-1</entry>
236 <entry>Serbian (sr)</entry>
237 <entry>ISO-8859-5</entry>
238 </row>
239 <row>
240 <entry>Norwegian Nynorsk (nn)</entry>
241 <entry>ISO-8859-1</entry>
242 <entry>Turkish (tr)</entry>
243 <entry>ISO-8859-9</entry>
244 </row>
245 <row>
246 <entry>Norwegian (no)</entry>
247 <entry>ISO-8859-1</entry>
248 <entry>Ukrainian (uk)</entry>
249 <entry>KOI8-U</entry>
250 </row>
251 <row>
252 <entry>Portuguese (pt)</entry>
253 <entry>ISO-8859-1</entry>
254 <entry>Vietnamese (vi)</entry>
255 <entry>TCVN5712-1</entry>
256 </row>
257 <row>
258 <entry>Swedish (sv)</entry>
259 <entry>ISO-8859-1</entry>
260 <entry>Simplified Chinese (zh_CN)</entry>
261 <entry>GBK</entry>
262 </row>
263 <row>
264 <entry>Belarusian (be)</entry>
265 <entry>CP1251</entry>
266 <entry>Simplified Chinese, Singapore (zh_SG)</entry>
267 <entry>GBK</entry>
268 </row>
269 <row>
270 <entry>Bulgarian (bg)</entry>
271 <entry>CP1251</entry>
272 <entry>Traditional Chinese, Hong Kong (zh_HK)</entry>
273 <entry>BIG5HKSCS</entry>
274 </row>
275 <row>
276 <entry>Czech (cs)</entry>
277 <entry>ISO-8859-2</entry>
278 <entry>Traditional Chinese (zh_TW)</entry>
279 <entry>BIG5</entry>
280 </row>
281 <row>
282 <entry>Greek (el)</entry>
283 <entry>ISO-8859-7</entry>
284 <entry></entry>
285 <entry></entry>
286 </row>
287
288 </tbody>
289
290 </tgroup>
291
292 </table>
293
294 <note>
295 <para>Manual pages in languages not in the list are not supported.</para>
296 </note>
297
298 </sect2>
299
300 <sect2 id="contents-man-db" role="content">
301 <title>Contents of Man-DB</title>
302
303 <segmentedlist>
304 <segtitle>Installed programs</segtitle>
305 <segtitle>Installed libraries</segtitle>
306 <segtitle>Installed directories</segtitle>
307
308 <seglistitem>
309 <seg>accessdb, apropos (link to whatis), catman, lexgrog, man, mandb,
310 manpath, and whatis</seg>
311 <seg>libman.so and libmandb.so (both in /usr/lib/man-db)</seg>
312 <seg>/usr/lib/man-db, /usr/libexec/man-db,
313 and /usr/share/doc/man-db-&man-db-version;</seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321
322 <varlistentry id="accessdb">
323 <term><command>accessdb</command></term>
324 <listitem>
325 <para>Dumps the <command>whatis</command> database contents in
326 human-readable form</para>
327 <indexterm zone="ch-system-man-db accessdb">
328 <primary sortas="b-accessdb">accessdb</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="apropos">
334 <term><command>apropos</command></term>
335 <listitem>
336 <para>Searches the <command>whatis</command> database and displays
337 the short descriptions of system commands that contain a given
338 string</para>
339 <indexterm zone="ch-system-man-db apropos">
340 <primary sortas="b-apropos">apropos</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="catman">
346 <term><command>catman</command></term>
347 <listitem>
348 <para>Creates or updates the pre-formatted manual pages</para>
349 <indexterm zone="ch-system-man-db catman">
350 <primary sortas="b-catman">catman</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="lexgrog">
356 <term><command>lexgrog</command></term>
357 <listitem>
358 <para>Displays one-line summary information about a given manual
359 page</para>
360 <indexterm zone="ch-system-man-db lexgrog">
361 <primary sortas="b-lexgrog">lexgrog</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="man">
367 <term><command>man</command></term>
368 <listitem>
369 <para>Formats and displays the requested manual page</para>
370 <indexterm zone="ch-system-man-db man">
371 <primary sortas="b-man">man</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="mandb">
377 <term><command>mandb</command></term>
378 <listitem>
379 <para>Creates or updates the <command>whatis</command> database</para>
380 <indexterm zone="ch-system-man-db mandb">
381 <primary sortas="b-mandb">mandb</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="manpath">
387 <term><command>manpath</command></term>
388 <listitem>
389 <para>Displays the contents of $MANPATH or (if $MANPATH is not set)
390 a suitable search path based on the settings in man.conf and the
391 user's environment</para>
392 <indexterm zone="ch-system-man-db manpath">
393 <primary sortas="b-manpath">manpath</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="whatis">
399 <term><command>whatis</command></term>
400 <listitem>
401 <para>Searches the <command>whatis</command> database and displays
402 the short descriptions of system commands that contain the given
403 keyword as a separate word</para>
404 <indexterm zone="ch-system-man-db whatis">
405 <primary sortas="b-whatis">whatis</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="libman">
411 <term><filename class="libraryfile">libman</filename></term>
412 <listitem>
413 <para>Contains run-time support for <command>man</command></para>
414 <indexterm zone="ch-system-man-db libman">
415 <primary sortas="c-libman">libman</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="libmandb">
421 <term><filename class="libraryfile">libmandb</filename></term>
422 <listitem>
423 <para>Contains run-time support for <command>man</command></para>
424 <indexterm zone="ch-system-man-db libmandb">
425 <primary sortas="c-libmandb">libmandb</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 </variablelist>
431
432 </sect2>
433
434</sect1>
Note: See TracBrowser for help on using the repository browser.