Return to apropos.1 CVS log

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

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

1.1     ! deraadt     1: .\"     $NetBSD: apropos.1,v 1.4 1995/09/04 20:46:17 tls Exp $
        !             2: .\"
        !             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: .\"    @(#)apropos.1   8.1 (Berkeley) 6/29/93
        !            35: .\"
        !            36: .Dd June 29, 1993
        !            37: .Dt APROPOS 1
        !            38: .Os
        !            39: .Sh NAME
        !            40: .Nm apropos
        !            41: .Nd locate commands by keyword lookup
        !            42: .Sh SYNOPSIS
        !            43: .Nm apropos
        !            44: .Op Fl M Ar path
        !            45: .Op Fl m Ar path
        !            46: .Ar keyword ...
        !            47: .Sh DESCRIPTION
        !            48: .Nm Apropos
        !            49: shows which manual pages contain instances of any of the given
        !            50: .Ar keyword(s)
        !            51: in their title line.
        !            52: Each word is considered separately and case of letters is ignored.
        !            53: Words which are part of other words are considered; when looking for
        !            54: .Dq compile ,
        !            55: .Nm apropos
        !            56: will also list all instances of
        !            57: .Dq compiler .
        !            58: .Pp
        !            59: If the line output by
        !            60: .Nm apropos
        !            61: starts
        !            62: .Dq Li name(section) ...
        !            63: you can enter
        !            64: .Dq Li man section name
        !            65: to get
        !            66: its documentation.
        !            67: .Pp
        !            68: The options are as follows:
        !            69: .Bl -tag -width flag
        !            70: .It Fl M
        !            71: Override the list of standard directories
        !            72: .Nm apropos
        !            73: searches for a database named
        !            74: .Pa whatis.db .
        !            75: The supplied
        !            76: .Ar path
        !            77: must be a colon
        !            78: .Dq \&:
        !            79: separated list of directories.
        !            80: This search path may also be set using the environment variable
        !            81: .Ev MANPATH .
        !            82: .It Fl m
        !            83: Augment the list of standard directories
        !            84: .Nm apropos
        !            85: searches for its database.
        !            86: The supplied
        !            87: .Ar path
        !            88: must be a colon
        !            89: .Dq \&:
        !            90: separated list of directories.
        !            91: These directories will be searched before the standard directories,
        !            92: or the directories supplied with the
        !            93: .Fl M
        !            94: option or the
        !            95: .Ev MANPATH
        !            96: environment variable.
        !            97: .Sh ENVIRONMENT
        !            98: .Bl -tag -width MANPATH
        !            99: .It Ev MANPATH
        !           100: The standard search path used by
        !           101: .Xr man 1
        !           102: may be overridden by specifying a path in the
        !           103: .Ev MANPATH
        !           104: environment variable.
        !           105: The format of the path is a colon
        !           106: .Dq \&:
        !           107: separated list of directories.
        !           108: .El
        !           109: .Sh FILES
        !           110: .Bl -tag -width whatis.db -compact
        !           111: .It Pa whatis.db
        !           112: name of the apropos database
        !           113: .El
        !           114: .Sh SEE ALSO
        !           115: .Xr man 1 ,
        !           116: .Xr whatis 1 ,
        !           117: .Xr whereis 1
        !           118: .Sh HISTORY
        !           119: The
        !           120: .Nm apropos
        !           121: command appeared in
        !           122: .Bx 3.0 .