mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.26 and 1.27

version 1.26, 2014/04/15 23:02:27

version 1.27, 2014/04/18 09:47:09

Line 38 and

.Nm whatis

utilities query manual page databases generated by

.Xr mandocdb 8 ,

evaluating on

evaluating

.Ar expression

for each file in each database.

By default, it displays the names, section numbers, and description lines

of all matching manuals.

.Pp

By default,

.Nm

searches for

.Xr mandocdb 8

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

.Pq the Li \&Nm No and Li \&Nd No macro keys .

Multiple terms imply pairwise

Line 120 True if both

Line 122 True if both

and

.Ar expr2

are true (logical

.Qq and ) .

.Sq and ) .

.It Ar expr1 Oo Fl o Oc Ar expr2

True if

.Ar expr1

and/or

.Ar expr2

evaluate to true (logical

.Qq or ) .

.Sq or ) .

.It Ar term

True if

.Ar term

is satisfied.

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

.Xr mdoc 7

macro to query and

.Cm val

.Ar val

is its value.

See

.Sx Macro Keys

for a list of available keys.

Operator

.Li \&=

.Cm =

evaluates a substring, while

.Li \&~

.Cm ~

evaluates a regular expression.

.It Fl i Ar term

Line 162 considers an

Line 170 considers an

.Ar expression

to consist of an opaque keyword.

.Pp

Results are sorted by manual title, with output formatted as

Results are sorted by manual sections and names, with output formatted as

.Pp

.D1 title(sec) \- description

.D1 name[, name...](sec) \- description

.Pp

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

.Qq description

.Dq description

is the manual's short description.

If an architecture is specified for the manual, it is displayed as

.Pp

.D1 title(cat/arch) \- description

.D1 name(sec/arch) \- description

.Pp

Resulting manuals may be accessed as

.Pp

.Dl $ man \-s sec title

.Dl $ man \-s sec name

.Pp

If an architecture is specified in the output, use

.Pp

.Dl $ man \-s sec \-S arch title

.Dl $ man \-s sec \-S arch name

.Ss Macro Keys

Queries evaluate over a subset of

.Xr mdoc 7

Line 314 Search in names and descriptions using a regular expre

Line 321 Search in names and descriptions using a regular expre

.Pp

.Dl $ apropos '~set.?[ug]id'

.Pp

Search for manuals in the library category mentioning both the

Search for manuals in the library section mentioning both the

.Qq optind

and the

.Qq optarg

CVSweb