source: chapter08/man-db.xml@ c7ee38f

12.0 12.0-rc1 12.1 12.1-rc1 multilib trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/update-glibc
Last change on this file since c7ee38f was 1053282, checked in by Xi Ruoyao <xry111@…>, 12 months ago

man-db: Update known test failures, again

I was too naive: actually a lot of tests fail with groff-1.23.0 and
they'll show up with "-k".

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