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.6 and 1.7

version 1.6, 2008/11/27 17:27:50

version 1.7, 2008/11/28 11:21:12

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 vW

.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

formatted manual source and passes results into the output filter

dictated by

.Fl f Ar filter .

The only current output filter is

.Ar validate ,

the default. The arguments are as follows:

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

.It Fl o Ar outfile

Place output in

Line 36 Read input from

Line 42 Read input from

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.

Print warnings (output depends on filter).

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

.\" 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 63 utility was written by

Line 77 utility was written by

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

.Pp

.It

.Em All

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

macro arguments may be quoted, instead of only some.

.It

Blank lines raise warnings.

.It

Non-ascii characters may cause issues.

.El

.\" .Sh BUGS

CVSweb