Fcitx5 - ArchWiki

Jump to content

# Fcitx5

From ArchWiki

Related articles

- Fcitx
- IBus

Fcitx5 is an input method framework with a lightweight core, offering additional language support via addons. It is the successor to Fcitx.

## Installation

Install the fcitx5 package.

fcitx5-im group provides fcitx5 ontology, #Configuration tool, and necessary #Input method module.

Note: fcitx5 has only a basic framework, it just gives English support. If you want to input other languages, such as Chinese or Japanese, you need an Input Method Engine (IME).

### Chinese

- fcitx5-chewing is a popular Zhuyin input engine for Traditional Chinese based on libchewing.
- fcitx5-chinese-addons contains addons related to Chinese, such pinyin, shuangpin, wubi.
- fcitx5-rime, using the Rime engine.
- fcitx5-mcbopomofo-gitAUR McBopomofo for fcitx5.

### Japanese

- fcitx5-anthy, a popular Japanese input engine. However, it is not actively developed anymore.
- fcitx5-kkc, a Japanese Kana Kanji input engine, based on libkkc.
- fcitx5-mozc, based on Mozc, the Open Source Edition of Google Japanese Input.
- fcitx5-skk, a Japanese Kana Kanji input engine, based on libskk.

### Other languages

- fcitx5-hangul, for typing Korean hangul, based on libhangul.
- fcitx5-unikey, for typing Vietnamese characters.
- fcitx5-m17n or fcitx5-table-other, for typing other miscellaneous languages — use the latter for typing IPA (X-SAMPA).

### Input method module

To get a better experience, you should install the following modules as per your needs. Without them, the input method may still work on most applications but you might experience input method hang up, preview window screen location error, or no preview error.

- For Qt programs, install fcitx5-qt.
- For GTK programs, install fcitx5-gtk.
- For Qt4 programs, install fcitx5-qt4-gitAUR.
- For Qt5 programs, install fcitx5-qt5-gitAUR.
- For Qt6 programs, install fcitx5-qt6-gitAUR.
- For date and time support, install fcitx5-lua.

Tip: Generally, installing fcitx5-qt and fcitx5-gtk is enough to handle all situations.

## Usage

### Integration

Edit `/etc/environment` and add the following lines:

    GTK_IM_MODULE=fcitx
    QT_IM_MODULE=fcitx
    XMODIFIERS=@im=fcitx

Tip:

- See Environment variables for other possible ways to set these variables.
- Append `SDL_IM_MODULE=fcitx` for some games (like Dota2) that use a vendor-modified version of SDL2 library.

### Desktop Environment Autostart

If you want Fcitx5 to autostart when you start your desktop, see Fcitx#Desktop Environment Autostart.

Note:

- The location of the Fcitx5 startup file has changed, and it is currently `/usr/share/applications/org.fcitx.Fcitx5.desktop`.
- If you are using any XDG compatible desktop environment such as KDE, GNOME, Xfce, LXDE, after you re-login, the autostart should work out of the box.

Tip: To see if Fcitx5 is working correctly, open an application and press `Ctrl+Space` to switch between input methods (when configured), and input some words.

## Configuration

### Configuration tool

The configuration file of fcitx5 is located at `~/.config/fcitx5`. Although you can use a text editor to edit the configuration file, you might find a GUI configuration tool much more convenient, so install the fcitx5-configtool package.

### Disable overriding XKB settings

By default Fcitx5 overrides X keyboard settings. (The ones you can set with `setxkbmap` command or graphical tools provided by desktop environments.) If you don't want that, run `fcitx5-configtool` and uncheck Addons → XCB → Allow Overriding System XKB Settings.

### Themes

This article or section needs language, wiki syntax or style improvements. See Help:Style for reference.

Reason: Use Template:App. (Discuss in Talk:Fcitx5)

The number of default themes is limited, you can find more themes on GitHub.

- fcitx5-breezeAUR：Fcitx5 theme to match the KDE Breeze style.
- fcitx5-nord ：Nord Color Themes.
- fcitx5-material-color: This theme gives a feeling like Microsoft PinYin. Its official repository is located at GitHub: Fcitx5-Material-Color. Its README.md file shows some beautiful configurations of one-line mode.
- fcitx5-solarizedAUR: Solarized color theme for Fcitx5.

Tip: If you are using KCM, then switch themes with: Setting -> Location -> input method -> Configure addons -> Classic user interface -> Theme.

## Troubleshooting

### Diagnose problems

If you have problems using fcitx5, eg. if `Ctrl+Space` fails to work in all applications, then the first thing you should try is to diagnose using fcitx5-diagnose. The output of fcitx5-diagnose should contain clues for the most common problems.

### The newest WPS cannot use fcitx5

See WPS Office#Fcitx5 cannot input Chinese.

### Fcitx5 has position errors in JetBrains IDEs

The root cause is the JBR come from IDE is not sure fully. To solve this problem, need:

1. Download this jbr and extract it: https://github.com/RikudouPatrickstar/JetBrainsRuntime-for-Linux-x64/releases 2. Change IDE's JBR according https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under

### Emoji show abnormally in the candidate box

1. Confirm you have a font with emoji support installed. (Such as noto-fonts-emoji)

2. Set the system font as `Noto Sans CJK SC` for Simplified Chinese, for example.

3. Use this command to restart Fcitx5:

    # kill `ps -A | grep fcitx5 | awk '{print $1}'` && fcitx5 &

## Tips and tricks

### How to view the Unicode encoding of selected characters

- If you want to view the Unicode encoding of the selected text in a text editor, then directly select the text, and then use the shortcut keys `ctrl + alt + shift + u` to view the encoding of the selected text.

- If you want to view the Unicode encoding of some text in a non-editable area (such as this wiki), you need to first copy the text to the clipboard, then click on any editable area (such as the search box), and then use the shortcut keys `ctrl + alt + shift + u` to view the encoding of the text in the clipboard.

### Input special character

In general, for some simple symbols, such as `≤`, `ā`, `á`, `©`, etc., you can enter them through Configuring compose key, but for more special symbols, such as `②`, `③`, `④`, etc., you Either customize `~/.XCompose`, or use Fcitx5's Unicode function to achieve.

Take `①` as an example:

Position the cursor in any input box, and then press `Ctrl + Alt + Shift + U`, and then enter `circle one`, you will see a variety of `①`, other special characters are similar here.

### Switching Halfwidth / Fullwidth Punctuation

For fcitx5-chinese-addons, fullwidth punctuation is used by default, one may use `Ctrl + .` to switch between halfwidth and fullwidth punctuation.

Category:

- Input methods

Hidden category:

- Pages or sections flagged with Template:Style