use_ime¶
Controls whether the Input Method Editor (IME) will be used to process keyboard input. The IME is useful for inputting kanji or other text that is not natively supported by the attached keyboard hardware.
IME support is a platform dependent feature
| Platform | Supported since | Notes |
|---|---|---|
| Windows | Forever | Always enabled, cannot be disabled |
| macOS | 20200113-214446-bb6251f | defaults to enabled starting in 20220319-142410-0fcdea07. Earlier versions had problems with key repeat when enabled |
| X11 | 20211204-082213-a66c61ee9 | XIM based. Your system needs to have a running input method engine (such as ibus or fcitx) that support the XIM protocol in order for wezterm to use it. |
| Wayland | 20220807-113146-c2fee766 | Your compositor must support zwp_text_input_v3 |
You can control whether the IME is enabled in your configuration file:
Changing use_ime usually requires re-launching WezTerm to take full effect.
Since: Version 20200620-160318-e00b076c
The functionality described in this section requires version 20200620-160318-e00b076c of wezterm, or a more recent version.
The default for use_ime is false. The default in earlier releases was true.
Since: Version 20220101-133340-7edc5b5a
The functionality described in this section requires version 20220101-133340-7edc5b5a of wezterm, or a more recent version.
The default for X11 systems is now true. Please ensure that the XMODIFIERS
environment variable or the new xim_im_name configuration
option is set appropriately before wezterm is launched! For
example, Gnome users will probably want to set XMODIFIERS=@im=ibus.
Since: Version 20220319-142410-0fcdea07
The functionality described in this section requires version 20220319-142410-0fcdea07 of wezterm, or a more recent version.
The default for all systems is now true