+-----------------------------------------------------------------------
| Running fcitx on OpenBSD
+-----------------------------------------------------------------------

The "fcitx" package provides a framework for multilingual typing.
You will also need to install packages providing support for your
chosen languages and graphical environments (e.g. Qt, GTK+).

A basic installation of fcitx would be:

	# pkg_add fcitx fcitx-configtool-qt fcitx-gtk fcitx-qt
	# pkg_add $YOUR_PREFERRED_INPUT_METHOD

then configure fcitx to start with your DE/WM and setup your IM
engine. For Chinese/Japanese/Korean users, remember to install a font
with CJK support. To install noto-cjk:

	# pkg_add noto-cjk

|=============================================================|
| Language/Method    | Language engine package to install     |
|=============================================================|
| M17N               | fcitx-m17n                             |
| Vietnamese Telex   | fcitx-unikey                           |
| Korean             | fcitx-hangul                           |
| Japanese           | fcitx-kkc / fcitx-anthy                |
| Symbols (e.g. IPA) | fcitx-table-other                      |
| Other tables [1]   | fcitx-table-other                      |
|=============================================================|

[1]: https://github.com/fcitx/fcitx5-table-other/tree/master/tables

Chinese Method
==============

For PinYin / CangJie / ShuangPin / WuBi / ErBi / ZiRanMa, install
fcitx-chinese-addons.

For ZhengMa / Boshiamy / Quick and other WuBi / CangJie tables,
install fcitx-table-extra.

For ZhuYin, install fcitx-chewing.

Starting fcitx
===============

You need to start fcitx with your desktop environment/window manager
for it to be useful. If your desktop environment supports XDG Autostart,
fcitx should start automatically. Otherwise, add the following lines
to ~/.xsession *BEFORE INVOKING YOUR DE/WM* and then login again:

export XMODIFIERS=@im=fcitx
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx
/usr/local/bin/fcitx5 &

To use fcitx with kitty terminal, also add the following line:

export GLFW_IM_MODULE=ibus

Setting up input engines
========================

To setup an input engine, run fcitx5-configtool after starting fcitx5,
then select and add your preferred input method from the Avaliable
Input Method panel. You might need to uncheck 'Only Show Current
Language' to find your preferred input method.

If using KDE Plasma, you can also setup your input method via:

  System Settings -> Regional Settings -> Input Method

For more information, please refer to Fcitx's wiki page:
https://www.fcitx-im.org/wiki/Setup_Fcitx_5

You might be the only one speaking a particular language, please
help improve the i18n support by reporting what works well and what does
not. So that issues are known and a solution can be worked on.

Troubleshooting
===============

Fcitx includes fcitx5-diagnose, a tool to help you troubleshoot.
If you need to send a bug report, remember to attach a copy of its
output, with sensitive information removed.

Known issues
============

- Some emoji characters cannot be rendered and will instead be
  displayed as blank spaces

Migrating from fcitx4
=====================

Pinyin and table input method engines were previously included in fcitx4.
These are now packaged separately as "fcitx-chinese-addons", install
it to use those methods.
