|
 |
dc70ea |
From 99b16e2159ba4234f4f804fe10348c9f3b2a8000 Mon Sep 17 00:00:00 2001
|
|
|
dc70ea |
From: Mike FABIAN <mfabian@redhat.com>
|
|
|
dc70ea |
Date: Thu, 18 Apr 2013 12:10:50 +0200
|
|
|
dc70ea |
Subject: [PATCH] Add man page for ibus-table-createdb
|
|
|
dc70ea |
|
|
|
dc70ea |
See https://bugzilla.redhat.com/show_bug.cgi?id=948454
|
|
|
dc70ea |
---
|
|
|
dc70ea |
engine/Makefile.am | 12 +++
|
|
|
dc70ea |
engine/ibus-table-createdb.sgml | 206 ++++++++++++++++++++++++++++++++++++++++
|
|
|
dc70ea |
engine/tabcreatedb.py | 10 +-
|
|
|
dc70ea |
3 files changed, 223 insertions(+), 5 deletions(-)
|
|
|
dc70ea |
create mode 100644 engine/ibus-table-createdb.sgml
|
|
|
dc70ea |
|
|
|
dc70ea |
diff --git a/engine/Makefile.am b/engine/Makefile.am
|
|
|
dc70ea |
index f17afe3..1fb070e 100644
|
|
|
dc70ea |
--- a/engine/Makefile.am
|
|
|
dc70ea |
+++ b/engine/Makefile.am
|
|
|
dc70ea |
@@ -19,6 +19,11 @@
|
|
|
dc70ea |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
dc70ea |
#
|
|
|
dc70ea |
|
|
|
dc70ea |
+DOC2MAN = docbook2man
|
|
|
dc70ea |
+SGML = ibus-table-createdb.sgml
|
|
|
dc70ea |
+BUILT_MANS = ibus-table-createdb.1
|
|
|
dc70ea |
+man_MANS = $(BUILT_MANS)
|
|
|
dc70ea |
+
|
|
|
dc70ea |
engine_table_PYTHON = \
|
|
|
dc70ea |
chinese_variants.py \
|
|
|
dc70ea |
factory.py \
|
|
|
dc70ea |
@@ -43,6 +48,8 @@ EXTRA_DIST = \
|
|
|
dc70ea |
ibus-table-createdb.in \
|
|
|
dc70ea |
ibus-engine-table.in \
|
|
|
dc70ea |
table.xml.in \
|
|
|
dc70ea |
+ $(SGML) \
|
|
|
dc70ea |
+ $(BUILT_MANS) \
|
|
|
dc70ea |
$(NULL)
|
|
|
dc70ea |
|
|
|
dc70ea |
CLEANFILES = \
|
|
|
dc70ea |
@@ -57,6 +64,11 @@ MAINTAINERCLEANFILES = \
|
|
|
dc70ea |
Makefile.in \
|
|
|
dc70ea |
$(NULL)
|
|
|
dc70ea |
|
|
|
dc70ea |
+${man_MANS}: ${SGML}
|
|
|
dc70ea |
+ $(AM_V_GEN) $(RM) $@; \
|
|
|
dc70ea |
+ $(DOC2MAN) ${SGML}; \
|
|
|
dc70ea |
+ $(RM) manpage.*
|
|
|
dc70ea |
+
|
|
|
dc70ea |
table.xml: table.xml.in
|
|
|
dc70ea |
( \
|
|
|
dc70ea |
libexecdir=${libexecdir}; \
|
|
|
dc70ea |
diff --git a/engine/ibus-table-createdb.sgml b/engine/ibus-table-createdb.sgml
|
|
|
dc70ea |
new file mode 100644
|
|
|
dc70ea |
index 0000000..86c8336
|
|
|
dc70ea |
--- /dev/null
|
|
|
dc70ea |
+++ b/engine/ibus-table-createdb.sgml
|
|
|
dc70ea |
@@ -0,0 +1,206 @@
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ page: `docbook-to-man manpage.sgml > manpage.1'. You may view
|
|
|
dc70ea |
+ the manual page with: `docbook-to-man manpage.sgml | nroff -man |
|
|
|
dc70ea |
+ less'. A typical entry in a Makefile or Makefile.am is:
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+manpage.1: manpage.sgml
|
|
|
dc70ea |
+ docbook-to-man $< > $@
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ The docbook-to-man binary is found in the docbook-to-man package.
|
|
|
dc70ea |
+ Please remember that if you create the nroff version in one of the
|
|
|
dc70ea |
+ debian/rules file targets (such as build), you will need to include
|
|
|
dc70ea |
+ docbook-to-man in your Build-Depends control field.
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ -->
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ Mike</firstname>">
|
|
|
dc70ea |
+ FABIAN</surname>">
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ Apr 18, 2013</date>">
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ allowed: see man(7), man(1). -->
|
|
|
dc70ea |
+ 1</manvolnum>">
|
|
|
dc70ea |
+ mfabian@redhat.com</email>">
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ ibus-table-createdb</refentrytitle>">
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ Debian</productname>">
|
|
|
dc70ea |
+ GNU">
|
|
|
dc70ea |
+ GPL">
|
|
|
dc70ea |
+]>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+<refentry>
|
|
|
dc70ea |
+ <refentryinfo>
|
|
|
dc70ea |
+ <address>
|
|
|
dc70ea |
+ &dhemail;
|
|
|
dc70ea |
+ </address>
|
|
|
dc70ea |
+ <author>
|
|
|
dc70ea |
+ &dhfirstname;
|
|
|
dc70ea |
+ &dhsurname;
|
|
|
dc70ea |
+ </author>
|
|
|
dc70ea |
+ <copyright>
|
|
|
dc70ea |
+ <year>2013</year>
|
|
|
dc70ea |
+ <holder>&dhusername;</holder>
|
|
|
dc70ea |
+ </copyright>
|
|
|
dc70ea |
+ &dhdate;
|
|
|
dc70ea |
+ </refentryinfo>
|
|
|
dc70ea |
+ <refmeta>
|
|
|
dc70ea |
+ &dhucpackage;
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ &dhsection;
|
|
|
dc70ea |
+ </refmeta>
|
|
|
dc70ea |
+ <refnamediv>
|
|
|
dc70ea |
+ <refname>&dhpackage;</refname>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <refpurpose>create ibus-table database from table source</refpurpose>
|
|
|
dc70ea |
+ </refnamediv>
|
|
|
dc70ea |
+ <refsynopsisdiv>
|
|
|
dc70ea |
+ <cmdsynopsis>
|
|
|
dc70ea |
+ <command>&dhpackage;</command>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <group>
|
|
|
dc70ea |
+ <arg><option>-n</option> <option><replaceable>name</replaceable></option></arg>
|
|
|
dc70ea |
+ <arg><option>--name</option> <option><replaceable>name</replaceable></option></arg>
|
|
|
dc70ea |
+ </group>
|
|
|
dc70ea |
+ <group>
|
|
|
dc70ea |
+ <arg><option>-s</option> <option><replaceable>source</replaceable></option></arg>
|
|
|
dc70ea |
+ <arg><option>--source</option> <option><replaceable>source</replaceable></option></arg>
|
|
|
dc70ea |
+ </group>
|
|
|
dc70ea |
+ <group>
|
|
|
dc70ea |
+ <arg><option>-e</option> <option><replaceable>extra</replaceable></option></arg>
|
|
|
dc70ea |
+ <arg><option>--extra</option> <option><replaceable>extra</replaceable></option></arg>
|
|
|
dc70ea |
+ </group>
|
|
|
dc70ea |
+ <group>
|
|
|
dc70ea |
+ <arg><option>-p</option> <option><replaceable>pinyin</replaceable></option></arg>
|
|
|
dc70ea |
+ <arg><option>--pinyin</option> <option><replaceable>pinyin</replaceable></option></arg>
|
|
|
dc70ea |
+ </group>
|
|
|
dc70ea |
+ <arg><option>-o</option></arg>
|
|
|
dc70ea |
+ <arg><option>--no-create-index</option></arg>
|
|
|
dc70ea |
+ <arg><option>-i</option></arg>
|
|
|
dc70ea |
+ <arg><option>--create-index-only</option></arg>
|
|
|
dc70ea |
+ <arg><option>-d</option></arg>
|
|
|
dc70ea |
+ <arg><option>--debug</option></arg>
|
|
|
dc70ea |
+ <sbr>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ </cmdsynopsis>
|
|
|
dc70ea |
+ </refsynopsisdiv>
|
|
|
dc70ea |
+ <refsect1>
|
|
|
dc70ea |
+ <title>DESCRIPTION</title>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <para><command>&dhpackage;</command> creates a database for
|
|
|
dc70ea |
+ ibus-table from a source table.</para>
|
|
|
dc70ea |
+ </refsect1>
|
|
|
dc70ea |
+ <refsect1>
|
|
|
dc70ea |
+ <title>OPTIONS</title>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <para>This program follows the usual &gnu; command line syntax,
|
|
|
dc70ea |
+ with long options starting with two dashes (`-'). A summary of
|
|
|
dc70ea |
+ options is included below.</para>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <variablelist>
|
|
|
dc70ea |
+ <term><option>-n</option>
|
|
|
dc70ea |
+ <option>--name</option>
|
|
|
dc70ea |
+ <option><replaceable>database-file</replaceable></option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para><replaceable>database-file</replaceable> specifies the file which will contain the binary database for the IME. The default is ''.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <term><option>-s</option>
|
|
|
dc70ea |
+ <option>--source</option>
|
|
|
dc70ea |
+ <option><replaceable>source-file</replaceable></option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para><replaceable>source-file</replaceable> specifies the file which contains the source of the IME. The default is ''.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term><option>-e</option>
|
|
|
dc70ea |
+ <option>--extra</option>
|
|
|
dc70ea |
+ <option><replaceable>extra-words-file</replaceable></option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para><replaceable>extra-words-file</replaceable> specifies the file for the extra words for the IME. The default is ''.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term><option>-p</option>
|
|
|
dc70ea |
+ <option>--pinyin</option>
|
|
|
dc70ea |
+ <option><replaceable>pinyin-file</replaceable></option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para><replaceable>pinyin-file</replaceable> specifies the source file for the pinyin. The default is /usr/share/ibus-table/data/pinyin_table.txt.bz2.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term><option>-o</option>
|
|
|
dc70ea |
+ <option>--no-create-index</option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para>Do not create an index for for a database (Only for distribution purposes, a normal user should not use this flag!)</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term><option>-i</option>
|
|
|
dc70ea |
+ <option>--create-index-only</option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para>Only create an index for an existing database.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term><option>-d</option>
|
|
|
dc70ea |
+ <option>--debug</option>
|
|
|
dc70ea |
+ </term>
|
|
|
dc70ea |
+ <listitem>
|
|
|
dc70ea |
+ <para>Print extra debug messages.</para>
|
|
|
dc70ea |
+ </listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ </variablelist>
|
|
|
dc70ea |
+ </refsect1>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <refsect1>
|
|
|
dc70ea |
+ <title>EXAMPLES</title>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <variablelist>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term>ibus-table-createdb -n ipa-x-sampa.db -s ipa-x-sampa.txt</term>
|
|
|
dc70ea |
+ <listitem><para>Create the binary database <quote>ipa-x-sampa.db</quote> from the source file <quote>ipa-x-sampa.txt</quote>.</para></listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ <varlistentry>
|
|
|
dc70ea |
+ <term>ibus-table-createdb -i -n ipa-x-sampa.db</term>
|
|
|
dc70ea |
+ <listitem><para>Create an index for the database <quote>ipa-x-sampa.db</quote>.</para></listitem>
|
|
|
dc70ea |
+ </varlistentry>
|
|
|
dc70ea |
+ </variablelist>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ </refsect1>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <refsect1>
|
|
|
dc70ea |
+ <title>AUTHOR</title>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ <para>This manual page was written by &dhusername; &dhemail;.</para>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+ </refsect1>
|
|
|
dc70ea |
+</refentry>
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+
|
|
|
dc70ea |
+Local variables:
|
|
|
dc70ea |
+mode: sgml
|
|
|
dc70ea |
+sgml-omittag:t
|
|
|
dc70ea |
+sgml-shorttag:t
|
|
|
dc70ea |
+sgml-minimize-attributes:nil
|
|
|
dc70ea |
+sgml-always-quote-attributes:t
|
|
|
dc70ea |
+sgml-indent-step:2
|
|
|
dc70ea |
+sgml-indent-data:t
|
|
|
dc70ea |
+sgml-parent-document:nil
|
|
|
dc70ea |
+sgml-default-dtd-file:nil
|
|
|
dc70ea |
+sgml-exposed-tags:nil
|
|
|
dc70ea |
+sgml-local-catalogs:nil
|
|
|
dc70ea |
+sgml-local-ecat-files:nil
|
|
|
dc70ea |
+End:
|
|
|
dc70ea |
+-->
|
|
|
dc70ea |
diff --git a/engine/tabcreatedb.py b/engine/tabcreatedb.py
|
|
|
dc70ea |
index 19ebacc..6694b13 100644
|
|
|
dc70ea |
--- a/engine/tabcreatedb.py
|
|
|
dc70ea |
+++ b/engine/tabcreatedb.py
|
|
|
dc70ea |
@@ -70,23 +70,23 @@ opt_parser.add_option( '-n', '--name',
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-s', '--source',
|
|
|
dc70ea |
action = 'store', dest='source', default = 'xingma.txt.bz2',
|
|
|
dc70ea |
- help = 'tell me which file is the source file of IME, default is %default')
|
|
|
dc70ea |
+ help = 'specifies the file which contains the source file of the IME. The default is %default')
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-e', '--extra',
|
|
|
dc70ea |
action = 'store', dest='extra', default = '',
|
|
|
dc70ea |
- help = 'tell me which file is the extra words file for IME, default is %default')
|
|
|
dc70ea |
+ help = 'specifies the file for the extra words for the IME. The default is %default')
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-p', '--pinyin',
|
|
|
dc70ea |
action = 'store', dest='pinyin', default = '/usr/share/ibus-table/data/pinyin_table.txt.bz2',
|
|
|
dc70ea |
- help = 'tell me which file is the source file of pinyin, default is %default')
|
|
|
dc70ea |
+ help = 'specifies the source file for the pinyin. The default is %default')
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-o', '--no-create-index',
|
|
|
dc70ea |
action = 'store_false', dest='index', default = True,
|
|
|
dc70ea |
- help = 'do not create index on database, only for distrubution purpose, normal user should not invoke this flag!')
|
|
|
dc70ea |
+ help = 'do not create an index for a database (Only for distrubution purposes, a normal user should not use this flag!)')
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-i', '--create-index-only',
|
|
|
dc70ea |
action = 'store_true', dest='only_index', default = False,
|
|
|
dc70ea |
- help = 'only create index on exist database')
|
|
|
dc70ea |
+ help = 'only create an index for an existing database')
|
|
|
dc70ea |
|
|
|
dc70ea |
opt_parser.add_option( '-d', '--debug',
|
|
|
dc70ea |
action = 'store_true', dest='debug', default = False,
|
|
|
dc70ea |
--
|
|
|
dc70ea |
1.8.4.2
|
|
|
dc70ea |
|