src/usr.bin/mandoc/man.1 - diff

Return to man.1 CVS log

Up to [local] / src / usr.bin / mandoc

Diff for /src/usr.bin/mandoc/man.1 between version 1.33 and 1.34

version 1.33, 2019/03/09 15:54:46

version 1.34, 2020/01/07 11:15:12

Line 51

.Nm

utility

displays the

manual pages entitled

manual page entitled

.Ar name .

Pages may be selected according to

a specific category

Line 64

.Bl -tag -width Ds

.It Fl a

Display all matching manual pages.

Normally, only the first page found is displayed.

.It Fl C Ar file

Use the specified

.Ar file

Line 129

Line 128

This option implies

.Fl a .

.It Fl M Ar path

Override the list of standard directories which

Override the list of directories to search for manual pages.

.Nm

searches for manual pages.

The supplied

.Ar path

must be a colon

.Pq Ql \&:

separated list of directories.

This search path may also be set using the environment variable

This option also overrides the environment variable

.Ev MANPATH .

.Ev MANPATH

and any directories specified in the

.Xr man.conf 5

file.

.It Fl m Ar path

Augment the list of standard directories which

Augment the list of directories to search for manual pages.

.Nm

searches for manual pages.

The supplied

.Ar path

must be a colon

.Pq Ql \&:

separated list of directories.

These directories will be searched before the standard directories or

These directories will be searched before those specified using the

the directories specified using the

.Fl M

option or the

option, the

.Ev MANPATH

environment variable.

environment variable, the

.Xr man.conf 5

file, or the default directories.

.It Fl S Ar subsection

Only show pages for the specified

.Xr machine 1

Line 197

Line 196

.It 9

Kernel internals.

.El

.Pp

If not specified and a match is found in more than one section,

the first match is selected from the following list:

1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.

.It Fl w

List the pathnames of all matching manual pages instead of displaying

any of them.

Line 214

Line 209

.Fl fkl

are mutually exclusive and override each other.

.Pp

Guidelines for writing

The search starts with the

man pages can be found in

.Fl m

.Xr mdoc 7 .

argument if provided, then continues with the

.Fl M

argument, the

.Ev MANPATH

variable, the

.Ic manpath

entries in the

.Xr man.conf 5

file, or with

.Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man

by default.

Within each of these, directories are searched in the order provided.

Within each directory, the search proceeds according to the following

list of sections: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.

The first match found is shown.

.Pp

The

.Xr mandoc.db 5

Line 236

Line 245

which is run by the

.Xr weekly 8

maintenance script.

.Pp

Guidelines for writing

man pages can be found in

.Xr mdoc 7 .

.Sh ENVIRONMENT

.Bl -tag -width MANPATHX

.It Ev MACHINE

Line 286

Line 299

.Ar term

rather than at the beginning.

.It Ev MANPATH

The standard search path used by

Override the standard search path which is either specified in

.Nm

.Xr man.conf 5

may be changed by specifying a path in the

or the default path.

The format of

.Ev MANPATH

environment variable.

is a colon

The format of the path is a colon

.Pq Ql \&:

separated list of directories.

Invalid paths are ignored.

Invalid directories are ignored.

Overridden by

.Fl M ,

ignored if

Line 303

Line 316

.Pp

.Ev MANPATH

begins with a colon, it is appended to the default list;

begins with a colon, it is appended to the standard path;

if it ends with a colon, it is prepended to the default list;

if it ends with a colon, it is prepended to the standard path;

or if it contains two adjacent colons,

the standard search path is inserted between the colons.

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

Line 321

Line 332

.Sh FILES

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

.It Pa /etc/man.conf

default man configuration file

default

.Nm

configuration file

.El

.Sh EXIT STATUS

.Ex -std man