Return to apropos.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.bin / man / apropos

Annotation of 43BSDReno/usr.bin/man/apropos/apropos.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1989, 1990 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)apropos.1  6.9 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt APROPOS 1
                     22: .Sh NAME
                     23: .Nm apropos
                     24: .Nd locate commands by keyword lookup
                     25: .Sh SYNOPSIS
                     26: .Nm apropos
                     27: .Op Fl M Ar path
                     28: .Op Fl m Ar path
                     29: .Ar keyword ...
                     30: .Sh DESCRIPTION
                     31: .Nm Apropos
                     32: shows which manual pages contain instances of any of the given
                     33: .Ar keyword(s)
                     34: in their title line.
                     35: Each word is considered separately and case of letters is ignored.
                     36: Words which are part of other words are considered; when looking for
                     37: \*(Lqcompile\*(Rq,
                     38: .Nm apropos
                     39: will also list all instances of \*(Lqcompiler\*(Rq.
                     40: .Pp
                     41: If the line output by
                     42: .Nm apropos
                     43: starts
                     44: .Li \*(Lqname(section) ...\*(Rq
                     45: you can enter
                     46: .Li \*(Lqman section name\*(Rq
                     47: to get
                     48: its documentation.
                     49: .Pp
                     50: The options are as follows:
                     51: .Tp Fl M
                     52: Override the list of standard directories where
                     53: .Nm apropos
                     54: searches for a database named
                     55: .Pa whatis.db .
                     56: The supplied
                     57: .Ar path
                     58: must be a colon (\*(Lq:\*(Rq) separated list of directories.
                     59: This search path may also be set using the environment variable
                     60: .Ev MANPATH .
                     61: .Tp Fl m
                     62: Augment the list of standard directories where
                     63: .Nm apropos
                     64: searches for its database.
                     65: The supplied
                     66: .Ar path
                     67: must be a colon (\*(Lq:\*(Rq) separated list of directories.
                     68: These directories will be searched before the standard directories
                     69: or the directories supplied with the
                     70: .Fl M
                     71: option or the
                     72: .Ev MANPATH
                     73: environmental variable are searched.
                     74: .Sh ENVIRONMENT
                     75: .Tw MANPATH
                     76: .Tp Ev MANPATH
                     77: The standard search path used by
                     78: .Xr man 1
                     79: may be overridden by specifying a path in the
                     80: .Ev MANPATH
                     81: environmental variable.
                     82: The format of the path is a colon (\*(Lq:\*(Rq) separated list of directories.
                     83: .Tp
                     84: .Sh FILES
                     85: .Dw whatis.db
                     86: .Di L
                     87: .Dp Pa whatis.db
                     88: name of the apropos database
                     89: .Dp
                     90: .Sh SEE ALSO
                     91: .Xr man 1 ,
                     92: .Xr whatis 1 ,
                     93: .Xr whereis 1
                     94: .Sh HISTORY
                     95: .Nm apropos
                     96: appeared in 3 BSD.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.