= System Configuration for uim =
This section shows you the configuration steps for uim to be usable on your system.

== (1) System Configuration ==
To use uim, you must set some environment variables correctly. You need to specify these variables and run programs(e.g. uim-xim) in ~/.xsession, ~/.xinitrc, and ~/.gnomerc depending on your system. Example settings is like this.

{{{
  GTK_IM_MODULE=uim ; export GTK_IM_MODULE
  QT_IM_MODULE=uim ; export QT_IM_MODULE
  uim-xim &
  XMODIFIERS=@im=uim ; export XMODIFIERS
}}}

To use Gtk immodule, you need to generate the immodule file. Please see the following Gtk Immodule section.

=== Using Gtk Immodule ===
Please set GTK_IM_MODULE environment variable like this.

{{{
  export GTK_IM_MODULE=uim
}}}

Then, generate the immodule file like this.

{{{
  $ gtk-query-immodules-2.0 > /etc/gtk-2.0/gtk.immodules
}}}

or

{{{
  $ gtk-query-immodules-2.0 im-uim.so > ~/.immodules
}}}

If you use ~/.immodules, please add the following lines to your setting file (eg. ~/.xsession, ~/.xinitrc, ...)

{{{
  GTK_IM_MODULE_FILE=~/.immodules
  export GTK_IM_MODULE_FILE
}}}


=== Using Qt Immodule ===
To use Qt immodule, you need to apply the [http://freedesktop.org/wiki/Software_2fimmodule_2dqt qt-immodule patch] Qt and build uim with --with-qt-immodule configure option. Then, please set QT_IM_MODULE environment variable like this.

{{{
  export QT_IM_MODULE=uim
}}}

=== Using XIM (X input method) protocol ===
To input via XIM, you need to set the environment variable XMODIFIERS, to specify the XIM client.

{{{
  export XMODIFIERS=@im=uim
}}}

You can also specify the candidate window program by setting UIM_CANDWIN_PROG. Currently, uim-candwin-gtk and uim-candwin-qt are available.

{{{
  export UIM_CANDWIN_PROG=uim-candwin-gtk
  export UIM_CANDWIN_PROG=uim-candwin-qt
}}}

Then, run the uim-xim command. For further defail, refer to [UIM_XIM uim-xim].


== (2) Choosing the Default Input Method ==
Next, you should choose the default input method by running uim-pref-gtk or uim-pref-qt.

  * run uim-pref-(gtk/qt)
  * Goto "General settings" section
  * check "Input method deployment -> Specify default IM"
  * choose "Input method deployment -> Default input method"
  * If you cannot find the IM that you want to use, press "Input method deployment -> Enabled input methods -> Edit" and activate the IM.
    * If you cannot find your favorite IM in the list of enabled input methods, please check your installation.



  Notice: uim-pref-(gtk/qt) was not offered before uim-0.4.5
  For such old version, put following line (replace 'anthy with whatever you'd like to use) to your ~/.uim.
    (define default-im-name 'anthy)

== (3) Setting other bridges ==
uim has other bridges like [UIM_EL uim-el](for emacs) and [UIM_FEP uim-fep](for console apps). Please setup these according to each bridge's manual (optional).

  * [UIM_FEP uim-fep document]
  * [UIM_EL uim-el document]