| version 1.1, 2008/11/22 14:53:29 |
version 1.31, 2009/02/20 23:35:36 |
|
|
| .\" $OpenBSD$ |
|
| .\" |
.\" |
| .\" The following requests are required for all man pages. |
.Dd $Mdocdate$ |
| .\" |
.Dt mdocml 1 |
| .\" Remove `\&' from the line below. |
|
| .Dd $\&Mdocdate$ |
|
| .Dt NAME SECTION# |
|
| .Os |
.Os |
| |
.\" SECTION |
| .Sh NAME |
.Sh NAME |
| .Nm program |
.Nm mdocml |
| .Nd one line about what it does |
.Nd mdoc macro compiler |
| |
.\" SECTION |
| .Sh SYNOPSIS |
.Sh SYNOPSIS |
| .\" For a program: program [-abc] file ... |
.Nm mdocml |
| .Nm program |
.Op Fl v |
| .Op Fl abc |
.Op Fl W Ns Ar err... |
| .Ar |
.Op Ar infile |
| |
.\" SECTION |
| .Sh DESCRIPTION |
.Sh DESCRIPTION |
| The |
The |
| .Nm |
.Nm |
| utility processes files ... |
utility interfaces the |
| something |
.Xr mdoc 3 |
| something. |
library to scan, parse and validate mdoc-macro documents. Arguments |
| .\" The following requests should be uncommented and used where appropriate. |
follow: |
| .\" This next request is for sections 2, 3, and 9 function return values only. |
.Bl -tag -width "\-Werr... " |
| .\" .Sh RETURN VALUES |
.It Fl W Ns Ar err... |
| .\" This next request is for sections 1, 6, 7 & 8 only. |
Print warning messages. May be set to |
| .\" .Sh ENVIRONMENT |
.Fl W Ns Ar all |
| .\" .Sh FILES |
for all warnings, |
| .\" .Sh EXAMPLES |
.Ar compat |
| .\" This next request is for sections 1, 4, 6, and 8 only. |
for groff/troff-compatibility warnings, or |
| .\" .Sh DIAGNOSTICS |
.Ar syntax |
| .\" The next request is for sections 2, 3, and 9 error and signal handling only. |
for syntax warnings. If |
| .\" .Sh ERRORS |
.Fl W Ns Ar error |
| .\" .Sh SEE ALSO |
is specified, warnings are considered errors and cause utility |
| .\" .Xr foobar 1 |
termination. Multiple |
| .\" .Sh STANDARDS |
.Fl W |
| .\" .Sh HISTORY |
arguments may be comma-separated, such as |
| .\" .Sh AUTHORS |
.Fl W Ns Ar error,all . |
| .\" .Sh CAVEATS |
.It Fl v |
| .\" .Sh BUGS |
Print verbose parsing output. |
| |
.It Ar infile |
| |
Read input from |
| |
.Ar infile , |
| |
which may be |
| |
.Dq \- |
| |
for stdin. |
| |
.El |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
Parsing and validation rules are drawn entirely from the |
| |
.Xr mdoc 7 |
| |
and |
| |
.Xr mdoc.samples 7 |
| |
manuals. |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
By default, |
| |
.Nm |
| |
reads from stdin, writes messages to stdout, and writes errors and |
| |
warnings to stderr. |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
.Ex -std mdocml |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
.Nm |
| |
is |
| |
.Ud |
| |
.\" SECTION |
| |
.Sh EXAMPLES |
| |
To validate this manual page: |
| |
.\" PARAGRAPH |
| |
.Pp |
| |
.D1 % mdocml \-Wall,error mdocml.1 |
| |
.\" SECTION |
| |
.Sh SEE ALSO |
| |
.Xr groff 1 , |
| |
.Xr mdoc.samples 7 , |
| |
.Xr mdoc 7 , |
| |
.Xr mdoc 3 |
| |
.\" |
| |
.Sh AUTHORS |
| |
The |
| |
.Nm |
| |
utility was written by |
| |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
| |
.\" SECTION |
| |
.Sh CAVEATS |
| |
See |
| |
.Xr mdoc 3 |
| |
for a list of bugs, caveats, and incomplete macros. |
![[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