version 1.27, 2014/04/18 09:47:09 |
version 1.32, 2014/08/22 03:42:18 |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
|
.Op Fl acfkw |
.Op Fl C Ar file |
.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 |
|
|
and |
and |
.Nm whatis |
.Nm whatis |
utilities query manual page databases generated by |
utilities query manual page databases generated by |
.Xr mandocdb 8 , |
.Xr makewhatis 8 , |
evaluating |
evaluating |
.Ar expression |
.Ar expression |
for each file in each database. |
for each file in each database. |
By default, it displays the names, section numbers, and description lines |
By default, they display the names, section numbers, and description lines |
of all matching manuals. |
of all matching manuals. |
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
searches for |
searches for |
.Xr mandocdb 8 |
.Xr makewhatis 8 |
databases in the default paths stipulated by |
databases in the default paths stipulated by |
.Xr man 1 |
.Xr man 1 |
and uses case-insensitive substring matching |
and uses case-insensitive substring matching |
Line 56 over manual names and descriptions |
|
Line 57 over manual names and descriptions |
|
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
Multiple terms imply pairwise |
Multiple terms imply pairwise |
.Fl o . |
.Fl o . |
|
.Pp |
.Nm whatis |
.Nm whatis |
maps terms only to case-sensitive manual names. |
is a synonym for |
|
.Nm |
|
.Fl f . |
.Pp |
.Pp |
Its arguments are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl a |
|
Instead of showing only the title lines, show the complete manual pages, |
|
just like |
|
.Xr man 1 |
|
.Fl a |
|
would. |
|
If the standard output is a terminal device and |
|
.Fl c |
|
is not specified, use |
|
.Xr more 1 |
|
to paginate them. |
|
In |
|
.Fl a |
|
mode, the options |
|
.Fl IOTW |
|
described in the |
|
.Xr mandoc 1 |
|
manual are also available. |
.It Fl C Ar file |
.It Fl C Ar file |
Specify an alternative configuration |
Specify an alternative configuration |
.Ar file |
.Ar file |
in |
in |
.Xr man.conf 5 |
.Xr man.conf 5 |
format. |
format. |
|
.It Fl c |
|
In |
|
.Fl a |
|
mode, copy the formatted manual pages to the standard output without using |
|
.Xr more 1 |
|
to paginate them. |
|
.It Fl f |
|
Search for all words in |
|
.Ar expression |
|
in manual page names only. |
|
The search is case insensitive and matches whole words only. |
|
In this mode, macro keys, comparison operators, and logical operators |
|
are not available. |
|
This overrides any earlier |
|
.Fl k |
|
option. |
|
.It Fl k |
|
Support the full |
|
.Ar expression |
|
syntax. |
|
This overrides any earlier |
|
.Fl f |
|
option. |
|
It is the default for |
|
.Nm . |
.It Fl M Ar path |
.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 makewhatis 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 path |
.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 makewhatis 8 |
databases. |
databases. |
Invalid paths, or paths without manual databases, are ignored. |
Invalid paths, or paths without manual databases, are ignored. |
.It Fl O Ar outkey |
.It Fl O Ar outkey |
Line 96 By default, pages from all sections are shown. |
|
Line 143 By default, pages from all sections are shown. |
|
See |
See |
.Xr man 1 |
.Xr man 1 |
for a listing of sections. |
for a listing of sections. |
|
.It Fl w |
|
Instead of showing title lines, show the pathnames of the matching |
|
manual pages, just like |
|
.Xr man 1 |
|
.Fl w |
|
would. |
.El |
.El |
.Pp |
.Pp |
An |
An |
|
|
.Op Ar key Op , Ar key ... |
.Op Ar key Op , Ar key ... |
.Pq Cm = | ~ |
.Pq Cm = | ~ |
.Oc |
.Oc |
.Ar val |
.Ar val , |
.Sm on , |
.Sm on |
where |
where |
.Ar key |
.Ar key |
is an |
is an |
Line 165 is evaluated case-insensitively. |
|
Line 218 is evaluated case-insensitively. |
|
Has no effect on substring terms. |
Has no effect on substring terms. |
.El |
.El |
.Pp |
.Pp |
.Nm whatis |
|
considers an |
|
.Ar expression |
|
to consist of an opaque keyword. |
|
.Pp |
|
Results are sorted by manual sections and names, with output formatted as |
Results are sorted by manual sections and names, with output formatted as |
.Pp |
.Pp |
.D1 name[, name...](sec) \- description |
.D1 name[, name...](sec) \- description |
Line 196 If an architecture is specified in the output, use |
|
Line 244 If an architecture is specified in the output, use |
|
Queries evaluate over a subset of |
Queries evaluate over a subset of |
.Xr mdoc 7 |
.Xr mdoc 7 |
macros indexed by |
macros indexed by |
.Xr mandocdb 8 . |
.Xr makewhatis 8 . |
In addition to the macro keys listed below, the special key |
In addition to the macro keys listed below, the special key |
.Cm any |
.Cm any |
may be used to match any available macro key. |
may be used to match any available macro key. |
Line 293 standard search path. |
|
Line 341 standard search path. |
|
.Bl -tag -width "/etc/man.conf" -compact |
.Bl -tag -width "/etc/man.conf" -compact |
.It Pa mandoc.db |
.It Pa mandoc.db |
name of the |
name of the |
.Xr mandocdb 8 |
.Xr makewhatis 8 |
keyword database |
keyword database |
.It Pa /etc/man.conf |
.It Pa /etc/man.conf |
default |
default |
Line 347 The following two invocations are equivalent: |
|
Line 395 The following two invocations are equivalent: |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr re_format 7 , |
.Xr re_format 7 , |
.Xr mandocdb 8 |
.Xr makewhatis 8 |
.Sh HISTORY |
.Sh HISTORY |
An |
Part of the functionality of |
|
.Nm whatis |
|
was already provided by the former |
|
.Nm manwhere |
|
utility in |
|
.Bx 1 . |
|
The |
.Nm |
.Nm |
utility first appeared in |
and |
|
.Nm whatis |
|
utilities first appeared in |
.Bx 2 . |
.Bx 2 . |
It was rewritten from scratch for |
They were rewritten from scratch for |
.Ox 5.6 . |
.Ox 5.6 . |
.Pp |
.Pp |
The |
The |
|
|
and |
and |
.Fl s |
.Fl s |
in |
in |
.Ox 4.5 . |
.Ox 4.5 |
|
for |
|
.Nm |
|
and in |
|
.Ox 5.6 |
|
for |
|
.Nm whatis . |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
.An Bill Joy |
.An Bill Joy |
wrote the original |
wrote |
|
.Nm manwhere |
|
in 1977 and the original |
.Bx |
.Bx |
.Nm |
.Nm |
|
and |
|
.Nm whatis |
in February 1979. |
in February 1979. |
The current version was written by |
The current version was written by |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |