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