mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.10 and 1.15

version 1.10, 2011/11/29 00:41:33

version 1.15, 2011/12/25 16:53:51

Line 22

.Nd search manual page databases

.Sh SYNOPSIS

.Nm

.Op Fl C Ar file

.Op Fl M Ar manpath

.Op Fl m Ar manpath

.Op Fl S Ar arch

.Op Fl s Ar section

.Ar expression...

.Ar expression ...

.Sh DESCRIPTION

The

.Nm

Line 37 evaluating on

Line 38 evaluating on

for each file in each database.

Its arguments are as follows:

.Bl -tag -width Ds

.It Fl C Ar file

Specify an alternative configuration

.Ar file

.Xr man.conf 5

format.

.It Fl M Ar manpath

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

searched for

Line 112 evaluates a substring, while

Line 119 evaluates a substring, while

.Li \&~

evaluates a regular expression.

.It Fl i Ar term

Same as

.Ar term ,

but

.Ar term

is a regular expression, it

is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

By default,

Line 125 searches for

Line 132 searches for

.Xr mandocdb 8

databases in the default paths stipulated by

.Xr man 1 ,

parses terms as case-insensitive regular expressions

parses terms as case-sensitive regular expressions

.Pq the Li \&~ operator

over manual names and descriptions

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

Line 232 Text production:

Line 239 Text production:

.Sh ENVIRONMENT

.Bl -tag -width Ds

.It Ev MANPATH

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

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

manual databases.

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

Overridden by

.Fl M .

.Ev MANPATH

begins with a

.Sq \&: ,

it is appended to the default list;

else if it ends with

.Sq \&: ,

it is prepended to the default list; else if it contains

.Sq \&:: ,

the default list is inserted between the colons.

If none of these conditions are met, it overrides the default list.

.El

.\" .Sh FILES

.Sh FILES

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

.It Pa whatis.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

configuration file

.El

.Sh EXIT STATUS

.Ex -std

.Sh EXAMPLES

Search for

.Qq mdoc

within the manual name and description:

as a substring and regular expression

within each manual name and description:

.Pp

.Dl $ apropos mdoc

.Dl $ apropos ~^mdoc$

.Pp

Two variants of searching for

Include matches for

.Qq mdoc ,

.Qq roff

.Qq roff ,

and

.Qq man

within manual names and descriptions:

for the regular expression case:

.Pp

.Dl $ apropos mdoc roff man

.Dl $ apropos ~^mdoc$ roff man

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

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

.Pp

Search for

.Qq optind

Line 264 and

Line 297 and

.Qq optarg

as variable names in the library category:

.Pp

.Dl $ apropos \-s 3 \(dqVa~^optind$\(dq -a \(dqVa~^optarg$\(dq

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

.Pp

Search for all manuals referencing

.Qq POSIX

in any letter case:

.Pp

.Dl $ apropos \-\- \-i posix

.Sh SEE ALSO

.Xr man 1 ,

.Xr mandoc 1 ,

.Xr re_format 7 ,

.Xr re_format 7

.Xr mandocdb 8

.Sh AUTHORS

The

.Nm

CVSweb