=================================================================== RCS file: /cvs/mandoc/Attic/mdocml.1,v retrieving revision 1.27 retrieving revision 1.31 diff -u -p -r1.27 -r1.31 --- mandoc/Attic/mdocml.1 2009/01/16 14:04:26 1.27 +++ mandoc/Attic/mdocml.1 2009/02/20 23:35:36 1.31 @@ -1,24 +1,25 @@ .\" -.Dd $Mdocdate: January 16 2009 $ +.Dd $Mdocdate: February 20 2009 $ .Dt mdocml 1 .Os -.\" +.\" SECTION .Sh NAME .Nm mdocml .Nd mdoc macro compiler -.\" +.\" SECTION .Sh SYNOPSIS .Nm mdocml .Op Fl v .Op Fl W Ns Ar err... .Op Ar infile -.\" +.\" SECTION .Sh DESCRIPTION The .Nm utility interfaces the .Xr mdoc 3 -library to validate and parse mdoc-macro documents. Arguments follow: +library to scan, parse and validate mdoc-macro documents. Arguments +follow: .Bl -tag -width "\-Werr... " .It Fl W Ns Ar err... Print warning messages. May be set to @@ -43,49 +44,47 @@ which may be .Dq \- for stdin. .El +.\" PARAGRAPH .Pp Parsing and validation rules are drawn entirely from the .Xr mdoc 7 and .Xr mdoc.samples 7 manuals. +.\" PARAGRAPH .Pp By default, .Nm reads from stdin, writes messages to stdout, and writes errors and warnings to stderr. +.\" PARAGRAPH .Pp .Ex -std mdocml -.\" +.\" PARAGRAPH +.Pp +.Nm +is +.Ud +.\" SECTION .Sh EXAMPLES To validate this manual page: +.\" PARAGRAPH .Pp .D1 % mdocml \-Wall,error mdocml.1 -.\" +.\" SECTION .Sh SEE ALSO .Xr groff 1 , .Xr mdoc.samples 7 , .Xr mdoc 7 , .Xr mdoc 3 -.\" .Sh STANDARDS -.\" .Sh HISTORY +.\" .Sh AUTHORS The .Nm utility was written by .An Kristaps Dzonsons Aq kristaps@kth.se . -.\" +.\" SECTION .Sh CAVEATS -The most glaring short-coming of -.Nm -is that it doesn't yet support the -.Sq \&Xc -and -.Sq \&Xo -macros when used to extend the line arguments to -.Sq \&It ; -in effect, trampling the body section. We note that this is explicitly -discouraged in -.Xr mdoc.samples 7 , -but in practice used quite often. -.\" .Sh BUGS +See +.Xr mdoc 3 +for a list of bugs, caveats, and incomplete macros.