version 1.6, 2008/11/27 17:27:50 |
version 1.9, 2008/11/30 18:50:44 |
|
|
.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 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 |
are as follows: |
.Xr mdoc |
.Bl -tag -width "\-o outfile" |
formatted manual source and passes results into the output filter |
.It Fl o Ar outfile |
dictated by |
|
.Fl f Ar filter . |
|
The only current output filter is |
|
.Ar validate , |
|
the default. The arguments are as follows: |
|
.Bl -tag -width "\-o outfile," |
|
.It Sq Fl o Ar outfile , |
Place output in |
Place output in |
.Ar outfile , |
.Ar outfile , |
which may be |
which may be |
|
|
which may be |
which may be |
.Qq \- |
.Qq \- |
for standard input. The default is standard input. |
for standard input. The default is standard input. |
|
.It Fl v |
|
Print messages (output depends on filter). |
.It Fl W |
.It Fl W |
Print warnings. |
Print warnings (output depends on filter). |
.El |
.El |
|
.Ss Validate Filter |
|
The validate filter, specified by |
|
.Fl f Ar validate , |
|
is the default filter. It produces no output, so specifying |
|
.Fl o Ar outfile |
|
results in an empty file. |
.\" The following requests should be uncommented and used where appropriate. |
.\" The following requests should be uncommented and used where appropriate. |
.\" This next request is for sections 2, 3, and 9 function return values only. |
.\" This next request is for sections 2, 3, and 9 function return values only. |
.\" .Sh RETURN VALUES |
.\" .Sh RETURN VALUES |
|
|
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 |
|
.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 |
.Sq \&Xo |
.Sq \&Xo |
and |
and |
.Sq \&Xc |
.Sq \&Xc |
troff macros. |
troff 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 warnings. |
|
.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 |