mirror of
https://git.linuxfromscratch.org/lfs.git
synced 2026-05-20 05:10:27 -04:00
3ed279fe4d
git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/testing/BOOK@4009 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
181 lines
6.4 KiB
XML
181 lines
6.4 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../general.ent">
|
|
%general-entities;
|
|
]>
|
|
<sect1 id="ch-system-man" xreflabel="Man" role="wrap">
|
|
<title>Man-&man-version;</title>
|
|
<?dbhtml filename="man.html"?>
|
|
|
|
<indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm>
|
|
|
|
<sect2 role="package"><title/>
|
|
<para>The Man package contains programs for finding and viewing manual pages.</para>
|
|
|
|
<segmentedlist>
|
|
<segtitle>&buildtime;</segtitle>
|
|
<segtitle>&diskspace;</segtitle>
|
|
<seglistitem><seg>0.1 SBU</seg><seg>1.9MB</seg></seglistitem>
|
|
</segmentedlist>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Man installation depends on</segtitle>
|
|
<seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC,
|
|
Glibc, Grep, Make, Sed</seg></seglistitem>
|
|
</segmentedlist>
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of Man</title>
|
|
|
|
<para>Three adjustments need to be made to the sources of Man.</para>
|
|
|
|
<para>The first is a patch which allows Man to work better with recent
|
|
releases of Groff. In particular, man pages will now display using the
|
|
full terminal width instead of being limited to 80 characters:</para>
|
|
|
|
<screen><userinput>patch -Np1 -i ../man-&man-version;-80cols-1.patch</userinput></screen>
|
|
|
|
<para>The second is a sed substitution to add the
|
|
<parameter>-R</parameter> switch to the <emphasis>PAGER</emphasis>
|
|
variable so that escape sequences are properly handled by Less:</para>
|
|
|
|
<screen><userinput>sed -i 's@-is@&R@g' configure</userinput></screen>
|
|
|
|
<para>The third is also a sed substitution to comment out the
|
|
<quote>MANPATH /usr/man</quote> line in the
|
|
<filename>man.conf</filename> file to prevent redundant results when
|
|
using programs such as <command>whatis</command>:</para>
|
|
|
|
<screen><userinput>sed -i 's@MANPATH./usr/man@#&@g' src/man.conf.in</userinput></screen>
|
|
|
|
<para>Prepare Man for compilation:</para>
|
|
|
|
<screen><userinput>./configure -confdir=/etc</userinput></screen>
|
|
|
|
<para>The meaning of the configure options:</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>-confdir=/etc</parameter></term>
|
|
<listitem><para>This tells the man program to look for the
|
|
<filename>man.conf</filename> configuration file in the <filename
|
|
class="directory">/etc</filename> directory.</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<para>Compile the package:</para>
|
|
|
|
<screen><userinput>make</userinput></screen>
|
|
|
|
<para>Install the package:</para>
|
|
|
|
<screen><userinput>make install</userinput></screen>
|
|
|
|
<note><para>To disable Select Graphic Rendition (SGR) escape
|
|
sequences, you should edit the <filename>man.conf</filename> file and
|
|
add the <parameter>-c</parameter> switch to
|
|
the <quote>NROFF</quote> variable.</para></note>
|
|
|
|
<para>If your character set uses 8-bit characters, search for the line
|
|
beginning with <quote>NROFF</quote> in
|
|
<filename>/etc/man.conf</filename>, and verify that it looks as
|
|
follows:</para>
|
|
|
|
<screen>NROFF /usr/bin/nroff -Tlatin1 -mandoc</screen>
|
|
|
|
<para>Note that <quote>latin1</quote> should be used even if it is not
|
|
the character set of the locale. The reason is that, according to the
|
|
specification, <command>groff</command> has no means of typesetting
|
|
characters outside ISO-8859-1 without some strange escape codes. When
|
|
formatting manual pages, <command>groff</command> thinks that they are
|
|
in the ISO-8859-1 encoding and this <parameter>-Tlatin1</parameter>
|
|
switch tells <command>groff</command> to use the same encoding for
|
|
output. Since <command>groff</command> does no recoding of input
|
|
characters, the formatted result is really in the same encoding as
|
|
input and therefore it is usable as the input for a pager.</para>
|
|
|
|
<para>This does not solve the problem of a non-working
|
|
<command>man2dvi</command> program for localized manual pages in
|
|
non-ISO-8859-1 locales. Also, it does not work with multibyte
|
|
character sets. The first problem does not currently have a solution.
|
|
The second issue is not of a concern because the LFS installation does
|
|
not support multibyte character sets.</para>
|
|
|
|
<para>Users can also refer to the BLFS page at <ulink
|
|
url="&blfs-root;view/cvs/postlfs/compressdoc.html"/> which deals with
|
|
formatting and compression issues for man pages.</para>
|
|
|
|
</sect2>
|
|
|
|
|
|
<sect2 id="contents-man" role="content"><title>Contents of Man</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed programs</segtitle>
|
|
<seglistitem><seg>apropos, makewhatis, man,
|
|
man2dvi, man2html and whatis</seg></seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist><bridgehead renderas="sect3">Short descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
|
|
<varlistentry id="apropos">
|
|
<term><command>apropos</command></term>
|
|
<listitem>
|
|
<para>searches the whatis database and displays the short descriptions
|
|
of system commands that contain a given string.</para>
|
|
<indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="makewhatis">
|
|
<term><command>makewhatis</command></term>
|
|
<listitem>
|
|
<para>builds the whatis database. It reads all the manual pages in the
|
|
manpath and writes the name and a short description in the whatis
|
|
database for each page.</para>
|
|
<indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="man">
|
|
<term><command>man</command></term>
|
|
<listitem>
|
|
<para>formats and displays the requested on-line manual page.</para>
|
|
<indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="man2dvi">
|
|
<term><command>man2dvi</command></term>
|
|
<listitem>
|
|
<para>converts a manual page into dvi format.</para>
|
|
<indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="man2html">
|
|
<term><command>man2html</command></term>
|
|
<listitem>
|
|
<para>converts a manual page into html.</para>
|
|
<indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="whatis">
|
|
<term><command>whatis</command></term>
|
|
<listitem>
|
|
<para>searches the whatis database and displays the short descriptions
|
|
of system commands that contain the given keyword as a separate
|
|
word.</para>
|
|
<indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|
|
|