Annotation of mandoc/mandoc_char.7, Revision 1.16
1.16 ! kristaps 1: .\" $Id: mandoc_char.7,v 1.15 2009/09/22 10:11:57 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
1.10 kristaps 26: This documents the special characters and predefined strings accepted by
1.1 kristaps 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.
1.10 kristaps 37: .\" PARAGRAPH
1.1 kristaps 38: .Pp
39: Both
40: .Xr mdoc 7
41: and
42: .Xr man 7
1.10 kristaps 43: encode special characters with
1.9 kristaps 44: .Sq \eX
45: .Pq for a one-character escape ,
46: .Sq \e(XX
47: .Pq two-character ,
48: and
49: .Sq \e[N]
50: .Pq N-character .
51: One may generalise
52: .Sq \e(XX
53: as
1.12 kristaps 54: .Sq \e[XX]
1.10 kristaps 55: and
56: .Sq \eX
57: as
58: .Sq \e[X] .
59: Predefined strings are functionally similar to special characters, using
60: .Sq \e*X
61: .Pq for a one-character escape ,
62: .Sq \e*(XX
63: .Pq two-character ,
64: and
65: .Sq \e*[N]
66: .Pq N-character .
67: One may generalise
68: .Sq \e*(XX
69: as
70: .Sq \e*[XX]
71: and
72: .Sq \e*X
73: as
74: .Sq \e*[X] .
75: .\" SECTION
76: .Sh Special Characters
77: These are the preferred input symbols for producing special characters.
1.8 kristaps 78: .\" PARAGRAPH
79: .Pp
80: Typographic:
81: .Bl -tag -width Ds -offset indent -compact
82: .It \e~
83: .Pq non-breaking space
84: .It \e
85: .Pq space
86: .It \e^
87: .Pq zero-width space
1.9 kristaps 88: .It \e%
1.8 kristaps 89: .Pq zero-width space
90: .It \e&
91: .Pq zero-width space
1.9 kristaps 92: .It \e|
93: .Pq zero-width space
1.8 kristaps 94: .El
95: .\" PARAGRAPH
1.1 kristaps 96: .Pp
97: Grammatic:
1.16 ! kristaps 98: .Bl -offset indent -column 10n 10n 10n
! 99: .It \e(em Ta \(em Ta em-dash
! 100: .It \e(en Ta \(en Ta en-dash
! 101: .It \e(hy Ta \(hy Ta hyphen
! 102: .It \e\e Ta \\ Ta back-slash
! 103: .It \\e Ta \e Ta back-slash
! 104: .It \e' Ta \' Ta apostrophe
! 105: .It \e` Ta \` Ta back-tick
! 106: .It \e. Ta \. Ta period
! 107: .It \e(r! Ta \(r! Ta upside-down exclamation
! 108: .It \e(r? Ta \(r? Ta upside-down question
1.1 kristaps 109: .El
110: .\" PARAGRAPH
111: .Pp
112: Enclosures:
1.16 ! kristaps 113: .Bl -offset indent -column 10n 10n 10n
! 114: .It \e(lh Ta \(lh Ta left hand
! 115: .It \e(rh Ta \(rh Ta right hand
! 116: .It \e(Fo Ta \(Fo Ta left guillemet
! 117: .It \e(Fc Ta \(Fc Ta right guillemet
! 118: .It \e(fo Ta \(fo Ta left guilsing
! 119: .It \e(fc Ta \(fc Ta right guilsing
! 120: .It \e(rC Ta \(rC Ta right brace
! 121: .It \e(lC Ta \(lC Ta left brace
! 122: .It \e(ra Ta \(ra Ta right angle
! 123: .It \e(la Ta \(la Ta left angle
! 124: .It \e(rB Ta \(rB Ta right bracket
! 125: .It \e(lB Ta \(lB Ta left bracket
! 126: .It \e(lq Ta \(lq Ta left double-quote
! 127: .It \e(rq Ta \(rq Ta right double-quote
! 128: .It \e(oq Ta \(oq Ta left single-quote
! 129: .It \e(aq Ta \(aq Ta right single-quote
! 130: .It \e(Bq Ta \(Bq Ta right low double-quote
! 131: .It \e(bq Ta \(ba Ta right low single-quote
1.1 kristaps 132: .El
133: .\" PARAGRAPH
134: .Pp
135: Indicatives:
1.16 ! kristaps 136: .Bl -offset indent -column 10n 10n 10n
! 137: .It \e(<- Ta \(<- Ta left arrow
! 138: .It \e(-> Ta \(-> Ta right arrow
! 139: .It \e(ua Ta \(ua Ta up arrow
! 140: .It \e(da Ta \(da Ta down arrow
! 141: .It \e(<> Ta \(<> Ta left-right arrow
! 142: .It \e(lA Ta \(lA Ta left double-arrow
! 143: .It \e(rA Ta \(rA Ta right double-arrow
! 144: .It \e(uA Ta \(uA Ta up double-arrow
! 145: .It \e(dA Ta \(dA Ta down double-arrow
! 146: .It \e(hA Ta \(hA Ta left-right double-arrow
1.1 kristaps 147: .El
148: .\" PARAGRAPH
149: .Pp
150: Mathematical:
1.16 ! kristaps 151: .Bl -offset indent -column 10n 10n 10n
! 152: .It \e(es Ta \(es Ta empty set
! 153: .It \e(ca Ta \(ca Ta intersection
! 154: .It \e(cu Ta \(cu Ta union
! 155: .It \e(gr Ta \(gr Ta gradient
! 156: .It \e(pd Ta \(dd Ta partial differential
! 157: .It \e(ap Ta \(ap Ta similarity
! 158: .It \e(sp Ta \(sp Ta proper superset
! 159: .It \e(sb Ta \(sb Ta proper subset
! 160: .It \e(eq Ta \(eq Ta equals
! 161: .It \e(di Ta \(di Ta division
! 162: .It \e(mu Ta \(mu Ta multiplication
! 163: .It \e(pl Ta \(pl Ta addition
! 164: .It \e- Ta \- Ta subtraction
! 165: .It \e(nm Ta \(nm Ta not element
! 166: .It \e(mo Ta \(mo Ta element
! 167: .It \e(Im Ta \(Im Ta imaginary
! 168: .It \e(Re Ta \(Re Ta real
! 169: .It \e(Ah Ta \(Ah Ta aleph
! 170: .It \e(te Ta \(te Ta existential quantifier
! 171: .It \e(fa Ta \(fa Ta universal quantifier
! 172: .It \e(AN Ta \(AN Ta logical AND
! 173: .It \e(OR Ta \(OR Ta logical OR
! 174: .It \e(no Ta \(no Ta logical NOT
! 175: .It \e(st Ta \(st Ta such that
! 176: .It \e(tf Ta \(tf Ta therefore
! 177: .It \e(~~ Ta \(~~ Ta approximate
! 178: .It \e(~= Ta \(~= Ta approximately equals
! 179: .It \e(=~ Ta \(=~ Ta congruent
! 180: .It \e(<= Ta \(<= Ta less-than-equal
! 181: .It \e(>= Ta \(>= Ta greater-than-equal
! 182: .It \e(== Ta \(== Ta equal
! 183: .It \e(!= Ta \(!= Ta not equal
! 184: .It \e(if Ta \(if Ta infinity
! 185: .It \e(na Ta \(na Ta NaN, an extension
! 186: .It \e(+- Ta \(+- Ta plus-minus
! 187: .It \e(** Ta \(** Ta asterisk
1.1 kristaps 188: .El
189: .\" PARAGRAPH
190: .Pp
191: Ligatures:
1.16 ! kristaps 192: .Bl -offset indent -column 10n 10n 10n
! 193: .It \e(ss Ta \(ss Ta German eszett
! 194: .It \e(AE Ta \(AE Ta AE
! 195: .It \e(ae Ta \(ae Ta ae
! 196: .It \e(OE Ta \(OE Ta OE
! 197: .It \e(oe Ta \(oe Ta oe
! 198: .It \e(ff Ta \(ff Ta ff ligature
! 199: .It \e(fi Ta \(fi Ta fi ligature
! 200: .It \e(fl Ta \(fl Ta fl ligature
! 201: .It \e(Fi Ta \(Fi Ta ffi ligature
! 202: .It \e(Fl Ta \(Fl Ta ffl ligature
1.1 kristaps 203: .El
204: .\" PARAGRAPH
205: .Pp
1.11 kristaps 206: Diacritics and accented letters:
1.16 ! kristaps 207: .Bl -offset indent -column 10n 10n 10n
! 208: .It \e(ga Ta \(ga Ta grave accent
! 209: .It \e(aa Ta \(aa Ta accute accent
! 210: .It \e(a" Ta \(a" Ta umlaut accent
! 211: .It \e(ad Ta \(ad Ta dieresis accent
! 212: .It \e(a~ Ta \(a~ Ta tilde accent
! 213: .It \e(a^ Ta \(a^ Ta circumflex accent
! 214: .It \e(ac Ta \(ac Ta cedilla accent
! 215: .It \e(ad Ta \(ad Ta dieresis accent
! 216: .It \e(ah Ta \(ah Ta caron accent
! 217: .It \e(ao Ta \(ao Ta ring accent
! 218: .It \e(ho Ta \(ha Ta hook accent
! 219: .It \e(ab Ta \(ab Ta breve accent
! 220: .It \e(a- Ta \(a- Ta macron accent
! 221: .It \e(-D Ta \(-D Ta Eth
! 222: .It \e(Sd Ta \(Sd Ta eth
! 223: .It \e(TP Ta \(TP Ta Thorn
! 224: .It \e(Tp Ta \(Tp Ta thorn
! 225: .It \e('A Ta \('A Ta acute A
! 226: .It \e('E Ta \('E Ta acute E
! 227: .It \e('I Ta \('I Ta acute I
! 228: .It \e('O Ta \('O Ta acute O
! 229: .It \e('U Ta \('U Ta acute U
! 230: .It \e('a Ta \('a Ta acute a
! 231: .It \e('e Ta \('e Ta acute e
! 232: .It \e('i Ta \('i Ta acute i
! 233: .It \e('o Ta \('o Ta acute o
! 234: .It \e('u Ta \('u Ta acute u
! 235: .It \e(`A Ta \(`A Ta grave A
! 236: .It \e(`E Ta \(`E Ta grave E
! 237: .It \e(`I Ta \(`I Ta grave I
! 238: .It \e(`O Ta \(`O Ta grave O
! 239: .It \e(`U Ta \(`U Ta grave U
! 240: .It \e(`a Ta \(`a Ta grave a
! 241: .It \e(`e Ta \(`e Ta grave e
! 242: .It \e(`i Ta \(`i Ta grave i
! 243: .It \e(`o Ta \(`i Ta grave o
! 244: .It \e(`u Ta \(`u Ta grave u
! 245: .It \e(~A Ta \(~A Ta tilde A
! 246: .It \e(~N Ta \(~N Ta tilde N
! 247: .It \e(~O Ta \(~O Ta tilde O
! 248: .It \e(~a Ta \(~a Ta tilde a
! 249: .It \e(~n Ta \(~n Ta tilde n
! 250: .It \e(~o Ta \(~o Ta tilde o
! 251: .It \e(:A Ta \(:A Ta dieresis A
! 252: .It \e(:E Ta \(:E Ta dieresis E
! 253: .It \e(:I Ta \(:I Ta dieresis I
! 254: .It \e(:O Ta \(:O Ta dieresis O
! 255: .It \e(:U Ta \(:U Ta dieresis U
! 256: .It \e(:a Ta \(:a Ta dieresis a
! 257: .It \e(:e Ta \(:e Ta dieresis e
! 258: .It \e(:i Ta \(:i Ta dieresis i
! 259: .It \e(:o Ta \(:o Ta dieresis o
! 260: .It \e(:u Ta \(:u Ta dieresis u
! 261: .It \e(:y Ta \(:y Ta dieresis y
! 262: .It \e(^A Ta \(^A Ta circumflex A
! 263: .It \e(^E Ta \(^E Ta circumflex E
! 264: .It \e(^I Ta \(^I Ta circumflex I
! 265: .It \e(^O Ta \(^O Ta circumflex O
! 266: .It \e(^U Ta \(^U Ta circumflex U
! 267: .It \e(^a Ta \(^a Ta circumflex a
! 268: .It \e(^e Ta \(^e Ta circumflex e
! 269: .It \e(^i Ta \(^i Ta circumflex i
! 270: .It \e(^o Ta \(^o Ta circumflex o
! 271: .It \e(^u Ta \(^u Ta circumflex u
! 272: .It \e(,C Ta \(,C Ta cedilla C
! 273: .It \e(,c Ta \(,c Ta cedilla c
! 274: .It \e(/L Ta \(/L Ta stroke L
! 275: .It \e(/l Ta \(/l Ta stroke l
! 276: .It \e(/O Ta \(/O Ta stroke O
! 277: .It \e(/o Ta \(/o Ta stroke o
! 278: .It \e(oA Ta \(oA Ta ring A
! 279: .It \e(oa Ta \(oa Ta ring a
1.1 kristaps 280: .El
281: .\" PARAGRAPH
282: .Pp
283: Monetary:
1.16 ! kristaps 284: .Bl -offset indent -column 10n 10n 10n
! 285: .It \e0 Ta \0 Ta white-space
! 286: .It \e(Cs Ta \(Cs Ta Scandinavian
! 287: .It \e(Do Ta \(Do Ta dollar
! 288: .It \e(Po Ta \(Po Ta pound
! 289: .It \e(Ye Ta \(Ye Ta yen
! 290: .It \e(Fn Ta \(Fn Ta florin
! 291: .It \e(ct Ta \(ct Ta cent
! 292: .It \e(Eu Ta \(Eu Ta Euro character glyph
! 293: .It \e(eu Ta \(eu Ta Euro symbol
1.11 kristaps 294: .El
295: .\" PARAGRAPH
296: .Pp
297: Greek letters:
1.16 ! kristaps 298: .Bl -offset indent -column 10n 10n 10n
! 299: .It \e0 Ta \0 Ta white-space
! 300: .It \e(*A Ta \(*A Ta Alpha
! 301: .It \e(*B Ta \(*B Ta Beta
! 302: .It \e(*C Ta \(*C Ta Xi
! 303: .It \e(*D Ta \(*D Ta Delta
! 304: .It \e(*E Ta \(*E Ta Epsilon
! 305: .It \e(*F Ta \(*F Ta Phi
! 306: .It \e(*G Ta \(*G Ta Gamma
! 307: .It \e(*H Ta \(*H Ta Theta
! 308: .It \e(*I Ta \(*I Ta Iota
! 309: .It \e(*K Ta \(*K Ta Kappa
! 310: .It \e(*L Ta \(*L Ta Lambda
! 311: .It \e(*M Ta \(*M Ta Mu
! 312: .It \e(*N Ta \(*N Ta Nu
! 313: .It \e(*O Ta \(*O Ta Omicron
! 314: .It \e(*P Ta \(*P Ta Pi
! 315: .It \e(*Q Ta \(*Q Ta Psi
! 316: .It \e(*R Ta \(*R Ta Rho
! 317: .It \e(*S Ta \(*S Ta Sigma
! 318: .It \e(*T Ta \(*T Ta Tau
! 319: .It \e(*U Ta \(*U Ta Upsilon
! 320: .It \e(*W Ta \(*W Ta Omega
! 321: .It \e(*X Ta \(*X Ta Chi
! 322: .It \e(*Y Ta \(*Y Ta Eta
! 323: .It \e(*Z Ta \(*Z Ta Zeta
! 324: .It \e(*a Ta \(*a Ta alpha
! 325: .It \e(*b Ta \(*b Ta beta
! 326: .It \e(*c Ta \(*c Ta xi
! 327: .It \e(*d Ta \(*d Ta delta
! 328: .It \e(*e Ta \(*e Ta epsilon
! 329: .It \e(*f Ta \(*f Ta phi
! 330: .It \e(+f Ta \(+f Ta phi variant
! 331: .It \e(*g Ta \(*g Ta gamma
! 332: .It \e(*h Ta \(*h Ta theta
! 333: .It \e(+h Ta \(+h Ta theta variant
! 334: .It \e(*i Ta \(*i Ta iota
! 335: .It \e(*k Ta \(*k Ta kappa
! 336: .It \e(*l Ta \(*l Ta lambda
! 337: .It \e(*m Ta \(*m Ta mu
! 338: .It \e(*n Ta \(*n Ta nu
! 339: .It \e(*o Ta \(*o Ta omicron
! 340: .It \e(*p Ta \(*p Ta pi
! 341: .It \e(+p Ta \(+p Ta pi variant
! 342: .It \e(*q Ta \(*q Ta psi
! 343: .It \e(*r Ta \(*r Ta rho
! 344: .It \e(*s Ta \(*s Ta sigma
! 345: .It \e(*t Ta \(*t Ta tau
! 346: .It \e(*u Ta \(*u Ta upsilon
! 347: .It \e(*w Ta \(*w Ta omega
! 348: .It \e(*x Ta \(*x Ta chi
! 349: .It \e(*y Ta \(*y Ta eta
! 350: .It \e(*z Ta \(*z Ta zeta
! 351: .It \e(ts Ta \(ts Ta sigma terminal
1.1 kristaps 352: .El
353: .\" PARAGRAPH
354: .Pp
355: Special symbols:
1.16 ! kristaps 356: .Bl -offset indent -column 10n 10n 10n
! 357: .It \e0 Ta \0 Ta white-space
! 358: .It \e(de Ta \(de Ta degree
! 359: .It \e(ps Ta \(ps Ta paragraph
! 360: .It \e(sc Ta \(sc Ta section
! 361: .It \e(dg Ta \(dg Ta dagger
! 362: .It \e(dd Ta \(dd Ta double dagger
! 363: .It \e(ci Ta \(ci Ta circle
! 364: .It \e(ba Ta \(ba Ta bar
! 365: .It \e(bb Ta \(bb Ta broken bar
! 366: .It \e(co Ta \(co Ta copyright
! 367: .It \e(rg Ta \(rg Ta registered
! 368: .It \e(tm Ta \(tm Ta trademarked
! 369: .It \ee Ta \e Ta escape
1.1 kristaps 370: .El
371: .\" SECTION
1.10 kristaps 372: .Sh PREDEFINED STRINGS
373: These are not recommended for use, as they differ across
374: implementations:
375: .Pp
376: Mathematical:
1.16 ! kristaps 377: .Bl -offset indent -column 10n 10n 10n
! 378: .It \e*(Ba Ta \*(Ba Ta vertical bar
! 379: .It \e*(Ne Ta \*(Ne Ta not equal
! 380: .It \e*(Ge Ta \*(Ge Ta greater-than-equal
! 381: .It \e*(Le Ta \*(Le Ta less-than-equal
! 382: .It \e*(Gt Ta \*(Gt Ta greater-than
! 383: .It \e*(Lt Ta \*(Lt Ta less-than
! 384: .It \e*(Pm Ta \*(Pm Ta plus-minus
! 385: .It \e*(If Ta \*(If Ta infinity
! 386: .It \e*(Pi Ta \*(Pi Ta pi
! 387: .It \e*(Na Ta \*(Na Ta NaN
1.10 kristaps 388: .El
389: .\" PARAGRAPH
390: .Pp
391: Special symbols:
1.16 ! kristaps 392: .Bl -offset indent -column 10n 10n 10n
! 393: .It \e*(Ba Ta \*(Ba Ta vertical bar
! 394: .It \e*(Am Ta \*(Am Ta ampersand
! 395: .It \e*R Ta \*R Ta restricted mark
! 396: .It \e*(Tm Ta \*(Tm Ta trade mark
1.10 kristaps 397: .El
398: .\" PARAGRAPH
399: .Pp
400: Enclosures:
1.16 ! kristaps 401: .Bl -offset indent -column 10n 10n 10n
! 402: .It \e*q Ta \*q Ta double-quote
! 403: .It \e*(Rq Ta \*(Rq Ta right-double-quote
! 404: .It \e*(Lq Ta \*(Lq Ta left-double-quote
! 405: .It \e*(lp Ta \*(lp Ta right-parenthesis
! 406: .It \e*(rp Ta \*(rp Ta left-parenthesis
1.10 kristaps 407: .El
408: .\" SECTION
1.3 kristaps 409: .Sh COMPATIBILITY
410: This section documents compatibility of
411: .Nm
412: with older or existing versions of
413: .Xr groff 1 :
414: .Pp
1.8 kristaps 415: .Bl -tag -width Ds -offset indent -compact
1.3 kristaps 416: .It \e(ss
417: Renders differently in
418: .Fl T Ns Ar ascii
419: mode.
420: .El
421: .\" SECTION
1.1 kristaps 422: .Sh SEE ALSO
423: .Xr mandoc 1
424: .\" SECTION
425: .Sh AUTHORS
426: The
427: .Nm
428: utility was written by
1.6 kristaps 429: .An Kristaps Dzonsons Aq kristaps@kth.se .
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc_char.7 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc