cmd_border: improve width selection

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 974135acb794bb37a58769f0ba0ab90c66f4553b..e82403900374d50aadd57103c3c35b68e163c061 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -1,7 +1,6 @@
 i3 User’s Guide
 ===============
 Michael Stapelberg <michael@i3wm.org>
 i3 User’s Guide
 ===============
 Michael Stapelberg <michael@i3wm.org>

-March 2013

 
 This document contains all the information you need to configure and use the i3
 window manager. If it does not, please check https://www.reddit.com/r/i3wm/
 
 This document contains all the information you need to configure and use the i3
 window manager. If it does not, please check https://www.reddit.com/r/i3wm/


@@ -586,23 +585,26 @@ workspace_layout default|stacking|tabbed
 workspace_layout tabbed
 ---------------------
 
 workspace_layout tabbed
 ---------------------
 

-=== Border style for new windows
+=== Default border style for new windows

 
 This option determines which border style new windows will have. The default is
 
 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
++normal+. Note that default_floating_border applies only to windows which are starting out as

 floating windows, e.g., dialog windows, but not windows that are floated later on.
 
 *Syntax*:
 ---------------------------------------------
 floating windows, e.g., dialog windows, but not windows that are floated later on.
 
 *Syntax*:
 ---------------------------------------------

-new_window normal|none|pixel
-new_window normal|pixel <px>
-new_float normal|none|pixel
-new_float normal|pixel <px>
+default_border normal|none|pixel
+default_border normal|pixel <px>
+default_floating_border normal|none|pixel
+default_floating_border normal|pixel <px>

 ---------------------------------------------
 
 ---------------------------------------------
 

+Please note that +new_window+ and +new_float+ have been deprecated in favor of the above options
+and will be removed in a future release. We strongly recommend using the new options instead.
+

 *Example*:
 ---------------------
 *Example*:
 ---------------------

-new_window pixel
+default_border pixel

 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in
 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in


@@ -610,11 +612,11 @@ pixels:
 
 *Example*:
 ---------------------
 
 *Example*:
 ---------------------

-# The same as new_window none
-new_window pixel 0
+# The same as default_border none
+default_border pixel 0

 
 # A 3 px border
 
 # A 3 px border

-new_window pixel 3
+default_border pixel 3

 ---------------------
 
 
 ---------------------
 
 


@@ -728,7 +730,8 @@ resource database to achieve an easily maintainable, consistent color theme
 across many X applications.
 
 Defining a resource will load this resource from the resource database and
 across many X applications.
 
 Defining a resource will load this resource from the resource database and

-assign its value to the specified variable. A fallback must be specified in
+assign its value to the specified variable. This is done verbatim and the value
+must therefore be in the format that i3 uses. A fallback must be specified in

 case the resource cannot be loaded from the database.
 
 *Syntax*:
 case the resource cannot be loaded from the database.
 
 *Syntax*:


@@ -1592,7 +1595,7 @@ bar {
 }
 ------------------------
 
 }
 ------------------------
 

-=== Strip workspace numbers
+=== Strip workspace numbers/name

 
 Specifies whether workspace numbers should be displayed within the workspace
 buttons. This is useful if you want to have a named workspace that stays in
 
 Specifies whether workspace numbers should be displayed within the workspace
 buttons. This is useful if you want to have a named workspace that stays in


@@ -1603,11 +1606,15 @@ the form "[n]:[NAME]" will display only the name. You could use this, for
 instance, to display Roman numerals rather than digits by naming your
 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
 
 instance, to display Roman numerals rather than digits by naming your
 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
 

+When +strip_workspace_name+ is set to +yes+, any workspace that has a name of
+the form "[n]:[NAME]" will display only the number.
+

 The default is to display the full name within the workspace button.
 
 *Syntax*:
 ------------------------------
 strip_workspace_numbers yes|no
 The default is to display the full name within the workspace button.
 
 *Syntax*:
 ------------------------------
 strip_workspace_numbers yes|no

+strip_workspace_name yes|no

 ------------------------------
 
 *Example*:
 ------------------------------
 
 *Example*:


@@ -2023,10 +2030,13 @@ Use the +move+ command to move a container.
 # defaults to 10 pixels.
 move <left|right|down|up> [<px> px]
 
 # defaults to 10 pixels.
 move <left|right|down|up> [<px> px]
 

-# Moves the container either to a specific location
-# or to the center of the screen. If 'absolute' is
-# used, it is moved to the center of all outputs.
-move [absolute] position <pos_x> [px] <pos_y> [px]
+# Moves the container to the specified pos_x and pos_y
+# coordinates on the screen.
+move position <pos_x> [px] <pos_y> [px]
+
+# Moves the container to the center of the screen.
+# If 'absolute' is used, it is moved to the center of
+# all outputs.

 move [absolute] position center
 
 # Moves the container to the current position of the
 move [absolute] position center
 
 # Moves the container to the current position of the


@@ -2251,8 +2261,7 @@ See <<move_to_outputs>> for how to move a container/workspace to a different
 RandR output.
 
 [[move_to_outputs]]
 RandR output.
 
 [[move_to_outputs]]

-[[_moving_containers_workspaces_to_randr_outputs]]
-=== Moving containers/workspaces to RandR outputs
+=== [[_moving_containers_workspaces_to_randr_outputs]]Moving containers/workspaces to RandR outputs

 
 To move a container to another RandR output (addressed by names like +LVDS1+ or
 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
 
 To move a container to another RandR output (addressed by names like +LVDS1+ or
 +VGA1+) or to a RandR output identified by a specific direction (like +left+,


@@ -2467,7 +2476,9 @@ To change the border of the current client, you can use +border normal+ to use t
 border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
 and +border none+ to make the client borderless.
 
 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.
+There is also +border toggle+ which will toggle the different border styles. The
+optional pixel argument can be used to specify the border width when switching
+to the normal and pixel styles.

 
 Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel
 may be represented by multiple physical pixels, so +pixel 1+ might not
 
 Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel
 may be represented by multiple physical pixels, so +pixel 1+ might not


@@ -2475,8 +2486,8 @@ necessarily translate into a single pixel row wide border.
 
 *Syntax*:
 -----------------------------------------------
 
 *Syntax*:
 -----------------------------------------------

-border normal|pixel [<n>]
-border none|toggle
+border normal|pixel|toggle [<n>]
+border none

 
 # legacy syntax, equivalent to "border pixel 1"
 border 1pixel
 
 # legacy syntax, equivalent to "border pixel 1"
 border 1pixel