xref: /csrg-svn/usr.bin/apropos/apropos.1 (revision 44952)
143082Scael.\" Copyright (c) 1989, 1990 The Regents of the University of California.
240389Sbostic.\" All rights reserved.
319645Smckusick.\"
443082Scael.\" %sccs.include.redist.man%
531718Sbostic.\"
6*44952Scael.\"     @(#)apropos.1	6.9 (Berkeley) 07/24/90
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
2543082Scael\*(Lqcompile\*(Rq,
2643082Scael.Nm apropos
2743082Scaelwill also list all instances of \*(Lqcompiler\*(Rq.
2843082Scael.Pp
2940389SbosticIf the line output by
3043082Scael.Nm apropos
3143082Scaelstarts
3243082Scael.Li \*(Lqname(section) ...\*(Rq
3343082Scaelyou can enter
3443082Scael.Li \*(Lqman section name\*(Rq
3543082Scaelto get
3640389Sbosticits documentation.
3743082Scael.Pp
3840389SbosticThe options are as follows:
3943082Scael.Tp Fl M
4040389SbosticOverride the list of standard directories where
4143082Scael.Nm apropos
4243082Scaelsearches for a database named
4343082Scael.Pa whatis.db .
4440389SbosticThe supplied
4543082Scael.Ar path
4643082Scaelmust be a colon (\*(Lq:\*(Rq) separated list of directories.
47*44952ScaelThis search path may also be set using the environment variable
4843082Scael.Ev MANPATH .
4943082Scael.Tp Fl m
5040389SbosticAugment the list of standard directories where
5143082Scael.Nm apropos
5243082Scaelsearches for its database.
5340389SbosticThe supplied
5443082Scael.Ar path
5543082Scaelmust be a colon (\*(Lq:\*(Rq) separated list of directories.
5640389SbosticThese directories will be searched before the standard directories
5740389Sbosticor the directories supplied with the
5843082Scael.Fl M
5940389Sbosticoption or the
6043082Scael.Ev MANPATH
6140389Sbosticenvironmental variable are searched.
6243082Scael.Sh ENVIRONMENT
6343082Scael.Tw MANPATH
6443082Scael.Tp Ev MANPATH
6540389SbosticThe standard search path used by
6643082Scael.Xr man 1
6740389Sbosticmay be overridden by specifying a path in the
6843082Scael.Ev MANPATH
6940389Sbosticenvironmental variable.
7043082ScaelThe format of the path is a colon (\*(Lq:\*(Rq) separated list of directories.
7143082Scael.Tp
7243082Scael.Sh FILES
73*44952Scael.Dw whatis.db
74*44952Scael.Di L
75*44952Scael.Dp Pa whatis.db
7643082Scaelname of the apropos database
77*44952Scael.Dp
7843082Scael.Sh SEE ALSO
7943082Scael.Xr man 1 ,
8043082Scael.Xr whatis 1 ,
8143082Scael.Xr whereis 1
8243082Scael.Sh HISTORY
8343082Scael.Nm apropos
8443082Scaelappeared in 3 BSD.
85