Sortix cross-volatile manual
This manual documents Sortix cross-volatile. You can instead view this document in the latest official manual.
NAME
mandoc_char — mandoc special charactersDESCRIPTION
This page documents the roff(7) escape sequences accepted by mandoc(1) to represent special characters in mdoc(7) and man(7) documents.Dashes and Hyphens
In typography there are different types of dashes of various width: the hyphen (‐), the en-dash (–), the em-dash (—), and the mathematical minus sign (−).blue-eyed lorry-driver
pp. 95\(en97. Go away \(en or else!
Three things \(em apples, oranges, and bananas. This is not that \(em rather, this is that.
Spaces
To separate words in normal text, for indenting and alignment in literal context, and when none of the following special cases apply, just use the normal space character (‘ ’)..Sq " "
.Sq \ \&
Quotes
On request and macro lines, the double-quote character (‘"’) is handled specially to allow quoting. One way to prevent this special handling is by using the ‘\(dq’ escape sequence.Accents
In output modes supporting such special output characters, for example -T pdf, and sometimes less consistently in -T utf8, some roff(7) formatters convert the following ASCII input characters to the following Unicode special output characters:` | U+2018 | left single quotation mark |
' | U+2019 | right single quotation mark |
~ | U+02DC | small tilde |
^ | U+02C6 | modifier letter circumflex |
\(ga | U+0060 | grave accent |
\(aq | U+0027 | apostrophe |
\(ti | U+007E | tilde |
\(ha | U+005E | circumflex accent |
Periods
The period (‘.’) is handled specially at the beginning of an input line, where it introduces a roff(7) request or a macro, and when appearing alone as a macro argument in mdoc(7). In such situations, prepend a zero-width space (‘\&.’) to make it behave like normal text.Backslashes
To include a literal backslash (‘\’) into the output, use the (‘\e’) escape sequence.SPECIAL CHARACTERS
Special characters are encoded as ‘\X’ (for a one-character escape), ‘\(XX’ (two-character), and ‘\[N]’ (N-character). For details, see the Special Characters subsection of the roff(7) manual.Input | Description |
‘\ ’ | unpaddable space |
\~ | paddable space |
\0 | digit-width space |
\| | one-sixth \(em narrow space, zero width in nroff mode |
\^ | one-twelfth \(em half-narrow space, zero width in nroff |
\& | zero-width space |
\) | zero-width space transparent to end-of-sentence detection |
\% | zero-width space allowing hyphenation |
\: | zero-width space allowing line break |
Input | Rendered | Description |
\(ba | | | bar |
\(br | │ | box rule |
\(ul | _ | underscore |
\(ru | underscore (width 0.5m) | |
\(rn | ‾ | overline |
\(bb | ¦ | broken bar |
\(sl | / | forward slash |
\(rs | \ | backward slash |
Input | Rendered | Description |
\(ci | ○ | circle |
\(bu | • | bullet |
\(dd | ‡ | double dagger |
\(dg | † | dagger |
\(lz | ◊ | lozenge |
\(sq | □ | white square |
\(ps | ¶ | paragraph |
\(sc | § | section |
\(lh | ☜ | left hand |
\(rh | ☞ | right hand |
\(at | @ | at |
\(sh | # | hash (pound) |
\(CR | ↵ | carriage return |
\(OK | ✓ | check mark |
\(CL | club suit | |
\(SP | spade suit | |
\(HE | heart suit | |
\(DI | diamond suit |
Input | Rendered | Description |
\(co | © | copyright |
\(rg | ® | registered |
\(tm | ™ | trademarked |
Input | Rendered | Description |
\(em | — | em-dash |
\(en | – | en-dash |
\(hy | ‐ | hyphen |
\e | \ | back-slash |
\. | . | period |
\(r! | ¡ | upside-down exclamation |
\(r? | ¿ | upside-down question |
Input | Rendered | Description |
\(Bq | „ | right low double-quote |
\(bq | ‚ | right low single-quote |
\(lq | “ | left double-quote |
\(rq | ” | right double-quote |
\(oq | ‘ | left single-quote |
\(cq | ’ | right single-quote |
\(aq | ' | apostrophe quote (ASCII character) |
\(dq | " | double quote (ASCII character) |
\(Fo | « | left guillemet |
\(Fc | » | right guillemet |
\(fo | ‹ | left single guillemet |
\(fc | › | right single guillemet |
Input | Rendered | Description |
\(lB | [ | left bracket |
\(rB | ] | right bracket |
\(lC | { | left brace |
\(rC | } | right brace |
\(la | ⟨ | left angle |
\(ra | ⟩ | right angle |
\(bv | ⎪ | brace extension (special font) |
\[braceex] | ⎪ | brace extension |
\[bracketlefttp] | ⎡ | top-left hooked bracket |
\[bracketleftbt] | ⎣ | bottom-left hooked bracket |
\[bracketleftex] | ⎢ | left hooked bracket extension |
\[bracketrighttp] | ⎤ | top-right hooked bracket |
\[bracketrightbt] | ⎦ | bottom-right hooked bracket |
\[bracketrightex] | ⎥ | right hooked bracket extension |
\(lt | ⎧ | top-left hooked brace |
\[bracelefttp] | ⎧ | top-left hooked brace |
\(lk | ⎨ | mid-left hooked brace |
\[braceleftmid] | ⎨ | mid-left hooked brace |
\(lb | ⎩ | bottom-left hooked brace |
\[braceleftbt] | ⎩ | bottom-left hooked brace |
\[braceleftex] | ⎪ | left hooked brace extension |
\(rt | ⎫ | top-left hooked brace |
\[bracerighttp] | ⎫ | top-right hooked brace |
\(rk | ⎬ | mid-right hooked brace |
\[bracerightmid] | ⎬ | mid-right hooked brace |
\(rb | ⎭ | bottom-right hooked brace |
\[bracerightbt] | ⎭ | bottom-right hooked brace |
\[bracerightex] | ⎪ | right hooked brace extension |
\[parenlefttp] | ⎛ | top-left hooked parenthesis |
\[parenleftbt] | ⎝ | bottom-left hooked parenthesis |
\[parenleftex] | ⎜ | left hooked parenthesis extension |
\[parenrighttp] | ⎞ | top-right hooked parenthesis |
\[parenrightbt] | ⎠ | bottom-right hooked parenthesis |
\[parenrightex] | ⎟ | right hooked parenthesis extension |
Input | Rendered | Description |
\(<- | ← | left arrow |
\(-> | → | right arrow |
\(<> | ↔ | left-right arrow |
\(da | ↓ | down arrow |
\(ua | ↑ | up arrow |
\(va | ↕ | up-down arrow |
\(lA | ⇐ | left double-arrow |
\(rA | ⇒ | right double-arrow |
\(hA | ⇔ | left-right double-arrow |
\(uA | ⇑ | up double-arrow |
\(dA | ⇓ | down double-arrow |
\(vA | ⇕ | up-down double-arrow |
\(an | horizontal arrow extension |
Input | Rendered | Description |
\(AN | ∧ | logical and |
\(OR | ∨ | logical or |
\[tno] | ¬ | logical not (text font) |
\(no | ¬ | logical not (special font) |
\(te | ∃ | existential quantifier |
\(fa | ∀ | universal quantifier |
\(st | ∋ | such that |
\(tf | ∴ | therefore |
\(3d | ∴ | therefore |
\(or | | | bitwise or |
Input | Rendered | Description |
\- | - | minus (text font) |
\(mi | − | minus (special font) |
+ | + | plus (text font) |
\(pl | + | plus (special font) |
\(-+ | ∓ | minus-plus |
\[t+-] | ± | plus-minus (text font) |
\(+- | ± | plus-minus (special font) |
\(pc | · | center-dot |
\[tmu] | × | multiply (text font) |
\(mu | × | multiply (special font) |
\(c* | ⊗ | circle-multiply |
\(c+ | ⊕ | circle-plus |
\[tdi] | ÷ | divide (text font) |
\(di | ÷ | divide (special font) |
\(f/ | ⁄ | fraction |
\(** | ∗ | asterisk |
\(<= | ≤ | less-than-equal |
\(>= | ≥ | greater-than-equal |
\(<< | ≪ | much less |
\(>> | ≫ | much greater |
\(eq | = | equal |
\(!= | ≠ | not equal |
\(== | ≡ | equivalent |
\(ne | ≢ | not equivalent |
\(ap | ∼ | tilde operator |
\(|= | ≃ | asymptotically equal |
\(=~ | ≅ | approximately equal |
\(~~ | ≈ | almost equal |
\(~= | ≈ | almost equal |
\(pt | ∝ | proportionate |
\(es | ∅ | empty set |
\(mo | ∈ | element |
\(nm | ∉ | not element |
\(sb | ⊂ | proper subset |
\(nb | ⊄ | not subset |
\(sp | ⊃ | proper superset |
\(nc | ⊅ | not superset |
\(ib | ⊆ | reflexive subset |
\(ip | ⊇ | reflexive superset |
\(ca | ∩ | intersection |
\(cu | ∪ | union |
\(/_ | ∠ | angle |
\(pp | ⊥ | perpendicular |
\(is | ∫ | integral |
\[integral] | ∫ | integral |
\[sum] | ∑ | summation |
\[product] | ∏ | product |
\[coproduct] | ∐ | coproduct |
\(gr | ∇ | gradient |
\(sr | √ | square root |
\[sqrt] | √ | square root |
\(lc | ⌈ | left-ceiling |
\(rc | ⌉ | right-ceiling |
\(lf | ⌊ | left-floor |
\(rf | ⌋ | right-floor |
\(if | ∞ | infinity |
\(Ah | ℵ | aleph |
\(Im | ℑ | imaginary |
\(Re | ℜ | real |
\(wp | Weierstrass p | |
\(pd | ∂ | partial differential |
\(-h | ℏ | Planck constant over 2π |
\[hbar] | Planck constant over 2π | |
\(12 | ½ | one-half |
\(14 | ¼ | one-fourth |
\(34 | ¾ | three-fourths |
\(18 | one-eighth | |
\(38 | three-eighths | |
\(58 | five-eighths | |
\(78 | seven-eighths | |
\(S1 | superscript 1 | |
\(S2 | superscript 2 | |
\(S3 | superscript 3 |
Input | Rendered | Description |
\(ff | ff | ff ligature |
\(fi | fi | fi ligature |
\(fl | fl | fl ligature |
\(Fi | ffi | ffi ligature |
\(Fl | ffl | ffl ligature |
\(AE | Æ | AE |
\(ae | æ | ae |
\(OE | Œ | OE |
\(oe | œ | oe |
\(ss | ß | German eszett |
\(IJ | IJ | IJ ligature |
\(ij | ij | ij ligature |
Input | Rendered | Description |
\(a" | ˝ | Hungarian umlaut |
\(a- | ¯ | macron |
\(a. | ˙ | dotted |
\(a^ | ^ | circumflex |
\(aa | ´ | acute |
\' | ´ | acute |
\(ga | ` | grave |
\` | ` | grave |
\(ab | ˘ | breve |
\(ac | ¸ | cedilla |
\(ad | ¨ | dieresis |
\(ah | ˇ | caron |
\(ao | ˚ | ring |
\(a~ | ~ | tilde |
\(ho | ˛ | ogonek |
\(ha | ^ | hat (ASCII character) |
\(ti | ~ | tilde (ASCII character) |
Input | Rendered | Description |
\('A | Á | acute A |
\('E | É | acute E |
\('I | Í | acute I |
\('O | Ó | acute O |
\('U | Ú | acute U |
\('Y | acute Y | |
\('a | á | acute a |
\('e | é | acute e |
\('i | í | acute i |
\('o | ó | acute o |
\('u | ú | acute u |
\('y | acute y | |
\(`A | À | grave A |
\(`E | È | grave E |
\(`I | Ì | grave I |
\(`O | Ò | grave O |
\(`U | Ù | grave U |
\(`a | à | grave a |
\(`e | è | grave e |
\(`i | ì | grave i |
\(`o | ì | grave o |
\(`u | ù | grave u |
\(~A | Ã | tilde A |
\(~N | Ñ | tilde N |
\(~O | Õ | tilde O |
\(~a | ã | tilde a |
\(~n | ñ | tilde n |
\(~o | õ | tilde o |
\(:A | Ä | dieresis A |
\(:E | Ë | dieresis E |
\(:I | Ï | dieresis I |
\(:O | Ö | dieresis O |
\(:U | Ü | dieresis U |
\(:a | ä | dieresis a |
\(:e | ë | dieresis e |
\(:i | ï | dieresis i |
\(:o | ö | dieresis o |
\(:u | ü | dieresis u |
\(:y | ÿ | dieresis y |
\(^A | Â | circumflex A |
\(^E | Ê | circumflex E |
\(^I | Î | circumflex I |
\(^O | Ô | circumflex O |
\(^U | Û | circumflex U |
\(^a | â | circumflex a |
\(^e | ê | circumflex e |
\(^i | î | circumflex i |
\(^o | ô | circumflex o |
\(^u | û | circumflex u |
\(,C | Ç | cedilla C |
\(,c | ç | cedilla c |
\(/L | Ł | stroke L |
\(/l | ł | stroke l |
\(/O | Ø | stroke O |
\(/o | ø | stroke o |
\(oA | Å | ring A |
\(oa | å | ring a |
Input | Rendered | Description |
\(-D | Ð | Eth |
\(Sd | ð | eth |
\(TP | Þ | Thorn |
\(Tp | þ | thorn |
\(.i | ı | dotless i |
\(.j | ȷ | dotless j |
Input | Rendered | Description |
\(Do | $ | dollar |
\(ct | ¢ | cent |
\(Eu | € | Euro symbol |
\(eu | € | Euro symbol |
\(Ye | ¥ | yen |
\(Po | £ | pound |
\(Cs | ¤ | Scandinavian |
\(Fn | ƒ | florin |
Input | Rendered | Description |
\(de | ° | degree |
\(%0 | ‰ | per-thousand |
\(fm | ′ | minute |
\(sd | ″ | second |
\(mc | µ | micro |
\(Of | Spanish female ordinal | |
\(Om | Spanish masculine ordinal |
Input | Rendered | Description |
\(*A | Α | Alpha |
\(*B | Β | Beta |
\(*G | Γ | Gamma |
\(*D | Δ | Delta |
\(*E | Ε | Epsilon |
\(*Z | Ζ | Zeta |
\(*Y | Η | Eta |
\(*H | Θ | Theta |
\(*I | Ι | Iota |
\(*K | Κ | Kappa |
\(*L | Λ | Lambda |
\(*M | Μ | Mu |
\(*N | Ν | Nu |
\(*C | Ξ | Xi |
\(*O | Ο | Omicron |
\(*P | Π | Pi |
\(*R | Ρ | Rho |
\(*S | Σ | Sigma |
\(*T | Τ | Tau |
\(*U | Υ | Upsilon |
\(*F | Φ | Phi |
\(*X | Χ | Chi |
\(*Q | Ψ | Psi |
\(*W | Ω | Omega |
\(*a | α | alpha |
\(*b | β | beta |
\(*g | γ | gamma |
\(*d | δ | delta |
\(*e | ε | epsilon |
\(*z | ζ | zeta |
\(*y | η | eta |
\(*h | θ | theta |
\(*i | ι | iota |
\(*k | κ | kappa |
\(*l | λ | lambda |
\(*m | μ | mu |
\(*n | ν | nu |
\(*c | ξ | xi |
\(*o | ο | omicron |
\(*p | π | pi |
\(*r | ρ | rho |
\(*s | σ | sigma |
\(*t | τ | tau |
\(*u | υ | upsilon |
\(*f | ϕ | phi |
\(*x | χ | chi |
\(*q | ψ | psi |
\(*w | ω | omega |
\(+h | ϑ | theta variant |
\(+f | φ | phi variant |
\(+p | ϖ | pi variant |
\(+e | ϵ | epsilon variant |
\(ts | ς | sigma terminal |
PREDEFINED STRINGS
Predefined strings are inherited from the macro packages of historical troff implementations. They are not recommended for use, as they differ across implementations. Manuals using these predefined strings are almost certainly not portable.Input | Rendered | Description |
\*(Ba | | | vertical bar |
\*(Ne | ≠ | not equal |
\*(Ge | ≥ | greater-than-equal |
\*(Le | ≤ | less-than-equal |
\*(Gt | > | greater-than |
\*(Lt | < | less-than |
\*(Pm | ± | plus-minus |
\*(If | infinity | infinity |
\*(Pi | pi | pi |
\*(Na | NaN | NaN |
\*(Am | & | ampersand |
\*R | ® | restricted mark |
\*(Tm | (Tm) | trade mark |
\*q | " | double-quote |
\*(Rq | ” | right-double-quote |
\*(Lq | “ | left-double-quote |
\*(lp | ( | right-parenthesis |
\*(rp | ) | left-parenthesis |
\*(lq | “ | left double-quote |
\*(rq | ” | right double-quote |
\*(ua | ↑ | up arrow |
\*(va | ↕ | up-down arrow |
\*(<= | ≤ | less-than-equal |
\*(>= | ≥ | greater-than-equal |
\*(aa | ´ | acute |
\*(ga | ` | grave |
\*(Px | POSIX | POSIX standard name |
\*(Ai | ANSI | ANSI standard name |
UNICODE CHARACTERS
The escape sequences\[uXXXX] and \C'uXXXX'
NUMBERED CHARACTERS
For backward compatibility with existing manuals, mandoc(1) also supports the\N'number' and \[charnumber]
COMPATIBILITY
This section documents compatibility between mandoc and other troff implementations, at this time limited to GNU troff (“groff”).- The \N'' escape sequence is limited to printable characters; in groff, it accepts arbitrary character numbers.
- In -Tascii, the \(ss, \(nm, \(nb, \(nc, \(ib, \(ip, \(pp, \[sum], \[product], \[coproduct], \(gr, \(-h, and \(a. special characters render differently between mandoc and groff.
- In -Thtml, the \(~=, \(nb, and \(nc special characters render differently between mandoc and groff.
- The -Tps and -Tpdf modes format like -Tascii instead of rendering glyphs as in groff.
- The \[radicalex], \[sqrtex], and \(ru special characters have been omitted from mandoc either because they are poorly documented or they have no known representation.