Return to apropos.1 CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.25, 2014/04/04 15:55:19 | 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 | ||
|
|
||
and | and | ||
.Nm whatis | .Nm whatis | ||
utilities query manual page databases generated by | utilities query manual page databases generated by | ||
.Xr mandocdb 8 , | .Xr makewhatis 8 , | ||
evaluating on | evaluating | ||
.Ar expression | .Ar expression | ||
for each file in each database. | for each file in each database. | ||
By default, they display the names, section numbers, and description lines | |||
of all matching manuals. | |||
.Pp | .Pp | ||
By default, | By default, | ||
.Nm | .Nm | ||
searches for | searches for | ||
.Xr mandocdb 8 | .Xr makewhatis 8 | ||
databases in the default paths stipulated by | databases in the default paths stipulated by | ||
.Xr man 1 , | .Xr man 1 | ||
parses terms as case-sensitive regular expressions | and uses case-insensitive substring matching | ||
.Pq the Li \&~ operator | .Pq the Cm = No operator | ||
over manual names and descriptions | 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 | ||
.Xr mandocdb 8 | .Xr makewhatis 8 | ||
databases. | databases. | ||
Invalid paths, or paths without manual databases, are ignored. | Invalid paths, or paths without manual databases, are ignored. | ||
.It Fl m Ar path | .It Fl m Ar path | ||
Prepend 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 makewhatis 8 | ||
databases. | databases. | ||
Invalid paths, or paths without manual databases, are ignored. | Invalid paths, or paths without manual databases, are ignored. | ||
.It Fl O Ar outkey | .It Fl O Ar outkey | ||
|
|
||
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 | ||
|
|
||
and | and | ||
.Ar expr2 | .Ar expr2 | ||
are true (logical | are true (logical | ||
.Qq and ) . | .Sq and ) . | ||
.It Ar expr1 Oo Fl o Oc Ar expr2 | .It Ar expr1 Oo Fl o Oc Ar expr2 | ||
True if | True if | ||
.Ar expr1 | .Ar expr1 | ||
and/or | and/or | ||
.Ar expr2 | .Ar expr2 | ||
evaluate to true (logical | evaluate to true (logical | ||
.Qq or ) . | .Sq or ) . | ||
.It Ar term | .It Ar term | ||
True if | True if | ||
.Ar term | .Ar term | ||
is satisfied. | is satisfied. | ||
This has syntax | This has syntax | ||
.Li [key[,key]*(=~)]?val , | .Sm off | ||
where operand | .Oo | ||
.Cm key | .Op Ar key Op , Ar key ... | ||
.Pq Cm = | ~ | |||
.Oc | |||
.Ar val , | |||
.Sm on | |||
where | |||
.Ar key | |||
is an | is an | ||
.Xr mdoc 7 | .Xr mdoc 7 | ||
macro to query and | macro to query and | ||
.Cm val | .Ar val | ||
is its value. | is its value. | ||
See | See | ||
.Sx Macro Keys | .Sx Macro Keys | ||
for a list of available keys. | for a list of available keys. | ||
Operator | Operator | ||
.Li \&= | .Cm = | ||
evaluates a substring, while | evaluates a substring, while | ||
.Li \&~ | .Cm ~ | ||
evaluates a regular expression. | evaluates a regular expression. | ||
.It Fl i Ar term | .It Fl i Ar term | ||
If | If | ||
|
|
||
Has no effect on substring terms. | Has no effect on substring terms. | ||
.El | .El | ||
.Pp | .Pp | ||
.Nm whatis | Results are sorted by manual sections and names, with output formatted as | ||
considers an | |||
.Ar expression | |||
to consist of an opaque keyword. | |||
.Pp | .Pp | ||
Results are sorted by manual title, with output formatted as | .D1 name[, name...](sec) \- description | ||
.Pp | .Pp | ||
.D1 title(sec) \- description | |||
.Pp | |||
Where | Where | ||
.Qq title | .Dq name | ||
is the manual's title (note multiple manual names may exist for one | is the manual's name, | ||
title), | .Dq sec | ||
.Qq sec | |||
is the manual section, and | is the manual section, and | ||
.Qq description | .Dq description | ||
is the manual's short description. | is the manual's short description. | ||
If an architecture is specified for the manual, it is displayed as | If an architecture is specified for the manual, it is displayed as | ||
.Pp | .Pp | ||
.D1 title(cat/arch) \- description | .D1 name(sec/arch) \- description | ||
.Pp | .Pp | ||
Resulting manuals may be accessed as | Resulting manuals may be accessed as | ||
.Pp | .Pp | ||
.Dl $ man \-s sec title | .Dl $ man \-s sec name | ||
.Pp | .Pp | ||
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 name | ||
.Ss Macro Keys | .Ss Macro Keys | ||
Queries evaluate over a subset of | Queries evaluate over a subset of | ||
.Xr mdoc 7 | .Xr mdoc 7 | ||
macros indexed by | macros indexed by | ||
.Xr mandocdb 8 . | .Xr makewhatis 8 . | ||
In addition to the macro keys listed below, the special key | In addition to the macro keys listed below, the special key | ||
.Cm any | .Cm any | ||
may be used to match any available macro key. | may be used to match any available macro key. | ||
.Pp | .Pp | ||
Names and description: | Names and description: | ||
.Bl -column "xLix" description -offset indent -compact | .Bl -column "xLix" description -offset indent -compact | ||
.It Li NAME Ta manual name in the NAME section, subset of \&Nm | |||
.It Li \&Nm Ta manual name | .It Li \&Nm Ta manual name | ||
.It Li \&Nd Ta one-line manual description | .It Li \&Nd Ta one-line manual description | ||
.It Li arch Ta machine architecture (case-insensitive) | .It Li arch Ta machine architecture (case-insensitive) | ||
|
|
||
.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 | ||
|
|
||
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 | ||
.It Pa mandoc.db | .It Pa mandoc.db | ||
name of the | name of the | ||
.Xr mandocdb 8 | .Xr makewhatis 8 | ||
keyword database | keyword database | ||
.It Pa /etc/man.conf | .It Pa /etc/man.conf | ||
default | default | ||
|
|
||
.Pp | .Pp | ||
.Dl $ apropos '~set.?[ug]id' | .Dl $ apropos '~set.?[ug]id' | ||
.Pp | .Pp | ||
Search for manuals in the library category mentioning both the | Search for manuals in the library section mentioning both the | ||
.Qq optind | .Qq optind | ||
and the | and the | ||
.Qq optarg | .Qq optarg | ||
|
|
||
.Sh SEE ALSO | .Sh SEE ALSO | ||
.Xr man 1 , | .Xr man 1 , | ||
.Xr re_format 7 , | .Xr re_format 7 , | ||
.Xr mandocdb 8 | .Xr makewhatis 8 | ||
.Sh HISTORY | .Sh HISTORY | ||
An | Part of the functionality of | ||
.Nm whatis | |||
was already provided by the former | |||
.Nm manwhere | |||
utility in | |||
.Bx 1 . | |||
The | |||
.Nm | .Nm | ||
utility first appeared in | and | ||
.Nm whatis | |||
utilities first appeared in | |||
.Bx 2 . | .Bx 2 . | ||
It was rewritten from scratch for | They were rewritten from scratch for | ||
.Ox 5.6 . | .Ox 5.6 . | ||
.Pp | .Pp | ||
The | The | ||
|
|
||
and | and | ||
.Fl s | .Fl s | ||
in | in | ||
.Ox 4.5 . | .Ox 4.5 | ||
for | |||
.Nm | |||
and in | |||
.Ox 5.6 | |||
for | |||
.Nm whatis . | |||
.Sh AUTHORS | .Sh AUTHORS | ||
.An -nosplit | .An -nosplit | ||
.An Bill Joy | .An Bill Joy | ||
wrote the original | wrote | ||
.Nm manwhere | |||
in 1977 and the original | |||
.Bx | .Bx | ||
.Nm | .Nm | ||
and | |||
.Nm whatis | |||
in February 1979. | in February 1979. | ||
The current version was written by | The current version was written by | ||
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv | .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv |