Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdocml.1, Revision 1.31

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.24      kristaps   24: .It Fl W Ns Ar err...
1.27      kristaps   25: Print warning messages.  May be set to
                     26: .Fl W Ns Ar all
                     27: for all warnings,
                     28: .Ar compat
                     29: for groff/troff-compatibility warnings, or
                     30: .Ar syntax
                     31: for syntax warnings.  If
                     32: .Fl W Ns Ar error
                     33: is specified, warnings are considered errors and cause utility
                     34: termination.  Multiple
1.24      kristaps   35: .Fl W
                     36: arguments may be comma-separated, such as
                     37: .Fl W Ns Ar error,all .
1.23      kristaps   38: .It Fl v
1.27      kristaps   39: Print verbose parsing output.
1.2       kristaps   40: .It Ar infile
                     41: Read input from
                     42: .Ar infile ,
                     43: which may be
1.21      kristaps   44: .Dq \-
1.12      kristaps   45: for stdin.
1.2       kristaps   46: .El
1.31    ! kristaps   47: .\" PARAGRAPH
1.12      kristaps   48: .Pp
1.27      kristaps   49: Parsing and validation rules are drawn entirely from the
                     50: .Xr mdoc 7
                     51: and
                     52: .Xr mdoc.samples 7
                     53: manuals.
1.31    ! kristaps   54: .\" PARAGRAPH
1.27      kristaps   55: .Pp
1.12      kristaps   56: By default,
                     57: .Nm
1.27      kristaps   58: reads from stdin, writes messages to stdout, and writes errors and
                     59: warnings to stderr.
1.31    ! kristaps   60: .\" PARAGRAPH
1.20      kristaps   61: .Pp
                     62: .Ex -std mdocml
1.31    ! kristaps   63: .\" PARAGRAPH
1.28      kristaps   64: .Pp
                     65: .Nm
                     66: is
                     67: .Ud
1.31    ! kristaps   68: .\" SECTION
1.17      kristaps   69: .Sh EXAMPLES
1.27      kristaps   70: To validate this manual page:
1.31    ! kristaps   71: .\" PARAGRAPH
1.26      kristaps   72: .Pp
1.27      kristaps   73: .D1 % mdocml \-Wall,error mdocml.1
1.31    ! kristaps   74: .\" SECTION
1.3       kristaps   75: .Sh SEE ALSO
                     76: .Xr groff 1 ,
                     77: .Xr mdoc.samples 7 ,
1.27      kristaps   78: .Xr mdoc 7 ,
                     79: .Xr mdoc 3
1.31    ! kristaps   80: .\"
1.3       kristaps   81: .Sh AUTHORS
                     82: The
                     83: .Nm
                     84: utility was written by
1.22      kristaps   85: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.31    ! kristaps   86: .\" SECTION
1.3       kristaps   87: .Sh CAVEATS
1.30      kristaps   88: See
                     89: .Xr mdoc 3
                     90: for a list of bugs, caveats, and incomplete macros.