aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2025-03-01 09:45:57 +0300
committerIvan Molodetskikh <yalterz@gmail.com>2025-03-08 21:47:37 +0300
commit69627bdc64d8891befff95e807869416658d36c6 (patch)
tree6f5c1a548c229e2c7fc560f059e2a79d1d87ae3f
parent3fa373c720650eb02f7f10ccf95f85e5b9b88791 (diff)
downloadniri-69627bdc64d8891befff95e807869416658d36c6.tar.gz
niri-69627bdc64d8891befff95e807869416658d36c6.tar.bz2
niri-69627bdc64d8891befff95e807869416658d36c6.zip
wiki: Document toggle-keyboard-shortcuts-inhibit and allow-inhibiting
-rw-r--r--wiki/Configuration:-Key-Bindings.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/wiki/Configuration:-Key-Bindings.md b/wiki/Configuration:-Key-Bindings.md
index 8a05b853..24efa839 100644
--- a/wiki/Configuration:-Key-Bindings.md
+++ b/wiki/Configuration:-Key-Bindings.md
@@ -319,3 +319,27 @@ binds {
Alt+Print { screenshot-window write-to-disk=false; }
}
```
+
+#### `toggle-keyboard-shortcuts-inhibit`
+
+<sup>Since: 25.02</sup>
+
+Applications such as remote-desktop clients and software KVM switches may request that niri stops processing its keyboard shortcuts so that they may, for example, forward the key presses as-is to a remote machine.
+`toggle-keyboard-shortcuts-inhibit` is an escape hatch that toggles the inhibitor.
+It's a good idea to bind it, so a buggy application can't hold your session hostage.
+
+```kdl
+binds {
+ Mod+Escape { toggle-keyboard-shortcuts-inhibit; }
+}
+```
+
+You can also make certain binds ignore inhibiting with the `allow-inhibiting=false` property.
+They will always be handled by niri and never passed to the window.
+
+```kdl
+binds {
+ // This bind will always work, even when using a virtual machine.
+ Super+Alt+L allow-inhibiting=false { spawn "swaylock"; }
+}
+```