version 1.22, 2008/12/07 23:08:23 |
version 1.26, 2008/12/10 14:42:46 |
|
|
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdocml 1 alpha |
.Dt mdocml 1 |
.Os |
.Os |
.\" |
.\" |
.Sh NAME |
.Sh NAME |
|
|
.\" |
.\" |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocml |
.Nm mdocml |
.Op Fl vW |
.Op Fl v |
|
.Op Fl W Ns Ar err... |
.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 mdoc formatted manual source and passes results into an |
utility parses mdoc formatted manual source and passes results into an |
output filter. The current output filters are |
output filter. The current output filters are |
.Ar html |
.Fl f Ar html |
and |
and |
.Ar xml , |
.Fl f Ar xml . |
the default. Arguments common to all filters follow: |
By default, |
|
.Nm |
|
only validates its input. This may be explicitly directed with |
|
.Fl f Ar noop . |
|
Arguments common to all filters follow: |
.Bl -tag -width "\-o outfile" |
.Bl -tag -width "\-o outfile" |
.It Fl f Ar filter |
.It Fl f Ar filter |
The output filter name. |
The output filter name. |
.It Fl o Ar outfile |
.It Fl o Ar outfile |
Write output to |
Write output to |
.Ar outfile , |
.Ar outfile , |
which may be |
which may be |
.Dq \- |
.Dq \- |
for stdout. |
for stdout. This is meaningless for |
.It Fl W |
.Fl f Ar noop . |
Print warnings to stderr. |
.It Fl W Ns Ar err... |
|
Print warning messages. If set to |
|
.Fl W Ns Ar all , |
|
all warnings are printed; if |
|
.Fl W Ns Ar error , |
|
warnings are considered errors and cause utility termination. Multiple |
|
.Fl W |
|
arguments may be comma-separated, such as |
|
.Fl W Ns Ar error,all . |
|
.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 , |
|
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
reads from stdin and writes to stdout using the xml filter. |
reads from stdin and writes to stdout. |
.Pp |
.Pp |
.Ex -std mdocml |
.Ex -std mdocml |
.\" |
.\" |
|
.Ss Noop Filter |
|
The default noop |
|
.Dq validating |
|
filter simply validates its input; it produces no output beyond error |
|
and warning messages. |
|
.\" |
.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. This filter has no additional arguments. |
produces correctly-formatted XML output. This filter has no additional |
|
arguments. |
.Pp |
.Pp |
The XML filter creates an XML document where element names are their respective |
The XML filter creates an XML document where element names are their respective |
roff macro names. Each element name has an associated |
roff macro names. Each element name has an associated |
Line 76 namespace is for block bodies; and the |
|
Line 98 namespace is for block bodies; and the |
|
.Dq inline |
.Dq inline |
namespace is for in-line elements (such as |
namespace is for in-line elements (such as |
.Sq .Em ) . |
.Sq .Em ) . |
|
.\" |
.Ss HTML Filter |
.Ss HTML Filter |
The HTML filter, specified by |
The HTML filter, specified by |
.Fl f Ar html , |
.Fl f Ar html , |
Line 87 The CSS file location, which defaults to |
|
Line 110 The CSS file location, which defaults to |
|
.It Fl e |
.It Fl e |
Whether to embed the CSS file into the HTML prologue. |
Whether to embed the CSS file into the HTML prologue. |
.El |
.El |
|
.Pp |
|
By default, the HTML filter produces HTML-4.01 strict mark-up. The |
|
default CSS document styles the page as it would appear in a terminal |
|
window. |
.\" |
.\" |
.Sh EXAMPLES |
.Sh EXAMPLES |
To produce an HTML4-strict document |
To produce an HTML4-strict document |
Line 106 with the default namespace identifiers |
|
Line 133 with the default namespace identifiers |
|
and |
and |
.Li inline : |
.Li inline : |
.Pp |
.Pp |
.D1 % mdocml mdocml.1 |
.D1 % mdocml -Wall,error -fxml mdocml.1 |
|
.Pp |
|
The previous example will also halt on input document warnings. |
.\" |
.\" |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr groff 1 , |
.Xr groff 1 , |