xref: /original-bsd/usr.bin/apropos/apropos.1 (revision 95a66346)
1.\" Copyright (c) 1989, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)apropos.1	6.10 (Berkeley) 03/14/91
7.\"
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
20shows which manual pages contain instances of any of the given
21.Ar keyword(s)
22in their title line.
23Each word is considered separately and case of letters is ignored.
24Words which are part of other words are considered; when looking for
25.Dq compile ,
26.Nm apropos
27will also list all instances of
28.Dq compiler .
29.Pp
30If the line output by
31.Nm apropos
32starts
33.Dq Li name(section) ...
34you can enter
35.Dq Li man section name
36to get
37its documentation.
38.Pp
39The options are as follows:
40.Bl -tag -width Ds
41.It Fl M
42Override the list of standard directories
43.Nm apropos
44searches for a database named
45.Pa whatis.db .
46The supplied
47.Ar path
48must be a colon
49.Dq \&:
50separated list of directories.
51This search path may also be set using the environment variable
52.Ev MANPATH .
53.It Fl m
54Augment the list of standard directories
55.Nm apropos
56searches for its database.
57The supplied
58.Ar path
59must be a colon
60.Dq \&:
61separated list of directories.
62These directories will be searched before the standard directories
63or the directories supplied with the
64.Fl M
65option or the
66.Ev MANPATH
67environment variable are searched.
68.Sh ENVIRONMENT
69.Bl -tag -width MANPATH
70.It Ev MANPATH
71The standard search path used by
72.Xr man 1
73may be overridden by specifying a path in the
74.Ev MANPATH
75environment variable.
76The format of the path is a colon
77.Dq \&:
78separated list of directories.
79.El
80.Sh FILES
81.Bl -tag -width whatis.db -compact
82.It Pa whatis.db
83name of the apropos database
84.El
85.Sh SEE ALSO
86.Xr man 1 ,
87.Xr whatis 1 ,
88.Xr whereis 1
89.Sh HISTORY
90The
91.Nm
92command appeared in
93.Bx 3.0 .
94