diff options
author | Matthew Burgess <matthew@linuxfromscratch.org> | 2004-05-03 10:59:46 +0000 |
---|---|---|
committer | Matthew Burgess <matthew@linuxfromscratch.org> | 2004-05-03 10:59:46 +0000 |
commit | 673b0d84ba9591e07c0bdf0ee49d92eba10f502c (patch) | |
tree | 129e27a1450727b440da4378e0117a468eb9c25e /chapter06/man.xml | |
parent | 287ea55da70ceb1f0990554b7db921d525fef816 (diff) |
* Merged newxml into HEAD
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@3435 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
Diffstat (limited to 'chapter06/man.xml')
-rw-r--r-- | chapter06/man.xml | 78 |
1 files changed, 60 insertions, 18 deletions
diff --git a/chapter06/man.xml b/chapter06/man.xml index d308a1263..37ec8c8e9 100644 --- a/chapter06/man.xml +++ b/chapter06/man.xml @@ -1,16 +1,23 @@ +<?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"> -<title>Installing Man-&man-version;</title> -<?dbhtml filename="man.html" dir="chapter06"?> +<title>Man-&man-version;</title> +<?dbhtml filename="man.html"?> + +<indexterm zone="ch-system-man"><primary sortas="a-Man">Man</primary></indexterm> <para>The Man package contains programs for finding and viewing manual pages.</para> -<screen>&buildtime; &man-time; -&diskspace; &man-compsize;</screen> +<screen>&buildtime; 0.1 SBU +&diskspace; 1.9MB</screen> + +<para>Man installation depends on: Bash, Binutils, Coreutils, Gawk, GCC, +Glibc, Grep, Make, Sed.</para> -&aa-man-down; -&aa-man-dep; -<sect2><title> </title><para> </para></sect2> <sect2> <title>Installation of Man</title> @@ -21,7 +28,7 @@ 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-80cols-patch;</userinput></screen> +<screen><userinput>patch -Np1 -i ../man-&man-version;-80cols.patch</userinput></screen> <para>The second is a sed substitution to add the <emphasis>-R</emphasis> switch to the <emphasis>PAGER</emphasis> variable so that escape sequences are @@ -29,9 +36,9 @@ properly handled by Less:</para> <screen><userinput>sed -i 's/-is/&R/' configure</userinput></screen> -<para>The third is also a sed substitution to comment out the "MANPATH -/usr/man" line in the <filename>man.conf</filename> file to prevent redundant -results when using programs such as <command>whatis</command>:</para> +<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%#&%' src/man.conf.in</userinput></screen> @@ -46,8 +53,8 @@ results when using programs such as <command>whatis</command>:</para> to select a sensible set of default options. For example: only English man pages, no message catalogs, man not suid, handle compressed man pages, compress cat pages, create cat pages whenever the appropriate directory exists, follow -FHS by putting cat pages under /var/cache/man provided that that directory -exists.</para></listitem> +FHS by putting cat pages under /var/cache/man (provided that directory +exists).</para></listitem> <listitem><para><userinput>-confdir=/etc</userinput>: This tells the <command>man</command> program to look for the <filename>man.conf</filename> @@ -58,11 +65,11 @@ configuration file in the <filename>/etc</filename> directory.</para></listitem> <screen><userinput>make</userinput></screen> -<para>And install it:</para> +<para>Lastly, install it:</para> <screen><userinput>make install</userinput></screen> -<note><para>If you wish to disable SGR escape sequences, you should edit the +<note><para>If you wish to disable SGR (Select Graphic Rendition) escape sequences, you should edit the <filename>man.conf</filename> file and add the <emphasis>-c</emphasis> switch to NROFF.</para></note> @@ -72,8 +79,43 @@ formatting and compression issues for man pages.</para> </sect2> -&aa-man-shortdesc; -&aa-man-desc; -</sect1> +<sect2 id="contents-man"><title>Contents of Man</title> + +<para><emphasis>Installed programs</emphasis>: apropos, makewhatis, man, +man2dvi, man2html and whatis</para> + +</sect2> + + +<sect2><title>Short descriptions</title> + +<indexterm zone="ch-system-man apropos"><primary sortas="b-apropos">apropos</primary></indexterm> +<para id="apropos"><command>apropos</command> searches the whatis database and displays +the short descriptions of system commands that contain a given string.</para> + +<indexterm zone="ch-system-man makewhatis"><primary sortas="b-makewhatis">makewhatis</primary></indexterm> +<para id="makewhatis"><command>makewhatis</command> builds the whatis database. It reads +all the manual pages in the manpath and for each page writes the name and a +short description in the whatis database.</para> +<indexterm zone="ch-system-man man"><primary sortas="b-man">man</primary></indexterm> +<para id="man"><command>man</command> formats and displays the requested on-line +manual page.</para> + +<indexterm zone="ch-system-man man2dvi"><primary sortas="b-man2dvi">man2dvi</primary></indexterm> +<para id="man2dvi"><command>man2dvi</command> converts a manual page into dvi format.</para> + +<indexterm zone="ch-system-man man2html"><primary sortas="b-man2html">man2html</primary></indexterm> +<para id="man2html"><command>man2html</command> converts a manual page into html.</para> + +<indexterm zone="ch-system-man whatis"><primary sortas="b-whatis">whatis</primary></indexterm> +<para id="whatis"><command>whatis</command> searches the whatis database and displays +the short descriptions of system commands that contain the given keyword as a +separate word.</para> + +</sect2> + + + +</sect1> |