mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.215 and 1.219

version 1.215, 2017/07/06 22:59:48

version 1.219, 2017/09/07 14:55:12

Line 238 See

.It Fl T Cm lint

Parse only: produce no output.

Implies

.Fl W Cm all .

.Fl W Cm all

and redirects parser messages, which usually appear

on standard error output, to standard output.

.It Fl T Cm locale

Encode output using the current locale.

This is the default.

Line 313 and seven for

Line 315 and seven for

.Xr man 7 .

Increasing this is not recommended; it may result in degraded formatting,

for example overfull lines or ugly line breaks.

.It Cm mdoc

Format

.Xr man 7

input files in

.Xr mdoc 7

output style.

Specifically, this suppresses the two additional blank lines near the

top and the bottom of each page, and it implies

.Fl O Cm indent Ns =5 .

One useful application is for checking that

.Fl T Cm man

output formats in the same way as the

.Xr mdoc 7

source it was generated from.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width .

Line 719 so using GNU troff instead of

Line 735 so using GNU troff instead of

.Nm

to process the file may be preferable.

.It Cm error

An input file contains invalid syntax that cannot be safely interpreted.

Indicates a risk of information loss or severe misformatting,

By discarding part of the input or inserting missing tokens,

in most cases caused by serious syntax errors.

the parser is able to continue, and the error does not prevent

generation of formatted output, but typically, preparing that

output involves information loss, broken document structure

or unintended formatting, no matter whether

.Nm

or GNU troff is used.

In many cases, the output of

.Nm

and GNU troff is identical, but in some,

.Nm

is more resilient than GNU troff with respect to malformed input.

.Pp

Non-existent or unreadable input files are also reported on the

.Cm error

level.

In that case, the parser cannot even be started and no output

is produced from those input files.

.It Cm warning

An input file uses obsolete, discouraged or non-portable syntax.

Indicates a risk that the information shown or its formatting

All the same, the meaning of the input is unambiguous and a correct

may mismatch the author's intent in minor ways.

rendering can be produced.

Additionally, syntax errors are classified at least as warnings,

Documents causing warnings may render poorly when using other

even if they do not usually cause misformatting.

formatting tools instead of

.Nm .

.It Cm style

An input file uses dubious or discouraged style.

This is not a complaint about the syntax, and probably neither

Line 758 Please use your good judgement to decide whether any p

Line 755 Please use your good judgement to decide whether any p

.Cm style

suggestion really justifies a change to the input file.

.It Cm base

A convertion used in the base system of a specific operating system

A convention used in the base system of a specific operating system

is not adhered to.

These are not markup mistakes, and neither the quality of formatting

nor portability are in danger.

CVSweb