File: xcin.1

package info (click to toggle)
xcingb 2.3.02-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,488 kB
  • ctags: 878
  • sloc: ansic: 9,779; sh: 1,460; makefile: 300; awk: 12
file content (194 lines) | stat: -rw-r--r-- 8,261 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
.TH XCINGB 1 "July 20, 1997" "XCINGB 2.3.02" "Chinese (GB) Input Server for X"
.UC
.SH NAME
xcin \- The Chinese Input server (GB) for the X Window System.
.SH SYNOPSIS
xcin [\fIoptions\fP]
.SH DESCRIPTION
\fIXcin\fP is a Chinese Input server for the X Window System.
It is originally written by \fIEdward Der-Hua Liu\fP, the version
of \fIxcin-2.1b\fP, package-rearranged by \fITung-Han Hsieh\fP,
the version of \fIxcin-2.1c\fP, and highly improved by 
\fISuei-Jeng Wang <vvvv.bbs@cis.nctu.edu.tw>\fP, the version of 
\fIXcinFix4\fP.
This version, \fIxcin-2.1d\fP, is based on \fIxcin-2.1b\fP, with
some features of \fIxcin-2.1c\fP, and plus the improvement of
\fIXcinFix4\fP. It is intended to provide a more flexible, 
more powerful, and more reliable Chinese input environment for
various users.

\fIXcin\fP is only an input-server. It should work with the
display-client which is compiled with \fIcli_xcin.o\fP module,
such as \fIcrxvt\fP (1).

On the start up, \fIxcin\fP will check the data files in it default
search path (see \fI-tabdir\fP option). If the users start \fIxcin\fP
with their favorite \fIUDIM\fP (see below), then \fIxcin\fP will try
to search the data files of the \fIUDIM\fP in the following sequence:

    1. $(HOME)
    2. $(HOME)/.xcin
    3. The value defined in $(XCIN_DIR) in Makefile (The 
       default search path).

\fIXcin\fP provides a lot of options to help users to configure their
Chinese-input environment. However, it seems that it will be a little
difficult to explain them completely in English. Therefore, this
manual page only serves as a quick guideline on how to use these
options. For detailed description, please referred to 
\fIxcin.HOWTO\fP document with this package (In fact, this manual
page is based on \fIxcin.HOWTO\fP).

.SH OPTIONS
There are two ways to use these options. One is appending these 
options directly on the command line, such as:

xcin -in9 Boshiamy.tab -vb 2 -len 10 -inmd 9

or use the standard X-window resource file. Usually the custom 
X-resource is the \fI$(HOME)/.Xdefault\fP. One can add the following
lines into the resource file:

    xcin.in9:   Boshiamy.tab
    xcin.vb:    2
    xcin.len:   10
    xcin.inmd:  9 

and this is equivalent to the command line listed above. Note that
each option has the format: \fI<option name> <value>\fP. For one
example on the above, \fIin9\fP is the \fIoption name\fP, and 
\fIBoshiamy.tab\fP is the \fIvalue\fP.

Here and after we will use the following definitions:

.PD 0
.IP "User Defined Input Method (\fIUDIM\fP)"
\fIXcin\fP provides a utility \fIcin2tab\fP for users to prepare
their own input-method. One can simply edit a \fI.cin\fP input-method
definition file and use \fIcin2tab\fP to transform it for \fIxcin\fP
(for details, please refer to \fIcin2tab\fP (1)). One can use this
method to generate the input-method table such as \fIChangJei\fP,
\fIArray\fP, or \fIBoshiamy\fP. But \fIPhonetic\fP, \fIPhrase
Phonetic\fP, \fIInternal Encoding\fP and \fIPhrase Library\fP are 
internally defined by \fIxcin\fP. They are not belong to \fIUDIM\fP.
.TP
.IP "Fully Input Encoding (\fIFIE\fP)"
Every \fIUDIM\fP has the \fImaximum encoding length\fP. For example,
\fIChangJei\fP and \fIArray\fP have at most 5 codes to form a 
character, and \fIArray\fP has at most 4 codes. If we should type
to fill the \fImaximum encoding length\fP to generate a particular
character under a particular \fIUDIM\fP, we call it is under the
\fIFIE\fP state.
.TP

The supported options are listed as following:

