=================================================================== RCS file: /cvs/mandoc/Attic/mdoctree.1,v retrieving revision 1.1 retrieving revision 1.7 diff -u -p -r1.1 -r1.7 --- mandoc/Attic/mdoctree.1 2009/02/21 21:00:06 1.1 +++ mandoc/Attic/mdoctree.1 2009/03/16 23:37:28 1.7 @@ -1,6 +1,6 @@ -.\" $Id: mdoctree.1,v 1.1 2009/02/21 21:00:06 kristaps Exp $ +.\" $Id: mdoctree.1,v 1.7 2009/03/16 23:37:28 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: February 21 2009 $ +.Dd $Mdocdate: March 16 2009 $ .Dt mdoctree 1 .Os .\" SECTION @@ -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 @@ -35,12 +36,23 @@ The .Nm utility parses a BSD .Dq mdoc -manual pages and prints its syntax tree. The arguments are as follows: -.Bl -tag -width "\-Werr... " +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 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 @@ -64,6 +76,7 @@ which may be for stdin. .El .\" PARAGRAPH +.Pp The .Nm utility is a formatting front-end for @@ -74,20 +87,55 @@ input, documented at .Xr mdoc 7 and .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 .Pp -By default, -.Nm -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. +.It Fl f Ns Ar ign-macro +Ignore unknown macros at the start of input lines. +.El .\" PARAGRAPH .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 -is -.Ud +utility expects its input to be 7-bit ASCII as defined in +.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 .Sh EXAMPLES To validate this manual page: @@ -97,6 +145,7 @@ To validate this manual page: .\" SECTION .Sh SEE ALSO .Xr mdocterm 1 , +.Xr mdoclint 1 , .Xr mdoc.samples 7 , .Xr mdoc 7 , .Xr mdoc 3 @@ -105,7 +154,7 @@ To validate this manual page: The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@kth.se . +.An Kristaps Dzonsons Aq kristaps@openbsd.org . .\" SECTION .Sh CAVEATS See