version 1.42, 2017/03/18 19:51:19 |
version 1.47, 2018/02/23 18:54:02 |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl acfhklw |
.Op Fl afk |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
Line 89 Specify an alternative configuration |
|
Line 89 Specify an alternative configuration |
|
in |
in |
.Xr man.conf 5 |
.Xr man.conf 5 |
format. |
format. |
.It Fl c |
|
In |
|
.Fl a |
|
mode, copy the formatted manual pages to the standard output without using |
|
.Xr more 1 |
|
to paginate them. |
|
.It Fl f |
.It Fl f |
Search for all words in |
Search for all words in |
.Ar expression |
.Ar expression |
Line 102 in manual page names only. |
|
Line 96 in manual page names only. |
|
The search is case insensitive and matches whole words only. |
The search is case insensitive and matches whole words only. |
In this mode, macro keys, comparison operators, and logical operators |
In this mode, macro keys, comparison operators, and logical operators |
are not available. |
are not available. |
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
|
.It Fl h |
|
Instead of showing the title lines, show the SYNOPSIS sections, just like |
|
.Xr man 1 |
|
.Fl h |
|
would. |
|
.It Fl k |
.It Fl k |
Support the full |
Support the full |
.Ar expression |
.Ar expression |
syntax. |
syntax. |
This overrides any earlier |
|
.Fl f |
|
and |
|
.Fl l |
|
options. |
|
It is the default for |
It is the default for |
.Nm . |
.Nm . |
.It Fl l |
|
An alias for |
|
.Xr mandoc 1 |
|
.Fl a . |
|
This overrides any earlier |
|
.Fl f , |
|
.Fl k , |
|
and |
|
.Fl w |
|
options. |
|
.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 |
Line 162 By default, pages from all sections are shown. |
|
Line 131 By default, pages from all sections are shown. |
|
See |
See |
.Xr man 1 |
.Xr man 1 |
for a listing of sections. |
for a listing of sections. |
.It Fl w |
|
Instead of showing title lines, show the pathnames of the matching |
|
manual pages, just like |
|
.Xr man 1 |
|
.Fl w |
|
would. |
|
.El |
.El |
.Pp |
.Pp |
|
The options |
|
.Fl chlw |
|
are also supported and are documented in |
|
.Xr man 1 . |
|
The options |
|
.Fl fkl |
|
are mutually exclusive and override each other. |
|
.Pp |
An |
An |
.Ar expression |
.Ar expression |
consists of search terms joined by logical operators |
consists of search terms joined by logical operators |
Line 357 Text production: |
|
Line 328 Text production: |
|
.It Li \&Ox Ta Ox No version reference |
.It Li \&Ox Ta Ox No version reference |
.It Li \&Dx Ta Dx No version reference |
.It Li \&Dx Ta Dx No version reference |
.El |
.El |
|
.Pp |
|
In general, macro keys are supposed to yield complete results without |
|
expecting the user to consider actual macro usage. |
|
For example, results include: |
|
.Pp |
|
.Bl -tag -width 3n -offset 3n -compact |
|
.It Li \&Fa |
|
function arguments appearing on |
|
.Ic \&Fn |
|
lines |
|
.It Li \&Fn |
|
fuction names marked up with |
|
.Ic \&Fo |
|
macros |
|
.It Li \&In |
|
include file names marked up with |
|
.Ic \&Fd |
|
macros |
|
.It Li \&Vt |
|
types appearing as function return types and |
|
.It \& |
|
types appearing in function arguments in the SYNOPSIS |
|
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPAGER |
.Bl -tag -width MANPAGER |
.It Ev MANPAGER |
.It Ev MANPAGER |
|
|
.Dl $ apropos \-s 3 Va=optind \-a Va=optarg |
.Dl $ apropos \-s 3 Va=optind \-a Va=optarg |
.Pp |
.Pp |
Do exactly the same as calling |
Do exactly the same as calling |
.Xr whatis 1 |
.Nm whatis |
with the argument |
with the argument |
.Qq ssh : |
.Qq ssh : |
.Pp |
.Pp |