mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.45, 2017/03/27 18:51:36

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

Line 74 would.

Line 73 would.

If the standard output is a terminal device and

.Fl c

is not specified, use

.Xr more 1

.Xr less 1

to paginate them.

.Fl a

Line 93 format.

Line 92 format.

Search for all words in

.Ar expression

in manual page names only.

The search is case insensitive and matches whole words 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

Line 123 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 199 Operator

Line 198 Operator

.Cm =

evaluates a substring, while

.Cm \(ti

evaluates a regular expression.

evaluates a case-sensitive extended regular expression.

.It Fl i Ar term

.Ar term

Line 208 is evaluated case-insensitively.

Line 207 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

Results are sorted according to the following criteria:

Results are sorted first according to the section number in ascending

.Bl -enum

numerical order, then by the page name in ascending

.It

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

Each output line is formatted as

.Pp

Line 328 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 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 ;

.Xr less 1 ;

see

.Xr man 1

for details.

Line 357 Specifies the pagination program to use when

Line 363 Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Xr less 1

.Fl s

is used.

Only used if

.Fl a

Line 384 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 392 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 \(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 407 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

Line 425 The following two invocations are equivalent:

Line 434 The following two invocations are equivalent:

.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

CVSweb