Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdocml.1, Revision 1.29

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
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.12      kristaps   47: .Pp
1.27      kristaps   48: Parsing and validation rules are drawn entirely from the
                     49: .Xr mdoc 7
                     50: and
                     51: .Xr mdoc.samples 7
                     52: manuals.
                     53: .Pp
1.12      kristaps   54: By default,
                     55: .Nm
1.27      kristaps   56: reads from stdin, writes messages to stdout, and writes errors and
                     57: warnings to stderr.
1.20      kristaps   58: .Pp
                     59: .Ex -std mdocml
1.28      kristaps   60: .Pp
                     61: .Nm
                     62: is
                     63: .Ud
1.18      kristaps   64: .\"
1.17      kristaps   65: .Sh EXAMPLES
1.27      kristaps   66: To validate this manual page:
1.26      kristaps   67: .Pp
1.27      kristaps   68: .D1 % mdocml \-Wall,error mdocml.1
1.12      kristaps   69: .\"
1.3       kristaps   70: .Sh SEE ALSO
                     71: .Xr groff 1 ,
                     72: .Xr mdoc.samples 7 ,
1.27      kristaps   73: .Xr mdoc 7 ,
                     74: .Xr mdoc 3
1.1       kristaps   75: .\" .Sh STANDARDS
                     76: .\" .Sh HISTORY
1.3       kristaps   77: .Sh AUTHORS
                     78: The
                     79: .Nm
                     80: utility was written by
1.22      kristaps   81: .An Kristaps Dzonsons Aq kristaps@kth.se .
1.3       kristaps   82: .\"
                     83: .Sh CAVEATS
1.27      kristaps   84: The most glaring short-coming of
1.3       kristaps   85: .Nm
1.27      kristaps   86: is that it doesn't yet support the
                     87: .Sq \&Xc
1.12      kristaps   88: and
1.3       kristaps   89: .Sq \&Xo
1.27      kristaps   90: macros when used to extend the line arguments to
                     91: .Sq \&It ;
                     92: in effect, trampling the body section.  We note that this is explicitly
                     93: discouraged in
                     94: .Xr mdoc.samples 7 ,
                     95: but in practice used quite often.
1.1       kristaps   96: .\" .Sh BUGS