version 1.3, 2011/11/09 10:53:48 |
version 1.6, 2011/11/20 16:29:50 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm apropos |
.Nm apropos |
.Nd search the manual page database |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl I |
.Op Fl m Ar manpath |
.Op Fl S Ar arch |
.Op Fl S Ar arch |
.Op Fl s Ar section |
.Op Fl s Ar section |
.Op Fl t Ar types |
.Ar expression... |
.Ar pattern |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility queries the manual page database. |
utility queries manual page databases generated by |
|
.Xr mandocdb 8 , |
|
evaluating on |
|
.Ar expression |
|
for each file in each database. |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl m Ar manpath |
|
Append the colon-separated paths to the default list of paths searched |
|
for |
|
.Xr mandocdb 8 |
|
databases. |
|
Invalid paths, or paths without manual databases, are ignored. |
.It Fl S Ar arch |
.It Fl S Ar arch |
Search only for a particular architecture. |
Search only for a particular architecture. |
.It Fl s Ar cat |
.It Fl s Ar cat |
Line 40 Search only for a manual section. |
|
Line 49 Search only for a manual section. |
|
See |
See |
.Xr man 1 |
.Xr man 1 |
for a listing of manual sections. |
for a listing of manual sections. |
.It Fl I |
|
Case-insensitive pattern matching. |
|
.It Fl t Ar types |
|
Consider only types of keyword match, where |
|
.Ar types |
|
is a comma-separated list consisting of the following: |
|
.Ar name , |
|
manual names; |
|
.Ar func , |
|
function names; |
|
.Ar utility , |
|
utility names; |
|
.Ar incl , |
|
include files; |
|
.Ar var , |
|
variable names; |
|
.Ar stand , |
|
standards ; |
|
.Ar auth , |
|
authors; |
|
.Ar conf , |
|
configuration strings; |
|
.Ar desc , |
|
descriptive text; |
|
.Ar xref , |
|
cross-references. |
|
.Ar path , |
|
file pathnames; |
|
.Ar env , |
|
environment variables; or |
|
.Ar err , |
|
error codes. |
|
Specifying |
|
.Ar all |
|
will search for all types. |
|
.It Ar key |
|
The search key. |
|
.El |
.El |
.Pp |
.Pp |
|
An |
|
.Ar expression |
|
consists of search terms joined by logical operators |
|
.Fl a |
|
.Pq and |
|
and |
|
.Fl o |
|
.Pq or . |
|
The |
|
.Fl a |
|
operator has precedence over |
|
.Fl o |
|
and both are evaluated left-to-right. |
|
.Pp |
|
.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 , |
|
where operand |
|
.Li key |
|
is an |
|
.Xr mdoc 7 |
|
macro to query and |
|
.Li val |
|
is its value. |
|
Operator |
|
.Li \&= |
|
evaluates a substring, while |
|
.Li \&~ |
|
evaluates a regular expression. |
|
.It Fl i Ar term |
|
Same as |
|
.Ar term , |
|
but |
|
.Ar term |
|
is evaluated case-insensitively. |
|
.El |
|
.Pp |
By default, |
By default, |
.Nm |
.Nm |
searches for pattern matches of |
searches for a |
.Ar pattern |
.Xr mandocdb 8 |
in manual names and descriptions |
database in the current working directory and |
and displays results sorted by manual title. |
parses terms as case-sensitive regular expressions |
Output is formatted as |
.Pq the Li \&~ operator |
|
over manual names and descriptions |
|
.Pq the Li \&Nm No and Li \&Nd No macros . |
|
Multiple terms imply pairwise |
|
.Fl o . |
|
Results are sorted by manual title, with output formatted as |
.Pp |
.Pp |
.D1 title(sec) \- description |
.D1 title(sec) \- description |
.Pp |
.Pp |
Line 108 Resulting manuals may be accessed as |
|
Line 144 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 |
.\" .Sh IMPLEMENTATION NOTES |
.Sh ENVIRONMENT |
.\" Not used in OpenBSD. |
.Bl -tag -width Ds |
.\" .Sh RETURN VALUES |
.It Ev MANPATH |
.\" For sections 2, 3, & 9 only. |
Comma-separated paths overriding the default list of paths searched for |
.\" .Sh ENVIRONMENT |
manual databases. |
.\" For sections 1, 6, 7, & 8 only. |
Invalid paths, or paths without manual databases, are ignored. |
|
.El |
.\" .Sh FILES |
.\" .Sh FILES |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
.Sh EXAMPLES |
.Sh EXAMPLES |
Search for |
Search for |
|
.Qq mdoc |
|
within the manual name and description: |
|
.Pp |
|
.Dl $ apropos mdoc |
|
.Pp |
|
Two variants of searching for |
|
.Qq mdoc , |
|
.Qq roff , |
|
or |
|
.Qq man |
|
within manual names and descriptions: |
|
.Pp |
|
.Dl $ apropos mdoc roff man |
|
.Dl $ apropos mdoc \-o roff \-o man |
|
.Pp |
|
Search for |
.Qq optind |
.Qq optind |
as a variable name in the library category: |
and |
|
.Qq optarg |
|
as variable names in the library category: |
.Pp |
.Pp |
.Dl $ apropos \-tvar \-s 3 optind |
.Dl $ apropos \-s 3 \(dqVa~^optind$\(dq -a \(dqVa~^optarg$\(dq |
.Pp |
.Pp |
Search for all manuals referencing the term |
Search for all manuals referencing |
.Qq POSIX |
.Qq POSIX |
in any letter case: |
in any letter case: |
.Pp |
.Pp |
.Dl $ apropos \-tall \-I posix |
.Dl $ apropos \-\- \-i posix |
.\" .Sh DIAGNOSTICS |
|
.\" For sections 1, 4, 6, 7, & 8 only. |
|
.\" .Sh ERRORS |
|
.\" For sections 2, 3, & 9 only. |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr re_format 7 |
.Xr re_format 7 |
.\" .Sh STANDARDS |
|
.\" .Sh HISTORY |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons , |
.Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
.\" .Sh CAVEATS |
|
.\" .Sh BUGS |
|
.\" .Sh SECURITY CONSIDERATIONS |
|
.\" Not used in OpenBSD. |
|