xref: /csrg-svn/usr.bin/apropos/apropos.1 (revision 43082)
1*43082Scael.\" Copyright (c) 1989, 1990 The Regents of the University of California.
240389Sbostic.\" All rights reserved.
319645Smckusick.\"
4*43082Scael.\" %sccs.include.redist.man%
531718Sbostic.\"
6*43082Scael.\"     @(#)apropos.1	6.8 (Berkeley) 06/11/90
740389Sbostic.\"
8*43082Scael.Dd
9*43082Scael.Dt APROPOS 1
10*43082Scael.Sh NAME
11*43082Scael.Nm apropos
12*43082Scael.Nd locate commands by keyword lookup
13*43082Scael.Sh SYNOPSIS
14*43082Scael.Nm apropos
15*43082Scael.Op Fl M Ar path
16*43082Scael.Op Fl m Ar path
17*43082Scael.Ar keyword ...
18*43082Scael.Sh DESCRIPTION
19*43082Scael.Nm Apropos
2040389Sbosticshows which manual pages contain instances of any of the given
21*43082Scael.Ar keyword(s)
2240389Sbosticin their title line.
2340389SbosticEach word is considered separately and case of letters is ignored.
2440389SbosticWords which are part of other words are considered; when looking for
25*43082Scael\*(Lqcompile\*(Rq,
26*43082Scael.Nm apropos
27*43082Scaelwill also list all instances of \*(Lqcompiler\*(Rq.
28*43082Scael.Pp
2940389SbosticIf the line output by
30*43082Scael.Nm apropos
31*43082Scaelstarts
32*43082Scael.Li \*(Lqname(section) ...\*(Rq
33*43082Scaelyou can enter
34*43082Scael.Li \*(Lqman section name\*(Rq
35*43082Scaelto get
3640389Sbosticits documentation.
37*43082Scael.Pp
3840389SbosticThe options are as follows:
39*43082Scael.Tp Fl M
4040389SbosticOverride the list of standard directories where
41*43082Scael.Nm apropos
42*43082Scaelsearches for a database named
43*43082Scael.Pa whatis.db .
4440389SbosticThe supplied
45*43082Scael.Ar path
46*43082Scaelmust be a colon (\*(Lq:\*(Rq) separated list of directories.
4740389SbosticThis search path may also be set using the environmental variable
48*43082Scael.Ev MANPATH .
49*43082Scael.Tp Fl m
5040389SbosticAugment the list of standard directories where
51*43082Scael.Nm apropos
52*43082Scaelsearches for its database.
5340389SbosticThe supplied
54*43082Scael.Ar path
55*43082Scaelmust be a colon (\*(Lq:\*(Rq) separated list of directories.
5640389SbosticThese directories will be searched before the standard directories
5740389Sbosticor the directories supplied with the
58*43082Scael.Fl M
5940389Sbosticoption or the
60*43082Scael.Ev MANPATH
6140389Sbosticenvironmental variable are searched.
62*43082Scael.Sh ENVIRONMENT
63*43082Scael.Tw MANPATH
64*43082Scael.Tp Ev MANPATH
6540389SbosticThe standard search path used by
66*43082Scael.Xr man 1
6740389Sbosticmay be overridden by specifying a path in the
68*43082Scael.Ev MANPATH
6940389Sbosticenvironmental variable.
70*43082ScaelThe format of the path is a colon (\*(Lq:\*(Rq) separated list of directories.
71*43082Scael.Tp
72*43082Scael.Sh FILES
73*43082Scael.Tw whatis.db
74*43082Scael.Tp Pa whatis.db
75*43082Scaelname of the apropos database
76*43082Scael.Tp
77*43082Scael.Sh SEE ALSO
78*43082Scael.Xr man 1 ,
79*43082Scael.Xr whatis 1 ,
80*43082Scael.Xr whereis 1
81*43082Scael.Sh HISTORY
82*43082Scael.Nm apropos
83*43082Scaelappeared in 3 BSD.
84