version 1.9, 2008/11/30 18:50:44 |
version 1.12, 2008/12/01 09:25:18 |
|
|
.\" $OpenBSD$ |
|
.\" |
.\" |
.\" The following requests are required for all man pages. |
|
.\" |
|
.\" Remove `\&' from the line below. |
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdocml 1 |
.Dt mdocml 1 |
.Os |
.Os |
|
|
.\" |
.\" |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocml |
.Nm mdocml |
.Op Fl vW |
.Op Fl W |
.Op Fl f Ar filter |
.Op Fl f Ar filter |
.Op Fl o Ar outfile |
.Op Fl o Ar outfile |
.Op Ar infile |
.Op Ar infile |
|
|
.Nm |
.Nm |
utility parses |
utility parses |
.Xr mdoc |
.Xr mdoc |
formatted manual source and passes results into the output filter |
formatted manual source and passes results into an output filter. The |
dictated by |
only current output filter is |
.Fl f Ar filter . |
.Ar xml , |
The only current output filter is |
|
.Ar validate , |
|
the default. The arguments are as follows: |
the default. The arguments are as follows: |
.Bl -tag -width "\-o outfile," |
.Bl -tag -width "\-o outfile" |
.It Sq Fl o Ar outfile , |
.It Fl f Ar filter |
Place output in |
The output filter name. |
|
.It Fl o Ar outfile |
|
Write output to |
.Ar outfile , |
.Ar outfile , |
which may be |
which may be |
.Qq \- |
.Qq \- |
for standard output. The default is standard output. |
for stdout. |
|
.It Fl W |
|
Print warnings to stderr. |
.It Ar infile |
.It Ar infile |
Read input from |
Read input from |
.Ar infile , |
.Ar infile , |
which may be |
which may be |
.Qq \- |
.Qq \- |
for standard input. The default is standard input. |
for stdin. |
.It Fl v |
|
Print messages (output depends on filter). |
|
.It Fl W |
|
Print warnings (output depends on filter). |
|
.El |
.El |
.Ss Validate Filter |
.Pp |
The validate filter, specified by |
By default, |
.Fl f Ar validate , |
.Nm |
is the default filter. It produces no output, so specifying |
reads from stdin and writes to stdout using the xml filter. |
.Fl o Ar outfile |
.\" |
results in an empty file. |
.Ss XML Filter |
.\" The following requests should be uncommented and used where appropriate. |
The XML filter, specified by |
.\" This next request is for sections 2, 3, and 9 function return values only. |
.Fl f Ar xml , |
.\" .Sh RETURN VALUES |
is the default filter. It creates an XML document where element names are |
|
their respective roff macro names. Each element name has an associated |
|
namespace, which is one of |
|
.Qq block |
|
or |
|
.Qq inline , |
|
corresponding to the display mode of a node. The document root is |
|
always the |
|
.Qq mdoc |
|
element, in the default namespace. |
.\" This next request is for sections 1, 6, 7 & 8 only. |
.\" This next request is for sections 1, 6, 7 & 8 only. |
.\" .Sh ENVIRONMENT |
.\" .Sh ENVIRONMENT |
.\" .Sh FILES |
.\" |
.\" .Sh EXAMPLES |
|
.\" This next request is for sections 1, 4, 6, and 8 only. |
|
.\" .Sh DIAGNOSTICS |
|
.\" The next request is for sections 2, 3, and 9 error and signal handling only. |
|
.\" .Sh ERRORS |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr groff 1 , |
.Xr groff 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
Line 85 or the necessary limitations of converting an ad hoc l |
|
Line 83 or the necessary limitations of converting an ad hoc l |
|
structured ones: |
structured ones: |
.Bl -enum -compact -offset indent |
.Bl -enum -compact -offset indent |
.It |
.It |
The engine doesn't understand |
The engine doesn't understand the |
.Sq \&Xo |
.Sq \&Xo , |
|
.Sq \&Xc , |
|
.Sq \&Ns , |
|
.Sq \&No , |
|
.Sq \&Db , |
|
.Sq \&Sm , |
|
.Sq \&Xc , |
and |
and |
.Sq \&Xc |
.Sq \&Xo |
troff macros. |
mdoc macros. |
.It |
.It |
All macro arguments may be quoted, instead of only some. |
All macro arguments may be quoted, instead of only some. |
.It |
.It |
Blank lines raise warnings. |
Blank lines raise errors. |
.It |
.It |
If terminating punctuation is found, then |
If terminating punctuation is found, then |
.Em all |
.Em all |