ibus for Debian                           Osamu Aoki <osamu@debian.org>

=========================================================================
!
!      Keyboard mode switching is now changed to SUPER-space.
!          The SUPER-key is commonly called windows-key.
!
!      The desktop and ibus should be run under the UTF-8 locale to have
!      stable behavior. Set it via "dpkg-reconfigure locales" command.
!
=========================================================================

=========================================================================
!	Quick Guide to Setup IBus
=========================================================================

* Install required packages.
 - The input method helper package:        im-config
 - Core ibus input package:                ibus
 - Support package for each UI environment
   - GTK2:       ibus-gtk     (for legacy GTK apps)
   - GTK3:       ibus-gtk3    (for old GTK apps)
   - GTK4:       ibus-gtk4    (for new GTK apps)
   - Wayland:    ibus-wayland
   [Note]
     These are optional. (Otherwise, only XIM will be supported.) Installing
     them will improve user experience. Both ibus-gtk3 and ibus-gtk4 are
     required to set up usable system with GTK. GNOME and XFce use GTK.
     .
     Qt provides builtin ibus support starting from Qt version 5. You cannot
     miss this if you have installed the Qt GUI library.
     .
     Only some versions of Wayland input method protocol are supported by ibus.
     For that reason, your Wayland compositor's input method implementation
     may not be supported by ibus. Therefore, it's recommended to always
     install ibus-gtk* rather than depending on ibus-wayland.

 - Support package for each IM engine client
   - Japanese, MOZC (newer, heavy):        ibus-mozc
   - Japanese, KKC (newer, light):         ibus-kkc
   - Japanese, Anthy (older, light):       ibus-anthy
   - Japanese, SKK (EMACS style):          ibus-skk
   - Korean language:                      ibus-hangul
   - Traditional Chinese:                  ibus-chewing
   - Simplified Chinese (legacy):          ibus-pinyin
   - Simplified Chinese (SUN):             ibus-sunpinyin
   - Chinese (Simplified / Tranditional):  ibus-libpinyin
   - Chinese (array30):                    ibus-array
   - Chinese (cangjie):                    ibus-cangjie
   - Thai                                  ibus-libthai
   - Vietnamese:                           ibus-unikey
   - Many table based input method:        ibus-table*
   [Note]
     These are optional. But if you use any one of the listed language
     you need to install that one.

* Configure im-config.
  If other input method packages (fcitx, uim, ...) are installed,
  select ibus by executing im-config from a terminal window.
  (Usually not needed since this is default.)

* Configure ibus.
  - How to start configuration
    - GNOME: Use the GNOME keyboard settings, with the
      "gnome-control-center keyboard" command.
    - Others: Execute the ibus-setup command.
  - Add your input method explicitly via ibus configuration.
    - If you are on GNOME, keyboard settings offers both the basic XKB and
      fancy ibus based methods. If you are not using standard US keyboard, make
      sure to set the XKB setting for keyboard first.
  - Setup XKB setting for ibus based input methods
    - The system wide keyboard setting is in /etc/default/keyboard. Change it:
      $ sudo dpkg-reconfigure keyboard-configuration
    - If no XKB is set in the desktop configuration, some desktop system may
      set XKB system to "us" as the default despite your system wide keyboard
      setting.
    - The ibus based input methods inherit the XKB setting of the immediately
      previous input mode if it is set not to use the custom setup. This is
      useful for people with keyboard settings which produce roman alphabets
      (German, French, ...) wishing to input Japanese etc. But if the previous
      input mode is something like Russian, it breaks Japanese input method.
      So, if you have non-alphabet input via XKB, you need to lock your keyboard
      setting within the configuration of particular ibus method used, e.g.,
      ibus-kkc, ibus-anthy, ibus-pynyin, ....

* Always restart ibus if you changes its settings.
  If you are not sure how, exit your desktop environment and re-login to the
  user account to have a refreshed desktop session.

 -- Changwoo Ryu <cwryu@debian.org>, Sun,  8 Mar 2026 02:49:05 +0900