Changeset 81fd230 for chapter06/man.xml
- Timestamp:
- 02/19/2005 10:16:42 PM (19 years ago)
- Branches:
- 10.0, 10.0-rc1, 10.1, 10.1-rc1, 11.0, 11.0-rc1, 11.0-rc2, 11.0-rc3, 11.1, 11.1-rc1, 11.2, 11.2-rc1, 11.3, 11.3-rc1, 12.0, 12.0-rc1, 12.1, 12.1-rc1, 6.1, 6.1.1, 6.3, 6.4, 6.5, 6.6, 6.7, 6.8, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5, 7.5-systemd, 7.6, 7.6-systemd, 7.7, 7.7-systemd, 7.8, 7.8-systemd, 7.9, 7.9-systemd, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, arm, bdubbs/gcc13, ml-11.0, multilib, renodr/libudev-from-systemd, s6-init, trunk, xry111/arm64, xry111/arm64-12.0, xry111/clfs-ng, xry111/lfs-next, xry111/loongarch, xry111/loongarch-12.0, xry111/loongarch-12.1, xry111/mips64el, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
- Children:
- 3d31fc4
- Parents:
- 2f9131f
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
chapter06/man.xml
r2f9131f r81fd230 4 4 %general-entities; 5 5 ]> 6 <sect1 id="ch-system-man" xreflabel="Man"role="wrap">6 <sect1 id="ch-system-man" role="wrap"> 7 7 <title>Man-&man-version;</title> 8 8 <?dbhtml filename="man.html"?> … … 11 11 12 12 <sect2 role="package"><title/> 13 <para>The Man package contains programs for finding and viewing manual pages.</para> 13 14 14 15 <segmentedlist> … … 18 19 </segmentedlist> 19 20 21 <segmentedlist> 22 <segtitle>Man installation depends on</segtitle> 23 <seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC, 24 Glibc, Grep, Make, and Sed</seg></seglistitem> 25 </segmentedlist> 20 26 </sect2> 21 27 … … 23 29 <title>Installation of Man</title> 24 30 25 <para>Issue a sed substitution:</para> 31 <para>Two adjustments need to be made to the sources of Man.</para> 32 33 <para>The first is a sed substitution to add the 34 <parameter>-R</parameter> switch to the <envar>PAGER</envar> 35 variable so that escape sequences are properly handled by Less:</para> 26 36 27 37 <screen><userinput>sed -i 's@-is@&R@g' configure</userinput></screen> 28 38 29 <para>Issue another sed substitution:</para> 39 <para>The second is also a sed substitution to comment out the 40 <quote>MANPATH /usr/man</quote> line in the 41 <filename>man.conf</filename> file to prevent redundant results when 42 using programs such as <command>whatis</command>:</para> 30 43 31 44 <screen><userinput>sed -i 's@MANPATH./usr/man@#&@g' src/man.conf.in</userinput></screen> 32 45 33 <para> Now prepare Man for compilation:</para>46 <para>Prepare Man for compilation:</para> 34 47 35 48 <screen><userinput>./configure -confdir=/etc</userinput></screen> 49 50 <para>The meaning of the configure options:</para> 51 52 <variablelist> 53 <varlistentry> 54 <term><parameter>-confdir=/etc</parameter></term> 55 <listitem><para>This tells the <command>man</command> program to look for the 56 <filename>man.conf</filename> configuration file in the <filename 57 class="directory">/etc</filename> directory.</para></listitem> 58 </varlistentry> 59 </variablelist> 36 60 37 61 <para>Compile the package:</para> … … 39 63 <screen><userinput>make</userinput></screen> 40 64 41 <para> Lastly, install it:</para>65 <para>Install the package:</para> 42 66 43 67 <screen><userinput>make install</userinput></screen> 44 68 45 <para>For some internazionalitation issues, see testing.</para> 69 <note><para>To disable Select Graphic Rendition (SGR) escape 70 sequences, edit the <filename>man.conf</filename> file and 71 add the <parameter>-c</parameter> switch to 72 the <envar>NROFF</envar> variable.</para></note> 73 74 <para>If the character set uses 8-bit characters, search for the line 75 beginning with <quote>NROFF</quote> in 76 <filename>/etc/man.conf</filename>, and verify that it looks as 77 follows:</para> 78 79 <screen>NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen> 80 81 <para>Note that <quote>latin1</quote> should be used even if it is not 82 the character set of the locale. The reason is that, according to the 83 specification, <command>groff</command> has no means of typesetting 84 characters outside International Organization for Standards 85 (ISO) 8859-1 without some strange escape codes. When formatting manual 86 pages, <command>groff</command> thinks that they are in the ISO 8859-1 87 encoding and this <parameter>-Tlatin1</parameter> switch tells 88 <command>groff</command> to use the same encoding for output. Since 89 <command>groff</command> does no recoding of input characters, the 90 formatted result is really in the same encoding as input, and therefore 91 it is usable as the input for a pager.</para> 92 93 <para>This does not solve the problem of a non-working 94 <command>man2dvi</command> program for localized manual pages in 95 non-ISO 8859-1 locales. Also, it does not work with multibyte 96 character sets. The first problem does not currently have a solution. 97 The second issue is not of concern because the LFS installation does 98 not support multibyte character sets.</para> 99 100 <para>Additional information with regards to the compression of 101 man and info pages can be found in the BLFS book at 102 <ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"><phrase 103 condition="pdf">http://www.linuxfromscratch.org/blfs/view/cvs/postlfs/ 104 compressdoc.html</phrase></ulink>.</para> 46 105 47 106 </sect2> … … 50 109 <sect2 id="contents-man" role="content"><title>Contents of Man</title> 51 110 52 <para>See testing</para> 111 <segmentedlist> 112 <segtitle>Installed programs</segtitle> 113 <seglistitem><seg>apropos, makewhatis, man, 114 man2dvi, man2html, and whatis</seg></seglistitem> 115 </segmentedlist> 116 117 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 118 <?dbfo list-presentation="list"?> 119 120 <varlistentry id="apropos"> 121 <term><command>apropos</command></term> 122 <listitem> 123 <para>Searches the whatis database and displays the short descriptions 124 of system commands that contain a given string</para> 125 <indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm> 126 </listitem> 127 </varlistentry> 128 129 <varlistentry id="makewhatis"> 130 <term><command>makewhatis</command></term> 131 <listitem> 132 <para>Builds the whatis database; it reads all the manual pages in the 133 manpath and writes the name and a short description in the whatis 134 database for each page</para> 135 <indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm> 136 </listitem> 137 </varlistentry> 138 139 <varlistentry id="man"> 140 <term><command>man</command></term> 141 <listitem> 142 <para>Formats and displays the requested on-line manual page</para> 143 <indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm> 144 </listitem> 145 </varlistentry> 146 147 <varlistentry id="man2dvi"> 148 <term><command>man2dvi</command></term> 149 <listitem> 150 <para>Converts a manual page into dvi format</para> 151 <indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm> 152 </listitem> 153 </varlistentry> 154 155 <varlistentry id="man2html"> 156 <term><command>man2html</command></term> 157 <listitem> 158 <para>Converts a manual page into HTML</para> 159 <indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm> 160 </listitem> 161 </varlistentry> 162 163 <varlistentry id="whatis"> 164 <term><command>whatis</command></term> 165 <listitem> 166 <para>Searches the whatis database and displays the short descriptions 167 of system commands that contain the given keyword as a separate 168 word</para> 169 <indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm> 170 </listitem> 171 </varlistentry> 172 </variablelist> 53 173 54 174 </sect2> 55 175 56 176 </sect1> 177
Note:
See TracChangeset
for help on using the changeset viewer.