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