aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-08-11 08:30:27 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-08-14 05:38:56 +0000
commit24ee6d836be6ce3952fecfb5edc44386046a1b9d (patch)
treea53bce55c2c502198a5a21913612d146b439477a
parentchangelog: new mouse actions (diff)
doc: footrc: mouse-bindings: clean up description
-rw-r--r--doc/footrc.5.scd24
1 files changed, 10 insertions, 14 deletions
diff --git a/doc/footrc.5.scd b/doc/footrc.5.scd
index a5792671..64f9c500 100644
--- a/doc/footrc.5.scd
+++ b/doc/footrc.5.scd
@@ -364,24 +364,20 @@ This section lets you override the default mouse bindings.
The general format is _action=combo1...comboN_. That is, each action
may have one or more key combinations, space separated. Each
-combination is on the form _mod1+mod2+BTN\_<name>_[-COUNT]. The names
-of the modifiers and the key *must* be valid XKB key names. You can
-find the button names using *libinput debug-events*.
+combination is on the form _mod1+mod2+BTN\_<name>[-COUNT]_. The names
+of the modifiers *must* be valid XKB key names, and the button name
+*must* be a valid libinput name. You can find the button names using
+*libinput debug-events*.
The trailing *COUNT* is optional and specifies the click count
-required to trigger the binding. The default is *COUNT* is omitted is
+required to trigger the binding. The default if *COUNT* is omitted is
_1_.
-Example: *primary-paste=Control+BTN_LEFT-2*
-
-Trigger _primary-paste_ when *ctrl* is pressed, and the left mouse
-button is double clicked.
-
-A button can only be mapped to *one* action. Lets say you want to bind
-*BTN\_MIDDLE* to *fullscreen*. Since *BTN\_MIDDLE* is the default
-binding for *primary-paste*, you first need to unmap the default
-binding. This can be done by setting _action=none_;
-e.g. *primary-paste=none*.
+A modifier+button combination can only be mapped to *one* action. Lets
+say you want to bind *BTN\_MIDDLE* to *fullscreen*. Since
+*BTN\_MIDDLE* is the default binding for *primary-paste*, you first
+need to unmap the default binding. This can be done by setting
+_action=none_; e.g. *primary-paste=none*.
All actions listed under *key-bindings* can be user here as well.