version 1.36, 2009/09/15 08:16:20 |
version 1.38, 2009/09/21 13:44:56 |
|
|
. |
. |
.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 |
|
|
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 241 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 260 To page manuals to the terminal: |
|
Line 277 To page manuals to the terminal: |
|
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less |
. |
. |
.Pp |
.Pp |
|
To produce HTML manuals with |
|
.Pa http://localhost/ |
|
as the base URI: |
|
.Pp |
|
.D1 % mandoc \-Thtml -obase=http://localhost/ mdoc.7 > mdoc.7.html |
|
.Pp |
To check over a large set of manuals: |
To check over a large set of manuals: |
. |
. |
.Pp |
.Pp |
Line 275 Each input and output format is separately noted. |
|
Line 298 Each input and output format is separately noted. |
|
. |
. |
. |
. |
.Ss ASCII output |
.Ss ASCII output |
.Bl -bullet -compact -width Ds |
.Bl -bullet -compact |
.It |
.It |
The |
The |
.Sq \e~ |
.Sq \e~ |