diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 24 | ||||
| -rw-r--r-- | doc/gen_binary_files.1 | 1 | ||||
| -rw-r--r-- | doc/gen_unigram.1 | 1 | ||||
| -rw-r--r-- | doc/import_interpolation.1 | 1 | ||||
| -rw-r--r-- | doc/libpinyin.1 | 38 |
5 files changed, 65 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..358100e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,24 @@ +## Makefile.am -- Process this file with automake to produce Makefile.in +## Copyright (C) 2007 Peng Wu +## +## This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2, or (at your option) +## any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + +man_MANS = libpinyin.1 \ + gen_binary_files.1 \ + import_interpolation.1 \ + gen_unigram.1 + +EXTRA_DIST = $(man_MANS) diff --git a/doc/gen_binary_files.1 b/doc/gen_binary_files.1 new file mode 100644 index 0000000..394a953 --- /dev/null +++ b/doc/gen_binary_files.1 @@ -0,0 +1 @@ +.so man1/libpinyin.1 diff --git a/doc/gen_unigram.1 b/doc/gen_unigram.1 new file mode 100644 index 0000000..394a953 --- /dev/null +++ b/doc/gen_unigram.1 @@ -0,0 +1 @@ +.so man1/libpinyin.1 diff --git a/doc/import_interpolation.1 b/doc/import_interpolation.1 new file mode 100644 index 0000000..394a953 --- /dev/null +++ b/doc/import_interpolation.1 @@ -0,0 +1 @@ +.so man1/libpinyin.1 diff --git a/doc/libpinyin.1 b/doc/libpinyin.1 new file mode 100644 index 0000000..419ef90 --- /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 + +gen_unigram +.RE |