=================================================================== RCS file: /cvs/mandoc/Attic/mdoclint.1,v retrieving revision 1.1 retrieving revision 1.5 diff -u -p -r1.1 -r1.5 --- mandoc/Attic/mdoclint.1 2009/02/23 13:06:18 1.1 +++ mandoc/Attic/mdoclint.1 2009/03/16 23:37:28 1.5 @@ -1,6 +1,6 @@ -.\" $Id: mdoclint.1,v 1.1 2009/02/23 13:06:18 kristaps Exp $ +.\" $Id: mdoclint.1,v 1.5 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 23 2009 $ +.Dd $Mdocdate: March 16 2009 $ .Dt mdoclint 1 .Os .\" SECTION @@ -26,9 +26,10 @@ .\" SECTION .Sh SYNOPSIS .Nm mdoclint -.Op Fl v +.Op Fl vV +.Op Fl f Ns Ar options... .Op Fl W Ns Ar err... -.Op Ar infile +.Op Ar infile... .\" SECTION .Sh DESCRIPTION The @@ -37,11 +38,19 @@ utility parses a BSD .Dq mdoc manual pages and validates its syntax tree. The arguments are as follows: -.Bl -tag -width "\-Werr... " +.Bl -tag -width XXXXXXXXXXXX -offset XXXX .\" 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 @@ -62,7 +71,10 @@ Read input from .Ar infile , which may be .Dq \- -for stdin. +for stdin. If multiple +.Ar infile +arguments are specified, each is processed and the system will exit on +the first failure. .El .\" PARAGRAPH .Pp @@ -76,20 +88,48 @@ 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. .\" PARAGRAPH .Pp -By default, -.Nm -reads from stdin. -.\" PARAGRAPH -.Pp .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. +.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. .\" SECTION .Sh EXAMPLES To validate this manual page: @@ -108,7 +148,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