mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/apropos.1 between version 1.47 and 1.49

version 1.47, 2018/02/23 18:54:02

version 1.49, 2018/11/22 12:33:52

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 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 339 function arguments appearing on

Line 322 function arguments appearing on

.Ic \&Fn

lines

.It Li \&Fn

fuction names marked up with

function names marked up with

.Ic \&Fo

macros

.It Li \&In

Line 407 Search for

Line 390 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 415 and

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

Line 448 The following two invocations are equivalent:

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