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