Return to whatis.1 CVS log

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

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

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