From: Axel Burri <axel@tty0.ch>
Date: Sat, 5 Aug 2023 21:58:40 +0000 (+0200)
Subject: doc: Adapt MoveToEdge action
X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=81af658c1f0005b5a3727056e0baa80b16b1b592;p=proto%2Flabwc.git

doc: Adapt MoveToEdge action
---

diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd
index 99b86983..4f650c60 100644
--- a/docs/labwc-actions.5.scd
+++ b/docs/labwc-actions.5.scd
@@ -39,9 +39,14 @@ Actions are used in menus and keyboard/mouse bindings.
 *<action name="Move" />*
 	Begin interactive move of window under cursor
 
-*<action name="MoveToEdge" direction="value" />*
-	Move window to edge of outputs. Understands directions "left", "up",
-	"right" and "down".
+*<action name="MoveToEdge" direction="value" snapWindows="value" />*
+	Move window until it hits the next edge.
+
+	*direction* [left|up|right|down] Direction in which to move.
+
+	*snapWindows* [yes|no] Move window until it hits an edge of
+	another window or screen edge. If set to "no", only move to
+	the next screen edge. Default is yes.
 
 *<action name="Resize" />*
 	Begin interactive resize of window under cursor