version 1.41, 2009/10/03 16:36:06 |
version 1.46, 2009/11/05 10:16:01 |
|
|
.Nm mandoc |
.Nm mandoc |
.Op Fl f Ns Ar option... |
.Op Fl f Ns Ar option... |
.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 V |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
Line 54 Input format. See |
|
Line 54 Input format. See |
|
for available formats. Defaults to |
for available formats. Defaults to |
.Fl m Ns Ar andoc . |
.Fl m Ns Ar andoc . |
. |
. |
.It Fl o Ns Ar option... |
.It Fl O Ns Ar option... |
Comma-separated output options. See |
Comma-separated output options. See |
.Sx Output Options |
.Sx Output Options |
for details. |
for details. |
Line 228 When rewinding the scope of a block macro, forces the |
|
Line 228 When rewinding the scope of a block macro, forces the |
|
scope violations. This can seriously mangle the resulting tree. |
scope violations. This can seriously mangle the resulting tree. |
.Pq mdoc only |
.Pq mdoc only |
. |
. |
|
.It Fl f Ns Ar ign-escape |
|
Ignore invalid escape sequences. |
|
This is the default, but the option can be used to override an earlier |
|
.Fl f Ns Ar strict . |
|
. |
.It Fl f Ns Ar no-ign-escape |
.It Fl f Ns Ar no-ign-escape |
Don't ignore invalid escape sequences. |
Don't ignore invalid escape sequences. |
. |
. |
Line 255 For the time being, only |
|
Line 260 For the time being, only |
|
.Fl T Ns Ar html |
.Fl T Ns Ar html |
is the only mode with output options: |
is the only mode with output options: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl o Ns Ar style=style.css |
.It Fl O Ns Ar style=style.css |
The file |
The file |
.Ar style.css |
.Ar style.css |
is used for an external style-sheet. This must be a valid absolute or |
is used for an external style-sheet. This must be a valid absolute or |
relative URI. |
relative URI. |
.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, |
|
|
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 Fl O Ns Ar man=fmt |
The string |
The string |
.Ar fmt , |
.Ar fmt , |
for example, |
for example, |
|
|
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. |
|
|
.It |
.It |
Sentences are unilaterally monospaced. |
Sentences are unilaterally monospaced. |
.El |
.El |
|
. |
|
.Ss HTML output |
|
.Bl -bullet -compact |
|
.It |
|
The |
|
.Xr mdoc 7 |
|
.Sq \&Bl \-hang |
|
and |
|
.Sq \&Bl \-tag |
|
list types render similarly (no break following overreached left-hand |
|
side) due to the expressive constraints of HTML. |
|
. |
|
.It |
|
The |
|
.Xr man 7 |
|
.Sq IP |
|
and |
|
.Sq TP |
|
lists render similarly. |
|
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
Line 393 the maximum size of an element attribute is determined |
|
Line 418 the maximum size of an element attribute is determined |
|
.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 |
formats with |
formats with |
.Fl o Ns Ar man=fmt . |
.Fl O Ns Ar man=fmt . |
|
.Pp |
|
The |
|
.Fl T Ns Ar html |
|
utility doesn't support the |
|
.Sq \ef |
|
and |
|
.Sq \es |
|
text decorations documented in |
|
.Xr mdoc 7 |
|
and |
|
.Xr man 7 . |