39
|
1 *mbyte.txt* For Vim version 7.0aa. Last change: 2004 Dec 19
|
7
|
2
|
|
3
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar et al.
|
|
5
|
|
6
|
|
7 Multi-byte support *multibyte* *multi-byte*
|
|
8 *Chinese* *Japanese* *Korean*
|
|
9 This is about editing text in languages which have many characters that can
|
|
10 not be represented using one byte (one octet). Examples are Chinese, Japanese
|
|
11 and Korean. Unicode is also covered here.
|
|
12
|
|
13 For an introduction to the most common features, see |usr_45.txt| in the user
|
|
14 manual.
|
|
15 For changing the language of messages and menus see |mlang.txt|.
|
|
16
|
|
17 {not available when compiled without the +multi_byte feature}
|
|
18
|
|
19
|
|
20 1. Getting started |mbyte-first|
|
|
21 2. Locale |mbyte-locale|
|
|
22 3. Encoding |mbyte-encoding|
|
|
23 4. Using a terminal |mbyte-terminal|
|
|
24 5. Fonts on X11 |mbyte-fonts-X11|
|
|
25 6. Fonts on MS-Windows |mbyte-fonts-MSwin|
|
|
26 7. Input on X11 |mbyte-XIM|
|
|
27 8. Input on MS-Windows |mbyte-IME|
|
|
28 9. Input with a keymap |mbyte-keymap|
|
|
29 10. Using UTF-8 |mbyte-utf8|
|
|
30 11. Overview of options |mbyte-options|
|
|
31
|
|
32 NOTE: This file contains UTF-8 characters. These may show up as strange
|
|
33 characters or boxes when using another encoding.
|
|
34
|
|
35 ==============================================================================
|
|
36 1. Getting started *mbyte-first*
|
|
37
|
|
38 This is a summary of the multibyte features in Vim. If you are lucky it works
|
|
39 as described and you can start using Vim without much trouble. If something
|
|
40 doesn't work you will have to read the rest. Don't be surprised if it takes
|
|
41 quite a bit of work and experimenting to make Vim use all the multi-byte
|
|
42 features. Unfortunately, every system has its own way to deal with multibyte
|
|
43 languages and it is quite complicated.
|
|
44
|
|
45
|
|
46 COMPILING
|
|
47
|
|
48 If you already have a compiled Vim program, check if the |+multi_byte| feature
|
|
49 is included. The |:version| command can be used for this.
|
|
50
|
|
51 If +multi_byte is not included, you should compile Vim with "big" features.
|
|
52 You can further tune what features are included. See the INSTALL files in the
|
|
53 source directory.
|
|
54
|
|
55
|
|
56 LOCALE
|
|
57
|
|
58 First of all, you must make sure your current locale is set correctly. If
|
|
59 your system has been installed to use the language, it probably works right
|
|
60 away. If not, you can often make it work by setting the $LANG environment
|
|
61 variable in your shell: >
|
|
62
|
|
63 setenv LANG ja_JP.EUC
|
|
64
|
|
65 Unfortunately, the name of the locale depends on your system. Japanese might
|
|
66 also be called "ja_JP.EUCjp" or just "ja". To see what is currently used: >
|
|
67
|
|
68 :language
|
|
69
|
|
70 To change the locale inside Vim use: >
|
|
71
|
|
72 :language ja_JP.EUC
|
|
73
|
|
74 Vim will give an error message if this doesn't work. This is a good way to
|
|
75 experiment and find the locale name you want to use. But it's always better
|
|
76 to set the locale in the shell, so that it is used right from the start.
|
|
77
|
|
78 See |mbyte-locale| for details.
|
|
79
|
|
80
|
|
81 ENCODING
|
|
82
|
|
83 If your locale works properly, Vim will try to set the 'encoding' option
|
|
84 accordingly. If this doesn't work you can overrule its value: >
|
|
85
|
|
86 :set encoding=utf-8
|
|
87
|
|
88 See |encoding-values| for a list of acceptable values.
|
|
89
|
|
90 The result is that all the text that is used inside Vim will be in this
|
|
91 encoding. Not only the text in the buffers, but also in registers, variables,
|
|
92 etc. This also means that changing the value of 'encoding' makes the existing
|
|
93 text invalid! The text doesn't change, but it will be displayed wrong.
|
|
94
|
|
95 You can edit files in another encoding than what 'encoding' is set to. Vim
|
|
96 will convert the file when you read it and convert it back when you write it.
|
|
97 See 'fileencoding', 'fileencodings' and |++enc|.
|
|
98
|
|
99
|
|
100 DISPLAY AND FONTS
|
|
101
|
|
102 If you are working in a terminal (emulator) you must make sure it accepts the
|
|
103 same encoding as which Vim is working with. If this is not the case, you can
|
|
104 use the 'termencoding' option to make Vim convert text automatically.
|
|
105
|
|
106 For the GUI you must select fonts that work with the current 'encoding'. This
|
|
107 is the difficult part. It depends on the system you are using, the locale and
|
|
108 a few other things. See the chapters on fonts: |mbyte-fonts-X11| for
|
|
109 X-Windows and |mbyte-fonts-MSwin| for MS-Windows.
|
|
110
|
|
111 For GTK+ 2, you can skip most of this section. The option 'guifontset' does
|
|
112 no longer exist. You only need to set 'guifont' and everything should "just
|
|
113 work". If your system comes with Xft2 and fontconfig and the current font
|
|
114 does not contain a certain glyph, a different font will be used automatically
|
|
115 if available. The 'guifontwide' option is still supported but usually you do
|
|
116 not need to set it. It is only necessary if the automatic font selection does
|
|
117 not suit your needs.
|
|
118
|
|
119 For X11 you can set the 'guifontset' option to a list of fonts that together
|
|
120 cover the characters that are used. Example for Korean: >
|
|
121
|
|
122 :set guifontset=k12,r12
|
|
123
|
|
124 Alternatively, you can set 'guifont' and 'guifontwide'. 'guifont' is used for
|
|
125 the single-width characters, 'guifontwide' for the double-width characters.
|
|
126 Thus the 'guifontwide' font must be exactly twice as wide as 'guifont'.
|
|
127 Example for UTF-8: >
|
|
128
|
|
129 :set guifont=-misc-fixed-medium-r-normal-*-18-120-100-100-c-90-iso10646-1
|
|
130 :set guifontwide=-misc-fixed-medium-r-normal-*-18-120-100-100-c-180-iso10646-1
|
|
131
|
|
132 You can also set 'guifont' alone, Vim will try to find a matching
|
|
133 'guifontwide' for you.
|
|
134
|
|
135
|
|
136 INPUT
|
|
137
|
|
138 There are several ways to enter multi-byte characters:
|
|
139 - For X11 XIM can be used. See |XIM|.
|
|
140 - For MS-Windows IME can be used. See |IME|.
|
|
141 - For all systems keymaps can be used. See |mbyte-keymap|.
|
|
142
|
|
143 The options 'iminsert', 'imsearch' and 'imcmdline' can be used to chose
|
9
|
144 the different input methods or disable them temporarily.
|
7
|
145
|
|
146 ==============================================================================
|
|
147 2. Locale *mbyte-locale*
|
|
148
|
|
149 The easiest setup is when your whole system uses the locale you want to work
|
|
150 in. But it's also possible to set the locale for one shell you are working
|
|
151 in, or just use a certain locale inside Vim.
|
|
152
|
|
153
|
|
154 WHAT IS A LOCALE? *locale*
|
|
155
|
|
156 There are many of languages in the world. And there are different cultures
|
|
157 and environments at least as much as the number of languages. A linguistic
|
|
158 environment corresponding to an area is called "locale". This includes
|
|
159 information about the used language, the charset, collating order for sorting,
|
|
160 date format, currency format and so on. For Vim only the language and charset
|
|
161 really matter.
|
|
162
|
|
163 You can only use a locale if your system has support for it. Some systems
|
|
164 have only a few locales, especially in the USA. The language which you want
|
|
165 to use may not be on your system. In that case you might be able to install
|
|
166 it as an extra package. Check your system documentation for how to do that.
|
|
167
|
|
168 The location in which the locales are installed varies from system to system.
|
|
169 For example, "/usr/share/locale" or "/usr/lib/locale". See your system's
|
|
170 setlocale() man page.
|
|
171
|
|
172 Looking in these directories will show you the exact name of each locale.
|
|
173 Mostly upper/lowercase matters, thus "ja_JP.EUC" and "ja_jp.euc" are
|
|
174 different. Some systems have a locale.alias file, which allows translation
|
|
175 from a short name like "nl" to the full name "nl_NL.ISO_8859-1".
|
|
176
|
|
177 Note that X-windows has its own locale stuff. And unfortunately uses locale
|
|
178 names different from what is used elsewhere. This is confusing! For Vim it
|
|
179 matters what the setlocale() function uses, which is generally NOT the
|
|
180 X-windows stuff. You might have to do some experiments to find out what
|
|
181 really works.
|
|
182
|
|
183 *locale-name*
|
|
184 The (simplified) format of |locale| name is:
|
|
185
|
|
186 language
|
|
187 or language_territory
|
|
188 or language_territory.codeset
|
|
189
|
|
190 Territory means the country (or part of it), codeset means the |charset|. For
|
|
191 example, the locale name "ja_JP.eucJP" means:
|
|
192 ja the language is Japanese
|
|
193 JP the country is Japan
|
|
194 eucJP the codeset is EUC-JP
|
|
195 But it also could be "ja", "ja_JP.EUC", "ja_JP.ujis", etc. And unfortunately,
|
|
196 the locale name for a specific language, territory and codeset is not unified
|
|
197 and depends on your system.
|
|
198
|
|
199 Examples of locale name:
|
|
200 charset language locale name ~
|
|
201 GB2312 Chinese (simplified) zh_CN.EUC, zh_CN.GB2312
|
|
202 Big5 Chinese (traditional) zh_TW.BIG5, zh_TW.Big5
|
|
203 CNS-11643 Chinese (traditional) zh_TW
|
|
204 EUC-JP Japanese ja, ja_JP.EUC, ja_JP.ujis, ja_JP.eucJP
|
|
205 Shift_JIS Japanese ja_JP.SJIS, ja_JP.Shift_JIS
|
|
206 EUC-KR Korean ko, ko_KR.EUC
|
|
207
|
|
208
|
|
209 USING A LOCALE
|
|
210
|
|
211 To start using a locale for the whole system, see the documentation of your
|
|
212 system. Mostly you need to set it in a configuration file in "/etc".
|
|
213
|
|
214 To use a locale in a shell, set the $LANG environment value. When you want to
|
|
215 use Korean and the |locale| name is "ko", do this:
|
|
216
|
|
217 sh: export LANG=ko
|
|
218 csh: setenv LANG ko
|
|
219
|
|
220 You can put this in your ~/.profile or ~/.cshrc file to always use it.
|
|
221
|
|
222 To use a locale in Vim only, use the |:language| command: >
|
|
223
|
|
224 :language ko
|
|
225
|
|
226 Put this in your ~/.vimrc file to use it always.
|
|
227
|
|
228 Or specify $LANG when starting Vim:
|
|
229
|
|
230 sh: LANG=ko vim {vim-arguments}
|
|
231 csh: env LANG=ko vim {vim-arguments}
|
|
232
|
|
233 You could make a small shell script for this.
|
|
234
|
|
235 ==============================================================================
|
|
236 3. Encoding *mbyte-encoding*
|
|
237
|
|
238 Vim uses the 'encoding' option to specify how characters identified and
|
|
239 encoded when they are used inside Vim. This applies to all the places where
|
|
240 text is used, including buffers (files loaded into memory), registers and
|
|
241 variables.
|
|
242
|
|
243 *charset* *codeset*
|
|
244 Charset is another name for encoding. There are subtle differences, but these
|
|
245 don't matter when using Vim. "codeset" is another similar name.
|
|
246
|
|
247 Each character is encoded as one or more bytes. When all characters are
|
|
248 encoded with one byte, we call this a single-byte encoding. The most often
|
|
249 used one is called "latin1". This limits the number of characters to 256.
|
|
250 Some of these are control characters, thus even fewer can be used for text.
|
|
251
|
|
252 When some characters use two or more bytes, we call this a multi-byte
|
|
253 encoding. This allows using much more than 256 characters, which is required
|
|
254 for most East Asian languages.
|
|
255
|
|
256 Most multi-byte encodings use one byte for the first 127 characters. These
|
|
257 are equal to ASCII, which makes it easy to exchange plain-ASCII text, no
|
|
258 matter what language is used. Thus you might see the right text even when the
|
|
259 encoding was set wrong.
|
|
260
|
|
261 *encoding-names*
|
|
262 Vim can use many different character encodings. There are three major groups:
|
|
263
|
|
264 1 8bit Single-byte encodings, 256 different characters. Mostly used
|
|
265 in USA and Europe. Example: ISO-8859-1 (Latin1). All
|
|
266 characters occupy one screen cell only.
|
|
267
|
|
268 2 2byte Double-byte encodings, over 10000 different characters.
|
|
269 Mostly used in Asian countries. Example: euc-kr (Korean)
|
|
270 The number of screen cells is equal to the number of bytes
|
|
271 (except for euc-jp when the first byte is 0x8e).
|
|
272
|
|
273 u Unicode Universal encoding, can replace all others. ISO 10646.
|
|
274 Millions of different characters. Example: UTF-8. The
|
|
275 relation between bytes and screen cells is complex.
|
|
276
|
|
277 Other encodings cannot be used by Vim internally. But files in other
|
|
278 encodings can be edited by using conversion, see 'fileencoding'.
|
|
279 Note that all encodings must use ASCII for the characters up to 128 (except
|
|
280 when compiled for EBCDIC).
|
|
281
|
|
282 Supported 'encoding' values are: *encoding-values*
|
|
283 1 latin1 8-bit characters (ISO 8859-1)
|
|
284 1 iso-8859-n ISO_8859 variant (n = 2 to 15)
|
|
285 1 koi8-r Russian
|
|
286 1 koi8-u Ukrainian
|
|
287 1 macroman MacRoman (Macintosh encoding)
|
|
288 1 8bit-{name} any 8-bit encoding (Vim specific name)
|
|
289 1 cp{number} MS-Windows: any installed single-byte codepage
|
|
290 2 cp932 Japanese (Windows only)
|
|
291 2 euc-jp Japanese (Unix only)
|
|
292 2 sjis Japanese (Unix only)
|
|
293 2 cp949 Korean (Unix and Windows)
|
|
294 2 euc-kr Korean (Unix only)
|
|
295 2 cp936 simplified Chinese (Windows only)
|
|
296 2 euc-cn simplified Chinese (Unix only)
|
|
297 2 cp950 traditional Chinese (on Unix alias for big5)
|
|
298 2 big5 traditional Chinese (on Windows alias for cp950)
|
|
299 2 euc-tw traditional Chinese (Unix only)
|
|
300 2 2byte-{name} Unix: any double-byte encoding (Vim specific name)
|
|
301 2 cp{number} MS-Windows: any installed double-byte codepage
|
|
302 u utf-8 32 bit UTF-8 encoded Unicode (ISO/IEC 10646-1)
|
|
303 u ucs-2 16 bit UCS-2 encoded Unicode (ISO/IEC 10646-1)
|
|
304 u ucs-2le like ucs-2, little endian
|
|
305 u utf-16 ucs-2 extended with double-words for more characters
|
|
306 u utf-16le like utf-16, little endian
|
|
307 u ucs-4 32 bit UCS-4 encoded Unicode (ISO/IEC 10646-1)
|
|
308 u ucs-4le like ucs-4, little endian
|
|
309
|
|
310 The {name} can be any encoding name that your system supports. It is passed
|
|
311 to iconv() to convert between the encoding of the file and the current locale.
|
|
312 For MS-Windows "cp{number}" means using codepage {number}.
|
|
313 Examples: >
|
|
314 :set encoding=8bit-cp1252
|
|
315 :set encoding=2byte-cp932
|
|
316 <
|
|
317 Several aliases can be used, they are translated to one of the names above.
|
|
318 An incomplete list:
|
|
319
|
|
320 1 ansi same as latin1 (obsolete, for backward compatibility)
|
|
321 2 japan Japanese: on Unix "euc-jp", on MS-Windows cp932
|
|
322 2 korea Korean: on Unix "euc-kr", on MS-Windows cp949
|
|
323 2 prc simplified Chinese: on Unix "euc-cn", on MS-Windows cp936
|
|
324 2 chinese same as "prc"
|
|
325 2 taiwan traditional Chinese: on Unix "euc-tw", on MS-Windows cp950
|
|
326 u utf8 same as utf-8
|
|
327 u unicode same as ucs-2
|
|
328 u ucs2be same as ucs-2 (big endian)
|
|
329 u ucs-2be same as ucs-2 (big endian)
|
|
330 u ucs-4be same as ucs-4 (big endian)
|
39
|
331 default stands for the default value of 'encoding', depends on the
|
|
332 environment
|
7
|
333
|
|
334 For the UCS codes the byte order matters. This is tricky, use UTF-8 whenever
|
|
335 you can. The default is to use big-endian (most significant byte comes
|
|
336 first):
|
|
337 name bytes char ~
|
|
338 ucs-2 11 22 1122
|
|
339 ucs-2le 22 11 1122
|
|
340 ucs-4 11 22 33 44 11223344
|
|
341 ucs-4le 44 33 22 11 11223344
|
|
342
|
|
343 On MS-Windows systems you often want to use "ucs-2le", because it uses little
|
|
344 endian UCS-2.
|
|
345
|
|
346 There are a few encodings which are similar, but not exactly the same. Vim
|
|
347 treats them as if they were different encodings, so that conversion will be
|
|
348 done when needed. You might want to use the similar name to avoid conversion
|
|
349 or when conversion is not possible:
|
|
350
|
|
351 cp932, shift-jis, sjis
|
|
352 cp936, euc-cn
|
|
353
|
|
354 *encoding-table*
|
|
355 Normally 'encoding' is equal to your current locale and 'termencoding' is
|
|
356 empty. This means that your keyboard and display work with characters encoded
|
|
357 in your current locale, and Vim uses the same characters internally.
|
|
358
|
|
359 You can make Vim use characters in a different encoding by setting the
|
|
360 'encoding' option to a different value. Since the keyboard and display still
|
|
361 use the current locale, conversion needs to be done. The 'termencoding' then
|
|
362 takes over the value of the current locale, so Vim converts between 'encoding'
|
|
363 and 'termencoding'. Example: >
|
|
364 :let &termencoding = &encoding
|
|
365 :set encoding=utf-8
|
|
366
|
|
367 However, not all combinations of values are possible. The table below tells
|
|
368 you how each of the nine combinations works. This is further restricted by
|
|
369 not all conversions being possible, iconv() being present, etc. Since this
|
|
370 depends on the system used, no detailed list can be given.
|
|
371
|
|
372 ('tenc' is the short name for 'termencoding' and 'enc' short for 'encoding')
|
|
373
|
|
374 'tenc' 'enc' remark ~
|
|
375
|
|
376 8bit 8bit Works. When 'termencoding' is different from
|
|
377 'encoding' typing and displaying may be wrong for some
|
|
378 characters, Vim does NOT perform conversion (set
|
|
379 'encoding' to "utf-8" to get this).
|
|
380 8bit 2byte MS-Windows: works for all codepages installed on your
|
|
381 system; you can only type 8bit characters;
|
|
382 Other systems: does NOT work.
|
|
383 8bit Unicode Works, but you can only type 8bit characters; in a
|
|
384 terminal you can only see 8bit characters; the GUI can
|
|
385 show all characters that the 'guifont' supports.
|
|
386
|
|
387 2byte 8bit Works, but typing non-ASCII characters might
|
|
388 be a problem.
|
|
389 2byte 2byte MS-Windows: works for all codepages installed on your
|
|
390 system; typing characters might be a problem when
|
|
391 locale is different from 'encoding'.
|
|
392 Other systems: Only works when 'termencoding' is equal
|
|
393 to 'encoding', you might as well leave it empty.
|
|
394 2byte Unicode works, Vim will translate typed characters.
|
|
395
|
|
396 Unicode 8bit works (unusual)
|
|
397 Unicode 2byte does NOT work
|
|
398 Unicode Unicode works very well (leaving 'termencoding' empty works
|
|
399 the same way, because all Unicode is handled
|
|
400 internally as UTF-8)
|
|
401
|
|
402 CONVERSION *charset-conversion*
|
|
403
|
|
404 Vim will automatically convert from one to another encoding in several places:
|
|
405 - When reading a file and 'fileencoding' is different from 'encoding'
|
|
406 - When writing a file and 'fileencoding' is different from 'encoding'
|
|
407 - When displaying characters and 'termencoding' is different from 'encoding'
|
|
408 - When reading input and 'termencoding' is different from 'encoding'
|
|
409 - When displaying messages and the encoding used for LC_MESSAGES differs from
|
|
410 'encoding' (requires a gettext version that supports this).
|
|
411 - When reading a Vim script where |:scriptencoding| is different from
|
|
412 'encoding'.
|
|
413 - When reading or writing a |viminfo| file.
|
|
414 Most of these require the |+iconv| feature. Conversion for reading and
|
|
415 writing files may also be specified with the 'charconvert' option.
|
|
416
|
|
417 Useful utilities for converting the charset:
|
|
418 All: iconv
|
|
419 GNU iconv can convert most encodings. Unicode is used as the
|
|
420 intermediate encoding, which allows conversion from and to all other
|
|
421 encodings. See http://www.gnu.org/directory/libiconv.html.
|
|
422
|
|
423 Japanese: nkf
|
|
424 Nkf is "Network Kanji code conversion Filter". One of the most unique
|
|
425 facility of nkf is the guess of the input Kanji code. So, you don't
|
|
426 need to know what the inputting file's |charset| is. When convert to
|
|
427 EUC-JP from ISO-2022-JP or Shift_JIS, simply do the following command
|
|
428 in Vim:
|
|
429 :%!nkf -e
|
|
430 Nkf can be found at:
|
|
431 http://www.sfc.wide.ad.jp/~max/FreeBSD/ports/distfiles/nkf-1.62.tar.gz
|
|
432
|
|
433 Chinese: hc
|
|
434 Hc is "Hanzi Converter". Hc convert a GB file to a Big5 file, or Big5
|
|
435 file to GB file. Hc can be found at:
|
|
436 ftp://ftp.cuhk.hk/pub/chinese/ifcss/software/unix/convert/hc-30.tar.gz
|
|
437
|
|
438 Korean: hmconv
|
|
439 Hmconv is Korean code conversion utility especially for E-mail. It can
|
|
440 convert between EUC-KR and ISO-2022-KR. Hmconv can be found at:
|
|
441 ftp://ftp.kaist.ac.kr/pub/hangul/code/hmconv/
|
|
442
|
|
443 Multilingual: lv
|
|
444 Lv is a Powerful Multilingual File Viewer. And it can be worked as
|
|
445 |charset| converter. Supported |charset|: ISO-2022-CN, ISO-2022-JP,
|
|
446 ISO-2022-KR, EUC-CN, EUC-JP, EUC-KR, EUC-TW, UTF-7, UTF-8, ISO-8859
|
|
447 series, Shift_JIS, Big5 and HZ. Lv can be found at:
|
|
448 http://www.ff.iij4u.or.jp/~nrt/freeware/lv4495.tar.gz
|
|
449
|
|
450
|
|
451 *mbyte-conversion*
|
|
452 When reading and writing files in an encoding different from 'encoding',
|
|
453 conversion needs to be done. These conversions are supported:
|
|
454 - All conversions between Latin-1 (ISO-8859-1), UTF-8, UCS-2 and UCS-4 are
|
|
455 handled internally.
|
|
456 - For MS-Windows, when 'encoding' is a Unicode encoding, conversion from and
|
|
457 to any codepage should work.
|
|
458 - Conversion specified with 'charconvert'
|
|
459 - Conversion with the iconv library, if it is available.
|
|
460 Old versions of GNU iconv() may cause the conversion to fail (they
|
|
461 request a very large buffer, more than Vim is willing to provide).
|
|
462 Try getting another iconv() implementation.
|
|
463
|
|
464 ==============================================================================
|
|
465 4. Using a terminal *mbyte-terminal*
|
|
466
|
|
467 The GUI fully supports multi-byte characters. It is also possible in a
|
|
468 terminal, if the terminal supports the same encoding that Vim uses. Thus this
|
|
469 is less flexible.
|
|
470
|
|
471 For example, you can run Vim in a xterm with added multi-byte support and/or
|
|
472 |XIM|. Examples are kterm (Kanji term) and hanterm (for Korean), Eterm
|
|
473 (Enlightened terminal) and rxvt.
|
|
474
|
|
475 If your terminal does not support the right encoding, you can set the
|
|
476 'termencoding' option. Vim will then convert the typed characters from
|
|
477 'termencoding' to 'encoding'. And displayed text will be converted from
|
|
478 'encoding' to 'termencoding'. If the encoding supported by the terminal
|
|
479 doesn't include all the characters that Vim uses, this leads to lost
|
|
480 characters. This may mess up the display. If you use a terminal that
|
|
481 supports Unicode, such as the xterm mentioned below, it should work just fine,
|
|
482 since nearly every character set can be converted to Unicode without loss of
|
|
483 information.
|
|
484
|
|
485
|
|
486 UTF-8 IN XFREE86 XTERM *UTF8-xterm*
|
|
487
|
|
488 This is a short explanation of how to use UTF-8 character encoding in the
|
|
489 xterm that comes with XFree86 by Thomas Dickey (text by Markus Kuhn).
|
|
490
|
|
491 Get the latest xterm version which has now UTF-8 support:
|
|
492
|
|
493 http://invisible-island.net/xterm/xterm.html
|
|
494
|
|
495 Compile it with "./configure --enable-wide-chars ; make"
|
|
496
|
|
497 Also get the ISO 10646-1 version of various fonts, which is available on
|
|
498
|
|
499 http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
|
|
500
|
|
501 and install the font as described in the README file.
|
|
502
|
|
503 Now start xterm with >
|
|
504
|
|
505 xterm -u8 -fn -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso10646-1
|
|
506 or, for bigger character: >
|
|
507 xterm -u8 -fn -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1
|
|
508
|
|
509 and you will have a working UTF-8 terminal emulator. Try both >
|
|
510
|
|
511 cat utf-8-demo.txt
|
|
512 vim utf-8-demo.txt
|
|
513
|
|
514 with the demo text that comes with ucs-fonts.tar.gz in order to see
|
|
515 whether there are any problems with UTF-8 in your xterm.
|
|
516
|
|
517 For Vim you may need to set 'encoding' to "utf-8".
|
|
518
|
|
519 ==============================================================================
|
|
520 5. Fonts on X11 *mbyte-fonts-X11*
|
|
521
|
|
522 Unfortunately, using fonts in X11 is complicated. The name of a single-byte
|
|
523 font is a long string. For multi-byte fonts we need several of these...
|
|
524
|
|
525 Note: Most of this is no longer relevant for GTK+ 2. Selecting a font via
|
|
526 its XLFD is not supported anymore; see 'guifont' for an example of how to
|
|
527 set the font. Do yourself a favor and ignore the |XLFD| and |xfontset|
|
|
528 sections below.
|
|
529
|
|
530 First of all, Vim only accepts fixed-width fonts for displaying text. You
|
|
531 cannot use proportionally spaced fonts. This excludes many of the available
|
|
532 (and nicer looking) fonts. However, for menus and tooltips any font can be
|
|
533 used.
|
|
534
|
|
535 Note that Display and Input are independent. It is possible to see your
|
|
536 language even though you have no input method for it.
|
|
537
|
|
538 You should get a default font for menus and tooltips that works, but it might
|
|
539 be ugly. Read the following to find out how to select a better font.
|
|
540
|
|
541
|
|
542 X LOGICAL FONT DESCRIPTION (XLFD)
|
|
543 *XLFD*
|
|
544 XLFD is the X font name and contains the information about the font size,
|
|
545 charset, etc. The name is in this format:
|
|
546
|
|
547 FOUNDRY-FAMILY-WEIGHT-SLANT-WIDTH-STYLE-PIXEL-POINT-X-Y-SPACE-AVE-CR-CE
|
|
548
|
|
549 Each field means:
|
|
550
|
|
551 - FOUNDRY: FOUNDRY field. The company that created the font.
|
|
552 - FAMILY: FAMILY_NAME field. Basic font family name. (helvetica, gothic,
|
|
553 times, etc)
|
|
554 - WEIGHT: WEIGHT_NAME field. How thick the letters are. (light, medium,
|
|
555 bold, etc)
|
|
556 - SLANT: SLANT field.
|
|
557 r: Roman (no slant)
|
|
558 i: Italic
|
|
559 o: Oblique
|
|
560 ri: Reverse Italic
|
|
561 ro: Reverse Oblique
|
|
562 ot: Other
|
|
563 number: Scaled font
|
|
564 - WIDTH: SETWIDTH_NAME field. Width of characters. (normal, condensed,
|
|
565 narrow, double wide)
|
|
566 - STYLE: ADD_STYLE_NAME field. Extra info to describe font. (Serif, Sans
|
|
567 Serif, Informal, Decorated, etc)
|
|
568 - PIXEL: PIXEL_SIZE field. Height, in pixels, of characters.
|
|
569 - POINT: POINT_SIZE field. Ten times height of characters in points.
|
|
570 - X: RESOLUTION_X field. X resolution (dots per inch).
|
|
571 - Y: RESOLUTION_Y field. Y resolution (dots per inch).
|
|
572 - SPACE: SPACING field.
|
|
573 p: Proportional
|
|
574 m: Monospaced
|
|
575 c: CharCell
|
|
576 - AVE: AVERAGE_WIDTH field. Ten times average width in pixels.
|
|
577 - CR: CHARSET_REGISTRY field. The name of the charset group.
|
|
578 - CE: CHARSET_ENCODING field. The rest of the charset name. For some
|
|
579 charsets, such as JIS X 0208, if this field is 0, code points has
|
|
580 the same value as GL, and GR if 1.
|
|
581
|
|
582 For example, in case of a 14 dots font corresponding to JIS X 0208, it is
|
|
583 written like:
|
|
584 -misc-fixed-medium-r-normal--16-110-100-100-c-160-jisx0208.1990-0
|
|
585
|
|
586
|
|
587 X FONTSET
|
|
588 *fontset* *xfontset*
|
|
589 A single-byte charset is typically associated with one font. For multi-byte
|
|
590 charsets a combination of fonts is often used. This means that one group of
|
|
591 characters are used from one font and another group from another font (which
|
|
592 might be double wide). This collection of fonts is called a fontset.
|
|
593
|
|
594 Which fonts are required in a fontset depends on the current locale. X
|
|
595 windows maintains a table of which groups of characters are required for a
|
|
596 locale. You have to specify all the fonts that a locale requires in the
|
|
597 'guifontset' option.
|
|
598
|
|
599 NOTE: The fontset always uses the current locale, even though 'encoding' may
|
|
600 be set to use a different charset. In that situation you might want to use
|
|
601 'guifont' and 'guifontwide' instead of 'guifontset'.
|
|
602
|
|
603 Example:
|
|
604 |charset| language "groups of characters" ~
|
|
605 GB2312 Chinese (simplified) ISO-8859-1 and GB 2312
|
|
606 Big5 Chinese (traditional) ISO-8859-1 and Big5
|
|
607 CNS-11643 Chinese (traditional) ISO-8859-1, CNS 11643-1 and CNS 11643-2
|
|
608 EUC-JP Japanese JIS X 0201 and JIS X 0208
|
|
609 EUC-KR Korean ISO-8859-1 and KS C 5601 (KS X 1001)
|
|
610
|
|
611 You can search for fonts using the xlsfonts command. For example, when you're
|
|
612 searching for a font for KS C 5601: >
|
|
613 xlsfonts | grep ksc5601
|
|
614
|
|
615 This is complicated and confusing. You might want to consult the X-Windows
|
|
616 documentation if there is something you don't understand.
|
|
617
|
|
618 *base_font_name_list*
|
|
619 When you have found the names of the fonts you want to use, you need to set
|
|
620 the 'guifontset' option. You specify the list by concatenating the font names
|
|
621 and putting a comma in between them.
|
|
622
|
|
623 For example, when you use the ja_JP.eucJP locale, this requires JIS X 0201
|
|
624 and JIS X 0208. You could supply a list of fonts that explicitly specifies
|
|
625 the charsets, like: >
|
|
626
|
|
627 :set guifontset=-misc-fixed-medium-r-normal--14-130-75-75-c-140-jisx0208.1983-0,
|
|
628 \-misc-fixed-medium-r-normal--14-130-75-75-c-70-jisx0201.1976-0
|
|
629
|
|
630 Alternatively, you can supply a base font name list that omits the charset
|
|
631 name, letting X-Windows select font characters required for the locale. For
|
|
632 example: >
|
|
633
|
|
634 :set guifontset=-misc-fixed-medium-r-normal--14-130-75-75-c-140,
|
|
635 \-misc-fixed-medium-r-normal--14-130-75-75-c-70
|
|
636
|
|
637 Alternatively, you can supply a single base font name that allows X-Windows to
|
|
638 select from all available fonts. For example: >
|
|
639
|
|
640 :set guifontset=-misc-fixed-medium-r-normal--14-*
|
|
641
|
|
642 Alternatively, you can specify alias names. See the fonts.alias file in the
|
|
643 fonts directory (e.g., /usr/X11R6/lib/X11/fonts/). For example: >
|
|
644
|
|
645 :set guifontset=k14,r14
|
|
646 <
|
|
647 *E253*
|
|
648 Note that in East Asian fonts, the standard character cell is square. When
|
|
649 mixing a Latin font and an East Asian font, the East Asian font width should
|
|
650 be twice the Latin font width.
|
|
651
|
|
652 If 'guifontset' is not empty, the "font" argument of the |:highlight| command
|
|
653 is also interpreted as a fontset. For example, you should use for
|
|
654 highlighting: >
|
|
655 :hi Comment font=english_font,your_font
|
|
656 If you use a wrong "font" argument you will get an error message.
|
|
657 Also make sure that you set 'guifontset' before setting fonts for highlight
|
|
658 groups.
|
|
659
|
|
660
|
|
661 USING RESOURCE FILES
|
|
662
|
|
663 Instead of specifying 'guifontset', you can set X11 resources and Vim will
|
|
664 pick them up. This is only for people who know how X resource files work.
|
|
665
|
|
666 For Motif and Athena insert these three lines in your $HOME/.Xdefaults file:
|
|
667
|
|
668 Vim.font: |base_font_name_list|
|
|
669 Vim*fontSet: |base_font_name_list|
|
|
670 Vim*fontList: your_language_font
|
|
671
|
|
672 Note: Vim.font is for text area.
|
|
673 Vim*fontSet is for menu.
|
|
674 Vim*fontList is for menu (for Motif GUI)
|
|
675
|
|
676 For example, when you are using Japanese and a 14 dots font, >
|
|
677
|
|
678 Vim.font: -misc-fixed-medium-r-normal--14-*
|
|
679 Vim*fontSet: -misc-fixed-medium-r-normal--14-*
|
|
680 Vim*fontList: -misc-fixed-medium-r-normal--14-*
|
|
681 <
|
|
682 or: >
|
|
683
|
|
684 Vim*font: k14,r14
|
|
685 Vim*fontSet: k14,r14
|
|
686 Vim*fontList: k14,r14
|
|
687 <
|
|
688 To have them take effect immediately you will have to do >
|
|
689
|
|
690 xrdb -merge ~/.Xdefaults
|
|
691
|
|
692 Otherwise you will have to stop and restart the X server before the changes
|
|
693 take effect.
|
|
694
|
|
695
|
|
696 The GTK+ version of GUI Vim does not use .Xdefaults, use ~/.gtkrc instead.
|
|
697 The default mostly works OK. But for the menus you might have to change
|
|
698 it. Example: >
|
|
699
|
|
700 style "default"
|
|
701 {
|
|
702 fontset="-*-*-medium-r-normal--14-*-*-*-c-*-*-*"
|
|
703 }
|
|
704 widget_class "*" style "default"
|
|
705
|
|
706 ==============================================================================
|
|
707 6. Fonts on MS-Windows *mbyte-fonts-MSwin*
|
|
708
|
|
709 The simplest is to use the font dialog to select fonts and try them out. You
|
|
710 can find this at the "Edit/Select Font..." menu. Once you find a font name
|
|
711 that works well you can use this command to see its name: >
|
|
712
|
|
713 :set guifont
|
|
714
|
|
715 Then add a command to your |gvimrc| file to set 'guifont': >
|
|
716
|
|
717 :set guifont=courier_new:h12
|
|
718
|
|
719 ==============================================================================
|
|
720 7. Input on X11 *mbyte-XIM*
|
|
721
|
|
722 X INPUT METHOD (XIM) BACKGROUND *XIM* *xim* *x-input-method*
|
|
723
|
|
724 XIM is an international input module for X. There are two kind of structures,
|
|
725 Xlib unit type and |IM-server| (Input-Method server) type. |IM-server| type
|
|
726 is suitable for complex input, such as CJK.
|
|
727
|
|
728 - IM-server
|
|
729 *IM-server*
|
|
730 In |IM-server| type input structures, the input event is handled by either
|
|
731 of the two ways: FrontEnd system and BackEnd system. In the FrontEnd
|
|
732 system, input events are snatched by the |IM-server| first, then |IM-server|
|
|
733 give the application the result of input. On the other hand, the BackEnd
|
|
734 system works reverse order. MS Windows adopt BackEnd system. In X, most of
|
|
735 |IM-server|s adopt FrontEnd system. The demerit of BackEnd system is the
|
|
736 large overhead in communication, but it provides safe synchronization with
|
|
737 no restrictions on applications.
|
|
738
|
|
739 For example, there are xwnmo and kinput2 Japanese |IM-server|, both are
|
|
740 FrontEnd system. Xwnmo is distributed with Wnn (see below), kinput2 can be
|
|
741 found at: ftp://ftp.sra.co.jp/pub/x11/kinput2/
|
|
742
|
|
743 For Chinese, there's a great XIM server named "xcin", you can input both
|
|
744 Traditional and Simplified Chinese characters. And it can accept other
|
|
745 locale if you make a correct input table. Xcin can be found at:
|
|
746 http://xcin.linux.org.tw/
|
15
|
747 Others are scim: http://scim.freedesktop.org/ and fcitx:
|
|
748 http://www.fcitx.org/
|
7
|
749
|
|
750 - Conversion Server
|
|
751 *conversion-server*
|
|
752 Some system needs additional server: conversion server. Most of Japanese
|
|
753 |IM-server|s need it, Kana-Kanji conversion server. For Chinese inputting,
|
|
754 it depends on the method of inputting, in some methods, PinYin or ZhuYin to
|
|
755 HanZi conversion server is needed. For Korean inputting, if you want to
|
|
756 input Hanja, Hangul-Hanja conversion server is needed.
|
|
757
|
|
758 For example, the Japanese inputting process is divided into 2 steps. First
|
|
759 we pre-input Hira-gana, second Kana-Kanji conversion. There are so many
|
|
760 Kanji characters (6349 Kanji characters are defined in JIS X 0208) and the
|
|
761 number of Hira-gana characters are 76. So, first, we pre-input text as
|
|
762 pronounced in Hira-gana, second, we convert Hira-gana to Kanji or Kata-Kana,
|
|
763 if needed. There are some Kana-Kanji conversion server: jserver
|
|
764 (distributed with Wnn, see below) and canna. Canna could be found at:
|
|
765 ftp://ftp.nec.co.jp/pub/Canna/ (no longer works).
|
|
766
|
|
767 There is a good input system: Wnn4.2. Wnn 4.2 contains,
|
|
768 xwnmo (|IM-server|)
|
|
769 jserver (Japanese Kana-Kanji conversion server)
|
|
770 cserver (Chinese PinYin or ZhuYin to simplified HanZi conversion server)
|
|
771 tserver (Chinese PinYin or ZhuYin to traditional HanZi conversion server)
|
|
772 kserver (Hangul-Hanja conversion server)
|
|
773 Wnn 4.2 for several systems can be found at various places on the internet.
|
|
774 Use the RPM or port for your system.
|
|
775
|
|
776
|
|
777 - Input Style
|
|
778 *xim-input-style*
|
|
779 When inputting CJK, there are four areas:
|
|
780 1. The area to display of the input while it is being composed
|
|
781 2. The area to display the currently active input mode.
|
|
782 3. The area to display the next candidate for the selection.
|
|
783 4. The area to display other tools.
|
|
784
|
|
785 The third area is needed when converting. For example, in Japanese
|
|
786 inputting, multiple Kanji characters could have the same pronunciation, so
|
|
787 a sequence of Hira-gana characters could map to a distinct sequence of Kanji
|
|
788 characters.
|
|
789
|
|
790 The first and second areas are defined in international input of X with the
|
|
791 names of "Preedit Area", "Status Area" respectively. The third and fourth
|
|
792 areas are not defined and are left to be managed by the |IM-server|. In the
|
|
793 international input, four input styles have been defined using combinations
|
|
794 of Preedit Area and Status Area: |OnTheSpot|, |OffTheSpot|, |OverTheSpot|
|
|
795 and |Root|.
|
|
796
|
|
797 Currently, GUI Vim support three style, |OverTheSpot|, |OffTheSpot| and
|
|
798 |Root|.
|
|
799
|
|
800 *. on-the-spot *OnTheSpot*
|
|
801 Preedit Area and Status Area are performed by the client application in
|
|
802 the area of application. The client application is directed by the
|
|
803 |IM-server| to display all pre-edit data at the location of text
|
|
804 insertion. The client registers callbacks invoked by the input method
|
|
805 during pre-editing.
|
|
806 *. over-the-spot *OverTheSpot*
|
|
807 Status Area is created in a fixed position within the area of application,
|
|
808 in case of Vim, the position is the additional status line. Preedit Area
|
|
809 is made at present input position of application. The input method
|
|
810 displays pre-edit data in a window which it brings up directly over the
|
|
811 text insertion position.
|
|
812 *. off-the-spot *OffTheSpot*
|
|
813 Preedit Area and Status Area are performed in the area of application, in
|
|
814 case of Vim, the area is additional status line. The client application
|
|
815 provides display windows for the pre-edit data to the input method which
|
|
816 displays into them directly.
|
|
817 *. root-window *Root*
|
|
818 Preedit Area and Status Area are outside of the application. The input
|
|
819 method displays all pre-edit data in a separate area of the screen in a
|
|
820 window specific to the input method.
|
|
821
|
|
822
|
|
823 USING XIM *multibyte-input* *E284* *E286* *E287* *E288*
|
|
824 *E285* *E291* *E292* *E290* *E289*
|
|
825
|
|
826 Note that Display and Input are independent. It is possible to see your
|
|
827 language even though you have no input method for it. But when your Display
|
|
828 method doesn't match your Input method, the text will be displayed wrong.
|
|
829
|
|
830 Note: You can not use IM unless you specify 'guifontset'.
|
|
831 Therefore, Latin users, you have to also use 'guifontset'
|
|
832 if you use IM.
|
|
833
|
|
834 To input your language you should run the |IM-server| which supports your
|
|
835 language and |conversion-server| if needed.
|
|
836
|
|
837 The next 3 lines should be put in your ~/.Xdefaults file. They are common for
|
|
838 all X applications which uses |XIM|. If you already use |XIM|, you can skip
|
|
839 this. >
|
|
840
|
|
841 *international: True
|
|
842 *.inputMethod: your_input_server_name
|
|
843 *.preeditType: your_input_style
|
|
844 <
|
|
845 input_server_name is your |IM-server| name (check your |IM-server|
|
|
846 manual).
|
|
847 your_input_style is one of |OverTheSpot|, |OffTheSpot|, |Root|. See
|
|
848 also |xim-input-style|.
|
|
849
|
|
850 *international may not necessary if you use X11R6.
|
|
851 *.inputMethod and *.preeditType are optional if you use X11R6.
|
|
852
|
|
853 For example, when you are using kinput2 as |IM-server|, >
|
|
854
|
|
855 *international: True
|
|
856 *.inputMethod: kinput2
|
|
857 *.preeditType: OverTheSpot
|
|
858 <
|
|
859 When using |OverTheSpot|, GUI Vim always connects to the IM Server even in
|
|
860 Normal mode, so you can input your language with commands like "f" and "r".
|
|
861 But when using one of the other two methods, GUI Vim connects to the IM Server
|
|
862 only if it is not in Normal mode.
|
|
863
|
|
864 If your IM Server does not support |OverTheSpot|, and if you want to use your
|
|
865 language with some Normal mode command like "f" or "r", then you should use a
|
|
866 localized xterm or an xterm which supports |XIM|
|
|
867
|
|
868 If needed, you can set the XMODIFIERS environment variable:
|
|
869
|
|
870 sh: export XMODIFIERS="@im=input_server_name"
|
|
871 csh: setenv XMODIFIERS "@im=input_server_name"
|
|
872
|
|
873 For example, when you are using kinput2 as |IM-server| and sh, >
|
|
874
|
|
875 export XMODIFIERS="@im=kinput2"
|
|
876 <
|
|
877
|
|
878 FULLY CONTROLLED XIM
|
|
879
|
|
880 You can fully control XIM, like with IME of MS-Windows (see |multibyte-ime|).
|
|
881 This is currently only available for the GTK GUI.
|
|
882
|
|
883 Before using fully controlled XIM, one setting is required. Set the
|
|
884 'imactivatekey' option to the key that is used for the activation of the input
|
|
885 method. For example, when you are using kinput2 + canna as IM Server, the
|
|
886 activation key is probably Shift+Space: >
|
|
887
|
|
888 :set imactivatekey=S-space
|
|
889
|
|
890 See 'imactivatekey' for the format.
|
|
891
|
|
892 ==============================================================================
|
|
893 8. Input on MS-Windows *mbyte-IME*
|
|
894
|
|
895 (Windows IME support) *multibyte-ime* *IME*
|
|
896
|
|
897 {only works Windows GUI and compiled with the |+multi_byte_ime| feature}
|
|
898
|
|
899 To input multibyte characters on Windows, you have to use Input Method Editor
|
|
900 (IME). In process of your editing text, you must switch status (on/off) of
|
|
901 IME many many many times. Because IME with status on is hooking all of your
|
|
902 key inputs, you cannot input 'j', 'k', or almost all of keys to Vim directly.
|
|
903
|
|
904 This |+multi_byte_ime| feature help this. It reduce times of switch status of
|
|
905 IME manually. In normal mode, there are almost no need working IME, even
|
|
906 editing multibyte text. So exiting insert mode with ESC, Vim memorize last
|
|
907 status of IME and force turn off IME. When re-enter insert mode, Vim revert
|
|
908 IME status to that memorized automatically.
|
|
909
|
|
910 This works on not only insert-normal mode, but also search-command input and
|
|
911 replace mode.
|
|
912 The options 'iminsert', 'imsearch' and 'imcmdline' can be used to chose
|
9
|
913 the different input methods or disable them temporarily.
|
7
|
914
|
|
915 WHAT IS IME
|
|
916 IME is a part of East asian version Windows. That helps you to input
|
|
917 multibyte character. English and other language version Windows does not
|
|
918 have any IME. (Also there are no need usually.) But there is one that
|
|
919 called Microsoft Global IME. Global IME is a part of Internet Explorer
|
|
920 4.0 or above. You can get more information about Global IME, at below
|
|
921 URL.
|
|
922
|
|
923 WHAT IS GLOBAL IME *global-ime*
|
|
924 Global IME makes capability to input Chinese, Japanese, and Korean text
|
|
925 into Vim buffer on any language version of Windows 98, Windows 95, and
|
|
926 Windows NT 4.0.
|
|
927 On Windows 2000 and XP it should work as well (without downloading). On
|
|
928 Windows 2000 Professional, Global IME is built in, and the Input Locales
|
|
929 can be added through Control Panel/Regional Options/Input Locales.
|
|
930 Please see below URL for detail of Global IME. You can also find various
|
|
931 language version of Global IME at same place.
|
|
932
|
|
933 - Global IME detailed information.
|
|
934 http://www.microsoft.com/windows/ie/features/ime.asp
|
|
935
|
|
936 - Active Input Method Manager (Global IME)
|
|
937 http://msdn.microsoft.com/workshop/misc/AIMM/aimm.asp
|
|
938
|
|
939 Support Global IME is a experimental feature.
|
|
940
|
|
941 NOTE: For IME to work you must make sure the input locales of your language
|
|
942 are added to your system. The exact location of this depends on the version
|
|
943 of Windows you use. For example, on my W2P box:
|
|
944 1. Control Panel
|
|
945 2. Regional Options
|
|
946 3. Input Locales Tab
|
|
947 4. Add Installed input locales -> Chinese(PRC)
|
|
948 The default is still English (United Stated)
|
|
949
|
|
950
|
|
951 Cursor color when IME or XIM is on *CursorIM*
|
|
952 There is a little cute feature for IME. Cursor can indicate status of IME
|
|
953 by changing its color. Usually status of IME was indicated by little icon
|
|
954 at a corner of desktop (or taskbar). It is not easy to verify status of
|
|
955 IME. But this feature help this.
|
|
956 This works in the same way when using XIM.
|
|
957
|
|
958 You can select cursor color when status is on by using highlight group
|
|
959 CursorIM. For example, add these lines to your _gvimrc: >
|
|
960
|
|
961 if has('multi_byte_ime')
|
|
962 highlight Cursor guifg=NONE guibg=Green
|
|
963 highlight CursorIM guifg=NONE guibg=Purple
|
|
964 endif
|
|
965 <
|
|
966 Cursor color with off IME is green. And purple cursor indicates that
|
|
967 status is on.
|
|
968
|
|
969 ==============================================================================
|
|
970 9. Input with a keymap *mbyte-keymap*
|
|
971
|
|
972 When the keyboard doesn't produce the characters you want to enter in your
|
|
973 text, you can use the 'keymap' option. This will translate one or more
|
|
974 (English) characters to another (non-English) character. This only happens
|
|
975 when typing text, not when typing Vim commands. This avoids having to switch
|
|
976 between two keyboard settings.
|
|
977
|
|
978 The value of the 'keymap' option specifies a keymap file to use. The name of
|
|
979 this file is one of these two:
|
|
980
|
|
981 keymap/{keymap}_{encoding}.vim
|
|
982 keymap/{keymap}.vim
|
|
983
|
|
984 Here {keymap} is the value of the 'keymap' option and {encoding} of the
|
|
985 'encoding' option. The file name with the {encoding} included is tried first.
|
|
986
|
|
987 'runtimepath' is used to find these files. To see an overview of all
|
|
988 available keymap files, use this: >
|
|
989 :echo globpath(&rtp, "keymap/*.vim")
|
|
990
|
|
991 In Insert and Command-line mode you can use CTRL-^ to toggle between using the
|
|
992 keyboard map or not. |i_CTRL-^| |c_CTRL-^|
|
|
993 This flag is remembered for Insert mode with the 'iminsert' option. When
|
|
994 leaving and entering Insert mode the previous value is used. The same value
|
|
995 is also used for commands that take a single character argument, like |f| and
|
|
996 |r|.
|
|
997 For Command-line mode the flag is NOT remembered. You are expected to type an
|
|
998 Ex command first, which is ASCII.
|
|
999 For typing search patterns the 'imsearch' option is used. It can be set to
|
|
1000 use the same value as for 'iminsert'.
|
|
1001
|
|
1002 It is possible to give the GUI cursor another color when the language mappings
|
|
1003 are being used. This is disabled by default, to avoid that the cursor becomes
|
|
1004 invisible when you use a non-standard background color. Here is an example to
|
|
1005 use a brightly colored cursor: >
|
|
1006 :highlight Cursor guifg=NONE guibg=Green
|
|
1007 :highlight lCursor guifg=NONE guibg=Cyan
|
|
1008 <
|
|
1009 *keymap-file-format* *:loadk* *:loadkeymap* *E105*
|
|
1010 The keymap file looks something like this: >
|
|
1011
|
|
1012 " Maintainer: name <email@address>
|
|
1013 " Last Changed: 2001 Jan 1
|
|
1014
|
|
1015 let b:keymap_name = "short"
|
|
1016
|
|
1017 loadkeymap
|
|
1018 a A
|
|
1019 b B comment
|
|
1020
|
|
1021 The lines starting with a " are comments and will be ignored. Blank lines are
|
|
1022 also ignored. The lines with the mappings may have a comment after the useful
|
|
1023 text.
|
|
1024
|
|
1025 The "b:keymap_name" can be set to a short name, which will be shown in the
|
|
1026 status line. The idea is that this takes less room than the value of
|
|
1027 'keymap', which might be long to distinguish between different languages,
|
|
1028 keyboards and encodings.
|
|
1029
|
|
1030 The actual mappings are in the lines below "loadkeymap". In the example "a"
|
|
1031 is mapped to "A" and "b" to "B". Thus the first item is mapped to the second
|
|
1032 item. This is done for each line, until the end of the file.
|
|
1033 These items are exactly the same as what can be used in a |:lnoremap| command,
|
|
1034 using "<buffer>" to make the mappings local to the buffer..
|
|
1035 You can check the result with this command: >
|
|
1036 :lmap
|
|
1037 The two items must be separated by white space. You cannot include white
|
|
1038 space inside an item, use the special names "<Tab>" and "<Space>" instead.
|
|
1039 The length of the two items together must not exceed 200 bytes.
|
|
1040
|
|
1041 It's possible to have more than one character in the first column. This works
|
|
1042 like a dead key. Example: >
|
|
1043 'a á
|
|
1044 Since Vim doesn't know if the next character after a quote is really an "a",
|
|
1045 it will wait for the next character. To be able to insert a single quote,
|
|
1046 also add this line: >
|
|
1047 '' '
|
|
1048 Since the mapping is defined with |:lnoremap| the resulting quote will not be
|
|
1049 used for the start of another character.
|
|
1050
|
|
1051 Although it's possible to have more than one character in the second column,
|
|
1052 this is unusual. But you can use various ways to specify the character: >
|
|
1053 A a literal character
|
|
1054 A <char-97> decimal value
|
|
1055 A <char-0x61> hexadecimal value
|
|
1056 A <char-0141> octal value
|
|
1057 x <Space> special key name
|
|
1058
|
|
1059 The characters are assumed to be encoded for the current value of 'encoding'.
|
|
1060 It's possible to use ":scriptencoding" when all characters are given
|
|
1061 literally. That doesn't work when using the <char-> construct, because the
|
|
1062 conversion is done on the keymap file, not on the resulting character.
|
|
1063
|
|
1064 The lines after "loadkeymap" are interpreted with 'cpoptions' set to "C".
|
|
1065 This means that continuation lines are not used and a backslash has a special
|
|
1066 meaning in the mappings. Examples: >
|
|
1067
|
|
1068 " a comment line
|
|
1069 \" x maps " to x
|
|
1070 \\ y maps \ to y
|
|
1071
|
|
1072 If you write a keymap file that will be useful for others, consider submitting
|
|
1073 it to the Vim maintainer for inclusion in the distribution:
|
|
1074 <maintainer@vim.org>
|
|
1075
|
|
1076
|
|
1077 HEBREW KEYMAP *keymap-hebrew*
|
|
1078
|
|
1079 This file explains what characters are available in UTF-8 and CP1255 encodings,
|
|
1080 and what the keymaps are to get those characters:
|
|
1081
|
|
1082 glyph encoding keymap ~
|
|
1083 Char utf-8 cp1255 hebrew hebrewp name ~
|
|
1084 א 0x5d0 0xe0 t a 'alef
|
|
1085 ב 0x5d1 0xe1 c b bet
|
|
1086 ג 0x5d2 0xe2 d g gimel
|
|
1087 ד 0x5d3 0xe3 s d dalet
|
|
1088 ה 0x5d4 0xe4 v h he
|
|
1089 ו 0x5d5 0xe5 u v vav
|
|
1090 ז 0x5d6 0xe6 z z zayin
|
|
1091 ח 0x5d7 0xe7 j j het
|
|
1092 ט 0x5d8 0xe8 y T tet
|
|
1093 י 0x5d9 0xe9 h y yod
|
|
1094 ך 0x5da 0xea l K kaf sofit
|
|
1095 כ 0x5db 0xeb f k kaf
|
|
1096 ל 0x5dc 0xec k l lamed
|
|
1097 ם 0x5dd 0xed o M mem sofit
|
|
1098 מ 0x5de 0xee n m mem
|
|
1099 ן 0x5df 0xef i N nun sofit
|
|
1100 נ 0x5e0 0xf0 b n nun
|
|
1101 ס 0x5e1 0xf1 x s samech
|
|
1102 ע 0x5e2 0xf2 g u `ayin
|
|
1103 ף 0x5e3 0xf3 ; P pe sofit
|
|
1104 פ 0x5e4 0xf4 p p pe
|
|
1105 ץ 0x5e5 0xf5 . X tsadi sofit
|
|
1106 צ 0x5e6 0xf6 m x tsadi
|
|
1107 ק 0x5e7 0xf7 e q qof
|
|
1108 ר 0x5e8 0xf8 r r resh
|
|
1109 ש 0x5e9 0xf9 a w shin
|
|
1110 ת 0x5ea 0xfa , t tav
|
|
1111
|
|
1112 Vowel marks and special punctuation:
|
|
1113 הְ 0x5b0 0xc0 A: A: sheva
|
|
1114 הֱ 0x5b1 0xc1 HE HE hataf segol
|
|
1115 הֲ 0x5b2 0xc2 HA HA hataf patah
|
|
1116 הֳ 0x5b3 0xc3 HO HO hataf qamats
|
|
1117 הִ 0x5b4 0xc4 I I hiriq
|
|
1118 הֵ 0x5b5 0xc5 AY AY tsere
|
|
1119 הֶ 0x5b6 0xc6 E E segol
|
|
1120 הַ 0x5b7 0xc7 AA AA patah
|
|
1121 הָ 0x5b8 0xc8 AO AO qamats
|
|
1122 הֹ 0x5b9 0xc9 O O holam
|
|
1123 הֻ 0x5bb 0xcb U U qubuts
|
|
1124 כּ 0x5bc 0xcc D D dagesh
|
|
1125 הֽ 0x5bd 0xcd ]T ]T meteg
|
|
1126 ה־ 0x5be 0xce ]Q ]Q maqaf
|
|
1127 בֿ 0x5bf 0xcf ]R ]R rafe
|
|
1128 ב׀ 0x5c0 0xd0 ]p ]p paseq
|
|
1129 שׁ 0x5c1 0xd1 SR SR shin-dot
|
|
1130 שׂ 0x5c2 0xd2 SL SL sin-dot
|
|
1131 ׃ 0x5c3 0xd3 ]P ]P sof-pasuq
|
|
1132 װ 0x5f0 0xd4 VV VV double-vav
|
|
1133 ױ 0x5f1 0xd5 VY VY vav-yod
|
|
1134 ײ 0x5f2 0xd6 YY YY yod-yod
|
|
1135
|
|
1136 The following are only available in utf-8
|
|
1137
|
|
1138 Cantillation marks:
|
|
1139 glyph
|
|
1140 Char utf-8 hebrew name
|
|
1141 ב֑ 0x591 C: etnahta
|
|
1142 ב֒ 0x592 Cs segol
|
|
1143 ב֓ 0x593 CS shalshelet
|
|
1144 ב֔ 0x594 Cz zaqef qatan
|
|
1145 ב֕ 0x595 CZ zaqef gadol
|
|
1146 ב֖ 0x596 Ct tipeha
|
|
1147 ב֗ 0x597 Cr revia
|
|
1148 ב֘ 0x598 Cq zarqa
|
|
1149 ב֙ 0x599 Cp pashta
|
|
1150 ב֚ 0x59a C! yetiv
|
|
1151 ב֛ 0x59b Cv tevir
|
|
1152 ב֜ 0x59c Cg geresh
|
|
1153 ב֝ 0x59d C* geresh qadim
|
|
1154 ב֞ 0x59e CG gershayim
|
|
1155 ב֟ 0x59f CP qarnei-parah
|
|
1156 ב֪ 0x5aa Cy yerach-ben-yomo
|
|
1157 ב֫ 0x5ab Co ole
|
|
1158 ב֬ 0x5ac Ci iluy
|
|
1159 ב֭ 0x5ad Cd dehi
|
|
1160 ב֮ 0x5ae Cn zinor
|
|
1161 ב֯ 0x5af CC masora circle
|
|
1162
|
|
1163 Combining forms:
|
|
1164 ﬠ 0xfb20 X` Alternative `ayin
|
|
1165 ﬡ 0xfb21 X' Alternative 'alef
|
|
1166 ﬢ 0xfb22 X-d Alternative dalet
|
|
1167 ﬣ 0xfb23 X-h Alternative he
|
|
1168 ﬤ 0xfb24 X-k Alternative kaf
|
|
1169 ﬥ 0xfb25 X-l Alternative lamed
|
|
1170 ﬦ 0xfb26 X-m Alternative mem-sofit
|
|
1171 ﬧ 0xfb27 X-r Alternative resh
|
|
1172 ﬨ 0xfb28 X-t Alternative tav
|
|
1173 ﬩ 0xfb29 X-+ Alternative plus
|
|
1174 שׁ 0xfb2a XW shin+shin-dot
|
|
1175 שׂ 0xfb2b Xw shin+sin-dot
|
|
1176 שּׁ 0xfb2c X..W shin+shin-dot+dagesh
|
|
1177 שּׂ 0xfb2d X..w shin+sin-dot+dagesh
|
|
1178 אַ 0xfb2e XA alef+patah
|
|
1179 אָ 0xfb2f XO alef+qamats
|
|
1180 אּ 0xfb30 XI alef+hiriq (mapiq)
|
|
1181 בּ 0xfb31 X.b bet+dagesh
|
|
1182 גּ 0xfb32 X.g gimel+dagesh
|
|
1183 דּ 0xfb33 X.d dalet+dagesh
|
|
1184 הּ 0xfb34 X.h he+dagesh
|
|
1185 וּ 0xfb35 Xu vav+dagesh
|
|
1186 זּ 0xfb36 X.z zayin+dagesh
|
|
1187 טּ 0xfb38 X.T tet+dagesh
|
|
1188 יּ 0xfb39 X.y yud+dagesh
|
|
1189 ךּ 0xfb3a X.K kaf sofit+dagesh
|
|
1190 כּ 0xfb3b X.k kaf+dagesh
|
|
1191 לּ 0xfb3c X.l lamed+dagesh
|
|
1192 מּ 0xfb3e X.m mem+dagesh
|
|
1193 נּ 0xfb40 X.n nun+dagesh
|
|
1194 סּ 0xfb41 X.s samech+dagesh
|
|
1195 ףּ 0xfb43 X.P pe sofit+dagesh
|
|
1196 פּ 0xfb44 X.p pe+dagesh
|
|
1197 צּ 0xfb46 X.x tsadi+dagesh
|
|
1198 קּ 0xfb47 X.q qof+dagesh
|
|
1199 רּ 0xfb48 X.r resh+dagesh
|
|
1200 שּ 0xfb49 X.w shin+dagesh
|
|
1201 תּ 0xfb4a X.t tav+dagesh
|
|
1202 וֹ 0xfb4b Xo vav+holam
|
|
1203 בֿ 0xfb4c XRb bet+rafe
|
|
1204 כֿ 0xfb4d XRk kaf+rafe
|
|
1205 פֿ 0xfb4e XRp pe+rafe
|
|
1206 ﭏ 0xfb4f Xal alef-lamed
|
|
1207
|
|
1208 ==============================================================================
|
|
1209 10. Using UTF-8 *mbyte-utf8* *UTF-8* *utf-8* *utf8*
|
|
1210 *Unicode* *unicode*
|
|
1211 The Unicode character set was designed to include all characters from other
|
|
1212 character sets. Therefore it is possible to write text in any language using
|
|
1213 Unicode (with a few rarely used languages excluded). And it's mostly possible
|
|
1214 to mix these languages in one file, which is impossible with other encodings.
|
|
1215
|
|
1216 Unicode can be encoded in several ways. The two most popular ones are UCS-2,
|
|
1217 which uses 16-bit words and UTF-8, which uses one or more bytes for each
|
|
1218 character. Vim can support all of these encodings, but always uses UTF-8
|
|
1219 internally.
|
|
1220
|
|
1221 Vim has comprehensive UTF-8 support. It appears to work in:
|
|
1222 - xterm with utf-8 support enabled
|
|
1223 - Athena, Motif and GTK GUI
|
|
1224 - MS-Windows GUI
|
|
1225
|
|
1226 Double-width characters are supported. This works best with 'guifontwide' or
|
|
1227 'guifontset'. When using only 'guifont' the wide characters are drawn in the
|
|
1228 normal width and a space to fill the gap. Note that the 'guifontset' option
|
|
1229 is no longer relevant in the GTK+ 2 GUI.
|
|
1230
|
|
1231 Up to two combining characters can be used. The combining character is drawn
|
|
1232 on top of the preceding character. When editing text a composing character is
|
|
1233 mostly considered part of the preceding character. For example "x" will
|
|
1234 delete a character and its following composing characters by default. If the
|
|
1235 'delcombine' option is on, then pressing 'x' will delete the combining
|
|
1236 characters, one at a time, then the base character. But when inserting, you
|
|
1237 type the first character and the following composing characters separately,
|
|
1238 after which they will be joined. The "r" command will not allow you to type a
|
|
1239 combining character, because it doesn't know one is coming. Use "R" instead.
|
|
1240
|
|
1241 Bytes which are not part of a valid UTF-8 byte sequence are handled like a
|
|
1242 single character and displayed as <xx>, where "xx" is the hex value of the
|
|
1243 byte.
|
|
1244
|
|
1245 Overlong sequences are not handled specially and displayed like a valid
|
|
1246 character. However, search patterns may not match on an overlong sequence.
|
|
1247 (an overlong sequence is where more bytes are used than required for the
|
|
1248 character.) An exception is NUL (zero) which is displayed as "<00>".
|
|
1249
|
|
1250 In the file and buffer the full range of Unicode characters can be used (31
|
|
1251 bits). However, displaying only works for 16 bit characters, and only for the
|
|
1252 characters present in the selected font.
|
|
1253
|
|
1254 Useful commands:
|
|
1255 - "ga" shows the decimal, hexadecimal and octal value of the character under
|
|
1256 the cursor. If there are composing characters these are shown too. (if the
|
|
1257 message is truncated, use ":messages").
|
|
1258 - "g8" shows the bytes used in a UTF-8 character, also the composing
|
|
1259 characters, as hex numbers.
|
|
1260 - ":set encoding=utf-8 fileencodings=" forces using UTF-8 for all files. The
|
|
1261 default is to use the current locale for 'encoding' and set 'fileencodings'
|
|
1262 to automatically the encoding of a file.
|
|
1263
|
|
1264
|
|
1265 STARTING VIM
|
|
1266
|
|
1267 If your current locale is in an utf-8 encoding, Vim will automatically start
|
|
1268 in utf-8 mode.
|
|
1269
|
|
1270 If you are using another locale: >
|
|
1271
|
|
1272 set encoding=utf-8
|
|
1273
|
|
1274 You might also want to select the font used for the menus. Unfortunately this
|
|
1275 doesn't always work. See the system specific remarks below, and 'langmenu'.
|
|
1276
|
|
1277
|
|
1278 USING UTF-8 IN X-Windows *utf-8-in-xwindows*
|
|
1279
|
|
1280 Note: This section does not apply to the GTK+ 2 GUI.
|
|
1281
|
|
1282 You need to specify a font to be used. For double-wide characters another
|
|
1283 font is required, which is exactly twice as wide. There are three ways to do
|
|
1284 this:
|
|
1285
|
|
1286 1. Set 'guifont' and let Vim find a matching 'guifontwide'
|
|
1287 2. Set 'guifont' and 'guifontwide'
|
|
1288 3. Set 'guifontset'
|
|
1289
|
|
1290 See the documentation for each option for details. Example: >
|
|
1291
|
|
1292 :set guifont=-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1
|
|
1293
|
|
1294 You might also want to set the font used for the menus. This only works for
|
|
1295 Motif. Use the ":hi Menu font={fontname}" command for this. |:highlight|
|
|
1296
|
|
1297
|
|
1298 TYPING UTF-8 *utf-8-typing*
|
|
1299
|
|
1300 If you are using X-Windows, you should find an input method that supports
|
|
1301 utf-8.
|
|
1302
|
|
1303 If your system does not provide support for typing utf-8, you can use the
|
|
1304 'keymap' feature. This allows writing a keymap file, which defines a utf-8
|
|
1305 character as a sequence of ASCII characters. See |mbyte-keymap|.
|
|
1306
|
|
1307 Another method is to set the current locale to the language you want to use
|
|
1308 and for which you have a XIM available. Then set 'termencoding' to that
|
|
1309 language and Vim will convert the typed characters to 'encoding' for you.
|
|
1310
|
|
1311 If everything else fails, you can type any character as four hex bytes: >
|
|
1312
|
|
1313 CTRL-V u 1234
|
|
1314
|
|
1315 "1234" is interpreted as a hex number. You must type four characters, prepend
|
|
1316 a zero if necessary.
|
|
1317
|
|
1318
|
|
1319 COMMAND ARGUMENTS *utf-8-char-arg*
|
|
1320
|
|
1321 Commands like |f|, |F|, |t| and |r| take an argument of one character. For
|
|
1322 UTF-8 this argument may include one or two composing characters. These needs
|
|
1323 to be produced together with the base character, Vim doesn't wait for the next
|
|
1324 character to be typed to find out if it is a composing character or not.
|
|
1325 Using 'keymap' or |:lmap| is a nice way to type these characters.
|
|
1326
|
|
1327 The commands that search for a character in a line handle composing characters
|
|
1328 as follows. When searching for a character without a composing character,
|
|
1329 this will find matches in the text with or without composing characters. When
|
|
1330 searching for a character with a composing character, this will only find
|
|
1331 matches with that composing character. It was implemented this way, because
|
|
1332 not everybody is able to type a composing character.
|
|
1333
|
|
1334
|
|
1335 ==============================================================================
|
|
1336 11. Overview of options *mbyte-options*
|
|
1337
|
|
1338 These options are relevant for editing multi-byte files. Check the help in
|
|
1339 options.txt for detailed information.
|
|
1340
|
|
1341 'encoding' Encoding used for the keyboard and display. It is also the
|
|
1342 default encoding for files.
|
|
1343
|
|
1344 'fileencoding' Encoding of a file. When it's different from 'encoding'
|
|
1345 conversion is done when reading or writing the file.
|
|
1346
|
|
1347 'fileencodings' List of possible encodings of a file. When opening a file
|
|
1348 these will be tried and the first one that doesn't cause an
|
|
1349 error is used for 'fileencoding'.
|
|
1350
|
|
1351 'charconvert' Expression used to convert files from one encoding to another.
|
|
1352
|
|
1353 'formatoptions' The 'm' flag can be included to have formatting break a line
|
|
1354 at a multibyte character of 256 or higher. Thus is useful for
|
|
1355 languages where a sequence of characters can be broken
|
|
1356 anywhere.
|
|
1357
|
|
1358 'guifontset' The list of font names used for a multi-byte encoding. When
|
|
1359 this option is not empty, it replaces 'guifont'.
|
|
1360
|
|
1361 'keymap' Specify the name of a keyboard mapping.
|
|
1362
|
|
1363 ==============================================================================
|
|
1364
|
|
1365 Contributions specifically for the multi-byte features by:
|
|
1366 Chi-Deok Hwang <hwang@mizi.co.kr>
|
12
|
1367 Nam SungHyun <namsh@kldp.org>
|
7
|
1368 K.Nagano <nagano@atese.advantest.co.jp>
|
|
1369 Taro Muraoka <koron@tka.att.ne.jp>
|
|
1370 Yasuhiro Matsumoto <mattn@mail.goo.ne.jp>
|
|
1371
|
|
1372 vim:tw=78:ts=8:ft=help:norl:
|