From 3d7074b394788d07e28d8724d1d5db69ec16247d Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Fri, 8 May 2026 12:14:27 +0200 Subject: [PATCH 1/2] docs(linux): Update KB article about using Keyman with KDE --- knowledge-base/kb0101.md | 97 +++++++++------------------------------- 1 file changed, 20 insertions(+), 77 deletions(-) diff --git a/knowledge-base/kb0101.md b/knowledge-base/kb0101.md index 8b9e0787f..a13a8eb1b 100644 --- a/knowledge-base/kb0101.md +++ b/knowledge-base/kb0101.md @@ -3,110 +3,53 @@ Unfortunately when using the KDE desktop environment, the support for ibus (which Keyman for Linux uses underneath) isn’t that great. -## Prequisites +## Prerequisites + As a prerequisite it is assumed that KDE Plasma, Wayland, and sddm are installed and working. This is the base for the steps described below. The steps may be appropriate for other configurations, too. ## Installation and Configuration Steps + If you want to use Keyman with KDE you’ll have to do some manual steps. ### Step 1 Install Keyman package + In a terminal window, run: + ```bash sudo apt update sudo apt install keyman ``` + If not installed, this command installs the `ibus` package. This is just an example for the apt package manager, on another Linux platform there may be a different package manager and different package names. -### Step 2 Provide the environment variables required for the `ibus` input method framework - -The environment variables `"GTK_IM_MODULE"` and `"QT_IM_MODULE"` must be set -to `"ibus"`; `"XMODIFIERS"` to `"@im=ibus"`. - -This can be achieved by setting them in the `/etc/environment` file or by -putting a file containing the environment variables into the directory -`$HOME/.config/environment.d`. - -The format in both files is: - -```bash -GTK_IM_MODULE=ibus -XMODIFIERS=@im=ibus -QT_IM_MODULE=ibus -``` - -### Step 3 Auto-start the ibus daemon on every login - -This can be achieved by providing a file ending with `.desktop` in the -directory `$HOME/.config/autostart`. - -```bash -[Desktop Entry] -Exec=/ibus-start.sh -Icon=application-x-shellscript -Name=ibus-start -Type=Application -X-KDE-AutostartScript=true -``` - -The content of the `ibus-start.sh` file is: +### Step 2 Enable IBus Wayland as Virtual Keyboard -```bash -#!/bin/bash -ibus-daemon -dxrn kde -``` - -This may lead to an `IBus Notification` message box after logging in. +Open the Virtual Keyboard dialog by launching the System Settings utility and going to +"Input & Output" → "Keyboard" → "Virtual Keyboard". Select "IBus Wayland" and click +the "Apply" button to configure IBus in Wayland. +### Step 3 Add input methods to IBus -```bash -IBus should be called from the desktop session in Wayland. For KDE, you can -launch 'systemsettings5' utility and go to "Input Devices"->"Virtual Keyboard" -icon and select "Ibus Wayland" and click "Apply" button to configure Ibus in -Wayland. (...) -``` +When installing a Keyman keyboard it gets automatically added to IBus +as Input Method. -One option is ignoring the `IBus Notification`. IBus will be working. - -Another option is to follow the instructions in the `IBus Notification`. In this -case the local autostart actions are no longer required. Therefore before you -follow the instructions, remove the `.desktop` file described above. Because -another autostart mechanism will be used. - -Even then another `IBus Notification` box may appear. - -```bash -Please unset QT_IM_MODULE and GTK_IM_MODULE environment variables and -'ibus-daemon --panel disable' should be executed as a child process of -ibus-ui-gtk3 component. -``` - -> [!WARNING] -> Please do not follow these instructions. Leave the `QT_IM_MODULE` and -`GTK_IM_MODULE` environment variables set, otherwise some fonts won't be -correctly displayed with Keyman. - -### Step 4 Reboot so that the changes you made get applied to the new session - -Now you should be able to use Keyman for Linux and add and use Keyman keyboards. - -## Adding input methods to IBus - -Keyman keyboards installed have to be added to IBus as Input Method -(Launcher->"System"->"IBus Preferences"->"Input Method"). +If you used a different desktop environment like Gnome before, keyboards might show up in +"Keyman Configuration" but are not listed in IBus' Input Methods. In that case simply +re-install the keyboard in "Keyman Configuration". --- > [!NOTE] > It seems that some KDE specific programs like Konsole aren’t designed to work with ibus/Keyman keyboards. To test if a Keyman keyboard works you can test with gedit or LibreOffice Writer. - --- ## References -- https://wiki.debian.org/I18n/ibus -- https://wiki.archlinux.org/title/IBus -- https://help.ubuntu.com/community/ibus \ No newline at end of file + +- +- +- \ No newline at end of file From 412e21a29f93df519a1e16ed82209a24103a9b56 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Wed, 13 May 2026 10:55:17 +0200 Subject: [PATCH 2/2] docs(linux): small improvements --- knowledge-base/kb0101.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/knowledge-base/kb0101.md b/knowledge-base/kb0101.md index a13a8eb1b..cf6f8e2e6 100644 --- a/knowledge-base/kb0101.md +++ b/knowledge-base/kb0101.md @@ -44,12 +44,16 @@ If you used a different desktop environment like Gnome before, keyboards might s re-install the keyboard in "Keyman Configuration". --- -> [!NOTE] -> It seems that some KDE specific programs like Konsole aren’t designed to work with ibus/Keyman keyboards. To test if a Keyman keyboard works you can test with gedit or LibreOffice Writer. +> [!NOTE] +> It seems that some KDE specific programs like Konsole aren’t designed to work with ibus/Keyman keyboards. To test if a Keyman keyboard works, you can test with gedit or LibreOffice Writer. --- ## References - - -- \ No newline at end of file +- + +## Applies to + +- Keyman for Linux