1KINPUT2(1) General Commands Manual KINPUT2(1)
2
6 kinput2 - kanji input server for X11
7
9 kinput2 [-options...]
10
12 Kinput2 is an X window application to input Japanese text. It acts as
13 a front-end for other applications that want kana-kanji conversion.
14 When invoked, after some initialization (which will take about a few to
16 30 seconds depending on your machine) kinput2 waits quietly for a Japa‐
17 nese text input request from another client (i.e. no windows appear).
18 When kinput2 receives a request, it pops up a window and starts conver‐
19 sion process. It sends the converted text back to the client when the
20 text is fixed.
21 Kinput2 has some big improvements over its predecessor, kinput, which
23 was contributed to X11R4.
24 Over-the-spot/On-the-spot Input
26 These features enable conversion process to be done at cursor
27 position, avoiding unnecessary movement of eyes between cursor
28 position and conversion window. Kinput2 also supports root
29 window style input and off-the-spot style input.
30 Multiple Protocol Support
32 Kinput2 supports several conversion protocols between front-end
33 and client. Supported protocols are:
34 kinput protocol
35 kinput2 protocol
36 Matsushita jinput protocol
37 Sony xlc protocol
38 XIMP protocol
39 X Input Method Protocol (X Consortium standard)
40 Multiple Conversion Engine Support
42 Kinput2 can use 4 different conversion engines, Wnn, Canna, Sj3
43 and Atok. You can choose one at compilation time, or at run
44 time.
45 Kinput Compatibility
47 Kinput2 is fully upward-compatible with kinput, so applications
48 which use kinput as the front-end can also use kinput2. In
49 this case, the applications cannot take advantage of over-the-
50 spot conversion, though.
51
53 kinput2 accepts all of the standard X Toolkit command line options.
54 The following options are accepted as well.
55 -wnn This option specifies that Wnn jserver is used as the conver‐
57 sion engine.
58 -jserver
60 This option specifies the hostname of the jserver to be used
61 for conversion.
62 -ccdef This option specifies the input character conversion rule file.
64 -wnnenvrc4
66 This option specifies the Wnn convertion environment initial‐
67 ization file (wnnenvrc) for Wnn version 4.
68 -wnnenvrc6
70 This option is similar to -wnenvrc4, but for Wnn version 6.
71 -canna This option specifies that Canna conversion server (iro‐
73 haserver) is used as the conversion engine.
74 -cannaserver
76 This option specifies the hostname of Canna conversion server.
77 -cannafile
79 This option specifies Canna conversion customization file.
80 -sj3 This option specifies that Sj3 conversion server (sj3serv) is
82 used as the conversion engine.
83 -sj3serv
85 This option specifies the hostname of the primary sj3 conver‐
86 sion server.
87 -sj3serv2
89 This option specifies the hostname of the secondary sj3 server.
90 The secondary server is used when kinput2 cannot connect to the
91 primary server.
92 -atok This option specifies that Atok server is used as the conver‐
94 sion engine.
95 -atokserver
97 This option specifies the hostname of the atok server to be
98 used for conversion.
99 -font ascii-font
101 This option specifies the default font to be used for display‐
102 ing ASCII text.
103 -kanjifont kanji-font
105 This option specifies the default font to be used for display‐
106 ing Kanji text.
107 -kanafont kana-font
109 This option specifies the default font to be used for display‐
110 ing Kana text.
111 -/+kinput
113 This option enables/disables use of kinput protocol family
114 (i.e. kinput protocol, kinput2 protocol, jinput protocol and
115 xlc protocol).
116 -/+ximp This option enables/disables use of XIMP protocol.
118 -/+xim This option enables/disables use of X Input Method Protocol.
120 -bc Kinput protocol, which is one of the communication protocols
122 kinput2 supports, uses X window's selection mechanism to notify
123 other clients of front-end's existence. This option forces
124 kinput2 to use selection ``JAPANESE_CONVERSION'' (which is not
125 a standard selection name) as well as ``_JAPANESE_CONVERSION''.
126 This is for backward compatibility, since many of the applica‐
127 tions that connect with kinput still use this non-standard
128 selection.
129 -tbheightP title-bar-height
131 This option specifies the height (in pixels) of the titlebar
132 attached to popup shells such as candidate selection window.
133 Kinput2 uses this value to compute the correct popup location
134 of these windows.
135
137 Below is the widget hierarchy of kinput2.
138 Kinput2 kinput2
139 ConversionManager convmanager
140 KinputProtocol kinputprotocol
141 XimpProtocol ximpprotocol
142 IMProtocol improtocol
143 SeparateConversion converter
144 CcWnn inputObj
145 Canna inputObj
146 Sj3 inputObj
147 JpWcharDisplay displayObj
148 Form form
149 ICLabel mode
150 JpWcharDisplay display
151 Canvas text
152 TransientShell selectionShell
153 CandidatePanel selection
154 JpWcharDisplay display
155 TransientShell auxShell
156 AuxPanel aux
157 JpWcharDisplay display
158 OffTheSpotConversion converter
159 CcWnn inputObj
160 Canna inputObj
161 Sj3 inputObj
162 JpWcharDisplay displayObj
163 AdoptedShell modeShell
164 ICLabel mode
165 JpWcharDisplay display
166 CanvasShell text
167 TransientShell selectionShell
168 CandidatePanel selection
169 JpWcharDisplay display
170 TransientShell auxShell
171 AuxPanel aux
172 JpWcharDisplay display
173 OverTheSpotConversion converter
174 CcWnn inputObj
175 Canna inputObj
176 Sj3 inputObj
177 JpWcharDisplay displayObj
178 TransientShell selectionShell
179 CandidatePanel selection
180 JpWcharDisplay display
181 TransientShell auxShell
182 AuxPanel aux
183 JpWcharDisplay display
184 AdoptedShell modeShell
185 ICLabel mode
186 JpWcharDisplay display
187 TransientShell modeShell
188 ICLabel mode
189 JpWcharDisplay display
190 CanvasShell text
191
193 There are too many resources to describe here, but you don't have to
194 know most of them. So here is a brief description of resources which
195 you might want to set.
196 Kinput2 application resource:
198 conversionEngine
200 This resource specifies which conversion engine to use. You
201 can specify one of ``wnn'', ``canna'', ``sj3'' or ``atok''.
202 ConversionControl widget (which is a superclass of SeparateConversion,
204 OffTheSpotConversion and OverTheSpotConversion) resource:
205 sendbackKeyPress
207 If this resource is ``true'', the KeyPress events intercepted
208 but unused by kinput2 are sent back to the client when there is
209 no conversion text. Although this feature is convenient, it
210 might confuse some clients since none of corresponding KeyRe‐
211 lease events are sent. Also, since the ``send_event'' flag of
212 those events are true, some clients do not accept events sent
213 back by kinput2. For example, kterm doesn't accept those
214 events without specifying
215 KTerm*allowSendEvents: true
216 in a resource file.
217 The default of sendbackKeyPress resource is true.
218 titlebarHeight
220 This resource specifies the height of a title bar which is
221 attached to various popup shell windows, such as candicate
222 selection. When computing the location of these windows, kin‐
223 put2 uses this value to pop up them at correct position.
224 The default is 0P.
225 OverTheSpotConversion widget resources:
227 shrinkWindow
229 If this resource is ``true'', the width of on-the-spot conver‐
230 sion window shrinks according to the length of the text on it.
231 Otherwise, the window never shrinks. If the performance of
232 Xserver on window resizing is poor, you may consider setting
233 this resources to false. The default is true.
234 modeLocation
236 This resource specifies the location of status widget in case
237 of over-the-spot type conversion. Unless client specifies the
238 location explicitly, the location of the status widget is
239 determined by this resource. If the value of this resource is
240 ``topleft'', the widget is placed at the top left of the client
241 window. You can also specify ``topright'', ``bottomleft'' and
242 ``bottomright''. If the value is ``tracktext'', the widget is
243 placed just under the cursor position, and moves according to
244 the cursor. However, if the region available for conversion is
245 too small, status is placed at the bottom left of the client
246 area. If the value is ``none'', the status widget will never
247 appear.
248 The default is ``tracktext''.
249 modeBorderForeground
251 If this resource is ``true'', the color of status widget is
252 forced to be same as the foreground color of the widget.
253 The default is false.
254 useOverrideShellForMode
256 If this resource is ``true'', the status widget becomes an
257 instance of OverriddeShell, instead of the default Tran‐
258 sientShell. Turn this resource on if you encounter a strange
259 phenomenon that the status widget keeps flickering and you
260 cannnot enter any text. This is caused by (incorrect) focus
261 management of your window manager, and setting this resource
262 will stop any window management for the widget. The result is
263 that the widget will be totally ignored by the window manager,
264 meaning you cannot move, resize, raise nor lower the widget.
265 The default is false.
266 OnTheSpotConversion widget resources:
268 feedbackAttributes
270 This resource specifies the display attributes of preedit
271 string when on-the-spot input style is used. In on-the-spot
272 style, it is a client's responsibility to draw preedit string,
273 and kinput2 sends some hints on how it should be drawn, which
274 is controled by this resource. The value of this resource
275 should be a comma-separated list of 4 elements, and each ele‐
276 ment represents the drawing hint of specific type of string.
277 They represent the hints for not-yet-converted string, for con‐
278 verted string, for converted string which belongs to the cur‐
279 rent clause, for converted string belonging to the current sub-
280 clause, in that order. Each element consists of zero or more
281 drawing attributes, which are `R' (reverse), `U' (underline),
282 `H' (highlight), `P' (primary), `S' (secondary) or `T' (ter‐
283 tiary). You should consult the Xlib document for the meaning
284 of these attributes (see the section about preedit draw call‐
285 back). The default is ``U,,R,H'', which is close to the draw‐
286 ing attributes used by other input styles.
287 CcWnn (conversion widget using Wnn) resources:
289 jserver
291 This resource specifies the hostname of the (primary) jserver
292 to be used for conversion. If not specified, value of environ‐
293 ment variable ``JSERVER'' is used.
294 jserver2nd
296 This resource specifies the hostname of the secondary jserver,
297 which is used if the primary server is down. If not specified,
298 kinput2 doesn't use secondary server.
299 wnnEnvrc4
301 This resource specifies the filename of the Wnn conversion
302 environment initialization file. This file is used when the Wnn
303 server (jserver) is version 4. See documents of Wnn for the
304 format of the file. The default is /usr/local/lib/wnn/wnnen‐
305 vrc.
306 wnnEnvrc6
308 This resource also specifies the filename of the Wnn conversion
309 environment initialization file. This file is used when the Wnn
310 server (jserver) is version 6. See documents of Wnn for the
311 format of the file.
312 wnnEnvrc
314 This resource is provided for backward compatibility. Use
315 wnnEnvrc4 or wnnEnvrc6 instead.
316 ccdef
318 This resource specifies the input character conversion rule
319 file. The default is /usr/lib/X11/ccdef/ccdef.kinput2.
320 Canna (conversion widget using Canna) resources:
322 cannahost
324 This resource specifies the hostname of the canna server to be
325 used.
326 cannafile
328 This resource specifies Canna conversion customization file.
329 Sj3 (conversion widget using SJ3) resources:
331 sj3serv
333 This resource specifies the hostname of the (primary) sj3serv
334 to be used for conversion. If not specified, value of environ‐
335 ment variable ``SJ3SERV'' is used.
336 sj3serv2
338 This resource specifies the hostname of the secondary sj3serv,
339 which is used if the primary server is down.
340 rcfile
342 This resource specifies the filename of the Sj3 conversion cus‐
343 tomization file. The default is /usr/lib/X11/sj3def/sjrc.
344 rkfile
346 This resource specifies the Romaji-Kana conversion rule file.
347 The default is /usr/lib/X11/sj3def/sjrk.
348 Atok (conversion widget using Atok) resources:
350 server
352 This resource specifies the hostname of the atok server to be
353 used for conversion.
354 port
356 This resource specifies the port number of the atok server.
357 conf
359 This resource specifies the name of atok configuration file.
360 style
362 This resource specifies the name of atok style file.
363 JpWcharDisplay (widget for drawing Japanese text) resources:
365 font, kanjiFont, kanaFont
367 These resource specifies the font to be used for displaying
368 ASCII, Kanji and Kana text, respectively. Since kinput2
369 changes fonts dynamically by client requests, the fonts speci‐
370 fied by these resources might not be used. If not specified,
371 the following fonts are used.
372 -*-fixed-medium-r-normal--14-*-*-*-c-*-iso8859-1
373 -*-fixed-medium-r-normal--14-*-*-*-c-*-jisx0208.1983-0
374 -*-fixed-medium-r-normal--14-*-*-*-c-*-jisx0201.1976-0
375 KinputProtocol (widget for handling kinput protocol family - kinput,
377 kinput2, jinput and xlc protocol) resources:
378 backwardCompatible
380 All of the protocols in kinput protocol family use X window's
381 selection mechanism to notify other clients of front-end's
382 existence. If this resource is ``true'', kinput2 uses selec‐
383 tion ``JAPANESE_CONVERSION'' (which is not a standard selection
384 name) as well as ``_JAPANESE_CONVERSION''. This is for back‐
385 ward compatibility, since many of the applications using these
386 protocols still use this non-standard selection.
387 The default is true.
388 xlcConversionStartKey
390 This resource specifies the key that starts the conversion.
391 The key is a hint for the clients using xlc protocol to deter‐
392 mine when they should request conversion to kinput2. The syn‐
393 tax of the specification is a subset of the translation table
394 syntax:
395 modifier-names<Key>keysym-name
396 where modifier-names is a combination of Shift, Lock, Meta, Alt
397 and Mod[1-5].
398 The default is Shift<Key>space.
399 XimpProtocol and IMProtocol (which handle XIMP protocol and X Input
401 Method Protocol) resources:
402 conversionStartKeys
404 This resource specifies the keys that start the conversion.
405 The syntax of the specification is a subset of the translation
406 table syntax:
407 modifier-names<Key>keysym-name
408 where modifier-names is a combination of Ctrl, Shift, Lock,
409 Meta, Alt and Mod[1-5]. A '~' can precede each modifier name,
410 meaning the modifier must not be asserted. For example, if the
411 conversion start key is ``Kanji'' key with shift key pressed
412 and control key not pressed (other modifier keys may be pressed
413 or not), the specification is:
414 Shift ~Ctrl<Key>Kanji
415 Multiple keys can be specified by separating them with new‐
416 lines.
417 The default is as follows:
418 Shift<Key>space \n\
419 Ctrl<Key>Kanji
420 defaultFontList
422 This resource specifies the default fonts to be used if the
423 client does not specify fonts to be used. The default is
424 -*-fixed-medium-r-normal--14-*-*-*-c-*.
425
427 When using X Input Method Protocol, you have to specify the name of the
428 input server you want to use. This can be done by setting ``input‐
429 Method'' resource or setting XMODIFIERS environment variable. Since
430 some clients don't regard inputMethod resource while other clients
431 ignore XMODIFIERS variable, so it is a good idea to set both of them.
432 To use kinput2, you should add the following line to your resource file
434 (such as .Xresources or .Xdefaults):
435 *inputMethod: kinput2
436 and, set XMODIFIERS to ``@im=kinput2''.
437 setenv XMODIFIERS "@im=kinput2" (for csh)
438 XMODIFIERS="@im=kinput2"; export XMODIFIERS (for sh)
439
441 Wnn documents, Canna documents, Sj3 documents, XIMP protocol specifica‐
442 tion, The Input Method Protocol
443
445 Copyright 1988, 1989, 1990, 1991, 1992, 1994 Software Research Associates, Inc.
446 Copyright 1991 NEC Corporation, Tokyo, Japan.
447 Copyright 1991 Sony Corporation
448 Copyright 1998 MORIBE, Hideyuki
449 Copyright 1999 Kazuki YASUMATSU
450 Copyright 1999 Justsystem Corporation, Japan.
451
453 Makoto Ishisone, Software Research Associates, Inc.
454 Akira Kon, NEC Corporation
455 Naoshi Suzuki, Sony Corporation
456 MORIBE, Hideyuki
457 Kazuki YASUMATSU
458 Atsushi Irisawa
459X Version 11 24 March 1999 KINPUT2(1)