Remove package type in manifest
[platform/core/uifw/ise-engine-sunpinyin.git] / doc / genpyt.pod
1 =head1 NAME
2
3 genpyt - generate the PINYIN lexicon
4
5 =head1 SYNOPSIS
6
7 B<genpyt> I<lexicon-file> I<result-file> I<log-file> I<slm-file>
8
9 =head1 DESCRIPTION
10
11 B<genpyt> is used to generate the PINYIN lexicon. 
12 It only works on zh_CN.UTF-8 locale.
13
14 =head1 ARGUMENTS
15
16 =over 4
17
18 =item I<lexicon-file>
19
20 Specify a dictionary file. It should be a line-based text file in utf-8 encoding
21 . Each line looks like:
22
23    CCC  id  [pinyin'pinyin'pinyin]*
24
25 A default dictionary file can be found at F</usr/share/sunpinyin/dict.utf8>.
26
27
28 =item I<result-file>
29
30 The output binary PINYIN lexicon file. This lexicon contains a trie presenting the key tree of PINYIN. And all of the candiate words are sorted using the unigram in I<slm-file>. This file can be used with sunpinyin input method engines.
31
32
33 =item I<log-file>
34
35 Specify the file to where the log goes. The I<log-file> can be seen as the human-readble presentation of the binary output file.
36
37
38 =item I<slm-file>
39
40 The language model from which the unigram information are retrieved. Typically, the I<slm-file> is generated by B<slmthread>.
41
42 =back
43
44 =head1 AUTHOR
45
46 Originally written by Phill.Zhang E<lt>phill.zhang@sun.comE<gt>.
47 Currently maintained by Kov.Chai E<lt>tchaikov@gmail.comE<gt>.
48
49 =head1 SEE ALSO
50
51 B<slmthread>(1).
52