=================================================================== RCS file: /cvs/mandoc/Attic/mdocml.1,v retrieving revision 1.5 retrieving revision 1.33 diff -u -p -r1.5 -r1.33 --- mandoc/Attic/mdocml.1 2008/11/27 13:29:44 1.5 +++ mandoc/Attic/mdocml.1 2009/02/21 15:34:46 1.33 @@ -1,73 +1,100 @@ -.\" $OpenBSD: mdocml.1,v 1.5 2008/11/27 13:29:44 kristaps Exp $ .\" -.\" The following requests are required for all man pages. -.\" -.\" Remove `\&' from the line below. -.Dd $Mdocdate: November 27 2008 $ +.Dd $Mdocdate: February 21 2009 $ .Dt mdocml 1 .Os -.\" -.Op foo +.\" SECTION .Sh NAME .Nm mdocml -.Nd compile manpage source into mark-up language -.\" +.Nd mdoc macro compiler +.\" SECTION .Sh SYNOPSIS .Nm mdocml -.Op Fl o Ar outfile +.Op Fl f Ns Ar filter +.Op Fl v +.Op Fl W Ns Ar err... .Op Ar infile -.\" +.\" SECTION .Sh DESCRIPTION The .Nm -utility compiles manpage source into a mark-up language. Its arguments -are as follows: -.Bl -tag -width "-o outfile" -.It Fl o Ar outfile -Place output in -.Ar outfile , -which may be -.Qq - -for standard output. The default is standard output. +utility interfaces the +.Xr mdoc 3 +library to scan, parse, validate and output mdoc-macro documents. +Arguments follow: +.Bl -tag -width "\-Werr... " +.\" ITEM +.It Fl f Ns Ar filter +Pipe the parsed syntax tree into an output filter. May be either +.Ar tree +for the parse tree or +.Ar term +for a terminal-encoded, formatted manual page. +.\" ITEM +.It Fl v +Print verbose parsing output. +.\" ITEM +.It Fl W Ns Ar err... +Print warning messages. May be set to +.Fl W Ns Ar all +for all warnings, +.Ar compat +for groff/troff-compatibility warnings, or +.Ar syntax +for syntax warnings. If +.Fl W Ns Ar error +is specified, warnings are considered errors and cause utility +termination. Multiple +.Fl W +arguments may be comma-separated, such as +.Fl W Ns Ar error,all . +.\" ITEM .It Ar infile Read input from .Ar infile , which may be -.Qq - -for standard input. The default is standard input. +.Dq \- +for stdin. .El -.\" The following requests should be uncommented and used where appropriate. -.\" This next request is for sections 2, 3, and 9 function return values only. -.\" .Sh RETURN VALUES -.\" This next request is for sections 1, 6, 7 & 8 only. -.\" .Sh ENVIRONMENT -.\" .Sh FILES -.\" .Sh EXAMPLES -.\" This next request is for sections 1, 4, 6, and 8 only. -.\" .Sh DIAGNOSTICS -.\" The next request is for sections 2, 3, and 9 error and signal handling only. -.\" .Sh ERRORS +.\" 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 and only validates its input. +.\" 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 -.\" .Sh STANDARDS -.\" .Sh HISTORY +.Xr mdoc 7 , +.Xr mdoc 3 +.\" .Sh AUTHORS The .Nm utility was written by .An Kristaps Dzonsons Aq kristaps@kth.se . -.\" +.\" SECTION .Sh CAVEATS -The -.Nm -engine doesn't understand -.Sq \&Xo -and -.Sq \&Xc -troff macros. -.Pp -.Em All -macro arguments may be quoted, instead of only some. -.\" .Sh BUGS +See +.Xr mdoc 3 +for a list of bugs, caveats, and incomplete macros.