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

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

version 1.15, 2008/12/02 13:20:24

Line 1

.\" $OpenBSD$

.\"

.\" The following requests are required for all man pages.

.\"

.\" Remove `\&' from the line below.

.Dd $Mdocdate$

.Dt mdocml 1

.Os

Line 13

Line 9

.\"

.Sh SYNOPSIS

.Nm mdocml

.Op Fl vW

.Op Fl W

.Op Fl f Ar filter

.Op Fl o Ar outfile

.Op Ar infile

Line 21

Line 17

.Sh DESCRIPTION

The

.Nm

utility parses

utility parses mdoc formatted manual source and passes results into an

.Xr mdoc

output filter. The only current output filter is

formatted manual source and passes results into the output filter

.Ar xml ,

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 f Ar filter

The output filter name.

.It Fl o Ar outfile

Place output in

Write output to

.Ar outfile ,

which may be

.Qq \-

for standard output. The default is standard output.

for stdout.

.It Fl W

Print warnings to stderr.

.It Ar infile

Read input from

.Ar infile ,

which may be

.Qq \-

for standard input. The default is standard input.

for stdin.

.It Fl v

Print messages (output depends on filter).

.It Fl W

Print warnings (output depends on filter).

.El

.Ss Validate Filter

.Pp

The validate filter, specified by

By default,

.Fl f Ar validate ,

.Nm

is the default filter. It produces no output, so specifying

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

.Fl o Ar outfile

.\"

results in an empty file.

.Ss XML Filter

.\" The following requests should be uncommented and used where appropriate.

The XML filter, specified by

.\" This next request is for sections 2, 3, and 9 function return values only.

.Fl f Ar xml ,

.\" .Sh RETURN VALUES

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 ,

corresponding to the display mode of a node. The document root is

always the

.Qq mdoc

element, in the default namespace.

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

.\" .Sh ENVIRONMENT

.\" .Sh FILES

.\"

.\" .Sh EXAMPLES

.\" This next request is for sections 1, 4, 6, and 8 only.

.\" .Sh DIAGNOSTICS

.\" The next request is for sections 2, 3, and 9 error and signal handling only.

.\" .Sh ERRORS

.Sh SEE ALSO

.Xr groff 1 ,

.Xr mdoc.samples 7 ,

Line 74 results in an empty file.

Line 70 results in an empty file.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@kth.se .

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

.\"

.Sh CAVEATS

Most caveats of

Line 85 or the necessary limitations of converting an ad hoc l

Line 81 or the necessary limitations of converting an ad hoc l

structured ones:

.Bl -enum -compact -offset indent

.It

The engine doesn't understand

The engine doesn't understand the

.Sq \&Xo

.Sq \&Xo ,

.Sq \&Xc ,

.Sq \&No ,

.Sq \&Db ,

.Sq \&Xc ,

and

.Sq \&Xc

.Sq \&Xo

troff macros.

mdoc macros.

.It

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

.It

Blank lines raise warnings.

Blank lines raise errors.

.It

Non-ascii characters may cause issues.

If terminating punctuation is found, then

.Em all

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

last one.

.El

.Pp

The roff engine in

.Nm

produces text in-line; thus, output may already be partially written by

the time an error is encountered.

.\" .Sh BUGS

CVSweb