aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKeith Hubbard <keithhub@users.noreply.github.com>2021-08-15 08:49:11 -0400
committerGitHub <noreply@github.com>2021-08-15 14:49:11 +0200
commit2bdf9e20a5816d12697fc5770eab10351dca609c (patch)
tree073462266b4d6c010b99c4737deace8aafe72616 /doc
parent6e51a8fcdda64fd1c2d34b969c0758c82895b9a5 (diff)
downloadriver-2bdf9e20a5816d12697fc5770eab10351dca609c.tar.gz
river-2bdf9e20a5816d12697fc5770eab10351dca609c.tar.xz
command: support repeating keyboard mappings
Repeating mappings are created using the -repeat option to the map command: % riverctl map normal $mod+Mod1 K -repeat move up 10 - repeating is only supported for key press (not -release) mappings - unlike -release, -repeat does not create distinct mappings: mapping a key with -repeat will replace an existing bare mapping and vice-versa Resolves #306
Diffstat (limited to 'doc')
-rw-r--r--doc/riverctl.1.scd4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd
index a589c45..d1d4666 100644
--- a/doc/riverctl.1.scd
+++ b/doc/riverctl.1.scd
@@ -185,11 +185,13 @@ 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_] _mode_ _modifiers_ _key_ _command_
+*map* [_-release_|_-repeat_] _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
- _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 (+).