mandoc/mdocml.1 - diff

Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdocml.1 between version 1.25 and 1.26

version 1.25, 2008/12/10 12:05:33

version 1.26, 2008/12/10 14:42:46

Line 20 The

.Nm

utility parses mdoc formatted manual source and passes results into an

output filter. The current output filters are

.Ar html

.Fl f Ar html

and

.Ar xml ,

.Fl f Ar xml .

the default. Arguments common to all filters follow:

By default,

.Nm

only validates its input. This may be explicitly directed with

.Fl f Ar noop .

Arguments common to all filters follow:

.Bl -tag -width "\-o outfile"

.It Fl f Ar filter

The output filter name. This

The output filter name.

.Em must

be declared before any other options.

.It Fl o Ar outfile

Write output to

.Ar outfile ,

which may be

.Dq \-

for stdout.

for stdout. This is meaningless for

.Fl f Ar noop .

.It Fl W Ns Ar err...

Print warning messages. If set to

.Fl W Ns Ar all ,

Line 56 for stdin.

Line 59 for stdin.

.Pp

By default,

.Nm

reads from stdin and writes to stdout using the xml filter.

reads from stdin and writes to stdout.

.Pp

.Ex -std mdocml

.\"

.Ss Noop Filter

The default noop

.Dq validating

filter simply validates its input; it produces no output beyond error

and warning messages.

.\"

.Ss XML Filter

The XML filter, specified by

.Fl f Ar xml ,

is the default filter. This filter has no additional arguments.

produces correctly-formatted XML output. 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

Line 88 namespace is for block bodies; and the

Line 98 namespace is for block bodies; and the

.Dq inline

namespace is for in-line elements (such as

.Sq .Em ) .

.\"

.Ss HTML Filter

The HTML filter, specified by

.Fl f Ar html ,

Line 99 The CSS file location, which defaults to

Line 110 The CSS file location, which defaults to

.It Fl e

Whether to embed the CSS file into the HTML prologue.

.El

.Pp

By default, the HTML filter produces HTML-4.01 strict mark-up. The

default CSS document styles the page as it would appear in a terminal

window.

.\"

.Sh EXAMPLES

To produce an HTML4-strict document

Line 118 with the default namespace identifiers

Line 133 with the default namespace identifiers

and

.Li inline :

.Pp

.D1 % mdocml mdocml.1

.D1 % mdocml -Wall,error -fxml mdocml.1

.Pp

The previous example will also halt on input document warnings.

.\"

.Sh SEE ALSO

.Xr groff 1 ,

CVSweb