version 1.10, 2008/11/30 21:41:35 |
version 1.13, 2008/12/01 15:32:36 |
|
|
.\" $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 DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility parses |
utility parses mdoc formatted manual source and passes results into an |
.Xr mdoc |
output filter. The only current output filter is |
formatted manual source and passes results into the output filter |
|
dictated by |
|
.Fl f Ar filter . |
|
The only current output filter is |
|
.Ar xml , |
.Ar xml , |
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 Fl f Ar filter |
.It Fl f Ar filter |
The output filter name, which defaults to |
The output filter name. |
.Ar xml . |
|
.It Fl o Ar outfile |
.It Fl o Ar outfile |
Place output in |
Write output to |
.Ar outfile , |
.Ar outfile , |
which may be |
which may be |
.Qq \- |
.Qq \- |
for stdout. The default is stdout. |
for stdout. |
.It Fl W |
.It Fl W |
Print compiler warnings to stderr. |
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 stdin. The default is stdin. |
for stdin. |
.El |
.El |
|
.Pp |
|
By default, |
|
.Nm |
|
reads from stdin and writes to stdout using the xml filter. |
|
.\" |
.Ss XML Filter |
.Ss XML Filter |
The XML filter, specified by |
The XML filter, specified by |
.Fl f Ar xml , |
.Fl f Ar xml , |
is the default filter. It creates an XML document where element names are |
is the default filter. It creates an XML document where element names are |
their respective roff macro names. Each element name has an associated |
their respective roff macro names. Each element name has an associated |
namespace, which is one of |
namespace, which is one of |
.Qq block , |
.Qq block |
.Qq inline , |
|
or |
or |
.Qq special , |
.Qq inline , |
corresponding to the display mode of a node. |
corresponding to the display mode of a node. The document root is |
.Pp |
always the |
Sample output follows: |
.Qq mdoc |
.Bd -literal |
element, in the default namespace. |
<?xml version="1.0" encoding="UTF-8"?> |
|
<block:mdoc> |
|
<block:Sh> |
|
<inline:Sh>NAME</inline:Sh> <inline:Nm>example</inline:Nm> |
|
<inline:Nd>example text</inline:Nd> |
|
</block:Sh> |
|
</block:mdoc> |
|
.Ed |
|
.\" The following requests should be uncommented and used where appropriate. |
|
.\" This next request is for sections 2, 3, and 9 function return values only. |
|
.\" .Sh RETURN VALUES |
|
.\" 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 102 or the necessary limitations of converting an ad hoc l |
|
Line 81 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 |