mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.132 and 1.137

version 1.132, 2015/01/15 04:26:40

version 1.137, 2015/01/26 13:03:48

Line 159 to be reported on the standard error output and to aff

The

.Ar level

can be

.Cm warning

.Cm warning ,

.Cm error ,

.Cm error ;

.Cm unsupp ;

.Cm all

is an alias for

.Cm warning .

Line 532 At least one warning occurred, but no error, and

Line 533 At least one warning occurred, but no error, and

.Fl W Ns Cm warning

was specified.

.It 3

At least one parsing error occurred, and

At least one parsing error occurred,

but no unsupported feature was encountered, and

.Fl W Ns Cm error

.Fl W Ns Cm warning

was specified.

.It 4

At least one unsupported feature was encountered, and

.Fl W Ns Cm unsupp ,

.Fl W Ns Cm error

.Fl W Ns Cm warning

was specified.

.It 5

Invalid command line arguments were specified.

No input files have been read.

Line 601 fields.

Line 610 fields.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm error

.It Cm unsupp

An input file contains syntax that cannot be safely interpreted,

An input file uses unsupported low-level

either because it is invalid or because

.Xr roff 7

features.

The output may be incomplete and/or misformatted,

so using GNU troff instead of

.Nm

does not implement it yet.

to process the file may be preferable.

.It Cm error

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

By discarding part of the input or inserting missing tokens,

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.

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

Line 627 formatting tools instead of

Line 648 formatting tools instead of

.El

.Pp

Messages of the

.Cm warning

.Cm warning ,

.Cm error ,

and

.Cm error

.Cm unsupp

levels except those about non-existent or unreadable input files

are hidden unless their level, or a lower level, is requested using a

.Fl W

Line 1259 keeps the code more readable.

Line 1281 keeps the code more readable.

.It "unexpected end of equation"

.El

.Ss "Errors related to tables"

.Bl -ohang

.It Sy "non-alphabetic character in tbl options"

.Pq tbl

The table options line contains a character other than a letter,

blank, or comma where the beginning of an option name is expected.

The character is ignored.

.It Sy "skipping unknown tbl option"

.Pq tbl

The table options line contains a string of letters that does not

match any known option name.

The word is ignored.

.It Sy "missing tbl option argument"

.Pq tbl

A table option that requires an argument is not followed by an

opening parenthesis, or the opening parenthesis is immediately

followed by a closing parenthesis.

The option is ignored.

.It Sy "wrong tbl option argument size"

.Pq tbl

A table option argument contains an invalid number of characters.

Both the option and the argument are ignored.

.El

.Pp

.Bl -inset -compact

.It "bad table syntax"

.It Sy "no table layout cells specified"

.It "bad table option"

.It Sy "no table data cells specified"

.It "bad table layout"

.It Sy "ignore data in cell"

.It "no table layout cells specified"

.It Sy "data block still open"

.It "no table data cells specified"

.It Sy "ignoring extra data cells"

.It "ignore data in cell"

.It "data block still open"

.It "ignoring extra data cells"

.It "ignoring macro in table"

.El

.Ss "Errors related to roff, mdoc, and man code"

.Bl -ohang

.It Sy "input too large"

.Pq mdoc , man

Currently,

.Nm

cannot handle input files larger than its arbitrary size limit

of 2^31 bytes (2 Gigabytes).

Since useful manuals are always small, this is not a problem in practice.

Parsing is aborted as soon as the condition is detected.

.It Sy "input stack limit exceeded, infinite loop?"

.Pq roff

Explicit recursion limits are implemented for the following features,

Line 1318 or

Line 1351 or

macro.

It may be mistyped or unsupported.

The request or macro is discarded including its arguments.

.It Sy "skipping insecure request"

.Pq roff

An input file attempted to run a shell command

or to read or write an external file.

Such attempts are denied for security reasons.

.It Sy "skipping item outside list"

.Pq mdoc , eqn

Line 1354 right delimiter or closing brace, or the end of an equ

Line 1392 right delimiter or closing brace, or the end of an equ

.Xr roff 7

conditional request is encountered but no matching block is open.

The offending request or macro is discarded.

.It Sy "fewer RS blocks open, skipping"

.Pq man

The

.Ic \&RE

macro is invoked with an argument, but less than the specified number of

.Ic \&RS

blocks is open.

The

.Ic \&RE

macro is discarded.

.It Sy "inserting missing end of block"

.Pq mdoc , tbl

Various

Line 1522 macro, or a

Line 1570 macro, or a

block closing request is invoked with at least one argument.

All arguments are ignored.

.It Sy "skipping excess arguments"

.Pq mdoc , roff

.Pq mdoc , man , roff

The

.Ic \&Bf

macro is invoked with more than one argument, or a request of the

macro is invoked with more than one argument, the

.Ic \&RE

macro is invoked with more than one argument

or with a non-integer argument, or a request of the

.Ic \&de

family is invoked with more than two arguments.

The excess arguments are ignored.

.El

.Ss Unsupported features

.Bl -ohang

.It Sy "input too large"

.Pq mdoc , man

Currently,

.Nm

cannot handle input files larger than its arbitrary size limit

of 2^31 bytes (2 Gigabytes).

Since useful manuals are always small, this is not a problem in practice.

Parsing is aborted as soon as the condition is detected.

.It Sy "unsupported control character"

.Pq roff

An ASCII control character supported by other

.Xr roff 7

implementations but not by

.Nm

was found in an input file.

It is replaced by a question mark.

.It Sy "unsupported roff request"

.Pq roff

An input file contains a

.Xr roff 7

request supported by GNU troff or Heirloom troff but not by

.Nm ,

and it is likely that this will cause information loss

or considerable misformatting.

.It Sy "unsupported table layout"

.It Sy "ignoring macro in table"

.It Sy "eqn in tbl"

.Pq eqn , tbl

The options line of a table defines equation delimiters.

Any equation source code contained in the table will be printed unformatted.

.El

.Sh COMPATIBILITY

This section summarises

CVSweb