*** empty log message ***

[mandoc.git] / mdocml.1

diff --git a/mdocml.1 b/mdocml.1
index c37c89e87e4da2cfee3d1234cb8856126937f2c1..db7e4caeec1475a4e35896b60bafaff57b91c1a9 100644 (file)
--- a/mdocml.1
+++ b/mdocml.1
@@ -1,5 +1,5 @@
 .\"
-.Dd $Mdocdate: December 4 2008 $
+.Dd $Mdocdate: December 9 2008 $
 .Dt mdocml 1 alpha
 .Os
 .\"
@@ -9,7 +9,8 @@
 .\"
 .Sh SYNOPSIS
 .Nm mdocml
-.Op Fl vW
+.Op Fl v
+.Op Fl W Ns Ar err...
 .Op Fl f Ar filter
 .Op Fl o Ar outfile
 .Op Ar infile
@@ -30,21 +31,32 @@ The output filter name.
 Write output to 
 .Ar outfile ,
 which may be
-.Qq \-
+.Dq \-
 for stdout.
-.It Fl W
-Print warnings to stderr.
+.It Fl W Ns Ar err...
+Print warning messages.  If set to 
+.Fl W Ns Ar all ,
+all warnings are printed; if
+.Fl W Ns Ar error ,
+warnings are considered errors and cause utility termination.  Multiple 
+.Fl W
+arguments may be comma-separated, such as
+.Fl W Ns Ar error,all .
+.It Fl v
+Make warning and error messages verbose.
 .It Ar infile
 Read input from
 .Ar infile ,
 which may be 
-.Qq \-
+.Dq \-
 for stdin.
 .El
 .Pp
 By default,
 .Nm
 reads from stdin and writes to stdout using the xml filter.
+.Pp
+.Ex -std mdocml
 .\"
 .Ss XML Filter
 The XML filter, specified by
@@ -54,24 +66,24 @@ is the default filter.  This filter has no additional arguments.
 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 head ,
-.Qq body ,
+.Dq block ,
+.Dq head ,
+.Dq body ,
 or
-.Qq inline ,
+.Dq inline ,
 corresponding to the display mode of a node.  The document root is
 always the
-.Qq mdoc
+.Dq mdoc
 element, in the default namespace; the 
-.Qq head
+.Dq head
 namespace is for block headers (such as 
 .Sq .Ss
 and
 .Sq .Sh ) ;
 the
-.Qq body
+.Dq body
 namespace is for block bodies; and the
-.Qq inline
+.Dq inline
 namespace is for in-line elements (such as
 .Sq .Em ) .
 .Ss HTML Filter
@@ -85,8 +97,7 @@ The CSS file location, which defaults to
 .It Fl e
 Whether to embed the CSS file into the HTML prologue.
 .El
-.\" This next request is for sections 1, 6, 7 & 8 only.
-.\" .Sh ENVIRONMENT
+.\" 
 .Sh EXAMPLES
 To produce an HTML4-strict document 
 .Pa mdocml.html
@@ -94,7 +105,7 @@ for
 .Pa mdocml.1 
 with the default, embedded style-sheet:
 .Pp
-.D1 % mdocml -fhtml -e mdocml.1 -o mdocml.html
+.D1 % mdocml -fhtml -e -o mdocml.html mdocml.1 
 .Pp
 To create an XML document on standard output from
 .Pa mdocml.1
@@ -117,7 +128,7 @@ and
 The
 .Nm
 utility was written by 
-.An Em Kristaps Dzonsons Aq kristaps@kth.se .
+.An Kristaps Dzonsons Aq kristaps@kth.se .
 .\"
 .Sh CAVEATS
 Most caveats of
@@ -129,8 +140,6 @@ structured ones:
 .Bl -enum -compact -offset indent
 .It 
 The engine doesn't understand the
-.Sq \&Xo ,
-.Sq \&Xc ,
 .Sq \&No ,
 .Sq \&Db ,
 .Sq \&Xc ,