From: Ingo Bürk <ingo.buerk@tngtech.com>
Date: Tue, 9 Jun 2015 21:13:40 +0000 (+0200)
Subject: Fix documentation for border styles.
X-Git-Tag: 4.11~93^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F1744%2Fhead;p=i3%2Fi3

Fix documentation for border styles.
---

diff --git a/docs/userguide b/docs/userguide
index 2f096d51..0c1130c3 100644
--- a/docs/userguide
+++ b/docs/userguide
@@ -517,20 +517,20 @@ workspace_layout tabbed
 === Border style for new windows
 
 This option determines which border style new windows will have. The default is
-"normal". Note that new_float applies only to windows which are starting out as
-floating windows, e.g. dialog windows.
++normal+. Note that new_float applies only to windows which are starting out as
+floating windows, e.g., dialog windows, but not windows that are floated later on.
 
 *Syntax*:
 ---------------------------------------------
-new_window normal|1pixel|none|pixel
+new_window normal|none|pixel
 new_window normal|pixel <px>
-new_float normal|1pixel|none|pixel
+new_float normal|none|pixel
 new_float normal|pixel <px>
 ---------------------------------------------
 
 *Example*:
 ---------------------
-new_window 1pixel
+new_window pixel
 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in
@@ -579,7 +579,7 @@ for_window <criteria> <command>
 for_window [class="XTerm"] floating enable
 
 # Make all urxvts use a 1-pixel border:
-for_window [class="urxvt"] border 1pixel
+for_window [class="urxvt"] border pixel 1
 
 # A less useful, but rather funny example:
 # makes the window floating as soon as I change
@@ -2045,21 +2045,29 @@ seperate bindings for a specific set of labels and then only use those labels.
 === Changing border style
 
 To change the border of the current client, you can use +border normal+ to use the normal
-border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
+border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
 and +border none+ to make the client borderless.
 
 There is also +border toggle+ which will toggle the different border styles.
 
-*Examples*:
-----------------------------
-bindsym $mod+t border normal
-bindsym $mod+y border 1pixel
-bindsym $mod+u border none
-----------------------------
-
 *Syntax*:
+-----------------------------------------------
+border normal|pixel [<n>]
+border none|toggle
+
+# legacy syntax, equivalent to "border pixel 1"
+border 1pixel
+-----------------------------------------------
 
 *Examples*:
+----------------------------------------------
+# use window title, but no border
+bindsym $mod+t border normal 0
+# use no window title and a thick border
+bindsym $mod+y border pixel 3
+# use neither window title nor border
+bindsym $mod+u border none
+----------------------------------------------
 
 [[shmlog]]
 
diff --git a/include/commands.h b/include/commands.h
index afb3c32a..16b7e146 100644
--- a/include/commands.h
+++ b/include/commands.h
@@ -67,7 +67,7 @@ void cmd_move_con_to_workspace_number(I3_CMD, char *which);
 void cmd_resize(I3_CMD, char *way, char *direction, char *resize_px, char *resize_ppt);
 
 /**
- * Implementation of 'border normal|none|1pixel|toggle'.
+ * Implementation of 'border normal|pixel [<n>]', 'border none|1pixel|toggle'.
  *
  */
 void cmd_border(I3_CMD, char *border_style_str, char *border_width);
diff --git a/parser-specs/commands.spec b/parser-specs/commands.spec
index 8d497cd1..c3e6e489 100644
--- a/parser-specs/commands.spec
+++ b/parser-specs/commands.spec
@@ -77,7 +77,8 @@ state DEBUGLOG:
   argument = 'toggle', 'on', 'off'
     -> call cmd_debuglog($argument)
 
-# border normal|none|1pixel|toggle|1pixel
+# border normal|pixel [<n>]
+# border none|1pixel|toggle
 state BORDER:
   border_style = 'normal', 'pixel'
     -> BORDER_WIDTH
diff --git a/src/commands.c b/src/commands.c
index b5558182..44b910ec 100644
--- a/src/commands.c
+++ b/src/commands.c
@@ -816,7 +816,7 @@ void cmd_resize(I3_CMD, char *way, char *direction, char *resize_px, char *resiz
 }
 
 /*
- * Implementation of 'border normal|none|1pixel|toggle|pixel'.
+ * Implementation of 'border normal|pixel [<n>]', 'border none|1pixel|toggle'.
  *
  */
 void cmd_border(I3_CMD, char *border_style_str, char *border_width) {