Annotation of mandoc/mandoc_char.7, Revision 1.2
1.2 ! kristaps 1: .\" $Id: mandoc_char.7,v 1.1 2009/03/27 14:56:15 kristaps Exp $
1.1 kristaps 2: .\"
3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
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$
1.2 ! kristaps 20: .Dt MANDOC_CHAR 7
1.1 kristaps 21: .Os
22: .\" SECTION
23: .Sh NAME
24: .Nm mandoc_char
25: .Nd mandoc special characters
26: .\" SECTION
27: .Sh DESCRIPTION
28: This documents the special characters accepted by
29: .Xr mandoc 1
30: to format
31: .Xr mdoc 7
32: and
33: .Xr man 7
34: documents. Specific output devices of
35: .Xr mandoc 1 ,
36: dictated by the
37: .Fl T Ns Ar output
38: argument, will properly render these sequences.
39: .Pp
40: Both
41: .Xr mdoc 7
42: and
43: .Xr man 7
44: encode special characters with slightly different semantics; consult the
45: respective manuals for these escapes.
46: .Pp
47: Grammatic:
48: .Bl -tag -width 12n -offset "XXXX" -compact
49: .It \e(em
50: .Pq em-dash
51: .It \e(en
52: .Pq en-dash
53: .It \e-
54: .Pq hyphen
55: .It \e\e
56: .Pq back-slash
57: .It \e'
58: .Pq apostrophe
59: .It \e`
60: .Pq back-tick
61: .It \e
62: .Pq space
63: .It \e.
64: .Pq period
65: .It \e(r!
66: .Pq upside-down exclamation
67: .It \e(r?
68: .Pq upside-down question
69: .El
70: .\" PARAGRAPH
71: .Pp
72: Enclosures:
73: .Bl -tag -width 12n -offset "XXXX" -compact
74: .It \e(lh
75: .Pq left hand
76: .It \e(rh
77: .Pq right hand
78: .It \e(Fo
79: .Pq left guillemet
80: .It \e(Fc
81: .Pq right guillemet
82: .It \e(fo
83: .Pq left guilsing
84: .It \e(fc
85: .Pq right guilsing
86: .It \e(rC
87: .Pq right brace
88: .It \e(lC
89: .Pq left brace
90: .It \e(ra
91: .Pq right angle
92: .It \e(la
93: .Pq left angle
94: .It \e(rB
95: .Pq right bracket
96: .It \e(lB
97: .Pq left bracket
98: .It \eq
99: .Pq double-quote
100: .It \e(lq
101: .Pq left double-quote
102: .It \e(Lq
103: .Pq left double-quote, deprecated
104: .It \e(rq
105: .Pq right double-quote
106: .It \e(Rq
107: .Pq right double-quote, deprecated
108: .It \e(oq
109: .Pq left single-quote
110: .It \e(aq
111: .Pq right single-quote
112: .It \e(Bq
113: .Pq right low double-quote
114: .It \e(bq
115: .Pq right low single-quote
116: .El
117: .\" PARAGRAPH
118: .Pp
119: Indicatives:
120: .Bl -tag -width 12n -offset "XXXX" -compact
121: .It \e(<-
122: .Pq left arrow
123: .It \e(->
124: .Pq right arrow
125: .It \e(ua
126: .Pq up arrow
127: .It \e(da
128: .Pq down arrow
129: .It \e(<>
130: .Pq left-right arrow
131: .It \e(lA
132: .Pq left double-arrow
133: .It \e(rA
134: .Pq right double-arrow
135: .It \e(uA
136: .Pq up double-arrow
137: .It \e(dA
138: .Pq down double-arrow
139: .It \e(hA
140: .Pq left-right double-arrow
141: .El
142: .\" PARAGRAPH
143: .Pp
144: Mathematical:
145: .Bl -tag -width 12n -offset "XXXX" -compact
146: .It \e(es
147: .Pq empty set
148: .It \e(ca
149: .Pq intersection
150: .It \e(cu
151: .Pq union
152: .It \e(gr
153: .Pq gradient
154: .It \e(pd
155: .Pq partial differential
156: .It \e(ap
157: .Pq similarity
158: .It \e(=)
159: .Pq proper superset
160: .It \e((=
161: .Pq proper subset
162: .It \e(eq
163: .Pq equals
164: .It \e(di
165: .Pq division
166: .It \e(mu
167: .Pq multiplication
168: .It \e(pl
169: .Pq addition
170: .It \e(nm
171: .Pq not element
172: .It \e(mo
173: .Pq element
174: .It \e(Im
175: .Pq imaginary
176: .It \e(Re
177: .Pq real
178: .It \e(Ah
179: .Pq aleph
180: .It \e(te
181: .Pq existential quantifier
182: .It \e(fa
183: .Pq universal quantifier
184: .It \e(AN
185: .Pq logical AND
186: .It \e(OR
187: .Pq logical OR
188: .It \e(no
189: .Pq logical NOT
190: .It \e(st
191: .Pq such that
192: .It \e(tf
193: .Pq therefore
194: .It \e(~~
195: .Pq approximate
196: .It \e(~=
197: .Pq approximately equals
198: .It \e(=~
199: .Pq congruent
200: .It \e(Gt
201: .Pq greater-than, deprecated
202: .It \e(Lt
203: .Pq less-than, deprecated
204: .It \e(<=
205: .Pq less-than-equal
206: .It \e(Le
207: .Pq less-than-equal, deprecated
208: .It \e(>=
209: .Pq greater-than-equal
210: .It \e(Ge
211: .Pq greater-than-equal
212: .It \e(==
213: .Pq equal
214: .It \e(!=
215: .Pq not equal
216: .It \e(Ne
217: .Pq not equal, deprecated
218: .It \e(if
219: .Pq infinity
220: .It \e(If
221: .Pq infinity, deprecated
222: .It \e(na
223: .Pq NaN , an extension
224: .It \e(Na
225: .Pq NaN, deprecated
226: .It \e(+-
227: .Pq plus-minus
228: .It \e(Pm
229: .Pq plus-minus, deprecated
230: .It \e(**
231: .Pq asterisk
232: .El
233: .\" PARAGRAPH
234: .Pp
235: Ligatures:
236: .Bl -tag -width 12n -offset "XXXX" -compact
237: .It \e(ss
238: .Pq German eszett
239: .It \e(AE
240: .Pq upper-case AE
241: .It \e(ae
242: .Pq lower-case AE
243: .It \e(OE
244: .Pq upper-case OE
245: .It \e(oe
246: .Pq lower-case OE
247: .It \e(ff
248: .Pq ff ligature
249: .It \e(fi
250: .Pq fi ligature
251: .It \e(fl
252: .Pq fl ligature
253: .It \e(Fi
254: .Pq ffi ligature
255: .It \e(Fl
256: .Pq ffl ligature
257: .El
258: .\" PARAGRAPH
259: .Pp
260: Diacritics and letters:
261: .Bl -tag -width 12n -offset "XXXX" -compact
262: .It \e(ga
263: .Pq grave accent
264: .It \e(aa
265: .Pq accute accent
266: .It \e(a"
267: .Pq umlaut accent
268: .It \e(ad
269: .Pq dieresis accent
270: .It \e(a~
271: .Pq tilde accent
272: .It \e(a^
273: .Pq circumflex accent
274: .It \e(ac
275: .Pq cedilla accent
276: .It \e(ad
277: .Pq dieresis accent
278: .It \e(ah
279: .Pq caron accent
280: .It \e(ao
281: .Pq ring accent
282: .It \e(ho
283: .Pq hook accent
284: .It \e(ab
285: .Pq breve accent
286: .It \e(a-
287: .Pq macron accent
288: .It \e(-D
289: .Pq upper-case eth
290: .It \e(Sd
291: .Pq lower-case eth
292: .It \e(TP
293: .Pq upper-case thorn
294: .It \e(Tp
295: .Pq lower-case thorn
296: .It \e('A
297: .Pq upper-case acute A
298: .It \e('E
299: .Pq upper-case acute E
300: .It \e('I
301: .Pq upper-case acute I
302: .It \e('O
303: .Pq upper-case acute O
304: .It \e('U
305: .Pq upper-case acute U
306: .It \e('a
307: .Pq lower-case acute a
308: .It \e('e
309: .Pq lower-case acute e
310: .It \e('i
311: .Pq lower-case acute i
312: .It \e('o
313: .Pq lower-case acute o
314: .It \e('u
315: .Pq lower-case acute u
316: .It \e(`A
317: .Pq upper-case grave A
318: .It \e(`E
319: .Pq upper-case grave E
320: .It \e(`I
321: .Pq upper-case grave I
322: .It \e(`O
323: .Pq upper-case grave O
324: .It \e(`U
325: .Pq upper-case grave U
326: .It \e(`a
327: .Pq lower-case grave a
328: .It \e(`e
329: .Pq lower-case grave e
330: .It \e(`i
331: .Pq lower-case grave i
332: .It \e(`o
333: .Pq lower-case grave o
334: .It \e(`u
335: .Pq lower-case grave u
336: .It \e(~A
337: .Pq upper-case tilde A
338: .It \e(~N
339: .Pq upper-case tilde N
340: .It \e(~O
341: .Pq upper-case tilde O
342: .It \e(~a
343: .Pq lower-case tilde a
344: .It \e(~n
345: .Pq lower-case tilde n
346: .It \e(~o
347: .Pq lower-case tilde o
348: .It \e(:A
349: .Pq upper-case dieresis A
350: .It \e(:E
351: .Pq upper-case dieresis E
352: .It \e(:I
353: .Pq upper-case dieresis I
354: .It \e(:O
355: .Pq upper-case dieresis O
356: .It \e(:U
357: .Pq upper-case dieresis U
358: .It \e(:a
359: .Pq lower-case dieresis a
360: .It \e(:e
361: .Pq lower-case dieresis e
362: .It \e(:i
363: .Pq lower-case dieresis i
364: .It \e(:o
365: .Pq lower-case dieresis o
366: .It \e(:u
367: .Pq lower-case dieresis u
368: .It \e(:y
369: .Pq lower-case dieresis y
370: .It \e(^A
371: .Pq upper-case circumflex A
372: .It \e(^E
373: .Pq upper-case circumflex E
374: .It \e(^I
375: .Pq upper-case circumflex I
376: .It \e(^O
377: .Pq upper-case circumflex O
378: .It \e(^U
379: .Pq upper-case circumflex U
380: .It \e(^a
381: .Pq lower-case circumflex a
382: .It \e(^e
383: .Pq lower-case circumflex e
384: .It \e(^i
385: .Pq lower-case circumflex i
386: .It \e(^o
387: .Pq lower-case circumflex o
388: .It \e(^u
389: .Pq lower-case circumflex u
390: .It \e(,C
391: .Pq upper-case cedilla C
392: .It \e(,c
393: .Pq lower-case cedilla c
394: .It \e(/L
395: .Pq upper-case stroke L
396: .It \e(/l
397: .Pq lower-case stroke l
398: .It \e(/O
399: .Pq upper-case stroke O
400: .It \e(/o
401: .Pq lower-case stroke o
402: .It \e(oA
403: .Pq upper-case ring A
404: .It \e(oa
405: .Pq lower-case ring a
406: .El
407: .\" PARAGRAPH
408: .Pp
409: Monetary:
410: .Bl -tag -width 12n -offset "XXXX" -compact
411: .It \e(Cs
412: .Pq Scandinavian
413: .It \e(Do
414: .Pq dollar
415: .It \e(Po
416: .Pq pound
417: .It \e(Ye
418: .Pq yen
419: .It \e(Fn
420: .Pq florin
421: .It \e(ct
422: .Pq cent
423: .El
424: .\" PARAGRAPH
425: .Pp
426: Special symbols:
427: .Bl -tag -width 12n -offset "XXXX" -compact
428: .It \e0
429: .Pq white-space
430: .It \e(de
431: .Pq degree
432: .It \e(ps
433: .Pq paragraph
434: .It \e(sc
435: .Pq section
436: .It \e(dg
437: .Pq dagger
438: .It \e(dd
439: .Pq double dagger
440: .It \e(ci
441: .Pq circle
442: .It \e(ba
443: .Pq bar
444: .It \e(bb
445: .Pq broken bar
446: .It \e(Ba
447: .Pq bar, deprecated
448: .It \e(co
449: .Pq copyright
450: .It \e(rg
451: .Pq registered
452: .It \e(tm
453: .Pq trademarked
454: .It \e&
455: .Pq non-breaking space
456: .It \ee
457: .Pq escape
458: .It \e(Am
459: .Pq ampersand, deprecated
460: .El
461: .\" SECTION
462: .Sh SEE ALSO
463: .Xr mandoc 1
464: .\" SECTION
465: .Sh AUTHORS
466: The
467: .Nm
468: utility was written by
469: .An Kristaps Dzonsons Aq kristaps@openbsd.org .
CVSweb