|
Hopefully, this page is exactly what you are looking for, but if not, you can always find further assistance on Unix/Linux Forum!
whatis(1) Manual pager utils whatis(1)
NAME
whatis - display manual page descriptions
SYNOPSIS
whatis [-dhV] [-r|-w] [-m system[,...]] [-M path] name ...
DESCRIPTION
Each manual page has a short description available within it. whatis
searches the manual page names and displays the manual page descrip-
tions of any name matched.
name may contain wildcards (-w) or be a regular expression (-r). Using
these options, it may be necessary to quote the name or escape (\) the
special characters to stop the shell from interpreting them.
index databases are used during the search. To produce an old style
text whatis database from the relative index database, issue the com-
mand:
whatis -M manpath -w '*' | sort > manpath/whatis
where manpath is a manual page hierarchy such as /usr/man.
OPTIONS
-d, --debug
Print debugging information.
-r, --regex
Interpret each name as a regular expression. If a name matches
any part of a page name, a match will be made. This option
causes whatis to be somewhat slower due to the nature of
database searches.
-w, --wildcard
Interpret each name as a pattern containing shell style wild-
cards. For a match to be made, an expanded name must match the
entire page name. This option causes whatis to be somewhat
slower due to the nature of database searches.
-m system[,...], --systems=system[,...]
If this system has access to other operating system's manual
page names, they can be accessed using this option. To search
NewOS's manual page names, use the option -m NewOS.
The system specified can be a combination of comma delimited
operating system names. To include a search of the native oper-
ating system's manual page names, include the system name man in
the argument string. This option will override the $SYSTEM
environment variable.
-M path, --manpath=path
Specify an alternate set of colon-delimited manual page hierar-
chies to search. By default, apropos uses the $MANPATH environ-
ment variable, unless it is empty or unset, in which case it
will determine an appropriate manpath based on your $PATH envi-
ronment variable. This option overrides the contents of $MAN
PATH.
-h, --help
Print a help message and exit.
-V, --version
Display version and author information.
EXIT STATUS
0 Successful program execution.
1 Usage, syntax or configuration file error.
2 Operational error.
16 No manual pages were found that matched the criteria specified.
ENVIRONMENT
SYSTEM If $SYSTEM is set, it will have the same effect as if it had
been specified as the argument to the -m option.
MANPATH
If $MANPATH is set, its value is interpreted as the colon-delim-
ited manual page hierarchy search path to use.
FILES
/usr/share/man/index.(bt|db|dir|pag)
A traditional global index database cache.
/var/cache/man/index.(bt|db|dir|pag)
An alternate or FSSTND compliant global index database cache.
/usr/share/man/.../whatis
A traditional whatis text database.
SEE ALSO
apropos(1), man(1).
AUTHOR
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
2.4.1 07 September 2001 whatis(1)
Man(1) output converted with
man2html and wrapped by fishsponge
This page was generated on Tue Feb 13 02:17:27 GMT 2007
|
Your favourite pages:
No pages logged yet. Trying to save cookie... Top 10 most popular pages:
sqlite3 man page (5323 hits) (openSUSE 10.2)
svn man page (5172 hits) (FreeBSD 6.2)
adv_cap_autoneg man page (4865 hits) (Solaris 10 11_06)
CPAN man page (4602 hits) (Suse Linux 10.1)
ssh man page (4337 hits) (Suse Linux 10.1)
ssh-socks5-proxy-connect man page (2841 hits) (Solaris 10 11_06)
netcat man page (2688 hits) (Suse Linux 10.1)
pprosetup man page (2473 hits) (Solaris 10 11_06)
startproc man page (2453 hits) (Suse Linux 10.1)
signal man page (2394 hits) (Suse Linux 10.1)
|