APROPOS(1) User Commands APROPOS(1)
NAME apropos, whatis
- locate commands by keyword lookup
] [-s section
] keyword ... whatis
] [-s section
] keyword ...
utility displays the man page name, section number, and a short
description for each man page whose NAME
line contains keyword
information is contained in the whatis
database created by the -w
used with man(1)
. If this database is not present, apropos
Each word is considered separately and the case of letters is ignored.
Words which are part of other words are considered; for example, when
looking for `compile', apropos
finds all instances of `compiler' also.
command performs the same search, but only matches whole words.
In the above example, whatis
would not match the instances of `compiler'
command is actually just the -k
option to the man(1)
OPTIONS -M path
Force a specific colon separated manual path instead of the
default search path. Overrides the MANPATH environment
variable. -s section
Restrict search to specified section.
MANPATH, PATH Used to find the location of the whatis
table of contents and keyword database
EXAMPLES Example 1 To find a man page whose NAME line contains a keyword
example% apropos password
If the line starts `filename
) ...' you can run
% man -s section filename
to display the man page for filename
. Example 2 To find the man page for the subroutine printf()
example% man -s 3C
to get the manual page on the subroutine printf(3C)
/usr/share/man/whatis: No such file or directory
database does not exist. The command man -w
must be run
to create it.
CODE SET INDEPENDENCE
INTERFACE STABILITY Committed
SEE ALSO man(1)
OmniOS July 20, 2014 OmniOS