version 1.95, 2011/10/06 22:29:12 |
version 1.100, 2011/12/25 19:35:44 |
|
|
utility formats |
utility formats |
.Ux |
.Ux |
manual pages for display. |
manual pages for display. |
|
.Pp |
|
By default, |
|
.Nm |
|
reads |
|
.Xr mdoc 7 |
|
or |
|
.Xr man 7 |
|
text from stdin, implying |
|
.Fl m Ns Cm andoc , |
|
and produces |
|
.Fl T Ns Cm ascii |
|
output. |
|
.Pp |
The arguments are as follows: |
The arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl m Ns Ar format |
.It Fl m Ns Ar format |
Line 96 If multiple files are specified, |
|
Line 109 If multiple files are specified, |
|
.Nm |
.Nm |
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
.Pp |
|
By default, |
|
.Nm |
|
reads |
|
.Xr mdoc 7 |
|
or |
|
.Xr man 7 |
|
text from stdin, implying |
|
.Fl m Ns Cm andoc , |
|
and produces |
|
.Fl T Ns Cm ascii |
|
output. |
|
.Ss Input Formats |
.Ss Input Formats |
The |
The |
.Nm |
.Nm |
|
|
.Fl O |
.Fl O |
arguments are accepted: |
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Cm indent Ns = Ns Ar indent |
|
The left margin for normal text is set to |
|
.Ar indent |
|
blank characters instead of the default of five for |
|
.Xr mdoc 7 |
|
and seven for |
|
.Xr man 7 . |
|
Increasing this is not recommended; it may result in degraded formatting, |
|
for example overfull lines or ugly line breaks. |
.It Cm width Ns = Ns Ar width |
.It Cm width Ns = Ns Ar width |
The output width is set to |
The output width is set to |
.Ar width , |
.Ar width , |
|
|
arguments are accepted: |
arguments are accepted: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Cm fragment |
.It Cm fragment |
Do not emit doctype, html, and body elements. |
Omit the |
|
.Aq !DOCTYPE |
|
declaration and the |
|
.Aq html , |
|
.Aq head , |
|
and |
|
.Aq body |
|
elements and only emit the subtree below the |
|
.Aq body |
|
element. |
The |
The |
.Cm style |
.Cm style |
argument shall be unused. |
argument will be ignored. |
This is useful when embedding manual content within existing documents. |
This is useful when embedding manual content within existing documents. |
.It Cm includes Ns = Ns Ar fmt |
.It Cm includes Ns = Ns Ar fmt |
The string |
The string |
Line 316 Translate input format into |
|
Line 335 Translate input format into |
|
.Xr man 7 |
.Xr man 7 |
output format. |
output format. |
This is useful for distributing manual sources to legancy systems |
This is useful for distributing manual sources to legancy systems |
lacking |
lacking |
.Xr mdoc 7 |
.Xr mdoc 7 |
formatters. |
formatters. |
.Pp |
.Pp |
If |
If |
.Xr mdoc 7 |
.Xr mdoc 7 |
is passed as input, it is translated into |
is passed as input, it is translated into |
.Xr man 7 ; |
.Xr man 7 . |
if the input format is |
If the input format is |
.Xr man 7 , |
.Xr man 7 , |
it is parsed and re-outputted. |
the input is copied to the output, expanding any |
In either case, the |
|
.Xr roff 7 |
.Xr roff 7 |
.Sq so |
.Sq so |
macros are processed prior to producing output. |
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 |
.Ss PDF Output |
PDF-1.1 output may be generated by |
PDF-1.1 output may be generated by |
.Fl T Ns Cm pdf . |
.Fl T Ns Cm pdf . |