[BACK]Return to whatis.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / whatis

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

1.16    ! jmc         1: .\"    $OpenBSD: whatis.1,v 1.15 2011/10/09 02:20:39 schwarze 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: .\"
1.16    ! jmc        32: .Dd $Mdocdate: October 9 2011 $
1.1       deraadt    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
1.12      jmc        40: .Op Fl C Ar file
1.1       deraadt    41: .Op Fl M Ar path
                     42: .Op Fl m Ar path
1.14      sobrado    43: .Ar command ...
1.1       deraadt    44: .Sh DESCRIPTION
1.6       aaron      45: .Nm
1.1       deraadt    46: looks up a given command and gives the header line from the manual page.
                     47: You can then use the
                     48: .Xr man 1
                     49: command to get more information.
1.7       millert    50: .Nm
                     51: will match on a case insensitive basis and for multiple word entries
                     52: will match on each individual word.
1.1       deraadt    53: .Pp
                     54: The options are as follows:
1.8       aaron      55: .Bl -tag -width Ds
1.7       millert    56: .It Fl C Ar file
                     57: Specify an alternate configuration file in
                     58: .Xr man.conf 5
1.11      jmc        59: format.
                     60: The default is
1.7       millert    61: .Pa /etc/man.conf .
1.1       deraadt    62: .It Fl M Ar path
                     63: Override the list of standard directories
1.6       aaron      64: .Nm
1.1       deraadt    65: searches for its database named
                     66: .Dq Pa whatis.db .
                     67: The supplied
                     68: .Ar path
                     69: must be a colon
1.6       aaron      70: .Pq Ql \&:
1.1       deraadt    71: separated list of directories.
                     72: This search path may also be set using the environment variable
                     73: .Ev MANPATH .
                     74: .It Fl m Ar path
                     75: Augment the list of standard directories
1.6       aaron      76: .Nm
1.1       deraadt    77: searches for its database named
                     78: .Dq Pa whatis.db .
                     79: The supplied
                     80: .Ar path
1.6       aaron      81: must be a colon-separated list of directories.
1.1       deraadt    82: These directories will be searched before the standard directories
                     83: or the directories supplied with the
                     84: .Fl M
                     85: option or the
                     86: .Ev MANPATH
                     87: environment variable are searched.
                     88: .El
                     89: .Sh ENVIRONMENT
                     90: .Bl -tag -width MANPATH
                     91: .It Ev MANPATH
                     92: The standard search path used by
                     93: .Xr man 1
                     94: may be overridden by specifying a path in the
                     95: .Ev MANPATH
                     96: environment variable.
                     97: .El
                     98: .Sh FILES
1.12      jmc        99: .Bl -tag -width "/etc/man.conf" -compact
1.1       deraadt   100: .It Pa whatis.db
                    101: name of the whatis database
1.12      jmc       102: .It Pa /etc/man.conf
                    103: default
                    104: .Xr man 1
                    105: configuration file
1.1       deraadt   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 ,
1.12      jmc       112: .Xr man.conf 5 ,
                    113: .Xr makewhatis 8
1.1       deraadt   114: .Sh HISTORY
                    115: The
                    116: .Nm
1.15      schwarze  117: command first appeared in
                    118: .Bx 2 .
1.16    ! jmc       119: .Pp
1.15      schwarze  120: The
                    121: .Fl M
                    122: option first appeared in
                    123: .Bx 4.3 Tahoe ;
                    124: .Fl m
                    125: in
                    126: .Bx 4.3 Reno ;
                    127: and
                    128: .Fl C
                    129: in
                    130: .Nx 1.0 .
                    131: .Sh AUTHORS
                    132: .An Bill Joy