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

Annotation of mandoc/mandoc_char.7, Revision 1.6

1.6     ! kristaps    1: .\"    $Id: mandoc_char.7,v 1.5 2009/06/10 20:18:43 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
                     26: This documents the special characters accepted by
                     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.
                     37: .Pp
                     38: Both
                     39: .Xr mdoc 7
                     40: and
                     41: .Xr man 7
                     42: encode special characters with slightly different semantics; consult the
                     43: respective manuals for these escapes.
                     44: .Pp
                     45: Grammatic:
                     46: .Bl -tag -width 12n -offset "XXXX" -compact
                     47: .It \e(em
                     48: .Pq em-dash
                     49: .It \e(en
                     50: .Pq en-dash
                     51: .It \e-
                     52: .Pq hyphen
                     53: .It \e\e
                     54: .Pq back-slash
                     55: .It \e'
                     56: .Pq apostrophe
                     57: .It \e`
                     58: .Pq back-tick
                     59: .It \e
                     60: .Pq space
                     61: .It \e.
                     62: .Pq period
                     63: .It \e(r!
                     64: .Pq upside-down exclamation
                     65: .It \e(r?
                     66: .Pq upside-down question
                     67: .El
                     68: .\" PARAGRAPH
                     69: .Pp
                     70: Enclosures:
                     71: .Bl -tag -width 12n -offset "XXXX" -compact
                     72: .It \e(lh
                     73: .Pq left hand
                     74: .It \e(rh
                     75: .Pq right hand
                     76: .It \e(Fo
                     77: .Pq left guillemet
                     78: .It \e(Fc
                     79: .Pq right guillemet
                     80: .It \e(fo
                     81: .Pq left guilsing
                     82: .It \e(fc
                     83: .Pq right guilsing
                     84: .It \e(rC
                     85: .Pq right brace
                     86: .It \e(lC
                     87: .Pq left brace
                     88: .It \e(ra
                     89: .Pq right angle
                     90: .It \e(la
                     91: .Pq left angle
                     92: .It \e(rB
                     93: .Pq right bracket
                     94: .It \e(lB
                     95: .Pq left bracket
                     96: .It \eq
                     97: .Pq double-quote
                     98: .It \e(lq
                     99: .Pq left double-quote
                    100: .It \e(Lq
                    101: .Pq left double-quote, deprecated
                    102: .It \e(rq
                    103: .Pq right double-quote
                    104: .It \e(Rq
                    105: .Pq right double-quote, deprecated
                    106: .It \e(oq
                    107: .Pq left single-quote
                    108: .It \e(aq
                    109: .Pq right single-quote
                    110: .It \e(Bq
                    111: .Pq right low double-quote
                    112: .It \e(bq
                    113: .Pq right low single-quote
                    114: .El
                    115: .\" PARAGRAPH
                    116: .Pp
                    117: Indicatives:
                    118: .Bl -tag -width 12n -offset "XXXX" -compact
                    119: .It \e(<-
                    120: .Pq left arrow
                    121: .It \e(->
                    122: .Pq right arrow
                    123: .It \e(ua
                    124: .Pq up arrow
                    125: .It \e(da
                    126: .Pq down arrow
                    127: .It \e(<>
                    128: .Pq left-right arrow
                    129: .It \e(lA
                    130: .Pq left double-arrow
                    131: .It \e(rA
                    132: .Pq right double-arrow
                    133: .It \e(uA
                    134: .Pq up double-arrow
                    135: .It \e(dA
                    136: .Pq down double-arrow
                    137: .It \e(hA
                    138: .Pq left-right double-arrow
                    139: .El
                    140: .\" PARAGRAPH
                    141: .Pp
                    142: Mathematical:
                    143: .Bl -tag -width 12n -offset "XXXX" -compact
                    144: .It \e(es
                    145: .Pq empty set
                    146: .It \e(ca
                    147: .Pq intersection
                    148: .It \e(cu
                    149: .Pq union
                    150: .It \e(gr
                    151: .Pq gradient
                    152: .It \e(pd
                    153: .Pq partial differential
                    154: .It \e(ap
                    155: .Pq similarity
                    156: .It \e(=)
                    157: .Pq proper superset
                    158: .It \e((=
                    159: .Pq proper subset
                    160: .It \e(eq
                    161: .Pq equals
                    162: .It \e(di
                    163: .Pq division
                    164: .It \e(mu
                    165: .Pq multiplication
                    166: .It \e(pl
                    167: .Pq addition
                    168: .It \e(nm
                    169: .Pq not element
                    170: .It \e(mo
                    171: .Pq element
                    172: .It \e(Im
                    173: .Pq imaginary
                    174: .It \e(Re
                    175: .Pq real
                    176: .It \e(Ah
                    177: .Pq aleph
                    178: .It \e(te
                    179: .Pq existential quantifier
                    180: .It \e(fa
                    181: .Pq universal quantifier
                    182: .It \e(AN
                    183: .Pq logical AND
                    184: .It \e(OR
                    185: .Pq logical OR
                    186: .It \e(no
                    187: .Pq logical NOT
                    188: .It \e(st
                    189: .Pq such that
                    190: .It \e(tf
                    191: .Pq therefore
                    192: .It \e(~~
                    193: .Pq approximate
                    194: .It \e(~=
                    195: .Pq approximately equals
                    196: .It \e(=~
                    197: .Pq congruent
                    198: .It \e(Gt
                    199: .Pq greater-than, deprecated
                    200: .It \e(Lt
                    201: .Pq less-than, deprecated
                    202: .It \e(<=
                    203: .Pq less-than-equal
                    204: .It \e(Le
                    205: .Pq less-than-equal, deprecated
                    206: .It \e(>=
                    207: .Pq greater-than-equal
                    208: .It \e(Ge
                    209: .Pq greater-than-equal
                    210: .It \e(==
                    211: .Pq equal
                    212: .It \e(!=
                    213: .Pq not equal
                    214: .It \e(Ne
                    215: .Pq not equal, deprecated
                    216: .It \e(if
                    217: .Pq infinity
                    218: .It \e(If
                    219: .Pq infinity, deprecated
                    220: .It \e(na
                    221: .Pq NaN , an extension
                    222: .It \e(Na
                    223: .Pq NaN, deprecated
                    224: .It \e(+-
                    225: .Pq plus-minus
                    226: .It \e(Pm
                    227: .Pq plus-minus, deprecated
                    228: .It \e(**
                    229: .Pq asterisk
                    230: .El
                    231: .\" PARAGRAPH
                    232: .Pp
                    233: Ligatures:
                    234: .Bl -tag -width 12n -offset "XXXX" -compact
                    235: .It \e(ss
                    236: .Pq German eszett
                    237: .It \e(AE
                    238: .Pq upper-case AE
                    239: .It \e(ae
                    240: .Pq lower-case AE
                    241: .It \e(OE
                    242: .Pq upper-case OE
                    243: .It \e(oe
                    244: .Pq lower-case OE
                    245: .It \e(ff
                    246: .Pq ff ligature
                    247: .It \e(fi
                    248: .Pq fi ligature
                    249: .It \e(fl
                    250: .Pq fl ligature
                    251: .It \e(Fi
                    252: .Pq ffi ligature
                    253: .It \e(Fl
                    254: .Pq ffl ligature
                    255: .El
                    256: .\" PARAGRAPH
                    257: .Pp
                    258: Diacritics and letters:
                    259: .Bl -tag -width 12n -offset "XXXX" -compact
                    260: .It \e(ga
                    261: .Pq grave accent
                    262: .It \e(aa
                    263: .Pq accute accent
                    264: .It \e(a"
                    265: .Pq umlaut accent
                    266: .It \e(ad
                    267: .Pq dieresis accent
                    268: .It \e(a~
                    269: .Pq tilde accent
                    270: .It \e(a^
                    271: .Pq circumflex accent
                    272: .It \e(ac
                    273: .Pq cedilla accent
                    274: .It \e(ad
                    275: .Pq dieresis accent
                    276: .It \e(ah
                    277: .Pq caron accent
                    278: .It \e(ao
                    279: .Pq ring accent
                    280: .It \e(ho
                    281: .Pq hook accent
                    282: .It \e(ab
                    283: .Pq breve accent
                    284: .It \e(a-
                    285: .Pq macron accent
                    286: .It \e(-D
                    287: .Pq upper-case eth
                    288: .It \e(Sd
                    289: .Pq lower-case eth
                    290: .It \e(TP
                    291: .Pq upper-case thorn
                    292: .It \e(Tp
                    293: .Pq lower-case thorn
                    294: .It \e('A
                    295: .Pq upper-case acute A
                    296: .It \e('E
                    297: .Pq upper-case acute E
                    298: .It \e('I
                    299: .Pq upper-case acute I
                    300: .It \e('O
                    301: .Pq upper-case acute O
                    302: .It \e('U
                    303: .Pq upper-case acute U
                    304: .It \e('a
                    305: .Pq lower-case acute a
                    306: .It \e('e
                    307: .Pq lower-case acute e
                    308: .It \e('i
                    309: .Pq lower-case acute i
                    310: .It \e('o
                    311: .Pq lower-case acute o
                    312: .It \e('u
                    313: .Pq lower-case acute u
                    314: .It \e(`A
                    315: .Pq upper-case grave A
                    316: .It \e(`E
                    317: .Pq upper-case grave E
                    318: .It \e(`I
                    319: .Pq upper-case grave I
                    320: .It \e(`O
                    321: .Pq upper-case grave O
                    322: .It \e(`U
                    323: .Pq upper-case grave U
                    324: .It \e(`a
                    325: .Pq lower-case grave a
                    326: .It \e(`e
                    327: .Pq lower-case grave e
                    328: .It \e(`i
                    329: .Pq lower-case grave i
                    330: .It \e(`o
                    331: .Pq lower-case grave o
                    332: .It \e(`u
                    333: .Pq lower-case grave u
                    334: .It \e(~A
                    335: .Pq upper-case tilde A
                    336: .It \e(~N
                    337: .Pq upper-case tilde N
                    338: .It \e(~O
                    339: .Pq upper-case tilde O
                    340: .It \e(~a
                    341: .Pq lower-case tilde a
                    342: .It \e(~n
                    343: .Pq lower-case tilde n
                    344: .It \e(~o
                    345: .Pq lower-case tilde o
                    346: .It \e(:A
                    347: .Pq upper-case dieresis A
                    348: .It \e(:E
                    349: .Pq upper-case dieresis E
                    350: .It \e(:I
                    351: .Pq upper-case dieresis I
                    352: .It \e(:O
                    353: .Pq upper-case dieresis O
                    354: .It \e(:U
                    355: .Pq upper-case dieresis U
                    356: .It \e(:a
                    357: .Pq lower-case dieresis a
                    358: .It \e(:e
                    359: .Pq lower-case dieresis e
                    360: .It \e(:i
                    361: .Pq lower-case dieresis i
                    362: .It \e(:o
                    363: .Pq lower-case dieresis o
                    364: .It \e(:u
                    365: .Pq lower-case dieresis u
                    366: .It \e(:y
                    367: .Pq lower-case dieresis y
                    368: .It \e(^A
                    369: .Pq upper-case circumflex A
                    370: .It \e(^E
                    371: .Pq upper-case circumflex E
                    372: .It \e(^I
                    373: .Pq upper-case circumflex I
                    374: .It \e(^O
                    375: .Pq upper-case circumflex O
                    376: .It \e(^U
                    377: .Pq upper-case circumflex U
                    378: .It \e(^a
                    379: .Pq lower-case circumflex a
                    380: .It \e(^e
                    381: .Pq lower-case circumflex e
                    382: .It \e(^i
                    383: .Pq lower-case circumflex i
                    384: .It \e(^o
                    385: .Pq lower-case circumflex o
                    386: .It \e(^u
                    387: .Pq lower-case circumflex u
                    388: .It \e(,C
                    389: .Pq upper-case cedilla C
                    390: .It \e(,c
                    391: .Pq lower-case cedilla c
                    392: .It \e(/L
                    393: .Pq upper-case stroke L
                    394: .It \e(/l
                    395: .Pq lower-case stroke l
                    396: .It \e(/O
                    397: .Pq upper-case stroke O
                    398: .It \e(/o
                    399: .Pq lower-case stroke o
                    400: .It \e(oA
                    401: .Pq upper-case ring A
                    402: .It \e(oa
                    403: .Pq lower-case ring a
                    404: .El
                    405: .\" PARAGRAPH
                    406: .Pp
                    407: Monetary:
                    408: .Bl -tag -width 12n -offset "XXXX" -compact
                    409: .It \e(Cs
                    410: .Pq Scandinavian
                    411: .It \e(Do
                    412: .Pq dollar
                    413: .It \e(Po
                    414: .Pq pound
                    415: .It \e(Ye
                    416: .Pq yen
                    417: .It \e(Fn
                    418: .Pq florin
                    419: .It \e(ct
                    420: .Pq cent
                    421: .El
                    422: .\" PARAGRAPH
                    423: .Pp
                    424: Special symbols:
                    425: .Bl -tag -width 12n -offset "XXXX" -compact
                    426: .It \e0
                    427: .Pq white-space
                    428: .It \e(de
                    429: .Pq degree
                    430: .It \e(ps
                    431: .Pq paragraph
                    432: .It \e(sc
                    433: .Pq section
                    434: .It \e(dg
                    435: .Pq dagger
                    436: .It \e(dd
                    437: .Pq double dagger
                    438: .It \e(ci
                    439: .Pq circle
                    440: .It \e(ba
                    441: .Pq bar
                    442: .It \e(bb
                    443: .Pq broken bar
                    444: .It \e(Ba
                    445: .Pq bar, deprecated
                    446: .It \e(co
                    447: .Pq copyright
                    448: .It \e(rg
                    449: .Pq registered
                    450: .It \e(tm
                    451: .Pq trademarked
                    452: .It \e&
                    453: .Pq non-breaking space
                    454: .It \ee
                    455: .Pq escape
                    456: .It \e(Am
                    457: .Pq ampersand, deprecated
                    458: .El
                    459: .\" SECTION
1.3       kristaps  460: .Sh COMPATIBILITY
                    461: This section documents compatibility of
                    462: .Nm
                    463: with older or existing versions of
                    464: .Xr groff 1 :
                    465: .Pp
                    466: .Bl -tag -width 12n -offset "XXXX" -compact
                    467: .It \e(ss
                    468: Renders differently in
                    469: .Fl T Ns Ar ascii
                    470: mode.
                    471: .El
                    472: .\" SECTION
1.1       kristaps  473: .Sh SEE ALSO
                    474: .Xr mandoc 1
                    475: .\" SECTION
                    476: .Sh AUTHORS
                    477: The
                    478: .Nm
                    479: utility was written by
1.6     ! kristaps  480: .An Kristaps Dzonsons Aq kristaps@kth.se .

CVSweb