mandoc/apropos.1 - diff

Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.37, 2015/02/16 16:23:54

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

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 afk

.Op Fl C Ar file

.Op Fl M Ar path

.Op Fl m Ar path

Line 89 Specify an alternative configuration

.Xr man.conf 5

format.

.It Fl c

.Fl a

mode, copy the formatted manual pages to the standard output without using

.Xr more 1

to paginate them.

.It Fl f

Search for all words in

.Ar expression

Line 102 in manual page names only.

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

This overrides any earlier

.Fl k

and

.Fl l

options.

.It Fl h

Instead of showing the title lines, show the SYNOPSIS sections, just like

.Xr man 1

.Fl h

would.

.It Fl k

Support the full

.Ar expression

syntax.

This overrides any earlier

.Fl f

and

.Fl l

options.

It is the default for

.Nm .

.It Fl l

An alias for

.Xr mandoc 1

.Fl a .

This overrides any earlier

.Fl f ,

.Fl k ,

and

.Fl w

options.

.It Fl M Ar path

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

searched for

Line 162 By default, pages from all sections are shown.

Line 131 By default, pages from all sections are shown.

See

.Xr man 1

for a listing of sections.

.It Fl w

Instead of showing title lines, show the pathnames of the matching

manual pages, just like

.Xr man 1

.Fl w

would.

.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 210 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 227 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 237 is evaluated case-insensitively.

Line 208 is evaluated case-insensitively.

Has no effect on substring terms.

.El

.Pp

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

Results are sorted according to the following criteria:

.Bl -enum

.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

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

.Pp

Where

Line 336 Text production:

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

fuction 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

will be used instead of the standard pagination program,

is used instead of the standard pagination program,

.Xr more 1 .

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

or if it contains two adjacent colons,

the standard search path is inserted between the colons.

If none of these conditions are met, it overrides the

standard search path.

.It Ev PAGER

Specifies the pagination program to use when

.Ev MANPAGER

is not defined.

If neither PAGER nor MANPAGER is defined,

.Pa /usr/bin/more Fl s

.Xr more 1

will be used.

.Fl s

is used.

Only used if

.Fl a

.Fl l

is specified.

.El

.Sh FILES

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

Line 398 as well:

Line 419 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 409 variables:

Line 430 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 ,

Line 467 and in

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