sway: add bindgesture command

Co-authored-by: Michael Weiser <michael.weiser@gmx.de>

1 files changed, 61 insertions, 0 deletions

diff --git a/sway/sway.5.scd b/sway/sway.5.scd
index 2780370f..db7886f0 100644
--- a/sway/sway.5.scd
+++ b/sway/sway.5.scd
@@ -488,6 +488,62 @@ runtime.
                 bindswitch lid:toggle exec echo "Lid moved"
 ```
 
+*bindgesture* [--exact] [--input-device=<device>] [--no-warn] \
+<gesture>[:<fingers>][:directions] <command>
+        Binds _gesture_ to execute the sway command _command_ when detected.
+        Currently supports the _hold_, _pinch_ or _swipe_ gesture. Optionally
+        can be limited to bind to a certain number of _fingers_ or, for a
+        _pinch_ or _swipe_ gesture, to certain _directions_.
+
+[[ *type*
+:[ *fingers*
+:< *direction*
+|  hold
+:- 1 - 5
+:  none
+|  swipe
+:  3 - 5
+:  up, down, left, right
+|  pinch
+:  2 - 5
+:  all above + inward, outward, clockwise, counterclockwise
+
+        The _fingers_ can be limited to any sensible number or left empty to accept
+        any finger counts.
+        Valid directions are _up_, _down_, _left_ and _right_, as well as _inward_,
+        _outward_, _clockwise_, _counterclockwise_ for the _pinch_ gesture.
+        Multiple directions can be combined by a plus.
+
+        If a _input-device_ is given, the binding will only be executed for
+        that input device and will be executed instead of any binding that is
+        generic to all devices. By default, if you overwrite a binding,
+        swaynag will give you a warning. To silence this, use the _--no-warn_ flag.
+
+        The _--exact_ flag can be used to ensure a binding only matches when exactly
+        all specified directions are matched and nothing more. If there is matching
+        binding with _--exact_, it will be preferred.
+
+        The priority for matching bindings is as follows: input device, then
+        exact matches followed by matches with the highest number of matching
+        directions.
+
+        Gestures executed while the pointer is above a bar are not handled by sway.
+        See the respective documentation, e.g. *bindgesture* in *sway-bar*(5).
+
+        Example:
+```
+                # Allow switching between workspaces with left and right swipes
+                bindgesture swipe:right workspace prev
+                bindgesture swipe:left workspace next
+
+                # Allow container movements by pinching them
+                bindgesture pinch:inward+up move up
+                bindgesture pinch:inward+down move down
+                bindgesture pinch:inward+left move left
+                bindgesture pinch:inward+right move right
+
+```
+
 *client.background* <color>
         This command is ignored and is only present for i3 compatibility.
 
@@ -792,6 +848,11 @@ The default colors are:
 *unbindswitch* <switch>:<state>
         Removes a binding for when <switch> changes to <state>.
 
+*unbindgesture* [--exact] [--input-device=<device>] \
+<gesture>[:<fingers>][:directions]
+        Removes a binding for the specified _gesture_, _fingers_
+        and _directions_ combination.
+
 *unbindsym* [--whole-window] [--border] [--exclude-titlebar] [--release] [--locked] \
 [--to-code] [--input-device=<device>] <key combo>
         Removes the binding for _key combo_ that was previously bound with the