=================================================================== RCS file: /cvs/mandoc/Attic/mdocml.1,v retrieving revision 1.12 retrieving revision 1.19 diff -u -p -r1.12 -r1.19 --- mandoc/Attic/mdocml.1 2008/12/01 09:25:18 1.12 +++ mandoc/Attic/mdocml.1 2008/12/05 22:34:30 1.19 @@ -1,6 +1,6 @@ .\" -.Dd $Mdocdate: December 1 2008 $ -.Dt mdocml 1 +.Dd $Mdocdate: December 5 2008 $ +.Dt mdocml 1 alpha .Os .\" .Sh NAME @@ -9,7 +9,7 @@ .\" .Sh SYNOPSIS .Nm mdocml -.Op Fl W +.Op Fl vW .Op Fl f Ar filter .Op Fl o Ar outfile .Op Ar infile @@ -17,12 +17,12 @@ .Sh DESCRIPTION The .Nm -utility parses -.Xr mdoc -formatted manual source and passes results into an output filter. The -only current output filter is +utility parses mdoc formatted manual source and passes results into an +output filter. The current output filters are +.Ar html +and .Ar xml , -the default. The arguments are as follows: +the default. Arguments common to all filters follow: .Bl -tag -width "\-o outfile" .It Fl f Ar filter The output filter name. @@ -49,18 +49,62 @@ reads from stdin and writes to stdout using the xml fi .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 +is the default filter. This filter has no additional arguments. +.Pp +The XML filter 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 block , +.Qq head , +.Qq body , 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 +element, in the default namespace; the +.Qq head +namespace is for block headers (such as +.Sq .Ss +and +.Sq .Sh ) ; +the +.Qq body +namespace is for block bodies; and the +.Qq inline +namespace is for in-line elements (such as +.Sq .Em ) . +.Ss HTML Filter +The HTML filter, specified by +.Fl f Ar html , +accepts the following filter-specific arguments: +.Bl -tag -width "\-c css" +.It Fl c Ar css +The CSS file location, which defaults to +.Ar mdocml.css . +.It Fl e +Whether to embed the CSS file into the HTML prologue. +.El +.\" +.Sh EXAMPLES +To produce an HTML4-strict document +.Pa mdocml.html +for +.Pa mdocml.1 +with the default, embedded style-sheet: +.Pp +.D1 % mdocml -fhtml -e -o mdocml.html mdocml.1 +.Pp +To create an XML document on standard output from +.Pa mdocml.1 +with the default namespace identifiers +.Li head , +.Li body , +.Li block +and +.Li inline : +.Pp +.D1 % mdocml mdocml.1 .\" .Sh SEE ALSO .Xr groff 1 , @@ -84,12 +128,8 @@ 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 \&Xo @@ -104,4 +144,9 @@ If terminating punctuation is found, then remaining tokens are flushed after line scope is closed, not just the last one. .El +.Pp +The roff engine in +.Nm +produces text in-line; thus, output may already be partially written by +the time an error is encountered. .\" .Sh BUGS