mandoc/whatis.1 - diff

Return to whatis.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/whatis.1 between version 1.7.2.2 and 1.9

version 1.7.2.2, 2013/10/05 01:25:20

version 1.9, 2012/03/25 00:48:47

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 23

.Sh SYNOPSIS

.Nm

.Op Fl C Ar file

.Op Fl M Ar path

.Op Fl M Ar manpath

.Op Fl m Ar path

.Op Fl m Ar manpath

.Op Fl S Ar arch

.Op Fl s Ar section

.Ar name ...

Line 36 utility searches databases generated by

for manuals containing the word

.Ar name

in their page name, ignoring case.

It returns the header lines from all matching pages.

You can then use the

.Xr man 1

command to get more information.

.Pp

By default,

.Nm

Line 47 searches for

Line 43 searches for

.Xr mandocdb 8

databases in the default paths stipulated by

.Xr man 1 .

If standard output is a TTY, a result may be selected from a list and

its manual displayed with the pager.

.Pp

The options are as follows:

.Bl -tag -width Ds

Line 56 Specify an alternative configuration

Line 54 Specify an alternative configuration

.Xr man.conf 5

format.

.It Fl M Ar path

.It Fl M Ar manpath

Use the colon-separated

.Ar path

.Ar manpath

instead of the default list of paths searched for

.Xr mandocdb 8

databases.

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

.It Fl m Ar path

.It Fl m Ar manpath

Prepend the colon-separated

.Ar path

.Ar manpath

to the list of paths searched for

.Xr mandocdb 8

databases.

Line 95 If an architecture is specified for the manual, it is

Line 93 If an architecture is specified for the manual, it is

.Pp

.D1 title(cat/arch) \- description

.Pp

Resulting manuals may be accessed as

If on a TTY, results are prefixed with a numeric identifier.

.Pp

.Dl $ man \-s sec title

.D1 [index] title(cat) \- description

.Pp

If an architecture is specified in the output, use

One may choose a manual be entering the index at the prompt.

Valid choices are displayed using

.Ev MANPAGER ,

or failing that ,

.Ev PAGER

or just

.Xr more 1 .

Source pages are formatted with

.Xr mandoc 1 ;

preformatted pages with

.Xr cat 1 .

.Pp

.Dl $ man \-s sec \-S arch title

.Pp

.Nm

is identical to running

.Xr apropos 1

Line 111 as follows:

Line 117 as follows:

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

.Sh ENVIRONMENT

.Bl -tag -width Ds

.It Ev MANPAGER

Default pager for manuals.

If this is unset, falls back to

.Ev Pager .

.It Ev PAGER

The second choice for a manual pager.

If this is unset, use

.Xr more 1 .

.It Ev MANPATH

Colon-separated paths modifying the default list of paths searched for

manual databases.

Line 131 If none of these conditions are met, it overrides the

Line 145 If none of these conditions are met, it overrides the

.El

.Sh FILES

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

.It Pa mandoc.db

.It Pa whatis.db

name of the

.Xr mandocdb 8

keyword database

.It Pa mandoc.index

.It Pa whatis.index

name of the

.Xr mandocdb 8

filename database

Line 168 wrote the original

Line 182 wrote the original

.Nm

in 1979.

The current version was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.An Kristaps Dzonsons ,

.Mt kristaps@bsd.lv .

CVSweb