source: chapter06/man-db.xml@ 31b4464

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 31b4464 was 31b4464, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Update to perl-5.20.1.
Update to xz-5.0.7.
Update to linux-3.16.3.
Update to man-pages-3.73.
Update to libpipeline-1.3.1.
Update to man-db-2.7.0.1.
Update to procps-ng-3.3.10.

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