mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.16.2.4, 2014/03/17 09:52:42

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

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 18

Line 19

.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 path

.Op Fl m Ar path

.Op Fl O Ar outkey

.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

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

.Fl o .

.Nm whatis

maps terms only to case-sensitive manual names.

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

Line 70 for

Line 79 for

.Xr mandocdb 8

databases.

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

.It Fl O Ar outkey

Show the values associated with the key

.Ar outkey

instead of the manual descriptions.

.It Fl S Ar arch

Restrict the search to pages for the specified

.Xr machine 1

Line 109 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 146 is evaluated case-insensitively.

Line 165 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

Results are sorted by manual title, with output formatted as

.Nm whatis

considers an

.Ar expression

to consist of an opaque keyword.

.Pp

.D1 title(sec) \- description

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

.Pp

.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 182 Names and description:

Line 205 Names and description:

.Bl -column "xLix" description -offset indent -compact

.It Li \&Nm Ta manual name

.It Li \&Nd Ta one-line manual description

.It Li arch Ta machine architecture (case-insensitive)

.It Li sec Ta manual section number

.El

.Pp

Sections and cross references:

Line 270 standard search path.

Line 295 standard search path.

name of the

.Xr mandocdb 8

keyword database

.It Pa mandoc.index

name of the

.Xr mandocdb 8

filename database

.It Pa /etc/man.conf

default

.Xr man 1

Line 300 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

Line 314 with the argument

Line 335 with the argument

.Qq ssh :

.Pp

.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'

.Pp

The following two invocations are equivalent:

.Pp

.D1 Li $ apropos -S Ar arch Li -s Ar section expression

.Bd -ragged -offset indent

.Li $ apropos \e( Ar expression Li \e)

.Li -a arch~^( Ns Ar arch Ns Li |any)$

.Li -a sec~^ Ns Ar section Ns Li $

.Ed

.Sh SEE ALSO

.Xr man 1 ,

.Xr re_format 7 ,

Line 324 An

Line 354 An

utility first appeared in

.Bx 2 .

It was rewritten from scratch for

.Ox 5.1 .

.Ox 5.6 .

.Pp

The

.Fl M

Line 352 wrote the original

Line 382 wrote the original

.Nm

in February 1979.

The current version was written by

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

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

and

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

CVSweb