version 1.48, 2009/11/16 09:52:47 |
version 1.51, 2010/03/22 14:03:03 |
Line 167 styles. This is the default. See |
|
Line 167 styles. This is the default. See |
|
Produce strict HTML-4.01 output, with a sane default style. See |
Produce strict HTML-4.01 output, with a sane default style. See |
.Sx HTML Output . |
.Sx HTML Output . |
. |
. |
|
.It Fl T Ns Ar xhtml |
|
Produce strict XHTML-1.0 output, with a sane default style. See |
|
.Sx XHTML Output . |
|
. |
.It Fl T Ns Ar tree |
.It Fl T Ns Ar tree |
Produce an indented parse tree. |
Produce an indented parse tree. |
. |
. |
|
|
.It Fl O Ns Ar includes=fmt |
.It Fl O Ns Ar includes=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 |
|
|
.It Fl O Ns Ar man=fmt |
.It Fl O Ns Ar man=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 |
Line 260 present a hyperlink. |
|
Line 264 present a hyperlink. |
|
This section documents output details of |
This section documents output details of |
.Nm . |
.Nm . |
In general, output conforms to the traditional manual style of a header, |
In general, output conforms to the traditional manual style of a header, |
a body composed of sections and sub-sections, and a footer. |
a body composed of sections and sub-sections, and a footer. |
.Pp |
.Pp |
The text style of output characters (non-macro characters, punctuation, |
The text style of output characters (non-macro characters, punctuation, |
and white-space) is dictated by context. |
and white-space) is dictated by context. |
Line 307 however, these rules are also applied to macro argumen |
|
Line 311 however, these rules are also applied to macro argumen |
|
. |
. |
. |
. |
.Ss ASCII Output |
.Ss ASCII Output |
Output produced by |
Output produced by |
.Fl T Ns Ar ascii , |
.Fl T Ns Ar ascii , |
which is the default, is rendered in standard 7-bit ASCII documented in |
which is the default, is rendered in standard 7-bit ASCII documented in |
.Xr ascii 7 . |
.Xr ascii 7 . |
Line 333 exceed this limit. |
|
Line 337 exceed this limit. |
|
.Ss HTML Output |
.Ss HTML Output |
Output produced by |
Output produced by |
.Fl T Ns Ar html |
.Fl T Ns Ar html |
comforms to HTML-4.01 strict. |
conforms to HTML-4.01 strict. |
.Pp |
.Pp |
Font styles and page structure are applied using CSS2. By default, no |
Font styles and page structure are applied using CSS2. By default, no |
font style is applied to any text, although CSS2 is hard-coded to format |
font style is applied to any text, although CSS2 is hard-coded to format |
Line 348 cause rendered documents to appear as they do in |
|
Line 352 cause rendered documents to appear as they do in |
|
Special characters are rendered in decimal-encoded UTF-8. |
Special characters are rendered in decimal-encoded UTF-8. |
. |
. |
. |
. |
|
.Ss XHTML Output |
|
Output produced by |
|
.Fl T Ns Ar 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 EXAMPLES |
.Sh EXAMPLES |
To page manuals to the terminal: |
To page manuals to the terminal: |
. |
. |
Line 379 Each input and output format is separately noted. |
|
Line 394 Each input and output format is separately noted. |
|
.Ss ASCII Compatibility |
.Ss ASCII Compatibility |
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
The |
The |
.Sq \e~ |
.Sq \e~ |
special character doesn't produce expected behaviour in |
special character doesn't produce expected behaviour in |
.Fl T Ns Ar ascii . |
.Fl T Ns Ar ascii . |
. |
. |
.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 |
|
|
are synonyms, as are \-filled and \-ragged. |
are synonyms, as are \-filled and \-ragged. |
. |
. |
.It |
.It |
In |
In |
.Xr groff 1 , |
.Xr groff 1 , |
the |
the |
.Sq \&Pa |
.Sq \&Pa |
Line 437 Sentences are unilaterally monospaced. |
|
Line 452 Sentences are unilaterally monospaced. |
|
.El |
.El |
. |
. |
. |
. |
.Ss HTML Compatibility |
.Ss HTML/XHTML Compatibility |
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
The |
The |
Line 446 escape will revert the font to the previous |
|
Line 461 escape will revert the font to the previous |
|
.Sq \ef |
.Sq \ef |
escape, not to the last rendered decoration, which is now dictated by |
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 |
CSS instead of hard-coded. It also will not span past the current |
scope, for the same reason. Note that in |
scope, for the same reason. Note that in |
.Sx ASCII Output |
.Sx ASCII Output |
mode, this will work fine. |
mode, this will work fine. |
.It |
.It |
Line 483 utility was written by |
|
Line 498 utility was written by |
|
.Sh CAVEATS |
.Sh CAVEATS |
The |
The |
.Fl T Ns Ar html |
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar xhtml |
CSS2 styling used for |
CSS2 styling used for |
.Fl m Ns Ar doc |
.Fl m Ns Ar doc |
input lists does not render properly in brain-dead browsers, such as |
input lists does not render properly in older browsers, such as Internet |
Internet Explorer 6 and earlier. |
Explorer 6 and earlier. |
.Pp |
.Pp |
In |
In |
.Fl T Ns Ar html , |
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar 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. Be aware of this when setting long link |
|
|
.Pp |
.Pp |
The |
The |
.Fl T Ns Ar html |
.Fl T Ns Ar html |
output mode doesn't render the |
and |
|
.Fl T Ns Ar xhtml |
|
output modes don't render the |
.Sq \es |
.Sq \es |
font size escape documented in |
font size escape documented in |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 . |
.Xr man 7 . |
|
.Pp |
|
Nesting elements within next-line element scopes of |
|
.Fl m Ar Ns an , |
|
such as |
|
.Sq br |
|
within an empty |
|
.Sq B , |
|
will confuse |
|
.Fl T Ns Ar html |
|
and |
|
.Fl T Ns Ar xhtml |
|
and cause it to forget the formatting. |