mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

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

Line 498 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 1349 it is hard to predict which tab stop position the tab

Line 1357 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 1832 utility was written by

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