README

ibus-tutcode -- a Japanese TUT-Code input engine for IBus

* What's it?

ibus-tutcode is an implementation of the TUT-Code/T-Code/Try-Code input
method on the IBus input method framework.  Since TUT-Code is quite
different from other Japanese input methods, if you haven't heard of
it, please consult the following Web pages before complaining about
the differences:

http://ja.wikipedia.org/wiki/%E6%BC%A2%E5%AD%97%E7%9B%B4%E6%8E%A5%E5%85%A5%E5%8A%9B
http://www.crew.sfc.keio.ac.jp/~chk/intro.html
http://openlab.jp/tcode/

* How to install

$ ./configure --prefix=/usr
$ make
$ sudo make install

(Change the path '/usr' according to your system configuration.)

* Configuration

Use configuration file located at ~/.config/ibus-tutcode.json.
Use ibus-tutcode.json.example as a template.

 "page_size": Number of candidates on a page: 10
 "pagination_start": Candidate window pagination start: 4
 "tutcode_rule": Code table(0=TUT-Code, 1=T-Code, 2=Try-Code): 0
 "initial_input_mode": Initial input mode(0=Latin, 1=Hiragana, 2=Katakana): 1
 "use_with_vi": Change to latin mode on escape key: false
 "use_mmap": Use mmap to access system dictionary: true
 "sysdict_paths": Paths to system dictionary:["/usr/share/t-code/mazegaki.dic"]
                                        or ["/usr/local/share/tc/mazegaki.dic"]
 "usrdict": Path to user dictionary: "~/.mazegaki-ibus.dic"
 "custom_tutcode_rule": Customization of code table: {}
 "on_keys": Keys to Hiragana mode: ["ctrl+\\"]
 "off_keys": Keys to latin mode: ["ctrl+\\"]
 "cancel_keys": Cancel keys: ["ctrl+g", "ctrl+u"]
 "backspace_keys": Backspace keys: ["ctrl+h", "backspace"]
 "conv_keys": Keys to begin conversion on Mazegaki: [" ", "ctrl+n"]
 "next_keys": Keys for next candidate: [" ", "ctrl+n"]
 "prev_keys": Keys for previous candidate: ["ctrl+p"]
 "commit_keys": Keys to commit: ["ctrl+m", "return"]
 "purge_keys": Keys to purge candidate: ["!"]
 "vi_escape_keys": Escape keys for use_with_vi: ["escape", "ctrl+["]

* How to report bugs

Use the issue tracker on GitHub:

https://github.com/deton/ibus-tutcode/issues

* See Also

ibus-tutcode is based on ibus-skk (prior to libskk)
https://github.com/ueno/ibus-skk