Runtime files update
[MacVim.git] / runtime / doc / digraph.txt
blob2b65e1be10c55940b7443e45a778a4e06d2bfc41
1 *digraph.txt*   For Vim version 7.1.  Last change: 2007 Sep 10
4                   VIM REFERENCE MANUAL    by Bram Moolenaar
7 Digraphs                                                *digraphs* *Digraphs*
9 Digraphs are used to enter characters that normally cannot be entered by
10 an ordinary keyboard.  These are mostly accented characters which have the
11 eighth bit set.  The digraphs are easier to remember than the decimal number
12 that can be entered with CTRL-V (see |i_CTRL-V|).
14 There is a brief introduction on digraphs in the user manual: |24.9|
15 An alternative is using the 'keymap' option.
17 1. Defining digraphs    |digraphs-define|
18 2. Using digraphs       |digraphs-use|
19 3. Default digraphs     |digraphs-default|
21 {Vi does not have any of these commands}
23 ==============================================================================
24 1. Defining digraphs                                    *digraphs-define*
26                                                 *:dig* *:digraphs*
27 :dig[raphs]             show currently defined digraphs.
28                                                         *E104* *E39*
29 :dig[raphs] {char1}{char2} {number} ...
30                         Add digraph {char1}{char2} to the list.  {number} is
31                         the decimal representation of the character.  Normally
32                         it is the Unicode character, see |digraph-encoding|.
33                         Example: >
34         :digr e: 235 a: 228
35 <                       Avoid defining a digraph with '_' (underscore) as the
36                         first character, it has a special meaning in the
37                         future.
39 Vim is normally compiled with the |+digraphs| feature.  If the feature is
40 disabled, the ":digraph" command will display an error message.
42 Example of the output of ":digraphs": >
43  TH Þ  222  ss ß  223  a! à  224  a' á  225  a> â  226  a? ã  227  a: ä  228
45 The first two characters in each column are the characters you have to type to
46 enter the digraph.
48 In the middle of each column is the resulting character.  This may be mangled
49 if you look at it on a system that does not support digraphs or if you print
50 this file.
52                                                         *digraph-encoding*
53 The decimal number normally is the Unicode number of the character.  Note that
54 the meaning doesn't change when 'encoding' changes.  The character will be
55 converted from Unicode to 'encoding' when needed.  This does require the
56 conversion to be available, it might fail.
58 When Vim was compiled without the +multi_byte feature, you need to specify the
59 character in the encoding given with 'encoding'.  You might want to use
60 something like this: >
62         if has("multi_byte")
63                 digraph oe 339
64         elseif &encoding == "iso-8859-15"
65                 digraph oe 189
66         endif
68 This defines the "oe" digraph for a character that is number 339 in Unicode
69 and 189 in latin9 (iso-8859-15).
71 ==============================================================================
72 2. Using digraphs                                       *digraphs-use*
74 There are two methods to enter digraphs:                        *i_digraph*
75         CTRL-K {char1} {char2}          or
76         {char1} <BS> {char2}
77 The first is always available; the second only when the 'digraph' option is
78 set.
80 If a digraph with {char1}{char2} does not exist, Vim searches for a digraph
81 {char2}{char1}.  This helps when you don't remember which character comes
82 first.
84 Note that when you enter CTRL-K {char1}, where {char1} is a special key, Vim
85 enters the code for that special key.  This is not a digraph.
87 Once you have entered the digraph, Vim treats the character like a normal
88 character that occupies only one character in the file and on the screen.
89 Example: >
90         'B' <BS> 'B'    will enter the broken '|' character (166)
91         'a' <BS> '>'    will enter an 'a' with a circumflex (226)
92         CTRL-K '-' '-'  will enter a soft hyphen (173)
94 The current digraphs are listed with the ":digraphs" command.  Some of the
95 default ones are listed below |digraph-table|.
97 For CTRL-K, there is one general digraph: CTRL-K <Space> {char} will enter
98 {char} with the highest bit set.  You can use this to enter meta-characters.
100 The <Esc> character cannot be part of a digraph.  When hitting <Esc>, Vim
101 stops digraph entry and ends Insert mode or Command-line mode, just like
102 hitting an <Esc> out of digraph context.  Use CTRL-V 155 to enter meta-ESC
103 (CSI).
105 If you accidentally typed an 'a' that should be an 'e', you will type 'a' <BS>
106 'e'.  But that is a digraph, so you will not get what you want.  To correct
107 this, you will have to type <BS> e again.  To avoid this don't set the
108 'digraph' option and use CTRL-K to enter digraphs.
110 You may have problems using Vim with characters which have a value above 128.
111 For example: You insert ue (u-umlaut) and the editor echoes \334 in Insert
112 mode.  After leaving the Insert mode everything is fine.  Note that fmt
113 removes all characters with a value above 128 from the text being formatted.
114 On some Unix systems this means you have to define the environment-variable
115 LC_CTYPE.  If you are using csh, then put the following line in your .cshrc: >
116         setenv LC_CTYPE iso_8859_1
118 ==============================================================================
119 3. Default digraphs                                     *digraphs-default*
121 Vim comes with a set of default digraphs.  Check the output of ":digraphs" to
122 see them.
124 On most systems Vim uses the same digraphs.  They work for the Unicode and
125 ISO-8859-1 character sets.  These default digraphs are taken from the RFC1345
126 mnemonics.  To make it easy to remember the mnemonic, the second character has
127 a standard meaning:
129         char name               char    meaning ~
130         Exclamation mark        !       Grave
131         Apostrophe              '       Acute accent
132         Greater-Than sign       >       Circumflex accent
133         Question mark           ?       Tilde
134         Hyphen-Minus            -       Macron
135         Left parenthesis        (       Breve
136         Full stop               .       Dot above
137         Colon                   :       Diaeresis
138         Comma                   ,       Cedilla
139         Underline               _       Underline
140         Solidus                 /       Stroke
141         Quotation mark          "       Double acute accent
142         Semicolon               ;       Ogonek
143         Less-Than sign          <       Caron
144         Zero                    0       Ring above
145         Two                     2       Hook
146         Nine                    9       Horn
148         Equals                  =       Cyrillic
149         Asterisk                *       Greek
150         Percent sign            %       Greek/Cyrillic special
151         Plus                    +       smalls: Arabic, capitals: Hebrew
152         Three                   3       some Latin/Greek/Cyrillic letters
153         Four                    4       Bopomofo
154         Five                    5       Hiragana
155         Six                     6       Katakana
157 Example: a: is ä  and o: is ö
159 These are the RFC1345 digraphs for the one-byte characters.  See the output of
160 ":digraphs" for the others.  The characters above 255 are only available when
161 Vim was compiled with the |+multi_byte| feature.
163 EURO
165 Exception: RFC1345 doesn't specify the euro sign.  In Vim the digraph =e was
166 added for this.  Note the difference between latin1, where the digraph Cu is
167 used for the currency sign, and latin9 (iso-8859-15), where the digraph =e is
168 used for the euro sign, while both of them are the character 164, 0xa4.  For
169 compatibility with zsh Eu can also be used for the euro sign.
171                                                         *digraph-table*
172 char  digraph   hex     dec     official name ~
173 ^@      NU      0x00      0     NULL (NUL)
174 ^A      SH      0x01      1     START OF HEADING (SOH)
175 ^B      SX      0x02      2     START OF TEXT (STX)
176 ^C      EX      0x03      3     END OF TEXT (ETX)
177 ^D      ET      0x04      4     END OF TRANSMISSION (EOT)
178 ^E      EQ      0x05      5     ENQUIRY (ENQ)
179 ^F      AK      0x06      6     ACKNOWLEDGE (ACK)
180 ^G      BL      0x07      7     BELL (BEL)
181 ^H      BS      0x08      8     BACKSPACE (BS)
182 ^I      HT      0x09      9     CHARACTER TABULATION (HT)
183 ^@      LF      0x0a     10     LINE FEED (LF)
184 ^K      VT      0x0b     11     LINE TABULATION (VT)
185 ^L      FF      0x0c     12     FORM FEED (FF)
186 ^M      CR      0x0d     13     CARRIAGE RETURN (CR)
187 ^N      SO      0x0e     14     SHIFT OUT (SO)
188 ^O      SI      0x0f     15     SHIFT IN (SI)
189 ^P      DL      0x10     16     DATALINK ESCAPE (DLE)
190 ^Q      D1      0x11     17     DEVICE CONTROL ONE (DC1)
191 ^R      D2      0x12     18     DEVICE CONTROL TWO (DC2)
192 ^S      D3      0x13     19     DEVICE CONTROL THREE (DC3)
193 ^T      D4      0x14     20     DEVICE CONTROL FOUR (DC4)
194 ^U      NK      0x15     21     NEGATIVE ACKNOWLEDGE (NAK)
195 ^V      SY      0x16     22     SYNCHRONOUS IDLE (SYN)
196 ^W      EB      0x17     23     END OF TRANSMISSION BLOCK (ETB)
197 ^X      CN      0x18     24     CANCEL (CAN)
198 ^Y      EM      0x19     25     END OF MEDIUM (EM)
199 ^Z      SB      0x1a     26     SUBSTITUTE (SUB)
200 ^[      EC      0x1b     27     ESCAPE (ESC)
201 ^\      FS      0x1c     28     FILE SEPARATOR (IS4)
202 ^]      GS      0x1d     29     GROUP SEPARATOR (IS3)
203 ^^      RS      0x1e     30     RECORD SEPARATOR (IS2)
204 ^_      US      0x1f     31     UNIT SEPARATOR (IS1)
205         SP      0x20     32     SPACE
206 #       Nb      0x23     35     NUMBER SIGN
207 $       DO      0x24     36     DOLLAR SIGN
208 @       At      0x40     64     COMMERCIAL AT
209 [       <(      0x5b     91     LEFT SQUARE BRACKET
210 \       //      0x5c     92     REVERSE SOLIDUS
211 ]       )>      0x5d     93     RIGHT SQUARE BRACKET
212 ^       '>      0x5e     94     CIRCUMFLEX ACCENT
213 `       '!      0x60     96     GRAVE ACCENT
214 {       (!      0x7b    123     LEFT CURLY BRACKET
215 |       !!      0x7c    124     VERTICAL LINE
216 }       !)      0x7d    125     RIGHT CURLY BRACKET
217 ~       '?      0x7e    126     TILDE
218 ^?      DT      0x7f    127     DELETE (DEL)
219 ~@      PA      0x80    128     PADDING CHARACTER (PAD)
220 ~A      HO      0x81    129     HIGH OCTET PRESET (HOP)
221 ~B      BH      0x82    130     BREAK PERMITTED HERE (BPH)
222 ~C      NH      0x83    131     NO BREAK HERE (NBH)
223 ~D      IN      0x84    132     INDEX (IND)
224 ~E      NL      0x85    133     NEXT LINE (NEL)
225 ~F      SA      0x86    134     START OF SELECTED AREA (SSA)
226 ~G      ES      0x87    135     END OF SELECTED AREA (ESA)
227 ~H      HS      0x88    136     CHARACTER TABULATION SET (HTS)
228 ~I      HJ      0x89    137     CHARACTER TABULATION WITH JUSTIFICATION (HTJ)
229 ~J      VS      0x8a    138     LINE TABULATION SET (VTS)
230 ~K      PD      0x8b    139     PARTIAL LINE FORWARD (PLD)
231 ~L      PU      0x8c    140     PARTIAL LINE BACKWARD (PLU)
232 ~M      RI      0x8d    141     REVERSE LINE FEED (RI)
233 ~N      S2      0x8e    142     SINGLE-SHIFT TWO (SS2)
234 ~O      S3      0x8f    143     SINGLE-SHIFT THREE (SS3)
235 ~P      DC      0x90    144     DEVICE CONTROL STRING (DCS)
236 ~Q      P1      0x91    145     PRIVATE USE ONE (PU1)
237 ~R      P2      0x92    146     PRIVATE USE TWO (PU2)
238 ~S      TS      0x93    147     SET TRANSMIT STATE (STS)
239 ~T      CC      0x94    148     CANCEL CHARACTER (CCH)
240 ~U      MW      0x95    149     MESSAGE WAITING (MW)
241 ~V      SG      0x96    150     START OF GUARDED AREA (SPA)
242 ~W      EG      0x97    151     END OF GUARDED AREA (EPA)
243 ~X      SS      0x98    152     START OF STRING (SOS)
244 ~Y      GC      0x99    153     SINGLE GRAPHIC CHARACTER INTRODUCER (SGCI)
245 ~Z      SC      0x9a    154     SINGLE CHARACTER INTRODUCER (SCI)
246 ~[      CI      0x9b    155     CONTROL SEQUENCE INTRODUCER (CSI)
247 ~\      ST      0x9c    156     STRING TERMINATOR (ST)
248 ~]      OC      0x9d    157     OPERATING SYSTEM COMMAND (OSC)
249 ~^      PM      0x9e    158     PRIVACY MESSAGE (PM)
250 ~_      AC      0x9f    159     APPLICATION PROGRAM COMMAND (APC)
251 |       NS      0xa0    160     NO-BREAK SPACE
252 ¡       !I      0xa1    161     INVERTED EXCLAMATION MARK
253 ¢       Ct      0xa2    162     CENT SIGN
254 £       Pd      0xa3    163     POUND SIGN
255 ¤       Cu      0xa4    164     CURRENCY SIGN
256 ¥       Ye      0xa5    165     YEN SIGN
257 ¦       BB      0xa6    166     BROKEN BAR
258 §       SE      0xa7    167     SECTION SIGN
259 ¨       ':      0xa8    168     DIAERESIS
260 ©       Co      0xa9    169     COPYRIGHT SIGN
261 ª       -a      0xaa    170     FEMININE ORDINAL INDICATOR
262 «       <<      0xab    171     LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
263 ¬       NO      0xac    172     NOT SIGN
264 ­       --      0xad    173     SOFT HYPHEN
265 ®       Rg      0xae    174     REGISTERED SIGN
266 ¯       'm      0xaf    175     MACRON
267 °       DG      0xb0    176     DEGREE SIGN
268 ±       +-      0xb1    177     PLUS-MINUS SIGN
269 ²       2S      0xb2    178     SUPERSCRIPT TWO
270 ³       3S      0xb3    179     SUPERSCRIPT THREE
271 ´       ''      0xb4    180     ACUTE ACCENT
272 µ       My      0xb5    181     MICRO SIGN
273 ¶       PI      0xb6    182     PILCROW SIGN
274 ·       .M      0xb7    183     MIDDLE DOT
275 ¸       ',      0xb8    184     CEDILLA
276 ¹       1S      0xb9    185     SUPERSCRIPT ONE
277 º       -o      0xba    186     MASCULINE ORDINAL INDICATOR
278 »       >>      0xbb    187     RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
279 ¼       14      0xbc    188     VULGAR FRACTION ONE QUARTER
280 ½       12      0xbd    189     VULGAR FRACTION ONE HALF
281 ¾       34      0xbe    190     VULGAR FRACTION THREE QUARTERS
282 ¿       ?I      0xbf    191     INVERTED QUESTION MARK
283 À       A!      0xc0    192     LATIN CAPITAL LETTER A WITH GRAVE
284 Á       A'      0xc1    193     LATIN CAPITAL LETTER A WITH ACUTE
285        A>      0xc2    194     LATIN CAPITAL LETTER A WITH CIRCUMFLEX
286 à      A?      0xc3    195     LATIN CAPITAL LETTER A WITH TILDE
287 Ä       A:      0xc4    196     LATIN CAPITAL LETTER A WITH DIAERESIS
288 Å       AA      0xc5    197     LATIN CAPITAL LETTER A WITH RING ABOVE
289 Æ       AE      0xc6    198     LATIN CAPITAL LETTER AE
290 Ç       C,      0xc7    199     LATIN CAPITAL LETTER C WITH CEDILLA
291 È       E!      0xc8    200     LATIN CAPITAL LETTER E WITH GRAVE
292 É       E'      0xc9    201     LATIN CAPITAL LETTER E WITH ACUTE
293 Ê       E>      0xca    202     LATIN CAPITAL LETTER E WITH CIRCUMFLEX
294 Ë       E:      0xcb    203     LATIN CAPITAL LETTER E WITH DIAERESIS
295 Ì       I!      0xcc    204     LATIN CAPITAL LETTER I WITH GRAVE
296 Í       I'      0xcd    205     LATIN CAPITAL LETTER I WITH ACUTE
297 Π      I>      0xce    206     LATIN CAPITAL LETTER I WITH CIRCUMFLEX
298 Ï       I:      0xcf    207     LATIN CAPITAL LETTER I WITH DIAERESIS
299 Р      D-      0xd0    208     LATIN CAPITAL LETTER ETH (Icelandic)
300 Ñ       N?      0xd1    209     LATIN CAPITAL LETTER N WITH TILDE
301 Ò       O!      0xd2    210     LATIN CAPITAL LETTER O WITH GRAVE
302 Ó       O'      0xd3    211     LATIN CAPITAL LETTER O WITH ACUTE
303 Ô       O>      0xd4    212     LATIN CAPITAL LETTER O WITH CIRCUMFLEX
304 Õ       O?      0xd5    213     LATIN CAPITAL LETTER O WITH TILDE
305 Ö       O:      0xd6    214     LATIN CAPITAL LETTER O WITH DIAERESIS
306 ×       *X      0xd7    215     MULTIPLICATION SIGN
307 Ø       O/      0xd8    216     LATIN CAPITAL LETTER O WITH STROKE
308 Ù       U!      0xd9    217     LATIN CAPITAL LETTER U WITH GRAVE
309 Ú       U'      0xda    218     LATIN CAPITAL LETTER U WITH ACUTE
310 Û       U>      0xdb    219     LATIN CAPITAL LETTER U WITH CIRCUMFLEX
311 Ü       U:      0xdc    220     LATIN CAPITAL LETTER U WITH DIAERESIS
312 Ý       Y'      0xdd    221     LATIN CAPITAL LETTER Y WITH ACUTE
313 Þ       TH      0xde    222     LATIN CAPITAL LETTER THORN (Icelandic)
314 ß       ss      0xdf    223     LATIN SMALL LETTER SHARP S (German)
315 à       a!      0xe0    224     LATIN SMALL LETTER A WITH GRAVE
316 á       a'      0xe1    225     LATIN SMALL LETTER A WITH ACUTE
317 â       a>      0xe2    226     LATIN SMALL LETTER A WITH CIRCUMFLEX
318 ã       a?      0xe3    227     LATIN SMALL LETTER A WITH TILDE
319 ä       a:      0xe4    228     LATIN SMALL LETTER A WITH DIAERESIS
320 å       aa      0xe5    229     LATIN SMALL LETTER A WITH RING ABOVE
321 æ       ae      0xe6    230     LATIN SMALL LETTER AE
322 ç       c,      0xe7    231     LATIN SMALL LETTER C WITH CEDILLA
323 è       e!      0xe8    232     LATIN SMALL LETTER E WITH GRAVE
324 é       e'      0xe9    233     LATIN SMALL LETTER E WITH ACUTE
325 ê       e>      0xea    234     LATIN SMALL LETTER E WITH CIRCUMFLEX
326 ë       e:      0xeb    235     LATIN SMALL LETTER E WITH DIAERESIS
327 ì       i!      0xec    236     LATIN SMALL LETTER I WITH GRAVE
328 í       i'      0xed    237     LATIN SMALL LETTER I WITH ACUTE
329 î       i>      0xee    238     LATIN SMALL LETTER I WITH CIRCUMFLEX
330 ï       i:      0xef    239     LATIN SMALL LETTER I WITH DIAERESIS
331 ð       d-      0xf0    240     LATIN SMALL LETTER ETH (Icelandic)
332 ñ       n?      0xf1    241     LATIN SMALL LETTER N WITH TILDE
333 ò       o!      0xf2    242     LATIN SMALL LETTER O WITH GRAVE
334 ó       o'      0xf3    243     LATIN SMALL LETTER O WITH ACUTE
335 ô       o>      0xf4    244     LATIN SMALL LETTER O WITH CIRCUMFLEX
336 õ       o?      0xf5    245     LATIN SMALL LETTER O WITH TILDE
337 ö       o:      0xf6    246     LATIN SMALL LETTER O WITH DIAERESIS
338 ÷       -:      0xf7    247     DIVISION SIGN
339 ø       o/      0xf8    248     LATIN SMALL LETTER O WITH STROKE
340 ù       u!      0xf9    249     LATIN SMALL LETTER U WITH GRAVE
341 ú       u'      0xfa    250     LATIN SMALL LETTER U WITH ACUTE
342 û       u>      0xfb    251     LATIN SMALL LETTER U WITH CIRCUMFLEX
343 ü       u:      0xfc    252     LATIN SMALL LETTER U WITH DIAERESIS
344 ý       y'      0xfd    253     LATIN SMALL LETTER Y WITH ACUTE
345 þ       th      0xfe    254     LATIN SMALL LETTER THORN (Icelandic)
346 ÿ       y:      0xff    255     LATIN SMALL LETTER Y WITH DIAERESIS
348  vim:tw=78:ts=8:ft=help:norl: