version 1.228, 2018/08/25 16:53:38 |
version 1.232, 2018/12/15 19:30:26 |
Line 290 One useful application is for checking that |
|
Line 290 One useful application is for checking that |
|
output formats in the same way as the |
output formats in the same way as the |
.Xr mdoc 7 |
.Xr mdoc 7 |
source it was generated from. |
source it was generated from. |
|
.It Cm tag Ns Op = Ns Ar term |
|
If the formatted manual page is opened in a pager, |
|
go to the definition of the |
|
.Ar term |
|
rather than showing the manual page from the beginning. |
|
If no |
|
.Ar term |
|
is specified, reuse the first command line argument that is not a |
|
.Ar section |
|
number. |
|
This is useful when it is the name of a manual page, |
|
in particular the name of a library function. |
.It Cm width Ns = Ns Ar width |
.It Cm width Ns = Ns Ar width |
The output width is set to |
The output width is set to |
.Ar width |
.Ar width |
|
|
are replaced with the include filename. |
are replaced with the include filename. |
The default is not to present a |
The default is not to present a |
hyperlink. |
hyperlink. |
.It Cm man Ns = Ns Ar fmt |
.It Cm man Ns = Ns Ar fmt Ns Op ; Ns Ar fmt |
The string |
The string |
.Ar fmt , |
.Ar fmt , |
for example, |
for example, |
Line 361 are replaced with the linked manual's name and section |
|
Line 373 are replaced with the linked manual's name and section |
|
If no section is included, section 1 is assumed. |
If no section is included, section 1 is assumed. |
The default is not to |
The default is not to |
present a hyperlink. |
present a hyperlink. |
|
If two formats are given and a file |
|
.Ar %N.%S |
|
exists in the current directory, the first format is used; |
|
otherwise, the second format is used. |
.It Cm style Ns = Ns Ar style.css |
.It Cm style Ns = Ns Ar style.css |
The file |
The file |
.Ar style.css |
.Ar style.css |
is used for an external style-sheet. |
is used for an external style-sheet. |
This must be a valid absolute or |
This must be a valid absolute or |
relative URI. |
relative URI. |
|
.It Cm toc |
|
If an input file contains at least two non-standard sections, |
|
print a table of contents near the beginning of the output. |
.El |
.El |
.Ss Locale Output |
.Ss Locale Output |
By default, |
By default, |
Line 1657 Start it on a new input line to help formatters produc |
|
Line 1676 Start it on a new input line to help formatters produc |
|
.It Sy "invalid escape sequence" |
.It Sy "invalid escape sequence" |
.Pq roff |
.Pq roff |
An escape sequence has an invalid opening argument delimiter, lacks the |
An escape sequence has an invalid opening argument delimiter, lacks the |
closing argument delimiter, or the argument has too few characters. |
closing argument delimiter, the argument is of an invalid form, or it is |
|
a character escape sequence with an invalid name. |
If the argument is incomplete, |
If the argument is incomplete, |
.Ic \e* |
.Ic \e* |
and |
and |
|
|
.Ic \ew |
.Ic \ew |
to the length of the incomplete argument. |
to the length of the incomplete argument. |
All other invalid escape sequences are ignored. |
All other invalid escape sequences are ignored. |
|
.It Sy "undefined escape, printing literally" |
|
.Pq roff |
|
In an escape sequence, the first character |
|
right after the leading backslash is invalid. |
|
That character is printed literally, |
|
which is equivalent to ignoring the backslash. |
.It Sy "undefined string, using \(dq\(dq" |
.It Sy "undefined string, using \(dq\(dq" |
.Pq roff |
.Pq roff |
If a string is used without being defined before, |
If a string is used without being defined before, |
Line 2135 implementations but not by |
|
Line 2161 implementations but not by |
|
.Nm |
.Nm |
was found in an input file. |
was found in an input file. |
It is replaced by a question mark. |
It is replaced by a question mark. |
|
.It Sy "unsupported escape sequence" |
|
.Pq roff |
|
An input file contains an escape sequence supported by GNU troff |
|
or Heirloom troff but not by |
|
.Nm , |
|
and it is likely that this will cause information loss |
|
or considerable misformatting. |
.It Sy "unsupported roff request" |
.It Sy "unsupported roff request" |
.Pq roff |
.Pq roff |
An input file contains a |
An input file contains a |