mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.14, 2011/12/24 22:37:16

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

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 36 utility queries manual page databases generated by

evaluating on

.Ar expression

for each file in each database.

.Pp

By default,

.Nm

searches for

.Xr mandocdb 8

databases in the default paths stipulated by

.Xr man 1 ,

parses terms as case-sensitive regular expressions

over manual names and descriptions.

Multiple terms imply pairwise

.Fl o .

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

its manual displayed with the pager.

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

.It Fl C Ar file

Line 126 is evaluated case-insensitively.

Line 140 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

By default,

.Nm

searches for

.Xr mandocdb 8

databases in the default paths stipulated by

.Xr man 1 ,

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 .

Multiple terms imply pairwise

.Fl o .

Results are sorted by manual title, with output formatted as

.Pp

.D1 title(sec) \- description

Line 154 If an architecture is specified for the manual, it is

Line 156 If an architecture is specified for the manual, it is

.Pp

.D1 title(cat/arch) \- description

.Pp

Resulting manuals may be accessed as

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

.Pp

.Dl $ man \-s sec title

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

.Pp

If an architecture is specified in the output, use

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

.Pp

Valid choices are displayed using

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

.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

.Xr mdoc 7

Line 238 Text production:

Line 248 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 258 If none of these conditions are met, it overrides the

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

.El

.Sh FILES

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

.It Pa mandoc.db

.It Pa whatis.db

name of the

.Xr mandocdb 8

keyword database

.It Pa mandoc.index

.It Pa whatis.index

name of the

.Xr mandocdb 8

filename database

Line 299 as variable names in the library category:

Line 317 as variable names in the library category:

.Pp

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

.Sh SEE ALSO

.Xr man 1 ,

.Xr more 1

.Xr re_format 7 ,

.Xr mandocdb 8

.Sh AUTHORS

CVSweb