312 lines
10 KiB
HTML
312 lines
10 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of IM-CONFIG</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>IM-CONFIG</H1>
|
|
Section: Maintenance Commands (8)<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
im-config - set up input method configuration for X Window System
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>im-config [OPTION]</B>
|
|
|
|
<DD>
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="2"><B>-a</B>
|
|
|
|
<DD>
|
|
List all; force to list all possible input methods in menu or STDOUT
|
|
even if any associated packages are not installed on the system.
|
|
<DT id="3"><B>-c</B>
|
|
|
|
<DD>
|
|
Use console dialogue.
|
|
<DT id="4"><B>-x</B>
|
|
|
|
<DD>
|
|
Use X dialogue with zenity.
|
|
<DT id="5"><B>-s</B>
|
|
|
|
<DD>
|
|
No action; perform a simulation of events that would occur but do
|
|
not actually change configuration files.
|
|
<DT id="6"><B>-l</B>
|
|
|
|
<DD>
|
|
List all available input method configuration settings to STDOUT.
|
|
Unless
|
|
<B>-a</B>
|
|
|
|
is used, list only ones with associated packages installed.
|
|
<DT id="7"><B>-m</B>
|
|
|
|
<DD>
|
|
List configuration values to STDOUT:
|
|
<DL COMPACT><DT id="8"><DD>
|
|
•
|
|
|
|
|
|
active configuration (system)
|
|
</DL>
|
|
|
|
<DL COMPACT><DT id="9"><DD>
|
|
•
|
|
|
|
|
|
active configuration (user)
|
|
</DL>
|
|
|
|
<DL COMPACT><DT id="10"><DD>
|
|
•
|
|
|
|
|
|
automatic configuration for the current locale
|
|
</DL>
|
|
|
|
<DL COMPACT><DT id="11"><DD>
|
|
•
|
|
|
|
|
|
override configuration for the current locale
|
|
</DL>
|
|
|
|
<DL COMPACT><DT id="12"><DD>
|
|
•
|
|
|
|
|
|
automatic configuration for most locales
|
|
</DL>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
If the active configuration is <B>custom</B>, the user made
|
|
a custom configuration and im-config should not change it.
|
|
</DL>
|
|
|
|
<DT id="14"><B>-n</B>
|
|
|
|
<DD>
|
|
<I><input method name></I>
|
|
|
|
<P>
|
|
Set input method to <I><input method name></I>. This option is for other
|
|
configuration tool to set the input method. Since the default value of
|
|
<I><input method name></I> is "auto", you usually do not need to use this from
|
|
other configuration script.
|
|
<P>
|
|
Specifying invalid <I><input method name></I> causes the error exit. Updating
|
|
the configuration file which was not updated by <B>im-config</B> also causes the
|
|
error exit.
|
|
<P>
|
|
When this <I><input method name></I> is "REMOVE" then it always removes the
|
|
configuration file even if it was not updated by <B>im-config</B>.
|
|
<DT id="15"><B>-o</B>
|
|
|
|
<DD>
|
|
<I><input method name></I>
|
|
|
|
<P>
|
|
Print the localized description of the input method <I><input method name></I> to
|
|
STDOUT.
|
|
</DL>
|
|
<P>
|
|
|
|
The <B>-l</B>, <B>-m</B>, <B>-n</B>, and <B>-o</B> options are meant to be API for other
|
|
programs to control the im-config.
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
This manual page very briefly documents <B>im-config</B> and the configuration
|
|
of the input method.
|
|
<P>
|
|
|
|
<B>im-config</B> provides the framework to configure the input method on X
|
|
Window System with GTK GUI or console terminal dialogue. If this is invoked
|
|
without option, this lists available input methods as its choice while marking
|
|
automatic choice with trailing @-mark. The listing is ordered by the priority
|
|
of the input method. The input method with the highest priority comes first.
|
|
The availability of the input method is judged by the installation of any
|
|
associated packages. After you make a choice for the input method, this
|
|
displays a guidance for associated packages to be installed.
|
|
<P>
|
|
|
|
If only a set of required input method packages along with the im-config
|
|
package is installed, you do not need to use this command. Such a installation
|
|
works well in its default and there is no need to use this command. When you
|
|
wish to have multiple input method environments installed and wish to switch
|
|
among them, you need to use this command.
|
|
<P>
|
|
|
|
If you have no idea for what package to install, <B>im-config</B> invoked with
|
|
both <B>-a</B> and <B>-s</B> is a good start.
|
|
<P>
|
|
|
|
This input method is the essential mechanism for Japanese, Chinese and Korean
|
|
(CJK) languages to enter their non-ASCII native characters. This is also
|
|
useful to support specialized keyboard bindings for other non-European
|
|
languages such as Indic and other Asian languages.
|
|
<P>
|
|
|
|
Some input methods such as IBus, fcitx, and uim support not only one of these
|
|
CJK languages but support almost all languages simultaneously by dynamically
|
|
switching keyboard modes with GUI on the fly.
|
|
<P>
|
|
|
|
The im-config package installs a hook script
|
|
<B>/etc/X11/Xsession.d/70im-config_launch</B>. When X starts, it sources this
|
|
file as a POSIX shell code. Then this hook script tries to source the user
|
|
configuration file <B>~/.xinputrc</B>, if it exists. Otherwise, this hook
|
|
script sources the system configuration file <B>/etc/X11/xinit/xinputrc</B>.
|
|
<P>
|
|
|
|
<B>im-config</B> invoked from a user account updates the user configuration
|
|
file <B>~/.xinputrc</B>. <B>im-config</B> invoked from the root account updates
|
|
the system configuration file <B>~/etc/X11/xinit/xinputrc</B>. The essential
|
|
contents of generated files are:
|
|
<P>
|
|
|
|
<B>run_im </B><I><input method name></I>
|
|
|
|
<P>
|
|
|
|
When these files are sourced, the <B>run_im</B> shell function instructs to
|
|
source the initialization code for the corresponding input method. This
|
|
initialization code is defined in the <I><2 digits number></I>_<I><input method
|
|
name></I>.<B>rc</B> file in <B>/usr/share/im-config/data</B>.
|
|
<P>
|
|
|
|
The im-config hook script, <B>/etc/X11/Xsession.d/70im-config_launch</B>,
|
|
exports following variables to X programs: $XMODIFIERS, $GTK_IM_MODULE,
|
|
$QT_IM_MODULE, $QT4_IM_MODULE, and $CLUTTER_IM_MODULE.
|
|
<P>
|
|
|
|
The im-config hook script, <B>/etc/X11/Xsession.d/70im-config_launch</B>,
|
|
also set $STARTUP to use <B>/usr/bin/im-launch</B> for starting required
|
|
daemons.
|
|
<P>
|
|
|
|
If you wish to create a custom configuration beyond what <B>im-config</B>
|
|
can do for you, please copy one of these initialization code files into
|
|
<B>~/.xinputrc</B> or <B>/etc/X11/xinit/xinputrc</B> and edit it to suite your
|
|
need. For example, <B>02_cjkv.rc</B> tells how input method can be customized
|
|
for each locale. This script should be written to set environment variables if
|
|
"$IM_CONFIG_PHASE" = 1 and to start daemon programs if "$IM_CONFIG_PHASE" = 2 .
|
|
<P>
|
|
|
|
Please note that this <I><2 digits number></I> part of these
|
|
configuration files may change for every new releases of the im-config
|
|
package.
|
|
<P>
|
|
|
|
When a user makes manual changes to <B>~/.xinputrc</B> or
|
|
<B>/etc/X11/xinit/xinputrc</B> without using <B>im-config</B>, <B>im-config</B>
|
|
will detect it using a md5sum hush value embedded in the shell comment and will
|
|
not overwrite such files. You must erase them manually if you wish to replace
|
|
them with ones created by <B>im-config</B>.
|
|
<P>
|
|
|
|
The <I><2 digits number></I>_<I><input method name></I>.<B>conf</B> files in
|
|
<B>/usr/share/im-config/data</B> provide the UI data for <B>im-config</B>
|
|
and the heuristic logic of selecting desirable input method under the
|
|
auto mode. The smaller number of the <I><2 digits number></I> indicates the
|
|
higher priority of <I><input method name></I>.
|
|
<P>
|
|
|
|
These <I><2 digits number></I>_<I><input method name></I>.<B>conf</B> files
|
|
define few variables and functions. The value of <B>IM_CONFIG_SHORT</B> is the
|
|
short description of the input method for the menu. The value of
|
|
<B>IM_CONFIG_LONG</B> is the long description of the input method explaining its
|
|
package dependency. The <B>package_menu</B> shell function defines as a
|
|
function to return true if any associated input method packages are installed
|
|
to activate its menu entry. The <B>package_auto</B> shell function defines as a
|
|
function to return true if the sufficient input method packages are installed
|
|
for the auto mode. These definitions use the <B>package_status</B> shell
|
|
function which takes package name as its argument and returns true if it is
|
|
installed properly.
|
|
<P>
|
|
|
|
The menu lists input methods with the <I><2 digits number></I> between <B>00</B>
|
|
and <B>89</B>. The auto mode considers its input method candidate from <I><2
|
|
digits number></I> between <B>10</B> and <B>79</B> in this order. The usage
|
|
convention of <I><2 digits number></I> is:
|
|
<DL COMPACT>
|
|
<DT id="16"><B>00-09:</B>
|
|
|
|
<DD>
|
|
Input Method choice mode (default/auto/cjkv/REMOVE)
|
|
<DT id="17"><B>10-49:</B>
|
|
|
|
<DD>
|
|
Input Method supporting multiple languages.(auto ready)
|
|
<DT id="18"><B>50-79:</B>
|
|
|
|
<DD>
|
|
Input Method supporting limited languages. (auto ready)
|
|
<DT id="19"><B>80-89:</B>
|
|
|
|
<DD>
|
|
Input Method (deprecated one) (not for auto)
|
|
<DT id="20"><B>90-99:</B>
|
|
|
|
<DD>
|
|
Used internally by <B>im-config</B> (not for auto)
|
|
</DL>
|
|
<P>
|
|
|
|
This structure ensures to have different input methods to be installed
|
|
side-by-side with minimal user configurations.
|
|
<P>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>TROUBLESHOOT</H2>
|
|
|
|
If you have any problem, see the first part of <B>~/.xsession-errors</B> and
|
|
look for the cause. If you are running <B>im-config</B> while Debian (sid)
|
|
system is undergoing a major library transition, you may need to manually set
|
|
up <B>~/.xinputrc</B> with adjusted library version number etc. Please file a
|
|
bug report to the im-config package using <A HREF="/cgi-bin/man/man2html?1+reportbug">reportbug</A>(1) describing your
|
|
resolution experience.
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B>/usr/share/doc/im-config/README.Debian.gz</B>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
This manual page was written by Osamu Aoki <<A HREF="mailto:osamu@debian.org">osamu@debian.org</A>>,
|
|
for the Debian GNU/Linux system (but may be used by others).
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="21"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="22"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="23"><A HREF="#lbAD">OPTIONS</A><DD>
|
|
<DT id="24"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
|
<DT id="25"><A HREF="#lbAF">TROUBLESHOOT</A><DD>
|
|
<DT id="26"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
<DT id="27"><A HREF="#lbAH">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:12 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|