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.17 and 1.26

version 1.17, 2008/12/04 11:25:29

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

Line 1

.\"

.Dd $Mdocdate$

.Dt mdocml 1 alpha

.Dt mdocml 1

.Os

.\"

.Sh NAME

Line 9

.\"

.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

Line 19 The

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.

.It Fl o Ar outfile

Write output to

.Ar outfile ,

which may be

.Qq \-

.Dq \-

for stdout.

for stdout. This is meaningless for

.It Fl W

.Fl f Ar noop .

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.

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

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

The HTML filter, specified by

.Fl f Ar html ,

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

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

.Pp

.\" .Sh ENVIRONMENT

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

.Pa mdocml.html

Line 94 for

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

Line 105 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 ,

Line 117 and

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

Line 129 structured ones:

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