mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.175 and 1.180

version 1.175, 2017/03/03 14:23:23

version 1.180, 2017/03/20 14:32:24

Line 26

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

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

A synonym for

Line 130 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 201 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 383 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 396 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 442 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

Line 457 input to the

Line 435 input to the

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;

Line 593 Meta data is not available in this case.

Line 581 Meta data is not available in this case.

.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 602 is not defined.

Line 598 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 900 The

Line 901 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.

CVSweb