Difference between revisions of "Smart Common Input Method platform"

From ArchWiki
Jump to: navigation, search
(Configure SCIM)
(25 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Internationalization (English)]]
+
[[Category:Internationalization]]
[[Category:HOWTOs (English)]]
+
[[ja:Smart Common Input Method platform]]
 +
[[zh-CN:Smart Common Input Method platform]]
 +
[[zh-TW:Smart Common Input Method platform]]
 +
{{Out of date}}
 +
{{Poor writing}}
 +
{{Related articles start}}
 +
{{Related|IBus}}
 +
{{Related|UIM}}
 +
{{Related articles end}}
 +
[[Wikipedia:Smart Common Input Method|SCIM]] is an input method framework developed by Su Zhe (or James Su) around 2001, similar to [[IBus]] or [[UIM]].
  
{{i18n_links_start}}
+
Its stated goals are to:
{{i18n_entry|English|Scim}}
+
* Act as an unified front-end for current available input method libraries. Currently bindings to [[UIM]] and [http://www.m17n.org/m17n-lib-en/ m17n] library are available.
{{i18n_entry|简体中文|SCIM 输入法 (简体中文)}}
+
* Act as a language engine of [[Wikipedia:Internet/Intranet Input Method Framework|IIIMF]] input method framework.
{{i18n_entry|正體中文|SCIM中文輸入法}}
+
* Provide as many native [http://www.scim-im.org/projects/imengines IMEngines] as possible.
{{i18n_links_end}}
+
* Support as many input method protocols/interfaces as possible.
 
+
= About SCIM =
+
Su Zhe (or James Su)-who at that time worked for TurboLinux- started this project about 2001 with the goal:
+
* Act as an unified frontend for current available input method libraries. Currently bindings to uim and m17n library are available.
+
* Act as a language engine of IIIMF input method framework (TBD).
+
* Provide as many native IMEngines as possible.
+
* Support as many input method protocol/interface as possible.
+
 
* Support as many operating systems as possible.
 
* Support as many operating systems as possible.
  
SCIM has the following features:
+
Nowadays, SCIM is also:  
* Fully Object Oriented structure written in C++.
+
 
* Highly modularized.
 
* Highly modularized.
* Very flexible architecture, can be used as a dynamically loaded library as well as a C/S input method environment.
+
* Very flexible in its architecture, it can be used as a dynamically loaded library as well as a C/S input method environment.
* Simple programming interface.
+
* Simple from a programming interface perspective.
* Fully i18n support with UCS-4/UTF-8 encoding.
+
* Fully i18n enabled with support for UCS-4/UTF-8 encoding.
* Include many handy utility functions to speedup the development.
+
* Easy to configure through its unified configuration framework.
* GUI Panel with very rich features.
+
* Unified configuration framework.
+
  
= Installing SCIM =
+
== Installing SCIM ==
# pacman -S scim
+
SCIM can be [[Pacman|installed]] with the package {{Pkg|scim}}, available in the [[official repositories]].
== Installing Input Method Engines ==
+
Currently the SCIM project has a wide range of input methods (some may need other libraries), covering more than 30 languages, including (Simplified/Traditional) Chinese, Japanese, Korean and many European languages.
+
These are some of the examples (more can be found [http://www.scim-im.org/projects/imengines here]):
+
  
Chinese Smart PinYin:
+
=== Installing Input Method Engines ===
# pacman -S scim-pinyin
+
Currently the SCIM project has a wide range of input methods (some may need other libraries), covering more than 30 languages, including (Simplified/Traditional) Chinese, Japanese, Korean and many European languages. These are some of the examples (more can be found [http://www.scim-im.org/projects/imengines here]):
Chinese WuBi or other tables based:
+
# pacman -S scim-tables
+
Japanese:
+
# pacman -S scim-anthy
+
Korean:
+
# pacman -S scim-hangul
+
  
= Configure SCIM =
+
* '''Chinese Smart PinYin''': {{Pkg|scim-pinyin}}.
 +
* '''Chinese WuBi or other tables based''': {{Pkg|scim-tables}}.
 +
* '''Japanese''': {{Pkg|scim-anthy}}.
 +
* '''Korean''': {{Pkg|scim-hangul}}
  
In order to work correctly, SCIM configuration needs three steps:
+
== Configure SCIM ==
 +
Configuring SCIM correctly requires the following three steps:
 +
# Exporting some environment variables that specify the used input method.
 +
# Modifying locale related files.
 +
# Finally, starting SCIM.
  
1. exporting environment variables
+
=== A Simple scenario ===
  
2. modify locale-related files
+
If you just need SCIM to work urgently in any Desktop Environment or Window Manager, put these lines into {{ic|/etc/xprofile}} or {{ic|~/.xprofile}} and then reboot:
 +
{{hc|~/.xprofile|<nowiki>
 +
export XMODIFIERS=@im=SCIM
 +
export GTK_IM_MODULE="scim"
 +
export QT_IM_MODULE="scim"
 +
scim -d</nowiki>
 +
}}
  
3. start the application
+
These lines can be added to other files that are run at startup, such as: {{ic|/etc/profile}}, {{ic|~/.profile}}, {{ic|~/.xinitrc}} or {{ic|~/.config/openbox/autostart}} (when using [[Openbox]]).
  
Method 1: === Best case example ===
+
{{Note|The first environment variable conflicts with some (unusual) options like {{ic|1=XMODIFIERS=urxvt}}.}}
  
If you use a good DE/WM and do need SCIM to work urgently, put these lines into /etc/profile or ~/.xprofile ,then reboot:
+
This is a very basic example for configuring XIM (X Input Method) to work with SCIM. XIM is not recommended because it has quite some limitations.
  
export XMODIFIERS=@im=SCIM
+
=== Note for GTK+ ===
export GTK_IM_MODULE="scim"
+
export QT_IM_MODULE="scim"
+
scim -d
+
  
This is also the base example. The Correct Way of Doing Things is presented below, together with some common variants.
+
If you use [[GNOME]], edit {{ic|/etc/gtk-2.0/gtk.immodules}} by adding follow content at the end:
 +
{{hc|/etc/gtk-2.0/gtk.immodules|
 +
"/usr/lib/gtk-2.0/immodules/im-scim.so"
 +
"scim" "SCIM Input Method" "scim" "/usr/share/locale" "ja:ko:zh"
 +
}}
  
Method 2: === Just a try ===
+
If your {{ic|LC_CTYPE}} or {{ic|LANG}} is ''en_US.UTF-8'', change {{ic|ja:ko:zh}} to {{ic|en:ja:ko:zh}}.
  
If you use Gnome, edit /etc/gtk-2.0/gtk.immodules. Add follow content to the end.
+
After making those changes, be sure to reboot. You can find out what input method modules are available on your system by executing {{ic|gtk-query-immodules-2.0}}.
  
  "/usr/lib/gtk-2.0/immodules/im-scim.so"
+
If SCIM does not work with GTK+ applications after these changes, check that the GTK_IM_MODULE_FILE environment variable is set to {{ic|/etc/gtk-2.0/gtk.immodules}}.
  "scim" "SCIM Input Method" "scim" "/usr/share/locale" "ja:ko:zh"
+
  
If your LC_CTYPE is en_US.UTF-8, change "ja:ko:zh" to "en:ja:ko:zh". You can find im-modules when you execute gtk-query-immodules-2.0.Save and add
+
You can use another file (in this example {{ic|~/.immodules}}) that contains the necessary information about input methods modules by adding these lines in the file you selected in the [[#A simple scenario|section above]].
 +
gtk-query-immodules-2.0 > ~/.immodules
 +
export GTK_IM_MODULE_FILE=~/.immodules
  
  scim -d
+
==== Note for aMSN users ====
 
+
You must also export the following variable to be able to use scim input with aMSN.
to Startup Application. Reboot. Maybe you will find there is no SCIM tray icon. But when you type CTRL + SPACE, the SCIM bar will show if you have enabled some INPUT METHODs. Maybe the QT immodules is the same way.Caution: GNOME PANEL may disappear sometime when your PC boots. You can turn to SHELL with typing CTRL + ALT + F1, and execute sudo reboot or reboot. You can edit /etc/gtk-2.0/gtk.immodules with vi or vim.
+
 
+
== Environment variables ==
+
 
+
Following environment variables have to be exported ''before'' executing scim:
+
 
+
export XMODIFIERS=@im=SCIM
+
export GTK_IM_MODULE="scim"
+
export QT_IM_MODULE="scim"
+
 
+
It is usual to put these lines into some script file, e.g. ~/.xinitrc or /etc/profile (for global settings), or also ~/.config/openbox/autostart.sh (if you use Openbox as WM). If you put them into ~/.xinitrc, they have to be put ''before'' executing your DE/WM.
+
 
+
'''If you do not know which solution is the right one for you, just use /etc/profile.'''
+
 
+
Note: the first environment variable conflicts with some (unusual) options like XMODIFIERS=urxvt.
+
 
+
=== Note for amsn users ===
+
You must also export the following variable to be able to use scim input with amsn.
+
 
  export XIM_MODULE="scim -d"
 
  export XIM_MODULE="scim -d"
  
=== Note for GNOME, XFCE, LXDE ===
+
==== Note for GNOME, Xfce, LXDE ====
  
If ''export QT_IM_MODULE="scim"'' didn't work for you, you can use 'scim-bridge'' from AUR. This configuration is working in Gnome, XFCE, LXDE with last updates on 2009.02.15 (scim 1.4.7-1, scim-bridge 0.4.15-1 from AUR). Like this:
+
{{Out of date|The package {{ic|scim-bridge}} does not exist anymore.}}
  
 +
If you are using GNOME, Xfce or LXDE and Qt applications do not pick up the {{ic|1=export QT_IM_MODULE="scim"}} variable, you can use {{AUR|scim-bridge}} from the [[AUR]]. To use ''scim-bridge'' instead, export the following:
 
  export QT_IM_MODULE="scim-bridge"
 
  export QT_IM_MODULE="scim-bridge"
  
=== Note for KDE3 ===
+
==== Note for KDE3 ====
  
For '''KDE''' you should either change QT IMM to '''xim''', or have ''scim-qtimm-cvs'' installed from AUR. Like this:
+
For KDE3 you should {{ic|export QT_IM_MODULE&#61;"xim"}} instead of ''scim'' and also install [http://www.scim-im.org/projects/scim_qtimm qtimm]] for Qt3.
  
export QT_IM_MODULE="xim"
+
=== Locale-related files ===
  
== Locale-related files ==
+
If your keyboard locale is not {{ic|en_US.UTF-8}} (or {{ic|en_US.utf8}}), you have to modify the first line of {{ic|~/.scim/global}} (or {{ic|/etc/scim/global}} to apply these settings to all users) according to the following example:
 
+
If your keyboard locale is en_US.UTF-8 (or en_US.utf8), just skip this second step.
+
 
+
If your keyboard locale is ''not'' en_US.UTF-8 (nor en_US.utf8), you have to modify the first line of ~/.scim/global (or /etc/scim/global to have an user-indipendent effect) according to the following example:
+
  
 
  /SupportedUnicodeLocales = en_US.UTF-8,de_CH.UTF-8
 
  /SupportedUnicodeLocales = en_US.UTF-8,de_CH.UTF-8
  
Obviously, you have to put your locale instead of de_CH.UTF-8.
+
and replace your {{ic|de_CH.UTF-8}} with your locale.
  
Note: your locale has to be active (i.e. you have to uncomment it in /etc/locale-gen and then execute locale-gen as root) ''and'' has to be supported by SCIM (most *.UTF-8 locales are).
+
{{Note|Your locale has to be active (i.e. you have to uncomment it in {{ic|/etc/locale-gen}} and then execute {{ic|locale-gen}} as root) ''and'' has to be supported by SCIM (most *.UTF-8 locales are).}}
  
 
If you do not know which locales you have active at the moment, you can check it:
 
If you do not know which locales you have active at the moment, you can check it:
Line 121: Line 105:
 
  locale -a
 
  locale -a
  
(alternatively you can look at /etc/locale.gen).
+
(alternatively you can look at {{ic|/etc/locale.gen}}).
  
=== Further troubleshooting with locales ===
+
==== Further troubleshooting with locales ====
  
If after you have install scim and the necessary input tables, and scim still doesn't work (click on the system tray, and nothing pops up), then you need to set the '''LC_CTYPE''' environmental variable in '''/etc/profile''' to the locale you plan to use. Simply create an entry for LC_CTYPE in /etc/profile, if there isn't one.
+
If after you have install SCIM and the necessary input tables, SCIM still does not work, then you need to set the {{ic|LC_CTYPE}} environmental variable in {{ic|/etc/profile}} to the locale you plan to use. Simply create an entry for LC_CTYPE such as:
 +
LC_CTYPE="zh_CN.UTF-8"              # if you want to type simplified chinese
  
eg.  LC_CTYPE="zh_CN.UTF-8"              //if you want to type simplified chinese
+
Finally you need to generate the locale using the {{ic|locale-gen}} command.
  
Finally you need to generate the locale using the locale-gen command. Modify the /etc/locale.gen file to uncomment the language and encoding set you wish to use scim with. Then run the following command to generate the locale for your system.
+
=== Executing SCIM ===
 
+
locale-gen
+
 
+
 
+
== Executing SCIM ==
+
 
+
To execute SCIM, you ''usually'' can just execute (but see below):
+
 
+
scim
+
 
+
It is common to start SCIM as a daemon, so that you can use your computer/terminal while SCIM is working. '''That is, the normal case is to execute''':
+
  
 +
SCIM can be run by just executing the {{ic|scim}} command, although it is common to start SCIM as a daemon:
 
  scim -d
 
  scim -d
  
As above, it is a common practice to put this command into some script file instead of executing it explicitely. As above, usual places are ~/.xinitrc (after environment variables and before DE/WM), /etc/profile (after environment variables) or ~/.config/openbox/autostart.sh (after environment variables and possibly after some sleep command).
+
You can put the above command in a script file and execute it automatically. Usual places are {{ic|~/.xinitrc}} (after environment variables and before DE/WM), {{ic|/etc/profile}} (after environment variables) or {{ic|~/.config/openbox/autostart}} (after environment variables and possibly after some sleep command).
  
=== Note for GNOME ===
+
==== Note for GNOME ====
  
In case you use GNOME as DE, the command above seems not to work as expected. Instead, you have to execute the following:
+
In case you use GNOME as your desktop environment, the command above does not seem to work as expected. Instead, you have to execute the following:
  
 
   scim -f x11 -c simple -d
 
   scim -f x11 -c simple -d
Line 154: Line 129:
 
If you want SCIM to start automatically at startup, go to System > Preferences > Session and create a new command with the line above.
 
If you want SCIM to start automatically at startup, go to System > Preferences > Session and create a new command with the line above.
  
Note: If you use the line scim -f socket -c socket -d instead, the configuration of your SCIM will be unmodifiable.
+
{{Note| If you use the line {{ic|scim -f socket -c socket -d}} instead, the configuration of your SCIM will be unmodifiable.}}
  
=== Note for KDE ===
+
==== Note for KDE ====
 
+
In case you use KDE as a DE, the command above seems not to work as expected. Instead, you have to execute the following:
+
  
 +
In case you use KDE as a desktop environment, the command above does not seem to work as expected. Instead, you have to execute the following:
 
   scim -f socket -c socket -d
 
   scim -f socket -c socket -d
  
You can also apply following ''optional'' steps:
+
== Bugs ==
 
+
1. Install '''skim''' from the [http://aur.archlinux.org/packages.php?ID=22652 AUR].
+
 
+
2. Start '''SKIM''', right click on the system tray icon and click 'Configure'
+
 
+
3. Under '''Frontend > X Window''', tick the checkbox for "Start skim automatically when KDE starts"
+
 
+
4. Logout and restart X server (ctrl+alt+del), then login again
+
  
In any application, press ''ctrl+space'' to activate the input window.
+
=== LWJGL (Lightweight Java Game Library) losing keyboard focus ===
  
[http://www.archlinux.org/news/166/ See the official news page for more details].
+
See [http://www.scim-im.org/forums#nabble-td2499750 these] [http://ubuntuforums.org/showthread.php?t=1641861 two] forum posts for a solution.
  
[http://www.h4.dion.ne.jp/~apricots/scim-anthy/howto.html Complex SCIM Mandriva howto type Japaneese]
+
== Links ==
 +
*[https://www.archlinux.org/news/166/ See the official news page for more details].

Revision as of 08:55, 23 December 2013

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Talk:Smart Common Input Method platform#)

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Talk:Smart Common Input Method platform#)

Related articles

SCIM is an input method framework developed by Su Zhe (or James Su) around 2001, similar to IBus or UIM.

Its stated goals are to:

  • Act as an unified front-end for current available input method libraries. Currently bindings to UIM and m17n library are available.
  • Act as a language engine of IIIMF input method framework.
  • Provide as many native IMEngines as possible.
  • Support as many input method protocols/interfaces as possible.
  • Support as many operating systems as possible.

Nowadays, SCIM is also:

  • Highly modularized.
  • Very flexible in its architecture, it can be used as a dynamically loaded library as well as a C/S input method environment.
  • Simple from a programming interface perspective.
  • Fully i18n enabled with support for UCS-4/UTF-8 encoding.
  • Easy to configure through its unified configuration framework.

Installing SCIM

SCIM can be installed with the package scim, available in the official repositories.

Installing Input Method Engines

Currently the SCIM project has a wide range of input methods (some may need other libraries), covering more than 30 languages, including (Simplified/Traditional) Chinese, Japanese, Korean and many European languages. These are some of the examples (more can be found here):

Configure SCIM

Configuring SCIM correctly requires the following three steps:

  1. Exporting some environment variables that specify the used input method.
  2. Modifying locale related files.
  3. Finally, starting SCIM.

A Simple scenario

If you just need SCIM to work urgently in any Desktop Environment or Window Manager, put these lines into /etc/xprofile or ~/.xprofile and then reboot:

~/.xprofile
export XMODIFIERS=@im=SCIM
export GTK_IM_MODULE="scim"
export QT_IM_MODULE="scim"
scim -d

These lines can be added to other files that are run at startup, such as: /etc/profile, ~/.profile, ~/.xinitrc or ~/.config/openbox/autostart (when using Openbox).

Note: The first environment variable conflicts with some (unusual) options like XMODIFIERS=urxvt.

This is a very basic example for configuring XIM (X Input Method) to work with SCIM. XIM is not recommended because it has quite some limitations.

Note for GTK+

If you use GNOME, edit /etc/gtk-2.0/gtk.immodules by adding follow content at the end:

/etc/gtk-2.0/gtk.immodules
"/usr/lib/gtk-2.0/immodules/im-scim.so"
"scim" "SCIM Input Method" "scim" "/usr/share/locale" "ja:ko:zh"

If your LC_CTYPE or LANG is en_US.UTF-8, change ja:ko:zh to en:ja:ko:zh.

After making those changes, be sure to reboot. You can find out what input method modules are available on your system by executing gtk-query-immodules-2.0.

If SCIM does not work with GTK+ applications after these changes, check that the GTK_IM_MODULE_FILE environment variable is set to /etc/gtk-2.0/gtk.immodules.

You can use another file (in this example ~/.immodules) that contains the necessary information about input methods modules by adding these lines in the file you selected in the section above.

gtk-query-immodules-2.0 > ~/.immodules
export GTK_IM_MODULE_FILE=~/.immodules

Note for aMSN users

You must also export the following variable to be able to use scim input with aMSN.

export XIM_MODULE="scim -d"

Note for GNOME, Xfce, LXDE

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: The package scim-bridge does not exist anymore. (Discuss in Talk:Smart Common Input Method platform#)

If you are using GNOME, Xfce or LXDE and Qt applications do not pick up the export QT_IM_MODULE="scim" variable, you can use scim-bridgeAUR from the AUR. To use scim-bridge instead, export the following:

export QT_IM_MODULE="scim-bridge"

Note for KDE3

For KDE3 you should export QT_IM_MODULE="xim" instead of scim and also install qtimm] for Qt3.

Locale-related files

If your keyboard locale is not en_US.UTF-8 (or en_US.utf8), you have to modify the first line of ~/.scim/global (or /etc/scim/global to apply these settings to all users) according to the following example:

/SupportedUnicodeLocales = en_US.UTF-8,de_CH.UTF-8

and replace your de_CH.UTF-8 with your locale.

Note: Your locale has to be active (i.e. you have to uncomment it in /etc/locale-gen and then execute locale-gen as root) and has to be supported by SCIM (most *.UTF-8 locales are).

If you do not know which locales you have active at the moment, you can check it:

locale -a

(alternatively you can look at /etc/locale.gen).

Further troubleshooting with locales

If after you have install SCIM and the necessary input tables, SCIM still does not work, then you need to set the LC_CTYPE environmental variable in /etc/profile to the locale you plan to use. Simply create an entry for LC_CTYPE such as:

LC_CTYPE="zh_CN.UTF-8"              # if you want to type simplified chinese

Finally you need to generate the locale using the locale-gen command.

Executing SCIM

SCIM can be run by just executing the scim command, although it is common to start SCIM as a daemon:

scim -d

You can put the above command in a script file and execute it automatically. Usual places are ~/.xinitrc (after environment variables and before DE/WM), /etc/profile (after environment variables) or ~/.config/openbox/autostart (after environment variables and possibly after some sleep command).

Note for GNOME

In case you use GNOME as your desktop environment, the command above does not seem to work as expected. Instead, you have to execute the following:

 scim -f x11 -c simple -d

If you want SCIM to start automatically at startup, go to System > Preferences > Session and create a new command with the line above.

Note: If you use the line scim -f socket -c socket -d instead, the configuration of your SCIM will be unmodifiable.

Note for KDE

In case you use KDE as a desktop environment, the command above does not seem to work as expected. Instead, you have to execute the following:

 scim -f socket -c socket -d

Bugs

LWJGL (Lightweight Java Game Library) losing keyboard focus

See these two forum posts for a solution.

Links