===================================================================
RCS file: /cvs/mandoc/Attic/mdocml.1,v
retrieving revision 1.4
retrieving revision 1.13
diff -u -p -r1.4 -r1.13
--- mandoc/Attic/mdocml.1	2008/11/25 16:49:57	1.4
+++ mandoc/Attic/mdocml.1	2008/12/01 15:32:36	1.13
@@ -1,52 +1,65 @@
-.\"	$OpenBSD: mdocml.1,v 1.4 2008/11/25 16:49:57 kristaps Exp $
 .\"
-.\" The following requests are required for all man pages.
-.\"
-.\" Remove `\&' from the line below.
-.Dd $Mdocdate: November 25 2008 $
+.Dd $Mdocdate: December 1 2008 $
 .Dt mdocml 1
 .Os
 .\"
-.Op foo
 .Sh NAME
 .Nm mdocml
 .Nd compile manpage source into mark-up language
 .\"
 .Sh SYNOPSIS
 .Nm mdocml
+.Op Fl W
+.Op Fl f Ar filter
 .Op Fl o Ar outfile
 .Op Ar infile
 .\"
 .Sh DESCRIPTION
 The
 .Nm
-utility compiles manpage source into a mark-up language.  Its arguments
-are as follows:
-.Bl -tag -width "-o outfile"
+utility parses mdoc formatted manual source and passes results into an
+output filter.  The only current output filter is
+.Ar xml ,
+the default.  The arguments are as follows:
+.Bl -tag -width "\-o outfile"
+.It Fl f Ar filter
+The output filter name.
 .It Fl o Ar outfile
-Place output in 
+Write output to 
 .Ar outfile ,
 which may be
-.Qq -
-for standard output.  The default is standard output.
+.Qq \-
+for stdout.
+.It Fl W
+Print warnings to stderr.
 .It Ar infile
 Read input from
 .Ar infile ,
 which may be 
-.Qq -
-for standard input.  The default is standard input.
+.Qq \-
+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
+.Pp
+By default,
+.Nm
+reads from stdin and writes to stdout using the xml filter.
+.\"
+.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 
+or
+.Qq inline ,
+corresponding to the display mode of a node.  The document root is
+always the
+.Qq mdoc
+element, in the default namespace.
 .\" 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
+.\"
 .Sh SEE ALSO
 .Xr groff 1 ,
 .Xr mdoc.samples 7 ,
@@ -57,14 +70,36 @@ for standard input.  The default is standard input.
 The
 .Nm
 utility was written by 
-.An Kristaps Dzonsons Aq kristaps@kth.se .
+.An Em Kristaps Dzonsons Aq kristaps@kth.se .
 .\"
 .Sh CAVEATS
-The
+Most caveats of
 .Nm
-engine doesn't understand
-.Sq \&Xo
+stem from ambiguities in 
+.Xr mdoc 7
+or the necessary limitations of converting an ad hoc language into
+structured ones:
+.Bl -enum -compact -offset indent
+.It 
+The engine doesn't understand the
+.Sq \&Xo ,
+.Sq \&Xc ,
+.Sq \&Ns ,
+.Sq \&No ,
+.Sq \&Db ,
+.Sq \&Sm ,
+.Sq \&Xc ,
 and
-.Sq \&Xc
-troff macros.
+.Sq \&Xo
+mdoc macros.
+.It 
+All macro arguments may be quoted, instead of only some.
+.It 
+Blank lines raise errors.
+.It 
+If terminating punctuation is found, then 
+.Em all
+remaining tokens are flushed after line scope is closed, not just the
+last one.
+.El
 .\" .Sh BUGS