The Smart Common Input Method platform
C C++ Makefile HTML M4 Shell Other
Latest commit 5ee9db0 May 31, 2016 @leggewie leggewie add Tz-Huan to developers file.
He has been the main upstream guy for a while already.
Failed to load latest commit information.
configs add sharedmethod support Mar 25, 2015
data Optimize all png files (closes #9) May 11, 2016
docs Optimize all png files (closes #9) May 11, 2016
extras Detect the num-lock mask as well May 25, 2016
modules Lower the chance to clear config file May 29, 2016
po Update the po files. Thanks to Ronald Stroethoff. May 15, 2016
src Fix SCIM_DEBUG_AllMask to be unisgned Aug 4, 2015
tests Replace INCLUDES with AM_CPPFLAGS Sep 24, 2014
utils Fix the scim_string_view_draw() bug for gtk >= 3.20 Apr 23, 2016
.gitignore drop and ignore dotfiles Oct 23, 2014
AUTHORS svn commit r52 Sep 6, 2007
COPYING Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
ChangeLog Regenerate gettext related files using gettextize-0.18.1. Mar 30, 2012
ChangeLog.old Use svn2cl to generate ChangeLog. Jun 22, 2007
Makefile.am Add docs to SUBDIRS. docs should be included in distribution. Apr 24, 2012
NEWS Restore the empty NEWS, which is required for automake Oct 25, 2014
README README: minor clean-up, the scim project moved away from svn Mar 25, 2015
THANKS Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
TODO Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
bootstrap Fix bootstrap Sep 24, 2014
configure.ac Bump release 1.4.17 May 29, 2016
developers add Tz-Huan to developers file. May 31, 2016
future-plan.txt Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
scim-gtkutils.pc.in Add gtk3 support for scim-setup. Mar 20, 2012
scim-x11utils.pc.in Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
scim.pc.in Initial import scim 1.4 branch into svn as trunk. Jun 17, 2007
scim.spec.in revert r307, the docs are created during 'make dist' Sep 26, 2011
svn2cl.sh Use svn2cl to generate ChangeLog. Jun 22, 2007
svn2cl.xsl Use svn2cl to generate ChangeLog. Jun 22, 2007

README

Source-derived documentation for developers is provided separately, courtesy
of doxygen.  Look for scim-doc-$(VERSION).tar.gz on our website for download
or browse online at http://oss.leggewie.org/scim/

To compile scim from VCS, be sure to run the bootstrap script in the toplevel
directory first.  To prepare a new tarball for release, adjust the values of
the AC_INIT, SCIM_*_VERSION, SCIM_CURRENT and SCIM_REVISION variables in
configure.ac as necessary.  Then run
"./bootstrap && ./configure && make dist && make docs".

The main program of SCIM is named scim. The usage of scim is:

  scim [option]...

  The options are: 
    -l, --list            List all of available modules.
    -f, --frontend name   Uses specified FrontEnd module.
    -c, --config name     Uses specified Config module.
    -e, --engines name    Load specified set of input method engines.
    -ne,--no-engines name Do not load those set of engines.
    -d, --daemon          Run scim as a daemon.
    --no-socket           Do not try to start a SCIM SocketFrontEnd daemon.
    -h, --help            Show this help message.

By default, scim will use x11 frontend module and simple 
config module if they are available, unless you specify the module names.

And if --no-socket option is not used, scim will try to start a separated
daemon with SocketFrontEnd to provide the service, and X11 FrontEnd will
try to connect to this service daemon.

TIPS of X11 FrontEnd:
=====================

* You can drag input window, lookup window by pressing down right mouse button.
* export GDK_USE_XFT=1 before running scim to let scim use Anti-Aliased font.
* Font and color of preedit, status and lookup area can be changed in config file.

TIPS of Socket FrontEnd, IMEngine and Config module:
==================================================

*********** Notice ************
From 1.0.0, scim will make use of SocketFrontEnd to construct a single user
client/server input method environment automatically. Unless you use --no-socket
option when starting scim.
*******************************

Socket FrontEnd/IMEngine/Config module is useless under X11 environment. It's only
useful to work with GTK2 SCIM IM Module.

The purpose of Socket FrontEnd is to listen and accept request
on a local/inet socket. Socket IMEngine and Config module serve as clients of 
Socket FrontEnd.

The default socket address is local:/tmp/scim-socket-frontend, the prefix local:
indicates that it's a unix/local socket. If you want to create a inet socket, use
inet: prefix, e.g. inet:localhost:12345, 12345 is the port number.

Use following command to start scim daemon to listen a socket:

$ scim -f socket -c simple -ne socket -d

To specify a different address, you can do:

$ SCIM_SOCKET_ADDRESS=inet:localhost:12345 scim -f socket -c simple -ne socket -d

the option "-ne socket" tells scim does not load Socket IMEngine IM module, because
there is no Socket FrontEnd running yet.

Then to use this scim to serve another scim, you can do like this:

$ SCIM_SOCKET_ADDRESS=inet:localhost:12345 scim -f x11 -c socket -e socket -d

(This command starts a SCIM X11 XIM server which only forward request between
X11 and the previous started SCIM Socket FrontEnd.)

The option "-e socket" tells scim only uses Socket IMEngine IM module. Other module
should not be loaded directly, because they will be accessed via Socket FrontEnd by
Socket IMEngine IM module. -c socket tells scim to load configuration from remote
Socket FrontEnd instead of local config file.

Or if you want to use GTK2 IM Module within a GTK2/GNOME2 application, you can:

$ export SCIM_SOCKET_ADDRESS=inet:localhost:12345
$ testgtk

Then you can use SCIM directly within testgtk, by right clicking on an entry widget
and selecting SCIM input method.

By default, GTK2 SCIM IM Module will only use Socket IMEngine/Config modules, if
you want to load other modules directly, you may set the environment variables,
e.g.:

$ export GTK_IM_SCIM_CONFIG_MODULE=simple
$ export GTK_IM_SCIM_IMENGINE_MODULES=table

In case you do not understand how Socket FrontEnd/IMEngine module work, here is a
simple diagram to explain it:

+--------+
|IMEngine|
|Mod 1   |--+
+--------+  |
            |
+--------+  |  +--------+    inet          +--------+  +--------+
|IMEngine|  |  |Socket  | +--------+       |Socket  |  |X11     | /-----\
|Mod 2   |--+--+        |-|a socket| <- -> |IMEngine|--|        |-| X11 |<->app
+--------+  |  |FrontEnd| +--------+       |Module  |  |FrontEnd| \-----/
   .        |  +--------+    local         +--------+  +--------+
   .        |
   .        |
+--------+  |
|IMEngine|  |
|Mod n   |--+
+--------+

Then you see, IMEngine Modules 1 to n (like pinyin, table, rawcode etc.) with
Socket FrontEnd together act as a socket daemon (like apache), Socket IMEngine
Module with X11 FrontEnd act as a client. All requests from application
will first be sent to X11 FrontEnd, then transfered to Socket FrontEnd via
Socket IMEngine IM Module, then those requests will be proceeded by the real
IMEngine Modules (1 to n), all reply will be sent back to application via
the same route.

Have fun!

James Su <suzhe@tsinghua.org.cn>
Rolf Leggewie <foss@rolf.leggewie.biz>