source: chapter06/man-db.xml@ 1fa2099

multilib-10.1 multilib-before-cross
Last change on this file since 1fa2099 was 1fa2099, checked in by Thomas Trepl <thomas@…>, 3 years ago

Initial creation of multilib branch

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