Linux® From Scratch - Quality of Life (System V Edition) - Version #494b

Chapter 11. Fcitx

Fcitx5-5.1.12

Introduction to Fcitx5

The Fcitx5 package provides an extensible input method framework.

[Note]

Note

An Internet connection is needed for building this package. The system certificate store may need to be set up with make-ca before building this package.

Fcitx5 Dependencies

Required

CMake, dbus, extra-cmake-modules, fmt, JSON-C, libxcb, and xcb-imdkit-1.0.9

Recommended

cldr-emoji-annotation-38, enchant, and Wayland

Optional

doxygen (to build the documentation)

Installation of Fcitx5

Install Fcitx5 by running the following commands:

[Warning]

Warning

DO NOT disable the testing addons with the -D ENABLE_TESTING_ADDONS=OFF option. For some reason some Fcitx input methods depend on those, even when the test code is explicitly disabled. 

mkdir build &&
cd    build &&

cmake -D CMAKE_INSTALL_PREFIX=/usr   \
      -D CMAKE_BUILD_TYPE=Release    \
      -D CMAKE_SKIP_INSTALL_RPATH=ON \
      -D ENABLE_TEST=OFF             \
      -Wno-dev .. &&

make

If you have passed the -D ENABLE_DOC=ON parameter to CMake, build the documentation by executing the following commands: 

make doc

Now, as the root user: 

make install

If you have built the documentation, install it as the root user: 

install -v -m755 -d /usr/share/doc/fcitx5-5.1.12 &&
cp -rv doc/html/* /usr/share/doc/fcitx5-5.1.12

Under some desktop environments and most window managers, Fcitx will not be started automatically. Execute the following command as each user you want to use Fcitx as to avoid that: 

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

Command Explanations

-D CMAKE_SKIP_INSTALL_RPATH=ON: This switch makes cmake remove hardcoded library search paths (rpath) when installing a binary executable file or a shared library. This package does not need rpath once it's installed into the standard location, and rpath may sometimes cause unwanted effects or even security issues.

-D ENABLE_DOC=ON: Use this switch if you want to build the documentation (requires doxygen).

Configuring Fcitx5

Configuration Information

While this package has been installed, you will want an Input Method Engine in tandom with this package, such as Fcitx5-Anthy-5.1.6. Furthermore, you will want to ensure you can actually use this package. Read the Fcitx5 Wiki for more information on how to set it up.

Contents

Installed Programs: comp-spell-dict, fcitx5, fcitx5-configtool, fcitx5-diagnose, fcitx5-remote, and fcitx5-wayland-launcher
Installed Libraries: libFcitx5Config, libFcitx5Core, and libFcitx5Utils
Installed Plugins: libclassicui, libclipboard, libdbus, libdbusfrontend, libemoji, libfcitx4frontend, libibusfrontend, libimselector, libkimpanel, libnotificationitem, libnotifications, libquickphrase, libspell, libtestfrontend, libtestim, libtestui, libunicode, libvirtualkeyboard, libwayland, libwaylandim, libxcb, and libxim
Installed Directories: /usr/include/Fcitx5, /usr/lib/fcitx5, /usr/share/fcitx5, and /usr/share/doc/fcitx5-5.1.12

Short Descriptions

comp-spell-dict

compiles a spell dictionary for the spell plugin

fcitx5

is the Fcitx server

fcitx5-configtool

is a wrapper which autodetects and runs a suitable Fcitx configuration tool

fcitx5-diagnose

is a script that fetches diagnostic data for bug reports

fcitx5-remote

is a control tool for the Fcitx server

fcitx5-wayland-launcher

is a helper tool for launching Fcitx within a Wayland compositor

libFcitx5Config

is a library for parsing Fcitx configuration files

libFcitx5Core

is the Fcitx core library

libFcitx5Utils

contains Fcitx utility functions