Annotation of mandoc/mdocterm.1, Revision 1.11
1.11 ! kristaps 1: .\" $Id: mdocterm.1,v 1.10 2009/03/03 21:07:01 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 mdocmterm 1
21: .Os
22: .\" SECTION
23: .Sh NAME
24: .Nm mdocmterm
25: .Nd mdoc macro compiler
26: .\" SECTION
27: .Sh SYNOPSIS
28: .Nm mdocmterm
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 formats a BSD
37: .Dq mdoc
38: manual page for display on the terminal. 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
1.2 kristaps 67: .Pp
1.1 kristaps 68: The
69: .Nm
70: utility is a formatting front-end for
71: .Xr mdoc 3 ,
72: which parses the
73: .Dq mdoc
74: input, documented at
75: .Xr mdoc 7
76: and
77: .Xr mdoc.samples 7 ,
78: into an abstract syntax tree.
79: .\" PARAGRAPH
80: .Pp
81: By default,
82: .Nm
83: reads from stdin and prints terminal-encoded output to stdout.
84: .\" PARAGRAPH
85: .Pp
86: .Ex -std mdocmterm
87: .\" PARAGRAPH
88: .Pp
89: .Nm
90: is
91: .Ud
1.7 kristaps 92: .\" SUB-SECTION
93: .Ss Character Escapes
94: This section documents the character-escapes accepted by
95: .Xr mdocterm 1 .
1.10 kristaps 96: Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx,
97: \\*[n] and \\*x forms described in
1.7 kristaps 98: .Xr mdoc.samples 7
1.10 kristaps 99: are deprecated, but still rendered. All one- and two-character
100: sequences may be used in the n-character sequence \\[n].
1.7 kristaps 101: .Pp
102: Note that the
103: .Em Output
104: column will render differently whether executed with
105: .Xr mdocterm 1
106: or another output filter.
107: .\" PARAGRAPH
108: .Pp
1.10 kristaps 109: Grammatic:
110: .Pp
111: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
112: .It Em Output
113: .Em Input (Name)
114: .It \(em
115: \\(em (em-dash)
116: .It \(en
117: \\(en (en-dash)
118: .It \-
119: \\- (hyphen)
120: .It \\
121: \\ (back-slash)
122: .El
123: .\" PARAGRAPH
124: .Pp
1.7 kristaps 125: Enclosures:
126: .Pp
127: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
128: .It Em Output
129: .Em Input (Name)
130: .It \(rB
131: \\(rB (right bracket)
132: .It \(lB
133: \\(rB (left bracket)
134: .It \(lq
135: \\(lq (left double-quote)
136: .It \(rq
1.10 kristaps 137: \\(rq, \\' (right double-quote)
1.7 kristaps 138: .It \(oq
1.10 kristaps 139: \\(lq, \\` (left single-quote)
1.7 kristaps 140: .It \(aq
141: \\(aq (right single-quote, apostrophe)
142: .El
143: .\" PARAGRAPH
144: .Pp
145: Indicatives:
146: .Pp
147: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
148: .It Em Output
149: .Em Input (Name)
150: .It \(<-
151: \\(<- (left arrow)
152: .It \(->
153: \\(-> (right arrow)
154: .It \(ua
155: \\(ua (up arrow)
156: .It \(da
157: \\(da (down arrow)
158: .El
159: .\" PARAGRAPH
160: .Pp
161: Mathematical:
162: .Pp
163: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
164: .It Em Output
165: .Em Input (Name)
166: .It \(<=
167: \\(<= (less-than-equal)
168: .It \(>=
169: \\(>= (greater-than-equal)
170: .It \(==
171: \\(== (greater-than-equal)
172: .It \(!=
173: \\(!= (not equal)
174: .It \(if
175: \\(if (infinity)
176: .It \(na
177: \\(na (NaN)*
178: .It \(+-
179: \\(+- (plus-minus)
1.10 kristaps 180: .It \(**
181: \\(** (asterisk)
1.7 kristaps 182: .El
183: .\" PARAGRAPH
184: .Pp
185: Diacritics:
186: .Pp
187: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
188: .It Em Output
189: .Em Input (Name)
190: .It \(ga
191: \\(ga (accent grave)
192: .It \(aa
193: \\(aa (accent accute)
194: .El
195: .\" PARAGRAPH
196: .Pp
197: Special symbols:
198: .Pp
199: .Bl -tag -width "OutputXXXX" -offset "XXXX" -compact
200: .It Em Output
201: .Em Input (Name)
202: .It \(bu
203: \\(bu (bullet)
204: .It \(ba
205: \\(ba (bar)
1.10 kristaps 206: .It \(co
207: \\(co (copyright)
1.7 kristaps 208: .El
1.10 kristaps 209: .Pp
210: *This is a deviation from the standard, as NaN is usually rendered as
211: \\*(Na, which is a deprecated form. We introduce \\(na, which follows
212: the more general syntax.
1.1 kristaps 213: .\" SECTION
214: .Sh EXAMPLES
215: To display this manual page:
216: .\" PARAGRAPH
217: .Pp
218: .D1 % mdocmterm \-Wall,error mdocmterm.1
1.2 kristaps 219: .\" PARAGRAPH
220: .Pp
221: To pipe a manual page to the pager:
222: .Pp
223: .D1 % mdocterm mdocterm.1 | less -R
1.1 kristaps 224: .\" SECTION
225: .Sh SEE ALSO
226: .Xr mdoctree 1 ,
1.3 kristaps 227: .Xr mdoclint 1 ,
1.1 kristaps 228: .Xr mdoc.samples 7 ,
229: .Xr mdoc 7 ,
230: .Xr mdoc 3
231: .\"
232: .Sh AUTHORS
233: The
234: .Nm
235: utility was written by
236: .An Kristaps Dzonsons Aq kristaps@kth.se .
237: .\" SECTION
238: .Sh CAVEATS
239: See
240: .Xr mdoc 3
1.4 kristaps 241: for a list of bugs, caveats, and incomplete macros regarding the
242: document parse.
1.9 kristaps 243: .Pp
244: The
245: .Nm
246: utility doesn't yet know how to display the following:
247: .Pp
248: .Bl -bullet -compact
249: .It
1.11 ! kristaps 250: The \-hang and \-column
1.9 kristaps 251: .Sq \&Bl
1.11 ! kristaps 252: lists are not yet supported.
1.9 kristaps 253: .It
254: The \-literal and \-unfilled
255: .Sq \&Bd
256: displays only accept text contents.
257: .It
258: The
259: .Sq \&Xo/Xc
260: pair isn't supported (and never will be).
261: .El
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdocterm.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc