version 1.2, 2009/02/22 11:23:19 |
version 1.6, 2009/03/09 13:04:01 |
|
|
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdoctree |
.Nm mdoctree |
.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 |
|
|
.Nm |
.Nm |
utility parses a BSD |
utility parses a BSD |
.Dq mdoc |
.Dq mdoc |
manual pages and prints its syntax tree. The arguments are as follows: |
manual pages and prints its syntax tree. It's commonly used to see the |
.Bl -tag -width "\-Werr... " |
syntax tree of a document when building new |
|
.Xr mdoc 3 |
|
utilities. The arguments are as follows: |
|
.Bl -tag -width XXXXXXXXXXXX |
.\" 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 75 input, documented at |
|
Line 87 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 and |
|
prints the syntax tree to stdout. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
By default, |
|
.Nm |
|
reads from stdin and prints the syntax tree to stdout. |
|
.\" PARAGRAPH |
|
.Pp |
|
.Ex -std mdoctree |
.Ex -std mdoctree |
|
.\" 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. |
|
.It Fl f Ns Ar ign-macro |
|
Ignore unknown macros at the start of input lines. |
|
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
As with the |
|
.Fl W |
|
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. |
|
.\" SUB-SECTION |
|
.Ss Input Encoding |
|
The |
.Nm |
.Nm |
is |
utility expects its input to be 7-bit ASCII as defined in |
.Ud |
.Xr ascii 7 . |
|
The only non-graphing characters accepted are spaces, |
|
.Sq \ , |
|
and tabs, |
|
.Sq \et . |
|
Tabs are only accepted in literal block-displays and as column |
|
delimiters. |
|
.Pp |
|
Only Unix-style newlines (\en) are accepted; if the newline is escaped, |
|
the line is concatenated with the next. |
|
.\" SUB-SECTION |
|
.Ss Character Escapes |
|
Since |
|
.Nm |
|
doesn't format its output, character escapes are displayed as passed |
|
into the compiler. |
.\" SECTION |
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To validate this manual page: |
To validate this manual page: |
Line 98 To validate this manual page: |
|
Line 145 To validate this manual page: |
|
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdocterm 1 , |
.Xr mdocterm 1 , |
|
.Xr mdoclint 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr mdoc 3 |
.Xr mdoc 3 |