.PD 1
.IP "-bg \fIcolor\fP"
Set the background color of \fIxcin\fP to be \fIcolor\fP.
.IP "-display \fIdisplay\fP"
Set the remote X-server display of \fIxcin\fP to be \fIdisplay\fP.
.IP "-fg \fIcolor\fP"
Set the foreground color of \fIxcin\fP to be \fIcolor\fP.
.IP "-font \fIfontName\fP"
Set the English font of \fIxcin\fP to be \fIfontName\fP.
.IP "-fngb \fIfontName\fP"
Set the Chinese (GB) font of \fIxcin\fP to be \fIfontName\fP.  Note that
the width of Chinese font should be twice as that of English font.
For example, if you use the \fIhanzigb24st\fP (with width 24) to be 
the Chinese font, then you should better use the \fI12x24\fP 
(with width 12) to be the English font.
.IP "-geometry \fIgeometry\fP"
Set the geometry of \fIxcin\fP to be \fIgeometry\fP.
.IP "-hidden \fIvalue\fP"
Set \fIvalue\fP to 1 to hid \fIxcin\fP when the client is under the 
English input mode or focus on the X-application which is not the
\fIxcin\fP client. Set it to 0 will not hid \fIxcin\fP under the 
circumstance. In addition, you can also use the key set Ctrl-Alt-m
to switch it to be on or off. The default value is 0.
.IP "-in\fI?\fP \fIinputName\fP"
Set the key sets Ctrl-Alt-\fI?\fP to be the input-method 
\fIinputName\fP. The value of \fI?\fP can be 1, 2, 3, 4, 5, 6,  
7, 8, 9 and 12.  Note that \fI-in0\fP, \fI-in11\fP are 
preserved for internal input-methods: \fI-in0\fP is 
\fIEnternal Encoding\fP, and \fI-in11\fP is \fIPhase Library\fP
(see the description of \fI-vocbox\fP option).  The \fI-in11\fP and 
\fI-in12\fP are special and use the Ctrl-Alt-- and Ctrl-Alt-= key sets, 
respectively. 
.IP "-inbg \fIcolor\fP"
Set the background color of the input region of \fIxcin\fP to be 
\fIcolor\fP.
.IP "-infg \fIcolor\fP"
Set the foreground color of the input region of \fIxcin\fP to be 
\fIcolor\fP.
.IP "-inmd \fI?\fP"
Set the default input-method to use when \fIxcin\fP starts up. The
value of \fI?\fP can be one of the number 1 \- 12.
.IP "-last_full \fIvalue\fP"
When you type the \fIFIE\fP for a particular character, \fIxcin\fP
will output the character directly. This option will control \fIxcin\fP
to send the white space followed by \fIFIE\fP immediately or not.
Set \fIvalue\fP to 0 will send the white space, or set it to 1
will not.
.IP "-len \fIlength\fP"
Set the length of \fIxcin\fP to be \fIlength\fP. This is the number
of English characters which can be fit into the \fIxcin\fP window.
It is a relative value, i.e., if \fIlength\fP is zero, then the
width of \fIxcin\fP can fit in 44 English characters. You can enlarge
or shorten its width by assigning it to be positive or negative values.
Note that its value should be greater than -43.
.IP "-phrase \fIphraseName\fP"
Use the key set Shift-Alt-<one key> will send a phrase directly in
\fIxcin\fP. Use this option to set the phrase file to be 
\fIphraseName\fP. The default value is \fIsample.phs.out\fP.
.IP "-tabdir \fItabPath\fP"
Use this option with value \fItabPath\fP to override the default 
search path for data files
and input-method tables of \fIxcin\fP. The default value is defined
in the \fIXCIN_DIR\fP variable in the compiling time.
.IP "-wild \fIvalue\fP"
If you want to type a particular character but unfortunately you
can only remember parts of its encoding, you can type the encoding
which you remembered with the "*" or "?" code. \fIXcin\fP has the 
ability to list all the characters with the encodings which satisfy the
wild field. Use the option to turn this ability to be on or off.
If you set \fIvalue\fP to 1, it is on, or you set \fIvalue\fP to 0, 
it is off.
.IP "-vb \fIvalue\fP"
Use this option to control \fIxcin\fP to beep or not. \fIvalue\fP
can be following values:

     1 :  Only beep when you type the wrong 
          encoding.
     2 :  Only beep when you type the encoding with 
          duplicate characters.
     3 :  Don't beep in any case.
     4 :  Beep when you type the wrong encoding or 
          encoding with duplicate characters.
.IP "-vocbox \fIvocName\fP"
Use the key set Ctrl-Alt-- will switch to the \fIPhrase Library\fP
input-method. One can use this option to set the \fIPhrase Library\fP
data file to be \fIvocName\fP.

.SH BUGS
If you find any bugs, please report to:

      \fIvvvv.bbs@cis.nctu.edu.tw\fP
   or \fIthhsieh@twcpro.phys.ntu.edu.tw\fP.

.SH AUTHORS
Edward Der-Hua Liu 
     (Original author of xcin-2.1b)

Jian-Da Li <jdli@FreeBSD.csie.nctu.edu.tw>
     (Contribtion on \fINational Phonetic\fP mode)

Tung-Han Hsieh <thhsieh@twcpro.phys.ntu.edu.tw>
     (xcin-2.1c, xcin-2.1d package management)

Suei-Jeng Wang <vvvv.bbs@cis.nctu.edu.tw>
     (XcinFix4: highly improved version of xcin-2.1b)

.SH SEE ALSO
crxvt-gb(1), cin2tab(1), xcin.HOWTO, cin2tab.HOWTO, Boshiamy.HOWTO,
Xfonts.HOWTO