mandoc/man.1 - diff

Return to man.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.1 between version 1.15 and 1.35

version 1.15, 2015/07/17 22:38:29

version 1.35, 2019/03/09 15:55:01

Line 3

.\"

.\" Redistribution and use in source and binary forms, with or without

.\" modification, are permitted provided that the following conditions

Line 41

.Nm man

.Op Fl acfhklw

.Op Fl C Ar file

.Op Fl I Cm os Ns = Ns Ar name

.Op Fl K Ar encoding

.Op Fl M Ar path

.Op Fl m Ar path

.Op Fl O Ar option Ns = Ns Ar value

.Op Fl S Ar subsection

.Op Fl s Ar section

.Op Oo Fl s Oc Ar section

.Op Fl T Ar output

.Op Fl W Ar level

.Op Ar section

.Ar name ...

.Sh DESCRIPTION

The

Line 69 machine architecture

Line 63 machine architecture

The options are as follows:

.Bl -tag -width Ds

.It Fl a

Display all of the manual pages for a specified

Display all matching manual pages.

.Ar section

Normally, only the first page found is displayed.

and

.Ar name

combination.

Normally, only the first manual page found is displayed.

.It Fl C Ar file

Use the specified

.Ar file

Line 88 Copy the manual page to the standard output instead of

Line 78 Copy the manual page to the standard output instead of

.Xr more 1

to paginate it.

This is done by default if the standard output is not a terminal device.

.Pp

When using

.Fl c ,

most terminal devices are unable to show the markup.

To print the output of

.Nm

to the terminal with markup but without using a pager, pipe it to

.Xr ul 1 .

To remove the markup, pipe the output to

.Xr col 1

.Fl b

instead.

.It Fl f

A synonym for

.Xr whatis 1 .

Line 95 It searches for

Line 97 It searches for

.Ar name

in manual page names and displays the header lines from all matching pages.

The search is case insensitive and matches whole words only.

This overrides any earlier

.Fl k

and

.Fl l

options.

.It Fl I Cm os Ns = Ns Ar name

Override the default operating system

.Ar name

for the

.Xr mdoc 7

.Ic \&Os

and for the

.Xr man 7

.Ic \&TH

macro.

.It Fl h

Display only the SYNOPSIS lines of the requested manual pages.

Implies

.Fl a

and

.Fl c .

.It Fl K Ar encoding

Specify the input encoding.

The supported

.Ar encoding

arguments are

.Cm us-ascii ,

.Cm iso-8859-1 ,

and

.Cm utf-8 .

By default, the encoding is automatically detected as described in the

.Xr mandoc 1

manual.

.It Fl k

A synonym for

.Xr apropos 1 .

Line 137 an expression can be provided using the syntax describ

Line 112 an expression can be provided using the syntax describ

.Xr apropos 1

manual.

By default, it displays the header lines of all matching pages.

This overrides any earlier

.Fl f

and

.Fl l

options.

.It Fl l

A synonym for

.Xr mandoc 1

.Xr mandoc 1 .

.Fl a .

The

.Ar name

arguments are interpreted as filenames.

Line 153 No search is done and

Line 122 No search is done and

.Ar file ,

.Ar path ,

.Ar section ,

.Ar subsection ,

and

.Ar subsection

are ignored.

This overrides any earlier

.Fl f ,

.Fl k ,

and

.Fl w

options.

are ignored.

This option implies

.Fl a .

.It Fl M Ar path

Override the list of standard directories which

.Nm

Line 173 must be a colon

Line 139 must be a colon

separated list of directories.

This search path may also be set using the environment variable

.Ev MANPATH .

The subdirectories to be searched, and their search order,

are specified by the

.Dq _subdir

line in the

.Nm

configuration file.

.It Fl m Ar path

Augment the list of standard directories which

.Nm

Line 194 the directories specified using the

Line 154 the directories specified using the

option or the

.Ev MANPATH

environment variable.

The subdirectories to be searched, and their search order,

are specified by the

.Dq _subdir

line in the

.Nm

configuration file.

.It Fl O Ar option Ns = Ns Ar value

Comma-separated output options.

For each output format, the available options are described in the

.Xr mandoc 1

manual.

.It Fl S Ar subsection

Restricts the directories that

Only show pages for the specified

.Nm

will search to those of a specific

.Xr machine 1

architecture.

.Ar subsection

Line 221 architecture whilst using another.

Line 168 architecture whilst using another.

This option overrides the

.Ev MACHINE

environment variable.

.It Xo

.It Oo Fl s Oc Ar section

.Op Fl s

Only select manuals from the specified

.Ar section

.Ar section .

.Xc

Restricts the directories that

.Nm

will search to a specific section.

The currently available sections are:

.Pp

.Bl -tag -width "localXXX" -offset indent -compact

Line 237 General commands

Line 180 General commands

.It 2

System calls and error numbers.

.It 3

Libraries.

Library functions.

.It 3f

Fortran programmer's reference guide.

.It 3p

.Xr perl 1

programmer's reference guide.

Line 250 File formats.

Line 191 File formats.

.It 6

Games.

.It 7

Miscellaneous.

Miscellaneous information.

.It 8

System maintenance and operation commands.

.It 9

Kernel internals.

.It X11

An alias for X11R6.

