[3f8be484] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
---|
[aa18ac0] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
---|
[3f8be484] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent"> |
---|
| 5 | %general-entities; |
---|
| 6 | ]> |
---|
| 7 | |
---|
| 8 | <sect1 id="ch-system-man" role="wrap"> |
---|
| 9 | <?dbhtml filename="man.html"?> |
---|
| 10 | |
---|
| 11 | <title>Man-&man-version;</title> |
---|
| 12 | |
---|
| 13 | <indexterm zone="ch-system-man"> |
---|
| 14 | <primary sortas="a-Man">Man</primary> |
---|
| 15 | </indexterm> |
---|
| 16 | |
---|
| 17 | <sect2 role="package"> |
---|
| 18 | <title/> |
---|
| 19 | |
---|
| 20 | <para>The Man package contains programs for finding and viewing man |
---|
| 21 | pages.</para> |
---|
| 22 | |
---|
| 23 | </sect2> |
---|
| 24 | |
---|
| 25 | <sect2 role="installation"> |
---|
| 26 | <title>Installation of Man</title> |
---|
| 27 | |
---|
[b0c96c6] | 28 | <para os="p1">This patch adds support for Internationalization:</para> |
---|
| 29 | |
---|
| 30 | <screen os="p2"><userinput>patch -Np1 -i ../&man-i18n-patch;</userinput></screen> |
---|
| 31 | |
---|
[6af3a34] | 32 | <para os="p3">The following patch will add support for new compressors like XZ Utils:</para> |
---|
| 33 | |
---|
| 34 | <screen os="p4"><userinput>patch -Np1 -i ../&man-new_compressors-patch;</userinput></screen> |
---|
| 35 | |
---|
[3f8be484] | 36 | <para os="a">A few adjustments need to be made to the sources of Man.</para> |
---|
| 37 | |
---|
[7c63c926] | 38 | <para os="b">First, a <command>sed</command> substitution is |
---|
| 39 | needed to add the <option>-R</option> switch to the |
---|
| 40 | <envar>PAGER</envar> variable so that escape sequences are |
---|
| 41 | properly handled by Less:</para> |
---|
[3f8be484] | 42 | |
---|
| 43 | <screen os="c"><userinput>sed -i 's@-is@&R@g' configure</userinput></screen> |
---|
| 44 | |
---|
[8fdf8edb] | 45 | <para os="d">Another couple of <command>sed</command> substitutions |
---|
| 46 | comment out the <quote>MANPATH /usr/man</quote> and |
---|
| 47 | <quote>MANPATH /usr/local/man</quote> lines in the |
---|
| 48 | <filename>man.conf</filename> file to prevent redundant |
---|
[ea24374] | 49 | results when using programs such as <command>whatis</command>:</para> |
---|
[3f8be484] | 50 | |
---|
[ea24374] | 51 | <screen os="e"><userinput>sed -i 's@MANPATH./usr/man@#&@g' src/man.conf.in |
---|
| 52 | sed -i 's@MANPATH./usr/local/man@#&@g' src/man.conf.in</userinput></screen> |
---|
[3f8be484] | 53 | |
---|
[7c63c926] | 54 | <para os="h">Prepare Man for compilation:</para> |
---|
| 55 | |
---|
| 56 | <screen os="i"><userinput>./configure -confdir=/etc</userinput></screen> |
---|
| 57 | |
---|
| 58 | <variablelist os="j"> |
---|
[3f8be484] | 59 | <title>The meaning of the configure options:</title> |
---|
| 60 | |
---|
| 61 | <varlistentry> |
---|
| 62 | <term><parameter>-confdir=/etc</parameter></term> |
---|
| 63 | <listitem> |
---|
| 64 | <para>This tells the <command>man</command> program to look for the |
---|
| 65 | <filename>man.conf</filename> configuration file in the <filename |
---|
| 66 | class="directory">/etc</filename> directory.</para> |
---|
| 67 | </listitem> |
---|
| 68 | </varlistentry> |
---|
| 69 | </variablelist> |
---|
| 70 | |
---|
[7c63c926] | 71 | <para os="k">Compile the package:</para> |
---|
[3f8be484] | 72 | |
---|
[7c63c926] | 73 | <screen os="l"><userinput>make</userinput></screen> |
---|
[3f8be484] | 74 | |
---|
[d1631d1] | 75 | <para os="m">This package does not come with a test suite.</para> |
---|
[3f8be484] | 76 | |
---|
[d1631d1] | 77 | <para os="n">Install the package:</para> |
---|
[3f8be484] | 78 | |
---|
[d1631d1] | 79 | <screen os="o"><userinput>make install</userinput></screen> |
---|
| 80 | |
---|
| 81 | <note os="p"> |
---|
[3f8be484] | 82 | <para>If you will be working on a terminal that does not support |
---|
| 83 | text attributes such as color and bold, you can disable Select |
---|
| 84 | Graphic Rendition (SGR) escape sequences by editing the |
---|
| 85 | <filename>man.conf</filename> file and adding the <option>-c</option> |
---|
| 86 | option to the <envar>NROFF</envar> variable. If you use multiple |
---|
| 87 | terminal types for one computer it may be better to selectively add |
---|
| 88 | the <envar>GROFF_NO_SGR</envar> environment variable for the terminals |
---|
| 89 | that do not support SGR.</para> |
---|
| 90 | </note> |
---|
| 91 | |
---|
[d1631d1] | 92 | <para os="q">If the character set of the locale uses 8-bit characters, search |
---|
[3f8be484] | 93 | for the line beginning with <quote>NROFF</quote> in |
---|
| 94 | <filename>/etc/man.conf</filename>, and verify that it matches the |
---|
| 95 | following:</para> |
---|
| 96 | |
---|
[d1631d1] | 97 | <screen os="r">NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen> |
---|
[3f8be484] | 98 | |
---|
[d1631d1] | 99 | <para os="s">Note that <quote>latin1</quote> should be used even if it is not |
---|
[3f8be484] | 100 | the character set of the locale. The reason is that, according to the |
---|
| 101 | specification, <command>groff</command> has no means of typesetting |
---|
| 102 | characters outside International Organization for Standards (ISO) 8859-1 |
---|
| 103 | without some strange escape codes. When formatting man pages, |
---|
| 104 | <command>groff</command> thinks that they are in the ISO 8859-1 encoding |
---|
| 105 | and this <parameter>-Tlatin1</parameter> switch tells |
---|
| 106 | <command>groff</command> to use the same encoding for output. Since |
---|
| 107 | <command>groff</command> does no recoding of input characters, the f |
---|
| 108 | ormatted result is really in the same encoding as input, and therefore |
---|
| 109 | it is usable as the input for a pager.</para> |
---|
| 110 | |
---|
[d1631d1] | 111 | <para os="t">This does not solve the problem of a non-working |
---|
[3f8be484] | 112 | <command>man2dvi</command> program for localized man pages in |
---|
| 113 | non-ISO 8859-1 locales. Also, it does not work with multibyte |
---|
| 114 | character sets. The first problem does not currently have a solution. |
---|
[fb40919] | 115 | The second issue is not of concern because the CLFS installation does |
---|
[3f8be484] | 116 | not support multibyte character sets.</para> |
---|
| 117 | |
---|
| 118 | </sect2> |
---|
| 119 | |
---|
| 120 | <sect2 id="contents-man" role="content"> |
---|
| 121 | <title>Contents of Man</title> |
---|
| 122 | |
---|
| 123 | <segmentedlist> |
---|
| 124 | <segtitle>Installed programs</segtitle> |
---|
| 125 | |
---|
| 126 | <seglistitem> |
---|
| 127 | <seg>apropos, makewhatis, man, man2dvi, man2html, and whatis</seg> |
---|
| 128 | </seglistitem> |
---|
| 129 | </segmentedlist> |
---|
| 130 | |
---|
| 131 | <variablelist> |
---|
| 132 | <bridgehead renderas="sect3">Short Descriptions</bridgehead> |
---|
| 133 | <?dbfo list-presentation="list"?> |
---|
| 134 | <?dbhtml list-presentation="table"?> |
---|
| 135 | |
---|
| 136 | <varlistentry id="apropos"> |
---|
| 137 | <term><command>apropos</command></term> |
---|
| 138 | <listitem> |
---|
| 139 | <para>Searches the <command>whatis</command> database and |
---|
| 140 | displays the short descriptions of system commands that contain |
---|
| 141 | a given string</para> |
---|
| 142 | <indexterm zone="ch-system-man apropos"> |
---|
| 143 | <primary sortas="b-apropos">apropos</primary> |
---|
| 144 | </indexterm> |
---|
| 145 | </listitem> |
---|
| 146 | </varlistentry> |
---|
| 147 | |
---|
| 148 | <varlistentry id="makewhatis"> |
---|
| 149 | <term><command>makewhatis</command></term> |
---|
| 150 | <listitem> |
---|
| 151 | <para>Builds the <command>whatis</command> database; it reads all |
---|
| 152 | the man pages in the <envar>MANPATH</envar> and writes the name |
---|
| 153 | and a short description in the <command>whatis</command> database |
---|
| 154 | for each page</para> |
---|
| 155 | <indexterm zone="ch-system-man makewhatis"> |
---|
| 156 | <primary sortas="b-makewhatis">makewhatis</primary> |
---|
| 157 | </indexterm> |
---|
| 158 | </listitem> |
---|
| 159 | </varlistentry> |
---|
| 160 | |
---|
| 161 | <varlistentry id="man"> |
---|
| 162 | <term><command>man</command></term> |
---|
| 163 | <listitem> |
---|
| 164 | <para>Formats and displays the requested on-line man page</para> |
---|
| 165 | <indexterm zone="ch-system-man man"> |
---|
| 166 | <primary sortas="b-man">man</primary> |
---|
| 167 | </indexterm> |
---|
| 168 | </listitem> |
---|
| 169 | </varlistentry> |
---|
| 170 | |
---|
| 171 | <varlistentry id="man2dvi"> |
---|
| 172 | <term><command>man2dvi</command></term> |
---|
| 173 | <listitem> |
---|
| 174 | <para>Converts a man page into dvi format</para> |
---|
| 175 | <indexterm zone="ch-system-man man2dvi"> |
---|
| 176 | <primary sortas="b-man2dvi">man2dvi</primary> |
---|
| 177 | </indexterm> |
---|
| 178 | </listitem> |
---|
| 179 | </varlistentry> |
---|
| 180 | |
---|
| 181 | <varlistentry id="man2html"> |
---|
| 182 | <term><command>man2html</command></term> |
---|
| 183 | <listitem> |
---|
| 184 | <para>Converts a man page into HTML</para> |
---|
| 185 | <indexterm zone="ch-system-man man2html"> |
---|
| 186 | <primary sortas="b-man2html">man2html</primary> |
---|
| 187 | </indexterm> |
---|
| 188 | </listitem> |
---|
| 189 | </varlistentry> |
---|
| 190 | |
---|
| 191 | <varlistentry id="whatis"> |
---|
| 192 | <term><command>whatis</command></term> |
---|
| 193 | <listitem> |
---|
| 194 | <para>Searches the <command>whatis</command> database and |
---|
| 195 | displays the short descriptions of system commands that |
---|
| 196 | contain the given keyword as a separate word</para> |
---|
| 197 | <indexterm zone="ch-system-man whatis"> |
---|
| 198 | <primary sortas="b-whatis">whatis</primary> |
---|
| 199 | </indexterm> |
---|
| 200 | </listitem> |
---|
| 201 | </varlistentry> |
---|
| 202 | |
---|
| 203 | </variablelist> |
---|
| 204 | |
---|
| 205 | </sect2> |
---|
| 206 | |
---|
| 207 | </sect1> |
---|