version 1.5, 2008/11/27 13:29:44 |
version 1.23, 2008/12/08 16:29:57 |
|
|
.\" $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 alpha |
.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 vW |
|
.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 mdoc formatted manual source and passes results into an |
are as follows: |
output filter. The current output filters are |
.Bl -tag -width "-o outfile" |
.Ar html |
|
and |
|
.Ar xml , |
|
the default. Arguments common to all filters follow: |
|
.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 - |
.Dq \- |
for standard output. The default is standard output. |
for stdout. |
|
.It Fl W |
|
Print warnings to stderr. |
|
.It Fl v |
|
Make warning and error messages verbose. |
.It Ar infile |
.It Ar infile |
Read input from |
Read input from |
.Ar infile , |
.Ar infile , |
which may be |
which may be |
.Qq - |
.Dq \- |
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 |
.\" This next request is for sections 1, 6, 7 & 8 only. |
reads from stdin and writes to stdout using the xml filter. |
.\" .Sh ENVIRONMENT |
.Pp |
.\" .Sh FILES |
.Ex -std mdocml |
.\" .Sh EXAMPLES |
.\" |
.\" This next request is for sections 1, 4, 6, and 8 only. |
.Ss XML Filter |
.\" .Sh DIAGNOSTICS |
The XML filter, specified by |
.\" The next request is for sections 2, 3, and 9 error and signal handling only. |
.Fl f Ar xml , |
.\" .Sh ERRORS |
is the default filter. This filter has no additional arguments. |
|
.Pp |
|
The XML filter creates an XML document where element names are their respective |
|
roff macro names. Each element name has an associated |
|
namespace, which is one of |
|
.Dq block , |
|
.Dq head , |
|
.Dq body , |
|
or |
|
.Dq inline , |
|
corresponding to the display mode of a node. The document root is |
|
always the |
|
.Dq mdoc |
|
element, in the default namespace; the |
|
.Dq head |
|
namespace is for block headers (such as |
|
.Sq .Ss |
|
and |
|
.Sq .Sh ) ; |
|
the |
|
.Dq body |
|
namespace is for block bodies; and the |
|
.Dq inline |
|
namespace is for in-line elements (such as |
|
.Sq .Em ) . |
|
.Ss HTML Filter |
|
The HTML filter, specified by |
|
.Fl f Ar html , |
|
accepts the following filter-specific arguments: |
|
.Bl -tag -width "\-c css" |
|
.It Fl c Ar css |
|
The CSS file location, which defaults to |
|
.Ar mdocml.css . |
|
.It Fl e |
|
Whether to embed the CSS file into the HTML prologue. |
|
.El |
|
.\" |
|
.Sh EXAMPLES |
|
To produce an HTML4-strict document |
|
.Pa mdocml.html |
|
for |
|
.Pa mdocml.1 |
|
with the default, embedded style-sheet: |
|
.Pp |
|
.D1 % mdocml -fhtml -e -o mdocml.html mdocml.1 |
|
.Pp |
|
To create an XML document on standard output from |
|
.Pa mdocml.1 |
|
with the default namespace identifiers |
|
.Li head , |
|
.Li body , |
|
.Li block |
|
and |
|
.Li inline : |
|
.Pp |
|
.D1 % mdocml mdocml.1 |
|
.\" |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr groff 1 , |
.Xr groff 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
Line 60 utility was written by |
|
Line 123 utility was written by |
|
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An 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 \&No , |
|
.Sq \&Db , |
|
.Sq \&Xc , |
and |
and |
.Sq \&Xc |
.Sq \&Xo |
troff macros. |
mdoc macros. |
|
.It |
|
All 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 |
.Pp |
.Pp |
.Em All |
The roff engine in |
macro arguments may be quoted, instead of only some. |
.Nm |
|
produces text in-line; thus, output may already be partially written by |
|
the time an error is encountered. |
.\" .Sh BUGS |
.\" .Sh BUGS |