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.4 and 1.11

version 1.4, 2008/11/25 16:49:57

version 1.11, 2008/11/30 23:05:57

Line 7

.Dt mdocml 1

.Os

.\"

.Op foo

.Sh NAME

.Nm mdocml

.Nd compile manpage source into mark-up language

.\"

.Sh SYNOPSIS

.Nm mdocml

.Op Fl W

.Op Fl f Ar filter

.Op Fl o Ar outfile

.Op Ar infile

.\"

.Sh DESCRIPTION

The

.Nm

utility compiles manpage source into a mark-up language. Its arguments

utility parses

are as follows:

.Xr mdoc

.Bl -tag -width "-o outfile"

formatted manual source and passes results into the output filter

dictated by

.Fl f Ar filter .

The only current output filter is

.Ar xml ,

the default. The arguments are as follows:

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

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

.Qq \-

for standard input. The default is standard input.

for stdin. The default is stdin.

.El

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

.Qq special ,

corresponding to the display mode of a node.

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

Line 57 for standard input. The default is standard input.

Line 80 for standard input. The default is standard input.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

.An Em Kristaps Dzonsons Aq kristaps@kth.se .

.\"

.Sh CAVEATS

The

Most caveats of

.Nm

engine doesn't understand

stem from ambiguities in

.Xr mdoc 7

or the necessary limitations of converting an ad hoc language into

structured ones:

.Bl -enum -compact -offset indent

.It

The engine doesn't understand

.Sq \&Xo

and

.Sq \&Xc

troff macros.

.It

All macro arguments may be quoted, instead of only some.

.It

Blank lines raise warnings.

.It

If terminating punctuation is found, then

.Em all

remaining tokens are flushed after line scope is closed, not just the

last one.

.El

.\" .Sh BUGS

CVSweb