1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
.\" $Id$
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the
.\" above copyright notice and this permission notice appear in all
.\" copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate$
.Dt mdocmterm 1
.Os
.\" SECTION
.Sh NAME
.Nm mdocmterm
.Nd mdoc macro compiler
.\" SECTION
.Sh SYNOPSIS
.Nm mdocmterm
.Op Fl v
.Op Fl W Ns Ar err...
.Op Ar infile
.\" SECTION
.Sh DESCRIPTION
The
.Nm
utility formats a BSD
.Dq mdoc
manual page for display on the terminal. The arguments are as follows:
.Bl -tag -width "\-Werr... "
.\" ITEM
.It Fl v
Print verbose parsing output.
.\" ITEM
.It Fl W Ns Ar err...
Print warning messages. May be set to
.Fl W Ns Ar all
for all warnings,
.Ar compat
for groff/troff-compatibility warnings, or
.Ar syntax
for syntax warnings. If
.Fl W Ns Ar error
is specified, warnings are considered errors and cause utility
termination. Multiple
.Fl W
arguments may be comma-separated, such as
.Fl W Ns Ar error,all .
.\" ITEM
.It Ar infile
Read input from
.Ar infile ,
which may be
.Dq \-
for stdin.
.El
.\" PARAGRAPH
.Pp
The
.Nm
utility is a formatting front-end for
.Xr mdoc 3 ,
which parses the
.Dq mdoc
input, documented at
.Xr mdoc 7
and
.Xr mdoc.samples 7 ,
into an abstract syntax tree.
.\" PARAGRAPH
.Pp
By default,
.Nm
reads from stdin and prints terminal-encoded output to stdout.
.\" PARAGRAPH
.Pp
.Ex -std mdocmterm
.\" PARAGRAPH
.Pp
.Nm
is
.Ud
.\" SUB-SECTION
.Ss Character Escapes
This section documents the character-escapes accepted by
.Xr mdocterm 1 .
Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx
and \\*x forms described in
.Xr mdoc.samples 7
are deprecated, but still correctly rendered. For all two-character
sequences, \\(xx is equivalent to the n-character \\[xx].
.Pp
Note that the
.Em Output
column will render differently whether executed with
.Xr mdocterm 1
or another output filter.
.\" PARAGRAPH
.Pp
Enclosures:
.Pp
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
.It Em Output
.Em Input (Name)
.It \(rB
\\(rB (right bracket)
.It \(lB
\\(rB (left bracket)
.It \(lq
\\(lq (left double-quote)
.It \(rq
\\(rq (right double-quote)
.It \(oq
\\(lq (left single-quote)
.It \(aq
\\(aq (right single-quote, apostrophe)
.El
.\" PARAGRAPH
.Pp
Indicatives:
.Pp
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
.It Em Output
.Em Input (Name)
.It \(<-
\\(<- (left arrow)
.It \(->
\\(-> (right arrow)
.It \(ua
\\(ua (up arrow)
.It \(da
\\(da (down arrow)
.El
.\" PARAGRAPH
.Pp
Mathematical:
.Pp
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
.It Em Output
.Em Input (Name)
.It \(<=
\\(<= (less-than-equal)
.It \(>=
\\(>= (greater-than-equal)
.It \(==
\\(== (greater-than-equal)
.It \(!=
\\(!= (not equal)
.It \(if
\\(if (infinity)
.It \(na
\\(na (NaN)*
.It \(+-
\\(+- (plus-minus)
.El
.\" PARAGRAPH
.Pp
*This is a deviation from the standard, as NaN is usually rendered as
\\*(Na, which is a deprecated form. We introduce \\(na, which follows
the more general syntax.
.Pp
Diacritics:
.Pp
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
.It Em Output
.Em Input (Name)
.It \(ga
\\(ga (accent grave)
.It \(aa
\\(aa (accent accute)
.El
.\" PARAGRAPH
.Pp
Special symbols:
.Pp
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
.It Em Output
.Em Input (Name)
.It \(bu
\\(bu (bullet)
.It \(ba
\\(ba (bar)
.El
.\" SECTION
.Sh EXAMPLES
To display this manual page:
.\" PARAGRAPH
.Pp
.D1 % mdocmterm \-Wall,error mdocmterm.1
.\" PARAGRAPH
.Pp
To pipe a manual page to the pager:
.Pp
.D1 % mdocterm mdocterm.1 | less -R
.\" SECTION
.Sh SEE ALSO
.Xr mdoctree 1 ,
.Xr mdoclint 1 ,
.Xr mdoc.samples 7 ,
.Xr mdoc 7 ,
.Xr mdoc 3
.\"
.Sh AUTHORS
The
.Nm
utility was written by
.An Kristaps Dzonsons Aq kristaps@kth.se .
.\" SECTION
.Sh CAVEATS
See
.Xr mdoc 3
for a list of bugs, caveats, and incomplete macros regarding the
document parse.
|
