source: chapter08/man-db.xml@ db2d98f

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 arm bdubbs/gcc13 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 db2d98f was db2d98f, checked in by Xi Ruoyao <xry111@…>, 2 years ago

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