1                    ** uim-fep **
2
3Uim-fep is a FEP (Front End Processer). Front End Processer is as same as input
4method, in Japanese.
5
6INSTALL
7=======
8
9See INSTALL.
10
11How to USE
12==========
13
14 Set the environment variable LANG. You can use also LC_ALL or LC_CTYPE.
15
16 Ex.1 example using sh
17 $ LANG=ja_JP.eucjp ; export LANG
18
19 Ex.2 example using csh
20 % setenv LANG ja_JP.utf8
21
22 and exec uim-fep.
23
24 $ uim-fep
25
26 If you want yo know the key binds, see the manual of uim.
27
28
29* Environment variables
30  o TERM
31    Set the terminal name in terminfo/termcap.
32    You must set this variable correctly otherwise fail to use uim-fep.
33
34  o SHELL
35    Set the program name after uim-fep execed.
36    You can specify both relative path and absolute path.
37
38  o UIM_FEP
39    Set the name of conversion engine. E.G. anthy, skk, ...
40
41  o LC_ALL LC_CTYPE LANG
42    Detecting the language and encoding in accordance with this order.
43
44  o WINDOW
45    backtickを使っているときに表示されます。
46
47  o UIM_FEP_PID
48    PID (Process ID) of uim-fep.
49
50  o UIM_FEP_GETMODE
51    uim-fepのモードが書き込まれるファイルです。
52
53  o UIM_FEP_SETMODE
54    このファイルにモードを書き込むとuim-fepのモードが変わります。
55    $ echo 0 > $UIM_FEP_SETMODE
56
57  o LIBUIM_USER_SCM_FILE
58    Set the path of the uim's configuration file.
59    In default, uim-fep uses ~/.uim
60
61* Options
62  Options are given priority over environment variables if conflicted.
63
64  o -u [skk/anthy/canna/tcode/tutcode/prime]
65    You can set conversion engine name.
66
67  o -s [lastline/backtick/none]
68    Set the location where status line is displayed
69    Also you can use abbreviated opsions -sl, -sb, -sn.
70
71  o -b <file>
72    Set the socket path which is used by backtik.
73    When you set relative path, its base path is ~/.uim.d/fep/
74
75  o -w <num>
76    Width of status line. This variable is used if it's in from 1 to width of terminal.
77
78  o -t <seconds>
79    When you are using rsh,  you may not use some keys such as "F1",
80    "up", "<Alt>a". This problem is caused because escape-sequence
81    doesn't be committed at once.
82    You can solve this problem by setting the waiting time after
83    inputting escape.
84    In default, waiting time is zero second.
85
86    Example: Set the waiting time 0.1 second
87    $ uim-fep -t 0.1
88
89  o -c  This option make the character which is located at cursorposition look inverted.
90        kterm, aterm, rxvt, teraterm(カーソル点滅なしの状態)などの端末
91        では反転された文字にカーソルがあると反転が消えることがあります。
92        このような場合はこのオプションを付けると反転文字にカーソルが
93        あるときに反転されるようになります。
94
95  o -i  ステータスラインを描画しているときやプリエディット(未確定文字列)
96        の末尾以外を編集しているときにカーソルを一時的に消します。カー
97        ソルの残像が気になるときはこのオプションを付けてください。
98
99  o -e command arg1 arg2 ...
100    起動するコマンドを指定します。このオプション以降の引数は
101    commandに渡されます。
102
103  o -h This option show help messages.
104
105  o -v This option show version.
106
107
108How to use backtick
109===================
110  First, put your uim-fep-tick to the directory in the PATH list.
111  Second, in ~/.screenrc, write down following lines,
112
113    backtick 0 0 0 uim-fep-tick
114    hardstatus alwayslastline "%0`"
115
116  last, exec uim-fep in the window of screen with -s option,
117
118    $ uim-fep -s backtick
119
120  o Options of uim-fep-tick
121    * -s <file>
122      You can specify the socket path.
123      When you set relative path, its base path is ~/.uim.d/fep/
124
125    * -h Display the help message
126
127    * -v Display the version info of uim-fep
128
129  o uim-fepはscreen内の複数のウィンドウで起動できます。
130
131  o uim-fep-tickはscreenから起動されるため、screenの環境変数が引き継が
132    れます。
133
134
135* ~/.uimを書くときの注意点
136  a .. z                ->        "a" .. "z"
137  A .. Z                ->        "A" .. "Z" (or "<Shift>A" ..  "<Shift>Z")
138  C-a .. C-z            ->        "<Control>a" .. <Control>z"
139  M-a .. M-z            ->        "<Alt>a" .. "<Alt>z"
140  M-A .. M-Z            ->        "<Alt>A" ..  "<Alt>Z" (or "<Alt><Shift>A" .. "<Alt><Shift>Z")
141  M-C-a .. M-C-z        ->        "<Control><Alt>a" ..  "<Control><Alt>z"
142  return                ->        "<Control>m"
143  backspace(C-hのとき)  ->        "<Control>h"
144  backspace(C-?のとき)  ->        "<Control>?"
145  backspace(それ以外)   ->        "backspace"
146  tab                   ->        "<Control>i"
147  del, C-?              ->        "delete"
148  esc, C-[              ->        "escape"
149  C-\                   ->        "<Control>\\"
150  C-]                   ->        "<Control>]"
151  C-^                   ->        "<Control>^"
152  C-_                   ->        "<Control>_"
153  C-space               ->        "<Control> "
154  M-esc, M-C-[          ->        "<Alt>escape"
155  M-C-\                 ->        "<Alt><Control>\\"
156  M-C-]                 ->        "<Alt><Control>]"
157  M-C-^                 ->        "<Alt><Control>^"
158  M-C-_                 ->        "<Alt><Control>_"
159  M-C-space             ->        "<Alt><Control> "
160  ↑ ↓ → ←           ->        "up" "down" "right" "left"
161  F1 .. F12             ->        "F1" .. "F12"
162  Home                  ->        "home"
163  End                   ->        "end"
164  PageUp                ->        "prior"
165  PageDown              ->        "next"
166  Insert                ->        使えません
167
168  o If you want to use Alt key, you should
169を使うにはAltを押しながら他のキーを押したときに、^[が出力さ
170  れるようにします。
171  mltermの場合は~/.mlterm/mainに次のように書きます。
172    mod_meta_mode=esc
173  ktermの場合は~/.Xresourceか~/.Xdefaultsに次のように書きます。
174    KTerm*EightBitInput: false
175
176  o Some terminals accept "<Alt>F1", "<Alt>right" correctly
177
178  o You cannot input "shift-space"
179
180  o prime-wide-latin-key?の"<Control>L"は入力できません。
181
182  o You cannot input "shift-backspace"
183
184  o If you set nr-candidate-max to 0, you can indcate many candidate
185    at one time.
186
187  Examples:
188    (define skk-nr-candidate-max 0)
189    (define anthy-nr-candidate-max 0)
190    (define prime-nr-candidate-max 0)
191
192
193* Issues
194  o プリエディット編集中に端末のサイズが変更されると表示が乱れることが
195    あります.
196
197  o screenの中でuim-fepを-s lastlineで使っているとき端末のサイズを変更
198    すると稀にscreenが暴走することがあります.
199
200  o 無反応になったり暴走したりしたら
201    $ kill -INT <uim-fepのpid>
202    このコマンドで直ると思います。ただし日本語入力はできなくなります。
203
204  o 色がおかしくなることがあるかもしれません。
205
206  o You cannot use uim-fep with Cygwin(aka DOS prompt).
207
208
209* Notes
210  中ボタンクリックやShift+Insertのペーストなどで一度に大量に入力された
211  ときは変換せずにそのまま出力されます。
212  プリエディットを入力中にペーストすると無効になります。
213
214  端末の右端でプリエディットを開始すると次の行に移ります.
215
216
217* 履歴
218  o 2004/8/1  0.4.0
219    * -Cオプションを追加しました。
220
221  o 2004/7/29 0.3.9
222    * pyで落ちないようにしました。
223
224  o 2004/7/17 0.3.8
225    * Solarisでコンパイルできるようにしました。
226
227  o 2004/7/3 0.3.7
228    * wcswidthがなくてもコンパイルできるようにしました.
229    * 変換候補数の表示を変更しました. (日本語以外では"残り"が表示できないため)
230
231  o 2004/6/29 0.3.6
232    * -lオプションを廃止しました.環境変数LANGを使ってください.
233    * euc-jpで半角カナを2カラムとして扱っていたバグを修正しました.
234    * euc-jp, utf-8以外でも使えるようにしました.
235    * -tオプションを追加しました.
236    * rsh先でも使えるようにしました.
237
238  o 2004/6/21 0.3.5
239    * 最下行で起動するとおかしくなるバグを修正しました.(0.3.4のバグ)
240
241  o 2004/6/20 0.3.4
242    * プリエディット描画の高速化しました.
243    * 行を跨いだ変換でゴミが残らないようにしました.
244    * -oオプションを廃止しました.
245
246  o 2004/6/17 0.3.3
247    * 致命的なバグを修正しました.(0.3.2で入ったバグです)
248    * ウィンドウサイズが変更されたときにステータスラインを再描画するようにしました.
249    * プリエディット編集中にウィンドウサイズが変更されたときにプリエディットを
250      上書きしてしまうバグを修正しました.
251
252  o 2004/6/13 0.3.2
253    * TERM=vt100などでモード表示が消えてしまうバグを修正しました。
254    * 開始時に画面をクリアしないようにしました。
255    * skkで高速に入力すると表示がおかしくなるバグを修正しました。
256
257  o 2004/6/7 0.3.1
258    * skkで"tt"と入力すると"つt"と出力するようにしました。
259    * 行を跨いだ変換をできるようにしました。
260    * -oオプションを追加しました。
261    * primeで表示が乱れるバグを修正しました。
262
263  o 2004/05/31 0.3.0
264    --mltermオプションを廃止しました。
265    -c, -iオプションを追加しました。
266
267  o 2004/05/29 0.2.9
268    ペーストで入力された長い文字列を変換しないようにしました。
269    ステータスラインを描画しているときやプリエディットの末尾以外を編集
270    しているときにカーソルを一時的に消すようにしました。(効果はあまりないです。)
271    terminfoのclearかedが空文字列のとき暴走するバグを修正しました。
272
273  o 2004/05/18 0.2.8
274    --mltermオプションを追加しました。
275    vimで制御できるようにしました。(KoRoNさん)
276
277  o 2004/05/16 0.2.7
278    -s lastlineのuim-fepからscreenを起動しても表示が乱れないようにしました。
279    uim-fep -s lastline -e screen
280
281  o 2004/05/15 0.2.6
282    落ちるバグを修正しました。
283    anthyで長い文字列を変換するときやのちらつきを少なくしました。
284    screenで(プレエディットの編集などで)右端から次の行の左端に移動できるようにしました。
285    jfbtermで最下行のステータスラインが白くならないようにしました。
286
287  o 2004/05/10
288    0.2.5 画面クリア時に最下行のステータスラインを再描画するようにした。(mattnさん)
289    終了時に最下行のステータスラインを消すようにした。(mattnさん)
290
291  o 2004/05/09
292    0.2.4 skkでC-j, /, C-j, /の順に押すと何も出力されなくなるバグを修正。
293
294  o 2004/05/06
295    0.2.3 uim-0.3.6に対応 (constを付けただけ)
296    -vオプションを追加
297    ステータスラインを消すときにclr_eolを使うようにした。
298
299  o 2004/05/04
300    0.2.2 ステータスラインから候補がはみ出ないようにした。
301    uim-fep-tickを-wオプションをuim-fepのオプションにした。
302    uim-fep-tickの-lオプションを廃止した。
303
304  o 2004/05/03
305    0.2.1 nr-candidate-maxを0以下にしていると落ちるバグを修正。
306
307  o 2004/05/01
308    0.2 最下行をステータスラインにしてウィンドウサイズを変更すると最下
309    行に移動できてしまうバグを修正。
310    同じソケットを使うuim-fep-tickのプロセスを2つ以上できないようにした。
311    はみ出た候補も強調するようにした。
312    configureのオプションでbacktickの幅を変えれるようにした。
313
314  o 2004/04/26
315    0.1.9 連続でcommitされるとおかしくなるのを修正。
316
317  o 2004/04/26
318    0.1.8 ステータスライン関係のバグ修正
319    uim-fep-tickに-lオプションを追加
320
321  o 2004/04/25
322    0.1.7 configureをつけた
323    <c-\>などを入力できるようにした。
324    ステータスラインの候補がはみ出ても表示が乱れないようにした。
325    暴走したときに止めれるようにした。
326
327  o 2004/04/18
328    0.1.6 primeに対応
329
330  o 2004/04/17
331    0.1.5 utf-8(mattnさんのパッチ) backtick
332
333  o 2004/04/12
334    0.1.4 バグ修正
335
336  o 2004/04/11
337    0.1.3 ステータスライン
338
339  o 2004/04/11
340    0.1.2 バグ修正
341
342  o 2004/04/10
343    0.1.1 バグ修正
344
345  o 2004/04/09
346    0.1 属性とカーソル
347
348  o 2004/04/03
349    開発開始
350
351質問、バグ報告などは h013177b@ice.nuie.nagoya-u.ac.jp にお願いします。
352