source: BOOK/final-system/common/man-db.xml@ 7ddb05f

sysvinit
Last change on this file since 7ddb05f was b27081c4, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line

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