[Pkg-ime-devel] Alternative README.Debian proposal

Osamu Aoki osamu@debian.org
Wed, 27 Oct 2004 23:11:18 +0200

If no one object in a week, I will overwrite current README.Debian with
followings.  I have made this much shorter and used newer reference
information from James Su.

(Also package description which I proposed before will be commited if no
one comments in a week.)

Brief User's Guide for SCIM 1.0.1

Install following basic packages as starter:
 scim, scim-frontend-socket, scim-server-socket, scim-config-gconf,

Install following packages for each needs of IMEngine (input method
conversion engine):
 scim-chinese                      (for Chinese, tightly integrated)
 scim-hangul                       (for Korean, tightly integrated)
 scim-m17n and libm17n-0  (for all languages: Arabic, Thai, Greek, ...)
 anthy and (scim-m17n or scim-uim) (for Japanese)
 (prime or canna) and scim-uim     (for alternative Japanese)

Other package to consider are:
 scim-table-zh, scim-table-ko, scim-table-ja, scim-tables-additional

SCIM can be automatically started during the X start up.  This
configuration can be easily done by the helper package m17n-env.  All
you have to do is to install m17n-env package and then to run
set-m17n-env command from the root and your user shell account while
choosing scim as your preferred IM from the menu choice.

For manual starting and configuration, run
 $ scim -d
to start SCIM.  

In order to set the X application which uses XIM to use SCIM:

In order to set the initial choice for the GTK IMModule to use SCIM:
 $ GTK_IM_MODULE="scim"; export GTK_IM_MODULE

There is also a separate qt(kde) module for scim, but it's not packaged

SCIM supports any locales which are supported by IMEngines directly.  
Any UTF-8 locales can be supported by modifying ~/.scim/config:

After first run of SCIM, ~/.scim/config contains:
    /SupportedUnicodeLocales = en_US.UTF-8
To add ja_JP.UTF-8, modify this to:
    /SupportedUnicodeLocales = en_US.UTF-8,ja_JP.UTF-8

If ~/.scim/config is not existent, run ``scim'' from terminal, then use
Ctrl-C to abort it, this configure file should be created for the user.

Then run any application that support XIM (still using the same terminal
with the environment set):
    $ gedit
Now press Ctrl-Space should switch input from English and Japanese.  If
you have a notification area on the panel, there would also be an icon
there indicating the status of scim.

Although you can set system wide environment variables such as LANG from
/etc/environment, I would not recommend to set it to any CJK (Chinese,
Japanese, Korean) locales there since normal Linux terminal will have
trouble with it.  Leave console locales as default ("C") or something
like "en_US.ISO-8859-1".  If you want to use UTF-8 locales in X use GDM
(or KDM) which run X start up script while using ~/.dmrc to set X locale
and session type (Gnome, KDE, Xfce, ...).  Custom X start up script can
be placed in /etc/X11/Xsession.d/ .

More information

The upstream website is at http://scim.freedesktop.org/ .

The details about how to start scim correctly are based on a mail from
the upstream author James Su, you can look at it if interested:

-- Ming Hua <minghua@rice.edu>  Thu, 24 Sep 2004 12:26:29 -0500
-- Osamu Aoki <osamu@debian.org>  Wed, 27 Oct 2004 22:49:23 +0200