version 1.1, 2009/02/23 13:06:18 |
version 1.2, 2009/03/08 18:02:36 |
|
|
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdoclint |
.Nm mdoclint |
.Op Fl v |
.Op Fl vV |
|
.Op Fl f Ns Ar options... |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Ar infile |
.Op Ar infile |
.\" SECTION |
.\" SECTION |
Line 37 utility parses a BSD |
|
Line 38 utility parses a BSD |
|
.Dq mdoc |
.Dq mdoc |
manual pages and validates its syntax tree. The arguments are as |
manual pages and validates its syntax tree. The arguments are as |
follows: |
follows: |
.Bl -tag -width "\-Werr... " |
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
.\" ITEM |
.\" ITEM |
.It Fl v |
.It Fl v |
Print verbose parsing output. |
Print verbose parsing output. |
.\" ITEM |
.\" ITEM |
|
.It Fl V |
|
Print version and exit. |
|
.\" ITEM |
|
.It Fl f Ns Ar option... |
|
Override default compiler behaviour. See |
|
.Sx Compiler Options |
|
for details. |
|
.\" 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 76 input, documented at |
|
Line 85 input, documented at |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
into an abstract syntax tree. |
into an abstract syntax tree. By default, it reads from stdin. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
By default, |
|
.Nm |
|
reads from stdin. |
|
.\" PARAGRAPH |
|
.Pp |
|
.Ex -std mdoclint |
.Ex -std mdoclint |
|
.\" SUB-SECTION |
|
.Ss Compiler Options |
|
Default compiler behaviour may be overriden with the |
|
.Fl f |
|
flag. The available options are as follows: |
|
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
|
.It Fl f Ns Ar ign-scope |
|
When rewinding the scope of a block macro, forces the compiler to ignore |
|
scope violations. This can seriously mangle the resulting tree. |
|
.It Fl f Ns Ar ign-escape |
|
Ignore invalid escape sequences. |
|
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.Nm |
As with the |
is |
.Fl W |
.Ud |
flag, multiple |
|
.Fl f |
|
options may be grouped and delimited with a comma. Using |
|
.Fl f Ns Ar ign-scope,ign-escape , |
|
for example, will try to ignore scope and character-escape errors. |
.\" SECTION |
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To validate this manual page: |
To validate this manual page: |