mandoc_char.7

   1 .\"     $Id: mandoc_char.7,v 1.15 2009/09/22 10:11:57 kristaps Exp $
   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 above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   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.
  16 .\"
  17 .Dd $Mdocdate: September 22 2009 $
  18 .Dt MANDOC_CHAR 7
  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 and predefined strings 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 .\" PARAGRAPH
  38 .Pp
  39 Both
  40 .Xr mdoc 7
  41 and
  42 .Xr man 7
  43 encode special characters with
  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
  54 .Sq \e[XX]
  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.
  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
  88 .It \e%
  89 .Pq zero-width space
  90 .It \e&
  91 .Pq zero-width space
  92 .It \e|
  93 .Pq zero-width space
  94 .El
  95 .\" PARAGRAPH
  96 .Pp
  97 Grammatic:
  98 .Bl -tag -width Ds -offset indent -compact
  99 .It \e(em
 100 .Pq em-dash
 101 .It \e(en
 102 .Pq en-dash
 103 .It \e(hy
 104 .Pq hyphen
 105 .It \e\e
 106 .Pq back-slash
 107 .It \\e
 108 .Pq back-slash
 109 .It \e'
 110 .Pq apostrophe
 111 .It \e`
 112 .Pq back-tick
 113 .It \e.
 114 .Pq period
 115 .It \e(r!
 116 .Pq upside-down exclamation
 117 .It \e(r?
 118 .Pq upside-down question
 119 .El
 120 .\" PARAGRAPH
 121 .Pp
 122 Enclosures:
 123 .Bl -tag -width Ds -offset indent -compact
 124 .It \e(lh
 125 .Pq left hand
 126 .It \e(rh
 127 .Pq right hand
 128 .It \e(Fo
 129 .Pq left guillemet
 130 .It \e(Fc
 131 .Pq right guillemet
 132 .It \e(fo
 133 .Pq left guilsing
 134 .It \e(fc
 135 .Pq right guilsing
 136 .It \e(rC
 137 .Pq right brace
 138 .It \e(lC
 139 .Pq left brace
 140 .It \e(ra
 141 .Pq right angle
 142 .It \e(la
 143 .Pq left angle
 144 .It \e(rB
 145 .Pq right bracket
 146 .It \e(lB
 147 .Pq left bracket
 148 .It \e(lq
 149 .Pq left double-quote
 150 .It \e(rq
 151 .Pq right double-quote
 152 .It \e(oq
 153 .Pq left single-quote
 154 .It \e(aq
 155 .Pq right single-quote
 156 .It \e(Bq
 157 .Pq right low double-quote
 158 .It \e(bq
 159 .Pq right low single-quote
 160 .El
 161 .\" PARAGRAPH
 162 .Pp
 163 Indicatives:
 164 .Bl -tag -width Ds -offset indent -compact
 165 .It \e(<-
 166 .Pq left arrow
 167 .It \e(->
 168 .Pq right arrow
 169 .It \e(ua
 170 .Pq up arrow
 171 .It \e(da
 172 .Pq down arrow
 173 .It \e(<>
 174 .Pq left-right arrow
 175 .It \e(lA
 176 .Pq left double-arrow
 177 .It \e(rA
 178 .Pq right double-arrow
 179 .It \e(uA
 180 .Pq up double-arrow
 181 .It \e(dA
 182 .Pq down double-arrow
 183 .It \e(hA
 184 .Pq left-right double-arrow
 185 .El
 186 .\" PARAGRAPH
 187 .Pp
 188 Mathematical:
 189 .Bl -tag -width Ds -offset indent -compact
 190 .It \e(es
 191 .Pq empty set
 192 .It \e(ca
 193 .Pq intersection
 194 .It \e(cu
 195 .Pq union
 196 .It \e(gr
 197 .Pq gradient
 198 .It \e(pd
 199 .Pq partial differential
 200 .It \e(ap
 201 .Pq similarity
 202 .It \e(sp
 203 .Pq proper superset
 204 .It \e(sb
 205 .Pq proper subset
 206 .It \e(eq
 207 .Pq equals
 208 .It \e(di
 209 .Pq division
 210 .It \e(mu
 211 .Pq multiplication
 212 .It \e(pl
 213 .Pq addition
 214 .It \e-
 215 .Pq subtraction
 216 .It \e(nm
 217 .Pq not element
 218 .It \e(mo
 219 .Pq element
 220 .It \e(Im
 221 .Pq imaginary
 222 .It \e(Re
 223 .Pq real
 224 .It \e(Ah
 225 .Pq aleph
 226 .It \e(te
 227 .Pq existential quantifier
 228 .It \e(fa
 229 .Pq universal quantifier
 230 .It \e(AN
 231 .Pq logical AND
 232 .It \e(OR
 233 .Pq logical OR
 234 .It \e(no
 235 .Pq logical NOT
 236 .It \e(st
 237 .Pq such that
 238 .It \e(tf
 239 .Pq therefore
 240 .It \e(~~
 241 .Pq approximate
 242 .It \e(~=
 243 .Pq approximately equals
 244 .It \e(=~
 245 .Pq congruent
 246 .It \e(<=
 247 .Pq less-than-equal
 248 .It \e(>=
 249 .Pq greater-than-equal
 250 .It \e(==
 251 .Pq equal
 252 .It \e(!=
 253 .Pq not equal
 254 .It \e(if
 255 .Pq infinity
 256 .It \e(na
 257 .Pq NaN, an extension
 258 .It \e(+-
 259 .Pq plus-minus
 260 .It \e(**
 261 .Pq asterisk
 262 .El
 263 .\" PARAGRAPH
 264 .Pp
 265 Ligatures:
 266 .Bl -tag -width Ds -offset indent -compact
 267 .It \e(ss
 268 .Pq German eszett
 269 .It \e(AE
 270 .Pq AE
 271 .It \e(ae
 272 .Pq ae
 273 .It \e(OE
 274 .Pq OE
 275 .It \e(oe
 276 .Pq oe
 277 .It \e(ff
 278 .Pq ff ligature
 279 .It \e(fi
 280 .Pq fi ligature
 281 .It \e(fl
 282 .Pq fl ligature
 283 .It \e(Fi
 284 .Pq ffi ligature
 285 .It \e(Fl
 286 .Pq ffl ligature
 287 .El
 288 .\" PARAGRAPH
 289 .Pp
 290 Diacritics and accented letters:
 291 .Bl -tag -width Ds -offset indent -compact
 292 .It \e(ga
 293 .Pq grave accent
 294 .It \e(aa
 295 .Pq accute accent
 296 .It \e(a"
 297 .Pq umlaut accent
 298 .It \e(ad
 299 .Pq dieresis accent
 300 .It \e(a~
 301 .Pq tilde accent
 302 .It \e(a^
 303 .Pq circumflex accent
 304 .It \e(ac
 305 .Pq cedilla accent
 306 .It \e(ad
 307 .Pq dieresis accent
 308 .It \e(ah
 309 .Pq caron accent
 310 .It \e(ao
 311 .Pq ring accent
 312 .It \e(ho
 313 .Pq hook accent
 314 .It \e(ab
 315 .Pq breve accent
 316 .It \e(a-
 317 .Pq macron accent
 318 .It \e(-D
 319 .Pq Eth
 320 .It \e(Sd
 321 .Pq eth
 322 .It \e(TP
 323 .Pq Thorn
 324 .It \e(Tp
 325 .Pq thorn
 326 .It \e('A
 327 .Pq acute A
 328 .It \e('E
 329 .Pq acute E
 330 .It \e('I
 331 .Pq acute I
 332 .It \e('O
 333 .Pq acute O
 334 .It \e('U
 335 .Pq acute U
 336 .It \e('a
 337 .Pq acute a
 338 .It \e('e
 339 .Pq acute e
 340 .It \e('i
 341 .Pq acute i
 342 .It \e('o
 343 .Pq acute o
 344 .It \e('u
 345 .Pq acute u
 346 .It \e(`A
 347 .Pq grave A
 348 .It \e(`E
 349 .Pq grave E
 350 .It \e(`I
 351 .Pq grave I
 352 .It \e(`O
 353 .Pq grave O
 354 .It \e(`U
 355 .Pq grave U
 356 .It \e(`a
 357 .Pq grave a
 358 .It \e(`e
 359 .Pq grave e
 360 .It \e(`i
 361 .Pq grave i
 362 .It \e(`o
 363 .Pq grave o
 364 .It \e(`u
 365 .Pq grave u
 366 .It \e(~A
 367 .Pq tilde A
 368 .It \e(~N
 369 .Pq tilde N
 370 .It \e(~O
 371 .Pq tilde O
 372 .It \e(~a
 373 .Pq tilde a
 374 .It \e(~n
 375 .Pq tilde n
 376 .It \e(~o
 377 .Pq tilde o
 378 .It \e(:A
 379 .Pq dieresis A
 380 .It \e(:E
 381 .Pq dieresis E
 382 .It \e(:I
 383 .Pq dieresis I
 384 .It \e(:O
 385 .Pq dieresis O
 386 .It \e(:U
 387 .Pq dieresis U
 388 .It \e(:a
 389 .Pq dieresis a
 390 .It \e(:e
 391 .Pq dieresis e
 392 .It \e(:i
 393 .Pq dieresis i
 394 .It \e(:o
 395 .Pq dieresis o
 396 .It \e(:u
 397 .Pq dieresis u
 398 .It \e(:y
 399 .Pq dieresis y
 400 .It \e(^A
 401 .Pq circumflex A
 402 .It \e(^E
 403 .Pq circumflex E
 404 .It \e(^I
 405 .Pq circumflex I
 406 .It \e(^O
 407 .Pq circumflex O
 408 .It \e(^U
 409 .Pq circumflex U
 410 .It \e(^a
 411 .Pq circumflex a
 412 .It \e(^e
 413 .Pq circumflex e
 414 .It \e(^i
 415 .Pq circumflex i
 416 .It \e(^o
 417 .Pq circumflex o
 418 .It \e(^u
 419 .Pq circumflex u
 420 .It \e(,C
 421 .Pq cedilla C
 422 .It \e(,c
 423 .Pq cedilla c
 424 .It \e(/L
 425 .Pq stroke L
 426 .It \e(/l
 427 .Pq stroke l
 428 .It \e(/O
 429 .Pq stroke O
 430 .It \e(/o
 431 .Pq stroke o
 432 .It \e(oA
 433 .Pq ring A
 434 .It \e(oa
 435 .Pq ring a
 436 .El
 437 .\" PARAGRAPH
 438 .Pp
 439 Monetary:
 440 .Bl -tag -width Ds -offset indent -compact
 441 .It \e(Cs
 442 .Pq Scandinavian
 443 .It \e(Do
 444 .Pq dollar
 445 .It \e(Po
 446 .Pq pound
 447 .It \e(Ye
 448 .Pq yen
 449 .It \e(Fn
 450 .Pq florin
 451 .It \e(ct
 452 .Pq cent
 453 .It \e(Eu
 454 .Pq Euro character glyph
 455 .It \e(eu
 456 .Pq Euro symbol
 457 .El
 458 .\" PARAGRAPH
 459 .Pp
 460 Greek letters:
 461 .Bl -tag -width Ds -offset indent -compact
 462 .It \e(*A
 463 \(*A
 464 .Pq Alpha
 465 .It \e(*B
 466 \(*B
 467 .Pq Beta
 468 .It \e(*C
 469 \(*C
 470 .Pq Xi
 471 .It \e(*D
 472 \(*D
 473 .Pq Delta
 474 .It \e(*E
 475 \(*E
 476 .Pq Epsilon
 477 .It \e(*F
 478 \(*F
 479 .Pq Phi
 480 .It \e(*G
 481 \(*G
 482 .Pq Gamma
 483 .It \e(*H
 484 \(*H
 485 .Pq Theta
 486 .It \e(*I
 487 \(*I
 488 .Pq Iota
 489 .It \e(*K
 490 \(*K
 491 .Pq Kappa
 492 .It \e(*L
 493 \(*L
 494 .Pq Lambda
 495 .It \e(*M
 496 \(*M
 497 .Pq Mu
 498 .It \e(*N
 499 \(*N
 500 .Pq Nu
 501 .It \e(*O
 502 \(*O
 503 .Pq Omicron
 504 .It \e(*P
 505 \(*P
 506 .Pq Pi
 507 .It \e(*Q
 508 \(*Q
 509 .Pq Psi
 510 .It \e(*R
 511 \(*R
 512 .Pq Rho
 513 .It \e(*S
 514 \(*S
 515 .Pq Sigma
 516 .It \e(*T
 517 \(*T
 518 .Pq Tau
 519 .It \e(*U
 520 \(*U
 521 .Pq Upsilon
 522 .It \e(*W
 523 \(*W
 524 .Pq Omega
 525 .It \e(*X
 526 \(*X
 527 .Pq Chi
 528 .It \e(*Y
 529 \(*Y
 530 .Pq Eta
 531 .It \e(*Z
 532 \(*Z
 533 .Pq Zeta
 534 .It \e(*a
 535 \(*a
 536 .Pq alpha
 537 .It \e(*b
 538 \(*b
 539 .Pq beta
 540 .It \e(*c
 541 \(*c
 542 .Pq xi
 543 .It \e(*d
 544 \(*d
 545 .Pq delta
 546 .It \e(*e
 547 \(*e
 548 .Pq epsilon
 549 .It \e(*f
 550 \(*f
 551 .Pq phi
 552 .It \e(+f
 553 \(+f
 554 .Pq phi variant
 555 .It \e(*g
 556 \(*g
 557 .Pq gamma
 558 .It \e(*h
 559 \(*h
 560 .Pq theta
 561 .It \e(+h
 562 \(*+
 563 .Pq theta variant
 564 .It \e(*i
 565 \(*i
 566 .Pq iota
 567 .It \e(*k
 568 \(*k
 569 .Pq kappa
 570 .It \e(*l
 571 \(*l
 572 .Pq lambda
 573 .It \e(*m
 574 \(*m
 575 .Pq mu
 576 .It \e(*n
 577 \(*n
 578 .Pq nu
 579 .It \e(*o
 580 \(*o
 581 .Pq omicron
 582 .It \e(*p
 583 \(*p
 584 .Pq pi
 585 .It \e(+p
 586 \(+p
 587 .Pq pi variant
 588 .It \e(*q
 589 \(*q
 590 .Pq psi
 591 .It \e(*r
 592 \(*r
 593 .Pq rho
 594 .It \e(*s
 595 \(*s
 596 .Pq sigma
 597 .It \e(*t
 598 \(*t
 599 .Pq tau
 600 .It \e(*u
 601 \(*u
 602 .Pq upsilon
 603 .It \e(*w
 604 \(*w
 605 .Pq omega
 606 .It \e(*x
 607 \(*x
 608 .Pq chi
 609 .It \e(*y
 610 \(*y
 611 .Pq eta
 612 .It \e(*z
 613 \(*z
 614 .Pq zeta
 615 .It \e(ts
 616 \(ts
 617 .Pq sigma terminal
 618 .El
 619 .\" PARAGRAPH
 620 .Pp
 621 Special symbols:
 622 .Bl -tag -width Ds -offset indent -compact
 623 .It \e0
 624 .Pq white-space
 625 .It \e(de
 626 .Pq degree
 627 .It \e(ps
 628 .Pq paragraph
 629 .It \e(sc
 630 .Pq section
 631 .It \e(dg
 632 .Pq dagger
 633 .It \e(dd
 634 .Pq double dagger
 635 .It \e(ci
 636 .Pq circle
 637 .It \e(ba
 638 .Pq bar
 639 .It \e(bb
 640 .Pq broken bar
 641 .It \e(co
 642 .Pq copyright
 643 .It \e(rg
 644 .Pq registered
 645 .It \e(tm
 646 .Pq trademarked
 647 .It \ee
 648 .Pq escape
 649 .El
 650 .\" SECTION
 651 .Sh PREDEFINED STRINGS
 652 These are not recommended for use, as they differ across
 653 implementations:
 654 .Pp
 655 Mathematical:
 656 .Bl -tag -width Ds -offset indent -compact
 657 .It \e*(Ne
 658 .Pq not equal
 659 .It \e*(Ge
 660 .Pq greater-than-equal
 661 .It \e*(Le
 662 .Pq less-than-equal
 663 .It \e*(Gt
 664 .Pq greater-than
 665 .It \e*(Lt
 666 .Pq greater-than
 667 .It \e*(Pm
 668 .Pq plus-minus
 669 .It \e*(If
 670 .Pq infinity
 671 .It \e*(Pi
 672 .Pq pi
 673 .It \e*(Na
 674 .Pq NaN
 675 .El
 676 .\" PARAGRAPH
 677 .Pp
 678 Special symbols:
 679 .Bl -tag -width Ds -offset indent -compact
 680 .It \e*(Ba
 681 .Pq vertical bar
 682 .It \e*(Am
 683 .Pq ampersand
 684 .It \e*R
 685 .Pq restricted mark
 686 .It \e*(Tm
 687 .Pq trade mark
 688 .El
 689 .\" PARAGRAPH
 690 .Pp
 691 Enclosures:
 692 .Bl -tag -width Ds -offset indent -compact
 693 .It \e*q
 694 .Pq double-quote
 695 .It \e*(Rq
 696 .Pq right-double-quote
 697 .It \e*(Lq
 698 .Pq left-double-quote
 699 .It \e*(lp
 700 .Pq right-parenthesis
 701 .It \e*(rp
 702 .Pq left-parenthesis
 703 .El
 704 .\" SECTION
 705 .Sh COMPATIBILITY
 706 This section documents compatibility of
 707 .Nm
 708 with older or existing versions of
 709 .Xr groff 1 :
 710 .Pp
 711 .Bl -tag -width Ds -offset indent -compact
 712 .It \e(ss
 713 Renders differently in
 714 .Fl T Ns Ar ascii
 715 mode.
 716 .El
 717 .\" SECTION
 718 .Sh SEE ALSO
 719 .Xr mandoc 1
 720 .\" SECTION
 721 .Sh AUTHORS
 722 The
 723 .Nm
 724 utility was written by
 725 .An Kristaps Dzonsons Aq kristaps@kth.se .