aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Kaplan <peter@pkap.de>2022-02-07 14:51:23 +0100
committerIsaac Freund <mail@isaacfreund.com>2022-04-14 12:49:47 +0200
commit60fdefc3fdecb7e4d3697634e91b07356a3a5b4d (patch)
tree78c0d87b0a8e2750314112452aad27cf0eab27f0 /doc
parentae349b0ce45b44b79a0a93e89c2cd05d24bb63d4 (diff)
downloadriver-60fdefc3fdecb7e4d3697634e91b07356a3a5b4d.tar.gz
river-60fdefc3fdecb7e4d3697634e91b07356a3a5b4d.tar.xz
input: add map-switch/unmap-switch commands
This allows running a command on a laptop's lid being opened/closed or a tablet's button/switch being pressed/toggled.
Diffstat (limited to 'doc')
-rw-r--r--doc/riverctl.1.scd21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd
index d4ba768..fec47dd 100644
--- a/doc/riverctl.1.scd
+++ b/doc/riverctl.1.scd
@@ -218,6 +218,20 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_
- move-view
- resize-view
+*map-switch* _mode_ *lid*|*tablet* _state_ _command_
+ Run _command_ when river receives a certain switch event.
+
+ - _mode_: name of the mode for which to create the mapping
+ - _lid_|_tablet_: 'lid switch' and 'tablet mode switch' are supported
+ - _state_:
+ - possible states for _lid_:
+ - close
+ - open
+ - possible states for _tablet_:
+ - on
+ - off
+ - _command_: any command that may be run with riverctl
+
*unmap* [_-release_] _mode_ _modifiers_ _key_
Remove the mapping defined by the arguments:
@@ -235,6 +249,13 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_
by a plus sign (+).
- _button_: the name of a linux input event code as described above
+*unmap-switch* _mode_ *lid*|*tablet* _state_
+ Remove the switch mapping defined by the arguments:
+
+ - _mode_: name of the mode for which to remove the mapping
+ - _lid_|_tablet_: the switch for which to remove the mapping
+ - _state_: a state as listed above
+
## CONFIGURATION
*attach-mode* *top*|*bottom*