version 1.23, 2014/03/17 09:43:56 |
version 1.30, 2014/08/21 01:52:59 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.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 |
|
.Op Fl O Ar outkey |
.Op Fl S Ar arch |
.Op Fl S Ar arch |
.Op Fl s Ar section |
.Op Fl s Ar section |
.Ar expression ... |
.Ar expression ... |
|
|
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 |
|
|
.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 |
|
Show the values associated with the key |
|
.Ar outkey |
|
instead of the manual descriptions. |
.It Fl S Ar arch |
.It Fl S Ar arch |
Restrict the search to pages for the specified |
Restrict the search to pages for the specified |
.Xr machine 1 |
.Xr machine 1 |
|
|
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 |
|
|
.Ar expression |
.Ar expression |
to consist of an opaque keyword. |
to consist of an opaque keyword. |
.Pp |
.Pp |
Results are sorted by manual title, with output formatted as |
Results are sorted by manual sections and names, with output formatted as |
.Pp |
.Pp |
.D1 title(sec) \- description |
.D1 name[, name...](sec) \- description |
.Pp |
.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. |
Line 192 Names and description: |
|
Line 205 Names and description: |
|
.Bl -column "xLix" description -offset indent -compact |
.Bl -column "xLix" description -offset indent -compact |
.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 sec Ta manual section number |
.El |
.El |
.Pp |
.Pp |
Sections and cross references: |
Sections and cross references: |
Line 278 standard search path. |
|
Line 293 standard search path. |
|
.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 |
Line 306 Search in names and descriptions using a regular expre |
|
Line 321 Search in names and descriptions using a regular expre |
|
.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 |
Line 320 with the argument |
|
Line 335 with the argument |
|
.Qq ssh : |
.Qq ssh : |
.Pp |
.Pp |
.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]' |
.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]' |
|
.Pp |
|
The following two invocations are equivalent: |
|
.Pp |
|
.D1 Li $ apropos -S Ar arch Li -s Ar section expression |
|
.Bd -ragged -offset indent |
|
.Li $ apropos \e( Ar expression Li \e) |
|
.Li -a arch~^( Ns Ar arch Ns Li |any)$ |
|
.Li -a sec~^ Ns Ar section Ns Li $ |
|
.Ed |
.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.1 . |
.Ox 5.6 . |
.Pp |
.Pp |
The |
The |
.Fl M |
.Fl M |
|
|
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 |
|
and |
|
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |