Return to apropos.1 CVS log

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

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

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