Annotation of mandoc/mandoc_char.7, Revision 1.10
1.10 ! kristaps 1: .\" $Id: mandoc_char.7,v 1.9 2009/07/27 12:02:49 kristaps Exp $
1.1 kristaps 2: .\"
1.5 kristaps 3: .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
1.4 kristaps 6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: .\"
1.4 kristaps 9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: .\"
17: .Dd $Mdocdate$
1.2 kristaps 18: .Dt MANDOC_CHAR 7
1.1 kristaps 19: .Os
20: .\" SECTION
21: .Sh NAME
22: .Nm mandoc_char
23: .Nd mandoc special characters
24: .\" SECTION
25: .Sh DESCRIPTION
1.10 ! kristaps 26: This documents the special characters and predefined strings accepted by
1.1 kristaps 27: .Xr mandoc 1
28: to format
29: .Xr mdoc 7
30: and
31: .Xr man 7
32: documents. Specific output devices of
33: .Xr mandoc 1 ,
34: dictated by the
35: .Fl T Ns Ar output
36: argument, will properly render these sequences.
1.10 ! kristaps 37: .\" PARAGRAPH
1.1 kristaps 38: .Pp
39: Both
40: .Xr mdoc 7
41: and
42: .Xr man 7
1.10 ! kristaps 43: encode special characters with
1.9 kristaps 44: .Sq \eX
45: .Pq for a one-character escape ,
46: .Sq \e(XX
47: .Pq two-character ,
48: and
49: .Sq \e[N]
50: .Pq N-character .
51: One may generalise
52: .Sq \e(XX
53: as
1.10 ! kristaps 54: .Sq \e[XX]
! 55: and
! 56: .Sq \eX
! 57: as
! 58: .Sq \e[X] .
! 59: Predefined strings are functionally similar to special characters, using
! 60: .Sq \e*X
! 61: .Pq for a one-character escape ,
! 62: .Sq \e*(XX
! 63: .Pq two-character ,
! 64: and
! 65: .Sq \e*[N]
! 66: .Pq N-character .
! 67: One may generalise
! 68: .Sq \e*(XX
! 69: as
! 70: .Sq \e*[XX]
! 71: and
! 72: .Sq \e*X
! 73: as
! 74: .Sq \e*[X] .
! 75: .\" SECTION
! 76: .Sh Special Characters
! 77: These are the preferred input symbols for producing special characters.
1.8 kristaps 78: .\" PARAGRAPH
79: .Pp
80: Typographic:
81: .Bl -tag -width Ds -offset indent -compact
82: .It \e~
83: .Pq non-breaking space
84: .It \e
85: .Pq space
86: .It \e^
87: .Pq zero-width space
1.9 kristaps 88: .It \e%
1.8 kristaps 89: .Pq zero-width space
90: .It \e&
91: .Pq zero-width space
1.9 kristaps 92: .It \e|
93: .Pq zero-width space
1.8 kristaps 94: .El
95: .\" PARAGRAPH
1.1 kristaps 96: .Pp
97: Grammatic:
1.8 kristaps 98: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 99: .It \e(em
100: .Pq em-dash
101: .It \e(en
102: .Pq en-dash
1.7 kristaps 103: .It \e(hy
1.1 kristaps 104: .Pq hyphen
105: .It \e\e
106: .Pq back-slash
107: .It \e'
108: .Pq apostrophe
109: .It \e`
110: .Pq back-tick
111: .It \e.
112: .Pq period
113: .It \e(r!
114: .Pq upside-down exclamation
115: .It \e(r?
116: .Pq upside-down question
117: .El
118: .\" PARAGRAPH
119: .Pp
120: Enclosures:
1.8 kristaps 121: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 122: .It \e(lh
123: .Pq left hand
124: .It \e(rh
125: .Pq right hand
126: .It \e(Fo
127: .Pq left guillemet
128: .It \e(Fc
129: .Pq right guillemet
130: .It \e(fo
131: .Pq left guilsing
132: .It \e(fc
133: .Pq right guilsing
134: .It \e(rC
135: .Pq right brace
136: .It \e(lC
137: .Pq left brace
138: .It \e(ra
139: .Pq right angle
140: .It \e(la
141: .Pq left angle
142: .It \e(rB
143: .Pq right bracket
144: .It \e(lB
145: .Pq left bracket
146: .It \e(lq
147: .Pq left double-quote
148: .It \e(rq
149: .Pq right double-quote
150: .It \e(oq
151: .Pq left single-quote
152: .It \e(aq
153: .Pq right single-quote
154: .It \e(Bq
155: .Pq right low double-quote
156: .It \e(bq
157: .Pq right low single-quote
158: .El
159: .\" PARAGRAPH
160: .Pp
161: Indicatives:
1.8 kristaps 162: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 163: .It \e(<-
164: .Pq left arrow
165: .It \e(->
166: .Pq right arrow
167: .It \e(ua
168: .Pq up arrow
169: .It \e(da
170: .Pq down arrow
171: .It \e(<>
172: .Pq left-right arrow
173: .It \e(lA
174: .Pq left double-arrow
175: .It \e(rA
176: .Pq right double-arrow
177: .It \e(uA
178: .Pq up double-arrow
179: .It \e(dA
180: .Pq down double-arrow
181: .It \e(hA
182: .Pq left-right double-arrow
183: .El
184: .\" PARAGRAPH
185: .Pp
186: Mathematical:
1.8 kristaps 187: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 188: .It \e(es
189: .Pq empty set
190: .It \e(ca
191: .Pq intersection
192: .It \e(cu
193: .Pq union
194: .It \e(gr
195: .Pq gradient
196: .It \e(pd
197: .Pq partial differential
198: .It \e(ap
199: .Pq similarity
200: .It \e(=)
201: .Pq proper superset
202: .It \e((=
203: .Pq proper subset
204: .It \e(eq
205: .Pq equals
206: .It \e(di
207: .Pq division
208: .It \e(mu
209: .Pq multiplication
210: .It \e(pl
211: .Pq addition
1.7 kristaps 212: .It \e-
213: .Pq subtraction
1.1 kristaps 214: .It \e(nm
215: .Pq not element
216: .It \e(mo
217: .Pq element
218: .It \e(Im
219: .Pq imaginary
220: .It \e(Re
221: .Pq real
222: .It \e(Ah
223: .Pq aleph
224: .It \e(te
225: .Pq existential quantifier
226: .It \e(fa
227: .Pq universal quantifier
228: .It \e(AN
229: .Pq logical AND
230: .It \e(OR
231: .Pq logical OR
232: .It \e(no
233: .Pq logical NOT
234: .It \e(st
235: .Pq such that
236: .It \e(tf
237: .Pq therefore
238: .It \e(~~
239: .Pq approximate
240: .It \e(~=
241: .Pq approximately equals
242: .It \e(=~
243: .Pq congruent
244: .It \e(<=
245: .Pq less-than-equal
246: .It \e(>=
247: .Pq greater-than-equal
248: .It \e(==
249: .Pq equal
250: .It \e(!=
251: .Pq not equal
252: .It \e(if
253: .Pq infinity
254: .It \e(na
1.10 ! kristaps 255: .Pq NaN, an extension
1.1 kristaps 256: .It \e(+-
257: .Pq plus-minus
258: .It \e(**
259: .Pq asterisk
260: .El
261: .\" PARAGRAPH
262: .Pp
263: Ligatures:
1.8 kristaps 264: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 265: .It \e(ss
266: .Pq German eszett
267: .It \e(AE
268: .Pq upper-case AE
269: .It \e(ae
270: .Pq lower-case AE
271: .It \e(OE
272: .Pq upper-case OE
273: .It \e(oe
274: .Pq lower-case OE
275: .It \e(ff
276: .Pq ff ligature
277: .It \e(fi
278: .Pq fi ligature
279: .It \e(fl
280: .Pq fl ligature
281: .It \e(Fi
282: .Pq ffi ligature
283: .It \e(Fl
284: .Pq ffl ligature
285: .El
286: .\" PARAGRAPH
287: .Pp
288: Diacritics and letters:
1.8 kristaps 289: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 290: .It \e(ga
291: .Pq grave accent
292: .It \e(aa
293: .Pq accute accent
294: .It \e(a"
295: .Pq umlaut accent
296: .It \e(ad
297: .Pq dieresis accent
298: .It \e(a~
299: .Pq tilde accent
300: .It \e(a^
301: .Pq circumflex accent
302: .It \e(ac
303: .Pq cedilla accent
304: .It \e(ad
305: .Pq dieresis accent
306: .It \e(ah
307: .Pq caron accent
308: .It \e(ao
309: .Pq ring accent
310: .It \e(ho
311: .Pq hook accent
312: .It \e(ab
313: .Pq breve accent
314: .It \e(a-
315: .Pq macron accent
316: .It \e(-D
317: .Pq upper-case eth
318: .It \e(Sd
319: .Pq lower-case eth
320: .It \e(TP
321: .Pq upper-case thorn
322: .It \e(Tp
323: .Pq lower-case thorn
324: .It \e('A
325: .Pq upper-case acute A
326: .It \e('E
327: .Pq upper-case acute E
328: .It \e('I
329: .Pq upper-case acute I
330: .It \e('O
331: .Pq upper-case acute O
332: .It \e('U
333: .Pq upper-case acute U
334: .It \e('a
335: .Pq lower-case acute a
336: .It \e('e
337: .Pq lower-case acute e
338: .It \e('i
339: .Pq lower-case acute i
340: .It \e('o
341: .Pq lower-case acute o
342: .It \e('u
343: .Pq lower-case acute u
344: .It \e(`A
345: .Pq upper-case grave A
346: .It \e(`E
347: .Pq upper-case grave E
348: .It \e(`I
349: .Pq upper-case grave I
350: .It \e(`O
351: .Pq upper-case grave O
352: .It \e(`U
353: .Pq upper-case grave U
354: .It \e(`a
355: .Pq lower-case grave a
356: .It \e(`e
357: .Pq lower-case grave e
358: .It \e(`i
359: .Pq lower-case grave i
360: .It \e(`o
361: .Pq lower-case grave o
362: .It \e(`u
363: .Pq lower-case grave u
364: .It \e(~A
365: .Pq upper-case tilde A
366: .It \e(~N
367: .Pq upper-case tilde N
368: .It \e(~O
369: .Pq upper-case tilde O
370: .It \e(~a
371: .Pq lower-case tilde a
372: .It \e(~n
373: .Pq lower-case tilde n
374: .It \e(~o
375: .Pq lower-case tilde o
376: .It \e(:A
377: .Pq upper-case dieresis A
378: .It \e(:E
379: .Pq upper-case dieresis E
380: .It \e(:I
381: .Pq upper-case dieresis I
382: .It \e(:O
383: .Pq upper-case dieresis O
384: .It \e(:U
385: .Pq upper-case dieresis U
386: .It \e(:a
387: .Pq lower-case dieresis a
388: .It \e(:e
389: .Pq lower-case dieresis e
390: .It \e(:i
391: .Pq lower-case dieresis i
392: .It \e(:o
393: .Pq lower-case dieresis o
394: .It \e(:u
395: .Pq lower-case dieresis u
396: .It \e(:y
397: .Pq lower-case dieresis y
398: .It \e(^A
399: .Pq upper-case circumflex A
400: .It \e(^E
401: .Pq upper-case circumflex E
402: .It \e(^I
403: .Pq upper-case circumflex I
404: .It \e(^O
405: .Pq upper-case circumflex O
406: .It \e(^U
407: .Pq upper-case circumflex U
408: .It \e(^a
409: .Pq lower-case circumflex a
410: .It \e(^e
411: .Pq lower-case circumflex e
412: .It \e(^i
413: .Pq lower-case circumflex i
414: .It \e(^o
415: .Pq lower-case circumflex o
416: .It \e(^u
417: .Pq lower-case circumflex u
418: .It \e(,C
419: .Pq upper-case cedilla C
420: .It \e(,c
421: .Pq lower-case cedilla c
422: .It \e(/L
423: .Pq upper-case stroke L
424: .It \e(/l
425: .Pq lower-case stroke l
426: .It \e(/O
427: .Pq upper-case stroke O
428: .It \e(/o
429: .Pq lower-case stroke o
430: .It \e(oA
431: .Pq upper-case ring A
432: .It \e(oa
433: .Pq lower-case ring a
434: .El
435: .\" PARAGRAPH
436: .Pp
437: Monetary:
1.8 kristaps 438: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 439: .It \e(Cs
440: .Pq Scandinavian
441: .It \e(Do
442: .Pq dollar
443: .It \e(Po
444: .Pq pound
445: .It \e(Ye
446: .Pq yen
447: .It \e(Fn
448: .Pq florin
449: .It \e(ct
450: .Pq cent
451: .El
452: .\" PARAGRAPH
453: .Pp
454: Special symbols:
1.8 kristaps 455: .Bl -tag -width Ds -offset indent -compact
1.1 kristaps 456: .It \e0
457: .Pq white-space
458: .It \e(de
459: .Pq degree
460: .It \e(ps
461: .Pq paragraph
462: .It \e(sc
463: .Pq section
464: .It \e(dg
465: .Pq dagger
466: .It \e(dd
467: .Pq double dagger
468: .It \e(ci
469: .Pq circle
470: .It \e(ba
471: .Pq bar
472: .It \e(bb
473: .Pq broken bar
474: .It \e(co
475: .Pq copyright
476: .It \e(rg
477: .Pq registered
478: .It \e(tm
479: .Pq trademarked
480: .It \ee
481: .Pq escape
482: .El
483: .\" SECTION
1.10 ! kristaps 484: .Sh PREDEFINED STRINGS
! 485: These are not recommended for use, as they differ across
! 486: implementations:
! 487: .Pp
! 488: Mathematical:
! 489: .Bl -tag -width Ds -offset indent -compact
! 490: .It \e*(Ne
! 491: .Pq not equal
! 492: .It \e*(Ge
! 493: .Pq greater-than-equal
! 494: .It \e*(Le
! 495: .Pq less-than-equal
! 496: .It \e*(Gt
! 497: .Pq greater-than
! 498: .It \e*(Lt
! 499: .Pq greater-than
! 500: .It \e*(Pm
! 501: .Pq plus-minus
! 502: .It \e*(If
! 503: .Pq infinity
! 504: .It \e*(Pi
! 505: .Pq pi
! 506: .It \e*(Na
! 507: .Pq NaN
! 508: .El
! 509: .\" PARAGRAPH
! 510: .Pp
! 511: Special symbols:
! 512: .Bl -tag -width Ds -offset indent -compact
! 513: .It \e*(Ba
! 514: .Pq vertical bar
! 515: .It \e*(Am
! 516: .Pq ampersand
! 517: .El
! 518: .\" PARAGRAPH
! 519: .Pp
! 520: Enclosures:
! 521: .Bl -tag -width Ds -offset indent -compact
! 522: .It \e*q
! 523: .Pq double-quote
! 524: .It \e*(Rq
! 525: .Pq right-double-quote
! 526: .It \e*(Lq
! 527: .Pq left-double-quote
! 528: .It \e*(lp
! 529: .Pq right-parenthesis
! 530: .It \e*(rp
! 531: .Pq left-parenthesis
! 532: .El
! 533: .\" SECTION
1.3 kristaps 534: .Sh COMPATIBILITY
535: This section documents compatibility of
536: .Nm
537: with older or existing versions of
538: .Xr groff 1 :
539: .Pp
1.8 kristaps 540: .Bl -tag -width Ds -offset indent -compact
1.3 kristaps 541: .It \e(ss
542: Renders differently in
543: .Fl T Ns Ar ascii
544: mode.
545: .El
546: .\" SECTION
1.1 kristaps 547: .Sh SEE ALSO
548: .Xr mandoc 1
549: .\" SECTION
550: .Sh AUTHORS
551: The
552: .Nm
553: utility was written by
1.6 kristaps 554: .An Kristaps Dzonsons Aq kristaps@kth.se .
CVSweb