xref: /original-bsd/usr.bin/whatis/whatis.1 (revision da7c76f1)
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.

@(#)whatis.1 6.6 (Berkeley) 05/27/90

WHATIS 1 ""
C 4
NAME
whatis - describe what a command is
SYNOPSIS
whatis [-M path] [-m path] command ...
DESCRIPTION
Whatis looks up a given command and gives the header line from the manual page. You can then use the man (1) command to get more information.

The options are as follows:

M Override the list of standard directories where whatis searches for its database named ``whatis.db''. 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 whatis searches for its database named ``whatis.db''. 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 whatis database
"SEE ALSO"
apropos(1), man(1), whereis(1)