diff options
Diffstat (limited to 'mdocml.1')
| -rw-r--r-- | mdocml.1 | 49 |
1 files changed, 33 insertions, 16 deletions
@@ -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 output filter 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 +<?xml version="1.0" encoding="UTF-8"?> +<block:mdoc> + <block:Sh> + <inline:Sh>NAME</inline:Sh> <inline:Nm>example</inline:Nm> + <inline:Nd>example text</inline:Nd> + </block:Sh> +</block:mdoc> +.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 |