Mercurial > kinput2.yaz
comparison README @ 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 | |
2 kinput2 version 3.1 | |
3 | |
4 -- an input server for easy input of Japanese text -- | |
5 | |
6 | |
7 Kinput2 is an input server for X11 applications that want Japanese | |
8 text input. | |
9 | |
10 A client that wants kana-kanji conversion service for Japanese text | |
11 sends a request to kinput2. Kinput2 receives the request, does | |
12 kana-kanji conversion, and sends the converted text back to the | |
13 client. | |
14 | |
15 | |
16 * Kinput2 Features | |
17 | |
18 Upward-Compatible with Kinput: | |
19 Kinput2 is fully upward-compatible with kinput, which was | |
20 contributed to X11R4. Applications using kinput to input | |
21 Japanese can also use kinput2 without any modification. | |
22 | |
23 Multiple Input Style: | |
24 Kinput2 supports 4 input styles: root-window, off-the-spot, | |
25 over-the-spot and on-the-spot. | |
26 | |
27 Multiple Protocol: | |
28 There are several protocols which define how the communication | |
29 between input server and clients should be done. Kinput2 | |
30 implements following protocols: | |
31 | |
32 * kinput protocol | |
33 * kinput2 protocol | |
34 * Matsushita's jinput protocol | |
35 * Sony's xlc protocol | |
36 * XIMP protocol (X11R5 Ximp implementation) | |
37 * X Input Method Protocol (X11R6 standard) | |
38 | |
39 If a client can speak at least one of them, the client can | |
40 communicate with kinput2 and get Japanese text. | |
41 | |
42 The support of X Input Method Protocol is not yet fully tested | |
43 and might have many bugs. | |
44 | |
45 Multiple Conversion Engine: | |
46 Kinput2 doesn't do actual kana-kanji conversion itself. There | |
47 are several conversion servers available, so kinput2 uses them | |
48 as its conversion engine. Kinput2 can connect to the | |
49 following servers: | |
50 | |
51 * Wnn jserver (version 4, 6 or 7) | |
52 * Canna cannaserver | |
53 * Sj3 sj3serv | |
54 * Atok server | |
55 | |
56 Canna and Sj3 are contributed to X11R6. Wnn is contributed | |
57 to X11R5. | |
58 | |
59 You can choose which server to use at compilation time. If | |
60 you choose more than one, you can choose your favorite engine | |
61 by a command line option when you invoke kinput2. | |
62 | |
63 | |
64 +-------------------------+ | |
65 +---------+ +---->| jserver | | |
66 | client1 |<------+ +---------+ | | (Wnn conversion daemon) | | |
67 +---------+ +--->| |<---+ +-------------------------+ | |
68 | kinput2 |<-----+ | |
69 +---------+ +--->| |<--+ | | |
70 | client2 |<------+ +---------+ | | +-------------------------+ | |
71 +---------+ | +-->| irohaserver | | |
72 | |(Canna conversion daemon)| | |
73 | +-------------------------+ | |
74 | | |
75 | +-------------------------+ | |
76 +----->| sj3serv | | |
77 | (SJ3 conversion daemon) | | |
78 +-------------------------+ | |
79 | |
80 | |
81 * Directories | |
82 | |
83 This directory contains the following subdirectories: | |
84 | |
85 lib/ source code for a library kinput2 uses | |
86 include/ header files | |
87 cmd/ kinput2 source code | |
88 doc/ various documents | |
89 client/ sample client library and patch to kterm | |
90 ccdef/ character conversion rule files (for Wnn) | |
91 sj3def/ SJ3 user customization files | |
92 | |
93 | |
94 * Installation | |
95 | |
96 First you have to decide which conversion server to use. Currently | |
97 kinput2 supports 4 servers -- Wnn jserver, Canna cannasersver, SJ3 | |
98 sj3serv and Atok server. You can choose one of them, or more (in this | |
99 case, you can choose the server to use at run time with a command line | |
100 option). Note that if you choose Wnn6, Wnn4 is also chosen | |
101 automatically. | |
102 | |
103 You have to compile and install the conversion system (i.e. conversion | |
104 server and client-side library to communicate with the server) you | |
105 have chosen before making kinput2. See the documents in each source | |
106 directory for their installation and how to get the servers up and | |
107 running. | |
108 | |
109 Then, you have to edit Kinput2.conf in this directory. It is the | |
110 global configuration file for kinput2. See the file for details. | |
111 | |
112 If you're going to generate Makefiles by xmkmf, maybe you should specify | |
113 TOP directory in Imakefile in this directory. | |
114 | |
115 Ready? Now what you should do to build kinput2 is: | |
116 | |
117 xmkmf | |
118 make Makefiles | |
119 make depend | |
120 make | |
121 make install | |
122 | |
123 During make depend, you may get warning messages that kinput2.c | |
124 includes "WcharDisp.h" more than once, which can be ignored. | |
125 | |
126 Don't forget to do 'make install'. Kinput2 won't run unless its | |
127 application default file (cmd/Kinput2.ad) is properly installed. | |
128 | |
129 | |
130 * How to Use | |
131 | |
132 Please see cmd/kinput2.man for general setting. Default key bindings | |
133 are described in doc/defaultkeys. Other documents will be found in | |
134 doc subdirectory, though they are written in Japanese. | |
135 | |
136 | |
137 * Clients | |
138 | |
139 Since kinput2 supports many protocols, various clients can use kinput2 | |
140 as their input server. | |
141 | |
142 First, internationalized clients using X11R6 Xlib can connect to | |
143 kinput2 via X Input Method Protocol. | |
144 | |
145 Also internationalized clients using Ximp implementation of X11R5 Xlib | |
146 can connect to kinput2 via Ximp protocol. | |
147 | |
148 A Japanized terminal emulator, 'kterm', can also connect to kinput2 | |
149 via kinput2 protocol. A sample client-side library source for kinput2 | |
150 protocol is provided in client subdirectory. See client/README for | |
151 details. | |
152 | |
153 | |
154 * Changes | |
155 | |
156 See `NEWS' file for recent major changes. | |
157 | |
158 | |
159 * Bugs | |
160 | |
161 If you find a bug, please send a bug report to kinput2@sra.co.jp. | |
162 Please don't forget to include the description of your environment (your | |
163 machine, OS version, X window patchlevel, etc.) as well as the version | |
164 of kinput2 ("kinput2 -version" prints version information). | |
165 | |
166 | |
167 * Credits | |
168 | |
169 I wish to thank the following people who have contributed much to this | |
170 release: | |
171 Akira Kon, Naoshi Suzuki, Hiroshi Ohta, Masaki Takeuchi, Hideki Hiura, | |
172 Ryuji Ishiguro, Nayuta Taga, Hideyuki Moribe, Kazuki Yasumatsu, Shinji | |
173 Morino, the members of the kinput2 mailing list and XXI working group. | |
174 | |
175 Also my thanks go to all the people who participated in beta testing of | |
176 kinput2. | |
177 | |
178 | |
179 Makoto Ishisone | |
180 Software Research Associates, Inc. | |
181 ishisone@sra.co.jp |