version 1.31, 2009/02/20 23:35:36 |
version 1.33, 2009/02/21 15:34:46 |
|
|
.\" SECTION |
.\" 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 |
|
|
.Nm |
.Nm |
utility interfaces the |
utility interfaces the |
.Xr mdoc 3 |
.Xr mdoc 3 |
library to scan, parse and validate mdoc-macro documents. Arguments |
library to scan, parse, validate and output mdoc-macro documents. |
follow: |
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 35 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 , |
|
|
.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 |
.\" PARAGRAPH |
.Pp |
.Pp |
.Ex -std mdocml |
.Ex -std mdocml |