mandoc/man.1 - diff

Return to man.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.1 between version 1.3 and 1.22

version 1.3, 2014/08/21 02:38:24

version 1.22, 2017/03/17 17:24:41

Line 1

.\" $Id$

.\" $OpenBSD$

.\"

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

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

Line 40

Line 39

.Nd display manual pages

.Sh SYNOPSIS

.Nm man

.Op Fl acfhkw

.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 Fl T Ar output

.Op Fl W Ar level

.Op Ar section

.Ar name ...

.Sh DESCRIPTION

Line 65 machine architecture

Line 69 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 91 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 h

Display only the

Display only the SYNOPSIS lines of the requested manual pages.

.Dq SYNOPSIS

Implies

lines of the requested manual pages.

.Fl a

and

.Fl c .

.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 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 104 an expression can be provided using the syntax describ

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

.Fl a .

The

.Ar name

arguments are interpreted as filenames.

No search is done and

.Ar file ,

.Ar path ,

.Ar section ,

and

.Ar subsection

are ignored.

This overrides any earlier

.Fl f ,

.Fl k ,

and

.Fl w

options.

.It Fl M Ar path

Override the list of standard directories which

.Nm

Line 115 must be a colon

Line 169 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 136 the directories specified using the

Line 184 the directories specified using the

option or the

.Ev MANPATH

environment variable.

The subdirectories to be searched, and their search order,

.It Fl O Ar option Ns = Ns Ar value

are specified by the

Comma-separated output options.

.Dq _subdir

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

line in the

.Xr mandoc 1

.Nm

manual.

configuration file.

.It Fl S Ar subsection

Restricts the directories that

.Nm

Line 158 architecture whilst using another.

Line 205 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 174 General commands

Line 217 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 187 File formats.

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

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

configuration file,

is silent.

.Xr man.conf 5 ,

See the

specifies the possible

.Xr mandoc 1

.Ar section

manual for details.

values, and their search order.

Additional sections may be specified.

.It Fl w

List the pathnames of the manual pages which

.Nm

Line 221 and

Line 285 and

combination.

.El

.Pp

The

.Nm

utility also supports the options

.Fl IOTW

described in the

.Xr mandoc 1

manual.

.Pp

Guidelines for writing

man pages can be found in

.Xr mdoc 7 .

Line 268 Any non-empty value of the environment variable

Line 324 Any non-empty value of the environment variable

.Ev MANPAGER

will be used instead of the standard pagination program,

.Xr more 1 .

.Xr less 1

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,

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 .

.It Ev MANPATH

The standard search path used by

.Nm

Line 278 variable.

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

are specified by the

.Dq _subdir

line in the

.Nm

configuration file.

.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

.Fl s

will be used.

.El

.Sh FILES

Line 322 utility is compliant with the

Line 392 utility is compliant with the

specification.

.Pp

The flags

.Op Fl aCcfhMmSsw ,

.Op Fl aCcfhIKlMmOSsTWw ,

as well as the environment variables

.Ev MACHINE ,

.Ev MANPAGER ,

Line 361 in

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