mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.18 and 1.19

version 1.18, 2012/06/08 10:44:52

version 1.19, 2012/06/09 14:11:15

Line 18

.Dt APROPOS 1

.Os

.Sh NAME

.Nm apropos

.Nm apropos ,

.Nm whatis

.Nd search manual page databases

.Sh SYNOPSIS

.Nm

Line 30

Line 31

.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 44 searches for

Line 47 searches for

databases in the default paths stipulated by

.Xr man 1

and

parses terms as case-sensitive words

maps terms to case-sensitive manual names and descriptions.

over manual names and descriptions.

Multiple terms are OR'd.

.Nm whatis

maps terms only to case-sensitive manual names.

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

Line 77 See

Line 81 See

for a listing of manual sections.

.El

.Pp

.Nm whatis

considers an

.Ar expression

consists of type and keyword pairs.

to consist of an opaque keyword.

.Nm apropos

parses a

.Ar expression

into type and keyword pairs.

This pair syntax

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

where operand

Line 113 is the manual's short description.

Line 122 is the manual's short description.

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

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

.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 209 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 mandocdb.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

CVSweb