aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2024-07-13 08:24:11 +0000
committerDaniel Eklöf <daniel@ekloef.se>2024-07-13 08:41:10 +0000
commit1136108c9780eae9fae252a1bca5089f19fcd57d (patch)
tree89cc11fabcbb5096fe4117266aa6bc0eedda61fa /doc
parentchangelog: remove entry for change that hasn't yet been merged (diff)
input: don't map wheel events to BTN_{BACK,FORWARD}
BTN_BACK and BTN_FORWARD are separate buttons. The scroll wheel don't have any button mappings in libinput/wayland, so make up our own defines. This allows us to map them in mouse bindings. Also expose BTN_WHEEL_{LEFT,RIGHT}. These were already defined, and used, internally, to handle wheel tilt events. With this, they can also be used in mouse bindings. Finally, fix encoding used for BTN_{BACK,FORWARD} when sending mouse button events to the client application. Before this, they were mapped to buttons 4/5. But, button 4/5 are for the scroll wheel, and as mentioned above, BTN_{BACK,FORWARD} are not the same as scroll wheel "buttons". Closes #1763
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd23
1 files changed, 13 insertions, 10 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index f3c0aea6..680768e0 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -1156,10 +1156,13 @@ The trailing *COUNT* (number of times the button has to be clicked) is
optional and specifies the click count required to trigger the
binding. The default if *COUNT* is omitted is _1_.
-To map wheel events (i.e. scrolling), use the button names *BTN_BACK*
-(up) and *BTN_FORWARD* (down). Note that these events never generate a
-*COUNT* larger than 1. That is, *BTN_BACK+2*, for example, will never
-trigger.
+To map wheel events (i.e. scrolling), use the button names
+*BTN_WHEEL_BACK* (up) and *BTN_WHEEL_FORWARD* (down). Note that these
+events never generate a *COUNT* larger than 1. That is,
+*BTN_WHEEL_BACK+2*, for example, will never trigger.
+
+Foot also recognizes tiltable wheels; to map these, use
+*BTN_WHEEL_LEFT* and *BTN_WHEEL_RIGHT*.
A modifier+button combination can only be mapped to *one* action. Lets
say you want to bind *BTN\_MIDDLE* to *fullscreen*. Since
@@ -1187,7 +1190,7 @@ actions listed under *key-bindings* can be used here as well.
Alt screen: send fake _KeyUP_ events to the client application, if
alternate scroll mode is enabled.
- Default: _BTN_BACK_
+ Default: _BTN\_WHEEL\_BACK_
*scrollback-down-mouse*
Normal screen: scrolls down the contents.
@@ -1195,7 +1198,7 @@ actions listed under *key-bindings* can be used here as well.
Alt screen: send fake _KeyDOWN_ events to the client application, if
alternate scroll mode is enabled.
- Default: _BTN_FORWARD_
+ Default: _BTN\_WHEEL\_FORWARD_
*select-begin*
Begin an interactive selection. The selection is finalized, and
@@ -1269,12 +1272,12 @@ actions listed under *key-bindings* can be used here as well.
Pastes from the _primary selection_. Default: _BTN\_MIDDLE_.
*font-increase*
- Increases the font size by 0.5pt. Default: _Control+BTN\_BACK_
- (also defined in *key-bindings*).
+ Increases the font size by 0.5pt. Default:
+ _Control+BTN\_WHEEL\_BACK_ (also defined in *key-bindings*).
*font-decrease*
- Decreases the font size by 0.5pt. Default: _Control+BTN\_FORWARD_
- (also defined in *key-bindings*).
+ Decreases the font size by 0.5pt. Default:
+ _Control+BTN\_WHEEL\_FORWARD_ (also defined in *key-bindings*).
# TWEAK