Mercurial > kinput2.yaz
comparison cmd/kinput2.man @ 0:92745d501b9a
initial import from kinput2-v3.1
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Mon, 08 Mar 2010 04:44:30 +0900 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:92745d501b9a |
---|---|
1 .\" $Id: kinput2.man,v 1.20 1999/09/13 08:40:31 ishisone Exp $ | |
2 .TH KINPUT2 1 "24 March 1999" "X Version 11" | |
3 .SH NAME | |
4 kinput2 \- kanji input server for X11 | |
5 .SH SYNOPSIS | |
6 \fBkinput2\fP [-options...] | |
7 .SH DESCRIPTION | |
8 .I Kinput2 | |
9 is an X window application to input Japanese text. | |
10 It acts as a front-end for other applications that want | |
11 kana-kanji conversion. | |
12 .PP | |
13 When invoked, after some initialization (which will take about a few to | |
14 30 seconds depending on your machine) \fIkinput2\fP waits quietly for a | |
15 Japanese text input request from another client (i.e. no windows | |
16 appear). | |
17 When \fIkinput2\fP receives a request, it pops up a window and | |
18 starts conversion process. It sends the converted text back to the | |
19 client when the text is fixed. | |
20 .PP | |
21 .I Kinput2 | |
22 has some big improvements over its predecessor, kinput, which | |
23 was contributed to X11R4. | |
24 .TP 8 | |
25 \fBOver-the-spot/On-the-spot Input\fP | |
26 These features enable conversion process to be done at cursor position, | |
27 avoiding unnecessary movement of eyes between cursor position and conversion | |
28 window. | |
29 .I Kinput2 | |
30 also supports root window style input and off-the-spot style input. | |
31 .TP 8 | |
32 \fBMultiple Protocol Support\fP | |
33 .I Kinput2 | |
34 supports several conversion protocols between front-end and | |
35 client. Supported protocols are: | |
36 .nf | |
37 kinput protocol | |
38 kinput2 protocol | |
39 Matsushita jinput protocol | |
40 Sony xlc protocol | |
41 XIMP protocol | |
42 X Input Method Protocol (X Consortium standard) | |
43 .fi | |
44 .TP 8 | |
45 \fBMultiple Conversion Engine Support\fP | |
46 .I Kinput2 | |
47 can use 4 different conversion engines, Wnn, Canna, Sj3 and Atok. | |
48 You can choose one at compilation time, or at run time. | |
49 .TP 8 | |
50 \fBKinput Compatibility\fP | |
51 .I Kinput2 | |
52 is fully upward-compatible with kinput, so applications which use | |
53 kinput as the front-end can also use \fIkinput2\fP. | |
54 In this case, the applications cannot take advantage of over-the-spot | |
55 conversion, though. | |
56 .SH OPTIONS | |
57 .I kinput2 | |
58 accepts all of the standard X Toolkit command line options. | |
59 The following options are accepted as well. | |
60 .TP 8 | |
61 \fB\-wnn\fP | |
62 This option specifies that Wnn jserver is used as the conversion engine. | |
63 .TP 8 | |
64 \fB\-jserver\fP | |
65 This option specifies the hostname of the jserver to be used for conversion. | |
66 .TP 8 | |
67 \fB\-ccdef\fP | |
68 This option specifies the input character conversion rule file. | |
69 .TP 8 | |
70 \fB\-wnnenvrc4\fP | |
71 This option specifies the Wnn convertion environment initialization | |
72 file (wnnenvrc) for Wnn version 4. | |
73 .TP 8 | |
74 \fB\-wnnenvrc6\fP | |
75 This option is similar to \-wnenvrc4, but for Wnn version 6. | |
76 .TP 8 | |
77 \fB\-canna\fP | |
78 This option specifies that Canna conversion server (irohaserver) is used as | |
79 the conversion engine. | |
80 .TP 8 | |
81 \fB\-cannaserver\fP | |
82 This option specifies the hostname of Canna conversion server. | |
83 .TP 8 | |
84 \fB\-cannafile\fP | |
85 This option specifies Canna conversion customization file. | |
86 .TP 8 | |
87 \fB\-sj3\fP | |
88 This option specifies that Sj3 conversion server (sj3serv) is used as | |
89 the conversion engine. | |
90 .TP 8 | |
91 \fB\-sj3serv\fP | |
92 This option specifies the hostname of the primary sj3 conversion server. | |
93 .TP 8 | |
94 \fB\-sj3serv2\fP | |
95 This option specifies the hostname of the secondary sj3 server. The secondary | |
96 server is used when \fIkinput2\fP cannot connect to the primary server. | |
97 .TP 8 | |
98 \fB\-atok\fP | |
99 This option specifies that Atok server is used as the conversion engine. | |
100 .TP 8 | |
101 \fB\-atokserver\fP | |
102 This option specifies the hostname of the atok server to be used for conversion. | |
103 .TP 8 | |
104 \fB\-font\fP \fIascii-font\fP | |
105 This option specifies the default font to be used for displaying ASCII text. | |
106 .TP 8 | |
107 \fB\-kanjifont\fP \fIkanji-font\fP | |
108 This option specifies the default font to be used for displaying Kanji text. | |
109 .TP 8 | |
110 \fB\-kanafont\fP \fIkana-font\fP | |
111 This option specifies the default font to be used for displaying Kana text. | |
112 .TP 8 | |
113 \fB\-/+kinput\fP | |
114 This option enables/disables use of kinput protocol family (i.e. | |
115 kinput protocol, kinput2 protocol, jinput protocol and xlc protocol). | |
116 .TP 8 | |
117 \fB\-/+ximp\fP | |
118 This option enables/disables use of XIMP protocol. | |
119 .TP 8 | |
120 \fB\-/+xim\fP | |
121 This option enables/disables use of X Input Method Protocol. | |
122 .TP 8 | |
123 \fB\-bc\fP | |
124 Kinput protocol, which is one of the communication protocols | |
125 \fIkinput2\fP supports, | |
126 uses X window's selection mechanism to notify other clients of | |
127 front-end's existence. | |
128 This option forces \fIkinput2\fP to use selection ``JAPANESE_CONVERSION'' | |
129 (which is not a standard selection name) as well as ``_JAPANESE_CONVERSION''. | |
130 This is for backward compatibility, since many of the applications that | |
131 connect with kinput still use this non-standard selection. | |
132 .TP 8 | |
133 \fB\-tbheight\P \fItitle-bar-height\fP | |
134 This option specifies the height (in pixels) of the titlebar | |
135 attached to popup shells such as candidate selection window. | |
136 .I Kinput2 | |
137 uses this value to compute the correct popup location of these windows. | |
138 .SH WIDGET TREE | |
139 Below is the widget hierarchy of \fIkinput2\fP. | |
140 .nf | |
141 .ta 0.5i 1.0i 1.5i 2.0i 2.5i 3.0i 3.5i 4.0i | |
142 Kinput2 kinput2 | |
143 ConversionManager convmanager | |
144 KinputProtocol kinputprotocol | |
145 XimpProtocol ximpprotocol | |
146 IMProtocol improtocol | |
147 SeparateConversion converter | |
148 CcWnn inputObj | |
149 Canna inputObj | |
150 Sj3 inputObj | |
151 JpWcharDisplay displayObj | |
152 Form form | |
153 ICLabel mode | |
154 JpWcharDisplay display | |
155 Canvas text | |
156 TransientShell selectionShell | |
157 CandidatePanel selection | |
158 JpWcharDisplay display | |
159 TransientShell auxShell | |
160 AuxPanel aux | |
161 JpWcharDisplay display | |
162 OffTheSpotConversion converter | |
163 CcWnn inputObj | |
164 Canna inputObj | |
165 Sj3 inputObj | |
166 JpWcharDisplay displayObj | |
167 AdoptedShell modeShell | |
168 ICLabel mode | |
169 JpWcharDisplay display | |
170 CanvasShell text | |
171 TransientShell selectionShell | |
172 CandidatePanel selection | |
173 JpWcharDisplay display | |
174 TransientShell auxShell | |
175 AuxPanel aux | |
176 JpWcharDisplay display | |
177 OverTheSpotConversion converter | |
178 CcWnn inputObj | |
179 Canna inputObj | |
180 Sj3 inputObj | |
181 JpWcharDisplay displayObj | |
182 TransientShell selectionShell | |
183 CandidatePanel selection | |
184 JpWcharDisplay display | |
185 TransientShell auxShell | |
186 AuxPanel aux | |
187 JpWcharDisplay display | |
188 AdoptedShell modeShell | |
189 ICLabel mode | |
190 JpWcharDisplay display | |
191 TransientShell modeShell | |
192 ICLabel mode | |
193 JpWcharDisplay display | |
194 CanvasShell text | |
195 .fi | |
196 .SH RESOURCES | |
197 There are too many resources to describe here, but you don't have to | |
198 know most of them. | |
199 So here is a brief description of resources which you might want to set. | |
200 .PP | |
201 \fBKinput2\fP application resource: | |
202 .RS 4 | |
203 .TP 4 | |
204 \fBconversionEngine\fP | |
205 This resource specifies which conversion engine to use. | |
206 You can specify one of ``wnn'', ``canna'', ``sj3'' or ``atok''. | |
207 .RE | |
208 .PP | |
209 .B ConversionControl | |
210 widget (which is a superclass | |
211 of SeparateConversion, OffTheSpotConversion and OverTheSpotConversion) | |
212 resource: | |
213 .RS 4 | |
214 .TP 4 | |
215 \fBsendbackKeyPress\fP | |
216 If this resource is ``true'', the KeyPress events intercepted but unused | |
217 by \fIkinput2\fP are sent back to the client when there is no conversion text. | |
218 Although this feature is convenient, it might confuse some clients | |
219 since none of corresponding KeyRelease events are sent. | |
220 Also, since the ``send_event'' flag of those events are true, some | |
221 clients do not accept events sent back by \fIkinput2\fP. | |
222 For example, kterm doesn't accept those events without specifying | |
223 .nf | |
224 KTerm*allowSendEvents: true | |
225 .fi | |
226 in a resource file. | |
227 .br | |
228 The default of \fBsendbackKeyPress\fP resource is \fBtrue\fP. | |
229 .TP 4 | |
230 \fBtitlebarHeight\fP | |
231 This resource specifies the height of a title bar which is attached | |
232 to various popup shell windows, such as candicate selection. | |
233 When computing the location of these windows, | |
234 .I kinput2 | |
235 uses this value to pop up them at correct position. | |
236 .br | |
237 The default is \fB0\P. | |
238 .RE | |
239 .PP | |
240 .B OverTheSpotConversion | |
241 widget resources: | |
242 .RS 4 | |
243 .TP 4 | |
244 \fBshrinkWindow\fP | |
245 If this resource is ``true'', the width of on-the-spot conversion window | |
246 shrinks according to the length of the text on it. Otherwise, | |
247 the window never shrinks. | |
248 If the performance of Xserver on window resizing is poor, | |
249 you may consider setting this resources to false. | |
250 The default is \fBtrue\fP. | |
251 .TP 4 | |
252 \fBmodeLocation\fP | |
253 This resource specifies the location of status widget in case of | |
254 over-the-spot type conversion. | |
255 Unless client specifies the location explicitly, the location of | |
256 the status widget is determined by this resource. | |
257 If the value of this resource is ``topleft'', the widget is placed at the | |
258 top left of the client window. You can also specify | |
259 ``topright'', ``bottomleft'' and ``bottomright''. | |
260 If the value is ``tracktext'', the widget is placed just under the cursor | |
261 position, and moves according to the cursor. However, if the | |
262 region available for conversion is too small, status is placed at | |
263 the bottom left of the client area. | |
264 If the value is ``none'', the status widget will never appear. | |
265 .br | |
266 The default is ``tracktext''. | |
267 .TP 4 | |
268 \fBmodeBorderForeground\fP | |
269 If this resource is ``true'', the color of status widget is forced | |
270 to be same as the foreground color of the widget. | |
271 .br | |
272 The default is \fBfalse\fP. | |
273 .TP 4 | |
274 \fBuseOverrideShellForMode\fP | |
275 If this resource is ``true'', the status widget becomes an instance of | |
276 OverriddeShell, instead of the default TransientShell. | |
277 Turn this resource on if you encounter a strange phenomenon that | |
278 the status widget keeps flickering and you cannnot enter any text. | |
279 This is caused by (incorrect) focus management of your window manager, | |
280 and setting this resource will stop any window management for the widget. | |
281 The result is that the widget will be totally ignored by the window manager, | |
282 meaning you cannot move, resize, raise nor lower the widget. | |
283 .br | |
284 The default is \fBfalse\fP. | |
285 .RE | |
286 .PP | |
287 .B OnTheSpotConversion | |
288 widget resources: | |
289 .RS 4 | |
290 .TP 4 | |
291 \fBfeedbackAttributes\fP | |
292 This resource specifies the display attributes of preedit string when | |
293 on-the-spot input style is used. In on-the-spot style, it is a client's | |
294 responsibility to draw preedit string, and kinput2 sends some hints | |
295 on how it should be drawn, which is controled by this resource. | |
296 The value of this resource should be a comma-separated list of 4 elements, | |
297 and each element represents the drawing hint of specific type of string. | |
298 They represent the hints for not-yet-converted string, | |
299 for converted string, for converted string which belongs to the current | |
300 clause, for converted string belonging to the current sub-clause, in that | |
301 order. | |
302 Each element consists of zero or more drawing attributes, which are `R' | |
303 (reverse), `U' (underline), `H' (highlight), `P' (primary), `S' (secondary) | |
304 or `T' (tertiary). You should consult the Xlib document for the meaning | |
305 of these attributes (see the section about preedit draw callback). | |
306 The default is ``U,,R,H'', which is close to the drawing attributes used | |
307 by other input styles. | |
308 .RE | |
309 .PP | |
310 .B CcWnn | |
311 (conversion widget using Wnn) resources: | |
312 .RS 4 | |
313 .TP 4 | |
314 \fBjserver\fP | |
315 This resource specifies the hostname of the (primary) jserver to be used | |
316 for conversion. If not specified, value of environment variable ``JSERVER'' | |
317 is used. | |
318 .TP 4 | |
319 \fBjserver2nd\fP | |
320 This resource specifies the hostname of the secondary jserver, which is | |
321 used if the primary server is down. If not specified, \fIkinput2\fP doesn't | |
322 use secondary server. | |
323 .TP 4 | |
324 \fBwnnEnvrc4\fP | |
325 This resource specifies the filename of the Wnn conversion environment | |
326 initialization file. This file is used when the Wnn server (jserver) is | |
327 version 4. See documents of Wnn for the format of the file. | |
328 The default is \fB/usr/local/lib/wnn/wnnenvrc\fP. | |
329 .TP 4 | |
330 \fBwnnEnvrc6\fP | |
331 This resource also specifies the filename of the Wnn conversion environment | |
332 initialization file. This file is used when the Wnn server (jserver) is | |
333 version 6. See documents of Wnn for the format of the file. | |
334 .TP 4 | |
335 \fBwnnEnvrc\fP | |
336 This resource is provided for backward compatibility. | |
337 Use \fBwnnEnvrc4\fP or \fBwnnEnvrc6\fP instead. | |
338 .TP 4 | |
339 \fBccdef\fP | |
340 This resource specifies the input character conversion rule file. | |
341 The default is \fB/usr/lib/X11/ccdef/ccdef.kinput2\fP. | |
342 .RE | |
343 .PP | |
344 .B Canna | |
345 (conversion widget using Canna) resources: | |
346 .RS 4 | |
347 .TP 4 | |
348 \fBcannahost\fP | |
349 This resource specifies the hostname of the canna server to be used. | |
350 .TP 4 | |
351 \fBcannafile\fP | |
352 This resource specifies Canna conversion customization file. | |
353 .RE | |
354 .PP | |
355 .B Sj3 | |
356 (conversion widget using SJ3) resources: | |
357 .RS 4 | |
358 .TP 4 | |
359 \fBsj3serv\fP | |
360 This resource specifies the hostname of the (primary) sj3serv to be used | |
361 for conversion. If not specified, value of environment variable ``SJ3SERV'' | |
362 is used. | |
363 .TP 4 | |
364 \fBsj3serv2\fP | |
365 This resource specifies the hostname of the secondary sj3serv, which is | |
366 used if the primary server is down. | |
367 .TP 4 | |
368 \fBrcfile\fP | |
369 This resource specifies the filename of the Sj3 conversion customization | |
370 file. The default is \fB/usr/lib/X11/sj3def/sjrc\fP. | |
371 .TP 4 | |
372 \fBrkfile\fP | |
373 This resource specifies the Romaji-Kana conversion rule file. | |
374 The default is \fB/usr/lib/X11/sj3def/sjrk\fP. | |
375 .RE | |
376 .PP | |
377 .B Atok | |
378 (conversion widget using Atok) resources: | |
379 .RS 4 | |
380 .TP 4 | |
381 \fBserver\fP | |
382 This resource specifies the hostname of the atok server to be used | |
383 for conversion. | |
384 .TP 4 | |
385 \fBport\fP | |
386 This resource specifies the port number of the atok server. | |
387 .TP 4 | |
388 \fBconf\fP | |
389 This resource specifies the name of atok configuration file. | |
390 .TP 4 | |
391 \fBstyle\fP | |
392 This resource specifies the name of atok style file. | |
393 .RE | |
394 .PP | |
395 .B JpWcharDisplay | |
396 (widget for drawing Japanese text) resources: | |
397 .RS 4 | |
398 .TP 4 | |
399 \fBfont\fP, \fBkanjiFont\fP, \fBkanaFont\fP | |
400 These resource specifies the font to be used for displaying ASCII, | |
401 Kanji and Kana text, respectively. | |
402 Since \fIkinput2\fP changes fonts dynamically by client requests, | |
403 the fonts specified by these resources might not be used. | |
404 If not specified, the following fonts are used. | |
405 .nf | |
406 -*-fixed-medium-r-normal--14-*-*-*-c-*-iso8859-1 | |
407 -*-fixed-medium-r-normal--14-*-*-*-c-*-jisx0208.1983-0 | |
408 -*-fixed-medium-r-normal--14-*-*-*-c-*-jisx0201.1976-0 | |
409 .fi | |
410 .RE | |
411 .PP | |
412 .B KinputProtocol | |
413 (widget for handling kinput protocol family \- kinput, kinput2, | |
414 jinput and xlc protocol) resources: | |
415 .RS 4 | |
416 .TP 4 | |
417 \fBbackwardCompatible\fP | |
418 All of the protocols in kinput protocol family | |
419 use X window's selection mechanism to notify other clients of | |
420 front-end's existence. | |
421 If this resource is ``true'', \fIkinput2\fP uses selection ``JAPANESE_CONVERSION'' | |
422 (which is not a standard selection name) as well as ``_JAPANESE_CONVERSION''. | |
423 This is for backward compatibility, since many of the applications | |
424 using these protocols still use this non-standard selection. | |
425 .br | |
426 The default is \fBtrue\fP. | |
427 .TP 4 | |
428 \fBxlcConversionStartKey\fP | |
429 This resource specifies the key that starts the conversion. | |
430 The key is a hint for the clients using xlc protocol to determine when | |
431 they should request conversion to \fIkinput2\fP. | |
432 The syntax of the specification is a subset of the translation table syntax: | |
433 .nf | |
434 \fImodifier-names\fP<Key>\fIkeysym-name\fP | |
435 .fi | |
436 where modifier-names is a combination of \fBShift\fP, \fBLock\fP, \fBMeta\fP, | |
437 \fBAlt\fP and \fBMod[1-5]\fP. | |
438 .br | |
439 The default is \fBShift<Key>space\fP. | |
440 .RE | |
441 .PP | |
442 \fBXimpProtocol\fP and \fBIMProtocol\fP | |
443 (which handle XIMP protocol and X Input Method Protocol) resources: | |
444 .RS 4 | |
445 .TP 4 | |
446 \fBconversionStartKeys\fP | |
447 This resource specifies the keys that start the conversion. | |
448 The syntax of the specification is a subset of the translation table syntax: | |
449 .nf | |
450 \fImodifier-names\fP<Key>\fIkeysym-name\fP | |
451 .fi | |
452 where modifier-names is a combination of \fBCtrl\fP, \fBShift\fP, \fBLock\fP, | |
453 \fBMeta\fP, \fBAlt\fP and \fBMod[1-5]\fP. A '~' can precede each modifier | |
454 name, meaning the modifier must not be asserted. | |
455 For example, if the conversion start key is ``Kanji'' key with shift key | |
456 pressed and control key not pressed (other modifier keys may be pressed or | |
457 not), the specification is: | |
458 .nf | |
459 Shift ~Ctrl<Key>Kanji | |
460 .fi | |
461 Multiple keys can be specified by separating them with newlines. | |
462 .br | |
463 The default is as follows: | |
464 .nf | |
465 Shift<Key>space \en\e | |
466 Ctrl<Key>Kanji | |
467 .fi | |
468 .TP 4 | |
469 \fBdefaultFontList\fP | |
470 This resource specifies the default fonts to be used if the client | |
471 does not specify fonts to be used. | |
472 The default is \fB-*-fixed-medium-r-normal--14-*-*-*-c-*\fP. | |
473 .RE | |
474 .SH "CLIENT SETUP" | |
475 When using X Input Method Protocol, you have to specify the | |
476 name of the input server you want to use. | |
477 This can be done by setting ``\fBinputMethod\fP'' resource | |
478 or setting \fBXMODIFIERS\fP environment variable. | |
479 Since some clients don't regard inputMethod resource while other | |
480 clients ignore XMODIFIERS variable, so it is a good idea to set both of | |
481 them. | |
482 .PP | |
483 To use kinput2, you should add the following line to your | |
484 resource file (such as .Xresources or .Xdefaults): | |
485 .nf | |
486 *inputMethod: kinput2 | |
487 .fi | |
488 and, set XMODIFIERS to ``@im=kinput2''. | |
489 .nf | |
490 setenv XMODIFIERS "@im=kinput2"\ \ \ (for csh) | |
491 XMODIFIERS="@im=kinput2"; export XMODIFIERS\ \ \ (for sh) | |
492 .fi | |
493 .SH "SEE ALSO" | |
494 Wnn documents, Canna documents, Sj3 documents, | |
495 XIMP protocol specification, | |
496 The Input Method Protocol | |
497 .SH COPYRIGHT | |
498 .nf | |
499 Copyright 1988, 1989, 1990, 1991, 1992, 1994 Software Research Associates, Inc. | |
500 Copyright 1991 NEC Corporation, Tokyo, Japan. | |
501 Copyright 1991 Sony Corporation | |
502 Copyright 1998 MORIBE, Hideyuki | |
503 Copyright 1999 Kazuki YASUMATSU | |
504 Copyright 1999 Justsystem Corporation, Japan. | |
505 .fi | |
506 .SH AUTHORS | |
507 .nf | |
508 Makoto Ishisone, Software Research Associates, Inc. | |
509 Akira Kon, NEC Corporation | |
510 Naoshi Suzuki, Sony Corporation | |
511 MORIBE, Hideyuki | |
512 Kazuki YASUMATSU | |
513 Atsushi Irisawa | |
514 .fi |