Make layout fancier by adding master_grow, master_shrink, master_add,

[spectrwm.git] / scrotwm.1

diff --git a/scrotwm.1 b/scrotwm.1
index 9640322..07a3c25 100644 (file)
--- a/scrotwm.1
+++ b/scrotwm.1
@@ -122,14 +122,30 @@ This ratio is the screen size to what they will be resized.
 For example, 0.6 is 60% of the physical screen size.
 .It Cm layout
 select layout to use at start-of-day.
-Defined in the format ws[<idx>]:<layout>, e.g. ws[2]:horizontal sets worskspace
-2 to the horizontal stack mode.
-This setting is not retained at restart.
-Possible values are
+Defined in the format ws[idx]:master_grow:master_add:stack_inc:layout, e.g.
+ws[2]:-4:0:1:horizontal sets worskspace 2 to the horizontal stack mode and
+shrinks the master area by 4 ticks and adds one window to the stack.
+Possible layout values are
 .Pa vertical ,
 .Pa horizontal
 and
 .Pa fullscreen .
+.Pp
+See
+.Pa master_grow ,
+.Pa master_shrink ,
+.Pa master_add ,
+.Pa master_del ,
+.Pa stack_inc ,
+and
+.Pa stack_del
+for more information.
+Note that the stacking options are complicated and have side-effects.
+One should familiarize oneself with these commands before experimenting with the
+.Pa layout
+option.
+.Pp
+This setting is not retained at restart.
 .It Cm region
 Allocates a custom region, removing any autodetected regions which occupy the same
 space on the screen.