wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-26 08:25:50 +03:00
Code Issues Projects Releases Wiki Activity

docs: flesh out use_ime docs

Browse Source 
closes: #1188
This commit is contained in:
Wez Furlong 2021-10-03 08:46:13 -07:00
parent 8da9196491
commit 6eb6fd6088
2 changed files with 31 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/config/keys.md
View File

@ -57,25 +57,12 @@ n` will emit `ñ`.
You may also set `use_dead_keys = false` to skip the hold state; continuing
the example above, `Right-Opt n` will then immediately produce `~`.
### macOS and the Input Method Editor (IME)
### Input Method Editor (IME)
WezTerm has support for using the operating system Input Method Editor (IME) on
macOS. This is useful in cases where you need to type kanji or are using a
keyboard layout with dead keys. However, the input method editor can get in
the way and has a couple of irritating side effects such as preventing key
repeat for a subset of keys.
some operating systems.
You can control whether the IME is enabled on macOS in your configuration file:
```lua
return {
use_ime = false,
}
```
*since: 20200620-160318-e00b076c*
The default for `use_ime` is false. The default in earlier releases was `true`.
[The `use_ime` docs have more information](lua/config/use_ime.md).
### Microsoft Windows and Dead Keys

28
docs/config/lua/config/use_ime.md Normal file
View File

@ -0,0 +1,28 @@
# `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|Causes some issues with [key repeat](https://github.com/wez/wezterm/issues/1131), defaults to disabled|
|X11 |nightly builds only|[XIM](https://en.wikipedia.org/wiki/X_Input_Method) 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.|
You can control whether the IME is enabled in your configuration file:
```lua
return {
use_ime = false,
}
```
Changing `use_ime` usually requires re-launching WezTerm to take full effect.
*since: 20200620-160318-e00b076c*
The default for `use_ime` is false. The default in earlier releases was `true`.