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