contrib/mdocml/mandoc_char.7

   1 .\"     $Id: mandoc_char.7,v 1.66 2017/06/02 12:43:52 schwarze Exp $
   2 .\"
   3 .\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
   4 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   5 .\" Copyright (c) 2011, 2013, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .Dd $Mdocdate: June 2 2017 $
  20 .Dt MANDOC_CHAR 7
  21 .Os
  22 .Sh NAME
  23 .Nm mandoc_char
  24 .Nd mandoc special characters
  25 .Sh DESCRIPTION
  26 This page documents the
  27 .Xr roff 7
  28 escape sequences accepted by
  29 .Xr mandoc 1
  30 to represent special characters in
  31 .Xr mdoc 7
  32 and
  33 .Xr man 7
  34 documents.
  35 .Pp
  36 The rendering depends on the
  37 .Xr mandoc 1
  38 output mode; in ASCII output, most characters are completely
  39 unintelligible.
  40 For that reason, using any of the special characters documented here,
  41 except those discussed in the
  42 .Sx DESCRIPTION ,
  43 is strongly discouraged; they are supported merely for backwards
  44 compatibility with existing documents.
  45 .Pp
  46 In particular, in English manual pages, do not use special-character
  47 escape sequences to represent national language characters in author
  48 names; instead, provide ASCII transcriptions of the names.
  49 .Ss Dashes and Hyphens
  50 In typography there are different types of dashes of various width:
  51 the hyphen (-),
  52 the minus sign (\(mi),
  53 the en-dash (\(en),
  54 and the em-dash (\(em).
  55 .Pp
  56 Hyphens are used for adjectives;
  57 to separate the two parts of a compound word;
  58 or to separate a word across two successive lines of text.
  59 The hyphen does not need to be escaped:
  60 .Bd -unfilled -offset indent
  61 blue-eyed
  62 lorry-driver
  63 .Ed
  64 .Pp
  65 If a word on a text input line contains a hyphen, a formatter may decide
  66 to insert an output line break after the hyphen if that helps filling
  67 the current output line, but the whole word would overflow the line.
  68 If it is important that the word is not broken across lines in this
  69 way, a zero-width space
  70 .Pq Sq \e&
  71 can be inserted before or after the hyphen.
  72 While
  73 .Xr mandoc 1
  74 never breaks the output line after hyphens adjacent to a zero-width
  75 space, after any of the other dash- or hyphen-like characters
  76 represented by escape sequences, or after hyphens inside words in
  77 macro arguments, other software may not respect these rules and may
  78 break the line even in such cases.
  79 .Pp
  80 Some
  81 .Xr roff 7
  82 implementations contains dictionaries allowing to break the line
  83 at syllable boundaries even inside words that contain no hyphens.
  84 Such automatic hyphenation is not supported by
  85 .Xr mandoc 1 ,
  86 which only breaks the line at whitespace, and inside words only
  87 after existing hyphens.
  88 .Pp
  89 The mathematical minus sign is used for negative numbers or subtraction.
  90 It should be written as
  91 .Sq \e(mi :
  92 .Bd -unfilled -offset indent
  93 a = 3 \e(mi 1;
  94 b = \e(mi2;
  95 .Ed
  96 .Pp
  97 The en-dash is used to separate the two elements of a range,
  98 or can be used the same way as an em-dash.
  99 It should be written as
 100 .Sq \e(en :
 101 .Bd -unfilled -offset indent
 102 pp. 95\e(en97.
 103 Go away \e(en or else!
 104 .Ed
 105 .Pp
 106 The em-dash can be used to show an interruption
 107 or can be used the same way as colons, semi-colons, or parentheses.
 108 It should be written as
 109 .Sq \e(em :
 110 .Bd -unfilled -offset indent
 111 Three things \e(em apples, oranges, and bananas.
 112 This is not that \e(em rather, this is that.
 113 .Ed
 114 .Pp
 115 Note:
 116 hyphens, minus signs, and en-dashes look identical under normal ASCII output.
 117 Other formats, such as PostScript, render them correctly,
 118 with differing widths.
 119 .Ss Spaces
 120 To separate words in normal text, for indenting and alignment
 121 in literal context, and when none of the following special cases apply,
 122 just use the normal space character
 123 .Pq Sq \  .
 124 .Pp
 125 When filling text, output lines may be broken between words, i.e. at space
 126 characters.
 127 To prevent a line break between two particular words,
 128 use the unpaddable non-breaking space escape sequence
 129 .Pq Sq \e\ \&
 130 instead of the normal space character.
 131 For example, the input string
 132 .Dq number\e\ 1
 133 will be kept together as
 134 .Dq number\ 1
 135 on the same output line.
 136 .Pp
 137 On request and macro lines, the normal space character serves as an
 138 argument delimiter.
 139 To include whitespace into arguments, quoting is usually the best choice;
 140 see the MACRO SYNTAX section in
 141 .Xr roff 7 .
 142 In some cases, using the non-breaking space escape sequence
 143 .Pq Sq \e\ \&
 144 may be preferable.
 145 .Pp
 146 To escape macro names and to protect whitespace at the end
 147 of input lines, the zero-width space
 148 .Pq Sq \e&
 149 is often useful.
 150 For example, in
 151 .Xr mdoc 7 ,
 152 a normal space character can be displayed in single quotes in either
 153 of the following ways:
 154 .Pp
 155 .Dl .Sq \(dq \(dq
 156 .Dl .Sq \e \e&
 157 .Ss Quotes
 158 On request and macro lines, the double-quote character
 159 .Pq Sq \(dq
 160 is handled specially to allow quoting.
 161 One way to prevent this special handling is by using the
 162 .Sq \e(dq
 163 escape sequence.
 164 .Pp
 165 Note that on text lines, literal double-quote characters can be used
 166 verbatim.
 167 All other quote-like characters can be used verbatim as well,
 168 even on request and macro lines.
 169 .Ss Accents
 170 In output modes supporting such special output characters, for example
 171 .Fl T Cm pdf ,
 172 and sometimes less consistently in
 173 .Fl T Cm utf8 ,
 174 some
 175 .Xr roff 7
 176 formatters convert the following ASCII input characters to the
 177 following Unicode special output characters:
 178 .Bl -column x(ga U+2018 -offset indent
 179 .It \(ga Ta U+2018 Ta left single quotation mark
 180 .It \(aq Ta U+2019 Ta right single quotation mark
 181 .It \(ti Ta U+02DC Ta small tilde
 182 .It \(ha Ta U+02C6 Ta modifier letter circumflex
 183 .El
 184 .Pp
 185 In prose, this automatic substitution is often desirable;
 186 but when these characters have to be displayed as plain ASCII
 187 characters, for example in source code samples, they require
 188 escaping to render as follows:
 189 .Bl -column x(ga U+2018 -offset indent
 190 .It \e(ga Ta U+0060 Ta grave accent
 191 .It \e(aq Ta U+0027 Ta apostrophe
 192 .It \e(ti Ta U+007E Ta tilde
 193 .It \e(ha Ta U+005E Ta circumflex accent
 194 .El
 195 .Ss Periods
 196 The period
 197 .Pq Sq \&.
 198 is handled specially at the beginning of an input line,
 199 where it introduces a
 200 .Xr roff 7
 201 request or a macro, and when appearing alone as a macro argument in
 202 .Xr mdoc 7 .
 203 In such situations, prepend a zero-width space
 204 .Pq Sq \e&.
 205 to make it behave like normal text.
 206 .Pp
 207 Do not use the
 208 .Sq \e.
 209 escape sequence.
 210 It does not prevent special handling of the period.
 211 .Ss Backslashes
 212 To include a literal backslash
 213 .Pq Sq \e
 214 into the output, use the
 215 .Pq Sq \ee
 216 escape sequence.
 217 .Pp
 218 Note that doubling it
 219 .Pq Sq \e\e
 220 is not the right way to output a backslash.
 221 Because
 222 .Xr mandoc 1
 223 does not implement full
 224 .Xr roff 7
 225 functionality, it may work with
 226 .Xr mandoc 1 ,
 227 but it may have weird effects on complete
 228 .Xr roff 7
 229 implementations.
 230 .Sh SPECIAL CHARACTERS
 231 Special characters are encoded as
 232 .Sq \eX
 233 .Pq for a one-character escape ,
 234 .Sq \e(XX
 235 .Pq two-character ,
 236 and
 237 .Sq \e[N]
 238 .Pq N-character .
 239 For details, see the
 240 .Em Special Characters
 241 subsection of the
 242 .Xr roff 7
 243 manual.
 244 .Pp
 245 Spacing:
 246 .Bl -column "Input" "Description" -offset indent -compact
 247 .It Em Input Ta Em Description
 248 .It Sq \e\ \& Ta unpaddable non-breaking space
 249 .It \e\(ti   Ta paddable non-breaking space
 250 .It \e0      Ta unpaddable, breaking digit-width space
 251 .It \e|      Ta one-sixth \e(em narrow space, zero width in nroff mode
 252 .It \e^      Ta one-twelfth \e(em half-narrow space, zero width in nroff
 253 .It \e&      Ta zero-width space
 254 .It \e%      Ta zero-width space allowing hyphenation
 255 .El
 256 .Pp
 257 Lines:
 258 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 259 .It Em Input Ta Em Rendered Ta Em Description
 260 .It \e(ba    Ta \(ba        Ta bar
 261 .It \e(br    Ta \(br        Ta box rule
 262 .It \e(ul    Ta \(ul        Ta underscore
 263 .It \e(rn    Ta \(rn        Ta overline
 264 .It \e(bb    Ta \(bb        Ta broken bar
 265 .It \e(sl    Ta \(sl        Ta forward slash
 266 .It \e(rs    Ta \(rs        Ta backward slash
 267 .El
 268 .Pp
 269 Text markers:
 270 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 271 .It Em Input Ta Em Rendered Ta Em Description
 272 .It \e(ci    Ta \(ci        Ta circle
 273 .It \e(bu    Ta \(bu        Ta bullet
 274 .It \e(dd    Ta \(dd        Ta double dagger
 275 .It \e(dg    Ta \(dg        Ta dagger
 276 .It \e(lz    Ta \(lz        Ta lozenge
 277 .It \e(sq    Ta \(sq        Ta white square
 278 .It \e(ps    Ta \(ps        Ta paragraph
 279 .It \e(sc    Ta \(sc        Ta section
 280 .It \e(lh    Ta \(lh        Ta left hand
 281 .It \e(rh    Ta \(rh        Ta right hand
 282 .It \e(at    Ta \(at        Ta at
 283 .It \e(sh    Ta \(sh        Ta hash (pound)
 284 .It \e(CR    Ta \(CR        Ta carriage return
 285 .It \e(OK    Ta \(OK        Ta check mark
 286 .It \e(CL    Ta \(CL        Ta club suit
 287 .It \e(SP    Ta \(SP        Ta spade suit
 288 .It \e(HE    Ta \(HE        Ta heart suit
 289 .It \e(DI    Ta \(DI        Ta diamond suit
 290 .El
 291 .Pp
 292 Legal symbols:
 293 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 294 .It Em Input Ta Em Rendered Ta Em Description
 295 .It \e(co    Ta \(co        Ta copyright
 296 .It \e(rg    Ta \(rg        Ta registered
 297 .It \e(tm    Ta \(tm        Ta trademarked
 298 .El
 299 .Pp
 300 Punctuation:
 301 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 302 .It Em Input Ta Em Rendered Ta Em Description
 303 .It \e(em    Ta \(em        Ta em-dash
 304 .It \e(en    Ta \(en        Ta en-dash
 305 .It \e(hy    Ta \(hy        Ta hyphen
 306 .It \ee      Ta \e          Ta back-slash
 307 .It \e.      Ta \.          Ta period
 308 .It \e(r!    Ta \(r!        Ta upside-down exclamation
 309 .It \e(r?    Ta \(r?        Ta upside-down question
 310 .El
 311 .Pp
 312 Quotes:
 313 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 314 .It Em Input Ta Em Rendered Ta Em Description
 315 .It \e(Bq    Ta \(Bq        Ta right low double-quote
 316 .It \e(bq    Ta \(bq        Ta right low single-quote
 317 .It \e(lq    Ta \(lq        Ta left double-quote
 318 .It \e(rq    Ta \(rq        Ta right double-quote
 319 .It \e(oq    Ta \(oq        Ta left single-quote
 320 .It \e(cq    Ta \(cq        Ta right single-quote
 321 .It \e(aq    Ta \(aq        Ta apostrophe quote (text)
 322 .It \e(dq    Ta \(dq        Ta double quote (text)
 323 .It \e(Fo    Ta \(Fo        Ta left guillemet
 324 .It \e(Fc    Ta \(Fc        Ta right guillemet
 325 .It \e(fo    Ta \(fo        Ta left single guillemet
 326 .It \e(fc    Ta \(fc        Ta right single guillemet
 327 .El
 328 .Pp
 329 Brackets:
 330 .Bl -column "xxbracketrightbtx" Rendered Description -offset indent -compact
 331 .It Em Input Ta Em Rendered Ta Em Description
 332 .It \e(lB    Ta \(lB        Ta left bracket
 333 .It \e(rB    Ta \(rB        Ta right bracket
 334 .It \e(lC    Ta \(lC        Ta left brace
 335 .It \e(rC    Ta \(rC        Ta right brace
 336 .It \e(la    Ta \(la        Ta left angle
 337 .It \e(ra    Ta \(ra        Ta right angle
 338 .It \e(bv    Ta \(bv        Ta brace extension
 339 .It \e[braceex] Ta \[braceex] Ta brace extension
 340 .It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket
 341 .It \e[bracketleftbt] Ta \[bracketleftbt] Ta bottom-left hooked bracket
 342 .It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension
 343 .It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket
 344 .It \e[bracketrightbt] Ta \[bracketrightbt] Ta bottom-right hooked bracket
 345 .It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension
 346 .It \e(lt    Ta \(lt        Ta top-left hooked brace
 347 .It \e[bracelefttp] Ta \[bracelefttp] Ta top-left hooked brace
 348 .It \e(lk    Ta \(lk        Ta mid-left hooked brace
 349 .It \e[braceleftmid] Ta \[braceleftmid] Ta mid-left hooked brace
 350 .It \e(lb    Ta \(lb        Ta bottom-left hooked brace
 351 .It \e[braceleftbt] Ta \[braceleftbt] Ta bottom-left hooked brace
 352 .It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension
 353 .It \e(rt    Ta \(rt        Ta top-left hooked brace
 354 .It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace
 355 .It \e(rk    Ta \(rk        Ta mid-right hooked brace
 356 .It \e[bracerightmid] Ta \[bracerightmid] Ta mid-right hooked brace
 357 .It \e(rb    Ta \(rb        Ta bottom-right hooked brace
 358 .It \e[bracerightbt] Ta \[bracerightbt] Ta bottom-right hooked brace
 359 .It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension
 360 .It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis
 361 .It \e[parenleftbt] Ta \[parenleftbt] Ta bottom-left hooked parenthesis
 362 .It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension
 363 .It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis
 364 .It \e[parenrightbt] Ta \[parenrightbt] Ta bottom-right hooked parenthesis
 365 .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension
 366 .El
 367 .Pp
 368 Arrows:
 369 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 370 .It Em Input Ta Em Rendered Ta Em Description
 371 .It \e(<-    Ta \(<-        Ta left arrow
 372 .It \e(->    Ta \(->        Ta right arrow
 373 .It \e(<>    Ta \(<>        Ta left-right arrow
 374 .It \e(da    Ta \(da        Ta down arrow
 375 .It \e(ua    Ta \(ua        Ta up arrow
 376 .It \e(va    Ta \(va        Ta up-down arrow
 377 .It \e(lA    Ta \(lA        Ta left double-arrow
 378 .It \e(rA    Ta \(rA        Ta right double-arrow
 379 .It \e(hA    Ta \(hA        Ta left-right double-arrow
 380 .It \e(uA    Ta \(uA        Ta up double-arrow
 381 .It \e(dA    Ta \(dA        Ta down double-arrow
 382 .It \e(vA    Ta \(vA        Ta up-down double-arrow
 383 .It \e(an    Ta \(an        Ta horizontal arrow extension
 384 .El
 385 .Pp
 386 Logical:
 387 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 388 .It Em Input Ta Em Rendered Ta Em Description
 389 .It \e(AN    Ta \(AN        Ta logical and
 390 .It \e(OR    Ta \(OR        Ta logical or
 391 .It \e(no    Ta \(no        Ta logical not
 392 .It \e[tno]  Ta \[tno]      Ta logical not (text)
 393 .It \e(te    Ta \(te        Ta existential quantifier
 394 .It \e(fa    Ta \(fa        Ta universal quantifier
 395 .It \e(st    Ta \(st        Ta such that
 396 .It \e(tf    Ta \(tf        Ta therefore
 397 .It \e(3d    Ta \(3d        Ta therefore
 398 .It \e(or    Ta \(or        Ta bitwise or
 399 .El
 400 .Pp
 401 Mathematical:
 402 .Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact
 403 .It Em Input Ta Em Rendered Ta Em Description
 404 .It \e(pl    Ta \(pl        Ta plus
 405 .It \e(mi    Ta \(mi        Ta minus
 406 .It \e-      Ta \-          Ta minus (text)
 407 .It \e(-+    Ta \(-+        Ta minus-plus
 408 .It \e(+-    Ta \(+-        Ta plus-minus
 409 .It \e[t+-]  Ta \[t+-]      Ta plus-minus (text)
 410 .It \e(pc    Ta \(pc        Ta center-dot
 411 .It \e(mu    Ta \(mu        Ta multiply
 412 .It \e[tmu]  Ta \[tmu]      Ta multiply (text)
 413 .It \e(c*    Ta \(c*        Ta circle-multiply
 414 .It \e(c+    Ta \(c+        Ta circle-plus
 415 .It \e(di    Ta \(di        Ta divide
 416 .It \e[tdi]  Ta \[tdi]      Ta divide (text)
 417 .It \e(f/    Ta \(f/        Ta fraction
 418 .It \e(**    Ta \(**        Ta asterisk
 419 .It \e(<=    Ta \(<=        Ta less-than-equal
 420 .It \e(>=    Ta \(>=        Ta greater-than-equal
 421 .It \e(<<    Ta \(<<        Ta much less
 422 .It \e(>>    Ta \(>>        Ta much greater
 423 .It \e(eq    Ta \(eq        Ta equal
 424 .It \e(!=    Ta \(!=        Ta not equal
 425 .It \e(==    Ta \(==        Ta equivalent
 426 .It \e(ne    Ta \(ne        Ta not equivalent
 427 .It \e(ap    Ta \(ap        Ta tilde operator
 428 .It \e(|=    Ta \(|=        Ta asymptotically equal
 429 .It \e(=\(ti Ta \(=~        Ta approximately equal
 430 .It \e(\(ti\(ti Ta \(~~        Ta almost equal
 431 .It \e(\(ti= Ta \(~=        Ta almost equal
 432 .It \e(pt    Ta \(pt        Ta proportionate
 433 .It \e(es    Ta \(es        Ta empty set
 434 .It \e(mo    Ta \(mo        Ta element
 435 .It \e(nm    Ta \(nm        Ta not element
 436 .It \e(sb    Ta \(sb        Ta proper subset
 437 .It \e(nb    Ta \(nb        Ta not subset
 438 .It \e(sp    Ta \(sp        Ta proper superset
 439 .It \e(nc    Ta \(nc        Ta not superset
 440 .It \e(ib    Ta \(ib        Ta reflexive subset
 441 .It \e(ip    Ta \(ip        Ta reflexive superset
 442 .It \e(ca    Ta \(ca        Ta intersection
 443 .It \e(cu    Ta \(cu        Ta union
 444 .It \e(/_    Ta \(/_        Ta angle
 445 .It \e(pp    Ta \(pp        Ta perpendicular
 446 .It \e(is    Ta \(is        Ta integral
 447 .It \e[integral] Ta \[integral] Ta integral
 448 .It \e[sum]    Ta \[sum]   Ta summation
 449 .It \e[product] Ta \[product] Ta product
 450 .It \e[coproduct] Ta \[coproduct] Ta coproduct
 451 .It \e(gr    Ta \(gr        Ta gradient
 452 .It \e(sr    Ta \(sr        Ta square root
 453 .It \e[sqrt] Ta \[sqrt]     Ta square root
 454 .It \e(lc    Ta \(lc        Ta left-ceiling
 455 .It \e(rc    Ta \(rc        Ta right-ceiling
 456 .It \e(lf    Ta \(lf        Ta left-floor
 457 .It \e(rf    Ta \(rf        Ta right-floor
 458 .It \e(if    Ta \(if        Ta infinity
 459 .It \e(Ah    Ta \(Ah        Ta aleph
 460 .It \e(Im    Ta \(Im        Ta imaginary
 461 .It \e(Re    Ta \(Re        Ta real
 462 .It \e(wp    Ta \(wp        Ta Weierstrass p
 463 .It \e(pd    Ta \(pd        Ta partial differential
 464 .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p
 465 .It \e[hbar] Ta \[hbar]     Ta Planck constant over 2\(*p
 466 .It \e(12    Ta \(12        Ta one-half
 467 .It \e(14    Ta \(14        Ta one-fourth
 468 .It \e(34    Ta \(34        Ta three-fourths
 469 .It \e(18    Ta \(18        Ta one-eighth
 470 .It \e(38    Ta \(38        Ta three-eighths
 471 .It \e(58    Ta \(58        Ta five-eighths
 472 .It \e(78    Ta \(78        Ta seven-eighths
 473 .It \e(S1    Ta \(S1        Ta superscript 1
 474 .It \e(S2    Ta \(S2        Ta superscript 2
 475 .It \e(S3    Ta \(S3        Ta superscript 3
 476 .El
 477 .Pp
 478 Ligatures:
 479 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 480 .It Em Input Ta Em Rendered Ta Em Description
 481 .It \e(ff    Ta \(ff        Ta ff ligature
 482 .It \e(fi    Ta \(fi        Ta fi ligature
 483 .It \e(fl    Ta \(fl        Ta fl ligature
 484 .It \e(Fi    Ta \(Fi        Ta ffi ligature
 485 .It \e(Fl    Ta \(Fl        Ta ffl ligature
 486 .It \e(AE    Ta \(AE        Ta AE
 487 .It \e(ae    Ta \(ae        Ta ae
 488 .It \e(OE    Ta \(OE        Ta OE
 489 .It \e(oe    Ta \(oe        Ta oe
 490 .It \e(ss    Ta \(ss        Ta German eszett
 491 .It \e(IJ    Ta \(IJ        Ta IJ ligature
 492 .It \e(ij    Ta \(ij        Ta ij ligature
 493 .El
 494 .Pp
 495 Accents:
 496 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 497 .It Em Input Ta Em Rendered Ta Em Description
 498 .It \e(a"    Ta \(a"        Ta Hungarian umlaut
 499 .It \e(a-    Ta \(a-        Ta macron
 500 .It \e(a.    Ta \(a.        Ta dotted
 501 .It \e(a^    Ta \(a^        Ta circumflex
 502 .It \e(aa    Ta \(aa        Ta acute
 503 .It \e\(aq   Ta \'          Ta acute
 504 .It \e(ga    Ta \(ga        Ta grave
 505 .It \e\(ga   Ta \`          Ta grave
 506 .It \e(ab    Ta \(ab        Ta breve
 507 .It \e(ac    Ta \(ac        Ta cedilla
 508 .It \e(ad    Ta \(ad        Ta dieresis
 509 .It \e(ah    Ta \(ah        Ta caron
 510 .It \e(ao    Ta \(ao        Ta ring
 511 .It \e(a\(ti Ta \(a~        Ta tilde
 512 .It \e(ho    Ta \(ho        Ta ogonek
 513 .It \e(ha    Ta \(ha        Ta hat (text)
 514 .It \e(ti    Ta \(ti        Ta tilde (text)
 515 .El
 516 .Pp
 517 Accented letters:
 518 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 519 .It Em Input Ta Em Rendered Ta Em Description
 520 .It \e(\(aqA Ta \('A        Ta acute A
 521 .It \e(\(aqE Ta \('E        Ta acute E
 522 .It \e(\(aqI Ta \('I        Ta acute I
 523 .It \e(\(aqO Ta \('O        Ta acute O
 524 .It \e(\(aqU Ta \('U        Ta acute U
 525 .It \e(\(aqa Ta \('a        Ta acute a
 526 .It \e(\(aqe Ta \('e        Ta acute e
 527 .It \e(\(aqi Ta \('i        Ta acute i
 528 .It \e(\(aqo Ta \('o        Ta acute o
 529 .It \e(\(aqu Ta \('u        Ta acute u
 530 .It \e(\(gaA Ta \(`A        Ta grave A
 531 .It \e(\(gaE Ta \(`E        Ta grave E
 532 .It \e(\(gaI Ta \(`I        Ta grave I
 533 .It \e(\(gaO Ta \(`O        Ta grave O
 534 .It \e(\(gaU Ta \(`U        Ta grave U
 535 .It \e(\(gaa Ta \(`a        Ta grave a
 536 .It \e(\(gae Ta \(`e        Ta grave e
 537 .It \e(\(gai Ta \(`i        Ta grave i
 538 .It \e(\(gao Ta \(`i        Ta grave o
 539 .It \e(\(gau Ta \(`u        Ta grave u
 540 .It \e(\(tiA Ta \(~A        Ta tilde A
 541 .It \e(\(tiN Ta \(~N        Ta tilde N
 542 .It \e(\(tiO Ta \(~O        Ta tilde O
 543 .It \e(\(tia Ta \(~a        Ta tilde a
 544 .It \e(\(tin Ta \(~n        Ta tilde n
 545 .It \e(\(tio Ta \(~o        Ta tilde o
 546 .It \e(:A    Ta \(:A        Ta dieresis A
 547 .It \e(:E    Ta \(:E        Ta dieresis E
 548 .It \e(:I    Ta \(:I        Ta dieresis I
 549 .It \e(:O    Ta \(:O        Ta dieresis O
 550 .It \e(:U    Ta \(:U        Ta dieresis U
 551 .It \e(:a    Ta \(:a        Ta dieresis a
 552 .It \e(:e    Ta \(:e        Ta dieresis e
 553 .It \e(:i    Ta \(:i        Ta dieresis i
 554 .It \e(:o    Ta \(:o        Ta dieresis o
 555 .It \e(:u    Ta \(:u        Ta dieresis u
 556 .It \e(:y    Ta \(:y        Ta dieresis y
 557 .It \e(^A    Ta \(^A        Ta circumflex A
 558 .It \e(^E    Ta \(^E        Ta circumflex E
 559 .It \e(^I    Ta \(^I        Ta circumflex I
 560 .It \e(^O    Ta \(^O        Ta circumflex O
 561 .It \e(^U    Ta \(^U        Ta circumflex U
 562 .It \e(^a    Ta \(^a        Ta circumflex a
 563 .It \e(^e    Ta \(^e        Ta circumflex e
 564 .It \e(^i    Ta \(^i        Ta circumflex i
 565 .It \e(^o    Ta \(^o        Ta circumflex o
 566 .It \e(^u    Ta \(^u        Ta circumflex u
 567 .It \e(,C    Ta \(,C        Ta cedilla C
 568 .It \e(,c    Ta \(,c        Ta cedilla c
 569 .It \e(/L    Ta \(/L        Ta stroke L
 570 .It \e(/l    Ta \(/l        Ta stroke l
 571 .It \e(/O    Ta \(/O        Ta stroke O
 572 .It \e(/o    Ta \(/o        Ta stroke o
 573 .It \e(oA    Ta \(oA        Ta ring A
 574 .It \e(oa    Ta \(oa        Ta ring a
 575 .El
 576 .Pp
 577 Special letters:
 578 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 579 .It Em Input Ta Em Rendered Ta Em Description
 580 .It \e(-D    Ta \(-D        Ta Eth
 581 .It \e(Sd    Ta \(Sd        Ta eth
 582 .It \e(TP    Ta \(TP        Ta Thorn
 583 .It \e(Tp    Ta \(Tp        Ta thorn
 584 .It \e(.i    Ta \(.i        Ta dotless i
 585 .It \e(.j    Ta \(.j        Ta dotless j
 586 .El
 587 .Pp
 588 Currency:
 589 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 590 .It Em Input Ta Em Rendered Ta Em Description
 591 .It \e(Do    Ta \(Do        Ta dollar
 592 .It \e(ct    Ta \(ct        Ta cent
 593 .It \e(Eu    Ta \(Eu        Ta Euro symbol
 594 .It \e(eu    Ta \(eu        Ta Euro symbol
 595 .It \e(Ye    Ta \(Ye        Ta yen
 596 .It \e(Po    Ta \(Po        Ta pound
 597 .It \e(Cs    Ta \(Cs        Ta Scandinavian
 598 .It \e(Fn    Ta \(Fn        Ta florin
 599 .El
 600 .Pp
 601 Units:
 602 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 603 .It Em Input Ta Em Rendered Ta Em Description
 604 .It \e(de    Ta \(de        Ta degree
 605 .It \e(%0    Ta \(%0        Ta per-thousand
 606 .It \e(fm    Ta \(fm        Ta minute
 607 .It \e(sd    Ta \(sd        Ta second
 608 .It \e(mc    Ta \(mc        Ta micro
 609 .It \e(Of    Ta \(Of        Ta Spanish female ordinal
 610 .It \e(Om    Ta \(Om        Ta Spanish masculine ordinal
 611 .El
 612 .Pp
 613 Greek letters:
 614 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 615 .It Em Input Ta Em Rendered Ta Em Description
 616 .It \e(*A    Ta \(*A        Ta Alpha
 617 .It \e(*B    Ta \(*B        Ta Beta
 618 .It \e(*G    Ta \(*G        Ta Gamma
 619 .It \e(*D    Ta \(*D        Ta Delta
 620 .It \e(*E    Ta \(*E        Ta Epsilon
 621 .It \e(*Z    Ta \(*Z        Ta Zeta
 622 .It \e(*Y    Ta \(*Y        Ta Eta
 623 .It \e(*H    Ta \(*H        Ta Theta
 624 .It \e(*I    Ta \(*I        Ta Iota
 625 .It \e(*K    Ta \(*K        Ta Kappa
 626 .It \e(*L    Ta \(*L        Ta Lambda
 627 .It \e(*M    Ta \(*M        Ta Mu
 628 .It \e(*N    Ta \(*N        Ta Nu
 629 .It \e(*C    Ta \(*C        Ta Xi
 630 .It \e(*O    Ta \(*O        Ta Omicron
 631 .It \e(*P    Ta \(*P        Ta Pi
 632 .It \e(*R    Ta \(*R        Ta Rho
 633 .It \e(*S    Ta \(*S        Ta Sigma
 634 .It \e(*T    Ta \(*T        Ta Tau
 635 .It \e(*U    Ta \(*U        Ta Upsilon
 636 .It \e(*F    Ta \(*F        Ta Phi
 637 .It \e(*X    Ta \(*X        Ta Chi
 638 .It \e(*Q    Ta \(*Q        Ta Psi
 639 .It \e(*W    Ta \(*W        Ta Omega
 640 .It \e(*a    Ta \(*a        Ta alpha
 641 .It \e(*b    Ta \(*b        Ta beta
 642 .It \e(*g    Ta \(*g        Ta gamma
 643 .It \e(*d    Ta \(*d        Ta delta
 644 .It \e(*e    Ta \(*e        Ta epsilon
 645 .It \e(*z    Ta \(*z        Ta zeta
 646 .It \e(*y    Ta \(*y        Ta eta
 647 .It \e(*h    Ta \(*h        Ta theta
 648 .It \e(*i    Ta \(*i        Ta iota
 649 .It \e(*k    Ta \(*k        Ta kappa
 650 .It \e(*l    Ta \(*l        Ta lambda
 651 .It \e(*m    Ta \(*m        Ta mu
 652 .It \e(*n    Ta \(*n        Ta nu
 653 .It \e(*c    Ta \(*c        Ta xi
 654 .It \e(*o    Ta \(*o        Ta omicron
 655 .It \e(*p    Ta \(*p        Ta pi
 656 .It \e(*r    Ta \(*r        Ta rho
 657 .It \e(*s    Ta \(*s        Ta sigma
 658 .It \e(*t    Ta \(*t        Ta tau
 659 .It \e(*u    Ta \(*u        Ta upsilon
 660 .It \e(*f    Ta \(*f        Ta phi
 661 .It \e(*x    Ta \(*x        Ta chi
 662 .It \e(*q    Ta \(*q        Ta psi
 663 .It \e(*w    Ta \(*w        Ta omega
 664 .It \e(+h    Ta \(+h        Ta theta variant
 665 .It \e(+f    Ta \(+f        Ta phi variant
 666 .It \e(+p    Ta \(+p        Ta pi variant
 667 .It \e(+e    Ta \(+e        Ta epsilon variant
 668 .It \e(ts    Ta \(ts        Ta sigma terminal
 669 .El
 670 .Sh PREDEFINED STRINGS
 671 Predefined strings are inherited from the macro packages of historical
 672 troff implementations.
 673 They are
 674 .Em not recommended
 675 for use, as they differ across implementations.
 676 Manuals using these predefined strings are almost certainly not
 677 portable.
 678 .Pp
 679 Their syntax is similar to special characters, using
 680 .Sq \e*X
 681 .Pq for a one-character escape ,
 682 .Sq \e*(XX
 683 .Pq two-character ,
 684 and
 685 .Sq \e*[N]
 686 .Pq N-character .
 687 For details, see the
 688 .Em Predefined Strings
 689 subsection of the
 690 .Xr roff 7
 691 manual.
 692 .Bl -column "Input" "Rendered" "Description" -offset indent
 693 .It Em Input Ta Em Rendered Ta Em Description
 694 .It \e*(Ba   Ta \*(Ba       Ta vertical bar
 695 .It \e*(Ne   Ta \*(Ne       Ta not equal
 696 .It \e*(Ge   Ta \*(Ge       Ta greater-than-equal
 697 .It \e*(Le   Ta \*(Le       Ta less-than-equal
 698 .It \e*(Gt   Ta \*(Gt       Ta greater-than
 699 .It \e*(Lt   Ta \*(Lt       Ta less-than
 700 .It \e*(Pm   Ta \*(Pm       Ta plus-minus
 701 .It \e*(If   Ta \*(If       Ta infinity
 702 .It \e*(Pi   Ta \*(Pi       Ta pi
 703 .It \e*(Na   Ta \*(Na       Ta NaN
 704 .It \e*(Am   Ta \*(Am       Ta ampersand
 705 .It \e*R     Ta \*R         Ta restricted mark
 706 .It \e*(Tm   Ta \*(Tm       Ta trade mark
 707 .It \e*q     Ta \*q         Ta double-quote
 708 .It \e*(Rq   Ta \*(Rq       Ta right-double-quote
 709 .It \e*(Lq   Ta \*(Lq       Ta left-double-quote
 710 .It \e*(lp   Ta \*(lp       Ta right-parenthesis
 711 .It \e*(rp   Ta \*(rp       Ta left-parenthesis
 712 .It \e*(lq   Ta \*(lq       Ta left double-quote
 713 .It \e*(rq   Ta \*(rq       Ta right double-quote
 714 .It \e*(ua   Ta \*(ua       Ta up arrow
 715 .It \e*(va   Ta \*(va       Ta up-down arrow
 716 .It \e*(<=   Ta \*(<=       Ta less-than-equal
 717 .It \e*(>=   Ta \*(>=       Ta greater-than-equal
 718 .It \e*(aa   Ta \*(aa       Ta acute
 719 .It \e*(ga   Ta \*(ga       Ta grave
 720 .It \e*(Px   Ta \*(Px       Ta POSIX standard name
 721 .It \e*(Ai   Ta \*(Ai       Ta ANSI standard name
 722 .El
 723 .Sh UNICODE CHARACTERS
 724 The escape sequences
 725 .Pp
 726 .Dl \e[uXXXX] and \eC\(aquXXXX\(aq
 727 .Pp
 728 are interpreted as Unicode codepoints.
 729 The codepoint must be in the range above U+0080 and less than U+10FFFF.
 730 For compatibility, the hexadecimal digits
 731 .Sq A
 732 to
 733 .Sq F
 734 must be given as uppercase characters,
 735 and points must be zero-padded to four characters; if
 736 greater than four characters, no zero padding is allowed.
 737 Unicode surrogates are not allowed.
 738 .Sh NUMBERED CHARACTERS
 739 For backward compatibility with existing manuals,
 740 .Xr mandoc 1
 741 also supports the
 742 .Pp
 743 .Dl \eN\(aq Ns Ar number Ns \(aq
 744 .Pp
 745 escape sequence, inserting the character
 746 .Ar number
 747 from the current character set into the output.
 748 Of course, this is inherently non-portable and is already marked
 749 as deprecated in the Heirloom roff manual.
 750 For example, do not use \eN\(aq34\(aq, use \e(dq, or even the plain
 751 .Sq \(dq
 752 character where possible.
 753 .Sh COMPATIBILITY
 754 This section documents compatibility between mandoc and other
 755 troff implementations, at this time limited to GNU troff
 756 .Pq Qq groff .
 757 .Pp
 758 .Bl -dash -compact
 759 .It
 760 The \eN\(aq\(aq escape sequence is limited to printable characters; in
 761 groff, it accepts arbitrary character numbers.
 762 .It
 763 In
 764 .Fl T Ns Cm ascii ,
 765 the
 766 \e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product],
 767 \e[coproduct], \e(gr, \e(-h, and \e(a. special characters render
 768 differently between mandoc and groff.
 769 .It
 770 In
 771 .Fl T Ns Cm html ,
 772 the \e(\(ti=, \e(nb, and \e(nc special characters render differently
 773 between mandoc and groff.
 774 .It
 775 The
 776 .Fl T Ns Cm ps
 777 and
 778 .Fl T Ns Cm pdf
 779 modes format like
 780 .Fl T Ns Cm ascii
 781 instead of rendering glyphs as in groff.
 782 .It
 783 The \e[radicalex], \e[sqrtex], and \e(ru special characters have been omitted
 784 from mandoc either because they are poorly documented or they have no
 785 known representation.
 786 .El
 787 .Sh SEE ALSO
 788 .Xr mandoc 1 ,
 789 .Xr man 7 ,
 790 .Xr mdoc 7 ,
 791 .Xr roff 7
 792 .Sh AUTHORS
 793 The
 794 .Nm
 795 manual page was written by
 796 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 797 .Sh CAVEATS
 798 The predefined string
 799 .Sq \e*(Ba
 800 mimics the behaviour of the
 801 .Sq \&|
 802 character in
 803 .Xr mdoc 7 ;
 804 thus, if you wish to render a vertical bar with no side effects, use
 805 the
 806 .Sq \e(ba
 807 escape.