version 1.17, 2012/03/24 01:46:25 |
version 1.18, 2012/06/08 10:44:52 |
|
|
searches for |
searches for |
.Xr mandocdb 8 |
.Xr mandocdb 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 |
|
parses terms as case-sensitive words |
over manual names and descriptions. |
over manual names and descriptions. |
Multiple terms imply pairwise |
Multiple terms are OR'd. |
.Fl o . |
|
If standard output is a TTY, a result may be selected from a list and |
|
its manual displayed with the pager. |
|
.Pp |
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
Line 81 for a listing of manual sections. |
|
Line 79 for a listing of manual sections. |
|
.Pp |
.Pp |
An |
An |
.Ar expression |
.Ar expression |
consists of search terms joined by logical operators |
consists of type and keyword pairs. |
.Fl a |
This pair syntax |
.Pq and |
|
and |
|
.Fl o |
|
.Pq or . |
|
The |
|
.Fl a |
|
operator has precedence over |
|
.Fl o |
|
and both are evaluated left-to-right. |
|
.Bl -tag -width Ds |
|
.It \&( Ar expr No \&) |
|
True if the subexpression |
|
.Ar expr |
|
is true. |
|
.It Ar expr1 Fl a Ar expr2 |
|
True if both |
|
.Ar expr1 |
|
and |
|
.Ar expr2 |
|
are true (logical |
|
.Qq and ) . |
|
.It Ar expr1 Oo Fl o Oc Ar expr2 |
|
True if |
|
.Ar expr1 |
|
and/or |
|
.Ar expr2 |
|
evaluate to true (logical |
|
.Qq or ) . |
|
.It Ar term |
|
True if |
|
.Ar term |
|
is satisfied. |
|
This has syntax |
|
.Li [key[,key]*(=~)]?val , |
.Li [key[,key]*(=~)]?val , |
where operand |
where operand |
.Cm key |
.Cm key |
|
|
for a list of available keys. |
for a list of available keys. |
Operator |
Operator |
.Li \&= |
.Li \&= |
evaluates a substring, while |
evaluates a full string, while |
.Li \&~ |
.Li \&~ |
evaluates a regular expression. |
evaluates a |
.It Fl i Ar term |
.Xr glob 7 |
If |
pattern. |
.Ar term |
|
is a regular expression, it |
|
is evaluated case-insensitively. |
|
Has no effect on substring terms. |
|
.El |
|
.Pp |
.Pp |
Results are sorted by manual title, with output formatted as |
Results are sorted by manual title, with output formatted as |
.Pp |
.Qq title(sec) \- description |
.D1 title(sec) \- description |
where |
.Pp |
|
Where |
|
.Qq title |
.Qq title |
is the manual's title (note multiple manual names may exist for one |
is the manual's title (note multiple manual names may exist for one |
title), |
title), |
Line 153 is the manual section, and |
|
Line 111 is the manual section, and |
|
.Qq description |
.Qq 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 |
.Qq title(cat/arch) \- description . |
.D1 title(cat/arch) \- description |
|
.Pp |
|
If on a TTY, results are prefixed with a numeric identifier. |
|
.Pp |
|
.D1 [index] title(cat) \- description |
|
.Pp |
|
One may choose a manual be entering the index at the prompt. |
|
Valid choices are displayed using |
|
.Ev MANPAGER , |
|
or failing that , |
|
.Ev PAGER |
|
or just |
|
.Xr more 1 . |
|
Source pages are formatted with |
|
.Xr mandoc 1 ; |
|
preformatted pages with |
|
.Xr cat 1 . |
|
.Ss Macro Keys |
.Ss Macro Keys |
Queries evaluate over a subset of |
Queries evaluate over a subset of |
.Xr mdoc 7 |
.Xr mdoc 7 |
Line 248 Text production: |
|
Line 189 Text production: |
|
.El |
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev MANPAGER |
|
Default pager for manuals. |
|
If this is unset, falls back to |
|
.Ev Pager . |
|
.It Ev PAGER |
|
The second choice for a manual pager. |
|
If this is unset, use |
|
.Xr more 1 . |
|
.It Ev MANPATH |
.It Ev MANPATH |
Colon-separated paths modifying the default list of paths searched for |
Colon-separated paths modifying the default list of paths searched for |
manual databases. |
manual databases. |
Line 294 configuration file |
|
Line 227 configuration file |
|
.Sh EXAMPLES |
.Sh EXAMPLES |
Search for |
Search for |
.Qq mdoc |
.Qq mdoc |
as a substring and regular expression |
as a word or |
within each manual name and description: |
.Xr glob 7 |
|
expression: |
.Pp |
.Pp |
.Dl $ apropos mdoc |
.Dl $ apropos mdoc |
.Dl $ apropos ~^mdoc$ |
.Dl $ apropos any~mdoc* |
.Pp |
.Pp |
Include matches for |
Include matches for |
.Qq roff |
.Qq roff |
and |
and |
.Qq man |
.Qq man |
for the regular expression case: |
using |
|
.Xr glob 7 |
|
expressions: |
.Pp |
.Pp |
.Dl $ apropos ~^mdoc$ roff man |
.Dl $ apropos ~*mdoc* ~*roff* |
.Dl $ apropos ~^mdoc$ \-o roff \-o man |
|
.Pp |
.Pp |
Search for |
Search for |
.Qq optind |
|
and |
|
.Qq optarg |
.Qq optarg |
as variable names in the library category: |
as a variable name in the library category: |
.Pp |
.Pp |
.Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$ |
.Dl $ apropos \-s 3 Va=optarg |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr more 1 |
.Xr glob 7 , |
.Xr re_format 7 , |
|
.Xr mandocdb 8 |
.Xr mandocdb 8 |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |