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