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