Merge branch 'MacVim'
[MacVim/KaoriYa.git] / runtime / doc / hangulin.txt
blob78c00a8871f2985f75751287630e81a557849180
1 *hangulin.txt*  For Vim version 7.2.  Last change: 2009 Jun 24
4                   VIM REFERENCE MANUAL    by Chi-Deok Hwang and Sung-Hyun Nam
6 NOTE: The |+hangul_input| feature is scheduled to be removed.  If you want to
7 keep it, please send a message to the Vim user maillist.
10 Introduction                                    *hangul*
11 ------------
12 It is to input hangul, the Korean language, with VIM GUI version.
13 If you have a XIM program, you can use another |+xim| feature.
14 Basically, it is for anybody who has no XIM program.
16 Compile
17 -------
18 Next is a basic option.  You can add any other configure option. >
20    ./configure --with-x --enable-multibyte --enable-fontset --enable-hangulinput
22 And you should check feature.h.  If |+hangul_input| feature is enabled
23 by configure, you can select more options such as keyboard type, 2 bulsik
24 or 3 bulsik.  You can find keywords like next in there. >
26         #define HANGUL_DEFAULT_KEYBOARD 2
27         #define ESC_CHG_TO_ENG_MODE
28         /* #define X_LOCALE */
29         /* #define SLOW_XSERVER */
31 Environment variables
32 ---------------------
33 You should set LANG variable to Korean locale such as ko or ko_KR.euc.
34 If you set LC_ALL variable, it should be set to Korean locale also.
36 VIM resource
37 ------------
38 You should add nexts to your global vimrc ($HOME/.vimrc). >
40         :set fileencoding=korea
42 Keyboard
43 --------
44 You can change keyboard type (2 bulsik or 3 bulsik) using VIM_KEYBOARD
45 or HANGUL_KEYBOARD_TYPE environment variables.  For sh, just do (2 bulsik): >
47     export VIM_KEYBOARD="2"
48 or >
49     export HANGUL_KEYBOARD_TYPE="2"
51 If both are set, VIM_KEYBOARD has higher priority.
53 Hangul Fonts
54 ------------
55 You can set text font using $HOME/.Xdefaults or in your gvimrc file.
56 But to use Hangul, you should set 'guifontset' in your vimrc.
58 $HOME/.Xdefaults: >
59     Vim.font: english_font
61     ! Nexts are for hangul menu with Athena
62     *international: True
63     Vim*fontSet: english_font,hangul_font
65     ! Nexts are for hangul menu with Motif
66     *international: True
67     Vim*fontList: english_font;hangul_font:
69 $HOME/.gvimrc: >
70     set guifontset=english_font,hangul_font
72 attention! the , (comma) or ; (semicolon)
74 And there should be no ':set guifont'.  If it exists, then Gvim ignores
75 ':set guifontset'.  It means VIM runs without fontset supporting.
76 So, you can see only English.  Hangul does not be correctly displayed.
78 After 'fontset' feature is enabled, VIM does not allow using 'font'.
79 For example, if you use >
80    :set guifontset=eng_font,your_font
81 in your .gvimrc, then you should do for syntax >
82    :hi Comment guifg=Cyan font=another_eng_font,another_your_font
83 If you just do >
84    :hi Comment font=another_eng_font
85 then you can see a GOOD error message.  Be careful!
87 hangul_font width should be twice than english_font width.
89 Unsupported Feature
90 -------------------
91 Johab font not yet supported.  And I don't have any plan.
92 If you really want to use johab font, you can use the
93 hanguldraw.c in gau package.
95 Hanja input not yet supported.  And I don't have any plan.
96 If you really want to input hanja, just use VIM with hanterm.
98 Bug or Comment
99 --------------
100 Send comments, patches and suggestions to:
102                                     Chi-Deok Hwang <hwang@mizi.co.kr>
103                                     SungHyun Nam <goweol@gmail.com>
105  vim:tw=78:ts=8:ft=help:norl: