Compiling fcitx5 - Revision history

Weng Xuetian at 15:21, 21 December 2022

2022-12-21T15:21:28Z

← Older revision		Revision as of 15:21, 21 December 2022
Line 55:		Line 55:
	The usual cmake/make/make install building process follows. If you enable [https://wiki.gnome.org/Projects/GObjectIntrospection GObject Introspection] (via the ENABLE_GIR CMake variable), <code>make install</code> will install some files to the system's GIR directories regardless of what CMAKE_INSTALL_PREFIX is set to.		The usual cmake/make/make install building process follows. If you enable [https://wiki.gnome.org/Projects/GObjectIntrospection GObject Introspection] (via the ENABLE_GIR CMake variable), <code>make install</code> will install some files to the system's GIR directories regardless of what CMAKE_INSTALL_PREFIX is set to.

	If you have installed it to a custom prefix, you'll need to update the GTK input method module cache. This is done by invoking <code>gtk-query-immodules-3.0</code> (or <code>gtk-query-immodules-3.0</code> for GTK 2) and setting GTK_PATH to point at fcitx5-gtk's GTK library install path beforehand. For example:		If you have installed it to a custom prefix, you'll need to update the GTK input method module cache. This is done by invoking <code>gtk-query-immodules-3.0</code> (or <code>gtk-query-immodules-2.0</code> for GTK 2) and setting GTK_PATH to point at fcitx5-gtk's GTK library install path beforehand. For example:

	GTK_PATH=/your/install/path/lib/gtk-3.0 gtk-query-immodules-3.0 --update-cache		GTK_PATH=/your/install/path/lib/gtk-3.0 gtk-query-immodules-3.0 --update-cache

Weng Xuetian at 19:02, 2 February 2022

2022-02-02T19:02:53Z

← Older revision		Revision as of 19:02, 2 February 2022
Line 1:		Line 1:
	~~'''(This article is a work in progress)'''~~

	While fcitx5 is provided as a package in many GNU/Linux distributions, some of them (such as Gentoo) don't officially provide it as of May 2020. This article aims to give general instructions on how to compile and install fcitx5 in your GNU/Linux system.		While fcitx5 is provided as a package in many GNU/Linux distributions, some of them (such as Gentoo) don't officially provide it as of May 2020. This article aims to give general instructions on how to compile and install fcitx5 in your GNU/Linux system.

Line 62:		Line 60:

	=== Input Methods ===		=== Input Methods ===
			For Mozc, please check [[Special:MyLanguage/Compiling Mozc\|Compiling Mozc]].

	Same procedure applies to input method addons like fcitx5-chinese-addons. but you likely want to make sure it's using the same prefix as fcitx5. Usually there is no cmake options needed, the most common one is to enable the GUI or not. You may look into the CMakeLists.txt in the root directory and look for <code>option(....)</code> lines.		Same procedure applies to input method addons like fcitx5-chinese-addons. but you likely want to make sure it's using the same prefix as fcitx5. Usually there is no cmake options needed, the most common one is to enable the GUI or not. You may look into the CMakeLists.txt in the root directory and look for <code>option(....)</code> lines.

Weng Xuetian at 02:34, 8 June 2021

2021-06-08T02:34:42Z

← Older revision		Revision as of 02:34, 8 June 2021
Line 30:		Line 30:
	Please note that installing to a non-standard path is not recommended.		Please note that installing to a non-standard path is not recommended.

	=== cldr-emoji-annotation ===		=== cldr-emoji-annotation/unicode-cldr ===
	fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. To install it to a custom prefix, run <code>PKG_CONFIG_PATH=$PWD ./configure --prefix=/your/install/path</code> instead (this commands assumes you're in the cldr-emoji-annotation directory).		fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. To install it to a custom prefix, run <code>PKG_CONFIG_PATH=$PWD ./configure --prefix=/your/install/path</code> instead (this commands assumes you're in the cldr-emoji-annotation directory).

			You may also simply disable it with <code>-DENABLE_EMOJI=Off</code>.

	=== fcitx5 ===		=== fcitx5 ===
Line 42:		Line 44:

	For example, an [https://i3wm.org/ i3] user who wishes to install it to /opt would run (likely with sudo privileges):		For example, an [https://i3wm.org/ i3] user who wishes to install it to /opt would run (likely with sudo privileges):
	cmake -DENABLE_WAYLAND=Off -DCMAKE_INSTALL_PREFIX=/~~opt~~ .		cmake -DENABLE_WAYLAND=Off -DCMAKE_INSTALL_PREFIX=/your/install/path .
	make		make
	make install		sudo make install

	=== fcitx5-qt ===		=== fcitx5-qt ===
Line 57:		Line 59:
	If you have installed it to a custom prefix, you'll need to update the GTK input method module cache. This is done by invoking <code>gtk-query-immodules-3.0</code> (or <code>gtk-query-immodules-3.0</code> for GTK 2) and setting GTK_PATH to point at fcitx5-gtk's GTK library install path beforehand. For example:		If you have installed it to a custom prefix, you'll need to update the GTK input method module cache. This is done by invoking <code>gtk-query-immodules-3.0</code> (or <code>gtk-query-immodules-3.0</code> for GTK 2) and setting GTK_PATH to point at fcitx5-gtk's GTK library install path beforehand. For example:

	GTK_PATH=/your/~~custom~~/~~pref~~/lib/gtk-3.0 gtk-query-immodules-3.0 --update-cache		GTK_PATH=/your/install/path/lib/gtk-3.0 gtk-query-immodules-3.0 --update-cache

	--		=== Input Methods ===
			Same procedure applies to input method addons like fcitx5-chinese-addons. but you likely want to make sure it's using the same prefix as fcitx5. Usually there is no cmake options needed, the most common one is to enable the GUI or not. You may look into the CMakeLists.txt in the root directory and look for <code>option(....)</code> lines.

	~~TODO: IM_MODULES envvars~~		cmake -DCMAKE_INSTALL_PREFIX=/your/install/path .
			make
			sudo make install

Serg: Document GTK im-module cache update

2020-05-22T12:26:24Z

Document GTK im-module cache update

← Older revision		Revision as of 12:26, 22 May 2020
Line 54:		Line 54:
	=== fcitx5-gtk ===		=== fcitx5-gtk ===
	The usual cmake/make/make install building process follows. If you enable [https://wiki.gnome.org/Projects/GObjectIntrospection GObject Introspection] (via the ENABLE_GIR CMake variable), <code>make install</code> will install some files to the system's GIR directories regardless of what CMAKE_INSTALL_PREFIX is set to.		The usual cmake/make/make install building process follows. If you enable [https://wiki.gnome.org/Projects/GObjectIntrospection GObject Introspection] (via the ENABLE_GIR CMake variable), <code>make install</code> will install some files to the system's GIR directories regardless of what CMAKE_INSTALL_PREFIX is set to.

			If you have installed it to a custom prefix, you'll need to update the GTK input method module cache. This is done by invoking <code>gtk-query-immodules-3.0</code> (or <code>gtk-query-immodules-3.0</code> for GTK 2) and setting GTK_PATH to point at fcitx5-gtk's GTK library install path beforehand. For example:

			GTK_PATH=/your/custom/pref/lib/gtk-3.0 gtk-query-immodules-3.0 --update-cache

	--		--

	TODO: IM_MODULES envvars		TODO: IM_MODULES envvars

Serg: fcitx5-gtk intro

2020-05-22T12:06:50Z

fcitx5-gtk intro

← Older revision		Revision as of 12:06, 22 May 2020
Line 53:		Line 53:

	=== fcitx5-gtk ===		=== fcitx5-gtk ===
			The usual cmake/make/make install building process follows. If you enable [https://wiki.gnome.org/Projects/GObjectIntrospection GObject Introspection] (via the ENABLE_GIR CMake variable), <code>make install</code> will install some files to the system's GIR directories regardless of what CMAKE_INSTALL_PREFIX is set to.
	~~TODO~~

	--		--

	TODO: IM_MODULES envvars		TODO: IM_MODULES envvars

Serg: Fix wrong formatting

2020-05-20T12:59:12Z

Fix wrong formatting

← Older revision		Revision as of 12:59, 20 May 2020
Line 14:		Line 14:
	* [https://github.com/json-c/json-c/wiki json-c]		* [https://github.com/json-c/json-c/wiki json-c]
	* dbus		* dbus
	* [~~fmt~~ https://fmt.dev]		* [https://fmt.dev fmt]
	* cldr-emoji-annotation*		* cldr-emoji-annotation*

Serg: Add dependency

2020-05-20T12:58:50Z

Add dependency

← Older revision		Revision as of 12:58, 20 May 2020
Line 14:		Line 14:
	* [https://github.com/json-c/json-c/wiki json-c]		* [https://github.com/json-c/json-c/wiki json-c]
	* dbus		* dbus
			* [fmt https://fmt.dev]
	* cldr-emoji-annotation*		* cldr-emoji-annotation*

Serg: Add content

2020-05-12T17:20:57Z

Add content

← Older revision		Revision as of 17:20, 12 May 2020
Line 9:		Line 9:
	* ECM (Extra CMake Modules)		* ECM (Extra CMake Modules)
	* GNU Make		* GNU Make
	* ~~libxcb~~ ([https://xcb.freedesktop.org/ X protocol C-language Binding])		* XCB ([https://xcb.freedesktop.org/ X protocol C-language Binding])
	* [https://libexpat.github.io/ Expat]		* [https://libexpat.github.io/ Expat]
	* [https://www.freedesktop.org/wiki/Software/pkg-config/ PkgConfig]		* [https://www.freedesktop.org/wiki/Software/pkg-config/ PkgConfig]
Line 30:		Line 30:

	=== cldr-emoji-annotation ===		=== cldr-emoji-annotation ===
	fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. To install it to a custom prefix, run <code>PKG_CONFIG_PATH=$PWD ./configure --prefix=/your/install/path</code> instead.		fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. To install it to a custom prefix, run <code>PKG_CONFIG_PATH=$PWD ./configure --prefix=/your/install/path</code> instead (this commands assumes you're in the cldr-emoji-annotation directory).

	=== fcitx5 ===		=== fcitx5 ===
Line 40:		Line 40:
	The user is encouraged to check the contents of CMakeLists.txt for an exhaustive list of options.		The user is encouraged to check the contents of CMakeLists.txt for an exhaustive list of options.

	For example, an [https://i3wm.org/ i3] user who wishes to install it to /opt would run:		For example, an [https://i3wm.org/ i3] user who wishes to install it to /opt would run (likely with sudo privileges):
	cmake -DENABLE_WAYLAND=Off -DCMAKE_INSTALL_PREFIX=/opt .		cmake -DENABLE_WAYLAND=Off -DCMAKE_INSTALL_PREFIX=/opt .
	make		make
	make install		make install

	~~TODO: IM_MODULE envvars~~		=== fcitx5-qt ===

	~~===~~ fcitx5-qt ~~===~~		fcitx5-qt is the Qt im-module for fcitx5 and it's needed to use fcitx5 with Qt-based applications. It currently supports Qt4 and Qt5. You'll need several Qt modules if you're going to enable Qt5 support, namely QtCore, QtDbus, QtWidgets and QtX11Extras. These usually come bundled in packages on some distributions. For example, on Gentoo you can check what packages include these modules [https://wiki.gentoo.org/wiki/Project:Qt/Qt5status here].

	~~TODO~~		Clone [https://github.com/fcitx/fcitx5-qt/ the repository]. Relevant CMake options are '''ENABLE_QT4''' and '''ENABLE_QT5'''. Both are turned on by default. You might want to turn off the flag related to the Qt version you aren't using. Then run <code>cmake</code> with the appropriate options,<code>make</code> and <code>make install</code> as usual. Please note that fcitx5-qt expects to be installed to the same prefix as the fcitx5 core.

	=== fcitx5-gtk ===		=== fcitx5-gtk ===

	TODO		TODO

			--

			TODO: IM_MODULES envvars

Serg at 12:46, 12 May 2020

2020-05-12T12:46:25Z

← Older revision		Revision as of 12:46, 12 May 2020
Line 27:		Line 27:
	cmake -DCMAKE_INSTALL_PREFIX=/your/install/path .		cmake -DCMAKE_INSTALL_PREFIX=/your/install/path .
	Then simply run <code>make</code> and <code>make install</code>.		Then simply run <code>make</code> and <code>make install</code>.
			Please note that installing to a non-standard path is not recommended.

	=== cldr-emoji-annotation ===		=== cldr-emoji-annotation ===
	fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. ~~It must be installed~~ to ~~the default directory so '''do not set~~ a prefix ~~to the~~ <code>./configure</code> ~~script'''~~.		fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. To install it to a custom prefix, run <code>PKG_CONFIG_PATH=$PWD ./configure --prefix=/your/install/path</code> instead.
	~~(TODO: it actually can be prefixed using a PkgConfig path, correct this)~~

	=== fcitx5 ===		=== fcitx5 ===

Serg: Add todo

2020-05-11T10:15:40Z

Add todo

← Older revision		Revision as of 10:15, 11 May 2020
Line 30:		Line 30:
	=== cldr-emoji-annotation ===		=== cldr-emoji-annotation ===
	fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. It must be installed to the default directory so '''do not set a prefix to the <code>./configure</code> script'''.		fcitx5 uses these for its emoji module. Some distributions (such as Void Linux) provide this package. Gentoo, on the other hand, does not, but there are user-maintained [https://wiki.gentoo.org/wiki/Ebuild_repository Portage overlays] that provide it such as [https://github.com/microcai/gentoo-zh gentoo-zh]. If you want to build it, [https://github.com/fujiwarat/cldr-emoji-annotation clone the repository] and run <code>./autogen.sh</code>, then <code>./configure</code>, <code>make</code> and <code>make install</code>. It must be installed to the default directory so '''do not set a prefix to the <code>./configure</code> script'''.
			(TODO: it actually can be prefixed using a PkgConfig path, correct this)

	=== fcitx5 ===		=== fcitx5 ===