Tizen 2.1 base
[platform/core/uifw/ise-engine-sunpinyin.git] / doc / tslmendian.pod
1 =head1 NAME
2
3 tslmendian - change the byte-order of sunpinyin's threaded back-off language model
4
5 =head1 SYNOPSIS
6
7 B<tslmendian> [I<option>]
8
9 =head1 DESCRIPTION
10
11 B<slmendian> converts the binary language model files used by SunPinyin from big-endian to small-endian or vice versa.
12
13 =head1 OPTIONS
14
15 =over 4
16
17 =item B<-e> I<endian>
18
19 Specify the I<output-lm-file>'s endian-ness. It can be B<le> or B<ge>. If not given, B<tslmendian> uses the host's endian-ness.
20
21 =item B<-v>
22
23 Prints out the endian-ness of B<input-lm-file>.
24
25 =item B<-i> I<input-lm-file>
26
27 Identify the input file of convert. Generally, this file is generated by B<slmthread> or B<tslmpack>.
28
29
30 =item B<-o> I<out-lm-file>
31
32 Identify the output file of convert.
33
34 =back
35
36 =head1 NOTES
37
38 The converted output file is equivalent to the input. But if you compare the output of B<tslminfo> of both files, the ARPA file generated by B<tslminfo> may different. This is due to the different precision in different machines.
39
40 And due to uninitialized padding data in data structure, the checksum of the original data file may different from the converted-back file, even though they are identical from SunPinyin's point of view.
41
42 =head1 AUTHOR
43
44 Originally written by Kov. Chai E<lt>tchaikov.gmail.comE<gt>.
45 Currently maintained by Kov.Chai E<lt>tchaikov@gmail.comE<gt>.
46
47 =head1 SEE ALSO
48
49 B<slmthread>(1). B<tslminfo>, B<tslmpack>.
50