version 1.24, 2014/04/04 15:51:28 |
version 1.29, 2014/04/24 00:28:19 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
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 on |
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 |
|
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 |
parses terms as case-sensitive regular expressions |
and uses case-insensitive substring matching |
.Pq the Li \&~ operator |
.Pq the Cm = No operator |
over manual names and descriptions |
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 |
|
|
.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 |
|
|
and |
and |
.Ar expr2 |
.Ar expr2 |
are true (logical |
are true (logical |
.Qq and ) . |
.Sq and ) . |
.It Ar expr1 Oo Fl o Oc Ar expr2 |
.It Ar expr1 Oo Fl o Oc Ar expr2 |
True if |
True if |
.Ar expr1 |
.Ar expr1 |
and/or |
and/or |
.Ar expr2 |
.Ar expr2 |
evaluate to true (logical |
evaluate to true (logical |
.Qq or ) . |
.Sq or ) . |
.It Ar term |
.It Ar term |
True if |
True if |
.Ar term |
.Ar term |
is satisfied. |
is satisfied. |
This has syntax |
This has syntax |
.Li [key[,key]*(=~)]?val , |
.Sm off |
where operand |
.Oo |
.Cm key |
.Op Ar key Op , Ar key ... |
|
.Pq Cm = | ~ |
|
.Oc |
|
.Ar val , |
|
.Sm on |
|
where |
|
.Ar key |
is an |
is an |
.Xr mdoc 7 |
.Xr mdoc 7 |
macro to query and |
macro to query and |
.Cm val |
.Ar val |
is its value. |
is its value. |
See |
See |
.Sx Macro Keys |
.Sx Macro Keys |
for a list of available keys. |
for a list of available keys. |
Operator |
Operator |
.Li \&= |
.Cm = |
evaluates a substring, while |
evaluates a substring, while |
.Li \&~ |
.Cm ~ |
evaluates a regular expression. |
evaluates a regular expression. |
.It Fl i Ar term |
.It Fl i Ar term |
If |
If |
|
|
.Ar expression |
.Ar expression |
to consist of an opaque keyword. |
to consist of an opaque keyword. |
.Pp |
.Pp |
Results are sorted by manual title, with output formatted as |
Results are sorted by manual sections and names, with output formatted as |
.Pp |
.Pp |
.D1 title(sec) \- description |
.D1 name[, name...](sec) \- description |
.Pp |
.Pp |
Where |
Where |
.Qq title |
.Dq name |
is the manual's title (note multiple manual names may exist for one |
is the manual's name, |
title), |
.Dq sec |
.Qq sec |
|
is the manual section, and |
is the manual section, and |
.Qq description |
.Dq description |
is the manual's short description. |
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 |
.Pp |
.Pp |
.D1 title(cat/arch) \- description |
.D1 name(sec/arch) \- description |
.Pp |
.Pp |
Resulting manuals may be accessed as |
Resulting manuals may be accessed as |
.Pp |
.Pp |
.Dl $ man \-s sec title |
.Dl $ man \-s sec name |
.Pp |
.Pp |
If an architecture is specified in the output, use |
If an architecture is specified in the output, use |
.Pp |
.Pp |
.Dl $ man \-s sec \-S arch title |
.Dl $ man \-s sec \-S arch name |
.Ss Macro Keys |
.Ss Macro Keys |
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 285 standard search path. |
|
Line 293 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 313 Search in names and descriptions using a regular expre |
|
Line 321 Search in names and descriptions using a regular expre |
|
.Pp |
.Pp |
.Dl $ apropos '~set.?[ug]id' |
.Dl $ apropos '~set.?[ug]id' |
.Pp |
.Pp |
Search for manuals in the library category mentioning both the |
Search for manuals in the library section mentioning both the |
.Qq optind |
.Qq optind |
and the |
and the |
.Qq optarg |
.Qq optarg |
Line 339 The following two invocations are equivalent: |
|
Line 347 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 |
An |
.Nm |
.Nm |