aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-08-14 05:39:11 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-08-14 05:39:11 +0000
commit394db77b04294c505e0a66560e5d8b13150f1191 (patch)
treea01d72bd6abed970261fb5c4fa4fb331c7ff5d64 /doc
parentMerge branch 'click-count-in-mouse-bindings' into master (diff)
parentinput: mouse motion: don't update selection while scrollback searching (diff)
Merge branch 'mouse-binding-actions' into master
Closes #79. Closes #75.
Diffstat (limited to 'doc')
-rw-r--r--doc/footrc.5.scd52
1 files changed, 39 insertions, 13 deletions
diff --git a/doc/footrc.5.scd b/doc/footrc.5.scd
index 5f39f72d..d5ea808d 100644
--- a/doc/footrc.5.scd
+++ b/doc/footrc.5.scd
@@ -364,26 +364,52 @@ 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*.
+
+Note that *Shift* cannot be used as a modifier in mouse bindings since
+it is used to enable selection when the client application is grabbing
+the mouse.
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*
+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.
-Trigger _primary-paste_ when *ctrl* is pressed, and the left mouse
-button is double clicked.
+*select-begin*
+ Begin an interactive selection. The selection is finalized, and
+ copied to the _primary selection_, when the button is
+ released. Default: _BTN\_LEFT_.
-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*.
+*select-begin-block*
+ Begin an interactive block selection. The selection is finalized,
+ and copied to the _primary selection_, when the button is
+ released. Default: _Control+BTN\_LEFT_.
-All actions listed under *key-bindings* can be user here as well.
+*select-extend*
+ Interactively extend an existing selection. The selection is
+ finalized, and copied to the _primary selection_, when the button
+ is released. Default: _BTN\_RIGHT_.
+
+*select-word*
+ Select the _word_ (separated by spaces, period, comma, parenthesis
+ etc) under the pointer. Default: _BTN\_LEFT-2_.
+
+*select-word-whitespace*
+ Select the _word_ (separated by spaces _only_) under the
+ pointer. Default: Control+_BTN\_LEFT-2_.
+
+*select-row*
+ Select the whole row under the pointer. Default: _BTN\_LEFT-3_.
*primary-paste*
Pastes from the _primary selection_. Default: _BTN\_MIDDLE_.