Fcitx - User contributions [en]

Setup Fcitx 5/zh-cn

2024-01-11T19:16:00Z

Winson:

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[https://www.youtube.com/watch?v=FwqTtGEN4vQ 针对 Fedora 36 KDE 的操作说明]。这个操作说明应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora package]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== 非 XDG 兼容的窗口管理器/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5.

另请注意，weston 有一个 bug，在首次运行时不会正确设置 DISPLAY 为输入法。您可能需要终止 fcitx5 一次才能使其正确设置 DISPLAY，或使用 OpenX11Connection dbus 调用来连接 fcitx。

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

此[https://youtu.be/8XDmLr6wb4M 视频]演示了如何在 Archlinux 上手动设置环境变量

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/7/zh-cn

2024-01-11T19:16:00Z

Winson:

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora package]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

Setup Fcitx 5/zh-cn

2023-12-07T04:20:24Z

Winson:

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== 非 XDG 兼容的窗口管理器/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5.

另请注意，weston 有一个 bug，在首次运行时不会正确设置 DISPLAY 为输入法。您可能需要终止 fcitx5 一次才能使其正确设置 DISPLAY，或使用 OpenX11Connection dbus 调用来连接 fcitx。

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/13/zh-cn

2023-12-07T04:20:24Z

Winson:

== 非 XDG 兼容的窗口管理器/Wayland Compoistor ==

Setup Fcitx 5/zh-cn

2023-12-07T04:19:14Z

Winson: Created page with "另请注意，weston 有一个 bug，在首次运行时不会正确设置 DISPLAY 为输入法。您可能需要终止 fcitx5 一次才能使其正确设置 DISPLAY，或使..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5.

另请注意，weston 有一个 bug，在首次运行时不会正确设置 DISPLAY 为输入法。您可能需要终止 fcitx5 一次才能使其正确设置 DISPLAY，或使用 OpenX11Connection dbus 调用来连接 fcitx。

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/20/zh-cn

2023-12-07T04:19:14Z

另请注意，weston 有一个 bug，在首次运行时不会正确设置 DISPLAY 为输入法。您可能需要终止 fcitx5 一次才能使其正确设置 DISPLAY，或使用 OpenX11Connection dbus 调用来连接 fcitx。

Setup Fcitx 5/zh-cn

2023-12-07T04:16:51Z

Winson: Created page with "如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/19/zh-cn

2023-12-07T04:16:51Z

Winson: Created page with "如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5."

如果你出于调试目的只在 X11 中运行 weston，最简单的方法是在启动 weston 前退出 fcitx5.

Setup Fcitx 5/zh-cn

2023-12-07T04:15:41Z

Winson: Created page with "如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。"

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/18/zh-cn

2023-12-07T04:15:41Z

Winson: Created page with "如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。"

如果你已经在同一个会话中运行 fcitx5，当你为了调试和 fcitx5 尝试在 nested mode 中使用 weston 时，会存在特定的问题。

Translations:Setup Fcitx 5/17/zh-cn

2023-12-07T04:13:43Z

Winson: Created page with "<nowiki>[input-method] path=/usr/bin/fcitx5</nowiki>"

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

Setup Fcitx 5/zh-cn

2023-12-07T04:13:34Z

Winson: Created page with "如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/16/zh-cn

2023-12-07T04:13:34Z

如果你希望使用 westons zwp_input_method_v1 实现，你需要确保以下内容存在 ~/.config/weston.ini 文件中（如果路径不是 /usr/bin/fcitx5 请做相应修改）。

Setup Fcitx 5/zh-cn

2023-12-07T04:12:16Z

Winson: Created page with "=== Weston === Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。"

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/15/zh-cn

2023-12-07T04:12:16Z

Winson: Created page with "=== Weston === Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。"

=== Weston ===
Weston 是一个 wayland compositor 的参考实现，并不是普通用户的常规配置。

Setup Fcitx 5/zh-cn

2023-12-07T04:11:21Z

Winson: Created page with "在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。"

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/14/zh-cn

2023-12-07T04:11:21Z

Winson: Created page with "在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。"

在不支持 XDG Autostart 的场景中，请检查你的窗口管理器的手册中关于如何在系统启动时自动运行应用程序的方法。

Translations:Setup Fcitx 5/13/zh-cn

2023-12-07T04:10:04Z

Winson: Created page with "== Non-XDG compliant Window Manager/Wayland Compoistor =="

== Non-XDG compliant Window Manager/Wayland Compoistor ==

Setup Fcitx 5/zh-cn

2023-12-07T04:09:47Z

Winson: Created page with "打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5""

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/12/zh-cn

2023-12-07T04:09:46Z

Winson: Created page with "打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5""

打开 systemsettings，转到 "Virtual Keyboard" 部分，将输入法从 "None" 改为 "Fcitx 5"

Setup Fcitx 5/zh-cn

2023-12-07T04:08:29Z

Winson: Created page with "== KWin Wayland 5.24+ == 如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/11/zh-cn

2023-12-07T04:08:29Z

== KWin Wayland 5.24+ ==
如果你只使用 Gtk/Qt/Xwayland 应用，那么你不需要这里的操作。如果你希望使用支持 text-input-v3 的原生 wayland 应用，则需要让 KWin 将输入法作为一个特殊的客户端启动。

Translations:Setup Fcitx 5/10/zh-cn

2023-12-07T04:05:59Z

Winson: Created page with "<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>"

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

Setup Fcitx 5/zh-cn

2023-12-07T04:05:41Z

Winson: Created page with "特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autos..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/9/zh-cn

2023-12-07T04:05:41Z

特定的发行版可能没有提供这个文件，如未提供，你可以直接复制 <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> 到 <code>~/.config/autostart</code>

Setup Fcitx 5/zh-cn

2023-12-07T04:03:28Z

Winson:

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/6/zh-cn

2023-12-07T04:03:28Z

Winson:

[Video instruction for Fedora 36 KDE]. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

Setup Fcitx 5/zh-cn

2023-12-07T04:03:20Z

Winson:

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/7/zh-cn

2023-12-07T04:03:20Z

Winson:

=== fcitx5-autostart (Fedora) ===
这是一个 [fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

Setup Fcitx 5/zh-cn

2023-12-07T04:03:11Z

Winson: Created page with "=== fcitx5-autostart (Fedora) === 这是一个 [ fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
这是一个 [ fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/7/zh-cn

2023-12-07T04:03:11Z

=== fcitx5-autostart (Fedora) ===
这是一个 [ fedora 软件包]，打包了一个用于设置环境变量和 XDG autostart file 的 /etc/profile.d 脚本，可用于自启动。

Setup Fcitx 5/zh-cn

2023-12-07T03:56:25Z

Winson: Created page with ". 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。"

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/6/zh-cn

2023-12-07T03:56:25Z

Winson: Created page with ". 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。"

. 这个向导应该适用于除 GNOME 外的 XDG 兼容桌面。

Translations:Setup Fcitx 5/8/zh-cn

2023-12-07T03:51:47Z

Winson: Created page with "== XDG Autostart =="

== XDG Autostart ==

Setup Fcitx 5/zh-cn

2023-12-07T03:47:30Z

Winson: Created page with "=== imsettings (Fedora) === 这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/5/zh-cn

2023-12-07T03:47:30Z

=== imsettings (Fedora) ===
这是一个与 im-config 类似的程序，它也提供了 GUI 来选择要使用的输入法框架。imsettings 应该是被默认安装的，如果没有，你可以手动安装它。imsettings 可以设置环境变量并且启动相应的输入法，它还提供了一个图形化的前端用于修改配置。你需要做的就是简单地执行<code>im-chooser</code>，log-out 然后再次 log-in。

Setup Fcitx 5/zh-cn

2023-12-07T03:42:19Z

Winson: Created page with "=== im-config (Debian/Debian-based/Ubuntu) === 这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</co..."

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

=== imsettings (Fedora) ===
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/4/zh-cn

2023-12-07T03:42:19Z

=== im-config (Debian/Debian-based/Ubuntu) ===
这是一个用于 Debian 和 Debian-based 发行版的工具。在登录到 GUI 之后，从命令行执行 <code>im-config</code>，应该会弹出一个向导程序，在其中选择 fcitx5 即可。

Setup Fcitx 5/zh-cn

2023-12-07T03:40:04Z

Winson: Created page with "特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。"

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

=== im-config (Debian/Debian-based/Ubuntu) ===
This is a tool used by debian or debian based distribution. Just run <code>im-config</code> from command line after login to your graphics interface and it should pop up a wizard, just select fcitx5 from it.

=== imsettings (Fedora) ===
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/3/zh-cn

2023-12-07T03:40:03Z

Winson: Created page with "特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。"

特定的发行版可能会提供一些用于自动启动 Fcitx 的工具，并且这些工具通常也会设置环境变量。

Setup Fcitx 5/zh-cn

2023-12-07T03:39:10Z

Winson: Created page with "== 特定发行版中的工具 =="

<languages />
= 开机自启动 =

== 特定发行版中的工具 ==

Distribution may provides some specific tool for autostart Fcitx and usually also set up environment variable together.

=== im-config (Debian/Debian-based/Ubuntu) ===
This is a tool used by debian or debian based distribution. Just run <code>im-config</code> from command line after login to your graphics interface and it should pop up a wizard, just select fcitx5 from it.

=== imsettings (Fedora) ===
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/2/zh-cn

2023-12-07T03:39:10Z

Winson: Created page with "== 特定发行版中的工具 =="

== 特定发行版中的工具 ==

Setup Fcitx 5/zh-cn

2023-12-07T03:38:33Z

Winson: Created page with "= 开机自启动 ="

<languages />
= 开机自启动 =

== Distribution specific tool ==

Distribution may provides some specific tool for autostart Fcitx and usually also set up environment variable together.

=== im-config (Debian/Debian-based/Ubuntu) ===
This is a tool used by debian or debian based distribution. Just run <code>im-config</code> from command line after login to your graphics interface and it should pop up a wizard, just select fcitx5 from it.

=== imsettings (Fedora) ===
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/1/zh-cn

2023-12-07T03:38:33Z

Winson: Created page with "= 开机自启动 ="

= 开机自启动 =

Setup Fcitx 5/zh-cn

2023-12-07T03:37:58Z

Winson: Created page with "设置 Fcitx 5"

<languages />
= Autostart =

== Distribution specific tool ==

Distribution may provides some specific tool for autostart Fcitx and usually also set up environment variable together.

=== im-config (Debian/Debian-based/Ubuntu) ===
This is a tool used by debian or debian based distribution. Just run <code>im-config</code> from command line after login to your graphics interface and it should pop up a wizard, just select fcitx5 from it.

=== imsettings (Fedora) ===
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.

[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) ===
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart ==

Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>

<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ ==
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.

Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor ==

In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston ===
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.

If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).

<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>

There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.

If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.

Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables =

Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile ==
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.

* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login

If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.

The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>

Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.

Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile ==
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile ==
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d ==
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.

This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.

The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so ==
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.

If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.

Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh ==
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup ==
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus =
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 =

See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

Translations:Setup Fcitx 5/Page display title/zh-cn

2023-12-07T03:37:58Z

Winson: Created page with "设置 Fcitx 5"

设置 Fcitx 5

Setup Fcitx 5

2023-12-07T03:35:02Z

Winson: Marked this version for translation

<languages />
<translate>
= Autostart = 

== Distribution specific tool == 


Distribution may provides some specific tool for autostart Fcitx and usually also set up environment variable together.

=== im-config (Debian/Debian-based/Ubuntu) === 
This is a tool used by debian or debian based distribution. Just run <code>im-config</code> from command line after login to your graphics interface and it should pop up a wizard, just select fcitx5 from it.

=== imsettings (Fedora) === 
A program that is similar to im-config, and it also provides a GUI to select the input method framework to be used. Under default installation, imsettings should be installed by default, if not, you may install that. imsettings can setup the environment variable and also launch the input method correspondingly. It also provides a graphical frontend [https://pkgs.org/search/?q=im-chooser im-chooser] to change the configuration. What you need to do is simply execute <code>im-chooser</code>, log-out and log-in again.


[https://www.youtube.com/watch?v=FwqTtGEN4vQ Video instruction for Fedora 36 KDE]. This instruction should work for other non-GNOME XDG-compliance desktop.

=== fcitx5-autostart (Fedora) === 
This is a [https://pkgs.org/search/?q=fcitx5-autostart fedora package] that bundles a /etc/profile.d script for setting up environment variables and also XDG autostart file for autostart.

== XDG Autostart == 


Certain distribution may not provide such a file. If not, you can simply copy <code>/usr/share/applications/org.fcitx.Fcitx5.desktop</code> to <code>~/.config/autostart</code>


<nowiki>mkdir -p ~/.config/autostart && cp /usr/share/applications/org.fcitx.Fcitx5.desktop ~/.config/autostart</nowiki>

== KWin Wayland 5.24+ == 
You do not have to do this if you use only Gtk/Qt/Xwayland application. If you want to use wayland native applications supporting text-input-v3, you will need to let KWin start input method as a special client.


Simply open systemsettings, go to the "Virtual Keyboard" section, change the input method from "None" to "Fcitx 5".

== Non-XDG compliant Window Manager/Wayland Compoistor == 


In those case may not support XDG Autostart, please check your Window Manager manual about how to automatically launch a program upon start.

=== Weston === 
Weston is a reference wayland compositor implementation, which is not a common setup for normal user.


If you want to use the westons zwp_input_method_v1 implementation, you will need to have following content in your ~/.config/weston.ini (Update the path accordingly for if it is not /usr/bin/fcitx5).


<nowiki>[input-method]
path=/usr/bin/fcitx5</nowiki>


There are certain issues if you try to use weston in a nested mode for debugging and fcitx5, if you already have a running fcitx5 in the same session.


If you just run weston under X11 for debugging purpose, easiest way is to simply quit fcitx5 before start weston.


Also be aware, there is a bug that weston does not set DISPLAY correctly input method on the first run. You may need to kill fcitx5 once to make it get the right DISPLAY or use OpenX11Connection dbus call to let fcitx to connect.

= Environment variables = 


Due to the transition phase in a lot of different places, there is no perfect solution that works for every one. Please choose your own solution based on your environment. Basically what you want to do is to set following environment variables for your desktop session.
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>
Though it looks like valid shell script, please *NOTE* that the snippet above is just to demonstrate what these value gonna be. Please check the section below for concrete syntax for different methods.

== Login shell profile == 
If you are using Bash as your login shell, <code>~/.bash_profile</code> is the best user-level thing you can rely on. It is widely supported by different DMs and will also work if you start graphics from TTY.


* Supported by mainstream Display manager, including GDM/SDDM/LightDM
* TTY login


If you are not using bash, you may want to double check if your shell profile can be used as a place to set environment variables, especially you are using some uncommon login shells.


The snippet that you need to add to <code>~/.bash_profile</code> would be
<nowiki>
export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx</nowiki>


Some may argue that <code>~/.profile</code> is a shell agnostic solution, which is wrong. While GDM always source this file, SDDM/Bash would not source this file if <code>~/.bash_profile</code> presents. This makes <code>~/.bash_profile</code> a better solution because bash is quite widely used. But check your login shell before proceeding, some distribution may not use bash as default shell.


Here is an [https://youtu.be/8XDmLr6wb4M video] on how to manual setup environment variable on Archlinux

== /etc/profile == 
Best option if you does not care about modifying a file with root. This file is generally supported by all distribution. The code snippet that you need to append to the end of <code>/etc/profile</code> is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== ~/.xprofile == 
An old perfect option if you are using X11 and display manager. But there is no counterpart for Wayland, so it is not ideal if you want to set environment variable for Wayland. The code that you want to add is same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== environment.d == 
This is a new configuration that introduced by system.d, but not widely used supported by desktop environment or display manager. It is basically the environment configuration for systemd user unit. Currently, it is only supported by GDM or Plasma 5.22+. As GDM, it means any session that login with GDM will work. As for Plasma, it means it works for Plasma regardless what DM you are using.


This configuration is applied upon your first user session login and persist afterwards unless you manually stop the systemd user. So after you modifies this configuration, the easiest way to make it effective is to reboot your system.


The syntax is similar to shell, but no <code>export</code> is required. For example, you can create a file <code>~/.config/environment.d/im.conf</code> with following content:
<nowiki>
XMODIFIERS=@im=fcitx
GTK_IM_MODULE=fcitx
QT_IM_MODULE=fcitx</nowiki>

== pam_env.so == 
This is an obsolete solution for following reasons:
* pam deprecate user level configuration <code>~/.pam_environment</code> since 1.5.0.
* Some distribution does not enable pam_env in their pam configuration.


If you know it works for your system, you can put following snippet to your <code>~/.pam_environment</code>.
<nowiki>XMODIFIERS DEFAULT=\@im=fcitx
GTK_IM_MODULE DEFAULT=fcitx
QT_IM_MODULE DEFAULT=fcitx</nowiki>.


Please '''NOTE''' that the syntax is different from shell script.

== ~/.config/plasma-workspace/env/*.sh == 
A env script location that only works for Plasma desktop, you need to create your own .sh file, e.g. <code>~/.config/plasma-workspace/env/im.sh</code> and put the code snippet same as [[Special:myLanguage/Setup Fcitx 5#Login in shell profile|login shell]].

== Other less common setup == 
There are some other variable that might be useful certain applications.
=== SDL_IM_MODULE ===
Set the value to fcitx. Only SDL2 requires this. SDL1 uses XIM.
=== GLFW_IM_MODULE ===
This is a variable only used by [https://github.com/kovidgoyal/kitty/ kitty]. You need to set it to `GLFW_IM_MODULE=ibus`.
=== Binary Qt application ===
Due to Qt 5 does not support XIM, and it only bundles ibus im module, you may want to set `QT_IM_MODULE=ibus` for Qt application that does not use your system Qt library. (It may still not work because certain Qt application does not even bundle any im module).

= DBus = 
On most distribution that ships with systemd, this should no longer be an issue. But if you are using some so called "systemd" free distribution, you may need to start DBus yourself and set the relevant environment variables. Usually, this can be done by adding a line in like this in your start up script. E.g. ~/.xprofile if you are using X11. Also you need to make sure this syntax works for your login shell.

<nowiki>eval `dbus-launch --sh-syntax --exit-with-session`</nowiki>

= Configure Fcitx 5 = 


See [[Special:myLanguage/Configtool (Fcitx 5)|Configtool (Fcitx 5)]].

</translate>

Fcitx 5/zh-cn

2023-12-07T03:29:57Z

Winson:

<languages/>

小企鹅输入法（Fcitx 读作[ˈfaɪtɪks]）是一个支持扩展的输入法框架。目前，它支持Linux操作系统，以及如freebsd这样的Unix操作系统。Fcitx 通过使用各种各样的输入法引擎来支持全世界大量不同种类的语言。

Fcitx本身的核心实现非常简单，它通过使用插件来提供强大的功能。fcitx可以非常容易的进行定制以满足不同的个性化需求。

[[Special:myLanguage/Fcitx|导航至旧版的 Fcitx 4 Wiki页面?]]

==== 用户 ====

* [[Special:myLanguage/Install Fcitx 5|如何安装 Fcitx 5]]
* [[Special:myLanguage/Setup Fcitx 5|设置 Fcitx 5]]
* 安装 [[Special:myLanguage/Input method engines|输入法引擎]]
* [[Special:myLanguage/Theme Customization|定制您的输入法主题]]
* [[Special:myLanguage/FAQ|常见问题]]
* [[Special:myLanguage/Using Fcitx 5 on Wayland|在 Wayland 上使用 Fcitx 5]]

==== 开发者 ====

* [[Special:myLanguage/Compiling fcitx5|如何编译 fcitx5]]
* [[Special:myLanguage/Basic concept|基本概念]]
* [[Special:myLanguage/Develop an simple input method|如何开发一个简单的输入法]]
* [[Special:myLanguage/Q&A for developer|开发者常见问题与解答]]
* [[Special:myLanguage/Debug fcitx5|调试 fcitx5]]

==== 新闻 ====

<rss max=5>https://politepol.com/fd/hhM5BOjZLblk</rss>

== 如何帮助 Fcitx ==
* 给你的朋友推荐Fcitx输入法
* [[Special:myLanguage/Report Bug|报告漏洞]]
* [[Special:myLanguage/Contribute to this Wiki|为Wiki做贡献]] ('''请在申请你的帐号之前仔细阅读此页面''')
* [[Special:myLanguage/Donate|捐助]]

== 关于 ==
* [[Special:myLanguage/History|Fcitx的历史]]

Translations:Fcitx 5/5/zh-cn

2023-12-07T03:29:57Z

Winson:

* [[Special:myLanguage/Install Fcitx 5|如何安装 Fcitx 5]]
* [[Special:myLanguage/Setup Fcitx 5|设置 Fcitx 5]]
* 安装 [[Special:myLanguage/Input method engines|输入法引擎]]
* [[Special:myLanguage/Theme Customization|定制您的输入法主题]]
* [[Special:myLanguage/FAQ|常见问题]]
* [[Special:myLanguage/Using Fcitx 5 on Wayland|在 Wayland 上使用 Fcitx 5]]