mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.126, 2014/11/30 02:36:38

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

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 49 or

text from stdin, implying

.Fl m Ns Cm andoc ,

and produces

.Fl T Ns Cm ascii

.Fl T Ns Cm locale

output.

.Pp

The options are as follows:

Line 85 Override the default operating system

for the

.Xr mdoc 7

.Sq \&Os

and for the

.Xr man 7

.Sq \&TH

macro.

.It Fl h

Display only the SYNOPSIS lines.

Line 146 See

Line 149 See

.Sx Output Formats

for available formats.

Defaults to

.Fl T Ns Cm ascii .

.Fl T Ns Cm locale .

.It Fl V

Print version and exit.

.It Fl W Ns Ar level

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

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

.Cm error ;

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 255 arguments, which correspond to output modes:

Line 258 arguments, which correspond to output modes:

.Bl -tag -width "-Tlocale"

.It Fl T Ns Cm ascii

Produce 7-bit ASCII output.

This is the default.

See

.Sx ASCII Output .

.It Fl T Ns Cm html

Line 268 Implies

Line 270 Implies

.Fl W Ns Cm warning .

.It Fl T Ns Cm locale

Encode output using the current locale.

This is the default.

See

.Sx Locale Output .

.It Fl T Ns Cm man

Line 299 If multiple input files are specified, these will be p

Line 302 If multiple input files are specified, these will be p

corresponding filter in-order.

.Ss ASCII Output

Output produced by

.Fl T Ns Cm ascii ,

.Fl T Ns Cm ascii

which is the default, is rendered in standard 7-bit ASCII documented in

is rendered in standard 7-bit ASCII documented in

.Xr ascii 7 .

.Pp

Font styles are applied by using back-spaced encoding such that an

Line 413 relative URI.

Line 416 relative URI.

.Ss Locale Output

Locale-depending output encoding is triggered with

.Fl T Ns Cm locale .

This is the default.

.Pp

This option is not available on all systems: systems without locale

support, or those whose internal representation is not natively UCS-4,

will fall back to

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

Line 532 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, and

.Fl W Ns Cm error

.Fl W Ns Cm warning

was specified.

.It 4

A fatal parsing error occurred.

.It 5

Invalid command line arguments were specified.

No input files have been read.

.It 6

An operating system error occurred, for example memory exhaustion or an

An operating system error occurred, for example exhaustion

error accessing input files.

of memory, file descriptors, or process table entries.

Such errors cause

.Nm

to exit at once, possibly in the middle of parsing or formatting a file.

Line 598 fields.

Line 601 fields.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm syserr

Opening or reading an input file failed, so the parser cannot

even be started and no output is produced from that input file.

.It Cm fatal

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

No formatted output is produced from that input file.

.It Cm error

An input file contains syntax that cannot be safely interpreted,

either because it is invalid or because

Line 614 the parser is able to continue, and the error does not

Line 611 the parser is able to continue, and the error does not

generation of formatted output, but typically, preparing that

output involves information loss, broken document structure

or unintended formatting.

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

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

Line 627 Messages of the

Line 630 Messages of the

.Cm warning

and

.Cm error

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

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

option or

.Fl T Ns Cm lint

Line 1054 argument is invalid.

Line 1058 argument is invalid.

The default font

.Cm \efR

is used instead.

.It Sy "nothing follows prefix"

.Pq mdoc

.Ic \&Pf

macro has no argument, or only one argument and no macro follows

on the same input line.

This defeats its purpose; in particular, spacing is not suppressed

before the text or macros following on the next input line.

.It Sy "missing -std argument, adding it"

.Pq mdoc

Line 1256 keeps the code more readable.

Line 1268 keeps the code more readable.

.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 1447 or

Line 1468 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 1485 macro is invoked with more than one argument, or a req

Line 1529 macro is invoked with more than one argument, or a req

.Ic \&de

family is invoked with more than two arguments.

The excess arguments are ignored.

.El

.Ss FATAL errors

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

The parser exits immediately.

.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