summaryrefslogtreecommitdiffstats
path: root/mdoctree.1
diff options
context:
space:
mode:
Diffstat (limited to 'mdoctree.1')
-rw-r--r--mdoctree.143
1 files changed, 32 insertions, 11 deletions
diff --git a/mdoctree.1 b/mdoctree.1
index 0c564811..fcd20fec 100644
--- a/mdoctree.1
+++ b/mdoctree.1
@@ -26,7 +26,8 @@
.\" SECTION
.Sh SYNOPSIS
.Nm mdoctree
-.Op Fl v
+.Op Fl vV
+.Op Fl f Ns Ar options...
.Op Fl W Ns Ar err...
.Op Ar infile
.\" SECTION
@@ -39,11 +40,19 @@ manual pages and prints its syntax tree. It's commonly used to see the
syntax tree of a document when building new
.Xr mdoc 3
utilities. The arguments are as follows:
-.Bl -tag -width "\-Werr... "
+.Bl -tag -width XXXXXXXXXXXX
.\" ITEM
.It Fl v
Print verbose parsing output.
.\" 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...
Print warning messages. May be set to
.Fl W Ns Ar all
@@ -78,20 +87,32 @@ input, documented at
.Xr mdoc 7
and
.Xr mdoc.samples 7 ,
-into an abstract syntax tree.
-.\" PARAGRAPH
-.Pp
-By default,
-.Nm
-reads from stdin and prints the syntax tree to stdout.
+into an abstract syntax tree. By default, it reads from stdin and
+prints the syntax tree to stdout.
.\" PARAGRAPH
.Pp
.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.
+.El
.\" PARAGRAPH
.Pp
-.Nm
-is
-.Ud
+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.
.\" SECTION
.Sh EXAMPLES
To validate this manual page: