version 1.8, 2011/11/23 10:09:30 |
version 1.11, 2011/11/29 10:53:42 |
|
|
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 manpath |
Append 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 |
databases. |
databases. |
|
|
This has syntax |
This has syntax |
.Li [key[,key]*(=~)]?val , |
.Li [key[,key]*(=~)]?val , |
where operand |
where operand |
.Li key |
.Cm key |
is an |
is an |
.Xr mdoc 7 |
.Xr mdoc 7 |
macro to query and |
macro to query and |
.Li val |
.Cm val |
is its value. |
is its value. |
|
See |
|
.Sx Macro Keys |
|
for a list of available keys. |
Operator |
Operator |
.Li \&= |
.Li \&= |
evaluates a substring, while |
evaluates a substring, while |
.Li \&~ |
.Li \&~ |
evaluates a regular expression. |
evaluates a regular expression. |
.It Fl i Ar term |
.It Fl i Ar term |
Same as |
If |
.Ar term , |
|
but |
|
.Ar term |
.Ar term |
|
is a regular expression, it |
is evaluated case-insensitively. |
is evaluated case-insensitively. |
|
Has no effect on substring terms. |
.El |
.El |
.Pp |
.Pp |
By default, |
By default, |
Line 125 databases in the default paths stipulated by |
|
Line 128 databases in the default paths stipulated by |
|
parses terms as case-sensitive regular expressions |
parses terms as case-sensitive regular expressions |
.Pq the Li \&~ operator |
.Pq the Li \&~ operator |
over manual names and descriptions |
over manual names and descriptions |
.Pq the Li \&Nm No and Li \&Nd No macros . |
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
Multiple terms imply pairwise |
Multiple terms imply pairwise |
.Fl o . |
.Fl o . |
Results are sorted by manual title, with output formatted as |
Results are sorted by manual title, with output formatted as |
Line 151 Resulting manuals may be accessed as |
|
Line 154 Resulting manuals may be accessed as |
|
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 title |
|
.Ss Macro Keys |
|
Queries evaluate over a subset of |
|
.Xr mdoc 7 |
|
macros indexed by |
|
.Xr mandocdb 8 . |
|
In addition to the macro keys listed below, the special key |
|
.Cm any |
|
may be used to match any available macro key. |
|
.Pp |
|
Names and description: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&Nm Ta manual name |
|
.It Li \&Nd Ta one-line manual description |
|
.El |
|
.Pp |
|
Sections and cross references: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&Sh Ta section header (excluding standard sections) |
|
.It Li \&Ss Ta subsection header |
|
.It Li \&Xr Ta cross reference to another manual page |
|
.It Li \&Rs Ta bibliographic reference |
|
.El |
|
.Pp |
|
Semantic markup for command line utilities: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&Fl Ta command line options (flags) |
|
.It Li \&Cm Ta command modifier |
|
.It Li \&Ar Ta command argument |
|
.It Li \&Ic Ta internal or interactive command |
|
.It Li \&Ev Ta environmental variable |
|
.It Li \&Pa Ta file system path |
|
.El |
|
.Pp |
|
Semantic markup for function libraries: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&Lb Ta function library name |
|
.It Li \&In Ta include file |
|
.It Li \&Ft Ta function return type |
|
.It Li \&Fn Ta function name |
|
.It Li \&Fa Ta function argument type and name |
|
.It Li \&Vt Ta variable type |
|
.It Li \&Va Ta variable name |
|
.It Li \&Dv Ta defined variable or preprocessor constant |
|
.It Li \&Er Ta error constant |
|
.It Li \&Ev Ta environmental variable |
|
.El |
|
.Pp |
|
Various semantic markup: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&An Ta author name |
|
.It Li \&Lk Ta hyperlink |
|
.It Li \&Mt Ta Do mailto Dc hyperlink |
|
.It Li \&Cd Ta kernel configuration declaration |
|
.It Li \&Ms Ta mathematical symbol |
|
.It Li \&Tn Ta tradename |
|
.El |
|
.Pp |
|
Physical markup: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&Em Ta italic font or underline |
|
.It Li \&Sy Ta boldface font |
|
.It Li \&Li Ta typewriter font |
|
.El |
|
.Pp |
|
Text production: |
|
.Bl -column "xLix" description -offset indent -compact |
|
.It Li \&St Ta reference to a standards document |
|
.It Li \&At Ta At No version reference |
|
.It Li \&Bx Ta Bx No version reference |
|
.It Li \&Bsx Ta Bsx No version reference |
|
.It Li \&Nx Ta Nx No version reference |
|
.It Li \&Fx Ta Fx No version reference |
|
.It Li \&Ox Ta Ox No version reference |
|
.It Li \&Dx Ta Dx No version reference |
|
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ev MANPATH |
.It Ev MANPATH |
Comma-separated paths overriding the default list of paths searched for |
Colon-separated paths overriding 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. |
Takes precedence over |
Overridden by |
.Fl M . |
.Fl M . |
.El |
.El |
.\" .Sh FILES |
|
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
.Sh EXAMPLES |
.Sh EXAMPLES |
Search for |
Search for |
.Qq mdoc |
.Qq mdoc |
within the manual name and description: |
as a substring and regular expression |
|
within each manual name and description: |
.Pp |
.Pp |
.Dl $ apropos mdoc |
.Dl $ apropos mdoc |
|
.Dl $ apropos ~^mdoc$ |
.Pp |
.Pp |
Two variants of searching for |
Include matches for |
.Qq mdoc , |
.Qq roff |
.Qq roff , |
and |
or |
|
.Qq man |
.Qq man |
within manual names and descriptions: |
for the regular expression case: |
.Pp |
.Pp |
.Dl $ apropos mdoc roff man |
.Dl $ apropos ~^mdoc$ roff man |
.Dl $ apropos mdoc \-o roff \-o man |
.Dl $ apropos ~^mdoc$ \-o roff \-o man |
.Pp |
.Pp |
Search for |
Search for |
.Qq optind |
.Qq optind |
|
|
.Qq optarg |
.Qq optarg |
as variable names in the library category: |
as variable names in the library category: |
.Pp |
.Pp |
.Dl $ apropos \-s 3 \(dqVa~^optind$\(dq -a \(dqVa~^optarg$\(dq |
.Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$ |
.Pp |
|
Search for all manuals referencing |
|
.Qq POSIX |
|
in any letter case: |
|
.Pp |
|
.Dl $ apropos \-\- \-i posix |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr re_format 7 , |
.Xr re_format 7 |
.Xr mandocdb 8 |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |