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