mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.122 and 1.148

version 1.122, 2014/11/11 02:43:41

version 1.148, 2015/02/06 08:28:35

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 159 can be

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

Line 259 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 271 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 303 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 317 Emboldened characters are rendered as

Line 321 Emboldened characters are rendered as

The special characters documented in

.Xr mandoc_char 7

are rendered best-effort in an ASCII equivalent.

If no equivalent is found,

.Sq \&?

is used instead.

.Pp

Output width is limited to 78 visible columns unless literal input lines

exceed this limit.

Line 340 for example overfull lines or ugly line breaks.

Line 341 for example overfull lines or ugly line breaks.

.It Cm width Ns = Ns Ar width

The output width is set to

.Ar width ,

which will normalise to \(>=60.

which will normalise to \(>=58.

.El

.Ss HTML Output

Output produced by

Line 368 The following

Line 369 The following

arguments are accepted:

.Bl -tag -width Ds

.It Cm fragment

Omit the

Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body>

.Aq !DOCTYPE

elements and only emit the subtree below the <body> element.

declaration and the

.Aq html ,

.Aq head ,

and

.Aq body

elements and only emit the subtree below the

.Aq body

element.

The

.Cm style

argument will be ignored.

Line 421 relative URI.

Line 414 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 535 At least one warning occurred, but no error, and

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

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

Line 607 fields.

.Pp

Message levels have the following meanings:

.Bl -tag -width "warning"

.It Cm syserr

.It Cm unsupp

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

An input file uses unsupported low-level

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

.Xr roff 7

.It Cm fatal

features.

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

The output may be incomplete and/or misformatted,

No formatted output is produced from that input file.

so using GNU troff instead of

.It Cm error

An input file contains syntax that cannot be safely interpreted,

either because it is invalid or because

.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

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 632 formatting tools instead of

Line 645 formatting tools instead of

.El

.Pp

Messages of the

.Cm warning

.Cm warning ,

.Cm error ,

and

.Cm error

.Cm unsupp

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 673 macro lacks the mandatory section argument.

Line 688 macro lacks the mandatory section argument.

The section number in a

.Ic \&Dt

line is invalid, but still used.

.It Sy "unknown manual volume or arch"

.Pq mdoc

The volume name in a

.Ic \&Dt

line is invalid, but still used.

The manual is assumed to be architecture-independent.

.It Sy "missing date, using today's date"

.Pq mdoc, man

The document was parsed as

Line 775 This may confuse

Line 784 This may confuse

.Xr makewhatis 8

and

.Xr apropos 1 .

.It Sy "missing description line, using \(dq\(dq"

.Pq mdoc

The

.Ic \&Nd

macro lacks the required argument.

The title line of the manual will end after the dash.

.It Sy "sections out of conventional order"

.Pq mdoc

A standard section occurs after another section it usually precedes.

Line 817 Probably, there are author names lacking markup.

Line 832 Probably, there are author names lacking markup.

See the

.Xr mdoc 7

manual for replacements.

.It Sy "macro neither callable nor escaped"

.Pq mdoc

The name of a macro that is not callable appears on a macro line.

It is printed verbatim.

If the intention is to call it, move it to its own line;

otherwise, escape it by prepending

.Sq \e& .

.It Sy "skipping paragraph macro"

.Xr mdoc 7

Line 973 clause.

Line 995 clause.

.It Sy "skipping empty macro"

.Pq mdoc

The indicated macro has no arguments and hence no effect.

.It Sy "empty block"

.Pq mdoc , man

.Ic \&Bd ,

.Ic \&Bk ,

.Ic \&Bl ,

.Ic \&D1 ,

.Ic \&Dl ,

.Ic \&RS ,

.Ic \&UR

block contains nothing in its body and will produce no output.

.It Sy "empty argument, using 0n"

.Pq mdoc

The required width is missing after

Line 982 or

Line 1016 or

.Fl offset

.Fl width.

.It Sy "argument count wrong"

.Pq mdoc , man

The indicated macro has too few or too many arguments.

The syntax tree will contain the wrong number of arguments as given.

Formatting behaviour depends on the specific macro in question.

Note that the same message may also occur as an ERROR, see below.

.It Sy "missing display type, using -ragged"

.Pq mdoc

The

Line 1019 The

Line 1047 The

macro is called without an argument before

.Ic \&Nm

has first been called with an argument.

.It Sy "missing function name, using \(dq\(dq"

.Pq mdoc

The

.Ic \&Fo

macro is called without an argument.

No function name is printed.

.It Sy "empty head in list item"

.Pq mdoc

In a

Line 1061 argument is invalid.

Line 1095 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 "empty reference block"

.Pq mdoc

.Ic \&Rs

macro is immediately followed by an

.Ic \&Re

macro on the next input line.

Such an empty block does not produce any output.

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

.Pq mdoc

Line 1246 its value is implicitly set to the empty string.

Line 1296 its value is implicitly set to the empty string.

However, defining strings explicitly before use

keeps the code more readable.

.El

.Ss "Errors related to equations"

.Ss "Warnings related to tables"

.Bl -inset -compact

.Bl -ohang

.It "unexpected equation scope closure"

.It Sy "tbl line starts with span"

.It "equation scope open on exit"

.Pq tbl

.It "overlapping equation scopes"

The first cell in a table layout line is a horizontal span

.It "unexpected end of equation"

.Pq Sq Cm s .

Data provided for this cell is ignored, and nothing is printed in the cell.

.It Sy "tbl column starts with span"

.Pq tbl

The first line of a table layout specification

requests a vertical span

.Pq Sq Cm ^ .

Data provided for this cell is ignored, and nothing is printed in the cell.

.It Sy "skipping vertical bar in tbl layout"

.Pq tbl

A table layout specification contains more than two consecutive vertical bars.

A double bar is printed, all additional bars are discarded.

.El

.Ss "Errors related to tables"

.Bl -inset -compact

.Bl -ohang

.It "bad table syntax"

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

.It "bad table option"

.Pq tbl

.It "bad table layout"

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

.It "no table layout cells specified"

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

.It "no table data cells specified"

The character is ignored.

.It "ignore data in cell"

.It Sy "skipping unknown tbl option"

.It "data block still open"

.Pq tbl

.It "ignoring extra data cells"

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.

.It Sy "empty tbl layout"

.Pq tbl

A table layout specification is completely empty,

specifying zero lines and zero columns.

As a fallback, a single left-justified column is used.

.It Sy "invalid character in tbl layout"

.Pq tbl

A table layout specification contains a character that can neither

be interpreted as a layout key character nor as a layout modifier,

or a modifier precedes the first key.

The invalid character is discarded.

.It Sy "unmatched parenthesis in tbl layout"

.Pq tbl

A table layout specification contains an opening parenthesis,

but no matching closing parenthesis.

The rest of the input line, starting from the parenthesis, has no effect.

.It Sy "tbl without any data cells"

.Pq tbl

A table does not contain any data cells.

It will probably produce no output.

.It Sy "ignoring data in spanned tbl cell"

.Pq tbl

A table cell is marked as a horizontal span

.Pq Sq Cm s

or vertical span

.Pq Sq Cm ^

in the table layout, but it contains data.

The data is ignored.

.It Sy "ignoring extra tbl data cells"

.Pq tbl

A data line contains more cells than the corresponding layout line.

The data in the extra cells is ignored.

.It Sy "data block open at end of tbl"

.Pq tbl

A data block is opened with

.Cm T{ ,

but never closed with a matching

.Cm T} .

The remaining data lines of the table are all put into one cell,

and any remaining cells stay empty.

.El

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

.Bl -ohang

Line 1304 or

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

Line 1458 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 1404 The indicated request or macro has too few or too many

Line 1532 The indicated request or macro has too few or too many

The syntax tree will contain the wrong number of arguments as given.

Formatting behaviour depends on the specific request or macro in question.

Note that the same message may also occur as a WARNING, see above.

.It Sy "NOT IMPLEMENTED: Bd -file"

.Pq mdoc

For security reasons, the

.Ic \&Bd

macro does not support the

.Fl file

argument.

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 argument is ignored including the file name following it.

.It Sy "missing list type, using -item"

.Pq mdoc

Line 1443 or

Line 1582 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 1452 An

Line 1614 An

.Ic \&Ef ,

.Ic \&Ek ,

.Ic \&El ,

.Ic \&Lp ,

.Ic \&Pp ,

.Ic \&Re ,

.Ic \&Rs ,

.Ic \&Ud

macro, an

Line 1470 or

Line 1635 or

.Ic \&EN

macro, or a

.Xr roff 7

.Ic \&br ,

.Ic \&fi ,

.Ic \&nf

request or

.Sq \&..

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

.Ic \&An

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

macro is invoked with another argument after

.Fl split

.Fl nosplit ,

.Ic \&Fo

is invoked with more than one argument,

.Ic \&Bd ,

.Ic \&Bk ,

.Ic \&Bl

are invoked with invalid arguments, the

.Ic \&RE

macro is invoked with more than one argument

or with a non-integer argument, the

.Ic \&sp

request is invoked with more than one 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 1492 cannot handle input files larger than its arbitrary si

Line 1677 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: Bd -file"

.It Sy "unsupported control character"

.Pq mdoc

For security reasons, the

.Ic \&Bd

macro does not support the

.Fl file

argument.

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

.Pq roff

For security reasons,

An ASCII control character supported by other

.Xr roff 7

implementations but not by

.Nm

allows

was found in an input file.

.Ic \&so

It is replaced by a question mark.

file inclusion requests only with relative paths

.It Sy "unsupported roff request"

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

An input file contains a

.Ic \&so

.Xr roff 7

request requires reading an external file.

request supported by GNU troff or Heirloom troff but not by

While trying to do so, an

.Nm ,

.Xr open 2 ,

and it is likely that this will cause information loss

.Xr stat 2 ,

or considerable misformatting.

.It Sy "eqn delim option in tbl"

.Xr read 2

.Pq eqn , tbl

system call failed.

The options line of a table defines equation delimiters.

The parser exits immediately.

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

Before showing this message,

.It Sy "unsupported table layout modifier"

.Nm

.Pq tbl

always shows another message explaining why the system call failed.

A table layout specification contains an

.El

.Sq Cm m

.Sh COMPATIBILITY

modifier.

This section summarises

The modifier is discarded.

.Nm

.It Sy "ignoring macro in table"

compatibility with GNU troff.

.Pq tbl , mdoc , man

Each input and output format is separately noted.

A table contains an invocation of an

.Ss ASCII Compatibility

.Bl -bullet -compact

.It

Unrenderable unicode codepoints specified with

.Sq \e[uNNNN]

escapes are printed as

.Sq \&?

in mandoc.

In GNU troff, these raise an error.

.It

The

.Sq \&Bd \-literal

and

.Sq \&Bd \-unfilled

macros of

.Xr mdoc 7

.Fl T Ns Cm ascii

are synonyms, as are \-filled and \-ragged.

.It

In historic GNU troff, the

.Sq \&Pa

.Xr mdoc 7

macro does not underline when scoped under an

.Sq \&It

in the FILES section.

This behaves correctly in

.Nm .

.It

A list or display following the

.Sq \&Ss

.Xr mdoc 7

macro in

.Fl T Ns Cm ascii

does not assert a prior vertical break, just as it doesn't with

.Sq \&Sh .

.It

The

.Sq \&na

.Xr man 7

macro in

macro or of an undefined macro.

.Fl T Ns Cm ascii

The macro is ignored, and its arguments are handled

has no effect.

as if they were a text line.

.It

Words aren't hyphenated.

.El

.Ss HTML Compatibility

.Bl -bullet -compact

.It

The

.Sq \efP

escape will revert the font to the previous

.Sq \ef

escape, not to the last rendered decoration, which is now dictated by

CSS instead of hard-coded.

It also will not span past the current scope,

for the same reason.

Note that in

.Sx ASCII Output

mode, this will work fine.

.It

The

.Xr mdoc 7

.Sq \&Bl \-hang

and

.Sq \&Bl \-tag

list types render similarly (no break following overreached left-hand

side) due to the expressive constraints of HTML.

.It

The

.Xr man 7

.Sq IP

and

.Sq TP

lists render similarly.

.El

.Sh SEE ALSO

.Xr apropos 1 ,

.Xr man 1 ,

.Xr eqn 7 ,

.Xr man 7 ,

.Xr mandoc_char 7 ,

Line 1623 lists render similarly.

Line 1726 lists render similarly.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv

.Sh CAVEATS

and is maintained by

.An Ingo Schwarze Aq Mt schwarze@openbsd.org .

.Sh BUGS

.Fl T Ns Cm html

.Fl T Ns Cm html ,

and

.Fl T Ns Cm xhtml ,

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 Ns Cm style Ns = Ns Ar really/long/link .

.Pp

Nesting elements within next-line element scopes of

.Fl m Ns Cm an ,

such as

.Sq br

within an empty

.Sq B ,

will confuse

.Fl T Ns Cm html

and

.Fl T Ns Cm xhtml

and cause them to forget the formatting of the prior next-line scope.

.Pp

The

.Sq \(aq

control character is an alias for the standard macro control character

and does not emit a line-break as stipulated in GNU troff.

CVSweb