Annotation of mandoc/mdocml.1, Revision 1.27
1.1 kristaps 1: .\"
1.2 kristaps 2: .Dd $Mdocdate$
1.25 kristaps 3: .Dt mdocml 1
1.1 kristaps 4: .Os
1.3 kristaps 5: .\"
1.1 kristaps 6: .Sh NAME
1.2 kristaps 7: .Nm mdocml
1.27 ! kristaps 8: .Nd mdoc macro compiler
1.3 kristaps 9: .\"
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.3 kristaps 15: .\"
1.1 kristaps 16: .Sh DESCRIPTION
17: The
18: .Nm
1.27 ! kristaps 19: utility interfaces the
! 20: .Xr mdoc 3
! 21: library to validate and parse mdoc-macro documents. Arguments follow:
! 22: .Bl -tag -width "\-Werr... "
1.24 kristaps 23: .It Fl W Ns Ar err...
1.27 ! kristaps 24: Print warning messages. May be set to
! 25: .Fl W Ns Ar all
! 26: for all warnings,
! 27: .Ar compat
! 28: for groff/troff-compatibility warnings, or
! 29: .Ar syntax
! 30: for syntax warnings. If
! 31: .Fl W Ns Ar error
! 32: is specified, warnings are considered errors and cause utility
! 33: termination. Multiple
1.24 kristaps 34: .Fl W
35: arguments may be comma-separated, such as
36: .Fl W Ns Ar error,all .
1.23 kristaps 37: .It Fl v
1.27 ! kristaps 38: Print verbose parsing output.
1.2 kristaps 39: .It Ar infile
40: Read input from
41: .Ar infile ,
42: which may be
1.21 kristaps 43: .Dq \-
1.12 kristaps 44: for stdin.
1.2 kristaps 45: .El
1.12 kristaps 46: .Pp
1.27 ! kristaps 47: Parsing and validation rules are drawn entirely from the
! 48: .Xr mdoc 7
! 49: and
! 50: .Xr mdoc.samples 7
! 51: manuals.
! 52: .Pp
1.12 kristaps 53: By default,
54: .Nm
1.27 ! kristaps 55: reads from stdin, writes messages to stdout, and writes errors and
! 56: warnings to stderr.
1.20 kristaps 57: .Pp
58: .Ex -std mdocml
1.18 kristaps 59: .\"
1.17 kristaps 60: .Sh EXAMPLES
1.27 ! kristaps 61: To validate this manual page:
1.26 kristaps 62: .Pp
1.27 ! kristaps 63: .D1 % mdocml \-Wall,error mdocml.1
1.12 kristaps 64: .\"
1.3 kristaps 65: .Sh SEE ALSO
66: .Xr groff 1 ,
67: .Xr mdoc.samples 7 ,
1.27 ! kristaps 68: .Xr mdoc 7 ,
! 69: .Xr mdoc 3
1.1 kristaps 70: .\" .Sh STANDARDS
71: .\" .Sh HISTORY
1.3 kristaps 72: .Sh AUTHORS
73: The
74: .Nm
75: utility was written by
1.22 kristaps 76: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.3 kristaps 77: .\"
78: .Sh CAVEATS
1.27 ! kristaps 79: The most glaring short-coming of
1.3 kristaps 80: .Nm
1.27 ! kristaps 81: is that it doesn't yet support the
! 82: .Sq \&Xc
1.12 kristaps 83: and
1.3 kristaps 84: .Sq \&Xo
1.27 ! kristaps 85: macros when used to extend the line arguments to
! 86: .Sq \&It ;
! 87: in effect, trampling the body section. We note that this is explicitly
! 88: discouraged in
! 89: .Xr mdoc.samples 7 ,
! 90: but in practice used quite often.
1.1 kristaps 91: .\" .Sh BUGS
CVSweb