mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.112 and 1.139

version 1.112, 2014/09/12 00:10:26

version 1.139, 2015/01/28 17:32:07

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 27

.Sm off

.Op Fl I Cm os Li = Ar name

.Sm on

.Op Fl K Ns Ar encoding

.Op Fl m Ns Ar format

.Op Fl O Ns Ar option

.Op Fl T Ns Ar output

Line 48 or

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 84 Override the default operating system

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.

Implies

.Fl a .

.Fl c .

.It Fl K Ns Ar encoding

Specify the input encoding.

The supported

.Ar encoding

arguments are

.Cm us-ascii ,

.Cm iso-8859-1 ,

and

.Cm utf-8 .

If not specified, autodetection uses the first match:

.Bl -tag -width iso-8859-1

.It Cm utf-8

if the first three bytes of the input file

are the UTF-8 byte order mark (BOM, 0xefbbbf)

.It Ar encoding

if the first or second line of the input file matches the

.Sy emacs

mode line format

.Pp

.D1 .\e" -*- Oo ...; Oc coding: Ar encoding ; No -*-

.It Cm utf-8

if the first non-ASCII byte in the file introduces a valid UTF-8 sequence

.It Cm iso-8859-1

otherwise

.El

.It Fl k

A synonym for

.Xr apropos 1 .

Line 120 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 133 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 229 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

Produce strict CSS1/HTML-4.01 output.

Produce HTML5, CSS1, and MathML output.

See

.Sx HTML Output .

.It Fl T Ns Cm lint

Line 242 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 265 Encode output in the UTF\-8 multi-byte format.

Line 295 Encode output in the UTF\-8 multi-byte format.

See

.Sx UTF\-8 Output .

.It Fl T Ns Cm xhtml

Produce strict CSS1/XHTML-1.0 output.

This is a synonym for

See

.Fl T Ns Cm html .

.Sx XHTML Output .

.El

.Pp

