Difference between revisions of "Input Japanese using uim"

From ArchWiki
Jump to: navigation, search
m (Compiling Mozc for uim using PKGBUILD)
m (Changed export XMODIFIERS=@im='uim' to export XMODIFIERS='@im=uim' and added a note to reflect the problems I had during installation (and the official uim documentation))
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Internationalization (English)]]
+
[[Category:Internationalization]]
{{i18n|Input Japanese using uim}}
+
[[ja:Input Japanese using uim]]
 
+
 
This page explains how to get the Japanese input to work using [http://code.google.com/p/uim/ uim].<br/>
 
This page explains how to get the Japanese input to work using [http://code.google.com/p/uim/ uim].<br/>
 
If you use SCIM, see [[Smart Common Input Method platform]].<br/>
 
If you use SCIM, see [[Smart Common Input Method platform]].<br/>
 
If you use IBus, see [[Ibus]].
 
If you use IBus, see [[Ibus]].
  
= Installation =
+
== Installation ==
 
You need the following packages to input Japanese.
 
You need the following packages to input Japanese.
  
 
* Japanese fonts
 
* Japanese fonts
* Japanese input method (Kana to Kanji conversion engine): This article describes about [http://en.sourceforge.jp/projects/anthy/ Anthy] and [http://code.google.com/p/mozc/ Mozc].
+
* Japanese input method (Kana to Kanji conversion engine)
 
* Input method framework: uim
 
* Input method framework: uim
  
== Japanese fonts ==
+
=== Japanese fonts ===
 
''see also [[Fonts]] and [[Font Configuration]] for configuration or more detail.''
 
''see also [[Fonts]] and [[Font Configuration]] for configuration or more detail.''
  
Line 28: Line 27:
 
* Monapo font (AUR: {{AUR|ttf-monapo}})
 
* Monapo font (AUR: {{AUR|ttf-monapo}})
  
== uim ==
+
=== uim ===
=== Using pacman ===
+
==== Using pacman ====
 
Pull down the necessary things with a :
 
Pull down the necessary things with a :
 
  # pacman -S uim
 
  # pacman -S uim
  
=== Compiling uim from source using PKGBUILD ===
+
==== Compiling uim from source using PKGBUILD ====
 
For instance, if you want to build uim with your configurationin, you can compile from source.
 
For instance, if you want to build uim with your configurationin, you can compile from source.
  
==== Arch's configuration====
+
===== Arch's configuration=====
 
In Arch official repository, uim is built with the following custom configuration (as of 1.7.1):
 
In Arch official repository, uim is built with the following custom configuration (as of 1.7.1):
 
* {{Ic|--with-anthy-utf8}} : Enable Anthy(UTF-8) support
 
* {{Ic|--with-anthy-utf8}} : Enable Anthy(UTF-8) support
Line 43: Line 42:
 
Please see [http://code.google.com/p/uim/wiki/InstallUim official wiki] for all configure options.
 
Please see [http://code.google.com/p/uim/wiki/InstallUim official wiki] for all configure options.
  
==== Steps to build====
+
===== Steps to build=====
 
The one of the easy way to build from source is using ABS.<br />
 
The one of the easy way to build from source is using ABS.<br />
 
First, install ABS:
 
First, install ABS:
Line 58: Line 57:
 
  $ makepkg -s -i
 
  $ makepkg -s -i
  
== Input method ==
+
=== Input method ===
=== Anthy ===
+
==== Anthy ====
Anthy is one of the most popular Japanese input method in open source world. Though it is not maintained for a long time, [http://wiki.debian.org/Teams/DebianAnthy Debian succeeds it] from May 2010.
+
Anthy is one of the most popular Japanese input methods in the open source world. However, it has not been maintained for a long time. [http://wiki.debian.org/Teams/DebianAnthy Debian succeeds it] from May 2010.
  
 
To install Anthy :
 
To install Anthy :
 
  # pacman -S anthy
 
  # pacman -S anthy
  
==== Extra dictionary ====
+
===== Extra dictionary =====
Default dictionary of original Anthy does not include several characters which are not specified on EUC-JP (JIS X 0208) such as "①", "♥", etc. [http://en.sourceforge.jp/projects/alt-cannadic/ alt-cannadic] provides extra dictionaries including those characters.
+
Anthy's default dictionary does not include several characters which are not specified on EUC-JP (JIS X 0208) such as "①", "♥", etc. [http://en.sourceforge.jp/projects/alt-cannadic/ alt-cannadic] provides extra dictionaries including those characters.
  
 
Get [http://en.sourceforge.jp/projects/alt-cannadic/releases/?package_id=6129 alt-cannadic dictionary] and put them under your {{Ic|~/.anthy/imported_words_default.d}}.
 
Get [http://en.sourceforge.jp/projects/alt-cannadic/releases/?package_id=6129 alt-cannadic dictionary] and put them under your {{Ic|~/.anthy/imported_words_default.d}}.
Line 77: Line 76:
 
{{Warning|If you will be using this extra dictionary, choose '''Anthy (UTF-8)''' for default input method on uim.}}
 
{{Warning|If you will be using this extra dictionary, choose '''Anthy (UTF-8)''' for default input method on uim.}}
  
=== Modified Anthy (anthy-ut) ===
+
==== Modified Anthy (anthy-ut) ====
 
[http://www.geocities.jp/ep3797/anthy_dict_01.html Modified Anthy] is a set of patches and huge extended dictionaries which aims to improve the Kana to Kanji conversion quality of original Anthy.
 
[http://www.geocities.jp/ep3797/anthy_dict_01.html Modified Anthy] is a set of patches and huge extended dictionaries which aims to improve the Kana to Kanji conversion quality of original Anthy.
  
Line 87: Line 86:
 
{{Warning|Modified Anthy does not have compatibility of the dictionaries and learning data with original Anthy.}}
 
{{Warning|Modified Anthy does not have compatibility of the dictionaries and learning data with original Anthy.}}
  
==== Compiling Modified Anthy using PKGBUILD ====
+
===== Compiling Modified Anthy using PKGBUILD =====
 
Modified Anthy is available on AUR named {{AUR|anthy-ut}}.
 
Modified Anthy is available on AUR named {{AUR|anthy-ut}}.
  
 
Get anthy-ut tarball and makepkg to make and install package:
 
Get anthy-ut tarball and makepkg to make and install package:
  $ wget http://aur.archlinux.org/packages/anthy-ut/anthy-ut.tar.gz
+
  $ wget https://aur.archlinux.org/packages/anthy-ut/anthy-ut.tar.gz
 
  $ tar xvf anthy-ut.tar.gz
 
  $ tar xvf anthy-ut.tar.gz
 
  $ cd anthy-ut
 
  $ cd anthy-ut
 
  $ makepkg -s -i
 
  $ makepkg -s -i
  
If you have already used original Anthy, you have to convert the existing learning data format.
+
If you already use original Anthy, you have to convert the existing learning data format.
 
  $ rm ~/.anthy/last-record1_*.bin
 
  $ rm ~/.anthy/last-record1_*.bin
 
  $ anthy-agent --update-base-record
 
  $ anthy-agent --update-base-record
Line 103: Line 102:
 
(Though this step repeats the same commands twice, it is not mistypes.)
 
(Though this step repeats the same commands twice, it is not mistypes.)
  
=== Anthy Kaomoji ===
+
==== Anthy Kaomoji ====
  
 
[http://sourceforge.jp/projects/anthy/ Anthy Kaomoji]  is a modified version of Anthy that converts Hiragana text to Kana Kanji mixed text and has emoticon (顔文字) and 2ch dictionaries.
 
[http://sourceforge.jp/projects/anthy/ Anthy Kaomoji]  is a modified version of Anthy that converts Hiragana text to Kana Kanji mixed text and has emoticon (顔文字) and 2ch dictionaries.
 
It can be found in the AUR ({{AUR|anthy-kaomoji}}).
 
It can be found in the AUR ({{AUR|anthy-kaomoji}}).
  
=== Mozc ===
+
==== Mozc ====
[http://code.google.com/p/mozc/ Mozc] (on [http://aur.archlinux.org/packages.php?K=mozc AUR]) is a Japanese open source input method originates from [http://www.google.com/intl/ja/ime/ Google Japanese Input]. It is considered that it has better conversion quality than Anthy as for multi segments conversion (e.g. one sentence) in a lump but the dictionary is not so sufficient than Google Japanese Input. Though Mozc adapts to only ibus and scim input method framework, [http://code.google.com/p/macuim/ macuim] provides uim-mozc plugin and you can use it with {{AUR|mozc-svn}} or {{AUR|mozc-ut}} on AUR.
+
''See [[Mozc]].''
  
* {{AUR|mozc-svn}}
+
[http://code.google.com/p/mozc/ Mozc] is a Japanese Input Method Editor (IME) designed for multi-platform such as Chromium OS, Windows, Mac and Linux which originates from [http://www.google.com/intl/ja/ime/ Google Japanese Input].
** mozc-svn builds with the published svn repository instead of source tarball and can build uim-mozc plugin. {{Note|If you do not use uim (use ibus or scim), you should not use mozc-svn. It is exactly similar to mozc (published svn repository is not trunk) and run-time of makepkg of mozc-svn will be longer than mozc.}}
+
* {{AUR|mozc-ut}}
+
** mozc-ut comes with [http://www.geocities.jp/ep3797/mozc_01.html Mozc UT dictionary] and can build uim-mozc plugin. The dictionary adds over 270,000 words into original.{{Note|Building mozc-ut requires further long time to generate dictionary seed.}}
+
  
==== Prepare building Mozc ====
+
Though {{AUR|Mozc}} adapts to only ibus input method framework, [http://code.google.com/p/macuim/ macuim] provides uim-mozc plugin which can use with {{AUR|mozc-svn}} or {{AUR|mozc-ut}}.
Mozc requires the following packages to be built in addition to its depending packages:
+
<!-- {{Warning|As of 2012-09, uim-mozc does not adapt to latest Mozc.}}
*Common
+
If you want use uim-mozc with latest Mozc, there is a workaround (as of r124). Edit PKGBUILD as follows, i.e. uncomment both of {{Ic|1=_uim_mozc=}} and {{Ic|1=_kill_kill_line}} lines: --><!-- This drops `kill-line' feature of uim-mozc. -->
**{{Pkg|pkg-config}}
+
**{{Pkg|python2}}
+
**{{AUR|gtest}} ''(AUR)''
+
**{{AUR|zinnia}} ''(AUR)''
+
*mozc-svn
+
**{{Pkg|subversion}}
+
*mozc-ut
+
**{{Pkg|ruby}}
+
Install {{AUR|gtest}} and {{AUR|zinnia}} from [[AUR]] before building Mozc.
+
  
==== Compiling Mozc for uim using PKGBUILD ====
+
To build uim-mozc, edit PKGBUILD like follow, i,e. uncomment {{Ic|1=_uim_mozc=}} line:
First, you get {{AUR|mozc-svn}} or {{AUR|mozc-ut}} tarball from the AUR and edit the PKGBUILD to enable uim-mozc. That is, uncomment {{Ic|_uim_mozc}} line and you can comment out {{Ic|_ibus_mozc}} line to disable ibus module if unnecessary:
+
## You can choose the input method framework to use either ibus, uim or both.
+
## If you will be not using ibus, comment out below.
+
#_ibus_mozc="yes"
+
 
  ## If you will be using uim, uncomment below.
 
  ## If you will be using uim, uncomment below.
 
  _uim_mozc="yes"
 
  _uim_mozc="yes"
  ## If you will be using scim, uncomment below.
+
  ## If applying patch for uim-mozc fails, try to uncomment below.
  #_scim_mozc="yes"
+
  #_kill_kill_line="yes"
If you will be using mozc.el  on Emacs instead of uim.el, uncomment {{Ic|_emacs_mozc}} line.
+
  ## This will disable the 'kill-line' function of uim-mozc.
  ## If you will be using mozc.el on Emacs, uncomment below.
+
_emacs_mozc="yes"
+
  
==== Build and install ====
+
{{Note|You '''must''' run the following command whenever you upgrade or (re-)install uim.<br/>
Finally, build and install:
+
  # uim-module-manager --register mozc}}
  $ makepkg -s -i
+
  
{{Note|You must run this command whenever you upgrade or (re-)install uim.<br/>
+
==== Google CGI API for Japanese Input ====
<code> # uim-module-manager --register mozc</code>}}
+
[http://www.google.co.jp/ime/cgiapi.html Google CGI API for Japanese Input] (Google-CGIAPI-Jp) is CGI service to provide Japanese conversion on the Internet by Google. It can be used on [http://www.google.com/transliterate web browser]. Its conversion engine seems to be equivalent to Google Japanese Input, so conversion quality is probably better than Mozc.
  
= Settings =
+
{{Note|This service sends/receives preedits and candidates as plain text (as of 2012-09).}}
 +
 
 +
You can use it via uim. Choose "Google-CGIAPI-Jp" on uim-im-switcher-gtk/gtk3/qt4 or uim-pref-gtk/gtk3/qt4.
 +
 
 +
== Settings ==
 
Add the followings to ~/.[[xprofile]], ~/.[[xinitrc]] or ~/.xsession:
 
Add the followings to ~/.[[xprofile]], ~/.[[xinitrc]] or ~/.xsession:
== Environment variables ==
+
=== Environment variables ===
 
  export GTK_IM_MODULE='uim'
 
  export GTK_IM_MODULE='uim'
 
  export QT_IM_MODULE='uim'
 
  export QT_IM_MODULE='uim'
 
  uim-xim &
 
  uim-xim &
  export XMODIFIERS=@im='uim'
+
  export XMODIFIERS='@im=uim'
 +
 
 +
{{Note|The variables should be exported before starting your desktop environment, i.e. before "exec startxfce4" or similar.}}
  
== Toolbar utilities ==
+
=== Toolbar utilities ===
 
If you want to use UimToolbar utilities which shows and controls uim mode, add '''one''' of the followings, too.
 
If you want to use UimToolbar utilities which shows and controls uim mode, add '''one''' of the followings, too.
  
=== uim-toolbar-gtk/qt ===
+
==== uim-toolbar-gtk/qt ====
 
Using toolbar appears as a window.
 
Using toolbar appears as a window.
  
Line 170: Line 156:
 
  uim-toolbar-qt4 &
 
  uim-toolbar-qt4 &
  
=== uim-toolbar-gtk-systray ===
+
==== uim-toolbar-gtk-systray ====
 
Using toolbar for system tray.
 
Using toolbar for system tray.
  
Line 178: Line 164:
 
  uim-toolbar-gtk3-systray &
 
  uim-toolbar-gtk3-systray &
  
=== Panel applet ===
+
==== Panel applet ====
 
Or, if you use GNOME, KDE or Xfce, you can use uim-toolbar panel applet (Xfce requires xfce4-xfapplet-plugin to use uim-applet-gnome).
 
Or, if you use GNOME, KDE or Xfce, you can use uim-toolbar panel applet (Xfce requires xfce4-xfapplet-plugin to use uim-applet-gnome).
  
== uim preferences ==
+
=== uim preferences ===
 
Configure uim preferences by running :
 
Configure uim preferences by running :
 
  $ uim-pref-gtk (Or, uim-pref-gtk3/uim-pref-qt4)
 
  $ uim-pref-gtk (Or, uim-pref-gtk3/uim-pref-qt4)
 
which brings forth a GUI.<br />
 
which brings forth a GUI.<br />
Choose {{Ic|"Anthy"}}, {{Ic|"Anthy (UTF-8)"}} or {{Ic|"Mozc"}} for 'Default input method'.
+
Choose your preferring input method as 'Default input method'.
 
{{Note|Mozc will be not listed in 'Default input method' at first time so you will need to add it into 'Enabled input methods' to use.}}
 
{{Note|Mozc will be not listed in 'Default input method' at first time so you will need to add it into 'Enabled input methods' to use.}}
  
Line 194: Line 180:
 
お疲れ様です!
 
お疲れ様です!
  
== Using uim on Emacs ==
+
=== Input Japanese on Emacs ===
 
uim provides uim.el the bridge software between Emacs and uim. Here is a sample to use uim on Emacs with utf-8 encoding.  
 
uim provides uim.el the bridge software between Emacs and uim. Here is a sample to use uim on Emacs with utf-8 encoding.  
  
 
Please see [http://code.google.com/p/uim/wiki/UimEl Official wiki] for more detail.
 
Please see [http://code.google.com/p/uim/wiki/UimEl Official wiki] for more detail.
  
Meanwhile, Anthy and Mozc provide frontend for Emacs, i.e. anthy.el and mozc.el. The one of the features of uim.el is the inline candidates displaying mode. It displays conversion candidates just below (or above) preedit text vertically.
+
==== LEIM or minor-mode ====
 
+
=== LEIM or minor-mode ===
+
 
You can call uim.el from Emacs in two ways; directly or with the LEIM (Library of Emacs Input Method) framework. Though settings of them are different, basic functions are same. If you want to switch between uim.el and other Emacs IMs frequently, you should use LEIM framework.
 
You can call uim.el from Emacs in two ways; directly or with the LEIM (Library of Emacs Input Method) framework. Though settings of them are different, basic functions are same. If you want to switch between uim.el and other Emacs IMs frequently, you should use LEIM framework.
  
==== Settings for the minor-mode ====
+
===== Settings for the minor-mode =====
If you will be using on minor-mode, write the following settings into your {{Ic|.emacs}} or some other file for Emacs customizing.
+
If you will be using on minor-mode, write the following settings into your {{Ic|.emacs.d/init.el}} or some other file for Emacs customizing.
 
  ;; read uim.el
 
  ;; read uim.el
 
  (require 'uim)
 
  (require 'uim)
Line 214: Line 198:
 
  (global-set-key "\C-\\" 'uim-mode)
 
  (global-set-key "\C-\\" 'uim-mode)
  
==== Settings for the LEIM ====
+
===== Settings for the LEIM =====
If you will be using via LEIM, write the following settings into your {{Ic|.emacs}} or some other file for Emacs customizing and choose default input method.
+
If you will be using via LEIM, write the following settings into your {{Ic|.emacs.d/init.el}} or some other file for Emacs customizing and choose default input method.
 
  ;; read uim.el with LEIM initializing
 
  ;; read uim.el with LEIM initializing
 
  (require 'uim-leim)
 
  (require 'uim-leim)
 
   
 
   
 
  ;; set default IM. Uncomment the one of the followings.
 
  ;; set default IM. Uncomment the one of the followings.
  ;(setq default-input-method "japanese-anthy-utf8-uim") ; Anthy (UTF-8)
+
  ;(setq default-input-method "japanese-anthy-utf8-uim")       ; Anthy (UTF-8)
  ;(setq default-input-method "japanese-mozc-uim")       ; Mozc
+
;(setq default-input-method "japanese-google-cgiapi-jp-uim")  ; Google-CGIAPI-Jp
 +
  ;(setq default-input-method "japanese-mozc-uim")             ; Mozc
  
=== Preferred character encoding ===
+
==== Preferred character encoding ====
uim.el uses euc-jp character encoding by default. To set UTF-8 as preferred encodings, add the followings into your {{Ic|.emacs}} or some other file for Emacs customizing.
+
uim.el uses euc-jp character encoding by default. To set UTF-8 as preferred encodings, add the followings into your {{Ic|.emacs.d/init.el}} or some other file for Emacs customizing.
 
  ;; Set UTF-8 as preferred character encoding (default is euc-jp).
 
  ;; Set UTF-8 as preferred character encoding (default is euc-jp).
 
  (setq uim-lang-code-alist
 
  (setq uim-lang-code-alist
Line 231: Line 216:
 
                     uim-lang-code-alist)))
 
                     uim-lang-code-alist)))
  
=== Enable inline candidates displaying mode by default ===
+
==== Enable inline candidates displaying mode by default ====
If you want to enable inline candidates displaying mode by default, write as follows.
+
The inline candidates displaying mode displays conversion candidates just below (or above) preedit text vertically instead of echo area. If you want to enable inline candidates displaying mode by default, write as follows.
 
  ;; set inline candidates displaying mode as default
 
  ;; set inline candidates displaying mode as default
 
  (setq uim-candidate-display-inline t)
 
  (setq uim-candidate-display-inline t)
  
=== Set Hiragana input mode by default ===
+
==== Set Hiragana input mode by default ====
 
To set Hiragana input mode at activting uim, add the settings like follows:
 
To set Hiragana input mode at activting uim, add the settings like follows:
  
 
  ;; Set Hiragana input mode at activating uim.
 
  ;; Set Hiragana input mode at activating uim.
  (setq uim-default-im-prop '("action_anthy_utf8_hiragana" "action_mozc_hiragana"))
+
  (setq uim-default-im-prop '("action_anthy_utf8_hiragana"
 +
                            "action_google-cgiapi-jp_hiragana"
 +
                            "action_mozc_hiragana"))
  
=== Disabling XIM on Emacs ===
+
==== Ignoring C-SPC on uim.el ====
When you are using input method on your desktop and assigning activation/deactivation of input method to C-SPC, you will be not able to use C-SPC/C-@ as set-mark-command on Emacs. To avoid this problem, add the following into your {{Ic|~/.Xresources}} or {{Ic|~/.Xdefaults}}. xim will be disabled on Emacs.
+
When you are assigning activation/deactivation of input method to C-SPC, C-SPC is stolen to switch input mode by uim.el while it is activated. To prevent the stealing and use for set-mark-command, add the followings into your {{Ic|.emacs.d/init.el}} or some other file for Emacs customizing.
Emacs*UseXIM: false
+
 
+
=== Ignoring C-SPC on uim.el ===
+
When you are assigning activation/deactivation of input method to C-SPC, C-SPC is stolen to switch input mode by uim.el while it is activated. To prevent the stealing and use for set-mark-command, add the followings into your {{Ic|.emacs}} or some other file for Emacs customizing.
+
 
  (add-hook 'uim-load-hook
 
  (add-hook 'uim-load-hook
 
           '(lambda ()
 
           '(lambda ()
Line 253: Line 236:
 
               (define-key uim-mode-map [0] nil)))
 
               (define-key uim-mode-map [0] nil)))
  
= Troubleshooting =
+
==== Disabling XIM on Emacs ====
== Cannot input Japanese on Opera ==
+
When you are using input method on your desktop and assigning activation/deactivation of input method to C-SPC, you will be not able to use C-SPC/C-@ as set-mark-command on Emacs. To avoid this problem, add the following into your {{Ic|~/.Xresources}} or {{Ic|~/.Xdefaults}}. xim will be disabled on Emacs.
 +
Emacs*UseXIM: false
 +
 
 +
== Troubleshooting ==
 +
=== Cannot input Japanese on Opera ===
 
If you use Opera and cannot input Japanese with uim, try to edit environment variable as follows:
 
If you use Opera and cannot input Japanese with uim, try to edit environment variable as follows:
 
  export QT_IM_MODULE='xim'
 
  export QT_IM_MODULE='xim'
  
== uim-toolbar-gtk-systray: tray icon is crushed ==
+
=== uim-toolbar-gtk-systray: tray icon is crushed ===
 
Though some of DE, WM or panel application  may provide only one icon space per application on system-tray/notification-area, uim-toolbar-gtk-systray displays some icons on it by default so those icons are crushed. Choose just one of them to solve it. The steps to display only 'Input mode' icon for example as follows:
 
Though some of DE, WM or panel application  may provide only one icon space per application on system-tray/notification-area, uim-toolbar-gtk-systray displays some icons on it by default so those icons are crushed. Choose just one of them to solve it. The steps to display only 'Input mode' icon for example as follows:
 
# Run {{Ic|uim-pref-gtk}}.
 
# Run {{Ic|uim-pref-gtk}}.
Line 269: Line 256:
 
The tray icon will be displayed "あ" (Hiragana mode) or "ー" (Direct mode).
 
The tray icon will be displayed "あ" (Hiragana mode) or "ー" (Direct mode).
  
== I use darker theme, I cannot read the uim mode icons ==
+
=== I use darker theme, I cannot read the uim mode icons ===
 
You can choose icons for darker background (uim 1.6.0 or later).
 
You can choose icons for darker background (uim 1.6.0 or later).
 
# Run uim-perf-gtk
 
# Run uim-perf-gtk
Line 275: Line 262:
 
# Check 'Use icon for dark background'.
 
# Check 'Use icon for dark background'.
  
= Useful literature =
+
== Useful literature ==
 
;uim
 
;uim
 
:[http://code.google.com/p/uim/wiki/OfficialUserDocument uim official document]
 
:[http://code.google.com/p/uim/wiki/OfficialUserDocument uim official document]

Revision as of 17:02, 23 October 2012

This page explains how to get the Japanese input to work using uim.
If you use SCIM, see Smart Common Input Method platform.
If you use IBus, see Ibus.

Installation

You need the following packages to input Japanese.

  • Japanese fonts
  • Japanese input method (Kana to Kanji conversion engine)
  • Input method framework: uim

Japanese fonts

see also Fonts and Font Configuration for configuration or more detail.

Recommended Japanese fonts are as follows.

A high quality and formal style opensource font set including Gothic (sans-serif) and Mincho (serif) glyphs. Default font of openSUSE-ja.
Default Gothic font of Debian-ja, Fedora-ja, Vine Linux, et al.
Default Gothic font of Mandriva Linux ja environment.

If you want to show 2channel Shift JIS art properly, use one of the following fonts:

uim

Using pacman

Pull down the necessary things with a :

# pacman -S uim

Compiling uim from source using PKGBUILD

For instance, if you want to build uim with your configurationin, you can compile from source.

Arch's configuration

In Arch official repository, uim is built with the following custom configuration (as of 1.7.1):

  • --with-anthy-utf8 : Enable Anthy(UTF-8) support
  • --with-qt4 : Build uim-tools for Qt

Please see official wiki for all configure options.

Steps to build

The one of the easy way to build from source is using ABS.
First, install ABS:

# pacman -S abs

Update ABS:

# abs

Then, copy uim's directory to under your $HOME. For example:

$ cp -R /var/abs/extra/uim ~/sources/

Edit PKGBUILD.

Finally, run makepkg under uim directory to make and install package:

$ makepkg -s -i

Input method

Anthy

Anthy is one of the most popular Japanese input methods in the open source world. However, it has not been maintained for a long time. Debian succeeds it from May 2010.

To install Anthy :

# pacman -S anthy
Extra dictionary

Anthy's default dictionary does not include several characters which are not specified on EUC-JP (JIS X 0208) such as "①", "♥", etc. alt-cannadic provides extra dictionaries including those characters.

Get alt-cannadic dictionary and put them under your ~/.anthy/imported_words_default.d.

$ tar jxvf alt-cannadic-091230.tar.bz2
$ mkdir ~/.anthy/imported_words_default.d (if not exist)
$ cp alt-cannadic-091230/extra/*.t ~/.anthy/imported_words_default.d/

Please see official wiki for more detail (Japanese).

Warning: If you will be using this extra dictionary, choose Anthy (UTF-8) for default input method on uim.

Modified Anthy (anthy-ut)

Modified Anthy is a set of patches and huge extended dictionaries which aims to improve the Kana to Kanji conversion quality of original Anthy.

Modified Anthy consists two different upstreams:

  • Patched source of Anthy by G-HAL
  • Huge extended dictionalies by UTSUMI
Warning: Modified Anthy applies to only Anthy (UTF-8). So you have to choose Anthy (UTF-8) for default input method on uim.
Warning: Modified Anthy does not have compatibility of the dictionaries and learning data with original Anthy.
Compiling Modified Anthy using PKGBUILD

Modified Anthy is available on AUR named anthy-utAUR.

Get anthy-ut tarball and makepkg to make and install package:

$ wget https://aur.archlinux.org/packages/anthy-ut/anthy-ut.tar.gz
$ tar xvf anthy-ut.tar.gz
$ cd anthy-ut
$ makepkg -s -i

If you already use original Anthy, you have to convert the existing learning data format.

$ rm ~/.anthy/last-record1_*.bin
$ anthy-agent --update-base-record
$ rm ~/.anthy/last-record1_*.bin
$ anthy-agent --update-base-record

(Though this step repeats the same commands twice, it is not mistypes.)

Anthy Kaomoji

Anthy Kaomoji is a modified version of Anthy that converts Hiragana text to Kana Kanji mixed text and has emoticon (顔文字) and 2ch dictionaries. It can be found in the AUR (anthy-kaomojiAUR).

Mozc

See Mozc.

Mozc is a Japanese Input Method Editor (IME) designed for multi-platform such as Chromium OS, Windows, Mac and Linux which originates from Google Japanese Input.

Though MozcAUR adapts to only ibus input method framework, macuim provides uim-mozc plugin which can use with mozc-svnAUR or mozc-utAUR.

To build uim-mozc, edit PKGBUILD like follow, i,e. uncomment _uim_mozc= line:

## If you will be using uim, uncomment below.
_uim_mozc="yes"
## If applying patch for uim-mozc fails, try to uncomment below.
#_kill_kill_line="yes"
## This will disable the 'kill-line' function of uim-mozc.
Note: You must run the following command whenever you upgrade or (re-)install uim.
# uim-module-manager --register mozc

Google CGI API for Japanese Input

Google CGI API for Japanese Input (Google-CGIAPI-Jp) is CGI service to provide Japanese conversion on the Internet by Google. It can be used on web browser. Its conversion engine seems to be equivalent to Google Japanese Input, so conversion quality is probably better than Mozc.

Note: This service sends/receives preedits and candidates as plain text (as of 2012-09).

You can use it via uim. Choose "Google-CGIAPI-Jp" on uim-im-switcher-gtk/gtk3/qt4 or uim-pref-gtk/gtk3/qt4.

Settings

Add the followings to ~/.xprofile, ~/.xinitrc or ~/.xsession:

Environment variables

export GTK_IM_MODULE='uim'
export QT_IM_MODULE='uim'
uim-xim &
export XMODIFIERS='@im=uim'
Note: The variables should be exported before starting your desktop environment, i.e. before "exec startxfce4" or similar.

Toolbar utilities

If you want to use UimToolbar utilities which shows and controls uim mode, add one of the followings, too.

uim-toolbar-gtk/qt

Using toolbar appears as a window.

For Gtk2:

uim-toolbar-gtk &

For Gtk3:

uim-toolbar-gtk3 &

For Qt:

uim-toolbar-qt4 &

uim-toolbar-gtk-systray

Using toolbar for system tray.

For Gtk2:

uim-toolbar-gtk-systray &

For Gtk3:

uim-toolbar-gtk3-systray &

Panel applet

Or, if you use GNOME, KDE or Xfce, you can use uim-toolbar panel applet (Xfce requires xfce4-xfapplet-plugin to use uim-applet-gnome).

uim preferences

Configure uim preferences by running :

$ uim-pref-gtk (Or, uim-pref-gtk3/uim-pref-qt4)

which brings forth a GUI.
Choose your preferring input method as 'Default input method'.

Note: Mozc will be not listed in 'Default input method' at first time so you will need to add it into 'Enabled input methods' to use.


You can run uim-xim or restart X to test your settings.
Provided everything went well you should be able to input Japanese in X.

お疲れ様です!

Input Japanese on Emacs

uim provides uim.el the bridge software between Emacs and uim. Here is a sample to use uim on Emacs with utf-8 encoding.

Please see Official wiki for more detail.

LEIM or minor-mode

You can call uim.el from Emacs in two ways; directly or with the LEIM (Library of Emacs Input Method) framework. Though settings of them are different, basic functions are same. If you want to switch between uim.el and other Emacs IMs frequently, you should use LEIM framework.

Settings for the minor-mode

If you will be using on minor-mode, write the following settings into your .emacs.d/init.el or some other file for Emacs customizing.

;; read uim.el
(require 'uim)
;; uncomment next and comment out previous to load uim.el on-demand
;; (autoload 'uim-mode "uim" nil t)

;; key-binding for activate uim (ex. C-\)
(global-set-key "\C-\\" 'uim-mode)
Settings for the LEIM

If you will be using via LEIM, write the following settings into your .emacs.d/init.el or some other file for Emacs customizing and choose default input method.

;; read uim.el with LEIM initializing
(require 'uim-leim)

;; set default IM. Uncomment the one of the followings.
;(setq default-input-method "japanese-anthy-utf8-uim")        ; Anthy (UTF-8)
;(setq default-input-method "japanese-google-cgiapi-jp-uim")  ; Google-CGIAPI-Jp
;(setq default-input-method "japanese-mozc-uim")              ; Mozc

Preferred character encoding

uim.el uses euc-jp character encoding by default. To set UTF-8 as preferred encodings, add the followings into your .emacs.d/init.el or some other file for Emacs customizing.

;; Set UTF-8 as preferred character encoding (default is euc-jp).
(setq uim-lang-code-alist
      (cons '("Japanese" "Japanese" utf-8 "UTF-8")
           (delete (assoc "Japanese" uim-lang-code-alist) 
                   uim-lang-code-alist)))

Enable inline candidates displaying mode by default

The inline candidates displaying mode displays conversion candidates just below (or above) preedit text vertically instead of echo area. If you want to enable inline candidates displaying mode by default, write as follows.

;; set inline candidates displaying mode as default
(setq uim-candidate-display-inline t)

Set Hiragana input mode by default

To set Hiragana input mode at activting uim, add the settings like follows:

;; Set Hiragana input mode at activating uim.
(setq uim-default-im-prop '("action_anthy_utf8_hiragana"
                            "action_google-cgiapi-jp_hiragana"
                            "action_mozc_hiragana"))

Ignoring C-SPC on uim.el

When you are assigning activation/deactivation of input method to C-SPC, C-SPC is stolen to switch input mode by uim.el while it is activated. To prevent the stealing and use for set-mark-command, add the followings into your .emacs.d/init.el or some other file for Emacs customizing.

(add-hook 'uim-load-hook
          '(lambda ()
             (define-key uim-mode-map [67108896] nil)
             (define-key uim-mode-map [0] nil)))

Disabling XIM on Emacs

When you are using input method on your desktop and assigning activation/deactivation of input method to C-SPC, you will be not able to use C-SPC/C-@ as set-mark-command on Emacs. To avoid this problem, add the following into your ~/.Xresources or ~/.Xdefaults. xim will be disabled on Emacs.

Emacs*UseXIM: false

Troubleshooting

Cannot input Japanese on Opera

If you use Opera and cannot input Japanese with uim, try to edit environment variable as follows:

export QT_IM_MODULE='xim'

uim-toolbar-gtk-systray: tray icon is crushed

Though some of DE, WM or panel application may provide only one icon space per application on system-tray/notification-area, uim-toolbar-gtk-systray displays some icons on it by default so those icons are crushed. Choose just one of them to solve it. The steps to display only 'Input mode' icon for example as follows:

  1. Run uim-pref-gtk.
  2. Click 'Toolbar' on 'Group' list.
  3. Take the all checkmarks off.
  4. Click 'Anthy', 'Anthy (UTF-8)' or 'Mozc' which you are using on 'Group' list.
  5. Click Edit button in 'Toolbar' box -> 'Enable toolbar buttons' line.
  6. Enable only 'Input mode' and click 'Close' button.
  7. Click 'OK' button to close uim-pref-gtk.

The tray icon will be displayed "あ" (Hiragana mode) or "ー" (Direct mode).

I use darker theme, I cannot read the uim mode icons

You can choose icons for darker background (uim 1.6.0 or later).

  1. Run uim-perf-gtk
  2. Click 'Toolbar' on 'Group' list.
  3. Check 'Use icon for dark background'.

Useful literature

uim
uim official document
uim on wikibooks
Fonts
Japanese fonts showcase
modified Japanese fonts