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