.It X11R6

X Window System.

.It local

Pages located in

.Pa /usr/local .

.It n

Tcl/Tk commands.

.El

.Pp

The

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

.Nm

the first match is selected from the following list:

configuration file,

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

.Xr man.conf 5 ,

specifies the possible

.Ar section

values, and their search order.

Additional sections may be specified.

.It Fl T Ar output

Select the output format.

The default is

.Cm locale .

The other output modes

.Cm ascii ,

.Cm html ,

.Cm lint ,

.Cm man ,

.Cm pdf ,

.Cm ps ,

.Cm tree ,

and

.Cm utf8

are described in the

.Xr mandoc 1

manual.

.It Fl W Ar level

Specify the minimum message

.Ar level

to be reported on the standard error output and to affect the exit status.

The

.Ar level

can be

.Cm warning ,

.Cm error ,

.Cm unsupp ;

.Cm all

is an alias for

.Cm warning .

By default,

.Nm

is silent.

See the

.Xr mandoc 1

manual for details.

.It Fl w

List the pathnames of the manual pages which

List the pathnames of all matching manual pages instead of displaying

.Nm

any of them.

would display for the specified

.Ar section

and

.Ar name

combination.

.El

.Pp

The options

.Fl IKOTW

are also supported and are documented in

.Xr mandoc 1 .

The options

.Fl fkl

are mutually exclusive and override each other.

.Pp

Guidelines for writing

man pages can be found in

.Xr mdoc 7 .

.Pp

The

.Xr mandoc.db 5

database is used for looking up manual page entries.

In cases where the database is absent, outdated, or corrupt,

.Nm

falls back to looking for files called

.Ar name . Ns Ar section .

If both a formatted and an unformatted version of the same manual page,

for example

.Pa cat1/foo.0

and

.Pa man1/foo.1 ,

exist in the same directory, and at least one of them is selected,

exist in the same directory, only the unformatted version is used.

only the newer one is used.

The database is kept up to date with

However, if both the

.Xr makewhatis 8 ,

.Fl a

which is run by the

and the

.Xr weekly 8

.Fl w

maintenance script.

options are specified, both file names are printed.

.Sh ENVIRONMENT

.Bl -tag -width MANPATHX

.It Ev MACHINE

Line 358 is case insensitive.

Line 257 is case insensitive.

.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 less 1

Line 366 is used, the interactive

Line 265 is used, the interactive

.Ic :t

command can be used to go to the definitions of various terms, for

example command line options, command modifiers, internal commands,

and environment variables.

environment variables, function names, preprocessor macros,

.Xr errno 2

values, and some other emphasized words.

Some terms may have defining text at more than one place.

In that case, the

.Xr less 1

interactive commands

.Ic t

and

.Ic T

can be used to move to the next and to the previous place providing

information about the term last searched for with

.Ic :t .

The

.Fl O Cm tag Ns Op = Ns Ar term

option documented in the

.Xr mandoc 1

manual opens a manual page at the definition of a specific

.Ar term

rather than at the beginning.

.It Ev MANPATH

The standard search path used by

.Nm

may be overridden by specifying a path in the

may be changed by specifying a path in the

.Ev MANPATH

environment

environment variable.

variable.

The format of the path is a colon

.Pq Ql \&:

separated list of directories.

The subdirectories to be searched, as well as their search order,

Invalid paths are ignored.

are specified by the

Overridden by

.Dq _subdir

.Fl M ,

line in the

ignored if

.Nm

.Fl l

configuration file.

is specified.

.Pp

.Ev MANPATH

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

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

Line 390 is not defined.

Line 316 is not defined.

If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Fl s

will be used.

is used.

.El

.Sh FILES

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

Line 399 default man configuration file

Line 325 default man configuration file

.El

.Sh EXIT STATUS

.Ex -std man

See

.Xr mandoc 1

for details.

.Sh EXAMPLES

Format a page for pasting extracts into an email message \(em

avoid printing any UTF-8 characters, reduce the width to ease

quoting in replies, and remove markup:

.Pp

.Dl $ man -T ascii -O width=65 pledge | col -b

.Pp

Read a typeset page in a PDF viewer:

.Pp

.Dl $ MANPAGER=mupdf man -T pdf lpd

.Sh SEE ALSO

.Xr apropos 1 ,

.Xr intro 1 ,

.Xr col 1 ,

.Xr whatis 1 ,

.Xr mandoc 1 ,

.Xr ul 1 ,

.Xr whereis 1 ,

.Xr intro 2 ,

.Xr intro 3 ,

.Xr intro 4 ,

.Xr intro 5 ,

.Xr man.conf 5 ,

.Xr intro 6 ,

.Xr mdoc 7

.Xr intro 7 ,

.Xr mdoc 7 ,

.Xr intro 8 ,

.Xr intro 9

.Sh STANDARDS

The

.Nm

Line 461 in

Line 393 in

.Fl C

.Nx 1.0 ;

and

.Fl s

and

.Fl S

.Ox 2.3 .

.Ox 2.3 ;

and

.Fl I ,

.Fl K ,

.Fl l ,

.Fl O ,

and

.Fl W

.Ox 5.7 .

The

.Fl T

option first appeared in

.At III

and was also added in

.Ox 5.7 .

CVSweb