mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

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

version 1.23, 2014/03/17 09:43:56

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

.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

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

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

.Nm whatis

maps terms only to case-sensitive manual names.

.Pp

Its arguments are as follows:

.Bl -tag -width Ds

.It Fl C Ar file

Line 44 Specify an alternative configuration

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

databases.

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

.It Fl S Ar arch

Search only for a particular architecture.

Restrict the search to pages for the specified

.It Fl s Ar cat

.Xr machine 1

Search only for a manual section.

architecture.

.Ar arch

is case insensitive.

By default, pages for all architectures are shown.

.It Fl s Ar section

Restrict the search to the specified section of the manual.

By default, pages from all sections are shown.

See

.Xr man 1

for a listing of manual sections.

for a listing of sections.

.El

.Pp

Line 126 is evaluated case-insensitively.

Line 151 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

By default,

.Nm whatis

.Nm

considers an

searches for

.Ar expression

.Xr mandocdb 8

to consist of an opaque keyword.

databases in the default paths stipulated by

.Pp

.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 237 Text production:

Line 255 Text production:

.It Li \&Dx Ta Dx No version reference

.El

.Sh ENVIRONMENT

.Bl -tag -width Ds

.Bl -tag -width MANPATH

.It Ev MANPATH

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

The standard search path used by

manual databases.

.Xr man 1

may be changed by specifying a path in the

.Ev MANPATH

environment variable.

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

Overridden by

.Fl M .

.Ev MANPATH

begins with a

begins with a colon, it is appended to the default list;

.Sq \&: ,

if it ends with a colon, it is prepended to the default list;

it is appended to the default list;

or if it contains two adjacent colons,

else if it ends with

the standard search path is inserted between the colons.

.Sq \&: ,

If none of these conditions are met, it overrides the

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

standard search path.

.Sq \&:: ,

the default list is inserted between the colons.

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

.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 275 configuration file

Line 289 configuration file

.Ex -std

.Sh EXAMPLES

Search for

.Qq mdoc

.Qq .cf

as a substring and regular expression

as a substring of manual names and descriptions:

within each manual name and description:

.Pp

.Dl $ apropos mdoc

.Dl $ apropos .cf

.Dl $ apropos ~^mdoc$

.Pp

Include matches for

.Qq roff

.Qq .cnf

and

.Qq man

.Qq .conf

for the regular expression case:

as well:

.Pp

.Dl $ apropos ~^mdoc$ roff man

.Dl $ apropos .cf .cnf .conf

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

.Pp

Search for

Search in names and descriptions using a regular expression:

.Pp

.Dl $ apropos '~set.?[ug]id'

.Pp

Search for manuals in the library category mentioning both the

.Qq optind

and

and the

.Qq optarg

as variable names in the library category:

variables:

.Pp

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

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

.Pp

Do exactly the same as calling

.Xr whatis 1

with the argument

.Qq ssh :

.Pp

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

.Sh SEE ALSO

.Xr man 1 ,

.Xr re_format 7 ,

.Xr mandocdb 8

.Sh AUTHORS

.Sh HISTORY

.Nm

utility first appeared in

.Bx 2 .

It was rewritten from scratch for

.Ox 5.1 .

.Pp

The

.Fl M

option and the

.Ev MANPATH

variable first appeared in

.Bx 4.3 ;

.Fl m

.Bx 4.3 Reno ;

.Fl C

.Bx 4.4 Lite1 ;

and

.Fl S

and

.Fl s

.Ox 4.5 .

.Sh AUTHORS

.An -nosplit

.An Bill Joy

wrote the original

.Bx

.Nm

utility was written by

in February 1979.

.An Kristaps Dzonsons ,

The current version was written by

.Mt kristaps@bsd.lv .

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

CVSweb