source: chapter06/man-db.xml@ 8f85d251

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 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 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 8f85d251 was 8f85d251, checked in by Matthew Burgess <matthew@…>, 15 years ago

Remove mention of convert-mans and oldfuser in Man-DB's and psmisc's installed file lists respectively. Fixes #2455.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8996 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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