[BACK]Return to mandoc_char.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_char.7 between version 1.38 and 1.63

version 1.38, 2010/05/09 21:11:22 version 1.63, 2015/09/02 15:38:35
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
   .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2011, 2013, 2015 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" 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
Line 21 
Line 23 
 .Nm mandoc_char  .Nm mandoc_char
 .Nd mandoc special characters  .Nd mandoc special characters
 .Sh DESCRIPTION  .Sh DESCRIPTION
 This page documents the special characters and predefined strings accepted by  This page documents the
   .Xr roff 7
   escape sequences accepted by
 .Xr mandoc 1  .Xr mandoc 1
 to format  to represent special characters in
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr man 7  .Xr man 7
 documents.  documents.
 .Pp  .Pp
 Both  The rendering depends on the
 .Xr mdoc 7  .Xr mandoc 1
 and  output mode; in ASCII output, most characters are completely
 .Xr man 7  unintelligible.
 encode special characters with  For that reason, using any of the special characters documented here,
   except those discussed in the
   .Sx DESCRIPTION ,
   is strongly discouraged; they are supported merely for backwards
   compatibility with existing documents.
   .Pp
   In particular, in English manual pages, do not use special-character
   escape sequences to represent national language characters in author
   names; instead, provide ASCII transcriptions of the names.
   .Ss Dashes and Hyphens
   In typography there are different types of dashes of various width:
   the hyphen (-),
   the minus sign (\(mi),
   the en-dash (\(en),
   and the em-dash (\(em).
   .Pp
   Hyphens are used for adjectives;
   to separate the two parts of a compound word;
   or to separate a word across two successive lines of text.
   The hyphen does not need to be escaped:
   .Bd -unfilled -offset indent
   blue-eyed
   lorry-driver
   .Ed
   .Pp
   The mathematical minus sign is used for negative numbers or subtraction.
   It should be written as
   .Sq \e(mi :
   .Bd -unfilled -offset indent
   a = 3 \e(mi 1;
   b = \e(mi2;
   .Ed
   .Pp
   The en-dash is used to separate the two elements of a range,
   or can be used the same way as an em-dash.
   It should be written as
   .Sq \e(en :
   .Bd -unfilled -offset indent
   pp. 95\e(en97.
   Go away \e(en or else!
   .Ed
   .Pp
   The em-dash can be used to show an interruption
   or can be used the same way as colons, semi-colons, or parentheses.
   It should be written as
   .Sq \e(em :
   .Bd -unfilled -offset indent
   Three things \e(em apples, oranges, and bananas.
   This is not that \e(em rather, this is that.
   .Ed
   .Pp
   Note:
   hyphens, minus signs, and en-dashes look identical under normal ASCII output.
   Other formats, such as PostScript, render them correctly,
   with differing widths.
   .Ss 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
   .Pq Sq \  .
   .Pp
   When filling text, output lines may be broken between words, i.e. at space
   characters.
   To prevent a line break between two particular words,
   use the unpaddable non-breaking space escape sequence
   .Pq Sq \e\ \&
   instead of the normal space character.
   For example, the input string
   .Dq number\e\ 1
   will be kept together as
   .Dq number\ 1
   on the same output line.
   .Pp
   On request and macro lines, the normal space character serves as an
   argument delimiter.
   To include whitespace into arguments, quoting is usually the best choice;
   see the MACRO SYNTAX section in
   .Xr roff 7 .
   In some cases, using the non-breaking space escape sequence
   .Pq Sq \e\ \&
   may be preferable.
   .Pp
   To escape macro names and to protect whitespace at the end
   of input lines, the zero-width space
   .Pq Sq \e&
   is often useful.
   For example, in
   .Xr mdoc 7 ,
   a normal space character can be displayed in single quotes in either
   of the following ways:
   .Pp
   .Dl .Sq \(dq \(dq
   .Dl .Sq \e \e&
   .Ss Quotes
   On request and macro lines, the double-quote character
   .Pq Sq \(dq
   is handled specially to allow quoting.
   One way to prevent this special handling is by using the
   .Sq \e(dq
   escape sequence.
   .Pp
   Note that on text lines, literal double-quote characters can be used
   verbatim.
   All other quote-like characters can be used verbatim as well,
   even on request and macro lines.
   .Ss Accents
   In output modes supporting such special output characters, for example
   .Fl T Cm pdf ,
   some
   .Xr roff 7
   formatters convert the following ASCII input characters to the
   following Unicode special output characters:
   .Bl -column x(ga U+2018 -offset indent
   .It \(ga Ta U+2018 Ta left single quotation mark
   .It \(aq Ta U+2019 Ta right single quotation mark
   .It \(ti Ta U+02DC Ta small tilde
   .El
   .Pp
   In prose, this automatic substitution is often desirable;
   but when these characters have to be displayed as plain ASCII
   characters, for example in source code samples, they require
   escaping to render as follows:
   .Bl -column x(ga U+2018 -offset indent
   .It \e(ga Ta U+0060 Ta grave accent
   .It \e(aq Ta U+0027 Ta apostrophe
   .It \e(ti Ta U+007E Ta tilde
   .El
   .Ss Periods
   The period
   .Pq Sq \&.
   is handled specially at the beginning of an input line,
   where it introduces a
   .Xr roff 7
   request or a macro, and when appearing alone as a macro argument in
   .Xr mdoc 7 .
   In such situations, prepend a zero-width space
   .Pq Sq \e&.
   to make it behave like normal text.
   .Pp
   Do not use the
   .Sq \e.
   escape sequence.
   It does not prevent special handling of the period.
   .Ss Backslashes
   To include a literal backslash
   .Pq Sq \e
   into the output, use the
   .Pq Sq \ee
   escape sequence.
   .Pp
   Note that doubling it
   .Pq Sq \e\e
   is not the right way to output a backslash.
   Because
   .Xr mandoc 1
   does not implement full
   .Xr roff 7
   functionality, it may work with
   .Xr mandoc 1 ,
   but it may have weird effects on complete
   .Xr roff 7
   implementations.
   .Sh SPECIAL CHARACTERS
   Special characters are encoded as
 .Sq \eX  .Sq \eX
 .Pq for a one-character escape ,  .Pq for a one-character escape ,
 .Sq \e(XX  .Sq \e(XX
Line 41  encode special characters with
Line 208  encode special characters with
 and  and
 .Sq \e[N]  .Sq \e[N]
 .Pq N-character .  .Pq N-character .
 One may generalise  For details, see the
 .Sq \e(XX  .Em Special Characters
 as  subsection of the
 .Sq \e[XX]  .Xr roff 7
 and  manual.
 .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
 Note that each output mode will have a different rendering of the  
 characters.  
 It's guaranteed that each input symbol will correspond to a  
 (more or less) meaningful output rendering, regardless the mode.  
 .Sh SPECIAL CHARACTERS  
 These are the preferred input symbols for producing special characters.  
 .Pp  
 Spacing:  Spacing:
 .Bl -column -compact -offset indent "Input" "Description"  .Bl -column "Input" "Description" -offset indent -compact
 .It Em Input Ta Em Description  .It Em Input Ta Em Description
 .It \e~      Ta non-breaking, non-collapsing space  .It Sq \e\ \& Ta unpaddable non-breaking space
 .It \e       Ta breaking, non-collapsing n-width space  .It \e\(ti   Ta paddable non-breaking space
 .It \e^      Ta zero-width space  .It \e0      Ta unpaddable, breaking digit-width space
 .It \e%      Ta zero-width space  .It \e|      Ta one-sixth \e(em narrow space, zero width in nroff mode
   .It \e^      Ta one-twelfth \e(em half-narrow space, zero width in nroff
 .It \e&      Ta zero-width space  .It \e&      Ta zero-width space
 .It \e|      Ta zero-width space  .It \e%      Ta zero-width space allowing hyphenation
 .It \e0      Ta breaking, non-collapsing digit-width space  
 .It \ec      Ta removes any trailing space (if applicable)  
 .El  .El
 .Pp  .Pp
 Lines:  Lines:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ba    Ta \(ba        Ta bar  .It \e(ba    Ta \(ba        Ta bar
 .It \e(br    Ta \(br        Ta box rule  .It \e(br    Ta \(br        Ta box rule
 .It \e(ul    Ta \(ul        Ta underscore  .It \e(ul    Ta \(ul        Ta underscore
 .It \e(rl    Ta \(rl        Ta overline  .It \e(rn    Ta \(rn        Ta overline
 .It \e(bb    Ta \(bb        Ta broken bar  .It \e(bb    Ta \(bb        Ta broken bar
 .It \e(sl    Ta \(sl        Ta forward slash  .It \e(sl    Ta \(sl        Ta forward slash
 .It \e(rs    Ta \(rs        Ta backward slash  .It \e(rs    Ta \(rs        Ta backward slash
 .El  .El
 .Pp  .Pp
 Text markers:  Text markers:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ci    Ta \(ci        Ta circle  .It \e(ci    Ta \(ci        Ta circle
 .It \e(bu    Ta \(bu        Ta bullet  .It \e(bu    Ta \(bu        Ta bullet
Line 118  Text markers:
Line 258  Text markers:
 .El  .El
 .Pp  .Pp
 Legal symbols:  Legal symbols:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(co    Ta \(co        Ta copyright  .It \e(co    Ta \(co        Ta copyright
 .It \e(rg    Ta \(rg        Ta registered  .It \e(rg    Ta \(rg        Ta registered
Line 126  Legal symbols:
Line 266  Legal symbols:
 .El  .El
 .Pp  .Pp
 Punctuation:  Punctuation:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(em    Ta \(em        Ta em-dash  .It \e(em    Ta \(em        Ta em-dash
 .It \e(en    Ta \(en        Ta en-dash  .It \e(en    Ta \(en        Ta en-dash
Line 138  Punctuation:
Line 278  Punctuation:
 .El  .El
 .Pp  .Pp
 Quotes:  Quotes:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em 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 double-quote
 .It \e(bq    Ta \(bq        Ta right low single-quote  .It \e(bq    Ta \(bq        Ta right low single-quote
Line 155  Quotes:
Line 295  Quotes:
 .El  .El
 .Pp  .Pp
 Brackets:  Brackets:
 .Bl -column -compact -offset indent "xxbracketrightbpx" Rendered Description  .Bl -column "xxbracketrightbtx" Rendered Description -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(lB    Ta \(lB        Ta left bracket  .It \e(lB    Ta \(lB        Ta left bracket
 .It \e(rB    Ta \(rB        Ta right bracket  .It \e(rB    Ta \(rB        Ta right bracket
Line 166  Brackets:
Line 306  Brackets:
 .It \e(bv    Ta \(bv        Ta brace extension  .It \e(bv    Ta \(bv        Ta brace extension
 .It \e[braceex] Ta \[braceex] Ta brace extension  .It \e[braceex] Ta \[braceex] Ta brace extension
 .It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket  .It \e[bracketlefttp] Ta \[bracketlefttp] Ta top-left hooked bracket
 .It \e[bracketleftbp] Ta \[bracketleftbp] Ta bottom-left hooked bracket  .It \e[bracketleftbt] Ta \[bracketleftbt] Ta bottom-left hooked bracket
 .It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension  .It \e[bracketleftex] Ta \[bracketleftex] Ta left hooked bracket extension
 .It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket  .It \e[bracketrighttp] Ta \[bracketrighttp] Ta top-right hooked bracket
 .It \e[bracketrightbp] Ta \[bracketrightbp] Ta bottom-right hooked bracket  .It \e[bracketrightbt] Ta \[bracketrightbt] Ta bottom-right hooked bracket
 .It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension  .It \e[bracketrightex] Ta \[bracketrightex] Ta right hooked bracket extension
 .It \e(lt    Ta \(lt        Ta top-left hooked brace  .It \e(lt    Ta \(lt        Ta top-left hooked brace
 .It \e[bracelefttp] Ta \[bracelefttp] 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(lk    Ta \(lk        Ta mid-left hooked brace
 .It \e[braceleftmid] Ta \[braceleftmid] 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(lb    Ta \(lb        Ta bottom-left hooked brace
 .It \e[braceleftbp] Ta \[braceleftbp] Ta bottom-left hooked brace  .It \e[braceleftbt] Ta \[braceleftbt] Ta bottom-left hooked brace
 .It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension  .It \e[braceleftex] Ta \[braceleftex] Ta left hooked brace extension
 .It \e(rt    Ta \(rt        Ta top-left hooked brace  .It \e(rt    Ta \(rt        Ta top-left hooked brace
 .It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace  .It \e[bracerighttp] Ta \[bracerighttp] Ta top-right hooked brace
 .It \e(rk    Ta \(rk        Ta mid-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[bracerightmid] Ta \[bracerightmid] Ta mid-right hooked brace
 .It \e(rb    Ta \(rb        Ta bottom-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[bracerightbt] Ta \[bracerightbt] Ta bottom-right hooked brace
 .It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension  .It \e[bracerightex] Ta \[bracerightex] Ta right hooked brace extension
 .It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis  .It \e[parenlefttp] Ta \[parenlefttp] Ta top-left hooked parenthesis
 .It \e[parenleftbp] Ta \[parenleftbp] Ta bottom-left hooked parenthesis  .It \e[parenleftbt] Ta \[parenleftbt] Ta bottom-left hooked parenthesis
 .It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension  .It \e[parenleftex] Ta \[parenleftex] Ta left hooked parenthesis extension
 .It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis  .It \e[parenrighttp] Ta \[parenrighttp] Ta top-right hooked parenthesis
 .It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis  .It \e[parenrightbt] Ta \[parenrightbt] Ta bottom-right hooked parenthesis
 .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension  .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension
 .El  .El
 .Pp  .Pp
 Arrows:  Arrows:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(<-    Ta \(<-        Ta left arrow  .It \e(<-    Ta \(<-        Ta left arrow
 .It \e(->    Ta \(->        Ta right arrow  .It \e(->    Ta \(->        Ta right arrow
Line 211  Arrows:
Line 351  Arrows:
 .El  .El
 .Pp  .Pp
 Logical:  Logical:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(AN    Ta \(AN        Ta logical and  .It \e(AN    Ta \(AN        Ta logical and
 .It \e(OR    Ta \(OR        Ta logical or  .It \e(OR    Ta \(OR        Ta logical or
Line 226  Logical:
Line 366  Logical:
 .El  .El
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Bl -column -compact -offset indent "xxcoproductxx" "Rendered" "Description"  .Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(pl    Ta \(pl        Ta plus  .It \e(pl    Ta \(pl        Ta plus
 .It \e(mi    Ta \(mi        Ta minus  .It \e(mi    Ta \(mi        Ta minus
Line 234  Mathematical:
Line 374  Mathematical:
 .It \e(-+    Ta \(-+        Ta minus-plus  .It \e(-+    Ta \(-+        Ta minus-plus
 .It \e(+-    Ta \(+-        Ta plus-minus  .It \e(+-    Ta \(+-        Ta plus-minus
 .It \e[t+-]  Ta \[t+-]      Ta plus-minus (text)  .It \e[t+-]  Ta \[t+-]      Ta plus-minus (text)
 .It \e(pc    Ta \(pc        Ta centre-dot  .It \e(pc    Ta \(pc        Ta center-dot
 .It \e(mu    Ta \(mu        Ta multiply  .It \e(mu    Ta \(mu        Ta multiply
 .It \e[tmu]  Ta \[tmu]      Ta multiply (text)  .It \e[tmu]  Ta \[tmu]      Ta multiply (text)
 .It \e(c*    Ta \(c*        Ta circle-multiply  .It \e(c*    Ta \(c*        Ta circle-multiply
Line 251  Mathematical:
Line 391  Mathematical:
 .It \e(!=    Ta \(!=        Ta not equal  .It \e(!=    Ta \(!=        Ta not equal
 .It \e(==    Ta \(==        Ta equivalent  .It \e(==    Ta \(==        Ta equivalent
 .It \e(ne    Ta \(ne        Ta not equivalent  .It \e(ne    Ta \(ne        Ta not equivalent
 .It \e(=~    Ta \(=~        Ta congruent  .It \e(ap    Ta \(ap        Ta tilde operator
 .It \e(-~    Ta \(-~        Ta asymptotically congruent  .It \e(|=    Ta \(|=        Ta asymptotically equal
 .It \e(ap    Ta \(ap        Ta asymptotically similar  .It \e(=\(ti Ta \(=~        Ta approximately equal
 .It \e(~~    Ta \(~~        Ta approximately similar  .It \e(\(ti\(ti Ta \(~~        Ta almost equal
 .It \e(~=    Ta \(~=        Ta approximately equal  .It \e(\(ti= Ta \(~=        Ta almost equal
 .It \e(pt    Ta \(pt        Ta proportionate  .It \e(pt    Ta \(pt        Ta proportionate
 .It \e(es    Ta \(es        Ta empty set  .It \e(es    Ta \(es        Ta empty set
 .It \e(mo    Ta \(mo        Ta element  .It \e(mo    Ta \(mo        Ta element
Line 288  Mathematical:
Line 428  Mathematical:
 .It \e(Re    Ta \(Re        Ta real  .It \e(Re    Ta \(Re        Ta real
 .It \e(pd    Ta \(pd        Ta partial differential  .It \e(pd    Ta \(pd        Ta partial differential
 .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p  .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p
   .It \e[12]   Ta \[12]       Ta one-half
   .It \e[14]   Ta \[14]       Ta one-fourth
   .It \e[34]   Ta \[34]       Ta three-fourths
 .El  .El
 .Pp  .Pp
 Ligatures:  Ligatures:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ff    Ta \(ff        Ta ff ligature  .It \e(ff    Ta \(ff        Ta ff ligature
 .It \e(fi    Ta \(fi        Ta fi ligature  .It \e(fi    Ta \(fi        Ta fi ligature
Line 308  Ligatures:
Line 451  Ligatures:
 .El  .El
 .Pp  .Pp
 Accents:  Accents:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(a"    Ta \(a"        Ta Hungarian umlaut  .It \e(a"    Ta \(a"        Ta Hungarian umlaut
 .It \e(a-    Ta \(a-        Ta macron  .It \e(a-    Ta \(a-        Ta macron
 .It \e(a.    Ta \(a.        Ta dotted  .It \e(a.    Ta \(a.        Ta dotted
 .It \e(a^    Ta \(a^        Ta circumflex  .It \e(a^    Ta \(a^        Ta circumflex
 .It \e(aa    Ta \(aa        Ta acute  .It \e(aa    Ta \(aa        Ta acute
 .It \e'      Ta \'          Ta acute  .It \e\(aq   Ta \'          Ta acute
 .It \e(ga    Ta \(ga        Ta grave  .It \e(ga    Ta \(ga        Ta grave
 .It \e`      Ta \`          Ta grave  .It \e\(ga   Ta \`          Ta grave
 .It \e(ab    Ta \(ab        Ta breve  .It \e(ab    Ta \(ab        Ta breve
 .It \e(ac    Ta \(ac        Ta cedilla  .It \e(ac    Ta \(ac        Ta cedilla
 .It \e(ad    Ta \(ad        Ta dieresis  .It \e(ad    Ta \(ad        Ta dieresis
 .It \e(ah    Ta \(ah        Ta caron  .It \e(ah    Ta \(ah        Ta caron
 .It \e(ao    Ta \(ao        Ta ring  .It \e(ao    Ta \(ao        Ta ring
 .It \e(a~    Ta \(a~        Ta tilde  .It \e(a\(ti Ta \(a~        Ta tilde
 .It \e(ho    Ta \(ho        Ta ogonek  .It \e(ho    Ta \(ho        Ta ogonek
 .It \e(ha    Ta \(ha        Ta hat (text)  .It \e(ha    Ta \(ha        Ta hat (text)
 .It \e(ti    Ta \(ti        Ta tilde (text)  .It \e(ti    Ta \(ti        Ta tilde (text)
 .El  .El
 .Pp  .Pp
 Accented letters:  Accented letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e('A    Ta \('A        Ta acute A  .It \e(\(aqA Ta \('A        Ta acute A
 .It \e('E    Ta \('E        Ta acute E  .It \e(\(aqE Ta \('E        Ta acute E
 .It \e('I    Ta \('I        Ta acute I  .It \e(\(aqI Ta \('I        Ta acute I
 .It \e('O    Ta \('O        Ta acute O  .It \e(\(aqO Ta \('O        Ta acute O
 .It \e('U    Ta \('U        Ta acute U  .It \e(\(aqU Ta \('U        Ta acute U
 .It \e('a    Ta \('a        Ta acute a  .It \e(\(aqa Ta \('a        Ta acute a
 .It \e('e    Ta \('e        Ta acute e  .It \e(\(aqe Ta \('e        Ta acute e
 .It \e('i    Ta \('i        Ta acute i  .It \e(\(aqi Ta \('i        Ta acute i
 .It \e('o    Ta \('o        Ta acute o  .It \e(\(aqo Ta \('o        Ta acute o
 .It \e('u    Ta \('u        Ta acute u  .It \e(\(aqu Ta \('u        Ta acute u
 .It \e(`A    Ta \(`A        Ta grave A  .It \e(\(gaA Ta \(`A        Ta grave A
 .It \e(`E    Ta \(`E        Ta grave E  .It \e(\(gaE Ta \(`E        Ta grave E
 .It \e(`I    Ta \(`I        Ta grave I  .It \e(\(gaI Ta \(`I        Ta grave I
 .It \e(`O    Ta \(`O        Ta grave O  .It \e(\(gaO Ta \(`O        Ta grave O
 .It \e(`U    Ta \(`U        Ta grave U  .It \e(\(gaU Ta \(`U        Ta grave U
 .It \e(`a    Ta \(`a        Ta grave a  .It \e(\(gaa Ta \(`a        Ta grave a
 .It \e(`e    Ta \(`e        Ta grave e  .It \e(\(gae Ta \(`e        Ta grave e
 .It \e(`i    Ta \(`i        Ta grave i  .It \e(\(gai Ta \(`i        Ta grave i
 .It \e(`o    Ta \(`i        Ta grave o  .It \e(\(gao Ta \(`i        Ta grave o
 .It \e(`u    Ta \(`u        Ta grave u  .It \e(\(gau Ta \(`u        Ta grave u
 .It \e(~A    Ta \(~A        Ta tilde A  .It \e(\(tiA Ta \(~A        Ta tilde A
 .It \e(~N    Ta \(~N        Ta tilde N  .It \e(\(tiN Ta \(~N        Ta tilde N
 .It \e(~O    Ta \(~O        Ta tilde O  .It \e(\(tiO Ta \(~O        Ta tilde O
 .It \e(~a    Ta \(~a        Ta tilde a  .It \e(\(tia Ta \(~a        Ta tilde a
 .It \e(~n    Ta \(~n        Ta tilde n  .It \e(\(tin Ta \(~n        Ta tilde n
 .It \e(~o    Ta \(~o        Ta tilde o  .It \e(\(tio Ta \(~o        Ta tilde o
 .It \e(:A    Ta \(:A        Ta dieresis A  .It \e(:A    Ta \(:A        Ta dieresis A
 .It \e(:E    Ta \(:E        Ta dieresis E  .It \e(:E    Ta \(:E        Ta dieresis E
 .It \e(:I    Ta \(:I        Ta dieresis I  .It \e(:I    Ta \(:I        Ta dieresis I
Line 390  Accented letters:
Line 533  Accented letters:
 .El  .El
 .Pp  .Pp
 Special letters:  Special letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(-D    Ta \(-D        Ta Eth  .It \e(-D    Ta \(-D        Ta Eth
 .It \e(Sd    Ta \(Sd        Ta eth  .It \e(Sd    Ta \(Sd        Ta eth
Line 401  Special letters:
Line 544  Special letters:
 .El  .El
 .Pp  .Pp
 Currency:  Currency:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(Do    Ta \(Do        Ta dollar  .It \e(Do    Ta \(Do        Ta dollar
 .It \e(ct    Ta \(ct        Ta cent  .It \e(ct    Ta \(ct        Ta cent
Line 414  Currency:
Line 557  Currency:
 .El  .El
 .Pp  .Pp
 Units:  Units:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(de    Ta \(de        Ta degree  .It \e(de    Ta \(de        Ta degree
 .It \e(%0    Ta \(%0        Ta per-thousand  .It \e(%0    Ta \(%0        Ta per-thousand
Line 424  Units:
Line 567  Units:
 .El  .El
 .Pp  .Pp
 Greek letters:  Greek letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(*A    Ta \(*A        Ta Alpha  .It \e(*A    Ta \(*A        Ta Alpha
 .It \e(*B    Ta \(*B        Ta Beta  .It \e(*B    Ta \(*B        Ta Beta
Line 481  Greek letters:
Line 624  Greek letters:
 .It \e(ts    Ta \(ts        Ta sigma terminal  .It \e(ts    Ta \(ts        Ta sigma terminal
 .El  .El
 .Sh PREDEFINED STRINGS  .Sh PREDEFINED STRINGS
 These are not recommended for use, as they differ across  Predefined strings are inherited from the macro packages of historical
 implementations:  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  .Pp
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"  Their syntax is 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 .
   For details, see the
   .Em Predefined Strings
   subsection of the
   .Xr roff 7
   manual.
   .Bl -column "Input" "Rendered" "Description" -offset indent
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e*(Ba   Ta \*(Ba       Ta vertical bar  .It \e*(Ba   Ta \*(Ba       Ta vertical bar
 .It \e*(Ne   Ta \*(Ne       Ta not equal  .It \e*(Ne   Ta \*(Ne       Ta not equal
Line 512  implementations:
Line 673  implementations:
 .It \e*(>=   Ta \*(>=       Ta greater-than-equal  .It \e*(>=   Ta \*(>=       Ta greater-than-equal
 .It \e*(aa   Ta \*(aa       Ta acute  .It \e*(aa   Ta \*(aa       Ta acute
 .It \e*(ga   Ta \*(ga       Ta grave  .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  .El
 .Sh COMPATIBILITY  .Sh UNICODE CHARACTERS
 This section documents compatibility of  The escape sequences
 .Nm  
 with older or existing versions of  
 .Xr groff 1 .  
 .Pp  .Pp
 The following render differently in  .Dl \e[uXXXX] and \eC\(aquXXXX\(aq
 .Fl T Ns Ar ascii  
 output mode:  
 .Bd -ragged -offset indent  
 \e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product],  
 \e[coproduct], \e(gr, \e(-h, \e(a.  
 .Ed  
 .Pp  .Pp
 The following render differently in  are interpreted as Unicode codepoints.
 .Fl T Ns Ar html  The codepoint must be in the range above U+0080 and less than U+10FFFF.
 output mode:  For compatibility, the hexadecimal digits
 .Bd -ragged -offset indent  .Sq A
 \e(~=, \e(nb, \e(nc  to
 .Ed  .Sq F
   must be given as uppercase characters,
   and points must be zero-padded to four characters; if
   greater than four characters, no zero padding is allowed.
   Unicode surrogates are not allowed.
   .Sh NUMBERED CHARACTERS
   For backward compatibility with existing manuals,
   .Xr mandoc 1
   also supports the
 .Pp  .Pp
 Finally, the following have been omitted by being poorly documented or  .Dl \eN\(aq Ns Ar number Ns \(aq
 having no known representation:  .Pp
 .Bd -ragged -offset indent  escape sequence, inserting the character
 \e[radicalex], \e[sqrtex], \e(ru  .Ar number
 .Ed  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\(aq34\(aq, use \e(dq, or even the plain
   .Sq \(dq
   character where possible.
   .Sh COMPATIBILITY
   This section documents compatibility between mandoc and other
   troff implementations, at this time limited to GNU troff
   .Pq Qq groff .
   .Pp
   .Bl -dash -compact
   .It
   The \eN\(aq\(aq escape sequence is limited to printable characters; in
   groff, it accepts arbitrary character numbers.
   .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(\(ti=, \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
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1  .Xr mandoc 1 ,
   .Xr man 7 ,
   .Xr mdoc 7 ,
   .Xr roff 7
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 manual page was written by  manual page was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 .Sh CAVEATS  .Sh CAVEATS
 The  The predefined string
 .Sq \e*(Ba  .Sq \e*(Ba
 escape mimics the behaviour of the  mimics the behaviour of the
 .Sq \*(Ba  .Sq \&|
 character in  character in
 .Xr mdoc 7 ;  .Xr mdoc 7 ;
 thus, if you wish to render a vertical bar with no side effects, use  thus, if you wish to render a vertical bar with no side effects, use
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.63
CVSweb