version 1.45, 2009/10/26 15:44:51 |
version 1.100, 2011/12/25 19:35:44 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MANDOC 1 |
.Dt MANDOC 1 |
.Os |
.Os |
. |
|
. |
|
.Sh NAME |
.Sh NAME |
.Nm mandoc |
.Nm mandoc |
.Nd format and display UNIX manuals |
.Nd format and display UNIX manuals |
. |
|
. |
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl f Ns Ar option... |
.Op Fl V |
.Op Fl m Ns Ar format |
.Op Fl m Ns Ar format |
.Op Fl O Ns Ar option... |
.Op Fl O Ns Ar option |
.Op Fl T Ns Ar output |
.Op Fl T Ns Ar output |
.Op Fl V |
.Op Fl W Ns Ar level |
.Op Fl W Ns Ar err... |
.Op Ar |
.Op Ar infile... |
|
. |
|
. |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility formats |
utility formats |
.Ux |
.Ux |
manual pages for display. The arguments are as follows: |
manual pages for display. |
. |
|
.Bl -tag -width Ds |
|
.It Fl f Ns Ar option... |
|
Comma-separated compiler options. See |
|
.Sx Compiler Options |
|
for details. |
|
. |
|
.It Fl m Ns Ar format |
|
Input format. See |
|
.Sx Input Formats |
|
for available formats. Defaults to |
|
.Fl m Ns Ar andoc . |
|
. |
|
.It Fl O Ns Ar option... |
|
Comma-separated output options. See |
|
.Sx Output Options |
|
for details. |
|
. |
|
.It Fl T Ns Ar output |
|
Output format. See |
|
.Sx Output Formats |
|
for available formats. Defaults to |
|
.Fl T Ns Ar ascii . |
|
. |
|
.It Fl V |
|
Print version and exit. |
|
. |
|
.It Fl W Ns Ar err... |
|
Comma-separated warning options. Use |
|
.Fl W Ns Ar all |
|
to print warnings, |
|
.Fl W Ns Ar error |
|
for warnings to be considered errors and cause utility |
|
termination. Multiple |
|
.Fl W |
|
arguments may be comma-separated, such as |
|
.Fl W Ns Ar error,all . |
|
. |
|
.It Ar infile... |
|
Read input from zero or more |
|
.Ar infile . |
|
If unspecified, reads from stdin. If multiple files are specified, |
|
.Nm |
|
will halt with the first failed parse. |
|
.El |
|
. |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
|
|
or |
or |
.Xr man 7 |
.Xr man 7 |
text from stdin, implying |
text from stdin, implying |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
and prints 78-column backspace-encoded output to stdout as if |
and produces |
.Fl T Ns Ar ascii |
.Fl T Ns Cm ascii |
were provided. |
output. |
. |
|
.Pp |
.Pp |
.Ex -std mandoc |
The arguments are as follows: |
. |
.Bl -tag -width Ds |
. |
.It Fl m Ns Ar format |
.Ss Punctuation and Spacing |
Input format. |
If punctuation is set apart from words, such as in the phrase |
See |
.Dq to be \&, or not to be , |
.Sx Input Formats |
it's processed by |
for available formats. |
.Nm |
Defaults to |
according to the following rules: opening punctuation |
.Fl m Ns Cm andoc . |
.Po |
.It Fl O Ns Ar option |
.Sq \&( , |
Comma-separated output options. |
.Sq \&[ , |
.It Fl T Ns Ar output |
|
Output format. |
|
See |
|
.Sx Output Formats |
|
for available formats. |
|
Defaults to |
|
.Fl T Ns Cm ascii . |
|
.It Fl V |
|
Print version and exit. |
|
.It Fl W Ns Ar level |
|
Specify the minimum message |
|
.Ar level |
|
to be reported on the standard error output and to affect the exit status. |
|
The |
|
.Ar level |
|
can be |
|
.Cm warning , |
|
.Cm error , |
|
or |
|
.Cm fatal . |
|
The default is |
|
.Fl W Ns Cm fatal ; |
|
.Fl W Ns Cm all |
|
is an alias for |
|
.Fl W Ns Cm warning . |
|
See |
|
.Sx EXIT STATUS |
and |
and |
.Sq \&{ |
.Sx DIAGNOSTICS |
.Pc |
for details. |
is not followed by a space; closing punctuation |
|
.Po |
|
.Sq \&. , |
|
.Sq \&, , |
|
.Sq \&; , |
|
.Sq \&: , |
|
.Sq \&? , |
|
.Sq \&! , |
|
.Sq \&) , |
|
.Sq \&] |
|
and |
|
.Sq \&} |
|
.Pc |
|
is not preceded by whitespace. |
|
. |
|
.Pp |
.Pp |
If the input is |
The special option |
.Xr mdoc 7 , |
.Fl W Ns Cm stop |
these rules are also applied to macro arguments when appropriate. |
tells |
. |
.Nm |
.Pp |
to exit after parsing a file that causes warnings or errors of at least |
White-space, in non-literal (normal) mode, is stripped from input and |
the requested level. |
replaced on output by a single space. Thus, if you wish to preserve multiple |
No formatted output will be produced from that file. |
spaces, they must be space-escaped or used in a literal display mode, e.g., |
If both a |
.Sq \&Bd \-literal |
.Ar level |
in |
and |
.Xr mdoc 7 . |
.Cm stop |
. |
are requested, they can be joined with a comma, for example |
. |
.Fl W Ns Cm error , Ns Cm stop . |
|
.It Ar file |
|
Read input from zero or more files. |
|
If unspecified, reads from stdin. |
|
If multiple files are specified, |
|
.Nm |
|
will halt with the first failed parse. |
|
.El |
.Ss Input Formats |
.Ss Input Formats |
The |
The |
.Nm |
.Nm |
|
|
and |
and |
.Xr man 7 |
.Xr man 7 |
input with |
input with |
.Fl m Ns Ar doc |
.Fl m Ns Cm doc |
and |
and |
.Fl m Ns Ar an , |
.Fl m Ns Cm an , |
respectively. The |
respectively. |
|
The |
.Xr mdoc 7 |
.Xr mdoc 7 |
format is |
format is |
.Em strongly |
.Em strongly |
recommended; |
recommended; |
.Xr man 7 |
.Xr man 7 |
should only be used for legacy manuals. |
should only be used for legacy manuals. |
. |
|
.Pp |
.Pp |
A third option, |
A third option, |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
which is also the default, determines encoding on-the-fly: if the first |
which is also the default, determines encoding on-the-fly: if the first |
non-comment macro is |
non-comment macro is |
.Sq \&Dd |
.Sq \&Dd |
|
|
parser is used; otherwise, the |
parser is used; otherwise, the |
.Xr man 7 |
.Xr man 7 |
parser is used. |
parser is used. |
. |
|
.Pp |
.Pp |
If multiple |
If multiple |
files are specified with |
files are specified with |
.Fl m Ns Ar andoc , |
.Fl m Ns Cm andoc , |
each has its file-type determined this way. If multiple files are |
each has its file-type determined this way. |
|
If multiple files are |
specified and |
specified and |
.Fl m Ns Ar doc |
.Fl m Ns Cm doc |
or |
or |
.Fl m Ns Ar an |
.Fl m Ns Cm an |
is specified, then this format is used exclusively. |
is specified, then this format is used exclusively. |
. |
|
. |
|
.Ss Output Formats |
.Ss Output Formats |
The |
The |
.Nm |
.Nm |
utility accepts the following |
utility accepts the following |
.Fl T |
.Fl T |
arguments: |
arguments, which correspond to output modes: |
. |
.Bl -tag -width "-Tlocale" |
.Bl -tag -width Ds |
.It Fl T Ns Cm ascii |
.It Fl T Ns Ar ascii |
Produce 7-bit ASCII output. |
Produce 7-bit ASCII output, backspace-encoded for bold and underline |
This is the default. |
styles. This is the default. |
See |
. |
.Sx ASCII Output . |
.It Fl T Ns Ar html |
.It Fl T Ns Cm html |
Produce strict HTML-4.01 output, with a sane default style. |
Produce strict CSS1/HTML-4.01 output. |
. |
See |
.It Fl T Ns Ar tree |
.Sx HTML Output . |
Produce an indented parse tree. |
.It Fl T Ns Cm lint |
. |
|
.It Fl T Ns Ar lint |
|
Parse only: produce no output. |
Parse only: produce no output. |
|
Implies |
|
.Fl W Ns Cm warning . |
|
.It Fl T Ns Cm locale |
|
Encode output using the current locale. |
|
See |
|
.Sx Locale Output . |
|
.It Fl T Ns Cm man |
|
Produce |
|
.Xr man 7 |
|
format output. |
|
See |
|
.Sx Man Output . |
|
.It Fl T Ns Cm pdf |
|
Produce PDF output. |
|
See |
|
.Sx PDF Output . |
|
.It Fl T Ns Cm ps |
|
Produce PostScript output. |
|
See |
|
.Sx PostScript Output . |
|
.It Fl T Ns Cm tree |
|
Produce an indented parse tree. |
|
.It Fl T Ns Cm utf8 |
|
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. |
|
See |
|
.Sx XHTML Output . |
.El |
.El |
. |
|
.Pp |
.Pp |
If multiple input files are specified, these will be processed by the |
If multiple input files are specified, these will be processed by the |
corresponding filter in-order. |
corresponding filter in-order. |
. |
.Ss ASCII Output |
. |
Output produced by |
.Ss Compiler Options |
.Fl T Ns Cm ascii , |
Default compiler behaviour may be overridden with the |
which is the default, is rendered in standard 7-bit ASCII documented in |
.Fl f |
.Xr ascii 7 . |
flag. |
.Pp |
. |
Font styles are applied by using back-spaced encoding such that an |
|
underlined character |
|
.Sq c |
|
is rendered as |
|
.Sq _ Ns \e[bs] Ns c , |
|
where |
|
.Sq \e[bs] |
|
is the back-space character number 8. |
|
Emboldened characters are rendered as |
|
.Sq c Ns \e[bs] Ns c . |
|
.Pp |
|
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. |
|
.Pp |
|
The following |
|
.Fl O |
|
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl f Ns Ar ign-scope |
.It Cm indent Ns = Ns Ar indent |
When rewinding the scope of a block macro, forces the compiler to ignore |
The left margin for normal text is set to |
scope violations. This can seriously mangle the resulting tree. |
.Ar indent |
.Pq mdoc only |
blank characters instead of the default of five for |
. |
.Xr mdoc 7 |
.It Fl f Ns Ar ign-escape |
and seven for |
Ignore invalid escape sequences. |
.Xr man 7 . |
This is the default, but the option can be used to override an earlier |
Increasing this is not recommended; it may result in degraded formatting, |
.Fl f Ns Ar strict . |
for example overfull lines or ugly line breaks. |
. |
.It Cm width Ns = Ns Ar width |
.It Fl f Ns Ar no-ign-escape |
The output width is set to |
Don't ignore invalid escape sequences. |
.Ar width , |
. |
which will normalise to \(>=60. |
.It Fl f Ns Ar no-ign-macro |
|
Do not ignore unknown macros at the start of input lines. |
|
. |
|
.It Fl f Ns Ar no-ign-chars |
|
Do not ignore disallowed characters. |
|
. |
|
.It Fl f Ns Ar strict |
|
Implies |
|
.Fl f Ns Ar no-ign-escape , |
|
.Fl f Ns Ar no-ign-macro |
|
and |
|
.Fl f Ns Ar no-ign-chars . |
|
. |
|
.It Fl f Ns Ar ign-errors |
|
Don't halt when encountering parse errors. Useful with |
|
.Fl T Ns Ar lint |
|
over a large set of manuals passed on the command line. |
|
.El |
.El |
. |
.Ss HTML Output |
.Ss Output Options |
Output produced by |
For the time being, only |
.Fl T Ns Cm html |
.Fl T Ns Ar html |
conforms to HTML-4.01 strict. |
is the only mode with output options: |
.Pp |
|
The |
|
.Pa example.style.css |
|
file documents style-sheet classes available for customising output. |
|
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 |
|
browser. |
|
.Pp |
|
Special characters are rendered in decimal-encoded UTF\-8. |
|
.Pp |
|
The following |
|
.Fl O |
|
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl O Ns Ar style=style.css |
.It Cm fragment |
The file |
Omit the |
.Ar style.css |
.Aq !DOCTYPE |
is used for an external style-sheet. This must be a valid absolute or |
declaration and the |
relative URI. |
.Aq html , |
.It Fl O Ns Ar includes=fmt |
.Aq head , |
|
and |
|
.Aq body |
|
elements and only emit the subtree below the |
|
.Aq body |
|
element. |
|
The |
|
.Cm style |
|
argument will be ignored. |
|
This is useful when embedding manual content within existing documents. |
|
.It Cm includes Ns = Ns Ar fmt |
The string |
The string |
.Ar fmt , |
.Ar fmt , |
for example, |
for example, |
.Ar ../src/%I.html , |
.Ar ../src/%I.html , |
is used as a template for linked header files (usually via the |
is used as a template for linked header files (usually via the |
.Sq \&In |
.Sq \&In |
macro). Instances of |
macro). |
|
Instances of |
.Sq \&%I |
.Sq \&%I |
are replaced with the include filename. The default is not to present a |
are replaced with the include filename. |
|
The default is not to present a |
hyperlink. |
hyperlink. |
.It Fl O Ns Ar man=fmt |
.It Cm man Ns = Ns Ar fmt |
The string |
The string |
.Ar fmt , |
.Ar fmt , |
for example, |
for example, |
.Ar ../html%S/%N.%S.html , |
.Ar ../html%S/%N.%S.html , |
is used as a template for linked manuals (usually via the |
is used as a template for linked manuals (usually via the |
.Sq \&Xr |
.Sq \&Xr |
macro). Instances of |
macro). |
|
Instances of |
.Sq \&%N |
.Sq \&%N |
and |
and |
.Sq %S |
.Sq %S |
are replaced with the linked manual's name and section, respectively. |
are replaced with the linked manual's name and section, respectively. |
If no section is included, section 1 is assumed. The default is not to |
If no section is included, section 1 is assumed. |
|
The default is not to |
present a hyperlink. |
present a hyperlink. |
|
.It Cm style Ns = Ns Ar style.css |
|
The file |
|
.Ar style.css |
|
is used for an external style-sheet. |
|
This must be a valid absolute or |
|
relative URI. |
.El |
.El |
. |
.Ss Locale Output |
|
Locale-depending output encoding is triggered with |
|
.Fl T Ns Cm locale . |
|
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 |
|
.Fl T Ns Cm ascii . |
|
See |
|
.Sx ASCII Output |
|
for font style specification and available command-line arguments. |
|
.Ss Man Output |
|
Translate input format into |
|
.Xr man 7 |
|
output format. |
|
This is useful for distributing manual sources to legancy systems |
|
lacking |
|
.Xr mdoc 7 |
|
formatters. |
|
.Pp |
|
If |
|
.Xr mdoc 7 |
|
is passed as input, it is translated into |
|
.Xr man 7 . |
|
If the input format is |
|
.Xr man 7 , |
|
the input is copied to the output, expanding any |
|
.Xr roff 7 |
|
.Sq so |
|
requests. |
|
The parser is also run, and as usual, the |
|
.Fl W |
|
level controls which |
|
.Sx DIAGNOSTICS |
|
are displayed before copying the input to the output. |
|
.Ss PDF Output |
|
PDF-1.1 output may be generated by |
|
.Fl T Ns Cm pdf . |
|
See |
|
.Sx PostScript Output |
|
for |
|
.Fl O |
|
arguments and defaults. |
|
.Ss PostScript Output |
|
PostScript |
|
.Qq Adobe-3.0 |
|
Level-2 pages may be generated by |
|
.Fl T Ns Cm ps . |
|
Output pages default to letter sized and are rendered in the Times font |
|
family, 11-point. |
|
Margins are calculated as 1/9 the page length and width. |
|
Line-height is 1.4m. |
|
.Pp |
|
Special characters are rendered as in |
|
.Sx ASCII Output . |
|
.Pp |
|
The following |
|
.Fl O |
|
arguments are accepted: |
|
.Bl -tag -width Ds |
|
.It Cm paper Ns = Ns Ar name |
|
The paper size |
|
.Ar name |
|
may be one of |
|
.Ar a3 , |
|
.Ar a4 , |
|
.Ar a5 , |
|
.Ar legal , |
|
or |
|
.Ar letter . |
|
You may also manually specify dimensions as |
|
.Ar NNxNN , |
|
width by height in millimetres. |
|
If an unknown value is encountered, |
|
.Ar letter |
|
is used. |
|
.El |
|
.Ss UTF\-8 Output |
|
Use |
|
.Fl T Ns Cm utf8 |
|
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 EXIT STATUS |
|
The |
|
.Nm |
|
utility exits with one of the following values, controlled by the message |
|
.Ar level |
|
associated with the |
|
.Fl W |
|
option: |
|
.Pp |
|
.Bl -tag -width Ds -compact |
|
.It 0 |
|
No warnings or errors occurred, or those that did were ignored because |
|
they were lower than the requested |
|
.Ar level . |
|
.It 2 |
|
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 |
|
.Fl W Ns Cm error |
|
or |
|
.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 |
|
error accessing input files. |
|
Such errors cause |
|
.Nm |
|
to exit at once, possibly in the middle of parsing or formatting a file. |
|
.El |
|
.Pp |
|
Note that selecting |
|
.Fl T Ns Cm lint |
|
output mode implies |
|
.Fl W Ns Cm warning . |
.Sh EXAMPLES |
.Sh EXAMPLES |
To page manuals to the terminal: |
To page manuals to the terminal: |
. |
|
.Pp |
.Pp |
.D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less |
.Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less |
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less |
. |
|
.Pp |
.Pp |
To produce HTML manuals with |
To produce HTML manuals with |
.Ar style.css |
.Ar style.css |
as the style-sheet: |
as the style-sheet: |
.Pp |
.Pp |
.D1 % mandoc \-Thtml -ostyle=style.css mdoc.7 > mdoc.7.html |
.Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html |
.Pp |
.Pp |
To check over a large set of manuals: |
To check over a large set of manuals: |
. |
|
.Pp |
.Pp |
.Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]` |
.Dl $ mandoc \-Tlint `find /usr/src -name \e*\e.[1-9]` |
. |
.Pp |
. |
To produce a series of PostScript manuals for A4 paper: |
|
.Pp |
|
.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps |
|
.Pp |
|
Convert a modern |
|
.Xr mdoc 7 |
|
manual to the older |
|
.Xr man 7 |
|
format, for use on systems lacking an |
|
.Xr mdoc 7 |
|
parser: |
|
.Pp |
|
.Dl $ mandoc \-Tman foo.mdoc \*(Gt foo.man |
|
.Sh DIAGNOSTICS |
|
Standard error messages reporting parsing errors are prefixed by |
|
.Pp |
|
.Sm off |
|
.D1 Ar file : line : column : \ level : |
|
.Sm on |
|
.Pp |
|
where the fields have the following meanings: |
|
.Bl -tag -width "column" |
|
.It Ar file |
|
The name of the input file causing the message. |
|
.It Ar line |
|
The line number in that input file. |
|
Line numbering starts at 1. |
|
.It Ar column |
|
The column number in that input file. |
|
Column numbering starts at 1. |
|
If the issue is caused by a word, the column number usually |
|
points to the first character of the word. |
|
.It Ar level |
|
The message level, printed in capital letters. |
|
.El |
|
.Pp |
|
Message levels have the following meanings: |
|
.Bl -tag -width "warning" |
|
.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 |
|
.Nm |
|
does not implement it yet. |
|
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. |
|
.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 |
|
rendering can be produced. |
|
Documents causing warnings may render poorly when using other |
|
formatting tools instead of |
|
.Nm . |
|
.El |
|
.Pp |
|
Messages of the |
|
.Cm warning |
|
and |
|
.Cm error |
|
levels are hidden unless their level, or a lower level, is requested using a |
|
.Fl W |
|
option or |
|
.Fl T Ns Cm lint |
|
output mode. |
|
.Pp |
|
The |
|
.Nm |
|
utility may also print messages related to invalid command line arguments |
|
or operating system errors, for example when memory is exhausted or |
|
input files cannot be read. |
|
Such messages do not carry the prefix described above. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section summarises |
This section summarises |
.Nm |
.Nm |
compatibility with |
compatibility with GNU troff. |
.Xr groff 1 . |
|
Each input and output format is separately noted. |
Each input and output format is separately noted. |
. |
.Ss ASCII Compatibility |
. |
|
.Ss ASCII output |
|
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
The |
Unrenderable unicode codepoints specified with |
.Sq \e~ |
.Sq \e[uNNNN] |
special character doesn't produce expected behaviour in |
escapes are printed as |
.Fl T Ns Ar ascii . |
.Sq \&? |
. |
in mandoc. |
|
In GNU troff, these raise an error. |
.It |
.It |
The |
The |
.Sq \&Bd \-literal |
.Sq \&Bd \-literal |
and |
and |
.Sq \&Bd \-unfilled |
.Sq \&Bd \-unfilled |
macros of |
macros of |
.Xr mdoc 7 |
.Xr mdoc 7 |
in |
in |
.Fl T Ns Ar ascii |
.Fl T Ns Cm ascii |
are synonyms, as are \-filled and \-ragged. |
are synonyms, as are \-filled and \-ragged. |
. |
|
.It |
.It |
In |
In historic GNU troff, the |
.Xr groff 1 , |
|
the |
|
.Sq \&Pa |
.Sq \&Pa |
.Xr mdoc 7 |
.Xr mdoc 7 |
macro does not underline when scoped under an |
macro does not underline when scoped under an |
.Sq \&It |
.Sq \&It |
in the FILES section. This behaves correctly in |
in the FILES section. |
|
This behaves correctly in |
.Nm . |
.Nm . |
. |
|
.It |
.It |
A list or display following |
A list or display following the |
.Sq \&Ss |
.Sq \&Ss |
.Xr mdoc 7 |
.Xr mdoc 7 |
macro in |
macro in |
.Fl T Ns Ar ascii |
.Fl T Ns Cm ascii |
does not assert a prior vertical break, just as it doesn't with |
does not assert a prior vertical break, just as it doesn't with |
.Sq \&Sh . |
.Sq \&Sh . |
. |
|
.It |
.It |
The |
The |
.Sq \&na |
.Sq \&na |
.Xr man 7 |
.Xr man 7 |
macro in |
macro in |
.Fl T Ns Ar ascii |
.Fl T Ns Cm ascii |
has no effect. |
has no effect. |
. |
|
.It |
.It |
Words aren't hyphenated. |
Words aren't hyphenated. |
. |
|
.It |
|
In normal mode (not a literal block), blocks of spaces aren't preserved, |
|
so double spaces following sentence closure are reduced to a single space; |
|
.Xr groff 1 |
|
retains spaces. |
|
. |
|
.It |
|
Sentences are unilaterally monospaced. |
|
.El |
.El |
. |
.Ss HTML/XHTML Compatibility |
.Ss HTML output |
|
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
The |
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 |
.Xr mdoc 7 |
.Sq \&Bl \-hang |
.Sq \&Bl \-hang |
and |
and |
.Sq \&Bl \-tag |
.Sq \&Bl \-tag |
list types render similarly (no break following overreached left-hand |
list types render similarly (no break following overreached left-hand |
side) due to the expressive constraints of HTML. |
side) due to the expressive constraints of HTML. |
. |
|
.It |
.It |
The |
The |
.Xr man 7 |
.Xr man 7 |
|
|
.Sq TP |
.Sq TP |
lists render similarly. |
lists render similarly. |
.El |
.El |
.\" SECTION |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr eqn 7 , |
|
.Xr man 7 , |
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr man 7 |
.Xr roff 7 , |
. |
.Xr tbl 7 |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons , |
. |
.Mt kristaps@bsd.lv . |
.Sh CAVEATS |
.Sh CAVEATS |
In |
In |
.Fl T Ns Ar html , |
.Fl T Ns Cm html |
|
and |
|
.Fl T Ns Cm xhtml , |
the maximum size of an element attribute is determined by |
the maximum size of an element attribute is determined by |
.Dv BUFSIZ , |
.Dv BUFSIZ , |
which is usually 1024 bytes. Be aware of this when setting long link |
which is usually 1024 bytes. |
formats with |
Be aware of this when setting long link |
.Fl O Ns Ar man=fmt . |
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. |