version 1.18, 2012/06/08 10:44:52 |
version 1.20, 2013/07/05 09:33:02 |
|
|
.Dt APROPOS 1 |
.Dt APROPOS 1 |
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm apropos |
.Nm apropos , |
|
.Nm whatis |
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl M Ar manpath |
.Op Fl M Ar path |
.Op Fl m Ar manpath |
.Op Fl m Ar path |
.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 apropos |
utility queries manual page databases generated by |
and |
|
.Nm whatis |
|
utilities query manual page databases generated by |
.Xr mandocdb 8 , |
.Xr mandocdb 8 , |
evaluating on |
evaluating on |
.Ar expression |
.Ar expression |
|
|
databases in the default paths stipulated by |
databases in the default paths stipulated by |
.Xr man 1 |
.Xr man 1 |
and |
and |
parses terms as case-sensitive words |
maps terms to case-sensitive manual names and descriptions. |
over manual names and descriptions. |
|
Multiple terms are OR'd. |
Multiple terms are OR'd. |
|
.Nm whatis |
|
maps terms only to case-sensitive manual names. |
.Pp |
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
Line 56 Specify an alternative configuration |
|
Line 60 Specify an alternative configuration |
|
in |
in |
.Xr man.conf 5 |
.Xr man.conf 5 |
format. |
format. |
.It Fl M Ar manpath |
.It Fl M Ar path |
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 |
.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 path |
Prepend the colon-separated paths to the list of paths searched |
Prepend the colon-separated paths to the list of paths searched |
for |
for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
|
|
for a listing of manual sections. |
for a listing of manual sections. |
.El |
.El |
.Pp |
.Pp |
An |
.Nm whatis |
|
considers an |
.Ar expression |
.Ar expression |
consists of type and keyword pairs. |
to consist of an opaque keyword. |
|
.Nm apropos |
|
parses a |
|
.Ar expression |
|
into type and keyword pairs. |
This pair syntax |
This pair syntax |
.Li [key[,key]*(=~)]?val , |
.Li [key[,key]*(=~)]?val , |
where operand |
where operand |
Line 113 is the manual's short description. |
|
Line 122 is the manual's short description. |
|
If an architecture is specified for the manual, it is displayed as |
If an architecture is specified for the manual, it is displayed as |
.Qq title(cat/arch) \- description . |
.Qq title(cat/arch) \- description . |
.Ss Macro Keys |
.Ss Macro Keys |
Queries evaluate over a subset of |
.Nm apropos |
|
queries evaluate over a subset of |
.Xr mdoc 7 |
.Xr mdoc 7 |
macros indexed by |
macros indexed by |
.Xr mandocdb 8 . |
.Xr mandocdb 8 . |
Line 209 If none of these conditions are met, it overrides the |
|
Line 219 If none of these conditions are met, it overrides the |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width "/etc/man.conf" -compact |
.Bl -tag -width "/etc/man.conf" -compact |
.It Pa whatis.db |
.It Pa mandocdb.db |
name of the |
name of the |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
keyword database |
keyword database |
.It Pa whatis.index |
|
name of the |
|
.Xr mandocdb 8 |
|
filename database |
|
.It Pa /etc/man.conf |
.It Pa /etc/man.conf |
default |
default |
.Xr man 1 |
.Xr man 1 |