mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.172 and 1.184

version 1.172, 2017/01/28 23:30:08

version 1.184, 2017/03/27 18:51:36

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 ac

.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 O Ar options

.Op Fl T Ar output

.Op Fl W Ar level

.Op Ar

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 67 to paginate them.

Line 65 to paginate them.

This is the default.

It can be specified to override

.Fl a .

.It Fl f

A synonym for

.Xr whatis 1 .

This overrides any earlier

.Fl k

and

.Fl l

options.

.It Fl h

Display only the SYNOPSIS lines.

Implies

.Fl c .

.It Fl I Cm os Ns = Ns Ar name

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 98 arguments are

Line 84 arguments are

.Cm iso-8859-1 ,

and

.Cm utf-8 .

If not specified, autodetection uses the first match:

If not specified, autodetection uses the first match in the following

.Bl -tag -width iso-8859-1

list:

.It Cm utf-8

.Bl -enum

if the first three bytes of the input file

.It

are the UTF-8 byte order mark (BOM, 0xefbbbf)

If the first three bytes of the input file are the UTF-8 byte order

.It Ar encoding

mark (BOM, 0xefbbbf), input is interpreted as

if the first or second line of the input file matches the

.Cm utf-8 .

.It

If the first or second line of the input file matches the

.Sy emacs

mode line format

.Pp

.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-

.It Cm utf-8

.Pp

if the first non-ASCII byte in the file introduces a valid UTF-8 sequence

then input is interpreted according to

.It Cm iso-8859-1

.Ar encoding .

otherwise

.It

If the first non-ASCII byte in the file introduces a valid UTF-8

sequence, input is interpreted as

.Cm utf-8 .

.It

Otherwise, input is interpreted as

.Cm iso-8859-1 .

.El

.It Fl k

.It Fl mdoc | man

A synonym for

With

.Xr apropos 1 .

.Fl mdoc ,

This overrides any earlier

all input files are interpreted as

.Fl f

.Xr mdoc 7 .

and

With

.Fl l

.Fl man ,

options.

all input files are interpreted as

.It Fl l

.Xr man 7 .

A synonym for

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

.Fl a .

if the the first macro is

Also reverts any earlier

.Ic \&Dd

.Fl f

and

.Ic \&Dt ,

.Fl k

the

options.

.Xr mdoc 7

.It Fl m Ns Ar format

parser is used; otherwise, the

Input format.

.Xr man 7

See

parser is used.

.Sx Input Formats

With other arguments,

for available formats.

.Fl m

Defaults to

is silently ignored.

.Fl m Ns Cm andoc .

.It Fl O Ar options

.It Fl O Ar option

Comma-separated output options.

.It Fl T Ar output

Output format.

Line 190 If multiple files are specified,

Line 183 If multiple files are specified,

will halt with the first failed parse.

.El

.Pp

The options

.Fl fhklw

are also supported and are documented in man(1).

.Fl f

and

Line 197 and

Line 193 and

mode,

.Nm

also supports the options

.Fl CMmOSsw

.Fl CMmOSs

described in the

.Xr apropos 1

manual.

.Ss Input Formats

The options

The

.Fl fkl

.Nm

are mutually exclusive and override each other.

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

utility accepts the following

.Fl T

arguments, which correspond to output modes:

.Bl -tag -width "-T locale"

.Bl -tag -width "-T markdown"

.It Fl T Cm ascii

Produce 7-bit ASCII output.

See

Line 274 Produce

Line 230 Produce

format output.

See

.Sx Man Output .

.It Fl T Cm markdown

Produce output in

.Sy markdown

format.

See

.Sx Markdown Output .

.It Fl T Cm pdf

Produce PDF output.

See

Line 377 The string

Line 339 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 390 The string

Line 352 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 436 If the input format is

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

level controls which

.Sx DIAGNOSTICS

are displayed before copying the input to the output.

.Ss Markdown Output

Translate

.Xr mdoc 7

input to the

.Sy markdown

format conforming to

.Lk http://daringfireball.net/projects/markdown/syntax.text\

"John Gruber's 2004 specification" .

The output also almost conforms to the

.Lk http://commonmark.org/ CommonMark

specification.

.Pp

The character set used for the markdown output is ASCII.

Non-ASCII characters are encoded as HTML entities.

Since that is not possible in literal font contexts, because these

are rendered as code spans and code blocks in the markdown output,

non-ASCII characters are transliterated to ASCII approximations in

these contexts.

.Pp

Markdown is a very weak markup language, so all semantic markup is

lost, and even part of the presentational markup may be lost.

Do not use this as an intermediate step in converting to HTML;

instead, use

.Fl T Cm html

directly.

.Pp

The

.Xr man 7 ,

.Xr tbl 7 ,

and

.Xr eqn 7

input languages are not supported by

.Fl T Cm markdown

output mode.

.Ss PDF Output

PDF-1.1 output may be generated by

.Fl T Cm pdf .

Line 538 A closing parenthesis if the node is a closing delimit

Line 534 A closing parenthesis if the node is a closing delimit

.It

A full stop if the node ends a sentence.

.It

BROKEN if the node is a block broken by another block.

.It

NOSRC if the node is not in the input file,

but automatically generated from macros.

.It

Line 545 NOPRT if the node is not supposed to generate output

Line 543 NOPRT if the node is not supposed to generate output

for any output format.

.El

.Pp

The following

.Fl O

argument is accepted:

.Bl -tag -width Ds

.It Cm noval

Skip validation and show the unvalidated syntax tree.

This can help to find out whether a given behaviour is caused by

the parser or by the validator.

Meta data is not available in this case.

.El

.Sh ENVIRONMENT

.Bl -tag -width MANPAGER

.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 more 1 ;

see

.Xr man 1

for details.

Only used if

.Fl a

.Fl l

is specified.

.It Ev PAGER

Specifies the pagination program to use when

.Ev MANPAGER

Line 559 is not defined.

Line 576 is not defined.

If neither PAGER nor MANPAGER is defined,

.Xr more 1

.Fl s

will be used.

is used.

Only used if

.Fl a

.Fl l

is specified.

.El

.Sh EXIT STATUS

The

Line 857 The

Line 879 The

.Ic \&Nd

macro lacks the required argument.

The title line of the manual will end after the dash.

.It Sy "description line outside NAME section"

.Pq mdoc

.Ic \&Nd

macro appears outside the NAME section.

The arguments are printed anyway and the following text is used for

.Xr apropos 1 ,

but none of that behaviour is portable.

.It Sy "sections out of conventional order"

.Pq mdoc

A standard section occurs after another section it usually precedes.

Line 1836 as if they were a text line.

Line 1866 as if they were a text line.

.Xr mdoc 7 ,

.Xr roff 7 ,

.Xr tbl 7

.Sh HISTORY

The

.Nm

utility first appeared in

.Ox 4.8 .

The option

.Fl I

appeared in

.Ox 5.2 ,

and

.Fl aCcfhKklMSsw

.Ox 5.7 .

.Sh AUTHORS

.An -nosplit

The

CVSweb