Return to mdoctree.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdoctree.1, Revision 1.1

1.1     ! kristaps    1: .\" $Id: mdoc.c,v 1.45 2009/02/20 07:43:15 kristaps Exp $
        !             2: .\"
        !             3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
        !             4: .\"
        !             5: .\" Permission to use, copy, modify, and distribute this software for any
        !             6: .\" purpose with or without fee is hereby granted, provided that the
        !             7: .\" above copyright notice and this permission notice appear in all
        !             8: .\" copies.
        !             9: .\"
        !            10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
        !            11: .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
        !            12: .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
        !            13: .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
        !            14: .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
        !            15: .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
        !            16: .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
        !            17: .\" PERFORMANCE OF THIS SOFTWARE.
        !            18: .\"
        !            19: .Dd $Mdocdate$
        !            20: .Dt mdoctree 1
        !            21: .Os
        !            22: .\" SECTION
        !            23: .Sh NAME
        !            24: .Nm mdoctree
        !            25: .Nd mdoc macro compiler
        !            26: .\" SECTION
        !            27: .Sh SYNOPSIS
        !            28: .Nm mdoctree
        !            29: .Op Fl v
        !            30: .Op Fl W Ns Ar err...
        !            31: .Op Ar infile
        !            32: .\" SECTION
        !            33: .Sh DESCRIPTION
        !            34: The
        !            35: .Nm
        !            36: utility parses a BSD
        !            37: .Dq mdoc
        !            38: manual pages and prints its syntax tree.  The arguments are as follows:
        !            39: .Bl -tag -width "\-Werr... "
        !            40: .\" ITEM
        !            41: .It Fl v
        !            42: Print verbose parsing output.
        !            43: .\" ITEM
        !            44: .It Fl W Ns Ar err...
        !            45: Print warning messages.  May be set to
        !            46: .Fl W Ns Ar all
        !            47: for all warnings,
        !            48: .Ar compat
        !            49: for groff/troff-compatibility warnings, or
        !            50: .Ar syntax
        !            51: for syntax warnings.  If
        !            52: .Fl W Ns Ar error
        !            53: is specified, warnings are considered errors and cause utility
        !            54: termination.  Multiple
        !            55: .Fl W
        !            56: arguments may be comma-separated, such as
        !            57: .Fl W Ns Ar error,all .
        !            58: .\" ITEM
        !            59: .It Ar infile
        !            60: Read input from
        !            61: .Ar infile ,
        !            62: which may be
        !            63: .Dq \-
        !            64: for stdin.
        !            65: .El
        !            66: .\" PARAGRAPH
        !            67: The
        !            68: .Nm
        !            69: utility is a formatting front-end for
        !            70: .Xr mdoc 3 ,
        !            71: which parses the
        !            72: .Dq mdoc
        !            73: input, documented at
        !            74: .Xr mdoc 7
        !            75: and
        !            76: .Xr mdoc.samples 7 ,
        !            77: into an abstract syntax tree.
        !            78: .\" PARAGRAPH
        !            79: .Pp
        !            80: By default,
        !            81: .Nm
        !            82: reads from stdin and prints the syntax tree to stdout.
        !            83: .\" PARAGRAPH
        !            84: .Pp
        !            85: .Ex -std mdoctree
        !            86: .\" PARAGRAPH
        !            87: .Pp
        !            88: .Nm
        !            89: is
        !            90: .Ud
        !            91: .\" SECTION
        !            92: .Sh EXAMPLES
        !            93: To validate this manual page:
        !            94: .\" PARAGRAPH
        !            95: .Pp
        !            96: .D1 % mdoctree \-Wall,error mdoctree.1
        !            97: .\" SECTION
        !            98: .Sh SEE ALSO
        !            99: .Xr mdocterm 1 ,
        !           100: .Xr mdoc.samples 7 ,
        !           101: .Xr mdoc 7 ,
        !           102: .Xr mdoc 3
        !           103: .\"
        !           104: .Sh AUTHORS
        !           105: The
        !           106: .Nm
        !           107: utility was written by
        !           108: .An Kristaps Dzonsons Aq kristaps@kth.se .
        !           109: .\" SECTION
        !           110: .Sh CAVEATS
        !           111: See
        !           112: .Xr mdoc 3
        !           113: for a list of bugs, caveats, and incomplete macros.