version 1.12, 2011/11/29 10:59:19 |
version 1.16, 2011/12/25 19:35:44 |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.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 expression... |
.Ar expression ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
Line 35 utility queries manual page databases generated by |
|
Line 36 utility queries manual page databases generated by |
|
evaluating on |
evaluating on |
.Ar expression |
.Ar expression |
for each file in each database. |
for each file in each database. |
|
.Pp |
|
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 , |
|
parses terms as case-sensitive regular expressions |
|
.Pq the Li \&~ operator |
|
over manual names and descriptions |
|
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
|
Multiple terms imply pairwise |
|
.Fl o . |
|
.Pp |
Its arguments are as follows: |
Its arguments 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 path instead of the default list of paths |
searched for |
searched for |
Line 119 is evaluated case-insensitively. |
|
Line 140 is evaluated case-insensitively. |
|
Has no effect on substring terms. |
Has no effect on substring terms. |
.El |
.El |
.Pp |
.Pp |
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 , |
|
parses terms as case-sensitive regular expressions |
|
.Pq the Li \&~ operator |
|
over manual names and descriptions |
|
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
|
Multiple terms imply pairwise |
|
.Fl o . |
|
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 232 Text production: |
|
Line 241 Text production: |
|
.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 |
|
.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 |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |