File: cin2tab.1

package info (click to toggle)
xcin 2.3.02-5
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 2,824 kB
  • ctags: 1,088
  • sloc: ansic: 12,864; sh: 1,487; makefile: 369
file content (131 lines) | stat: -rw-r--r-- 5,125 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.TH CIN2TAB 1 "July 20, 1997" "XCIN 2.3.02" "Input method table converter for XCIN"
.UC
.SH NAME
cin2tab \- The input-method table converter for \fIxcin\fP system.
.SH SYNOPSIS
cin2tab \fIfilename\fP
.SH DESCRIPTION
\fICin2tab\fP is the input-method table converter for \fIxcin\fP
system. It is the utility to accomplish the ability of \fIUser 
Defined Input Method\fP of \fIxcin\fP. All one needs to do is to
edit a \fIfilename.cin\fP formated \fIInput-Method Table Source File\fP
(\fIIMTSF\fP), which is the definition of the particular input-method,
then use \fIcin2tab\fP to transform it into binary
format for \fIxcin\fP.

This manual page is based on the document \fIcin2tab.HOWTO\fP.
This is a quick guideline for users to install their favorite
\fIUser Defined Input Method\fP. For a more detailed description, 
please refer to the original document of \fIxcin-2.1d\fP.
.SH CONVERTING
Suppose that you have prepared an \fIIMTSF\fP named \fIvvvv.cin\fP,
then you can execute the following command to transform it:

     cin2tab vvvv[.cin]

If there are no errors, it will generate the following files:

     vvvv.tab
     vvvv.tab.rev
     vvvv.tab.phr
     vvvv.tab.quick
     vvvv.tab.sel1st

where the \fI.tab\fP and \fI.tab.rev\fP will always be generated,
but \fI.tab.phr\fP, \fI.tab.quick\fP and \fI.tab.sel1st\fP may or may
not be generated, depending on what you defined in the \fIvvvv.cin\fP.
Note that if you upgrade your xcin system from older version to this
version, please be sure to regenerate these input-method tables.
Because the data structure of these table may be changed in the newer
version, this may cause problems to read your older formatted table
file and lead xcin to down.
.SH STRUCTURE OF \fIIMTSF\fP
The structure of \fIIMTSF\fP contains the following sections:
.IP "%NoBosh \fIvalue\fP"
Set \fIvalue\fP to 0 to turn on the \fIoutput character 
immediately\fP mode, or set it to 1 to turn the mode off.
This is the extension of the new version. The \fIoutput character
immediately\fP mode will upload the first of the duplicate
characters with the same encoding immediately when
you type the \fIFully Input Encoding\fP (see \fIxcin(1)\fP) and 
followed by ANY key. You do not have to type the space key to 
upload this character as before.
.IP "%ename \fIname\fP"
Define the English name \fIname\fP of this input-method appeared in the
title bar of the \fIxcin\fP window.
.IP "%prompt \fI[name]\fP"
Define the Chinese name \fIname\fP of this input-method.
.IP "%selkey \fIkeyList\fP"
Define the key list \fIkeyList\fP of this input-method to select
the character if there are duplicate characters sharing with
the same encoding.
.IP "%endkey \fIkeyList\fP"
Define the key list \fIkeyList\fP of this input-method to be 
the end-key to terminate the input encoding. Every time when you
type one of the \fIkeyList\fP, \fIxcin\fP will assume that you
have typed a complete encoding, and it will perform the 
\fIoutput character immediately\fP functionary.  Using this
extension, one can make the \fIPhonetic\fP like input-method
more easy-to-use. See \fIcin2tab.HOWTO\fP for more details.
.IP "%last_full \fIvalue\fP"
When \fIxcin\fP perform the \fIoutput character immediately\fP
functionary, this extension will control \fIxcin\fP
to send the white space followed by encoding immediately or not.
Set \fIvalue\fP to 0 will send the white space, or set it to 1 will
not. This is the same as the command option \fI-last_full\fP of
\fIxcin\fP.
.IP "%dupsel \fInumber\fP"
Set the maximum number \fInumber\fP of the duplicate characters
with the same encoding can be selected at the same time.

.PD 0
.IP "%keyname begin"
.IP ".............."
.IP "%keyname end"
This section defines the mapping between each key and the 
Chinese-input representation of the input-method. The format of 
this section is:  
    <key> <Chinese representation>
.TP
.IP "%quick begin"
.IP "............"
.IP "%quick end"
This section defines the quick keys for several special characters.
The format of this section is:
    <key> <Character list>
.TP
.IP "%sel1st begin"
.IP "............."
.IP "%se1lst end"
This section defines the special characters which will be output
under the \fIoutput character immediately\fP, instead of the 
first of the duplicate characters with the same encoding. If you
setting this section, then the \fIcin2tab\fP will generate 
the \fI\.tab.sel1st\fP table file.

.SH ""
From now on, there begins the mapping table of encoding & character.
The format is:

    <encoding key list> <character (or phrase)>

If you define a phrase in the second argument, then \fIcin2tab\fP
will generate a \fI.tab.phr\fP file. Therefore, every time you type
this encoding, \fIxcin\fP will output this phrase directly.

.SH BUGS
If you find any bugs, please report to:

      \fIvvvv.bbs@cis.nctu.edu.tw\fP
   or \fIthhsieh@twclx.phys.ntu.edu.tw\fP.

.SH AUTHORS
Edward Der-Hua Liu
     (Original author of xcin-2.1b)

Suei-Jeng Wang <vvvv.bbs@cis.nctu.edu.tw>
     (XcinFix4: highly improved version of xcin-2.1b)

.SH SEE ALSO
xcin(1), crxvt(1), xcin.HOWTO, cin2tab.HOWTO, Boshiamy.HOWTO,
Xfonts.HOWTO