Annotation of src/usr.bin/apropos/apropos.1, Revision 1.7
1.7 ! aaron 1: .\" $OpenBSD: apropos.1,v 1.6 2000/07/06 04:06:53 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
45: .Op Fl M Ar path
46: .Op Fl m Ar path
1.4 aaron 47: .Ar keyword
48: .Op Ar ...
1.1 deraadt 49: .Sh DESCRIPTION
1.5 aaron 50: .Nm
1.1 deraadt 51: shows which manual pages contain instances of any of the given
52: .Ar keyword(s)
53: in their title line.
54: Each word is considered separately and case of letters is ignored.
55: Words which are part of other words are considered; when looking for
56: .Dq compile ,
1.5 aaron 57: .Nm
1.1 deraadt 58: will also list all instances of
59: .Dq compiler .
60: .Pp
61: If the line output by
1.5 aaron 62: .Nm
1.1 deraadt 63: starts
64: .Dq Li name(section) ...
65: you can enter
66: .Dq Li man section name
67: to get
68: its documentation.
69: .Pp
70: The options are as follows:
1.7 ! aaron 71: .Bl -tag -width Ds
1.3 deraadt 72: .It Fl M Ar path
1.1 deraadt 73: Override the list of standard directories
1.5 aaron 74: .Nm
1.1 deraadt 75: searches for a database named
76: .Pa whatis.db .
77: The supplied
78: .Ar path
79: must be a colon
1.4 aaron 80: .Pq Sq \&:
1.1 deraadt 81: separated list of directories.
82: This search path may also be set using the environment variable
83: .Ev MANPATH .
1.4 aaron 84: .It Fl m Ar path
1.1 deraadt 85: Augment the list of standard directories
1.5 aaron 86: .Nm
1.1 deraadt 87: searches for its database.
88: The supplied
89: .Ar path
90: must be a colon
1.4 aaron 91: .Pq Sq \&:
1.1 deraadt 92: separated list of directories.
93: These directories will be searched before the standard directories,
94: or the directories supplied with the
95: .Fl M
96: option or the
97: .Ev MANPATH
98: environment variable.
1.6 aaron 99: .El
1.1 deraadt 100: .Sh ENVIRONMENT
101: .Bl -tag -width MANPATH
102: .It Ev MANPATH
103: The standard search path used by
104: .Xr man 1
105: may be overridden by specifying a path in the
106: .Ev MANPATH
107: environment variable.
108: The format of the path is a colon
1.4 aaron 109: .Pq Sq \&:
1.1 deraadt 110: separated list of directories.
111: .El
112: .Sh FILES
113: .Bl -tag -width whatis.db -compact
114: .It Pa whatis.db
115: name of the apropos database
116: .El
117: .Sh SEE ALSO
118: .Xr man 1 ,
119: .Xr whatis 1 ,
120: .Xr whereis 1
121: .Sh HISTORY
122: The
1.5 aaron 123: .Nm
1.1 deraadt 124: command appeared in
125: .Bx 3.0 .