– General Linux 2 – Use and manage local system documentation [4]
(Linux Professional Institute Certification)
a .˜. /V\ by: geoffrey robertson // \\ geoffrey@zip.com.au @._.@ %% $Id: gl2.108.1.slides.tex,v 1.2 2003/10/22 05:38:14 geoffr Exp $

c 2003 Geoffrey Robertson. Permission is granted to make and distribute verbatim copies or modified versions of this document provided that this copyright notice and this permission notice are preserved on all copies under the terms of the GNU General Public License as published by the Free Software Foundation—either version 2 of the License or (at your option) any later version.

a Copyright

1

Documentation
2.108.1 Use and Manage Local System Documentation [4] 2.108.2 Find Linux Documentation on the Internet [3] 2.108.5 Notify Users on System Related Issues [1]

2

Use and Manage Local System Documentation
Objective
Candidates should be able to use and administer the man facility and the material in /usr/share/doc/. This objective includes finding relevant man pages, searching man page sections, finding commands and man pages related to them, and configuring access to man sources and the man system. It also includes using system documentation stored in /usr/share/doc/ and determining what documentation to keep in /usr/share/doc/.

3

Use and Manage Local System Documentation
Key files, terms, and utilities
MANPATH man apropos whatis

4

Use and Manage Local System Documentation
Resources

5

Using whatis
display manual page descriptions

6

Using whatis
display manual page descriptions
whatis searches the manual page names and displays the manual page descrip tions of any name matched.

6-a

Using whatis
display manual page descriptions
whatis searches the manual page names and displays the manual page descrip tions of any name matched. $ whatis nmap ← nmap (1) - Network exploration tool and security scanner

6-b

Using whatis
display manual page descriptions
whatis searches the manual page names and displays the manual page descrip tions of any name matched. $ whatis nmap ← nmap (1) - Network exploration tool and security scanner (in Debian Woody but not RH9.0) Interpret each name as a regular expression. $ whatis -r ˆifc ← ifconfig (8) - configure a network interface
6-c

-r, --regex

Using apropos
search the manual page names and descriptions
Each manual page has a short description available within it. apropos searches the descriptions for instances of keyword.

7

Using apropos
search the manual page names and descriptions
Each manual page has a short description available within it. apropos searches the descriptions for instances of keyword. $ apropos nmap ← MapWindow (3tk) mmap (2) munmap (2) nmap (1) k_MapWindow (3tk) ... map or unmap a window map or unmap files or d map or unmap files or devi Network exploration tool and - map or unmap a window -

7-a