mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.17 and 1.22

version 1.17, 2012/03/24 01:46:25

version 1.22, 2013/10/01 20:56:18

Line 18

.Dt APROPOS 1

.Os

.Sh NAME

.Nm apropos

.Nm apropos ,

.Nm whatis

.Nd search manual page databases

.Sh SYNOPSIS

.Nm

.Op Fl C Ar file

.Op Fl M Ar manpath

.Op Fl M Ar path

.Op Fl m Ar manpath

.Op Fl m Ar path

.Op Fl S Ar arch

.Op Fl s Ar section

.Ar expression ...

.Sh DESCRIPTION

The

.Nm

.Nm apropos

utility queries manual page databases generated by

and

.Nm whatis

utilities query manual page databases generated by

.Xr mandocdb 8 ,

evaluating on

.Ar expression

Line 42 By default,

Line 45 By default,

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

over manual names and descriptions.

maps terms to case-sensitive manual names and descriptions.

Multiple terms imply pairwise

Multiple terms are OR'd.

.Fl o .

.Nm whatis

If standard output is a TTY, a result may be selected from a list and

maps terms only to case-sensitive manual names.

its manual displayed with the pager.

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

Line 58 Specify an alternative configuration

Line 60 Specify an alternative configuration

.Xr man.conf 5

format.

.It Fl M Ar manpath

.It Fl M Ar path

Use the colon-separated path instead of the default list of paths

searched for

.Xr mandocdb 8

databases.

Invalid paths, or paths without manual databases, are ignored.

.It Fl m Ar manpath

.It Fl m Ar path

Prepend the colon-separated paths to the list of paths searched

for

.Xr mandocdb 8

Line 79 See

Line 81 See

for a listing of manual sections.

.El

.Pp

.Nm whatis

considers an

.Ar expression

consists of search terms joined by logical operators

to consist of an opaque keyword.

.Fl a

.Nm apropos

.Pq and

parses a

and

.Ar expression

.Fl o

into type and keyword pairs.

.Pq or .

This pair syntax

The

.Fl a

operator has precedence over

.Fl o

and both are evaluated left-to-right.

.Bl -tag -width Ds

.It \&( Ar expr No \&)

True if the subexpression

.Ar expr

is true.

.It Ar expr1 Fl a Ar expr2

True if both

.Ar expr1

and

.Ar expr2

are true (logical

.Qq and ) .

.It Ar expr1 Oo Fl o Oc Ar expr2

True if

.Ar expr1

and/or

.Ar expr2

evaluate to true (logical

.Qq or ) .

.It Ar term

True if

.Ar term

is satisfied.

This has syntax

.Li [key[,key]*(=~)]?val ,

where operand

.Cm key

Line 129 See

Line 103 See

for a list of available keys.

Operator

.Li \&=

evaluates a substring, while

evaluates a full string, while

.Li \&~

evaluates a regular expression.

evaluates a

.It Fl i Ar term

.Xr glob 7

pattern.

.Ar term

is a regular expression, it

is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

Results are sorted by manual title, with output formatted as

.Pp

.Qq title(sec) \- description

.D1 title(sec) \- description

where

.Pp

Where

.Qq title

is the manual's title (note multiple manual names may exist for one

title),

Line 153 is the manual section, and

Line 120 is the manual section, and

.Qq description

is the manual's short description.

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

.Pp

.Qq title(cat/arch) \- description .

.D1 title(cat/arch) \- description

.Pp

If on a TTY, results are prefixed with a numeric identifier.

.Pp

.D1 [index] title(cat) \- description

.Pp

One may choose a manual be entering the index at the prompt.

Valid choices are displayed using

.Ev MANPAGER ,

or failing that ,

.Ev PAGER

or just

.Xr more 1 .

Source pages are formatted with

.Xr mandoc 1 ;

preformatted pages with

.Xr cat 1 .

.Ss Macro Keys

Queries evaluate over a subset of

.Nm apropos

queries evaluate over a subset of

.Xr mdoc 7

macros indexed by

.Xr mandocdb 8 .

Line 248 Text production:

Line 199 Text production:

.El

.Sh ENVIRONMENT

.Bl -tag -width Ds

.It Ev MANPAGER

Default pager for manuals.

If this is unset, falls back to

.Ev Pager .

.It Ev PAGER

The second choice for a manual pager.

If this is unset, use

.Xr more 1 .

.It Ev MANPATH

Colon-separated paths modifying the default list of paths searched for

manual databases.

Line 276 If none of these conditions are met, it overrides the

Line 219 If none of these conditions are met, it overrides the

.El

.Sh FILES

.Bl -tag -width "/etc/man.conf" -compact

.It Pa whatis.db

.It Pa mandoc.db

name of the

.Xr mandocdb 8

keyword database

.It Pa whatis.index

name of the

.Xr mandocdb 8

filename database

.It Pa /etc/man.conf

default

.Xr man 1

Line 294 configuration file

Line 233 configuration file

.Sh EXAMPLES

Search for

.Qq mdoc

as a substring and regular expression

as a word or

within each manual name and description:

.Xr glob 7

expression:

.Pp

.Dl $ apropos mdoc

.Dl $ apropos ~^mdoc$

.Dl $ apropos any~mdoc*

.Pp

Include matches for

.Qq roff

and

.Qq man

for the regular expression case:

using

.Xr glob 7

expressions:

.Pp

.Dl $ apropos ~^mdoc$ roff man

.Dl $ apropos ~*mdoc* ~*roff*

.Dl $ apropos ~^mdoc$ \-o roff \-o man

.Pp

Search for

.Qq optind

and

.Qq optarg

as variable names in the library category:

as a variable name in the library category:

.Pp

.Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$

.Dl $ apropos \-s 3 Va=optarg

.Sh SEE ALSO

.Xr more 1

.Xr glob 7 ,

.Xr re_format 7 ,

.Xr mandocdb 8

.Sh AUTHORS

The

.Nm

utility was written by

.An Kristaps Dzonsons ,

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.Mt kristaps@bsd.lv .

CVSweb