source: chapter06/man-db.xml@ 784b3bb

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 ml-11.0 multilib old-trunk trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since 784b3bb was 784b3bb, checked in by Bruce Dubbs <bdubbs@…>, 19 months ago

Update to bison-3.6.
Update to gcc-10.1.0.
Update to libcap-2.34.
Update to bc-2.7.2.
Update to linux-5.6.11.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@11840 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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