source: chapter08/man-db.xml@ 6a156bab

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 trunk xry111/git-transition xry111/glibc-2.34 xry111/tester-nohack xry111/usr-move
Last change on this file since 6a156bab was 6a156bab, checked in by Bruce Dubbs <bdubbs@…>, 18 months ago

Mostly text updates in Chapter 8.
There are a couple of minor command changes.

git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/cross2@11924 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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