xref: /csrg-svn/usr.bin/apropos/apropos.1 (revision 47397)
143082Scael.\" Copyright (c) 1989, 1990 The Regents of the University of California.
240389Sbostic.\" All rights reserved.
319645Smckusick.\"
443082Scael.\" %sccs.include.redist.man%
531718Sbostic.\"
6*47397Scael.\"     @(#)apropos.1	6.10 (Berkeley) 03/14/91
740389Sbostic.\"
843082Scael.Dd
943082Scael.Dt APROPOS 1
1043082Scael.Sh NAME
1143082Scael.Nm apropos
1243082Scael.Nd locate commands by keyword lookup
1343082Scael.Sh SYNOPSIS
1443082Scael.Nm apropos
1543082Scael.Op Fl M Ar path
1643082Scael.Op Fl m Ar path
1743082Scael.Ar keyword ...
1843082Scael.Sh DESCRIPTION
1943082Scael.Nm Apropos
2040389Sbosticshows which manual pages contain instances of any of the given
2143082Scael.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*47397Scael.Dq compile ,
2643082Scael.Nm apropos
27*47397Scaelwill also list all instances of
28*47397Scael.Dq compiler .
2943082Scael.Pp
3040389SbosticIf the line output by
3143082Scael.Nm apropos
3243082Scaelstarts
33*47397Scael.Dq Li name(section) ...
3443082Scaelyou can enter
35*47397Scael.Dq Li man section name
3643082Scaelto get
3740389Sbosticits documentation.
3843082Scael.Pp
3940389SbosticThe options are as follows:
40*47397Scael.Bl -tag -width Ds
41*47397Scael.It Fl M
42*47397ScaelOverride the list of standard directories
4343082Scael.Nm apropos
4443082Scaelsearches for a database named
4543082Scael.Pa whatis.db .
4640389SbosticThe supplied
4743082Scael.Ar path
48*47397Scaelmust be a colon
49*47397Scael.Dq \&:
50*47397Scaelseparated list of directories.
5144952ScaelThis search path may also be set using the environment variable
5243082Scael.Ev MANPATH .
53*47397Scael.It Fl m
54*47397ScaelAugment the list of standard directories
5543082Scael.Nm apropos
5643082Scaelsearches for its database.
5740389SbosticThe supplied
5843082Scael.Ar path
59*47397Scaelmust be a colon
60*47397Scael.Dq \&:
61*47397Scaelseparated list of directories.
6240389SbosticThese directories will be searched before the standard directories
6340389Sbosticor the directories supplied with the
6443082Scael.Fl M
6540389Sbosticoption or the
6643082Scael.Ev MANPATH
67*47397Scaelenvironment variable are searched.
6843082Scael.Sh ENVIRONMENT
69*47397Scael.Bl -tag -width MANPATH
70*47397Scael.It Ev MANPATH
7140389SbosticThe standard search path used by
7243082Scael.Xr man 1
7340389Sbosticmay be overridden by specifying a path in the
7443082Scael.Ev MANPATH
75*47397Scaelenvironment variable.
76*47397ScaelThe format of the path is a colon
77*47397Scael.Dq \&:
78*47397Scaelseparated list of directories.
79*47397Scael.El
8043082Scael.Sh FILES
81*47397Scael.Bl -tag -width whatis.db -compact
82*47397Scael.It Pa whatis.db
8343082Scaelname of the apropos database
84*47397Scael.El
8543082Scael.Sh SEE ALSO
8643082Scael.Xr man 1 ,
8743082Scael.Xr whatis 1 ,
8843082Scael.Xr whereis 1
8943082Scael.Sh HISTORY
90*47397ScaelThe
91*47397Scael.Nm
92*47397Scaelcommand appeared in
93*47397Scael.Bx 3.0 .
94