NAME
xcin - X window Chinese INput XIM server
SYNOPSIS
xcin [ -d DISPLAY ] [ -h ] [ -m
] [ -r rcfile ] [ -x XIM_name ]
DESCRIPTION
XCIN is an XIM (X Input Method) server which is
widely used in Taiwan to perform Chinese input under X Window
system. It is originally developed by Edward Der-Hua Liu (Oct.
1994) and many other programmers in early days; while now it is
supported by the XCIN Project.
New XCIN design follows the Xi18N standard and locale mechanism.
You should have locale supported in your system C library and
installed before you run xcin. You also need the libtabe, an input
method table library, and Berkeley DB2 library to run xcin. XCIN
allows you to input the Chinese characters to an X client which
supports XIM mechanism too.
Currently, XCIN project supports big5 (used in Taiwan),
big5hkscs (used in Hong Kong) and gb2312 (used in China) character
set/encodings. The input methods currently supported are:
- big5 character set:
- cj simplex phone bimspinyin bimsphone jyutping array30
jyutping0 zh_hex
- big5hkscs character set:
- cj zh_hex
- gb2312 character set:
- pinyin shuangpin jtcj_gb wubizixing phonegb2 array30 zh_hex
XCIN has been tested and supported in the following platform
with different encoding name:
GNU/Linux
$(BIG5): big5
$(BIG5HKSCS): big5hkscs
$(GB2312): gb2312
$(GBK): gbk
FreeBSD
$(BIG5): big5
$(GB2312): euc
HP-UX
$(BIG5): big5
$(BIG5HKSCS): hkbig5
$(GB2312): hp15cn
OPTIONS
[ -h ] : print help message.
[ -m ] : print the comment of module "mod_name".
[ -d ] : set X Display.
[ -x ] : register XIM server name to Xlib.
[ -r ] : set user specified rcfile.
[ -U ] : specify the user directory of xcin data.
[ -D ] : specify the system default directory of xcin data.
[ -v n ] : set the debug level to n.
FILES
XCIN searches the configuration file, the rcfile, in
the following order.
- $HOME/.xcin/xcinrc
- This is a lisp file in user's home directory.
- $HOME/.xcinrc
- This is another lisp file in user's home directory.
- $PREFIX/etc/xcinrc
- This is a system wide configuration file.
Note that the /etc/xcinrc or /usr/local/etc/xcinrc is set up by
configure script when you compile the xcin with default prefix
directory.
RCFILE
The rcfile is a lisp program file. The main program
global setting are:
- XCIN_DEFAULT_DIR:
- XCIN default data directory, which will contain the IM tables,
IM modules,andotherdatafiles.
- XCIN_USER_DIR:
- User specified data directory. If it is not a relative path,
then
itwillstartwiththeuser's$HOMEdirectory.
- INDEX_FONT:
- The font used to display the English IM name (in the
right-bottom cornerofthexcinmainwindow).
- FG_COLOR:
- The foreground color of xcin windows.
- BG_COLOR:
- The background color of xcin windows.
- M_FG_COLOR:
- The specially displayed foreground color (e.g., the preedit
area, mutiplecharactersforselection).
- M_BG_COLOR:
- The specially displayed background color (e.g., the preedit
area, mutiplecharactersforselection).
- ULINE_COLOR:
- The color of phrases marking underline of xcin windows.
- GRID_COLOR:
- The grid color of xcin windows.
- X_GEOMETRY:
- The size and position of xcin main window.
- START_MAINWIN2:
- Open the xcin 2nd main window or not? Because in the
OverTheSpot
input_style,allthepreeditinformationaremovedinto
the
OverTheSpotwindow(thesmallwindowappearednearthe
cursorof
theXIMclient),sotheoriginalxcinmainwindowseems
tobetoo
largeandwastealotofspaceofthedisktop.
Therefore,ifthe
xcin2ndmainwindowisopened,thenintheEnglish
inputmodeor
theOverTheSpotinput_style,xcinwillusethesmaller
2ndmain
windowtodisplaynecessaryinformation.Butwhenthe
Rootinput_style
isenabled,thexcinwillautomaticallyswitchto
theoriginalmain windown.
- MAINWIN2_GEOMETRY:
- The size and position of xcin 2nd main window.
- XCIN_HIDE:
- Hide xcin window when English input mode or not?
- XKILL_DISABLE:
- Disable the facility such that the Window Manager can terminate
xcin throughWMprotocolornot?
- ICCHECK_DISABLE:
- Disable the IC checking facility or not? This facility can
check the
ICsandwindowsofalltheXIMclientsperiodically.
- SINGLE_IM_CONTEXT:
- Let all the XIM clients to share the same IM data structer or
not.
ThedefaultisNO,i.e.,theIMdatastructerof
eachXIMclient
aredistinct,sotheIMstatusofeachXIMclient
isindependent.
IfsetthisoptiontoYES,thenalltheXIM
clientswillhavethe sameIMstatus.
- IM_FOCUS_ON:
- Start the IM focus facility when running xcin. See the
following for details.
- KEEP_POSITION_ON:
- Keep the position of the xcin window or not? If this option is
opened,
thenxcinwindowwillautomaticallyappearedonthe
disktopwhenwe
switchbetweenthevirtualdisktops.Alsowhenwe
movethexcin
ENVIRONMENT VARIABLES
- XCIN_RCFILE
- set the file name of "rcfile".
- LC_CTYPE
- set the character handling locale, default is "zh_TW.Big5".
ThisisdependsonwhatkindofClibraryyou
areusing. Pleaserefertothecommandlocale
-a.
- LC_MESSAGES
- set the message output locale, default is "C" or "POSIX".
ThisisdependsonwhatkindofClibraryyou
areusing. Pleaserefertothecommandlocale
-a.
- XMODIFIERS
- A usual locale name contains a definite format as
following:
Ifthelocaleiszh_TW.Big5,thevalueisxcin.Otherwise,
thevalueisxcin-$locale
for example:
under bash: XMODIFIERS="@im=xcin-zh_CN.GB2312"
export XMODIFIERS
under csh : setenv XMODIFIERS @im=xcin
SEE ALSO
locale(1),
locale(5),
locale(7),
localedef(1),
setlocale(3)
cin2tab(1)
COPYRIGHT
XCIN is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
ACKNOWLEDGE
XCIN Team.<mailing-list: xcin@linux.org.tw>
<www:
http://xcin.linux.org.tw>
<ftp:
ftp://xcin.linux.org.tw/pub/xcin>