xref: /csrg-svn/usr.bin/apropos/apropos.1 (revision 63649)
1*63649Sbostic.\" Copyright (c) 1989, 1990, 1993
2*63649Sbostic.\"	The Regents of the University of California.  All rights reserved.
319645Smckusick.\"
450475Scael.\" %sccs.include.redist.roff%
531718Sbostic.\"
6*63649Sbostic.\"	@(#)apropos.1	8.1 (Berkeley) 06/29/93
740389Sbostic.\"
843082Scael.Dd
943082Scael.Dt APROPOS 1
1050475Scael.Os
1143082Scael.Sh NAME
1243082Scael.Nm apropos
1343082Scael.Nd locate commands by keyword lookup
1443082Scael.Sh SYNOPSIS
1543082Scael.Nm apropos
1643082Scael.Op Fl M Ar path
1743082Scael.Op Fl m Ar path
1843082Scael.Ar keyword ...
1943082Scael.Sh DESCRIPTION
2043082Scael.Nm Apropos
2140389Sbosticshows which manual pages contain instances of any of the given
2243082Scael.Ar keyword(s)
2340389Sbosticin their title line.
2440389SbosticEach word is considered separately and case of letters is ignored.
2540389SbosticWords which are part of other words are considered; when looking for
2647397Scael.Dq compile ,
2743082Scael.Nm apropos
2847397Scaelwill also list all instances of
2947397Scael.Dq compiler .
3043082Scael.Pp
3140389SbosticIf the line output by
3243082Scael.Nm apropos
3343082Scaelstarts
3447397Scael.Dq Li name(section) ...
3543082Scaelyou can enter
3647397Scael.Dq Li man section name
3743082Scaelto get
3840389Sbosticits documentation.
3943082Scael.Pp
4040389SbosticThe options are as follows:
4150475Scael.Bl -tag -width flag
4247397Scael.It Fl M
4347397ScaelOverride the list of standard directories
4443082Scael.Nm apropos
4543082Scaelsearches for a database named
4643082Scael.Pa whatis.db .
4740389SbosticThe supplied
4843082Scael.Ar path
4947397Scaelmust be a colon
5047397Scael.Dq \&:
5147397Scaelseparated list of directories.
5244952ScaelThis search path may also be set using the environment variable
5343082Scael.Ev MANPATH .
5447397Scael.It Fl m
5547397ScaelAugment the list of standard directories
5643082Scael.Nm apropos
5743082Scaelsearches for its database.
5840389SbosticThe supplied
5943082Scael.Ar path
6047397Scaelmust be a colon
6147397Scael.Dq \&:
6247397Scaelseparated list of directories.
6363648SmckusickThese directories will be searched before the standard directories,
6440389Sbosticor the directories supplied with the
6543082Scael.Fl M
6640389Sbosticoption or the
6743082Scael.Ev MANPATH
6863648Smckusickenvironment variable.
6943082Scael.Sh ENVIRONMENT
7047397Scael.Bl -tag -width MANPATH
7147397Scael.It Ev MANPATH
7240389SbosticThe standard search path used by
7343082Scael.Xr man 1
7440389Sbosticmay be overridden by specifying a path in the
7543082Scael.Ev MANPATH
7647397Scaelenvironment variable.
7747397ScaelThe format of the path is a colon
7847397Scael.Dq \&:
7947397Scaelseparated list of directories.
8047397Scael.El
8143082Scael.Sh FILES
8247397Scael.Bl -tag -width whatis.db -compact
8347397Scael.It Pa whatis.db
8443082Scaelname of the apropos database
8547397Scael.El
8643082Scael.Sh SEE ALSO
8743082Scael.Xr man 1 ,
8843082Scael.Xr whatis 1 ,
8943082Scael.Xr whereis 1
9043082Scael.Sh HISTORY
9147397ScaelThe
9250475Scael.Nm apropos
9347397Scaelcommand appeared in
9447397Scael.Bx 3.0 .
95