Annotation of mandoc/mdoctree.1, Revision 1.4
1.4 ! kristaps 1: .\" $Id: mdoctree.1,v 1.3 2009/02/22 19:23:48 kristaps Exp $
1.1 kristaps 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
1.3 kristaps 38: manual pages and prints its syntax tree. It's commonly used to see the
39: syntax tree of a document when building new
40: .Xr mdoc 3
41: utilities. The arguments are as follows:
1.1 kristaps 42: .Bl -tag -width "\-Werr... "
43: .\" ITEM
44: .It Fl v
45: Print verbose parsing output.
46: .\" ITEM
47: .It Fl W Ns Ar err...
48: Print warning messages. May be set to
49: .Fl W Ns Ar all
50: for all warnings,
51: .Ar compat
52: for groff/troff-compatibility warnings, or
53: .Ar syntax
54: for syntax warnings. If
55: .Fl W Ns Ar error
56: is specified, warnings are considered errors and cause utility
57: termination. Multiple
58: .Fl W
59: arguments may be comma-separated, such as
60: .Fl W Ns Ar error,all .
61: .\" ITEM
62: .It Ar infile
63: Read input from
64: .Ar infile ,
65: which may be
66: .Dq \-
67: for stdin.
68: .El
69: .\" PARAGRAPH
1.2 kristaps 70: .Pp
1.1 kristaps 71: The
72: .Nm
73: utility is a formatting front-end for
74: .Xr mdoc 3 ,
75: which parses the
76: .Dq mdoc
77: input, documented at
78: .Xr mdoc 7
79: and
80: .Xr mdoc.samples 7 ,
81: into an abstract syntax tree.
82: .\" PARAGRAPH
83: .Pp
84: By default,
85: .Nm
86: reads from stdin and prints the syntax tree to stdout.
87: .\" PARAGRAPH
88: .Pp
89: .Ex -std mdoctree
90: .\" PARAGRAPH
91: .Pp
92: .Nm
93: is
94: .Ud
95: .\" SECTION
96: .Sh EXAMPLES
97: To validate this manual page:
98: .\" PARAGRAPH
99: .Pp
100: .D1 % mdoctree \-Wall,error mdoctree.1
101: .\" SECTION
102: .Sh SEE ALSO
103: .Xr mdocterm 1 ,
1.4 ! kristaps 104: .Xr mdoclint 1 ,
1.1 kristaps 105: .Xr mdoc.samples 7 ,
106: .Xr mdoc 7 ,
107: .Xr mdoc 3
108: .\"
109: .Sh AUTHORS
110: The
111: .Nm
112: utility was written by
113: .An Kristaps Dzonsons Aq kristaps@kth.se .
114: .\" SECTION
115: .Sh CAVEATS
116: See
117: .Xr mdoc 3
118: for a list of bugs, caveats, and incomplete macros.
CVSweb