Author: yamakenz
Date: Fri Jun 29 17:38:43 2007
New Revision: 4627

Added:
   wiki/UIM_FEP.wiki

Log:
Created wiki page through web user interface.



Added: wiki/UIM_FEP.wiki
==============================================================================
--- (empty file)
+++ wiki/UIM_FEP.wiki   Fri Jun 29 17:38:43 2007
@@ -0,0 +1,158 @@
+= About =
+
+uim-fep is the bridge for inputting text on console applications.
+
+= Screen Shot =
+
+Input Japanese on Vim.
+
+http://www.ice.nuie.nagoya-u.ac.jp/~h013177b/uim-fep/imgs/uim-fep.png
+
+= From README =
+uim-fep is a FEP (Front End Processer).
+
+== How to USE ==
+
+Set the environment variable LANG. You can use also LC_ALL or LC_CTYPE.
+
+Ex.1 example using sh
+ 
+  $ LANG=ja_JP.eucjp ; export LANG
+ 
+Ex.2 example using csh
+
+  % setenv LANG ja_JP.utf8
+
+and exec uim-fep.
+
+  $ uim-fep
+
+If you want yo know the key binds, see the manual of uim.
+
+=== Environment variables ===
+
+  o TERM
+    Set the terminal name in terminfo/termcap.
+    You must set this variable correctly otherwise fail to use uim-fep.
+
+  o SHELL
+    Set the program name after uim-fep execed.
+    You can specify both relative path and absolute path.
+    
+  o UIM_FEP
+    Set the name of conversion engine. E.G. anthy, skk, ...
+
+  o LC_ALL LC_CTYPE LANG
+    Detecting the language and encoding in accordance with this order.
+
+  o TMP
+    The directory to put socket which is for communicating with uim-fep-tick.
+    If this variable not defined, /tmp will be used.
+
+  o WINDOW
+    This is shown when you use backtick
+
+  o UIM_FEP_PID
+    PID (Process ID) of uim-fep.
+
+  o UIM_FEP_GETMODE
+    The file where the mode of uim-fep is wrritten
+
+  o UIM_FEP_SETMODE
+    If you write the mode to this file, uim-fep's mode will change.
+    $ echo 0 > $UIM_FEP_SETMODE
+
+  o LIBUIM_USER_SCM_FILE
+    Set the path of the uim's configuration file.
+    In default, uim-fep uses ~/.uim
+
+=== Options ===
+
+Options are given priority over environment variables if conflicted.
+
+  o -u [skk/anthy/canna/tcode/tutcode/prime]
+    You can set conversion engine name.
+
+  o -s [lastline/backtick/none]
+    Set the location where status line is displayed
+    Also you can use abbreviated opsions -sl, -sb, -sn.
+
+  o -b <file>
+    Set the socket path which is used by backtik.
+    When you set relative path, its base path is $TMP or /tmp
+
+  o -w <num>
+    Width of status line. This variable is used if it's in from 1 to width of 
terminal.
+  
+  o -t <seconds>
+    When you are using rsh,  you may not use some keys such as "F1",
+    "up", "<Alt>a". This problem is caused because escape-sequence
+    doesn't be committed at once.
+    You can solve this problem by setting the waiting time after
+    inputting escape.
+    In default, waiting time is zero second.
+
+    Example: Set the waiting time 0.1 second
+    $ uim-fep -t 0.1
+
+  o -e command arg1 arg2 ...
+    Specify the command to run.
+
+  o -h This option show help messages.
+
+  o -v This option show version.
+
+=== How to use backtick ===
+
+First, put your uim-fep-tick to the directory in the PATH list.
+Second, in ~/.screenrc, write down following lines,
+
+    backtick 0 0 0 uim-fep-tick
+    hardstatus alwayslastline "%0`"
+
+last, exec uim-fep in the window of screen with -s option,
+
+    $ uim-fep -s backtick
+
+  o Options of uim-fep-tick
+    * -s <file>
+      You can specify the socket path.
+      When you set relative path, its base path is $TMP or /tmp
+
+    * -h Display the help message
+
+    * -v Display the version info of uim-fep
+  
+  o You can run uim-fep by the multiple windows in screen
+
+  o uim-fep-tick is excuted by screen, environment variables of screen is
+    taken over.
+
+=== Misc ===
+  o If you want to use Alt key, you should setup like follows.
+
+  If you use mlterm, please add the following line to ~/.mlterm/main
+
+    mod_meta_mode=esc
+
+  If you use kterm, please add the following line to~/.Xresource or 
~/.Xdefaults
+
+    KTerm*EightBitInput: false
+
+  o Some terminals accept "<Alt>F1", "<Alt>right" correctly
+
+  o You cannot input "shift-space"
+
+  o cannot input "<Control>L" of prime-wide-latin-key?
+
+  o You cannot input "shift-backspace"
+
+  o If you set nr-candidate-max to 0, you can indcate many candidate
+    at one time.
+ 
+  Examples:
+{{{
+    (define skk-nr-candidate-max 0)
+    (define anthy-nr-candidate-max 0)
+    (define prime-nr-candidate-max 0)
+}}}

Reply via email to