mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.179 and 1.181

version 1.179, 2017/03/18 19:51:19

version 1.181, 2017/03/21 18:25:51

Line 20

.Os

.Sh NAME

.Nm mandoc

.Nd format and display UNIX manuals

.Nd format manual pages

.Sh SYNOPSIS

.Nm mandoc

.Op Fl acfhkl

.Op Fl I Cm os Ns = Ns Ar name

.Op Fl K Ar encoding

.Op Fl m Ns Ar format

.Op Fl mdoc | man

.Op Fl O Ar option

.Op Fl T Ar output

.Op Fl W Ar level

Line 44 reads

.Xr mdoc 7

.Xr man 7

text from stdin, implying

text from stdin and produces

.Fl m Ns Cm andoc ,

and produces

.Fl T Cm locale

output.

.Pp

Line 84 Override the default operating system

Line 82 Override the default operating system

.Ar name

for the

.Xr mdoc 7

.Sq \&Os

.Ic \&Os

and for the

.Xr man 7

.Sq \&TH

.Ic \&TH

macro.

.It Fl K Ar encoding

Specify the input encoding.

Line 138 Also reverts any earlier

Line 136 Also reverts any earlier

and

.Fl k

options.

.It Fl m Ns Ar format

.It Fl mdoc | man

Input format.

With

See

.Fl mdoc ,

.Sx Input Formats

all input files are interpreted as

for available formats.

.Xr mdoc 7 .

Defaults to

With

.Fl m Ns Cm andoc .

.Fl man ,

all input files are interpreted as

.Xr man 7 .

By default, the input language is automatically detected for each file:

if the the first macro is

.Ic \&Dd

.Ic \&Dt ,

the

.Xr mdoc 7

parser is used; otherwise, the

.Xr man 7

parser is used.

With other arguments,

.Fl m

is silently ignored.

.It Fl O Ar option

Comma-separated output options.

.It Fl T Ar output

Line 209 also supports the options

Line 222 also supports the options

described in the

.Xr apropos 1

manual.

.Ss Input Formats

The

.Nm

utility accepts

.Xr mdoc 7

and

.Xr man 7

input with

.Fl m Ns Cm doc

and

.Fl m Ns Cm an ,

respectively.

The

.Xr mdoc 7

format is

.Em strongly

recommended;

.Xr man 7

should only be used for legacy manuals.

.Pp

A third option,

.Fl m Ns Cm andoc ,

which is also the default, determines encoding on-the-fly: if the first

non-comment macro is

.Sq \&Dd

.Sq \&Dt ,

the

.Xr mdoc 7

parser is used; otherwise, the

.Xr man 7

parser is used.

.Pp

If multiple

files are specified with

.Fl m Ns Cm andoc ,

each has its file-type determined this way.

If multiple files are

specified and

.Fl m Ns Cm doc

.Fl m Ns Cm an

is specified, then this format is used exclusively.

.Ss Output Formats

The

.Nm

Line 391 The string

Line 361 The string

for example,

.Ar ../src/%I.html ,

is used as a template for linked header files (usually via the

.Sq \&In

.Ic \&In

macro).

Instances of

.Sq \&%I

Line 404 The string

Line 374 The string

for example,

.Ar ../html%S/%N.%S.html ,

is used as a template for linked manuals (usually via the

.Sq \&Xr

.Ic \&Xr

macro).

Instances of

.Sq \&%N

Line 450 If the input format is

Line 420 If the input format is

.Xr man 7 ,

the input is copied to the output, expanding any

.Xr roff 7

.Sq so

.Ic so

requests.

The parser is also run, and as usual, the

.Fl W

CVSweb