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.16 and 1.23

version 1.16, 2008/12/03 19:21:58

version 1.23, 2008/12/08 16:29:57

Line 1

.\"

.Dd $Mdocdate$

.Dt mdocml 1

.Dt mdocml 1 alpha

.Os

.\"

.Sh NAME

Line 9

.\"

.Sh SYNOPSIS

.Nm mdocml

.Op Fl W

.Op Fl vW

.Op Fl f Ar filter

.Op Fl o Ar outfile

.Op Ar infile

Line 18

The

.Nm

utility parses mdoc formatted manual source and passes results into an

output filter. The only current output filter is

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.

Line 28 The output filter name.

Line 30 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 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

.Fl f Ar xml ,

is the default filter. It creates an XML document where element names are

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

their respective roff macro names. Each element name has an associated

.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 ,

.Dq block ,

.Qq head ,

.Dq head ,

.Qq body ,

.Dq body ,

.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.

element, in the default namespace; the

.\" This next request is for sections 1, 6, 7 & 8 only.

.Dq head

.\" .Sh ENVIRONMENT

namespace is for block headers (such as

.Sq .Ss

and

.Sq .Sh ) ;

the

.Dq body

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 ,

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 ,

Line 72 element, in the default namespace.

Line 120 element, in the default namespace.

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

Line 84 structured ones:

Line 132 structured ones:

.Bl -enum -compact -offset indent

.It

The engine doesn't understand the

.Sq \&Xo ,

.Sq \&Xc ,

.Sq \&No ,

.Sq \&Db ,

.Sq \&Xc ,

CVSweb