version 1.32, 2009/08/20 12:08:40 |
version 1.37, 2009/09/21 13:06:13 |
|
|
. |
. |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl V |
|
.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 W Ns Ar err... |
.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 err... |
.Op Ar infile... |
.Op Ar infile... |
. |
. |
. |
. |
Line 43 manual pages for display. The arguments are as follow |
|
Line 44 manual pages for display. The arguments are as follow |
|
. |
. |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl f Ns Ar option... |
.It Fl f Ns Ar option... |
Override default compiler behaviour. See |
Comma-separated compiler options. See |
.Sx Compiler Options |
.Sx Compiler Options |
for details. |
for details. |
. |
. |
Line 53 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 format |
|
Comma-separated output options. See |
|
.Sx Output Options |
|
for details. |
|
. |
.It Fl T Ns Ar output |
.It Fl T Ns Ar output |
Output format. See |
Output format. See |
.Sx Output Formats |
.Sx Output Formats |
Line 63 for available formats. Defaults to |
|
Line 69 for available formats. Defaults to |
|
Print version and exit. |
Print version and exit. |
. |
. |
.It Fl W Ns Ar err... |
.It Fl W Ns Ar err... |
Configure warning messages. Use |
Comma-separated warning options. Use |
.Fl W Ns Ar all |
.Fl W Ns Ar all |
to print warnings, |
to print warnings, |
.Fl W Ns Ar error |
.Fl W Ns Ar error |
Line 132 these rules are also applied to macro arguments when a |
|
Line 138 these rules are also applied to macro arguments when a |
|
. |
. |
.Pp |
.Pp |
White-space, in non-literal (normal) mode, is stripped from input and |
White-space, in non-literal (normal) mode, is stripped from input and |
replaced on output by a single space. Thus, if you wish to preserve |
replaced on output by a single space. Thus, if you wish to preserve multiple |
multiple spaces, they must be space-escaped |
spaces, they must be space-escaped or used in a literal display mode, e.g., |
.Sq \e\ |
|
or used in a literal display mode, e.g., |
|
.Sq \&Bd \-literal |
.Sq \&Bd \-literal |
in |
in |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
|
|
Produce 7-bit ASCII output, backspace-encoded for bold and underline |
Produce 7-bit ASCII output, backspace-encoded for bold and underline |
styles. This is the default. |
styles. This is the default. |
. |
. |
|
.It Fl T Ns Ar html |
|
Produce strict HTML-4.01 output, with a sane default style. |
|
. |
.It Fl T Ns Ar tree |
.It Fl T Ns Ar tree |
Produce an indented parse tree. |
Produce an indented parse tree. |
. |
. |
Line 211 corresponding filter in-order. |
|
Line 218 corresponding filter in-order. |
|
. |
. |
. |
. |
.Ss Compiler Options |
.Ss Compiler Options |
Default compiler behaviour may be overriden with the |
Default compiler behaviour may be overridden with the |
.Fl f |
.Fl f |
flag. |
flag. |
. |
. |
Line 243 Don't halt when encountering parse errors. Useful wit |
|
Line 250 Don't halt when encountering parse errors. Useful wit |
|
over a large set of manuals passed on the command line. |
over a large set of manuals passed on the command line. |
.El |
.El |
. |
. |
.Pp |
.Ss Output Options |
As with the |
For the time being, only |
.Fl W |
.Fl T Ns Ar html |
flag, multiple |
is the only mode with output options: |
.Fl f |
.Bl -tag -width Ds |
options may be grouped and delimited with a comma. Using |
.It Fl o Ns Ar style=style.css |
.Fl f Ns Ar ign-scope,no-ign-escape , |
The file |
for example, will try to ignore scope and not ignore character-escape |
.Ar style.css |
errors. |
is used for an external style-sheet. This must be a valid absolute or |
|
relative URI. |
|
.It Fl o Ns Ar base=http://base/ |
|
The URL |
|
.Ar http://base/ |
|
is used as a base URL for all relative links. This is useful when |
|
linking between documents via the |
|
.Sq \&Xr |
|
macro. |
|
.El |
. |
. |
. |
|
.Sh EXAMPLES |
.Sh EXAMPLES |
To page manuals to the terminal: |
To page manuals to the terminal: |
. |
. |
Line 286 special character doesn't produce expected behaviour i |
|
Line 301 special character doesn't produce expected behaviour i |
|
. |
. |
.It |
.It |
The |
The |
.Sq \&Bd \-literal |
.Sq \&Bd \-literal |
and |
and |
.Sq \&Bd \-unfilled |
.Sq \&Bd \-unfilled |
macros of |
macros of |
Line 318 does not assert a prior vertical break, just as it doe |
|
Line 333 does not assert a prior vertical break, just as it doe |
|
.It |
.It |
The |
The |
.Sq \&na |
.Sq \&na |
and |
|
.Sq \&Dt |
|
.Xr man 7 |
.Xr man 7 |
macros in |
macro in |
.Fl T Ns Ar ascii |
.Fl T Ns Ar ascii |
have no effect. |
has no effect. |
. |
. |
.It |
.It |
Words aren't hyphenated. |
Words aren't hyphenated. |