From 111f48b4852d2b1bb4ad8223a8a0a27d71941bb6 Mon Sep 17 00:00:00 2001
From: Consolatis <35009135+Consolatis@users.noreply.github.com>
Date: Sat, 7 Jan 2023 03:30:10 +0100
Subject: [PATCH] SnapToRegion: Add documentation
---
docs/labwc-actions.5.scd | 4 ++++
docs/labwc-config.5.scd | 10 ++++++++++
docs/rc.xml.all | 27 +++++++++++++++++++++++++++
3 files changed, 41 insertions(+)
diff --git a/docs/labwc-actions.5.scd b/docs/labwc-actions.5.scd
index 9cc2eceb..10c3b542 100644
--- a/docs/labwc-actions.5.scd
+++ b/docs/labwc-actions.5.scd
@@ -46,6 +46,10 @@ Actions are used in menus and keyboard/mouse bindings.
Resize window to fill half the output in the given direction. Supports
directions "left", "up", "right", "down" and "center".
+**
+ Resize and move active window according to the given region.
+ See labwc-config(5) for further information on how to define regions.
+
**
Cycle focus to next window.
diff --git a/docs/labwc-config.5.scd b/docs/labwc-config.5.scd
index e00debe1..070e4c04 100644
--- a/docs/labwc-config.5.scd
+++ b/docs/labwc-config.5.scd
@@ -104,6 +104,16 @@ The rest of this man page describes configuration options.
** [yes|no]
Maximize window if Move operation ends on the top edge. Default is yes.
+## REGIONS
+
+**
+ Define snap regions. The regions are calculated based on the usable area
+ of each output. Usable area in this context means space not exclusively
+ used by layershell clients like panels. The "%" character is required.
+ Windows can either be snapped to regions by keeping a keyboard modifier
+ pressed while moving a window (Ctrl, Alt, Shift, Logo) or by using the
+ SnapToRegion action. By default there are no regions defined.
+
## WORKSPACES
**
diff --git a/docs/rc.xml.all b/docs/rc.xml.all
index 52552b72..2c86fb7d 100644
--- a/docs/rc.xml.all
+++ b/docs/rc.xml.all
@@ -81,6 +81,21 @@
+
+
+
+