| version 1.11, 2008/11/30 23:05:57 |
version 1.32, 2009/02/21 14:56:57 |
|
|
| .\" $OpenBSD$ |
|
| .\" |
.\" |
| .\" The following requests are required for all man pages. |
|
| .\" |
|
| .\" Remove `\&' from the line below. |
|
| .Dd $Mdocdate$ |
.Dd $Mdocdate$ |
| .Dt mdocml 1 |
.Dt mdocml 1 |
| .Os |
.Os |
| .\" |
.\" SECTION |
| .Sh NAME |
.Sh NAME |
| .Nm mdocml |
.Nm mdocml |
| .Nd compile manpage source into mark-up language |
.Nd mdoc macro compiler |
| .\" |
.\" SECTION |
| .Sh SYNOPSIS |
.Sh SYNOPSIS |
| .Nm mdocml |
.Nm mdocml |
| .Op Fl W |
.Op Fl v |
| .Op Fl f Ar filter |
.Op Fl W Ns Ar err... |
| .Op Fl o Ar outfile |
|
| .Op Ar infile |
.Op Ar infile |
| .\" |
.\" SECTION |
| .Sh DESCRIPTION |
.Sh DESCRIPTION |
| The |
The |
| .Nm |
.Nm |
| utility parses |
utility interfaces the |
| .Xr mdoc |
.Xr mdoc 3 |
| formatted manual source and passes results into the output filter |
library to scan, parse and validate mdoc-macro documents. Arguments |
| dictated by |
follow: |
| .Fl f Ar filter . |
.Bl -tag -width "\-Werr... " |
| The only current output filter is |
.\" ITEM |
| .Ar xml , |
.It Fl W Ns Ar err... |
| the default. The arguments are as follows: |
Print warning messages. May be set to |
| .Bl -tag -width "\-o outfile" |
.Fl W Ns Ar all |
| .It Fl f Ar filter |
for all warnings, |
| The output filter name, which defaults to |
.Ar compat |
| .Ar xml . |
for groff/troff-compatibility warnings, or |
| .It Fl o Ar outfile |
.Ar syntax |
| Place output in |
for syntax warnings. If |
| .Ar outfile , |
.Fl W Ns Ar error |
| which may be |
is specified, warnings are considered errors and cause utility |
| .Qq \- |
termination. Multiple |
| for stdout. The default is stdout. |
.Fl W |
| .It Fl W |
arguments may be comma-separated, such as |
| Print compiler warnings to stderr. |
.Fl W Ns Ar error,all . |
| |
.\" ITEM |
| |
.It Fl v |
| |
Print verbose parsing output. |
| |
.\" ITEM |
| .It Ar infile |
.It Ar infile |
| Read input from |
Read input from |
| .Ar infile , |
.Ar infile , |
| which may be |
which may be |
| .Qq \- |
.Dq \- |
| for stdin. The default is stdin. |
for stdin. |
| .El |
.El |
| .Ss XML Filter |
.\" PARAGRAPH |
| The XML filter, specified by |
.Pp |
| .Fl f Ar xml , |
Parsing and validation rules are drawn entirely from the |
| is the default filter. It creates an XML document where element names are |
.Xr mdoc 7 |
| their respective roff macro names. Each element name has an associated |
and |
| namespace, which is one of |
.Xr mdoc.samples 7 |
| .Qq block , |
manuals. |
| .Qq inline , |
.\" PARAGRAPH |
| or |
.Pp |
| .Qq special , |
By default, |
| corresponding to the display mode of a node. |
.Nm |
| .\" The following requests should be uncommented and used where appropriate. |
reads from stdin, writes messages to stdout, and writes errors and |
| .\" This next request is for sections 2, 3, and 9 function return values only. |
warnings to stderr. |
| .\" .Sh RETURN VALUES |
.\" PARAGRAPH |
| .\" This next request is for sections 1, 6, 7 & 8 only. |
.Pp |
| .\" .Sh ENVIRONMENT |
.Ex -std mdocml |
| .\" .Sh FILES |
.\" PARAGRAPH |
| .\" .Sh EXAMPLES |
.Pp |
| .\" This next request is for sections 1, 4, 6, and 8 only. |
.Nm |
| .\" .Sh DIAGNOSTICS |
is |
| .\" The next request is for sections 2, 3, and 9 error and signal handling only. |
.Ud |
| .\" .Sh ERRORS |
.\" SECTION |
| |
.Sh EXAMPLES |
| |
To validate this manual page: |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
.D1 % mdocml \-Wall,error mdocml.1 |
| |
.\" SECTION |
| .Sh SEE ALSO |
.Sh SEE ALSO |
| .Xr groff 1 , |
.Xr groff 1 , |
| .Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
| .Xr mdoc 7 |
.Xr mdoc 7 , |
| .\" .Sh STANDARDS |
.Xr mdoc 3 |
| .\" .Sh HISTORY |
.\" |
| .Sh AUTHORS |
.Sh AUTHORS |
| The |
The |
| .Nm |
.Nm |
| utility was written by |
utility was written by |
| .An Em Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
| .\" |
.\" SECTION |
| .Sh CAVEATS |
.Sh CAVEATS |
| Most caveats of |
See |
| .Nm |
.Xr mdoc 3 |
| stem from ambiguities in |
for a list of bugs, caveats, and incomplete macros. |
| .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 |
|
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdocml.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc