version 1.5, 2011/11/20 15:43:14 |
version 1.7, 2011/11/20 21:36:00 |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
|
.Op Fl M Ar manpath |
.Op Fl m Ar manpath |
.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 |
|
|
for each file in each database. |
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 |
|
Use the colon-separated path instead of the default list of paths |
|
searched for |
|
.Xr mandocdb 8 |
|
databases. |
|
Invalid paths, or paths without manual databases, are ignored. |
.It Fl m Ar manpath |
.It Fl m Ar manpath |
A colon-separated list of paths containing |
Append the colon-separated paths to the list of paths searched |
|
for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
databases. |
databases. |
Paths may be relative or absolute. |
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 |
|
|
.Nm |
.Nm |
searches for |
searches for |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
database in the current working directory and |
databases in the default paths stipulated by |
|
.Xr man 1 , |
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 |
Line 143 Resulting manuals may be accessed as |
|
Line 152 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. |
|
Takes precedence over |
|
.Fl M . |
|
.El |
.\" .Sh FILES |
.\" .Sh FILES |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
Line 182 Search for all manuals referencing |
|
Line 194 Search for all manuals referencing |
|
in any letter case: |
in any letter case: |
.Pp |
.Pp |
.Dl $ apropos \-\- \-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. |
|