aboutsummaryrefslogtreecommitdiff
path: root/doc/riverctl.1.scd
diff options
context:
space:
mode:
authorPeter Kaplan <peter@pkap.de>2022-04-20 15:38:18 +0200
committerIsaac Freund <mail@isaacfreund.com>2022-04-27 18:31:08 +0200
commit44aaee3a51b971817ccacd1c1dd4897f58dd25e7 (patch)
tree8fa20b4c674cf6c576c5bb296de2716424b1f15e /doc/riverctl.1.scd
parent8f59075bc505910207bb803d3530c6daee36577c (diff)
downloadriver-44aaee3a51b971817ccacd1c1dd4897f58dd25e7.tar.gz
river-44aaee3a51b971817ccacd1c1dd4897f58dd25e7.tar.xz
command/map: layout-pinned mappings
e.g. `riverctl map -layout 0 normal Super Y spawn foot` When this mapping is checked against a pressed key, layout 0 will be used to translate the pressed key instead of the currently active layout. The number denotes to an index of the layouts set with `XKB_DEFAULT_LAYOUT`.
Diffstat (limited to 'doc/riverctl.1.scd')
-rw-r--r--doc/riverctl.1.scd8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd
index 0826850..42e1500 100644
--- a/doc/riverctl.1.scd
+++ b/doc/riverctl.1.scd
@@ -193,13 +193,19 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_
*enter-mode* _name_
Switch to given mode if it exists.
-*map* [_-release_|_-repeat_] _mode_ _modifiers_ _key_ _command_
+*map* [_-release_|_-repeat_|_-layout_ _index_] _mode_ _modifiers_ _key_ _command_
Run _command_ when _key_ is pressed while _modifiers_ are held down
and in the specified _mode_.
- _-release_: if passed activate on key release instead of key press
- _-repeat_: if passed activate repeatedly until key release; may not
be used with -release
+ - _-layout_: if passed, a specific layout is pinned to the mapping.
+ When the mapping is checked against a pressed key, this layout is
+ used to translate the key independent of the active layout
+ - _index_: zero-based index of a layout set with the environment variable
+ *XKB_DEFAULT_LAYOUT*; see *river*(1) for an example; if the index is
+ out of range, the _-layout_ option will have no effect
- _mode_: name of the mode for which to create the mapping
- _modifiers_: one or more of the modifiers listed above, separated
by a plus sign (+).