version 1.2, 1996/06/26 05:31:14 |
version 1.6, 2000/07/06 04:06:53 |
|
|
.Nm apropos |
.Nm apropos |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
.Ar keyword ... |
.Ar keyword |
|
.Op Ar ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm Apropos |
.Nm |
shows which manual pages contain instances of any of the given |
shows which manual pages contain instances of any of the given |
.Ar keyword(s) |
.Ar keyword(s) |
in their title line. |
in their title line. |
Each word is considered separately and case of letters is ignored. |
Each word is considered separately and case of letters is ignored. |
Words which are part of other words are considered; when looking for |
Words which are part of other words are considered; when looking for |
.Dq compile , |
.Dq compile , |
.Nm apropos |
.Nm |
will also list all instances of |
will also list all instances of |
.Dq compiler . |
.Dq compiler . |
.Pp |
.Pp |
If the line output by |
If the line output by |
.Nm apropos |
.Nm |
starts |
starts |
.Dq Li name(section) ... |
.Dq Li name(section) ... |
you can enter |
you can enter |
|
|
.Pp |
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width flag |
.Bl -tag -width flag |
.It Fl M |
.It Fl M Ar path |
Override the list of standard directories |
Override the list of standard directories |
.Nm apropos |
.Nm |
searches for a database named |
searches for a database named |
.Pa whatis.db . |
.Pa whatis.db . |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon |
.Dq \&: |
.Pq Sq \&: |
separated list of directories. |
separated list of directories. |
This search path may also be set using the environment variable |
This search path may also be set using the environment variable |
.Ev MANPATH . |
.Ev MANPATH . |
.It Fl m |
.It Fl m Ar path |
Augment the list of standard directories |
Augment the list of standard directories |
.Nm apropos |
.Nm |
searches for its database. |
searches for its database. |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon |
.Dq \&: |
.Pq Sq \&: |
separated list of directories. |
separated list of directories. |
These directories will be searched before the standard directories, |
These directories will be searched before the standard directories, |
or the directories supplied with the |
or the directories supplied with the |
|
|
option or the |
option or the |
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
environment variable. |
|
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATH |
.Bl -tag -width MANPATH |
.It Ev MANPATH |
.It Ev MANPATH |
|
|
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
environment variable. |
The format of the path is a colon |
The format of the path is a colon |
.Dq \&: |
.Pq Sq \&: |
separated list of directories. |
separated list of directories. |
.El |
.El |
.Sh FILES |
.Sh FILES |
|
|
.Xr whereis 1 |
.Xr whereis 1 |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm apropos |
.Nm |
command appeared in |
command appeared in |
.Bx 3.0 . |
.Bx 3.0 . |