Annotation of src/usr.bin/apropos/apropos.1, Revision 1.15
1.15 ! jmc 1: .\" $OpenBSD: apropos.1,v 1.14 2011/10/09 02:20:39 schwarze 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.15 ! jmc 33: .Dd $Mdocdate: October 9 2011 $
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.13 jmc 44: .Op Fl S Ar subsection
45: .Op Fl s Ar section
1.12 sobrado 46: .Ar keyword ...
1.1 deraadt 47: .Sh DESCRIPTION
1.5 aaron 48: .Nm
1.1 deraadt 49: shows which manual pages contain instances of any of the given
50: .Ar keyword(s)
51: in their title line.
52: Each word is considered separately and case of letters is ignored.
53: Words which are part of other words are considered; when looking for
54: .Dq compile ,
1.5 aaron 55: .Nm
1.1 deraadt 56: will also list all instances of
57: .Dq compiler .
58: .Pp
59: If the line output by
1.5 aaron 60: .Nm
1.1 deraadt 61: starts
1.10 jmc 62: .Dq Li name (section) ... ,
1.1 deraadt 63: you can enter
64: .Dq Li man section name
65: to get
66: its documentation.
67: .Pp
68: The options are as follows:
1.10 jmc 69: .Bl -tag -width "-C file"
1.8 millert 70: .It Fl C Ar file
71: Specify an alternative configuration
72: .Ar file
73: in
74: .Xr man.conf 5
75: format.
1.3 deraadt 76: .It Fl M Ar path
1.1 deraadt 77: Override the list of standard directories
1.5 aaron 78: .Nm
1.1 deraadt 79: searches for a database named
80: .Pa whatis.db .
81: The supplied
82: .Ar path
83: must be a colon
1.4 aaron 84: .Pq Sq \&:
1.1 deraadt 85: separated list of directories.
86: This search path may also be set using the environment variable
87: .Ev MANPATH .
1.4 aaron 88: .It Fl m Ar path
1.1 deraadt 89: Augment the list of standard directories
1.5 aaron 90: .Nm
1.1 deraadt 91: searches for its database.
92: The supplied
93: .Ar path
94: must be a colon
1.4 aaron 95: .Pq Sq \&:
1.1 deraadt 96: separated list of directories.
97: These directories will be searched before the standard directories,
98: or the directories supplied with the
99: .Fl M
100: option or the
101: .Ev MANPATH
102: environment variable.
1.13 jmc 103: .It Fl S Ar subsection
104: Restrict the search to pages for the specified machine architecture.
105: By default, pages for all architectures are shown.
106: .It Fl s Ar section
107: Restrict the search to the specified section of the manual.
108: By default, pages from all sections are shown.
1.6 aaron 109: .El
1.1 deraadt 110: .Sh ENVIRONMENT
111: .Bl -tag -width MANPATH
112: .It Ev MANPATH
113: The standard search path used by
114: .Xr man 1
115: may be overridden by specifying a path in the
116: .Ev MANPATH
117: environment variable.
118: The format of the path is a colon
1.4 aaron 119: .Pq Sq \&:
1.1 deraadt 120: separated list of directories.
121: .El
122: .Sh FILES
1.8 millert 123: .Bl -tag -width /etc/man.conf -compact
1.1 deraadt 124: .It Pa whatis.db
125: name of the apropos database
1.8 millert 126: .It Pa /etc/man.conf
127: default
128: .Xr man 1
129: configuration file
1.1 deraadt 130: .El
131: .Sh SEE ALSO
132: .Xr man 1 ,
133: .Xr whatis 1 ,
1.8 millert 134: .Xr whereis 1 ,
135: .Xr man.conf 5 ,
136: .Xr makewhatis 8
1.1 deraadt 137: .Sh HISTORY
138: The
1.5 aaron 139: .Nm
1.14 schwarze 140: command first appeared in
141: .Bx 2 .
1.15 ! jmc 142: .Pp
1.14 schwarze 143: The
144: .Fl M
145: and
146: .Fl m
147: options first appeared in
148: .Bx 4.3 Reno ;
149: .Fl C
150: in
151: .Nx 1.0 ;
152: and
153: .Fl s
154: and
155: .Fl S
156: in
157: .Ox 4.5 .
158: .Sh AUTHORS
159: .An Bill Joy
![[BACK]](/icons/back.gif){kind=icon}
Return to apropos.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / apropos