source: chapter06/man-db.xml@ 82d957c

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 82d957c was 82d957c, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Update bash upstream patch for CVE-2014-6271, CVE-2014-7169, and
CVE-2014-7187 (through upstream patch bash43-027).

Update to tzdata-2014h.
Update to man-db-2.7.0.2.
Improve wget command line in Section 3.1.

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