If multiple input files are specified, these will be processed by the

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 320 which will normalise to \(>=60.

Line 349 which will normalise to \(>=60.

.Ss HTML Output

Output produced by

.Fl T Ns Cm html

conforms to HTML-4.01 strict.

conforms to HTML5 using optional self-closing tags.

Default styles use only CSS1.

Equations rendered from

.Xr eqn 7

blocks use MathML.

.Pp

The

.Pa example.style.css

Line 328 file documents style-sheet classes available for custo

Line 361 file documents style-sheet classes available for custo

If a style-sheet is not specified with

.Fl O Ns Ar style ,

.Fl T Ns Cm html

defaults to simple output readable in any graphical or text-based web

defaults to simple output (via an embedded style-sheet)

readable in any graphical or text-based web

browser.

.Pp

Special characters are rendered in decimal-encoded UTF\-8.

Line 338 The following

Line 372 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 391 relative URI.

Line 417 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 471 to force a UTF\-8 locale.

Line 499 to force a UTF\-8 locale.

See

.Sx Locale Output

for details and options.

.Ss XHTML Output

Output produced by

.Fl T Ns Cm xhtml

conforms to XHTML-1.0 strict.

.Pp

See

.Sx HTML Output

for details; beyond generating XHTML tags instead of HTML tags, these

output modes are identical.

.Sh ENVIRONMENT

.Bl -tag -width MANPAGER

.It Ev MANPAGER

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

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

Line 610 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 611 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 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 652 macro lacks the mandatory section argument.

Line 691 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 796 Probably, there are author names lacking markup.

Line 829 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 916 The previous, interrupted macro is deleted from the pa

Line 956 The previous, interrupted macro is deleted from the pa

.Ss "Warnings related to missing arguments"

.Bl -ohang

.It Sy "skipping empty request"

.Pq roff

.Pq roff , eqn

The macro name is missing from a macro definition request.

The macro name is missing from a macro definition request,

or an

.Xr eqn 7

control statement or operation keyword lacks its required argument.

.It Sy "conditional request controls empty scope"

.Pq roff

A conditional request is only useful if any of the following

Line 1037 argument is invalid.

Line 1080 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 1051 The

Line 1102 The

utility assumes

.Fl std

even when it is not specified, but other implementations may not.

.It Sy "missing eqn box, using \(dq\(dq"

.Pq eqn

A diacritic mark or a binary operator is found,

but there is nothing to the left of it.

An empty box is inserted.

.El

.Ss "Warnings related to bad macro arguments"

.Bl -ohang

Line 1118 macro has an invalid argument.

Line 1174 macro has an invalid argument.

It is used verbatim, with

.Qq "AT&T UNIX "

prefixed to it.

.It Sy "comma in function argument"

.Pq mdoc

An argument of an

.Ic \&Fa

.Ic \&Fn

macro contains a comma; it should probably be split into two arguments.

.It Sy "parenthesis in function name"

.Pq mdoc

The first argument of an

.Ic \&Fc

.Ic \&Fn

macro contains an opening or closing parenthesis; that's probably wrong,

parentheses are added automatically.

.It Sy "invalid content in Rs block"

.Pq mdoc

Line 1136 or

Line 1207 or

The invalid argument is moved out of the macro, which leaves the macro

empty, causing it to toggle the spacing mode.

.It Sy "unknown font, skipping request"

.Pq man

.Pq man , tbl

.Xr roff 7

.Ic \&ft

request has an invalid argument.

request or a

.Xr tbl 7

.Ic \&f

layout modifier has an unknown

.Ar font

argument.

.El

.Ss "Warnings related to plain text"

.Bl -ohang

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

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

However, defining strings explicitly before use

keeps the code more readable.

.El

.Ss "Warnings related to tables"

.Bl -ohang

.It Sy "tbl line starts with span"

.Pq tbl

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

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

.Bl -inset -compact

.It "unexpected equation scope closure"

.It "equation scope open on exit"

.It "overlapping equation scopes"

.It "unexpected end of equation"

.It "equation syntax error"

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

Line 1401 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

.Pq mdoc , eqn

.Ic \&It

macro occurs outside any

.Ic \&Bl

list.

list, or an

.Xr eqn 7

.Ic above

delimiter occurs outside any pile.

It is discarded including its arguments.

.It Sy "skipping column outside column list"

.Pq mdoc

Line 1283 block closing macro, a

Line 1436 block closing macro, a

.Ic \&RE

.Ic \&UE

macro, or the end of an equation, table, or

macro, an

.Xr eqn 7

right delimiter or closing brace, or the end of an equation, table, or

.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 1351 The indicated request or macro has too few or too many

Line 1516 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 1380 An

Line 1556 An

.Ic \&St

macro has an unknown argument and is discarded.

.It Sy "skipping request without numeric argument"

.Pq roff

.Pq roff , eqn

.Ic \&it

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

request or an

The invalid request is ignored.

.Xr eqn 7

.Ic \&size

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

Line 1611 or

.Ic \&PP

macro, an

.Xr eqn 7

.Ic \&EQ

.Ic \&EN

macro, or a

.Xr roff 7

Line 1414 macro, or a

Line 1620 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 1432 cannot handle input files larger than its arbitrary si

Line 1641 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"

.Pq eqn , tbl

The options line of a table defines equation delimiters.

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

.It Sy "unsupported table layout modifier"

.Pq tbl

A table layout specification contains an

.Sq Cm m

modifier.

The modifier is discarded.

.It Sy "ignoring macro in table"

.Pq tbl , mdoc , man

A table contains an invocation of an

.Xr mdoc 7

.Xr read 2

.Xr man 7

system call failed.

macro or of an undefined macro.

The parser exits immediately.

The macro is ignored, and its arguments are handled

Before showing this message,

as if they were a text line.

.Nm

always shows another message explaining why the system call failed.

.El

.Sh COMPATIBILITY

This section summarises

Line 1522 has no effect.

Line 1728 has no effect.

.It

Words aren't hyphenated.

.El

.Ss HTML/XHTML Compatibility

.Ss HTML Compatibility

.Bl -bullet -compact

.It

The

CVSweb