Return to whatis.1 CVS log

Up to [local] / src / usr.bin / whatis

Annotation of src/usr.bin/whatis/whatis.1, Revision 1.8

1.8     ! aaron       1: .\"    $OpenBSD: whatis.1,v 1.7 2000/04/01 05:05:35 millert Exp $
1.2       deraadt     2: .\"
1.1       deraadt     3: .\" Copyright (c) 1989, 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
                      5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
                     14: .\" 3. All advertising materials mentioning features or use of this software
                     15: .\"    must display the following acknowledgement:
                     16: .\"    This product includes software developed by the University of
                     17: .\"    California, Berkeley and its contributors.
                     18: .\" 4. Neither the name of the University nor the names of its contributors
                     19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
                     34: .\"     @(#)whatis.1   8.1 (Berkeley) 6/6/93
                     35: .\"
                     36: .Dd June 6, 1993
                     37: .Dt WHATIS 1
1.4       aaron      38: .Os
1.1       deraadt    39: .Sh NAME
                     40: .Nm whatis
                     41: .Nd describe what a command is
                     42: .Sh SYNOPSIS
                     43: .Nm whatis
                     44: .Op Fl M Ar path
                     45: .Op Fl m Ar path
1.3       aaron      46: .Ar command Op Ar ...
1.1       deraadt    47: .Sh DESCRIPTION
1.6       aaron      48: .Nm
1.1       deraadt    49: looks up a given command and gives the header line from the manual page.
                     50: You can then use the
                     51: .Xr man 1
                     52: command to get more information.
1.7       millert    53: .Nm
                     54: will match on a case insensitive basis and for multiple word entries
                     55: will match on each individual word.
1.1       deraadt    56: .Pp
                     57: The options are as follows:
1.8     ! aaron      58: .Bl -tag -width Ds
1.7       millert    59: .It Fl C Ar file
                     60: Specify an alternate configuration file in
                     61: .Xr man.conf 5
                     62: format.  The default is
                     63: .Pa /etc/man.conf .
1.1       deraadt    64: .It Fl M Ar path
                     65: Override the list of standard directories
1.6       aaron      66: .Nm
1.1       deraadt    67: searches for its database named
                     68: .Dq Pa whatis.db .
                     69: The supplied
                     70: .Ar path
                     71: must be a colon
1.6       aaron      72: .Pq Ql \&:
1.1       deraadt    73: separated list of directories.
                     74: This search path may also be set using the environment variable
                     75: .Ev MANPATH .
                     76: .It Fl m Ar path
                     77: Augment the list of standard directories
1.6       aaron      78: .Nm
1.1       deraadt    79: searches for its database named
                     80: .Dq Pa whatis.db .
                     81: The supplied
                     82: .Ar path
1.6       aaron      83: must be a colon-separated list of directories.
1.1       deraadt    84: These directories will be searched before the standard directories
                     85: or the directories supplied with the
                     86: .Fl M
                     87: option or the
                     88: .Ev MANPATH
                     89: environment variable are searched.
                     90: .El
                     91: .Sh ENVIRONMENT
1.6       aaron      92: The following environment variables affect the execution of
                     93: .Nm whatis :
1.1       deraadt    94: .Bl -tag -width MANPATH
                     95: .It Ev MANPATH
                     96: The standard search path used by
                     97: .Xr man 1
                     98: may be overridden by specifying a path in the
                     99: .Ev MANPATH
                    100: environment variable.
                    101: .El
                    102: .Sh FILES
                    103: .Bl -tag -width whatis.db
                    104: .It Pa whatis.db
                    105: name of the whatis database
                    106: .El
                    107: .Sh SEE ALSO
                    108: .Xr apropos 1 ,
                    109: .Xr man 1 ,
1.5       aaron     110: .Xr whereis 1 ,
1.7       millert   111: .Xr which 1 ,
                    112: .Xr man.conf 5
1.1       deraadt   113: .Sh HISTORY
                    114: The
                    115: .Nm
                    116: command appeared in
                    117: .Bx 3.0 .