man-db.xml 15 KB

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