mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.131 and 1.135

version 1.131, 2015/01/14 22:02:49

version 1.135, 2015/01/24 01:58:33

Line 162 can be

.Cm warning ,

.Cm error ,

.Cm fatal .

.Cm unsupp ;

The default is

.Cm all

.Fl W Ns Cm fatal ;

.Fl W Ns Cm all

is an alias for

.Fl W Ns Cm warning .

.Cm warning .

By default,

.Nm

is silent.

See

.Sx EXIT STATUS

and

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, but no fatal error, 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

A fatal parsing error occurred.

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 603 fields.

Line 610 fields.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm fatal

.It Cm unsupp

The parser is unable to parse a given input file at all.

An input file uses unsupported low-level

No formatted output is produced from that input file.

.Xr roff 7

.It Cm error

features.

An input file contains syntax that cannot be safely interpreted,

The output may be incomplete and/or misformatted,

either because it is invalid or because

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 632 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 1265 keeps the code more readable.

Line 1282 keeps the code more readable.

.El

.Ss "Errors related to tables"

.Bl -inset -compact

.It "bad table syntax"

.It "bad table option"

.It "bad table layout"

.It "no table layout cells specified"

.It "no table data cells specified"

.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

Line 1315 or

Line 1328 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 1351 right delimiter or closing brace, or the end of an equ

Line 1369 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 1465 or

Line 1493 or

.Ic \&gsize

statement has a non-numeric or negative argument or no argument at all.

The invalid request or statement is ignored.

.It Sy "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"

.Pq roff

For security reasons,

.Nm

allows

.Ic \&so

file inclusion requests only with relative paths

and only without ascending to any parent directory.

By requesting the inclusion of a sensitive file, a malicious document

might otherwise trick a privileged user into inadvertently displaying

the file on the screen, revealing the file content to bystanders.

.Nm

only shows the path as it appears behind

.Ic \&so .

.It Sy ".so request failed"

.Pq roff

Servicing a

.Ic \&so

request requires reading an external file, but the file could not be

opened.

.Nm

only shows the path as it appears behind

.Ic \&so .

.It Sy "skipping all arguments"

.Pq mdoc , man , eqn , roff

Line 1496 macro, or a

Line 1547 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 FATAL errors

.Ss Unsupported features

.Bl -ohang

.It Sy "input too large"

.Pq mdoc , man

Line 1514 cannot handle input files larger than its arbitrary si

Line 1568 cannot handle input files larger than its arbitrary si

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 "NOT IMPLEMENTED: .so with absolute path or \(dq..\(dq"

.It Sy "unsupported roff request"

.Pq roff

For security reasons,

An input file contains a

.Nm

.Xr roff 7

allows

request supported by GNU troff or Heirloom troff but not by

.Ic \&so

.Nm ,

file inclusion requests only with relative paths

and it is likely that this will cause information loss

and only without ascending to any parent directory.

or considerable misformatting.

By requesting the inclusion of a sensitive file, a malicious document

.It Sy "bad table syntax"

might otherwise trick a privileged user into inadvertently displaying

.It Sy "bad table option"

the file on the screen, revealing the file content to bystanders.

.It Sy "bad table layout"

The parser exits immediately.

.It Sy "ignoring macro in table"

.It Sy ".so request failed"

.Pq roff

Servicing a

.Ic \&so

request requires reading an external file.

While trying to do so, an

.Xr open 2 ,

.Xr stat 2 ,

.Xr read 2

system call failed.

The parser exits immediately.

Before showing this message,

.Nm

always shows another message explaining why the system call failed.

.El

.Sh COMPATIBILITY

This section summarises

CVSweb