Changeset 94aa6621 for chapter06/man.xml


Ignore:
Timestamp:
12/26/2005 07:46:12 PM (19 years ago)
Author:
Archaic <archaic@…>
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, 12.2, 12.2-rc1, 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/loongarch-12.2, xry111/mips64el, xry111/multilib, xry111/pip3, xry111/rust-wip-20221008, xry111/update-glibc
Children:
b82f0c0
Parents:
5536f74
Message:

Reverting UTF-8 changes until everything is in place.

git-svn-id: ​http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7236 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

File:
1 edited

Legend:

Unmodified
Added
Removed

  • chapter06/man.xml

    r5536f74 r94aa6621  
     1<?xml version="1.0" encoding="ISO-8859-1"?>
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
     3  <!ENTITY % general-entities SYSTEM "../general.ent">
     4  %general-entities;
     5]>
     6<sect1 id="ch-system-man" role="wrap">
     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>
     11
     12<sect2 role="package"><title/>
     13<para>The Man package contains programs for finding and viewing man pages.</para>
     14
     15<segmentedlist>
     16<segtitle>&buildtime;</segtitle>
     17<segtitle>&diskspace;</segtitle>
     18<seglistitem><seg>0.1 SBU</seg><seg>1.3 MB</seg></seglistitem>
     19</segmentedlist>
     20
     21<segmentedlist>
     22<segtitle>&dependencies;</segtitle>
     23<seglistitem><seg>Bash, Binutils, Coreutils, Gawk, GCC,
     24Glibc, Grep, Make, and Sed</seg></seglistitem>
     25</segmentedlist>
     26</sect2>
     27
     28<sect2 role="installation">
     29<title>Installation of Man</title>
     30
     31<para>Two adjustments need to be made to the sources of Man.</para>
     32
     33<para>The first is a <command>sed</command> substitution to add the
     34<parameter>-R</parameter> switch to the <envar>PAGER</envar>
     35variable so that escape sequences are properly handled by Less:</para>
     36
     37<screen><userinput>sed -i 's@-is@&amp;R@g' configure</userinput></screen>
     38
     39<para>The second is also a <command>sed</command> 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
     42using programs such as <command>whatis</command>:</para>
     43
     44<screen><userinput>sed -i 's@MANPATH./usr/man@#&amp;@g' src/man.conf.in</userinput></screen>
     45
     46<para>Prepare Man for compilation:</para>
     47
     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
     57class="directory">/etc</filename> directory.</para></listitem>
     58</varlistentry>
     59</variablelist>
     60
     61<para>Compile the package:</para>
     62
     63<screen><userinput>make</userinput></screen>
     64
     65<para>This package does not come with a test suite.</para>
     66
     67<para>Install the package:</para>
     68
     69<screen><userinput>make install</userinput></screen>
     70
     71<note><para>If you will be working on a terminal that does not support text
     72attributes such as color and bold, you can disable Select Graphic Rendition
     73(SGR) escape sequences by editing the <filename>man.conf</filename> file and
     74adding the <parameter>-c</parameter> option to the <envar>NROFF</envar>
     75variable. If you use multiple terminal types for one computer it may be better
     76to selectively add the <envar>GROFF_NO_SGR</envar> environment variable for the
     77terminals that do not support SGR.</para></note>
     78
     79<para>If the character set of the locale uses 8-bit characters, search for the
     80line beginning with <quote>NROFF</quote> in <filename>/etc/man.conf</filename>,
     81and verify that it matches the following:</para>
     82
     83<screen>NROFF  /usr/bin/nroff -Tlatin1 -mandoc</screen>
     84
     85<para>Note that <quote>latin1</quote> should be used even if it is not
     86the character set of the locale. The reason is that, according to the
     87specification, <command>groff</command> has no means of typesetting
     88characters outside International Organization for Standards
     89(ISO) 8859-1 without some strange escape codes. When formatting man
     90pages, <command>groff</command> thinks that they are in the ISO 8859-1
     91encoding and this <parameter>-Tlatin1</parameter> switch tells
     92<command>groff</command> to use the same encoding for output. Since
     93<command>groff</command> does no recoding of input characters, the
     94formatted result is really in the same encoding as input, and therefore
     95it is usable as the input for a pager.</para>
     96
     97<para>This does not solve the problem of a non-working
     98<command>man2dvi</command> program for localized man pages in
     99non-ISO 8859-1 locales. Also, it does not work with multibyte
     100character sets. The first problem does not currently have a solution.
     101The second issue is not of concern because the LFS installation does
     102not support multibyte character sets.</para>
     103
     104<para>Additional information with regards to the compression of
     105man and info pages can be found in the BLFS book at
     106<ulink url="&blfs-root;view/cvs/postlfs/compressdoc.html"/>.</para>
     107
     108</sect2>
     109
     110
     111<sect2 id="contents-man" role="content"><title>Contents of Man</title>
     112
     113<segmentedlist>
     114<segtitle>Installed programs</segtitle>
     115<seglistitem><seg>apropos, makewhatis, man,
     116man2dvi, man2html, and whatis</seg></seglistitem>
     117</segmentedlist>
     118
     119<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
     120<?dbfo list-presentation="list"?>
     121<?dbhtml list-presentation="table"?>
     122
     123<varlistentry id="apropos">
     124<term><command>apropos</command></term>
     125<listitem>
     126<para>Searches the <command>whatis</command> database and displays the short descriptions
     127of system commands that contain a given string</para>
     128<indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm>
     129</listitem>
     130</varlistentry>
     131
     132<varlistentry id="makewhatis">
     133<term><command>makewhatis</command></term>
     134<listitem>
     135<para>Builds the <command>whatis</command> database; it reads all the man pages
     136in the <envar>MANPATH</envar> and writes the name and a short description in the
     137<command>whatis</command> database for each page</para>
     138<indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm>
     139</listitem>
     140</varlistentry>
     141
     142<varlistentry id="man">
     143<term><command>man</command></term>
     144<listitem>
     145<para>Formats and displays the requested on-line man page</para>
     146<indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm>
     147</listitem>
     148</varlistentry>
     149
     150<varlistentry id="man2dvi">
     151<term><command>man2dvi</command></term>
     152<listitem>
     153<para>Converts a man page into dvi format</para>
     154<indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm>
     155</listitem>
     156</varlistentry>
     157
     158<varlistentry id="man2html">
     159<term><command>man2html</command></term>
     160<listitem>
     161<para>Converts a man page into HTML</para>
     162<indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm>
     163</listitem>
     164</varlistentry>
     165
     166<varlistentry id="whatis">
     167<term><command>whatis</command></term>
     168<listitem>
     169<para>Searches the <command>whatis</command> database and displays the short descriptions
     170of system commands that contain the given keyword as a separate
     171word</para>
     172<indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm>
     173</listitem>
     174</varlistentry>
     175</variablelist>
     176
     177</sect2>
     178
     179</sect1>
     180
Note: See TracChangeset for help on using the changeset viewer.