version 1.3, 1998/03/24 05:40:17 |
version 1.10, 2004/03/31 08:45:48 |
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright |
.\" 2. Redistributions in binary form must reproduce the above copyright |
.\" notice, this list of conditions and the following disclaimer in the |
.\" notice, this list of conditions and the following disclaimer in the |
.\" documentation and/or other materials provided with the distribution. |
.\" documentation and/or other materials provided with the distribution. |
.\" 3. All advertising materials mentioning features or use of this software |
.\" 3. Neither the name of the University nor the names of its contributors |
.\" must display the following acknowledgement: |
|
.\" This product includes software developed by the University of |
|
.\" California, Berkeley and its contributors. |
|
.\" 4. Neither the name of the University nor the names of its contributors |
|
.\" may be used to endorse or promote products derived from this software |
.\" may be used to endorse or promote products derived from this software |
.\" without specific prior written permission. |
.\" without specific prior written permission. |
.\" |
.\" |
|
|
.Nd locate commands by keyword lookup |
.Nd locate commands by keyword lookup |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm apropos |
.Nm apropos |
|
.Op Fl C Ar file |
.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 |
.Dq Li man section name |
.Dq Li man section name |
to get |
to get |
its documentation. |
its documentation. |
.Pp |
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width flag |
.Bl -tag -width "-C file" |
|
.It Fl C Ar file |
|
Specify an alternative configuration |
|
.Ar file |
|
in |
|
.Xr man.conf 5 |
|
format. |
.It Fl M Ar path |
.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 path |
.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 |
.Bl -tag -width whatis.db -compact |
.Bl -tag -width /etc/man.conf -compact |
.It Pa whatis.db |
.It Pa whatis.db |
name of the apropos database |
name of the apropos database |
|
.It Pa /etc/man.conf |
|
default |
|
.Xr man 1 |
|
configuration file |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr whatis 1 , |
.Xr whatis 1 , |
.Xr whereis 1 |
.Xr whereis 1 , |
|
.Xr man.conf 5 , |
|
.Xr makewhatis 8 |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm apropos |
.Nm |
command appeared in |
command appeared in |
.Bx 3.0 . |
.Bx 3.0 . |