Annotation of mandoc/mdocml.1, Revision 1.32
1.1 kristaps 1: .\"
1.2 kristaps 2: .Dd $Mdocdate$
1.25 kristaps 3: .Dt mdocml 1
1.1 kristaps 4: .Os
1.31 kristaps 5: .\" SECTION
1.1 kristaps 6: .Sh NAME
1.2 kristaps 7: .Nm mdocml
1.27 kristaps 8: .Nd mdoc macro compiler
1.31 kristaps 9: .\" SECTION
1.1 kristaps 10: .Sh SYNOPSIS
1.2 kristaps 11: .Nm mdocml
1.24 kristaps 12: .Op Fl v
13: .Op Fl W Ns Ar err...
1.2 kristaps 14: .Op Ar infile
1.31 kristaps 15: .\" SECTION
1.1 kristaps 16: .Sh DESCRIPTION
17: The
18: .Nm
1.27 kristaps 19: utility interfaces the
20: .Xr mdoc 3
1.29 kristaps 21: library to scan, parse and validate mdoc-macro documents. Arguments
22: follow:
1.27 kristaps 23: .Bl -tag -width "\-Werr... "
1.32 ! kristaps 24: .\" ITEM
1.24 kristaps 25: .It Fl W Ns Ar err...
1.27 kristaps 26: Print warning messages. May be set to
27: .Fl W Ns Ar all
28: for all warnings,
29: .Ar compat
30: for groff/troff-compatibility warnings, or
31: .Ar syntax
32: for syntax warnings. If
33: .Fl W Ns Ar error
34: is specified, warnings are considered errors and cause utility
35: termination. Multiple
1.24 kristaps 36: .Fl W
37: arguments may be comma-separated, such as
38: .Fl W Ns Ar error,all .
1.32 ! kristaps 39: .\" ITEM
1.23 kristaps 40: .It Fl v
1.27 kristaps 41: Print verbose parsing output.
1.32 ! kristaps 42: .\" ITEM
1.2 kristaps 43: .It Ar infile
44: Read input from
45: .Ar infile ,
46: which may be
1.21 kristaps 47: .Dq \-
1.12 kristaps 48: for stdin.
1.2 kristaps 49: .El
1.31 kristaps 50: .\" PARAGRAPH
1.12 kristaps 51: .Pp
1.27 kristaps 52: Parsing and validation rules are drawn entirely from the
53: .Xr mdoc 7
54: and
55: .Xr mdoc.samples 7
56: manuals.
1.31 kristaps 57: .\" PARAGRAPH
1.27 kristaps 58: .Pp
1.12 kristaps 59: By default,
60: .Nm
1.27 kristaps 61: reads from stdin, writes messages to stdout, and writes errors and
62: warnings to stderr.
1.31 kristaps 63: .\" PARAGRAPH
1.20 kristaps 64: .Pp
65: .Ex -std mdocml
1.31 kristaps 66: .\" PARAGRAPH
1.28 kristaps 67: .Pp
68: .Nm
69: is
70: .Ud
1.31 kristaps 71: .\" SECTION
1.17 kristaps 72: .Sh EXAMPLES
1.27 kristaps 73: To validate this manual page:
1.31 kristaps 74: .\" PARAGRAPH
1.26 kristaps 75: .Pp
1.27 kristaps 76: .D1 % mdocml \-Wall,error mdocml.1
1.31 kristaps 77: .\" SECTION
1.3 kristaps 78: .Sh SEE ALSO
79: .Xr groff 1 ,
80: .Xr mdoc.samples 7 ,
1.27 kristaps 81: .Xr mdoc 7 ,
82: .Xr mdoc 3
1.31 kristaps 83: .\"
1.3 kristaps 84: .Sh AUTHORS
85: The
86: .Nm
87: utility was written by
1.22 kristaps 88: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.31 kristaps 89: .\" SECTION
1.3 kristaps 90: .Sh CAVEATS
1.30 kristaps 91: See
92: .Xr mdoc 3
93: for a list of bugs, caveats, and incomplete macros.
CVSweb