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