Difference between revisions of "Fcitx"

From ArchWiki
Jump to: navigation, search
m (On KDE, CTRL+Space does not work on Firefox, Chromium etc. applications)
(Gnome-Shell)
(29 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
[[Category:Internationalization]]
 
[[Category:Internationalization]]
 
[[zh-CN:Fcitx]]
 
[[zh-CN:Fcitx]]
[http://code.google.com/p/fcitx/ FCITX] (Flexible Input Method Framework) is a input method framework aiming at providing environment independent language support for Linux.
+
[http://code.google.com/p/fcitx/ FCITX] (Flexible Input Method Framework) is a [http://en.wikipedia.org/wiki/Input_method input method framework] aiming at providing environment independent language support for Linux. It supports a lot of different languages and also provides many useful non-CJK features.
  
 
==Installation==
 
==Installation==
 
{{Pkg|fcitx}} can be installed with [[Pacman]] from the [community] repository.
 
{{Pkg|fcitx}} can be installed with [[Pacman]] from the [community] repository.
 +
 +
In order to have a better experience in gtk and qt programs (especially gtk programs) (e.g. better cursor following) and get rid of many unsolvable problems/bugs caused by xim, please install the corresponding input method modules for gtk and qt: {{Pkg|fcitx-gtk2}} (for gtk2 programs), {{Pkg|fcitx-gtk3}} (for gtk3 programs) and {{Pkg|fcitx-qt}} (for qt programs). You can install all four of them in a bundle by issuing this command:
 +
 +
  pacman -S fcitx-im
  
 
==Using FCITX to Input==
 
==Using FCITX to Input==
 
Before you can make use of FCITX for input, you have to setup some environment variables.  It is quite simple.
 
Before you can make use of FCITX for input, you have to setup some environment variables.  It is quite simple.
*Opening the {{ic|.xprofile}} (or {{ic|.profile}} depending on the desktop environment and display manager you are using) file in your home directory and add following lines:
+
*Adding the following lines to your desktop startup script files ({{ic|.xprofile}} or {{ic|.profile}} when you are using KDM, GDM or LightDM, and {{ic|.xinitrc}} when you are using startx or Slim). With these lines, fcitx will work along with gtk/qt input method modules and support xim programs (Please make sure the necessary input method modules are already installed):
  #setup XIM environment
+
  export GTK_IM_MODULE=xim
+
  export QT_IM_MODULE=xim
+
  export XMODIFIERS="@im=fcitx"
+
 
+
Since 4.1.0, Fcitx provides it's own input method module, {{Pkg|fcitx-gtk2}}, {{Pkg|fcitx-gtk3}}, and {{Pkg|fcitx-qt}}. It's recommend to use input method module instead of xim directly, in order to resolve strange bugs brought by XIM.
+
  
You can set corresponding environment variables
 
 
   export GTK_IM_MODULE=fcitx
 
   export GTK_IM_MODULE=fcitx
 
   export QT_IM_MODULE=fcitx
 
   export QT_IM_MODULE=fcitx
 +
  export XMODIFIERS="@im=fcitx"
 +
 +
Optionally, you can also choose to use xim in your gtk and/or qt programs, in which case you need to change the corresponding lines above as following:
 +
 +
  export GTK_IM_MODULE=xim
 +
  export QT_IM_MODULE=xim
 +
 +
{{Warning| Using xim can sometimes cause problems that are not solvable by any input method including not being able to input, no cursor following, application freeze on input method restart. For these xim related problems, Fcitx cannot provide any fix or support. This is the same with any other input method framework, so please use toolkit (gtk/qt) input method modules instead of xim whenever possible}}
  
 
*Re-login to make such environment effective.
 
*Re-login to make such environment effective.
Line 24: Line 29:
 
If you are using any XDG compatible desktop environment such as [[KDE]], [[GNOME]], [[XFCE]], [[LXDE]], after you relogin, the autostart should work out of box. If not, open your favorite terminal, type:
 
If you are using any XDG compatible desktop environment such as [[KDE]], [[GNOME]], [[XFCE]], [[LXDE]], after you relogin, the autostart should work out of box. If not, open your favorite terminal, type:
  
  fcitx
+
$ fcitx
  
To see if fcitx is working correctly, open an application such as leafpad and press CTRL+Space(the default shortcut for switching input method) to invoke FCITX and input some words.
+
To see if fcitx is working correctly, open an application such as leafpad and press CTRL+Space (the default shortcut for switching input method) to invoke FCITX and input some words.
  
If everything goes well, you may want to add fcitx to your {{ic|.xinitrc}} file (see [[xinitrc]]) if the xdg autostart doesn't work for you:
+
If Fcitx failed to start with your desktop automatically or if you want to change the parameters to start fcitx, please use tools provided by your desktop environment to configure xdg auto start or edit the {{ic|fcitx-autostart.desktop}} file in your {{ic|~/.config/autostart/}} directory (copy it from {{ic|/etc/xdg/autostart/}} if it doesn't exist yet).
  
  fcitx -r
+
If your desktop environment does not support xdg auto start, please add the following command to your startup script (after the environment variables are set up properly).
  
Enjoy!
+
$ fcitx
 +
 
 +
When other input methods with xim support is also running, Fcitx may fail to start due to xim error. Please make sure no other input method is running before you start Fcitx.
  
 
==Configuration==
 
==Configuration==
  
Fcitx provides GUI configure tool since version 4.0. You can install either {{Pkg|kcm-fcitx}}(based on kcm), {{Pkg|fcitx-configtool}}(based on gtk3), or {{AUR|fcitx-configtool-gtk2}}(based on gtk2, unsupported) from [[Arch User Repository|AUR]]. Editing the configure file manually is possible but is not supported anymore and may cause trouble.
+
Fcitx provides GUI configure tool. You can install either {{Pkg|kcm-fcitx}}(based on kcm), {{Pkg|fcitx-configtool}}(based on gtk3), or {{AUR|fcitx-configtool-gtk2}}(based on gtk2, unsupported) from [[Arch User Repository|AUR]].
  
 
==Desktop Environment Integration==
 
==Desktop Environment Integration==
Line 42: Line 49:
 
===Gnome-Shell===
 
===Gnome-Shell===
  
You can install {{AUR|gnome-shell-extension-kimpanel-git}} package in [[Arch User Repository|AUR]], which provides a similar user experience as ibus-gjs.
+
You can install kimpanel from extensions.gnome.org or {{AUR|gnome-shell-extension-kimpanel-git}} package in [[Arch User Repository|AUR]], which provides a similar user experience as ibus-gjs.
 +
 
 +
Remove all input source form gnome-control-center ,and clear all the hotkey for inputmethord.Use this command to disable ibus:
 +
$gsettings set org.gnome.settings-daemon.plugins.keyboard active false
  
 
===KDE===
 
===KDE===
Line 50: Line 60:
 
{{Pkg|kcm-fcitx}} is a kcontrol module for fcitx.
 
{{Pkg|kcm-fcitx}} is a kcontrol module for fcitx.
  
{{Pkg|kdeplasma-addons-applets-kimpanel}} is a plasmoids, that provides native feeling under kde desktop. Simply add kimpanel to plasma and fcitx will automatically switch to it without extra configuration.
+
{{Pkg|kdeplasma-addons-applets-kimpanel}} is a plasmoids providing native feeling under kde. Simply add kimpanel to plasma and fcitx will automatically switch to it without extra configuration.
  
 
==Install other components of fcitx==
 
==Install other components of fcitx==
Line 70: Line 80:
  
 
===Japanese Input Method===
 
===Japanese Input Method===
Install {{Pkg|fcitx-anthy}} or {{AUR|mozc-fcitx}} in [[Arch User Repository|AUR]].
+
Install {{Pkg|fcitx-anthy}} or {{Pkg|fcitx-mozc}}.
  
 
===Korean Input Method===
 
===Korean Input Method===
Line 76: Line 86:
  
 
===Other language===
 
===Other language===
[http://www.m17n.org/index.html m17n] provides quite a long other language support, you can install m17n support for fcitx with {{AUR|fcitx-m17n}} in [[Arch User Repository|AUR]].
+
[http://www.m17n.org/index.html m17n] provides quite a long other language support, you can install m17n support for fcitx with {{Pkg|fcitx-m17n}}
 +
 
 +
==Clipboard Access==
 +
You can use fcitx to input text in you clipboard (as well as a short clipboard history and primary selection). The default trigger key is Control-;. You can change the trigger key as well as other options in the Clipboard addon configure page.
 +
 
 +
NOTE: This is NOT a clipboard manager, it doesn't hold the selection or change it's content as what a clipboard manager is supposed to do. It can only be used to input from the clipboard.
 +
 
 +
{{Warning| Some client doesn't support multi-line input so you may see the multi-line clipboard content pasted as a single line using fcitx-clipboard. That's either a bug or feature of the program been input and it's not something fcitx is able to help with.}}
  
 
==Troubleshooting==
 
==Troubleshooting==
===CTRL+Space does not work===
+
* Emacs
If you cannot invoke FCITX by pressing the CTRL+Space keyboard combination, but FCITX runs in background without problem, please check your [[locale]], and make sure your locale is un-commented in /etc/locale.gen.
+
If your LC_CTYPE is English, you may not be able to use input method in emacs due to a old emacs' bug. You can set your LC_CTYPE to something else such as "zh_CN.UTF-8" before emacs starts to get rid of this problem.
After that it seems that by simply change LC_CTYPE to zh_CN.UTF-8 (or probably any Chinese locale) will get it done for Chinese input.
+
 
 +
* Input method module
 +
{{Warning| You may still be able to use input method in most programs without the input method module, however, you may have unsolvable weird problems if you do so.}}
 +
 
 +
{{Warning| for firefox above version 13, the popup menu may fail to work due to xim, please make sure that fcitx-gtk2 along with a latest version fcitx are installed.}}
 +
 
 +
* Ctrl+Space fail to work in GTK2 programs
 +
 
 +
This problem sometimes happens especially when locale is set as English. Please make sure your GTK_IM_MODULE is set correctly.
 +
 
 +
See also [http://fcitx-im.org/wiki/FAQ#When_use_Ctrl_.2B_Space.2C_Fcitx_cannot_be_triggered_on FAQ]
  
===On KDE, CTRL+Space does not work on Firefox, Chromium etc. GTK applications===
+
If you have set the *_IM_MODULE environment variables to fcitx but cannot activate fcitx, please check if you have installed the corresponding input method modules.
  
Install {{Pkg|fcitx-gtk2}}, {{Pkg|fcitx-gtk3}}.
+
Some programs can only use xim, if you are using these programs, please make sure your XMODIFIERS is set properly and be aware of the problems you may have. These programs includes: all programs that are not using gtk or qt (e.g. programs that use tk, motif, or xlib directly), emacs, opera, openoffice, libreoffice, skype
  
 
==See also==
 
==See also==
* [http://fcitx.github.com/handbook/ User Handbook (Chinese)]
+
*[https://github.com/fcitx/fcitx/ Fcitx GitHub]
 +
*[https://code.google.com/p/fcitx/ Fcitx Google Code]
 +
*[http://fcitx-im.org/ Fcitx Wiki]

Revision as of 08:59, 18 February 2013

FCITX (Flexible Input Method Framework) is a input method framework aiming at providing environment independent language support for Linux. It supports a lot of different languages and also provides many useful non-CJK features.

Installation

fcitx can be installed with Pacman from the [community] repository.

In order to have a better experience in gtk and qt programs (especially gtk programs) (e.g. better cursor following) and get rid of many unsolvable problems/bugs caused by xim, please install the corresponding input method modules for gtk and qt: fcitx-gtk2 (for gtk2 programs), fcitx-gtk3 (for gtk3 programs) and fcitx-qt (for qt programs). You can install all four of them in a bundle by issuing this command:

 pacman -S fcitx-im

Using FCITX to Input

Before you can make use of FCITX for input, you have to setup some environment variables. It is quite simple.

  • Adding the following lines to your desktop startup script files (.xprofile or .profile when you are using KDM, GDM or LightDM, and .xinitrc when you are using startx or Slim). With these lines, fcitx will work along with gtk/qt input method modules and support xim programs (Please make sure the necessary input method modules are already installed):
 export GTK_IM_MODULE=fcitx
 export QT_IM_MODULE=fcitx
 export XMODIFIERS="@im=fcitx"

Optionally, you can also choose to use xim in your gtk and/or qt programs, in which case you need to change the corresponding lines above as following:

 export GTK_IM_MODULE=xim
 export QT_IM_MODULE=xim
Warning: Using xim can sometimes cause problems that are not solvable by any input method including not being able to input, no cursor following, application freeze on input method restart. For these xim related problems, Fcitx cannot provide any fix or support. This is the same with any other input method framework, so please use toolkit (gtk/qt) input method modules instead of xim whenever possible
  • Re-login to make such environment effective.

If you are using any XDG compatible desktop environment such as KDE, GNOME, XFCE, LXDE, after you relogin, the autostart should work out of box. If not, open your favorite terminal, type:

$ fcitx

To see if fcitx is working correctly, open an application such as leafpad and press CTRL+Space (the default shortcut for switching input method) to invoke FCITX and input some words.

If Fcitx failed to start with your desktop automatically or if you want to change the parameters to start fcitx, please use tools provided by your desktop environment to configure xdg auto start or edit the fcitx-autostart.desktop file in your ~/.config/autostart/ directory (copy it from /etc/xdg/autostart/ if it doesn't exist yet).

If your desktop environment does not support xdg auto start, please add the following command to your startup script (after the environment variables are set up properly).

$ fcitx

When other input methods with xim support is also running, Fcitx may fail to start due to xim error. Please make sure no other input method is running before you start Fcitx.

Configuration

Fcitx provides GUI configure tool. You can install either kcm-fcitx(based on kcm), fcitx-configtool(based on gtk3), or fcitx-configtool-gtk2AUR(based on gtk2, unsupported) from AUR.

Desktop Environment Integration

Gnome-Shell

You can install kimpanel from extensions.gnome.org or gnome-shell-extension-kimpanel-gitAUR package in AUR, which provides a similar user experience as ibus-gjs.

Remove all input source form gnome-control-center ,and clear all the hotkey for inputmethord.Use this command to disable ibus:

$gsettings set org.gnome.settings-daemon.plugins.keyboard active false

KDE

You can install kcm-fcitx and kdeplasma-addons-applets-kimpanel.

kcm-fcitx is a kcontrol module for fcitx.

kdeplasma-addons-applets-kimpanel is a plasmoids providing native feeling under kde. Simply add kimpanel to plasma and fcitx will automatically switch to it without extra configuration.

Install other components of fcitx

All components of fcitx will requires fcitx to restart after install.

Keyboard layout integration

fcitx-keyboard is now built-in supported. Open a configuration tool (kcm-fcitx or fcitx-configtool mentioned above), you might want to uncheck the "Show only current language" and find your keyboard layout.

In order to enable spell checking, press ctrl + alt + h when fcitx is on a input method provides by fcitx-keyboard. Then that's it, you can type long word, to see whether it works.

Chinese Input

fcitx built-in provides fcitx-pinyin and fcitx-table inside fcitx package, which supports Pinyin and table-based input method, for example, Wubi.

If you want better support for pinyin, you can install, fcitx-cloudpinyin, fcitx-sunpinyin, fcitx-googlepinyin or fcitx-libpinyin.

If you need Bopomofo support, you can install fcitx-chewing or fcitx-libpinyin.

If you need Cangjie, Zhengma, Boshiamy support, you can install fcitx-table-extraAUR in AUR.

Japanese Input Method

Install fcitx-anthy or fcitx-mozc.

Korean Input Method

Install fcitx-hangulAUR in AUR.

Other language

m17n provides quite a long other language support, you can install m17n support for fcitx with fcitx-m17n

Clipboard Access

You can use fcitx to input text in you clipboard (as well as a short clipboard history and primary selection). The default trigger key is Control-;. You can change the trigger key as well as other options in the Clipboard addon configure page.

NOTE: This is NOT a clipboard manager, it doesn't hold the selection or change it's content as what a clipboard manager is supposed to do. It can only be used to input from the clipboard.

Warning: Some client doesn't support multi-line input so you may see the multi-line clipboard content pasted as a single line using fcitx-clipboard. That's either a bug or feature of the program been input and it's not something fcitx is able to help with.

Troubleshooting

  • Emacs

If your LC_CTYPE is English, you may not be able to use input method in emacs due to a old emacs' bug. You can set your LC_CTYPE to something else such as "zh_CN.UTF-8" before emacs starts to get rid of this problem.

  • Input method module
Warning: You may still be able to use input method in most programs without the input method module, however, you may have unsolvable weird problems if you do so.
Warning: for firefox above version 13, the popup menu may fail to work due to xim, please make sure that fcitx-gtk2 along with a latest version fcitx are installed.
  • Ctrl+Space fail to work in GTK2 programs

This problem sometimes happens especially when locale is set as English. Please make sure your GTK_IM_MODULE is set correctly.

See also FAQ

If you have set the *_IM_MODULE environment variables to fcitx but cannot activate fcitx, please check if you have installed the corresponding input method modules.

Some programs can only use xim, if you are using these programs, please make sure your XMODIFIERS is set properly and be aware of the problems you may have. These programs includes: all programs that are not using gtk or qt (e.g. programs that use tk, motif, or xlib directly), emacs, opera, openoffice, libreoffice, skype

See also