From: Peng Wu <alexepico@gmail.com>
Date: Mon, 6 Feb 2012 06:18:54 +0000 (+0800)
Subject: add libpinyin.1
X-Git-Tag: 0.5.91~13
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a0095d85a122f7b4972471c9d7b0da414044a375;p=platform%2Fupstream%2Flibpinyin.git

add libpinyin.1
---

diff --git a/doc/libpinyin.1 b/doc/libpinyin.1
new file mode 100644
index 0000000..b8a0261
--- /dev/null
+++ b/doc/libpinyin.1
@@ -0,0 +1,38 @@
+.TH LIBPINYIN "1" "Fed 2012" "libpinyin" "User Commands"
+
+.SH NAME
+libpinyin \- Library to deal with pinyin
+
+.SH DESCRIPTION
+The libpinyin project aims to provide the algorithms core for intelligent sentence-based Chinese pinyin input methods.
+
+.SH TOOLS
+gen_binary_files \- generate initially binary pinyin libraries
+import_interpolation \- import libpinyin textual format model data
+gen_unigram \- increase the unigram frequency for all phrases
+
+.SH USAGE
+.HP
+gen_binary_files --table-dir <DIRNAME>
+.RS
+.HP
+.B --table-dir
+Read textual format files from the <DIRNAME> directory.
+.RE
+.HP
+import_interpolation \< <MODELFILE>
+.HP
+gen_unigram
+
+.SH EXAMPLE
+Download the model.text.tar.gz, and extracts all files into a folder, then run the commands below to generate the binary model data.
+
+.RS
+rm gb_char.bin gbk_char.bin phrase_index.bin pinyin_index.bin bigram.db
+
+gen_binary_files --table-dir ../data
+
+import_interpolation < ../data/interpolation.text
+
+utils/training/gen_unigram
+.RE