Return to mdocml.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdocml.1, Revision 1.33

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