version 1.147, 2015/02/06 07:13:14 |
version 1.155, 2015/02/23 13:31:03 |
|
|
.Nd format and display UNIX manuals |
.Nd format and display UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl acfhklV |
.Op Fl acfhkl |
.Sm off |
.Sm off |
.Op Fl I Cm os Li = Ar name |
.Op Fl I Cm os Li = Ar name |
.Sm on |
.Sm on |
|
|
for available formats. |
for available formats. |
Defaults to |
Defaults to |
.Fl T Ns Cm locale . |
.Fl T Ns Cm locale . |
.It Fl V |
|
Print version and exit. |
|
.It Fl W Ns Ar level |
.It Fl W Ns Ar level |
Specify the minimum message |
Specify the minimum message |
.Ar level |
.Ar level |
Line 729 macro occurs after some non-prologue macro, but still |
|
Line 727 macro occurs after some non-prologue macro, but still |
|
.Pq mdoc |
.Pq mdoc |
The |
The |
.Ic \&Dt |
.Ic \&Dt |
macro can only occur before the first non-prologue macro |
macro appears after the first non-prologue macro. |
because traditional formatters write the page header |
Traditional formatters cannot handle this because |
before parsing the document body. |
they write the page header before parsing the document body. |
Even though this technical restriction does not apply to |
Even though this technical restriction does not apply to |
.Nm , |
.Nm , |
traditional semantics is preserved. |
traditional semantics is preserved. |
Line 773 This may confuse |
|
Line 771 This may confuse |
|
.Xr makewhatis 8 |
.Xr makewhatis 8 |
and |
and |
.Xr apropos 1 . |
.Xr apropos 1 . |
.It Sy "bad NAME section contents" |
.It Sy "NAME section without name" |
.Pq mdoc |
.Pq mdoc |
The last node in the NAME section is not an |
The NAME section does not contain any |
|
.Ic \&Nm |
|
child macro. |
|
.It Sy "NAME section without description" |
|
.Pq mdoc |
|
The NAME section lacks the mandatory |
.Ic \&Nd |
.Ic \&Nd |
macro, or any preceding macro is not |
child macro. |
.Ic \&Nm , |
.It Sy "description not at the end of NAME" |
or the NAME section is completely empty. |
.Pq mdoc |
This may confuse |
The NAME section does contain an |
.Xr makewhatis 8 |
.Ic \&Nd |
|
child macro, but other content follows it. |
|
.It Sy "bad NAME section content" |
|
.Pq mdoc |
|
The NAME section contains plain text or macros other than |
|
.Ic \&Nm |
and |
and |
.Xr apropos 1 . |
.Ic \&Nd . |
.It Sy "missing description line, using \(dq\(dq" |
.It Sy "missing description line, using \(dq\(dq" |
.Pq mdoc |
.Pq mdoc |
The |
The |
Line 836 manual for replacements. |
|
Line 844 manual for replacements. |
|
.Pq mdoc |
.Pq mdoc |
The name of a macro that is not callable appears on a macro line. |
The name of a macro that is not callable appears on a macro line. |
It is printed verbatim. |
It is printed verbatim. |
If the intention is to call it, move it to its own line; |
If the intention is to call it, move it to its own input line; |
otherwise, escape it by prepending |
otherwise, escape it by prepending |
.Sq \e& . |
.Sq \e& . |
.It Sy "skipping paragraph macro" |
.It Sy "skipping paragraph macro" |
|
|
.Ic \&It |
.Ic \&It |
block is empty. |
block is empty. |
An empty list item is shown. |
An empty list item is shown. |
.It Sy "missing font type" |
.It Sy "missing font type, using \efR" |
.Pq mdoc |
.Pq mdoc |
A |
A |
.Ic \&Bf |
.Ic \&Bf |
macro has no argument. |
macro has no argument. |
It switches to the default font, |
It switches to the default font. |
.Cm \efR . |
.It Sy "unknown font type, using \efR" |
.It Sy "unknown font type" |
|
.Pq mdoc |
.Pq mdoc |
The |
The |
.Ic \&Bf |
.Ic \&Bf |
argument is invalid. |
argument is invalid. |
The default font |
The default font is used instead. |
.Cm \efR |
|
is used instead. |
|
.It Sy "nothing follows prefix" |
.It Sy "nothing follows prefix" |
.Pq mdoc |
.Pq mdoc |
A |
A |
|
|
utility assumes |
utility assumes |
.Fl std |
.Fl std |
even when it is not specified, but other implementations may not. |
even when it is not specified, but other implementations may not. |
|
.It Sy "missing option string, using \(dq\(dq" |
|
.Pq man |
|
The |
|
.Ic \&OP |
|
macro is invoked without any argument. |
|
An empty pair of square brackets is shown. |
|
.It Sy "missing resource identifier, using \(dq\(dq" |
|
.Pq man |
|
The |
|
.Ic \&UR |
|
macro is invoked without any argument. |
|
An empty pair of angle brackets is shown. |
.It Sy "missing eqn box, using \(dq\(dq" |
.It Sy "missing eqn box, using \(dq\(dq" |
.Pq eqn |
.Pq eqn |
A diacritic mark or a binary operator is found, |
A diacritic mark or a binary operator is found, |
|
|
.Fl width |
.Fl width |
argument. |
argument. |
That has no effect. |
That has no effect. |
|
.It Sy "wrong number of cells" |
|
In a line of a |
|
.Ic \&Bl Fl column |
|
list, the number of tabs or |
|
.Ic \&Ta |
|
macros is less than the number expected from the list header line |
|
or exceeds the expected number by more than one. |
|
Missing cells remain empty, and all cells exceeding the number of |
|
columns are joined into one single cell. |
.It Sy "unknown AT&T UNIX version" |
.It Sy "unknown AT&T UNIX version" |
.Pq mdoc |
.Pq mdoc |
An |
An |
|
|
layout modifier has an unknown |
layout modifier has an unknown |
.Ar font |
.Ar font |
argument. |
argument. |
|
.It Sy "odd number of characters in request" |
|
.Pq roff |
|
A |
|
.Ic \&tr |
|
request contains an odd number of characters. |
|
The last character is mapped to the blank character. |
.El |
.El |
.Ss "Warnings related to plain text" |
.Ss "Warnings related to plain text" |
.Bl -ohang |
.Bl -ohang |
Line 1476 macros as well as tables require explicit closing by d |
|
Line 1508 macros as well as tables require explicit closing by d |
|
A block that doesn't support bad nesting |
A block that doesn't support bad nesting |
ends before all of its children are properly closed. |
ends before all of its children are properly closed. |
The open child nodes are closed implicitly. |
The open child nodes are closed implicitly. |
.It Sy "scope open on exit" |
.It Sy "appending missing end of block" |
.Pq mdoc , man , eqn , tbl , roff |
.Pq mdoc , man , eqn , tbl , roff |
At the end of the document, an explicit |
At the end of the document, an explicit |
.Xr mdoc 7 |
.Xr mdoc 7 |
Line 1526 When parsing for a request or a user-defined macro nam |
|
Line 1558 When parsing for a request or a user-defined macro nam |
|
only the escape sequence is discarded. |
only the escape sequence is discarded. |
The characters preceding it are used as the request or macro name, |
The characters preceding it are used as the request or macro name, |
the characters following it are used as the arguments to the request or macro. |
the characters following it are used as the arguments to the request or macro. |
.It Sy "argument count wrong" |
|
.Pq mdoc , man , roff |
|
The indicated request or 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 request or macro in question. |
|
Note that the same message may also occur as a WARNING, see above. |
|
.It Sy "NOT IMPLEMENTED: Bd -file" |
.It Sy "NOT IMPLEMENTED: Bd -file" |
.Pq mdoc |
.Pq mdoc |
For security reasons, the |
For security reasons, the |
|
|
.Ic \&EN |
.Ic \&EN |
macro, or a |
macro, or a |
.Xr roff 7 |
.Xr roff 7 |
.Ic \&br |
.Ic \&br , |
|
.Ic \&fi , |
|
or |
|
.Ic \&nf |
request or |
request or |
.Sq \&.. |
.Sq \&.. |
block closing request is invoked with at least one argument. |
block closing request is invoked with at least one argument. |
All arguments are ignored. |
All arguments are ignored. |
.It Sy "skipping excess arguments" |
.It Sy "skipping excess arguments" |
.Pq mdoc , man , roff |
.Pq mdoc , man , roff |
The |
A macro or request is invoked with too many arguments: |
|
.Bl -dash -offset 2n -width 2n -compact |
|
.It |
|
.Ic \&Fo , |
|
.Ic \&PD , |
|
.Ic \&RS , |
|
.Ic \&UR , |
|
.Ic \&ft , |
|
or |
|
.Ic \&sp |
|
with more than one argument |
|
.It |
.Ic \&An |
.Ic \&An |
macro is invoked with another argument after |
with another argument after |
.Fl split |
.Fl split |
or |
or |
.Fl nosplit , |
.Fl nosplit |
.Ic \&Fo |
.It |
is invoked with more than one argument, |
.Ic \&RE |
|
with more than one argument or with a non-integer argument |
|
.It |
|
.Ic \&OP |
|
or a request of the |
|
.Ic \&de |
|
family with more than two arguments |
|
.It |
|
.Ic \&Dt |
|
with more than three arguments |
|
.It |
|
.Ic \&TH |
|
with more than five arguments |
|
.It |
.Ic \&Bd , |
.Ic \&Bd , |
.Ic \&Bk , |
.Ic \&Bk , |
or |
or |
.Ic \&Bl |
.Ic \&Bl |
are invoked with invalid arguments, the |
with invalid arguments |
.Ic \&RE |
.El |
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. |
The excess arguments are ignored. |
.El |
.El |
.Ss Unsupported features |
.Ss Unsupported features |