xref: /csrg-svn/usr.bin/apropos/apropos.1 (revision 40389)
Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)apropos.1 6.6 (Berkeley) 03/11/90

APROPOS 1 ""
.AT 3
NAME
apropos - locate commands by keyword lookup
SYNOPSIS
apropos [-M path] [-m path] keyword ...
DESCRIPTION
Apropos shows which manual pages contain instances of any of the given keyword(s) in their title line. Each word is considered separately and case of letters is ignored. Words which are part of other words are considered; when looking for ``compile'', apropos will also list all instances of ``compiler''.

If the line output by apropos starts ``name(section) ...'' you can enter ``man section name'' to get its documentation.

The options are as follows:

M Override the list of standard directories where apropos searches for its database. The supplied path must be a colon (``:'') separated list of directories. This search path may also be set using the environmental variable MANPATH .

m Augment the list of standard directories where apropos searches for its database. The supplied path must be a colon (``:'') separated list of directories. These directories will be searched before the standard directories or the directories supplied with the M option or the MANPATH environmental variable are searched.

"ENVIRONMENTAL VARIABLES"

MANPATH The standard search path used by man may be overridden by specifying a path in the MANPATH environmental variable. The format of the path is a colon (``:'') separated list of directories.

FILES
whatis.db name of the apropos database
"SEE ALSO"
man(1), whatis(1), whereis(1)