version 1.5, 1999/10/07 19:15:25 |
version 1.6, 2000/03/14 14:58:26 |
|
|
.Op Fl m Ar path |
.Op Fl m Ar path |
.Ar command Op Ar ... |
.Ar command Op Ar ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm whatis |
.Nm |
looks up a given command and gives the header line from the manual page. |
looks up a given command and gives the header line from the manual page. |
You can then use the |
You can then use the |
.Xr man 1 |
.Xr man 1 |
|
|
.Bl -tag -width Fl |
.Bl -tag -width Fl |
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories |
Override the list of standard directories |
.Nm whatis |
.Nm |
searches for its database named |
searches for its database named |
.Dq Pa whatis.db . |
.Dq Pa whatis.db . |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon |
.Dq \&: |
.Pq Ql \&: |
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 Ar path |
.It Fl m Ar path |
Augment the list of standard directories |
Augment the list of standard directories |
.Nm whatis |
.Nm |
searches for its database named |
searches for its database named |
.Dq Pa whatis.db . |
.Dq Pa whatis.db . |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon |
must be a colon-separated list of directories. |
.Dq \&: |
|
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 |
.Fl M |
.Fl M |
|
|
environment variable are searched. |
environment variable are searched. |
.El |
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
|
The following environment variables affect the execution of |
|
.Nm whatis : |
.Bl -tag -width MANPATH |
.Bl -tag -width MANPATH |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |