version 1.27, 2009/01/16 14:04:26 |
version 1.33, 2009/02/21 15:34:46 |
|
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdocml 1 |
.Dt mdocml 1 |
.Os |
.Os |
.\" |
.\" SECTION |
.Sh NAME |
.Sh NAME |
.Nm mdocml |
.Nm mdocml |
.Nd mdoc macro compiler |
.Nd mdoc macro compiler |
.\" |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocml |
.Nm mdocml |
|
.Op Fl f Ns Ar filter |
.Op Fl v |
.Op Fl v |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Ar infile |
.Op Ar infile |
.\" |
.\" SECTION |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility interfaces the |
utility interfaces the |
.Xr mdoc 3 |
.Xr mdoc 3 |
library to validate and parse mdoc-macro documents. Arguments follow: |
library to scan, parse, validate and output mdoc-macro documents. |
|
Arguments follow: |
.Bl -tag -width "\-Werr... " |
.Bl -tag -width "\-Werr... " |
|
.\" ITEM |
|
.It Fl f Ns Ar filter |
|
Pipe the parsed syntax tree into an output filter. May be either |
|
.Ar tree |
|
for the parse tree or |
|
.Ar term |
|
for a terminal-encoded, formatted manual page. |
|
.\" ITEM |
|
.It Fl v |
|
Print verbose parsing output. |
|
.\" ITEM |
.It Fl W Ns Ar err... |
.It Fl W Ns Ar err... |
Print warning messages. May be set to |
Print warning messages. May be set to |
.Fl W Ns Ar all |
.Fl W Ns Ar all |
Line 34 termination. Multiple |
|
Line 47 termination. Multiple |
|
.Fl W |
.Fl W |
arguments may be comma-separated, such as |
arguments may be comma-separated, such as |
.Fl W Ns Ar error,all . |
.Fl W Ns Ar error,all . |
.It Fl v |
.\" ITEM |
Print verbose parsing output. |
|
.It Ar infile |
.It Ar infile |
Read input from |
Read input from |
.Ar infile , |
.Ar infile , |
|
|
.Dq \- |
.Dq \- |
for stdin. |
for stdin. |
.El |
.El |
|
.\" PARAGRAPH |
.Pp |
.Pp |
Parsing and validation rules are drawn entirely from the |
Parsing and validation rules are drawn entirely from the |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr mdoc.samples 7 |
.Xr mdoc.samples 7 |
manuals. |
manuals. |
|
.\" PARAGRAPH |
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
reads from stdin, writes messages to stdout, and writes errors and |
reads from stdin and only validates its input. |
warnings to stderr. |
.\" PARAGRAPH |
.Pp |
.Pp |
.Ex -std mdocml |
.Ex -std mdocml |
.\" |
.\" PARAGRAPH |
|
.Pp |
|
.Nm |
|
is |
|
.Ud |
|
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To validate this manual page: |
To validate this manual page: |
|
.\" PARAGRAPH |
.Pp |
.Pp |
.D1 % mdocml \-Wall,error mdocml.1 |
.D1 % mdocml \-Wall,error mdocml.1 |
.\" |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr groff 1 , |
.Xr groff 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr mdoc 3 |
.Xr mdoc 3 |
.\" .Sh STANDARDS |
.\" |
.\" .Sh HISTORY |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |
The most glaring short-coming of |
See |
.Nm |
.Xr mdoc 3 |
is that it doesn't yet support the |
for a list of bugs, caveats, and incomplete macros. |
.Sq \&Xc |
|
and |
|
.Sq \&Xo |
|
macros when used to extend the line arguments to |
|
.Sq \&It ; |
|
in effect, trampling the body section. We note that this is explicitly |
|
discouraged in |
|
.Xr mdoc.samples 7 , |
|
but in practice used quite often. |
|
.\" .Sh BUGS |
|