Skip to content

Commit 3b60d5d

Browse files
committed
wiki/Doc/KnownBugs: Clean up 'multikey bindings' section
1 parent 74efb5e commit 3b60d5d

1 file changed

Lines changed: 35 additions & 13 deletions

File tree

site/_wiki/Documentation/KnownBugs.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Many of these bugs have a planned milestone to be fixed in.
1515

1616
## Bugs caused by Eto {#eto-bugs}
1717

18-
### [#1821 - Multikey bindings doesn't respect keyboard layout](https://github.com/OpenTabletDriver/OpenTabletDriver/issues/1821) {#multikey-binding-keyboard-layout}
18+
### Multikey bindings doesn't respect keyboard layout {#multikey-binding-keyboard-layout}
1919

2020
For non-QWERTY users (e.g. AZERTY), you may experience that keyboard bindings
2121
are read correctly in the GUI, but sent as a QWERTY keycode by the daemon.
@@ -24,19 +24,45 @@ Eto only allows us to read the processed keyboard layout.
2424

2525
This is planned to be fixed with the migration to Avalonia.
2626

27-
There are 2 known workarounds:
27+
See [OpenTabletDriver issue #1821](https://github.com/OpenTabletDriver/OpenTabletDriver/issues/1821) for more details.
2828

29-
#### Workaround 1: Temporarily Use QWERTY when setting up keys {#multikey-binding-keyboard-layout-workaround1}
29+
How to work around this depends on your operating system:
3030

31-
- Change your keyboard layout to QWERTY
32-
- Set up the bindings you want to use, clicking your normal keys
33-
- Change your keyboard layout back to the one you want to use
31+
#### System-wide keyboard layout: Temporarily use U.S. English layout when setting up keys {#multikey-binding-keyboard-layout-system-wide-layouts}
3432

35-
#### Workaround 2: Force Virtual Keyboard to use U.S. English layout (Linux only) {#multikey-binding-keyboard-layout-workaround2}
33+
Suitable for:
3634

37-
Keyboard Layouts are system-wide on Windows on MacOS.
35+
- Windows
36+
- macOS
37+
- Linux users with system-wide keyboard layouts (some X11 setups)
3838

39-
##### Sway window manager
39+
How to apply the workaround:
40+
41+
1. Change your keyboard layout to QWERTY
42+
2. Set up the bindings you want to use, clicking your normal keys
43+
3. Change your keyboard layout back to the one you want to use
44+
45+
This way, operating systems with system-wide keyboard layouts will emit the
46+
intended keys, despite the resulting button possibly seeming incorrect.
47+
48+
#### Per-keyboard layout: Force Virtual Keyboard to use U.S. English layout {#multikey-binding-keyboard-layout-linux-per-keyboard-layouts}
49+
50+
**This section normally only applies to Linux users**
51+
52+
How to do this depends on your software stack:
53+
54+
- Wayland-based stacks must configure this in their Desktop Environment's (KDE/Gnome/sway/etc) settings
55+
- X11-based display stacks must change X11 `xorg.conf` settings (see `man 5 xorg.conf`), or use `setxkbmap` during runtime.
56+
57+
##### X11 {#multikey-binding-keyboard-layout-linux-X11}
58+
59+
Unless you're using special configuration (`setxkbmap -device <ID>` / udev rule `ENV{XKBLAYOUT}` / similar), chances are you're using a system-wide keyboard layout.
60+
61+
In that case, follow the workaround presented for [Windows/macOS](#multikey-binding-keyboard-layout-win-macos) users.
62+
63+
If it turns out that this doesn't work anyway, make sure the virtual keyboard from OpenTabletDriver is assigned the US-American layout.
64+
65+
##### Sway window manager {#multikey-binding-keyboard-layout-linux-sway}
4066

4167
Put this _after_ any other keyboard configuration:
4268

@@ -46,10 +72,6 @@ input '0:0:OpenTabletDriver_Virtual_Keyboard' {
4672
}
4773
```
4874

49-
##### X11 Window Manager
50-
51-
TODO
52-
5375
## Assorted Bugs {#general-bugs}
5476

5577
### [#3834 - Eraser behavior may be spotty on Linux](https://github.com/OpenTabletDriver/OpenTabletDriver/issues/3834)

0 commit comments

Comments
 (0)