source: chapter08/man-db.xml@ 4d63404

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

Partially revert "man-db: Update known test failures, again"

This partially reverts commit 1053282e5f0a6e7bba9605676b650d46db6ffaf4.

There is actually only one test suite in LFS build even with -k, but on
my complete system there are many test failures with "-k". I guess some
tests depend on non-LFS packages.

The text change is reverted, but the command change is preserved as
generally we should use -k for any make check command known to fail.

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