=================================================================== RCS file: /cvs/mandoc/Attic/mdocml.1,v retrieving revision 1.9 retrieving revision 1.10 diff -u -p -r1.9 -r1.10 --- mandoc/Attic/mdocml.1 2008/11/30 18:50:44 1.9 +++ mandoc/Attic/mdocml.1 2008/11/30 21:41:35 1.10 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdocml.1,v 1.9 2008/11/30 18:50:44 kristaps Exp $ +.\" $OpenBSD: mdocml.1,v 1.10 2008/11/30 21:41:35 kristaps Exp $ .\" .\" The following requests are required for all man pages. .\" @@ -13,7 +13,7 @@ .\" .Sh SYNOPSIS .Nm mdocml -.Op Fl vW +.Op Fl W .Op Fl f Ar filter .Op Fl o Ar outfile .Op Ar infile @@ -27,32 +27,49 @@ formatted manual source and passes results into the ou dictated by .Fl f Ar filter . The only current output filter is -.Ar validate , +.Ar xml , the default. The arguments are as follows: -.Bl -tag -width "\-o outfile," -.It Sq Fl o Ar outfile , +.Bl -tag -width "\-o outfile" +.It Fl f Ar filter +The output filter name, which defaults to +.Ar xml . +.It Fl o Ar outfile Place output in .Ar outfile , which may be .Qq \- -for standard output. The default is standard output. +for stdout. The default is stdout. +.It Fl W +Print compiler warnings to stderr. .It Ar infile Read input from .Ar infile , which may be .Qq \- -for standard input. The default is standard input. -.It Fl v -Print messages (output depends on filter). -.It Fl W -Print warnings (output depends on filter). +for stdin. The default is stdin. .El -.Ss Validate Filter -The validate filter, specified by -.Fl f Ar validate , -is the default filter. It produces no output, so specifying -.Fl o Ar outfile -results in an empty file. +.Ss XML Filter +The XML filter, specified by +.Fl f Ar xml , +is the default filter. It creates an XML document where element names are +their respective roff macro names. Each element name has an associated +namespace, which is one of +.Qq block , +.Qq inline , +or +.Qq special , +corresponding to the display mode of a node. +.Pp +Sample output follows: +.Bd -literal + + + + NAME example + example text + + +.Ed .\" 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