version 1.5, 2008/11/27 13:29: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 |
.\" |
.\" |
.Op foo |
|
.Sh NAME |
.Sh NAME |
.Nm mdocml |
.Nm mdocml |
.Nd compile manpage source into mark-up language |
.Nd compile manpage source into mark-up language |
.\" |
.\" |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocml |
.Nm mdocml |
|
.Op Fl W |
|
.Op Fl f Ar filter |
.Op Fl o Ar outfile |
.Op Fl o Ar outfile |
.Op Ar infile |
.Op Ar infile |
.\" |
.\" |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility compiles manpage source into a mark-up language. Its arguments |
utility parses |
are as follows: |
.Xr mdoc |
.Bl -tag -width "-o outfile" |
formatted manual source and passes results into an output filter. The |
|
only current output filter is |
|
.Ar xml , |
|
the default. The arguments are as follows: |
|
.Bl -tag -width "\-o outfile" |
|
.It Fl f Ar filter |
|
The output filter name. |
.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 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. |
.El |
.El |
.\" The following requests should be uncommented and used where appropriate. |
.Pp |
.\" This next request is for sections 2, 3, and 9 function return values only. |
By default, |
.\" .Sh RETURN VALUES |
.Nm |
|
reads from stdin and writes to stdout using the xml filter. |
|
.\" |
|
.Ss XML Filter |
|
The XML filter, specified by |
|
.Fl f Ar xml , |
|
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 57 for standard input. The default is standard input. |
|
Line 72 for standard input. The default is standard input. |
|
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Em Kristaps Dzonsons Aq kristaps@kth.se . |
.\" |
.\" |
.Sh CAVEATS |
.Sh CAVEATS |
The |
Most caveats of |
.Nm |
.Nm |
engine doesn't understand |
stem from ambiguities in |
.Sq \&Xo |
.Xr mdoc 7 |
|
or the necessary limitations of converting an ad hoc language into |
|
structured ones: |
|
.Bl -enum -compact -offset indent |
|
.It |
|
The engine doesn't understand the |
|
.Sq \&Xo , |
|
.Sq \&Xc , |
|
.Sq \&Ns , |
|
.Sq \&No , |
|
.Sq \&Db , |
|
.Sq \&Sm , |
|
.Sq \&Xc , |
and |
and |
.Sq \&Xc |
.Sq \&Xo |
troff macros. |
mdoc macros. |
.Pp |
.It |
.Em All |
All macro arguments may be quoted, instead of only some. |
macro arguments may be quoted, instead of only some. |
.It |
|
Blank lines raise errors. |
|
.It |
|
If terminating punctuation is found, then |
|
.Em all |
|
remaining tokens are flushed after line scope is closed, not just the |
|
last one. |
|
.El |
.\" .Sh BUGS |
.\" .Sh BUGS |