mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.169 and 1.176

version 1.169, 2017/01/10 12:53:07

version 1.176, 2017/03/04 17:17:34

Line 98 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 250 The

Line 258 The

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 282 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 443 The parser is also run, and as usual, the

Line 457 The parser is also run, and as usual, the

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

.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 498 Use

Line 536 Use

to show a human readable representation of the syntax tree.

It is useful for debugging the source code of manual pages.

The exact format is subject to change, so don't write parsers for it.

Each output line shows one syntax tree node.

.Pp

The first paragraph shows meta data found in the

.Xr mdoc 7

prologue, on the

.Xr man 7

.Ic \&TH

line, or the fallbacks used.

.Pp

In the tree dump, each output line shows one syntax tree node.

Child nodes are indented with respect to their parent node.

The columns are:

.Pp

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

Line 576 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 537 NOPRT if the node is not supposed to generate output

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

Line 1349 it is hard to predict which tab stop position the tab

Line 1408 it is hard to predict which tab stop position the tab

Whitespace at the end of input lines is almost never semantically

significant \(em but in the odd case where it might be, it is

extremely confusing when reviewing and maintaining documents.

.It Sy "new sentence, new line"

.Pq mdoc

A new sentence starts in the middle of a text line.

Start it on a new input line to help formatters produce correct spacing.

.It Sy "bad comment style"

.Pq roff

Comment lines start with a dot, a backslash, and a double-quote character.

Line 1824 as if they were a text line.

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

Line 1832 utility was written by

Line 1908 utility was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

and is maintained by

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

.Sh BUGS

.Fl T Cm html ,

the maximum size of an element attribute is determined by

.Dv BUFSIZ ,

which is usually 1024 bytes.

Be aware of this when setting long link

formats such as

.Fl O Cm style Ns = Ns Ar really/long/link .

CVSweb