aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-03-12 09:46:27 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-03-12 09:46:27 +0000
commitc58f9a9ef93fd3fd2be711906b8214a53665e45f (patch)
treee760cd598211e03c91e4ff03a5acf7f444b48011 /doc
parentchangelog: user configurable key- and mouse bindings (diff)
config: mouse-bindings: verify button isn't already mapped
A button may only be mapped to a single action. Detect when the user tried to map the same button to multiple actions and error out. To clear a binding (for example, to free up a button from the default bindings), one can set the action it is bound to to `NONE` (e.g. `primary-paste=NONE`).
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.5.scd14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/foot.5.scd b/doc/foot.5.scd
index dbbcc52d..457d053b 100644
--- a/doc/foot.5.scd
+++ b/doc/foot.5.scd
@@ -151,15 +151,15 @@ component.
This section lets you override the default key bindings.
-The general format is *action*=*combo1*...*comboN*. That is, each
+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*+*key*. The names of the
+combination is on the form _mod1_+_mod2_+_key_. The names of the
modifiers and the key *must* be a valid XKB key name.
Note that if *Shift* is one of the modifiers, the _key_ *must* be in
upper case.
-Note that _Alt_ is usually called *Mod1*.
+Note that *Alt* is usually called *Mod1*.
*scrollback-up*
Scrolls up/back in history. Default: _Shift+Page_Up_.
@@ -207,10 +207,16 @@ Note that _Alt_ is usually called *Mod1*.
This section lets you override the default mouse bindings.
-The general format is *action*=*BTN\_<name>*, where *BTN\_<name>* is
+The general format is _action_=_BTN\_<name>_, where _BTN\_<name>_ is
the name of the event code (e.g. *BTN\_LEFT*, *BTN\_RIGHT*). You can
find the event names using *libinput debug-events*.
+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*.
+
*primary-paste*
Pastes from the _primary selection_. Default: _BTN_MIDDLE_.