mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.30 and 1.44

version 1.30, 2014/08/21 01:52:59

version 1.44, 2017/03/27 14:40:39

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 24

.Nd search manual page databases

.Sh SYNOPSIS

.Nm

.Op Fl acfhklw

.Op Fl C Ar file

.Op Fl M Ar path

.Op Fl m Ar path

Line 56 over manual names and descriptions

Line 57 over manual names and descriptions

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

Multiple terms imply pairwise

.Fl o .

.Pp

.Nm whatis

maps terms only to case-sensitive manual names.

is a synonym for

.Nm

.Fl f .

.Pp

Its arguments are as follows:

The options are as follows:

.Bl -tag -width Ds

.It Fl a

Instead of showing only the title lines, show the complete manual pages,

just like

.Xr man 1

.Fl a

would.

If the standard output is a terminal device and

.Fl c

is not specified, use

.Xr more 1

to paginate them.

.Fl a

mode, the options

.Fl IKOTW

described in the

.Xr mandoc 1

manual are also available.

.It Fl C Ar file

Specify an alternative configuration

.Ar file

.Xr man.conf 5

format.

.It Fl f

Search for all words in

.Ar expression

in manual page names only.

The search is case insensitive and matches whole words only.

In this mode, macro keys, comparison operators, and logical operators

are not available.

.It Fl k

Support the full

.Ar expression

syntax.

It is the default for

.Nm .

.It Fl M Ar path

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

searched for

Line 98 See

Line 133 See

for a listing of sections.

.El

.Pp

The options

.Fl chlw

are also supported and are documented in

.Xr man 1 .

The options

.Fl fkl

are mutually exclusive and override each other.

.Pp

.Ar expression

consists of search terms joined by logical operators

Line 138 This has syntax

Line 181 This has syntax

.Sm off

.Oo

.Op Ar key Op , Ar key ...

.Pq Cm = | ~

.Pq Cm = | \(ti

.Oc

.Ar val ,

.Sm on

Line 155 for a list of available keys.

Line 198 for a list of available keys.

Operator

.Cm =

evaluates a substring, while

.Cm ~

.Cm \(ti

evaluates a regular expression.

.It Fl i Ar term

Line 165 is evaluated case-insensitively.

Line 208 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

.Nm whatis

Results are sorted according to the following criteria:

considers an

.Bl -enum

.Ar expression

.It

to consist of an opaque keyword.

The manpath directory tree the page is found in, according to the

order specified with

.Fl M ,

.Fl m ,

the

.Ev MANPATH

environment variable, the

.Xr man.conf 5

configuration file, or the default documented in

.Xr man.conf 5 .

.It

The section number in ascending numerical order.

.It

The page name in ascending

.Xr ascii 7

alphabetical order, case-insensitive.

.El

.Pp

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

Each output line is formatted as

.Pp

.D1 name[, name...](sec) \- description

.Pp

Line 270 Text production:

Line 329 Text production:

.It Li \&Dx Ta Dx No version reference

.El

.Sh ENVIRONMENT

.Bl -tag -width MANPATH

.Bl -tag -width MANPAGER

.It Ev MANPAGER

Any non-empty value of the environment variable

.Ev MANPAGER

is used instead of the standard pagination program,

.Xr more 1 ;

see

.Xr man 1

for details.

Only used if

.Fl a

.Fl l

is specified.

.It Ev MANPATH

The standard search path used by

A colon-separated list of directories to search for manual pages; see

.Xr man 1

may be changed by specifying a path in the

for details.

.Ev MANPATH

environment variable.

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

Overridden by

.Fl M .

.Fl M ,

ignored if

.Ev MANPATH

.Fl l

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

is specified.

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

.It Ev PAGER

or if it contains two adjacent colons,

Specifies the pagination program to use when

the standard search path is inserted between the colons.

.Ev MANPAGER

If none of these conditions are met, it overrides the

is not defined.

standard search path.

If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Fl s

is used.

Only used if

.Fl a

.Fl l

is specified.

.El

.Sh FILES

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

Line 319 as well:

Line 396 as well:

.Pp

Search in names and descriptions using a regular expression:

.Pp

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

.Dl $ apropos \(aq\(tiset.?[ug]id\(aq

.Pp

Search for manuals in the library section mentioning both the

.Qq optind

Line 334 Do exactly the same as calling

Line 411 Do exactly the same as calling

with the argument

.Qq ssh :

.Pp

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

.Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq

.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 arch\(ti^( Ns Ar arch Ns Li |any)$

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

.Li -a sec\(ti^ Ns Ar section Ns Li $

.Ed

.Sh SEE ALSO

.Xr man 1 ,

Line 388 and in

Line 465 and in

.Ox 5.6

for

.Nm whatis .

The options

.Fl acfhIKklOTWw

appeared in

.Ox 5.7 .

.Sh AUTHORS

.An -nosplit

.An Bill Joy

CVSweb