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