Commit | Line | Data |
---|---|---|
0346b0ee KB |
1 | .\" Copyright (c) 1989, 1990, 1993 |
2 | .\" The Regents of the University of California. All rights reserved. | |
3d55d843 | 3 | .\" |
13852408 | 4 | .\" %sccs.include.redist.roff% |
2f28d62a | 5 | .\" |
0346b0ee | 6 | .\" @(#)apropos.1 8.1 (Berkeley) %G% |
d5781aef | 7 | .\" |
b5dc1377 CL |
8 | .Dd |
9 | .Dt APROPOS 1 | |
13852408 | 10 | .Os |
b5dc1377 CL |
11 | .Sh NAME |
12 | .Nm apropos | |
13 | .Nd locate commands by keyword lookup | |
14 | .Sh SYNOPSIS | |
15 | .Nm apropos | |
16 | .Op Fl M Ar path | |
17 | .Op Fl m Ar path | |
18 | .Ar keyword ... | |
19 | .Sh DESCRIPTION | |
20 | .Nm Apropos | |
2f28d62a | 21 | shows which manual pages contain instances of any of the given |
b5dc1377 | 22 | .Ar keyword(s) |
2f28d62a KB |
23 | in their title line. |
24 | Each word is considered separately and case of letters is ignored. | |
25 | Words which are part of other words are considered; when looking for | |
0e853b88 | 26 | .Dq compile , |
b5dc1377 | 27 | .Nm apropos |
0e853b88 CL |
28 | will also list all instances of |
29 | .Dq compiler . | |
b5dc1377 | 30 | .Pp |
2f28d62a | 31 | If the line output by |
b5dc1377 CL |
32 | .Nm apropos |
33 | starts | |
0e853b88 | 34 | .Dq Li name(section) ... |
b5dc1377 | 35 | you can enter |
0e853b88 | 36 | .Dq Li man section name |
b5dc1377 | 37 | to get |
2f28d62a | 38 | its documentation. |
b5dc1377 | 39 | .Pp |
2f28d62a | 40 | The options are as follows: |
13852408 | 41 | .Bl -tag -width flag |
0e853b88 CL |
42 | .It Fl M |
43 | Override the list of standard directories | |
b5dc1377 CL |
44 | .Nm apropos |
45 | searches for a database named | |
46 | .Pa whatis.db . | |
2f28d62a | 47 | The supplied |
b5dc1377 | 48 | .Ar path |
0e853b88 CL |
49 | must be a colon |
50 | .Dq \&: | |
51 | separated list of directories. | |
5325ced3 | 52 | This search path may also be set using the environment variable |
b5dc1377 | 53 | .Ev MANPATH . |
0e853b88 CL |
54 | .It Fl m |
55 | Augment the list of standard directories | |
b5dc1377 CL |
56 | .Nm apropos |
57 | searches for its database. | |
2f28d62a | 58 | The supplied |
b5dc1377 | 59 | .Ar path |
0e853b88 CL |
60 | must be a colon |
61 | .Dq \&: | |
62 | separated list of directories. | |
61751b67 | 63 | These directories will be searched before the standard directories, |
2f28d62a | 64 | or the directories supplied with the |
b5dc1377 | 65 | .Fl M |
2f28d62a | 66 | option or the |
b5dc1377 | 67 | .Ev MANPATH |
61751b67 | 68 | environment variable. |
b5dc1377 | 69 | .Sh ENVIRONMENT |
0e853b88 CL |
70 | .Bl -tag -width MANPATH |
71 | .It Ev MANPATH | |
2f28d62a | 72 | The standard search path used by |
b5dc1377 | 73 | .Xr man 1 |
2f28d62a | 74 | may be overridden by specifying a path in the |
b5dc1377 | 75 | .Ev MANPATH |
0e853b88 CL |
76 | environment variable. |
77 | The format of the path is a colon | |
78 | .Dq \&: | |
79 | separated list of directories. | |
80 | .El | |
b5dc1377 | 81 | .Sh FILES |
0e853b88 CL |
82 | .Bl -tag -width whatis.db -compact |
83 | .It Pa whatis.db | |
b5dc1377 | 84 | name of the apropos database |
0e853b88 | 85 | .El |
b5dc1377 CL |
86 | .Sh SEE ALSO |
87 | .Xr man 1 , | |
88 | .Xr whatis 1 , | |
89 | .Xr whereis 1 | |
90 | .Sh HISTORY | |
0e853b88 | 91 | The |
13852408 | 92 | .Nm apropos |
0e853b88 CL |
93 | command appeared in |
94 | .Bx 3.0 . |