Skip to content

Commit ed00674

Browse files
committed
integration: simplify Input Method section
Many things have changed since 3c0ad00: - Setting environment variables like `GTK_IM_MODULE=fcitx` is now discouraged by Fcitx5 - IBus now supports input-method-v2 protocol - Chromium now supports text-input-v3 protocol
1 parent aa9456c commit ed00674

File tree

1 file changed

+9
-69
lines changed

1 file changed

+9
-69
lines changed

src/integration.md

Lines changed: 9 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -346,74 +346,19 @@ alive. See the documentation of the individual tools for further information.
346346

347347
# 11. Input Method {#input-method}
348348

349-
Input methods like Fcitx5 and IBus provide modules for GTK and Qt and an
350-
interface for xserver (xwayland) using D-Bus without wayland protocols.
349+
Input methods (e.g. Fcitx5, IBus) intercepts text inputs in applications and
350+
compose them to other forms, like Chinese/Japanese/Korean or accented characters.
351351

352-
You can enable input method for those platforms by setting environment
353-
variables like this:
352+
## Fcitx5
354353

355-
```
356-
export GTK_IM_MODULE=fcitx
357-
export QT_IM_MODULE=fcitx
358-
export XMODIFIERS=@im=fcitx
359-
```
360-
361-
<!-- TODO: remove "in the master branch" when labwc 0.7.2 is released -->
362-
For apps not running on those platforms (e.g. Alacritty), labwc supports
363-
the following wayland protocols in the master branch:
364-
365-
- [text-input-v3]
366-
- Used by winit apps (e.g. Alacritty) and GTK (without setting
367-
`GTK_IM_MODULE` environment variable).
368-
- [input-method-v2]
369-
- Supported by Fcitx5, but not by IBus yet
370-
([issue](https://github.com/ibus/ibus/issues/2182)).
371-
372-
Here is a quick guide for using Fcitx5 in labwc:
373-
374-
1. Install fcitx5, GTK/Qt modules, configtool and language-specific module.
375-
- Arch Linux: `pacman -S fcitx5-im fcitx5-mozc`
376-
- Ubuntu: `apt install fcitx5 fcitx5-mozc`
377-
378-
Replace `fcitx5-mozc` with a module for your language.
379-
380-
2. Set `GTK_IM_MODULE`, `QT_IM_MODULE` and `XMODIFIERS` like described earlier.
381-
These are usually saved in files like `~/.config/labwc/environment`,
382-
`~/.profile` and `/etc/environment`.
383-
384-
3. Start `fcitx5`. You can automatically start fcitx5 by adding `fcitx5 &` to
385-
`~/.config/labwc/autostart`.
354+
Fcitx5 can be started with the command `fcitx5`. Use `fcitx5-configtool` to
355+
set up hotkeys and enable language-specific modules (e.g. fcitx5-mozc).
386356

387-
4. Configure Fcitx5 with configtool to enable the installed language-specific
388-
module and to set up hotkeys. See [Configtool (Fcitx 5) - Fcitx].
357+
## IBus
389358

390-
5. Activate input method with hotkeys while typing in applications.
391-
392-
<!--- TODO: remove this once Chromium supports text-input-v3 -->
393-
## Input method on Chromium
394-
395-
Chromium (and Electron-based) apps don't support the [text-input-v3] protocol
396-
[at this point](https://chromium-review.googlesource.com/c/chromium/src/+/3750452).
397-
So if you want to use IME with Chromium under labwc, you have following options:
398-
399-
1. Run Chromium under XWayland
400-
401-
This is the default option. However, some features like touchpad gesture
402-
don't work.
403-
404-
2. Use GTK IM Module
405-
406-
By running Chromium with `--enable-features=UseOzonePlatform --ozone-platform=wayland --gtk-version=4`,
407-
you can enable IME with GTK IM Module (selected by `GTK_IM_MODULE`) under
408-
wayland. However, IME popups might be incorrectly positioned.
409-
410-
3. Patch labwc and use [text-input-v1] protocol
411-
412-
Since [text-input-v1] is an outdated protocol, labwc doesn't officially
413-
support it. However, you can optionally add support for it by installing
414-
labwc from the [unofficial AUR](https://aur.archlinux.org/packages/labwc-im)
415-
or by applying its patch. Then, you can enable IME with [text-input-v1] by
416-
running Chromium with `--enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime`.
359+
IBus can be started with the command `ibus start --type=wayland`.
360+
Use `ibus-setup` to set up hotkeys and enable language-specific modules
361+
(e.g. ibus-anthy).
417362

418363
# 12. Gtk {#gtk}
419364

@@ -442,11 +387,6 @@ without using the `ibus` package. See [#3068] for details.
442387
[labwc-portals.conf]: https://github.com/labwc/labwc/blob/master/data/labwc-portals.conf
443388
[portal-user-home]: https://flatpak.github.io/xdg-desktop-portal/docs/portals.conf.html
444389

445-
[text-input-v3]: https://wayland.app/protocols/text-input-unstable-v3
446-
[input-method-v2]: https://wayland.app/protocols/input-method-unstable-v2
447-
[Configtool (Fcitx 5) - Fcitx]: https://fcitx-im.org/wiki/Configtool_(Fcitx_5)
448-
[text-input-v1]: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/unstable/text-input/text-input-unstable-v1.xml
449-
450390
[waybar repository]: https://github.com/Alexays/Waybar
451391
[waybar documentation]: https://github.com/Alexays/Waybar/tree/master/man
452392
[xfce4-panel repository]: https://gitlab.xfce.org/xfce/xfce4-panel

0 commit comments

Comments
 (0)