version 1.1, 2011/11/27 18:54:01 |
version 1.7, 2011/12/25 19:35:44 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm whatis |
.Nm whatis |
.Nd search manual page databases |
.Nd search for manual pages by page names |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
|
.Op Fl C Ar file |
.Op Fl M Ar manpath |
.Op Fl M Ar manpath |
.Op Fl m Ar manpath |
.Op Fl m Ar manpath |
.Op Fl S Ar arch |
.Op Fl S Ar arch |
.Op Fl s Ar section |
.Op Fl s Ar section |
.Ar term... |
.Ar name ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility searches for manuals named or described with |
utility searches databases generated by |
.Ar term |
.Xr mandocdb 8 |
in manual page databases generated by |
for manuals containing the word |
.Xr mandocdb 8 . |
.Ar name |
Its arguments are as follows: |
in their page name, ignoring case. |
|
It returns the header lines from all matching pages. |
|
You can then use the |
|
.Xr man 1 |
|
command to get more information. |
|
.Pp |
|
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 . |
|
.Pp |
|
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl C Ar file |
|
Specify an alternative configuration |
|
.Ar file |
|
in |
|
.Xr man.conf 5 |
|
format. |
.It Fl M Ar manpath |
.It Fl M Ar manpath |
Use the colon-separated path instead of the default list of paths |
Use the colon-separated |
searched for |
.Ar manpath |
|
instead of the default list of paths searched for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
databases. |
databases. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths, or paths without manual databases, are ignored. |
.It Fl m Ar manpath |
.It Fl m Ar manpath |
Prepend the colon-separated paths to the list of paths searched |
Prepend the colon-separated |
for |
.Ar manpath |
|
to the list of paths searched for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
databases. |
databases. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths, or paths without manual databases, are ignored. |
|
|
for a listing of manual sections. |
for a listing of manual sections. |
.El |
.El |
.Pp |
.Pp |
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 . |
|
Results are sorted by manual title, with output formatted as |
Results are sorted by manual title, with output formatted as |
.Pp |
.Pp |
.D1 title(sec) \- description |
.D1 title(sec) \- description |
Line 92 is identical to running |
|
Line 108 is identical to running |
|
.Xr apropos 1 |
.Xr apropos 1 |
as follows: |
as follows: |
.Pp |
.Pp |
.Dl $ apropos -- -i '~[[:<:]]term[[:>:]]' |
.Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]' |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev MANPATH |
.It Ev MANPATH |
Colon-separated paths overriding the default list of paths searched for |
Colon-separated paths modifying the default list of paths searched for |
manual databases. |
manual databases. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths, or paths without manual databases, are ignored. |
Overridden by |
Overridden by |
.Fl M . |
.Fl M . |
|
If |
|
.Ev MANPATH |
|
begins with a |
|
.Sq \&: , |
|
it is appended to the default list; |
|
else if it ends with |
|
.Sq \&: , |
|
it is prepended to the default list; else if it contains |
|
.Sq \&:: , |
|
the default list is inserted between the colons. |
|
If none of these conditions are met, it overrides the default list. |
.El |
.El |
.\" .Sh FILES |
.Sh FILES |
|
.Bl -tag -width "/etc/man.conf" -compact |
|
.It Pa whatis.db |
|
name of the |
|
.Xr mandocdb 8 |
|
keyword database |
|
.It Pa whatis.index |
|
name of the |
|
.Xr mandocdb 8 |
|
filename database |
|
.It Pa /etc/man.conf |
|
default |
|
.Xr man 1 |
|
configuration file |
|
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr man.conf 5 , |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
.Sh AUTHORS |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |
utility was written by |
utility first appeared in |
|
.Bx 2 . |
|
It was rewritten from scratch as part of the |
|
.Xr mandocdb 8 |
|
project for |
|
.Ox 5.1 . |
|
.Sh AUTHORS |
|
.An -nosplit |
|
.An Bill Joy |
|
wrote the original |
|
.Bx |
|
.Nm |
|
in 1979. |
|
The current version was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons , |
.Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |