version 1.30, 2014/08/21 01:52:59 |
version 1.36, 2014/10/25 01:03:52 |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
|
.Op Fl acfhklVw |
.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 56 over manual names and descriptions |
|
Line 57 over manual names and descriptions |
|
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
.Pq the Li \&Nm No and Li \&Nd No macro keys . |
Multiple terms imply pairwise |
Multiple terms imply pairwise |
.Fl o . |
.Fl o . |
|
.Pp |
.Nm whatis |
.Nm whatis |
maps terms only to case-sensitive manual names. |
is a synonym for |
|
.Nm |
|
.Fl f . |
.Pp |
.Pp |
Its arguments are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl a |
|
Instead of showing only the title lines, show the complete manual pages, |
|
just like |
|
.Xr man 1 |
|
.Fl a |
|
would. |
|
If the standard output is a terminal device and |
|
.Fl c |
|
is not specified, use |
|
.Xr more 1 |
|
to paginate them. |
|
In |
|
.Fl a |
|
mode, the options |
|
.Fl IKOTW |
|
described in the |
|
.Xr mandoc 1 |
|
manual are also available. |
.It Fl C Ar file |
.It Fl C Ar file |
Specify an alternative configuration |
Specify an alternative configuration |
.Ar file |
.Ar file |
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 |
|
Search for all words in |
|
.Ar expression |
|
in manual page names only. |
|
The search is case insensitive and matches whole words only. |
|
In this mode, macro keys, comparison operators, and logical operators |
|
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 |
|
Support the full |
|
.Ar expression |
|
syntax. |
|
This overrides any earlier |
|
.Fl f |
|
and |
|
.Fl l |
|
options. |
|
It is the default for |
|
.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 96 By default, pages from all sections are shown. |
|
Line 162 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 V |
|
Print version and exit. |
|
.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 |
An |
An |
Line 165 is evaluated case-insensitively. |
|
Line 239 is evaluated case-insensitively. |
|
Has no effect on substring terms. |
Has no effect on substring terms. |
.El |
.El |
.Pp |
.Pp |
.Nm whatis |
|
considers an |
|
.Ar expression |
|
to consist of an opaque keyword. |
|
.Pp |
|
Results are sorted by manual sections and names, with output formatted as |
Results are sorted by manual sections and names, with output formatted as |
.Pp |
.Pp |
.D1 name[, name...](sec) \- description |
.D1 name[, name...](sec) \- description |
Line 270 Text production: |
|
Line 339 Text production: |
|
.It Li \&Dx Ta Dx No version reference |
.It Li \&Dx Ta Dx No version reference |
.El |
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATH |
.Bl -tag -width MANPAGER |
|
.It Ev MANPAGER |
|
Any non-empty value of the environment variable |
|
.Ev MANPAGER |
|
will be used instead of the standard pagination program, |
|
.Xr more 1 . |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |
.Xr man 1 |
.Xr man 1 |
Line 288 or if it contains two adjacent colons, |
|
Line 362 or if it contains two adjacent colons, |
|
the standard search path is inserted between the colons. |
the standard search path is inserted between the colons. |
If none of these conditions are met, it overrides the |
If none of these conditions are met, it overrides the |
standard search path. |
standard search path. |
|
.It Ev PAGER |
|
Specifies the pagination program to use when |
|
.Ev MANPAGER |
|
is not defined. |
|
If neither PAGER nor MANPAGER is defined, |
|
.Pa /usr/bin/more Fl s |
|
will be used. |
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width "/etc/man.conf" -compact |
.Bl -tag -width "/etc/man.conf" -compact |