[673b0d8] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 4 | %general-entities;
|
---|
| 5 | ]>
|
---|
[3be4d97] | 6 | <sect1 id="ch-system-man" xreflabel="Man">
|
---|
[673b0d8] | 7 | <title>Man-&man-version;</title>
|
---|
| 8 | <?dbhtml filename="man.html"?>
|
---|
| 9 |
|
---|
| 10 | <indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm>
|
---|
[6370fa6] | 11 |
|
---|
[5888299] | 12 | <para>The Man package contains programs for finding and viewing manual pages.</para>
|
---|
| 13 |
|
---|
[673b0d8] | 14 | <screen>&buildtime; 0.1 SBU
|
---|
| 15 | &diskspace; 1.9MB</screen>
|
---|
| 16 |
|
---|
| 17 | <para>Man installation depends on: Bash, Binutils, Coreutils, Gawk, GCC,
|
---|
| 18 | Glibc, Grep, Make, Sed.</para>
|
---|
[3554fa3a] | 19 |
|
---|
[73aedd1d] | 20 |
|
---|
| 21 |
|
---|
| 22 | <sect2>
|
---|
| 23 | <title>Installation of Man</title>
|
---|
| 24 |
|
---|
| 25 | <para>We'll make three adjustments to the sources of Man.</para>
|
---|
| 26 |
|
---|
[37dcf2a] | 27 | <para>The first is a patch which allows Man to work better with recent releases
|
---|
| 28 | of Groff. In particular, man pages will now display using the full terminal
|
---|
| 29 | width instead of being limited to 80 characters:</para>
|
---|
[73aedd1d] | 30 |
|
---|
[673b0d8] | 31 | <screen><userinput>patch -Np1 -i ../man-&man-version;-80cols.patch</userinput></screen>
|
---|
[73aedd1d] | 32 |
|
---|
[37dcf2a] | 33 | <para>The second is a sed substitution to add the <emphasis>-R</emphasis>
|
---|
| 34 | switch to the <emphasis>PAGER</emphasis> variable so that escape sequences are
|
---|
| 35 | properly handled by Less:</para>
|
---|
[73aedd1d] | 36 |
|
---|
[37dcf2a] | 37 | <screen><userinput>sed -i 's/-is/&R/' configure</userinput></screen>
|
---|
[73aedd1d] | 38 |
|
---|
[673b0d8] | 39 | <para>The third is also a sed substitution to comment out the <quote>MANPATH
|
---|
| 40 | /usr/man</quote> line in the <filename>man.conf</filename> file to prevent
|
---|
| 41 | redundant results when using programs such as <command>whatis</command>:</para>
|
---|
[73aedd1d] | 42 |
|
---|
[d081b3e] | 43 | <screen><userinput>sed -i 's%MANPATH./usr/man%#&%' src/man.conf.in</userinput></screen>
|
---|
[37dcf2a] | 44 |
|
---|
[73aedd1d] | 45 | <para>Now prepare Man for compilation:</para>
|
---|
| 46 |
|
---|
| 47 | <screen><userinput>./configure -default -confdir=/etc</userinput></screen>
|
---|
| 48 |
|
---|
| 49 | <para>The meaning of the configure options:</para>
|
---|
| 50 |
|
---|
| 51 | <itemizedlist>
|
---|
| 52 | <listitem><para><userinput>-default</userinput>: This tells the configure script
|
---|
| 53 | to select a sensible set of default options. For example: only English man
|
---|
| 54 | pages, no message catalogs, man not suid, handle compressed man pages, compress
|
---|
| 55 | cat pages, create cat pages whenever the appropriate directory exists, follow
|
---|
[673b0d8] | 56 | FHS by putting cat pages under /var/cache/man (provided that directory
|
---|
| 57 | exists).</para></listitem>
|
---|
[73aedd1d] | 58 |
|
---|
| 59 | <listitem><para><userinput>-confdir=/etc</userinput>: This tells the
|
---|
[90e3cb3] | 60 | <command>man</command> program to look for the <filename>man.conf</filename>
|
---|
[73aedd1d] | 61 | configuration file in the <filename>/etc</filename> directory.</para></listitem>
|
---|
| 62 | </itemizedlist>
|
---|
| 63 |
|
---|
| 64 | <para>Compile the package:</para>
|
---|
| 65 |
|
---|
| 66 | <screen><userinput>make</userinput></screen>
|
---|
| 67 |
|
---|
[673b0d8] | 68 | <para>Lastly, install it:</para>
|
---|
[73aedd1d] | 69 |
|
---|
| 70 | <screen><userinput>make install</userinput></screen>
|
---|
| 71 |
|
---|
[673b0d8] | 72 | <note><para>If you wish to disable SGR (Select Graphic Rendition) escape sequences, you should edit the
|
---|
[90e3cb3] | 73 | <filename>man.conf</filename> file and add the <emphasis>-c</emphasis> switch
|
---|
| 74 | to NROFF.</para></note>
|
---|
[73aedd1d] | 75 |
|
---|
| 76 | <para>You may want to also take a look at the BLFS page at
|
---|
| 77 | <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/> which deals with
|
---|
| 78 | formatting and compression issues for man pages.</para>
|
---|
| 79 |
|
---|
| 80 | </sect2>
|
---|
[6370fa6] | 81 |
|
---|
[5888299] | 82 |
|
---|
[673b0d8] | 83 | <sect2 id="contents-man"><title>Contents of Man</title>
|
---|
| 84 |
|
---|
| 85 | <para><emphasis>Installed programs</emphasis>: apropos, makewhatis, man,
|
---|
| 86 | man2dvi, man2html and whatis</para>
|
---|
| 87 |
|
---|
| 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 |
|
---|
| 91 | <sect2><title>Short descriptions</title>
|
---|
| 92 |
|
---|
| 93 | <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
|
---|
| 94 | <para id="apropos"><command>apropos</command> searches the whatis database and displays
|
---|
| 95 | the short descriptions of system commands that contain a given string.</para>
|
---|
| 96 |
|
---|
| 97 | <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
|
---|
| 98 | <para id="makewhatis"><command>makewhatis</command> builds the whatis database. It reads
|
---|
| 99 | all the manual pages in the manpath and for each page writes the name and a
|
---|
| 100 | short description in the whatis database.</para>
|
---|
[6370fa6] | 101 |
|
---|
[673b0d8] | 102 | <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
|
---|
| 103 | <para id="man"><command>man</command> formats and displays the requested on-line
|
---|
| 104 | manual page.</para>
|
---|
| 105 |
|
---|
| 106 | <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
|
---|
| 107 | <para id="man2dvi"><command>man2dvi</command> converts a manual page into dvi format.</para>
|
---|
| 108 |
|
---|
| 109 | <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
|
---|
| 110 | <para id="man2html"><command>man2html</command> converts a manual page into html.</para>
|
---|
| 111 |
|
---|
| 112 | <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
|
---|
| 113 | <para id="whatis"><command>whatis</command> searches the whatis database and displays
|
---|
| 114 | the short descriptions of system commands that contain the given keyword as a
|
---|
| 115 | separate word.</para>
|
---|
| 116 |
|
---|
| 117 | </sect2>
|
---|
| 118 |
|
---|
| 119 |
|
---|
| 120 |
|
---|
| 121 | </sect1>
|
---|