README
1libskk -- a library to deal with Japanese kana-to-kanji conversion method
2
3Features:
4
5* Support basic features of SKK including: new word registration,
6 completion, numeric conversion, abbrev mode, kuten input,
7 hankaku-katakana input, Lisp expression evaluation (concat only),
8 and re-conversion.
9
10* Support various typing rules including: romaji-to-kana, AZIK,
11 TUT-Code, and NICOLA.
12
13* Support various dictionary types including: file dictionary (such as
14 SKK-JISYO.[SML]), user dictionary, skkserv, and CDB format
15 dictionary.
16
17* GObject based API with gobject-introspection support.
18
19Documentation:
20
21* file:tests/context.c for basic usage
22* file:rules/README.rules for keymap and romaji-to-kana table customization
23* http://du-a.org/docs/libskk/libskk/ for Vala binding reference
24* http://du-a.org/docs/gtk-doc/libskk/html/ for C binding reference
25
26Test:
27
28$ echo "A i SPC" | skk
29{ "input": "A i SPC", "output": "", "preedit": "▼愛" }
30$ echo "K a p a SPC K a SPC" | skk
31{ "input": "K a p a SPC K a SPC", "output": "", "preedit": "▼かぱ【▼蚊】" }
32$ echo "r k" | skk -r tutcode
33{ "input": "r k", "output": "あ", "preedit": "" }
34$ echo "a (usleep 50000) b (usleep 200000)" | skk -r nicola
35{ "input": "a (usleep 50000) b (usleep 200000)", "output": "うへ", "preedit": "" }
36
37License:
38
39GPLv3+
40
41Copyright (C) 2011-2018 Daiki Ueno <ueno@gnu.org>
42Copyright (C) 2011-2018 Red Hat, Inc.
43
44This file is free software; as a special exception the author gives
45unlimited permission to copy and/or distribute it, with or without
46modifications, as long as this notice is preserved.
47
48This file is distributed in the hope that it will be useful, but
49WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
50implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
51
README.md
1libskk -- a library to deal with Japanese kana-to-kanji conversion method
2======
3[](https://travis-ci.org/ueno/libskk) [](https://coveralls.io/r/ueno/libskk)
4
5Features
6------
7
8* Support basic features of SKK including: new word registration,
9completion, numeric conversion, abbrev mode, kuten input,
10hankaku-katakana input, Lisp expression evaluation (concat only),
11and re-conversion.
12
13* Support various typing rules including: romaji-to-kana, AZIK,
14TUT-Code, and NICOLA.
15
16* Support various dictionary types including: file dictionary (such as
17SKK-JISYO.[SML]), user dictionary, skkserv, and CDB format
18dictionary.
19
20* GObject based API with gobject-introspection support.
21
22Documentation
23------
24
25* [Basic usage](https://github.com/ueno/libskk/blob/master/tests/context.c)
26* [Keymap and Romaji-to-Kana table customization](https://github.com/ueno/libskk/blob/master/rules/README.rules)
27* [Vala binding reference](https://ueno.github.io/libskk/vala/)
28* [C binding reference](https://ueno.github.io/libskk/c/)
29
30Test
31------
32```
33$ echo "A i SPC" | skk
34{ "input": "A i SPC", "output": "", "preedit": "▼愛" }
35$ echo "K a p a SPC K a SPC" | skk
36{ "input": "K a p a SPC K a SPC", "output": "", "preedit": "▼かぱ【▼蚊】" }
37$ echo "r k" | skk -r tutcode
38{ "input": "r k", "output": "あ", "preedit": "" }
39$ echo "a (usleep 50000) b (usleep 200000)" | skk -r nicola
40{ "input": "a (usleep 50000) b (usleep 200000)", "output": "うへ", "preedit": "" }
41```
42
43License
44------
45```
46GPLv3+
47
48Copyright (C) 2011-2018 Daiki Ueno <ueno@gnu.org>
49Copyright (C) 2011-2018 Red Hat, Inc.
50
51This file is free software; as a special exception the author gives
52unlimited permission to copy and/or distribute it, with or without
53modifications, as long as this notice is preserved.
54
55This file is distributed in the hope that it will be useful, but
56WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
57implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
58```
){kind=link}
){kind=link}