mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.28 and 1.51

version 1.28, 2014/04/18 10:30:37

version 1.51, 2020/10/01 22:50:00

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 afk

.Op Fl C Ar file

.Op Fl M Ar path

.Op Fl m Ar path

Line 41 utilities query manual page databases generated by

Line 42 utilities query manual page databases generated by

evaluating

.Ar expression

for each file in each database.

By default, it displays the names, section numbers, and description lines

By default, they display the names, section numbers, and description lines

of all matching manuals.

.Pp

By default,

Line 50 searches for

Line 51 searches for

.Xr makewhatis 8

databases in the default paths stipulated by

.Xr man 1

and uses case-insensitive substring matching

and uses case-insensitive extended regular expression matching

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

.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 less 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 88 Restrict the search to pages for the specified

Line 122 Restrict the search to pages for the specified

.Xr machine 1

architecture.

.Ar arch

is case insensitive.

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.

Line 98 See

Line 132 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 180 This has syntax

.Sm off

.Oo

.Op Ar key Op , Ar key ...

.Pq Cm = | ~

.Pq Cm = | \(ti

.Oc

.Ar val

.Ar val ,

.Sm on ,

.Sm on

where

.Ar key

is an

Line 155 for a list of available keys.

Line 197 for a list of available keys.

Operator

.Cm =

evaluates a substring, while

.Cm ~

.Cm \(ti

evaluates a regular expression.

evaluates a case-sensitive extended regular expression.

.It Fl i Ar term

.Ar term

Line 165 is evaluated case-insensitively.

Line 207 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

.Nm whatis

Results are sorted first according to the section number in ascending

considers an

numerical order, then by the page name in ascending

.Ar expression

.Xr ascii 7

to consist of an opaque keyword.

alphabetical order, case-insensitive.

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

Line 311 Text production:

.It Li \&Ox Ta Ox No version reference

.It Li \&Dx Ta Dx No version reference

.El

.Pp

In general, macro keys are supposed to yield complete results without

expecting the user to consider actual macro usage.

For example, results include:

.Pp

.Bl -tag -width 3n -offset 3n -compact

.It Li \&Fa

function arguments appearing on

.Ic \&Fn

lines

.It Li \&Fn

function names marked up with

.Ic \&Fo

macros

.It Li \&In

include file names marked up with

.Ic \&Fd

macros

.It Li \&Vt

types appearing as function return types and

.It \&

types appearing in function arguments in the SYNOPSIS

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

is used.

Only used if

.Fl a

.Fl l

is specified.

.El

.Sh FILES

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

Line 307 Search for

Line 389 Search for

.Qq .cf

as a substring of manual names and descriptions:

.Pp

.Dl $ apropos .cf

.Dl $ apropos =.cf

.Pp

Include matches for

.Qq .cnf

Line 315 and

Line 397 and

.Qq .conf

as well:

.Pp

.Dl $ apropos .cf .cnf .conf

.Dl $ apropos =.cf =.cnf =.conf

.Pp

Search in names and descriptions using a regular expression:

Search in names and descriptions using a case-sensitive regular expression:

.Pp

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

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

.Pp

Search for all manual pages in a given section:

.Pp

.Dl $ apropos \-s 9 \&.

.Pp

Search for manuals in the library section mentioning both the

.Qq optind

and the

Line 330 variables:

Line 416 variables:

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

.Pp

Do exactly the same as calling

.Xr whatis 1

.Nm whatis

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 ,

.Xr re_format 7 ,

.Xr makewhatis 8

.Sh STANDARDS

The

.Nm

utility is compliant with the

.St -p1003.1-2008

specification of

.Xr man 1

.Fl k .

.Pp

All options, the

.Nm whatis

command, support for logical operators, macro keys,

substring matching, sorting of results, the environment variables

.Ev MANPAGER

and

.Ev MANPATH ,

the database format, and the configuration file

are extensions to that specification.

.Sh HISTORY

Part of the functionality of

.Nm whatis

was already provided by the former

.Nm manwhere

utility in

.Bx 1 .

The

.Nm

utility first appeared in

and

.Nm whatis

utilities first appeared in

.Bx 2 .

It was rewritten from scratch for

They were rewritten from scratch for

.Ox 5.6 .

.Pp

The

Line 373 and

Line 485 and

and

.Fl s

.Ox 4.5 .

.Ox 4.5

for

.Nm

and in

.Ox 5.6

for

.Nm whatis .

The options

.Fl acfhIKklOTWw

appeared in

.Ox 5.7 .

.Sh AUTHORS

.An -nosplit

.An Bill Joy

wrote the original

wrote

.Nm manwhere

in 1977 and the original

.Bx

.Nm

and

.Nm whatis

in February 1979.

The current version was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

CVSweb