From: Michael Stapelberg <michael@stapelberg.de>
Date: Sun, 28 Aug 2011 15:51:37 +0000 (+0200)
Subject: docs/userguide: properly document the resize command
X-Git-Tag: 4.0.2~3^2~1
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=e5f10022e7e0732b810ee9e666beb91ed2ddb624;p=i3%2Fi3

docs/userguide: properly document the resize command
---

diff --git a/docs/userguide b/docs/userguide
index 6971c9ed..dbb6efa3 100644
--- a/docs/userguide
+++ b/docs/userguide
@@ -828,7 +828,20 @@ will order them numerically.
 === Resizing containers/windows
 
 If you want to resize containers/windows using your keyboard, you can use the
-+resize+ command, I recommend using it inside a so called +mode+:
++resize+ command:
+
+*Syntax*:
+---------------------------------------------------------
+resize <grow|shrink> <direction> [<px> px] [or <ppt> ppt]
+---------------------------------------------------------
+
+Direction can be one of +up+, +down+, +left+ or +right+. The optional pixel
+argument specifies by how many pixels a *floating container* should be grown or
+shrinked (the default is 10 pixels). The ppt argument means percentage points
+and specifies by how many percentage points a *tiling container* should be
+grown or shrinked (the default is 10 percentage points).
+
+I recommend using the resize command inside a so called +mode+:
 
 .Example: Configuration file, defining a mode for resizing
 ----------------------------------------------------------------------
@@ -851,7 +864,9 @@ mode "resize" {
         bindsym semicolon resize grow right
         bindsym Shift+semicolon resize shrink right
 
-        bindcode 36 mode default
+        # back to normal: Enter or Escape
+        bindsym Return mode "default"
+        bindsym Escape mode "default"
 }
 
 # Enter resize mode