version 1.8, 2009/07/26 19:53:40 |
version 1.46, 2011/07/22 14:15:15 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MANDOC_CHAR 7 |
.Dt MANDOC_CHAR 7 |
.Os |
.Os |
.\" SECTION |
|
.Sh NAME |
.Sh NAME |
.Nm mandoc_char |
.Nm mandoc_char |
.Nd mandoc special characters |
.Nd mandoc special characters |
.\" SECTION |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
This documents the special characters accepted by |
This page documents the special characters and predefined strings accepted by |
.Xr mandoc 1 |
.Xr mandoc 1 |
to format |
to format |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
documents. Specific output devices of |
documents. |
.Xr mandoc 1 , |
|
dictated by the |
|
.Fl T Ns Ar output |
|
argument, will properly render these sequences. |
|
.Pp |
.Pp |
Both |
Both |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
encode special characters with slightly different semantics; consult the |
encode special characters with |
respective manuals for these escapes. |
.Sq \eX |
.\" PARAGRAPH |
.Pq for a one-character escape , |
|
.Sq \e(XX |
|
.Pq two-character , |
|
and |
|
.Sq \e[N] |
|
.Pq N-character . |
|
One may generalise |
|
.Sq \e(XX |
|
as |
|
.Sq \e[XX] |
|
and |
|
.Sq \eX |
|
as |
|
.Sq \e[X] . |
|
Predefined strings are functionally similar to special characters, using |
|
.Sq \e*X |
|
.Pq for a one-character escape , |
|
.Sq \e*(XX |
|
.Pq two-character , |
|
and |
|
.Sq \e*[N] |
|
.Pq N-character . |
|
One may generalise |
|
.Sq \e*(XX |
|
as |
|
.Sq \e*[XX] |
|
and |
|
.Sq \e*X |
|
as |
|
.Sq \e*[X] . |
.Pp |
.Pp |
Typographic: |
Note that each output mode will have a different rendering of the |
.Bl -tag -width Ds -offset indent -compact |
characters. |
.It \e~ |
It's guaranteed that each input symbol will correspond to a |
.Pq non-breaking space |
(more or less) meaningful output rendering, regardless the mode. |
.It \e |
.Sh SPECIAL CHARACTERS |
.Pq space |
These are the preferred input symbols for producing special characters. |
.It \e^ |
.Pp |
.Pq zero-width space |
Spacing: |
.It \e^ |
.Bl -column -compact -offset indent "Input" "Description" |
.Pq zero-width space |
.It Em Input Ta Em Description |
.It \e& |
.It \e~ Ta non-breaking, non-collapsing space |
.Pq zero-width space |
.It \e Ta breaking, non-collapsing n-width space |
|
.It \e^ Ta zero-width space |
|
.It \e% Ta zero-width space |
|
.It \e& Ta zero-width space |
|
.It \e| Ta zero-width space |
|
.It \e0 Ta breaking, non-collapsing digit-width space |
|
.It \ec Ta removes any trailing space (if applicable) |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Grammatic: |
Lines: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(em |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq em-dash |
.It \e(ba Ta \(ba Ta bar |
.It \e(en |
.It \e(br Ta \(br Ta box rule |
.Pq en-dash |
.It \e(ul Ta \(ul Ta underscore |
.It \e(hy |
.It \e(rl Ta \(rl Ta overline |
.Pq hyphen |
.It \e(bb Ta \(bb Ta broken bar |
.It \e\e |
.It \e(sl Ta \(sl Ta forward slash |
.Pq back-slash |
.It \e(rs Ta \(rs Ta backward slash |
.It \e' |
|
.Pq apostrophe |
|
.It \e` |
|
.Pq back-tick |
|
.It \e. |
|
.Pq period |
|
.It \e(r! |
|
.Pq upside-down exclamation |
|
.It \e(r? |
|
.Pq upside-down question |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Enclosures: |
Text markers: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(lh |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq left hand |
.It \e(ci Ta \(ci Ta circle |
.It \e(rh |
.It \e(bu Ta \(bu Ta bullet |
.Pq right hand |
.It \e(dd Ta \(dd Ta double dagger |
.It \e(Fo |
.It \e(dg Ta \(dg Ta dagger |
.Pq left guillemet |
.It \e(lz Ta \(lz Ta lozenge |
.It \e(Fc |
.It \e(sq Ta \(sq Ta white square |
.Pq right guillemet |
.It \e(ps Ta \(ps Ta paragraph |
.It \e(fo |
.It \e(sc Ta \(sc Ta section |
.Pq left guilsing |
.It \e(lh Ta \(lh Ta left hand |
.It \e(fc |
.It \e(rh Ta \(rh Ta right hand |
.Pq right guilsing |
.It \e(at Ta \(at Ta at |
.It \e(rC |
.It \e(sh Ta \(sh Ta hash (pound) |
.Pq right brace |
.It \e(CR Ta \(CR Ta carriage return |
.It \e(lC |
.It \e(OK Ta \(OK Ta check mark |
.Pq left brace |
|
.It \e(ra |
|
.Pq right angle |
|
.It \e(la |
|
.Pq left angle |
|
.It \e(rB |
|
.Pq right bracket |
|
.It \e(lB |
|
.Pq left bracket |
|
.It \eq |
|
.Pq double-quote |
|
.It \e(lq |
|
.Pq left double-quote |
|
.It \e(Lq |
|
.Pq left double-quote, deprecated |
|
.It \e(rq |
|
.Pq right double-quote |
|
.It \e(Rq |
|
.Pq right double-quote, deprecated |
|
.It \e(oq |
|
.Pq left single-quote |
|
.It \e(aq |
|
.Pq right single-quote |
|
.It \e(Bq |
|
.Pq right low double-quote |
|
.It \e(bq |
|
.Pq right low single-quote |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Indicatives: |
Legal symbols: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(<- |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq left arrow |
.It \e(co Ta \(co Ta copyright |
.It \e(-> |
.It \e(rg Ta \(rg Ta registered |
.Pq right arrow |
.It \e(tm Ta \(tm Ta trademarked |
.It \e(ua |
|
.Pq up arrow |
|
.It \e(da |
|
.Pq down arrow |
|
.It \e(<> |
|
.Pq left-right arrow |
|
.It \e(lA |
|
.Pq left double-arrow |
|
.It \e(rA |
|
.Pq right double-arrow |
|
.It \e(uA |
|
.Pq up double-arrow |
|
.It \e(dA |
|
.Pq down double-arrow |
|
.It \e(hA |
|
.Pq left-right double-arrow |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
|
Punctuation: |
|
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(em Ta \(em Ta em-dash |
|
.It \e(en Ta \(en Ta en-dash |
|
.It \e(hy Ta \(hy Ta hyphen |
|
.It \ee Ta \e Ta back-slash |
|
.It \e. Ta \. Ta period |
|
.It \e(r! Ta \(r! Ta upside-down exclamation |
|
.It \e(r? Ta \(r? Ta upside-down question |
|
.El |
|
.Pp |
|
Quotes: |
|
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(Bq Ta \(Bq Ta right low double-quote |
|
.It \e(bq Ta \(bq Ta right low single-quote |
|
.It \e(lq Ta \(lq Ta left double-quote |
|
.It \e(rq Ta \(rq Ta right double-quote |
|
.It \e(oq Ta \(oq Ta left single-quote |
|
.It \e(cq Ta \(cq Ta right single-quote |
|
.It \e(aq Ta \(aq Ta apostrophe quote (text) |
|
.It \e(dq Ta \(dq Ta double quote (text) |
|
.It \e(Fo Ta \(Fo Ta left guillemet |
|
.It \e(Fc Ta \(Fc Ta right guillemet |
|
.It \e(fo Ta \(fo Ta left single guillemet |
|
.It \e(fc Ta \(fc Ta right single guillemet |
|
.El |
|
.Pp |
|
Brackets: |
|
.Bl -column -compact -offset indent "xxbracketrightbpx" Rendered Description |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(lB Ta \(lB Ta left bracket |
|
.It \e(rB Ta \(rB Ta right bracket |
|
.It \e(lC Ta \(lC Ta left brace |
|
.It \e(rC Ta \(rC Ta right brace |
|
.It \e(la Ta \(la Ta left angle |
|
.It \e(ra Ta \(ra Ta right angle |
|
.It \e(bv Ta \(bv Ta brace extension |
|
.It \e[braceex] Ta \[braceex] Ta brace extension |
|
.It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket |
|
.It \e[bracketleftbp] Ta \[bracketleftbp] Ta bottom-left hooked bracket |
|
.It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension |
|
.It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket |
|
.It \e[bracketrightbp] Ta \[bracketrightbp] Ta bottom-right hooked bracket |
|
.It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension |
|
.It \e(lt Ta \(lt Ta top-left hooked brace |
|
.It \e[bracelefttp] Ta \[bracelefttp] Ta top-left hooked brace |
|
.It \e(lk Ta \(lk Ta mid-left hooked brace |
|
.It \e[braceleftmid] Ta \[braceleftmid] Ta mid-left hooked brace |
|
.It \e(lb Ta \(lb Ta bottom-left hooked brace |
|
.It \e[braceleftbp] Ta \[braceleftbp] Ta bottom-left hooked brace |
|
.It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension |
|
.It \e(rt Ta \(rt Ta top-left hooked brace |
|
.It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace |
|
.It \e(rk Ta \(rk Ta mid-right hooked brace |
|
.It \e[bracerightmid] Ta \[bracerightmid] Ta mid-right hooked brace |
|
.It \e(rb Ta \(rb Ta bottom-right hooked brace |
|
.It \e[bracerightbp] Ta \[bracerightbp] Ta bottom-right hooked brace |
|
.It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension |
|
.It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis |
|
.It \e[parenleftbp] Ta \[parenleftbp] Ta bottom-left hooked parenthesis |
|
.It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension |
|
.It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis |
|
.It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis |
|
.It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension |
|
.El |
|
.Pp |
|
Arrows: |
|
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(<- Ta \(<- Ta left arrow |
|
.It \e(-> Ta \(-> Ta right arrow |
|
.It \e(<> Ta \(<> Ta left-right arrow |
|
.It \e(da Ta \(da Ta down arrow |
|
.It \e(ua Ta \(ua Ta up arrow |
|
.It \e(va Ta \(va Ta up-down arrow |
|
.It \e(lA Ta \(lA Ta left double-arrow |
|
.It \e(rA Ta \(rA Ta right double-arrow |
|
.It \e(hA Ta \(hA Ta left-right double-arrow |
|
.It \e(uA Ta \(uA Ta up double-arrow |
|
.It \e(dA Ta \(dA Ta down double-arrow |
|
.It \e(vA Ta \(vA Ta up-down double-arrow |
|
.El |
|
.Pp |
|
Logical: |
|
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(AN Ta \(AN Ta logical and |
|
.It \e(OR Ta \(OR Ta logical or |
|
.It \e(no Ta \(no Ta logical not |
|
.It \e[tno] Ta \[tno] Ta logical not (text) |
|
.It \e(te Ta \(te Ta existential quantifier |
|
.It \e(fa Ta \(fa Ta universal quantifier |
|
.It \e(st Ta \(st Ta such that |
|
.It \e(tf Ta \(tf Ta therefore |
|
.It \e(3d Ta \(3d Ta therefore |
|
.It \e(or Ta \(or Ta bitwise or |
|
.El |
|
.Pp |
Mathematical: |
Mathematical: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "xxcoproductxx" "Rendered" "Description" |
.It \e(es |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq empty set |
.It \e(pl Ta \(pl Ta plus |
.It \e(ca |
.It \e(mi Ta \(mi Ta minus |
.Pq intersection |
.It \e- Ta \- Ta minus (text) |
.It \e(cu |
.It \e(-+ Ta \(-+ Ta minus-plus |
.Pq union |
.It \e(+- Ta \(+- Ta plus-minus |
.It \e(gr |
.It \e[t+-] Ta \[t+-] Ta plus-minus (text) |
.Pq gradient |
.It \e(pc Ta \(pc Ta centre-dot |
.It \e(pd |
.It \e(mu Ta \(mu Ta multiply |
.Pq partial differential |
.It \e[tmu] Ta \[tmu] Ta multiply (text) |
.It \e(ap |
.It \e(c* Ta \(c* Ta circle-multiply |
.Pq similarity |
.It \e(c+ Ta \(c+ Ta circle-plus |
.It \e(=) |
.It \e(di Ta \(di Ta divide |
.Pq proper superset |
.It \e[tdi] Ta \[tdi] Ta divide (text) |
.It \e((= |
.It \e(f/ Ta \(f/ Ta fraction |
.Pq proper subset |
.It \e(** Ta \(** Ta asterisk |
.It \e(eq |
.It \e(<= Ta \(<= Ta less-than-equal |
.Pq equals |
.It \e(>= Ta \(>= Ta greater-than-equal |
.It \e(di |
.It \e(<< Ta \(<< Ta much less |
.Pq division |
.It \e(>> Ta \(>> Ta much greater |
.It \e(mu |
.It \e(eq Ta \(eq Ta equal |
.Pq multiplication |
.It \e(!= Ta \(!= Ta not equal |
.It \e(pl |
.It \e(== Ta \(== Ta equivalent |
.Pq addition |
.It \e(ne Ta \(ne Ta not equivalent |
.It \e- |
.It \e(=~ Ta \(=~ Ta congruent |
.Pq subtraction |
.It \e(-~ Ta \(-~ Ta asymptotically congruent |
.It \e(nm |
.It \e(ap Ta \(ap Ta asymptotically similar |
.Pq not element |
.It \e(~~ Ta \(~~ Ta approximately similar |
.It \e(mo |
.It \e(~= Ta \(~= Ta approximately equal |
.Pq element |
.It \e(pt Ta \(pt Ta proportionate |
.It \e(Im |
.It \e(es Ta \(es Ta empty set |
.Pq imaginary |
.It \e(mo Ta \(mo Ta element |
.It \e(Re |
.It \e(nm Ta \(nm Ta not element |
.Pq real |
.It \e(sb Ta \(sb Ta proper subset |
.It \e(Ah |
.It \e(nb Ta \(nb Ta not subset |
.Pq aleph |
.It \e(sp Ta \(sp Ta proper superset |
.It \e(te |
.It \e(nc Ta \(nc Ta not superset |
.Pq existential quantifier |
.It \e(ib Ta \(ib Ta reflexive subset |
.It \e(fa |
.It \e(ip Ta \(ip Ta reflexive superset |
.Pq universal quantifier |
.It \e(ca Ta \(ca Ta intersection |
.It \e(AN |
.It \e(cu Ta \(cu Ta union |
.Pq logical AND |
.It \e(/_ Ta \(/_ Ta angle |
.It \e(OR |
.It \e(pp Ta \(pp Ta perpendicular |
.Pq logical OR |
.It \e(is Ta \(is Ta integral |
.It \e(no |
.It \e[integral] Ta \[integral] Ta integral |
.Pq logical NOT |
.It \e[sum] Ta \[sum] Ta summation |
.It \e(st |
.It \e[product] Ta \[product] Ta product |
.Pq such that |
.It \e[coproduct] Ta \[coproduct] Ta coproduct |
.It \e(tf |
.It \e(gr Ta \(gr Ta gradient |
.Pq therefore |
.It \e(sr Ta \(sr Ta square root |
.It \e(~~ |
.It \e[sqrt] Ta \[sqrt] Ta square root |
.Pq approximate |
.It \e(lc Ta \(lc Ta left-ceiling |
.It \e(~= |
.It \e(rc Ta \(rc Ta right-ceiling |
.Pq approximately equals |
.It \e(lf Ta \(lf Ta left-floor |
.It \e(=~ |
.It \e(rf Ta \(rf Ta right-floor |
.Pq congruent |
.It \e(if Ta \(if Ta infinity |
.It \e(Gt |
.It \e(Ah Ta \(Ah Ta aleph |
.Pq greater-than, deprecated |
.It \e(Im Ta \(Im Ta imaginary |
.It \e(Lt |
.It \e(Re Ta \(Re Ta real |
.Pq less-than, deprecated |
.It \e(pd Ta \(pd Ta partial differential |
.It \e(<= |
.It \e(-h Ta \(-h Ta Planck constant over 2\(*p |
.Pq less-than-equal |
.It \e[12] Ta \[12] Ta one-half |
.It \e(Le |
.It \e[14] Ta \[14] Ta one-fourth |
.Pq less-than-equal, deprecated |
.It \e[34] Ta \[34] Ta three-fourths |
.It \e(>= |
|
.Pq greater-than-equal |
|
.It \e(Ge |
|
.Pq greater-than-equal |
|
.It \e(== |
|
.Pq equal |
|
.It \e(!= |
|
.Pq not equal |
|
.It \e(Ne |
|
.Pq not equal, deprecated |
|
.It \e(if |
|
.Pq infinity |
|
.It \e(If |
|
.Pq infinity, deprecated |
|
.It \e(na |
|
.Pq NaN , an extension |
|
.It \e(Na |
|
.Pq NaN, deprecated |
|
.It \e(+- |
|
.Pq plus-minus |
|
.It \e(Pm |
|
.Pq plus-minus, deprecated |
|
.It \e(** |
|
.Pq asterisk |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Ligatures: |
Ligatures: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(ss |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq German eszett |
.It \e(ff Ta \(ff Ta ff ligature |
.It \e(AE |
.It \e(fi Ta \(fi Ta fi ligature |
.Pq upper-case AE |
.It \e(fl Ta \(fl Ta fl ligature |
.It \e(ae |
.It \e(Fi Ta \(Fi Ta ffi ligature |
.Pq lower-case AE |
.It \e(Fl Ta \(Fl Ta ffl ligature |
.It \e(OE |
.It \e(AE Ta \(AE Ta AE |
.Pq upper-case OE |
.It \e(ae Ta \(ae Ta ae |
.It \e(oe |
.It \e(OE Ta \(OE Ta OE |
.Pq lower-case OE |
.It \e(oe Ta \(oe Ta oe |
.It \e(ff |
.It \e(ss Ta \(ss Ta German eszett |
.Pq ff ligature |
.It \e(IJ Ta \(IJ Ta IJ ligature |
.It \e(fi |
.It \e(ij Ta \(ij Ta ij ligature |
.Pq fi ligature |
|
.It \e(fl |
|
.Pq fl ligature |
|
.It \e(Fi |
|
.Pq ffi ligature |
|
.It \e(Fl |
|
.Pq ffl ligature |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Diacritics and letters: |
Accents: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(ga |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq grave accent |
.It \e(a" Ta \(a" Ta Hungarian umlaut |
.It \e(aa |
.It \e(a- Ta \(a- Ta macron |
.Pq accute accent |
.It \e(a. Ta \(a. Ta dotted |
.It \e(a" |
.It \e(a^ Ta \(a^ Ta circumflex |
.Pq umlaut accent |
.It \e(aa Ta \(aa Ta acute |
.It \e(ad |
.It \e' Ta \' Ta acute |
.Pq dieresis accent |
.It \e(ga Ta \(ga Ta grave |
.It \e(a~ |
.It \e` Ta \` Ta grave |
.Pq tilde accent |
.It \e(ab Ta \(ab Ta breve |
.It \e(a^ |
.It \e(ac Ta \(ac Ta cedilla |
.Pq circumflex accent |
.It \e(ad Ta \(ad Ta dieresis |
.It \e(ac |
.It \e(ah Ta \(ah Ta caron |
.Pq cedilla accent |
.It \e(ao Ta \(ao Ta ring |
.It \e(ad |
.It \e(a~ Ta \(a~ Ta tilde |
.Pq dieresis accent |
.It \e(ho Ta \(ho Ta ogonek |
.It \e(ah |
.It \e(ha Ta \(ha Ta hat (text) |
.Pq caron accent |
.It \e(ti Ta \(ti Ta tilde (text) |
.It \e(ao |
|
.Pq ring accent |
|
.It \e(ho |
|
.Pq hook accent |
|
.It \e(ab |
|
.Pq breve accent |
|
.It \e(a- |
|
.Pq macron accent |
|
.It \e(-D |
|
.Pq upper-case eth |
|
.It \e(Sd |
|
.Pq lower-case eth |
|
.It \e(TP |
|
.Pq upper-case thorn |
|
.It \e(Tp |
|
.Pq lower-case thorn |
|
.It \e('A |
|
.Pq upper-case acute A |
|
.It \e('E |
|
.Pq upper-case acute E |
|
.It \e('I |
|
.Pq upper-case acute I |
|
.It \e('O |
|
.Pq upper-case acute O |
|
.It \e('U |
|
.Pq upper-case acute U |
|
.It \e('a |
|
.Pq lower-case acute a |
|
.It \e('e |
|
.Pq lower-case acute e |
|
.It \e('i |
|
.Pq lower-case acute i |
|
.It \e('o |
|
.Pq lower-case acute o |
|
.It \e('u |
|
.Pq lower-case acute u |
|
.It \e(`A |
|
.Pq upper-case grave A |
|
.It \e(`E |
|
.Pq upper-case grave E |
|
.It \e(`I |
|
.Pq upper-case grave I |
|
.It \e(`O |
|
.Pq upper-case grave O |
|
.It \e(`U |
|
.Pq upper-case grave U |
|
.It \e(`a |
|
.Pq lower-case grave a |
|
.It \e(`e |
|
.Pq lower-case grave e |
|
.It \e(`i |
|
.Pq lower-case grave i |
|
.It \e(`o |
|
.Pq lower-case grave o |
|
.It \e(`u |
|
.Pq lower-case grave u |
|
.It \e(~A |
|
.Pq upper-case tilde A |
|
.It \e(~N |
|
.Pq upper-case tilde N |
|
.It \e(~O |
|
.Pq upper-case tilde O |
|
.It \e(~a |
|
.Pq lower-case tilde a |
|
.It \e(~n |
|
.Pq lower-case tilde n |
|
.It \e(~o |
|
.Pq lower-case tilde o |
|
.It \e(:A |
|
.Pq upper-case dieresis A |
|
.It \e(:E |
|
.Pq upper-case dieresis E |
|
.It \e(:I |
|
.Pq upper-case dieresis I |
|
.It \e(:O |
|
.Pq upper-case dieresis O |
|
.It \e(:U |
|
.Pq upper-case dieresis U |
|
.It \e(:a |
|
.Pq lower-case dieresis a |
|
.It \e(:e |
|
.Pq lower-case dieresis e |
|
.It \e(:i |
|
.Pq lower-case dieresis i |
|
.It \e(:o |
|
.Pq lower-case dieresis o |
|
.It \e(:u |
|
.Pq lower-case dieresis u |
|
.It \e(:y |
|
.Pq lower-case dieresis y |
|
.It \e(^A |
|
.Pq upper-case circumflex A |
|
.It \e(^E |
|
.Pq upper-case circumflex E |
|
.It \e(^I |
|
.Pq upper-case circumflex I |
|
.It \e(^O |
|
.Pq upper-case circumflex O |
|
.It \e(^U |
|
.Pq upper-case circumflex U |
|
.It \e(^a |
|
.Pq lower-case circumflex a |
|
.It \e(^e |
|
.Pq lower-case circumflex e |
|
.It \e(^i |
|
.Pq lower-case circumflex i |
|
.It \e(^o |
|
.Pq lower-case circumflex o |
|
.It \e(^u |
|
.Pq lower-case circumflex u |
|
.It \e(,C |
|
.Pq upper-case cedilla C |
|
.It \e(,c |
|
.Pq lower-case cedilla c |
|
.It \e(/L |
|
.Pq upper-case stroke L |
|
.It \e(/l |
|
.Pq lower-case stroke l |
|
.It \e(/O |
|
.Pq upper-case stroke O |
|
.It \e(/o |
|
.Pq lower-case stroke o |
|
.It \e(oA |
|
.Pq upper-case ring A |
|
.It \e(oa |
|
.Pq lower-case ring a |
|
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Monetary: |
Accented letters: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(Cs |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq Scandinavian |
.It \e('A Ta \('A Ta acute A |
.It \e(Do |
.It \e('E Ta \('E Ta acute E |
.Pq dollar |
.It \e('I Ta \('I Ta acute I |
.It \e(Po |
.It \e('O Ta \('O Ta acute O |
.Pq pound |
.It \e('U Ta \('U Ta acute U |
.It \e(Ye |
.It \e('a Ta \('a Ta acute a |
.Pq yen |
.It \e('e Ta \('e Ta acute e |
.It \e(Fn |
.It \e('i Ta \('i Ta acute i |
.Pq florin |
.It \e('o Ta \('o Ta acute o |
.It \e(ct |
.It \e('u Ta \('u Ta acute u |
.Pq cent |
.It \e(`A Ta \(`A Ta grave A |
|
.It \e(`E Ta \(`E Ta grave E |
|
.It \e(`I Ta \(`I Ta grave I |
|
.It \e(`O Ta \(`O Ta grave O |
|
.It \e(`U Ta \(`U Ta grave U |
|
.It \e(`a Ta \(`a Ta grave a |
|
.It \e(`e Ta \(`e Ta grave e |
|
.It \e(`i Ta \(`i Ta grave i |
|
.It \e(`o Ta \(`i Ta grave o |
|
.It \e(`u Ta \(`u Ta grave u |
|
.It \e(~A Ta \(~A Ta tilde A |
|
.It \e(~N Ta \(~N Ta tilde N |
|
.It \e(~O Ta \(~O Ta tilde O |
|
.It \e(~a Ta \(~a Ta tilde a |
|
.It \e(~n Ta \(~n Ta tilde n |
|
.It \e(~o Ta \(~o Ta tilde o |
|
.It \e(:A Ta \(:A Ta dieresis A |
|
.It \e(:E Ta \(:E Ta dieresis E |
|
.It \e(:I Ta \(:I Ta dieresis I |
|
.It \e(:O Ta \(:O Ta dieresis O |
|
.It \e(:U Ta \(:U Ta dieresis U |
|
.It \e(:a Ta \(:a Ta dieresis a |
|
.It \e(:e Ta \(:e Ta dieresis e |
|
.It \e(:i Ta \(:i Ta dieresis i |
|
.It \e(:o Ta \(:o Ta dieresis o |
|
.It \e(:u Ta \(:u Ta dieresis u |
|
.It \e(:y Ta \(:y Ta dieresis y |
|
.It \e(^A Ta \(^A Ta circumflex A |
|
.It \e(^E Ta \(^E Ta circumflex E |
|
.It \e(^I Ta \(^I Ta circumflex I |
|
.It \e(^O Ta \(^O Ta circumflex O |
|
.It \e(^U Ta \(^U Ta circumflex U |
|
.It \e(^a Ta \(^a Ta circumflex a |
|
.It \e(^e Ta \(^e Ta circumflex e |
|
.It \e(^i Ta \(^i Ta circumflex i |
|
.It \e(^o Ta \(^o Ta circumflex o |
|
.It \e(^u Ta \(^u Ta circumflex u |
|
.It \e(,C Ta \(,C Ta cedilla C |
|
.It \e(,c Ta \(,c Ta cedilla c |
|
.It \e(/L Ta \(/L Ta stroke L |
|
.It \e(/l Ta \(/l Ta stroke l |
|
.It \e(/O Ta \(/O Ta stroke O |
|
.It \e(/o Ta \(/o Ta stroke o |
|
.It \e(oA Ta \(oA Ta ring A |
|
.It \e(oa Ta \(oa Ta ring a |
.El |
.El |
.\" PARAGRAPH |
|
.Pp |
.Pp |
Special symbols: |
Special letters: |
.Bl -tag -width Ds -offset indent -compact |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e0 |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq white-space |
.It \e(-D Ta \(-D Ta Eth |
.It \e(de |
.It \e(Sd Ta \(Sd Ta eth |
.Pq degree |
.It \e(TP Ta \(TP Ta Thorn |
.It \e(ps |
.It \e(Tp Ta \(Tp Ta thorn |
.Pq paragraph |
.It \e(.i Ta \(.i Ta dotless i |
.It \e(sc |
.It \e(.j Ta \(.j Ta dotless j |
.Pq section |
.El |
.It \e(dg |
.Pp |
.Pq dagger |
Currency: |
.It \e(dd |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.Pq double dagger |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(ci |
.It \e(Do Ta \(Do Ta dollar |
.Pq circle |
.It \e(ct Ta \(ct Ta cent |
.It \e(ba |
.It \e(Eu Ta \(Eu Ta Euro symbol |
.Pq bar |
.It \e(eu Ta \(eu Ta Euro symbol |
.It \e(bb |
.It \e(Ye Ta \(Ye Ta yen |
.Pq broken bar |
.It \e(Po Ta \(Po Ta pound |
.It \e(Ba |
.It \e(Cs Ta \(Cs Ta Scandinavian |
.Pq bar, deprecated |
.It \e(Fn Ta \(Fn Ta florin |
.It \e(co |
.El |
.Pq copyright |
.Pp |
.It \e(rg |
Units: |
.Pq registered |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It \e(tm |
.It Em Input Ta Em Rendered Ta Em Description |
.Pq trademarked |
.It \e(de Ta \(de Ta degree |
.It \e& |
.It \e(%0 Ta \(%0 Ta per-thousand |
.Pq non-breaking space |
.It \e(fm Ta \(fm Ta minute |
.It \ee |
.It \e(sd Ta \(sd Ta second |
.Pq escape |
.It \e(mc Ta \(mc Ta micro |
.It \e(Am |
.El |
.Pq ampersand, deprecated |
.Pp |
.El |
Greek letters: |
.\" SECTION |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e(*A Ta \(*A Ta Alpha |
|
.It \e(*B Ta \(*B Ta Beta |
|
.It \e(*G Ta \(*G Ta Gamma |
|
.It \e(*D Ta \(*D Ta Delta |
|
.It \e(*E Ta \(*E Ta Epsilon |
|
.It \e(*Z Ta \(*Z Ta Zeta |
|
.It \e(*Y Ta \(*Y Ta Eta |
|
.It \e(*H Ta \(*H Ta Theta |
|
.It \e(*I Ta \(*I Ta Iota |
|
.It \e(*K Ta \(*K Ta Kappa |
|
.It \e(*L Ta \(*L Ta Lambda |
|
.It \e(*M Ta \(*M Ta Mu |
|
.It \e(*N Ta \(*N Ta Nu |
|
.It \e(*C Ta \(*C Ta Xi |
|
.It \e(*O Ta \(*O Ta Omicron |
|
.It \e(*P Ta \(*P Ta Pi |
|
.It \e(*R Ta \(*R Ta Rho |
|
.It \e(*S Ta \(*S Ta Sigma |
|
.It \e(*T Ta \(*T Ta Tau |
|
.It \e(*U Ta \(*U Ta Upsilon |
|
.It \e(*F Ta \(*F Ta Phi |
|
.It \e(*X Ta \(*X Ta Chi |
|
.It \e(*Q Ta \(*Q Ta Psi |
|
.It \e(*W Ta \(*W Ta Omega |
|
.It \e(*a Ta \(*a Ta alpha |
|
.It \e(*b Ta \(*b Ta beta |
|
.It \e(*g Ta \(*g Ta gamma |
|
.It \e(*d Ta \(*d Ta delta |
|
.It \e(*e Ta \(*e Ta epsilon |
|
.It \e(*z Ta \(*z Ta zeta |
|
.It \e(*y Ta \(*y Ta eta |
|
.It \e(*h Ta \(*h Ta theta |
|
.It \e(*i Ta \(*i Ta iota |
|
.It \e(*k Ta \(*k Ta kappa |
|
.It \e(*l Ta \(*l Ta lambda |
|
.It \e(*m Ta \(*m Ta mu |
|
.It \e(*n Ta \(*n Ta nu |
|
.It \e(*c Ta \(*c Ta xi |
|
.It \e(*o Ta \(*o Ta omicron |
|
.It \e(*p Ta \(*p Ta pi |
|
.It \e(*r Ta \(*r Ta rho |
|
.It \e(*s Ta \(*s Ta sigma |
|
.It \e(*t Ta \(*t Ta tau |
|
.It \e(*u Ta \(*u Ta upsilon |
|
.It \e(*f Ta \(*f Ta phi |
|
.It \e(*x Ta \(*x Ta chi |
|
.It \e(*q Ta \(*q Ta psi |
|
.It \e(*w Ta \(*w Ta omega |
|
.It \e(+h Ta \(+h Ta theta variant |
|
.It \e(+f Ta \(+f Ta phi variant |
|
.It \e(+p Ta \(+p Ta pi variant |
|
.It \e(+e Ta \(+e Ta epsilon variant |
|
.It \e(ts Ta \(ts Ta sigma terminal |
|
.El |
|
.Sh PREDEFINED STRINGS |
|
Predefined strings are inherited from the macro packages of historical |
|
troff implementations. |
|
They are |
|
.Em not recommended |
|
for use, as they differ across implementations. |
|
Manuals using these predefined strings are almost certainly not |
|
portable. |
|
.Pp |
|
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
|
.It Em Input Ta Em Rendered Ta Em Description |
|
.It \e*(Ba Ta \*(Ba Ta vertical bar |
|
.It \e*(Ne Ta \*(Ne Ta not equal |
|
.It \e*(Ge Ta \*(Ge Ta greater-than-equal |
|
.It \e*(Le Ta \*(Le Ta less-than-equal |
|
.It \e*(Gt Ta \*(Gt Ta greater-than |
|
.It \e*(Lt Ta \*(Lt Ta less-than |
|
.It \e*(Pm Ta \*(Pm Ta plus-minus |
|
.It \e*(If Ta \*(If Ta infinity |
|
.It \e*(Pi Ta \*(Pi Ta pi |
|
.It \e*(Na Ta \*(Na Ta NaN |
|
.It \e*(Am Ta \*(Am Ta ampersand |
|
.It \e*R Ta \*R Ta restricted mark |
|
.It \e*(Tm Ta \*(Tm Ta trade mark |
|
.It \e*q Ta \*q Ta double-quote |
|
.It \e*(Rq Ta \*(Rq Ta right-double-quote |
|
.It \e*(Lq Ta \*(Lq Ta left-double-quote |
|
.It \e*(lp Ta \*(lp Ta right-parenthesis |
|
.It \e*(rp Ta \*(rp Ta left-parenthesis |
|
.It \e*(lq Ta \*(lq Ta left double-quote |
|
.It \e*(rq Ta \*(rq Ta right double-quote |
|
.It \e*(ua Ta \*(ua Ta up arrow |
|
.It \e*(va Ta \*(va Ta up-down arrow |
|
.It \e*(<= Ta \*(<= Ta less-than-equal |
|
.It \e*(>= Ta \*(>= Ta greater-than-equal |
|
.It \e*(aa Ta \*(aa Ta acute |
|
.It \e*(ga Ta \*(ga Ta grave |
|
.It \e*(Px Ta \*(Px Ta POSIX standard name |
|
.It \e*(Ai Ta \*(Ai Ta ANSI standard name |
|
.El |
|
.Sh UNICODE CHARACTERS |
|
The escape sequence |
|
.Pp |
|
.Dl \e[uXXXX] |
|
.Pp |
|
is interpreted as a Unicode codepoint. |
|
The codepoint must be in the range above U+0080 and less than U+10FFFF. |
|
For compatibility, points must be zero-padded to four characters; if |
|
greater than four characters, no zero padding is allowed. |
|
Unicode surrogates are not allowed. |
|
.\" .Pp |
|
.\" Unicode glyphs attenuate to the |
|
.\" .Sq \&? |
|
.\" character if invalid or not rendered by current output media. |
|
.Sh NUMBERED CHARACTERS |
|
For backward compatibility with existing manuals, |
|
.Xr mandoc 1 |
|
also supports the |
|
.Pp |
|
.Dl \eN\(aq Ns Ar number Ns \(aq |
|
.Pp |
|
escape sequence, inserting the character |
|
.Ar number |
|
from the current character set into the output. |
|
Of course, this is inherently non-portable and is already marked |
|
as deprecated in the Heirloom roff manual. |
|
For example, do not use \eN'34', use \e(dq, or even the plain |
|
.Sq \(dq |
|
character where possible. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility of |
This section documents compatibility between mandoc and other other |
.Nm |
troff implementations, at this time limited to GNU troff |
with older or existing versions of |
.Pq Qq groff . |
.Xr groff 1 : |
|
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -dash -compact |
.It \e(ss |
.It |
Renders differently in |
The \eN\(aq\(aq escape sequence is limited to printable characters; in |
.Fl T Ns Ar ascii |
groff, it accepts arbitrary character numbers. |
mode. |
.It |
|
In |
|
.Fl T Ns Cm ascii , |
|
the |
|
\e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product], |
|
\e[coproduct], \e(gr, \e(\-h, and \e(a. special characters render |
|
differently between mandoc and groff. |
|
.It |
|
In |
|
.Fl T Ns Cm html |
|
and |
|
.Fl T Ns Cm xhtml , |
|
the \e(~=, \e(nb, and \e(nc special characters render differently |
|
between mandoc and groff. |
|
.It |
|
The |
|
.Fl T Ns Cm ps |
|
and |
|
.Fl T Ns Cm pdf |
|
modes format like |
|
.Fl T Ns Cm ascii |
|
instead of rendering glyphs as in groff. |
|
.It |
|
The \e[radicalex], \e[sqrtex], and \e(ru special characters have been omitted |
|
from mandoc either because they are poorly documented or they have no |
|
known representation. |
.El |
.El |
.\" SECTION |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 |
.Xr mandoc 1 |
.\" SECTION |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
manual page was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
|
.Sh CAVEATS |
|
The |
|
.Sq \e*(Ba |
|
escape mimics the behaviour of the |
|
.Sq \&| |
|
character in |
|
.Xr mdoc 7 ; |
|
thus, if you wish to render a vertical bar with no side effects, use |
|
the |
|
.Sq \e(ba |
|
escape. |