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