Merge pull request #3179 from orestisf1993/issue-2733

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 4a400dfc80015ab6585c804f2bfe8c875d4d0eb9..d944bb3977ecdf36932ab97b8a0e043b172382cf 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -585,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


@@ -609,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

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


@@ -727,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*:


@@ -1114,6 +1118,7 @@ force_xinerama yes
 Also note that your output names are not descriptive (like +HDMI1+) when using
 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
 
 Also note that your output names are not descriptive (like +HDMI1+) when using
 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
 

+[[workspace_auto_back_and_forth]]

 === Automatic back-and-forth when switching to the current workspace
 
 This configuration directive enables automatic +workspace back_and_forth+ (see
 === Automatic back-and-forth when switching to the current workspace
 
 This configuration directive enables automatic +workspace back_and_forth+ (see


@@ -1591,7 +1596,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


@@ -1602,11 +1607,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*:


@@ -2022,10 +2031,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


@@ -2110,8 +2122,8 @@ for_window [instance=notepad] sticky enable
 
 To change to a specific workspace, use the +workspace+ command, followed by the
 number or name of the workspace. Pass the optional flag
 
 To change to a specific workspace, use the +workspace+ command, followed by the
 number or name of the workspace. Pass the optional flag

-+--no-auto-back-and-forth+ to disable <<back_and_forth>> for this specific call
-only.
++--no-auto-back-and-forth+ to disable <<workspace_auto_back_and_forth>> for this
+specific call only.

 
 To move containers to specific workspaces, use +move container to workspace+.
 
 
 To move containers to specific workspaces, use +move container to workspace+.
 


@@ -2250,8 +2262,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+,


@@ -2310,7 +2321,9 @@ If you want to resize containers/windows using your keyboard, you can use the
 *Syntax*:
 -------------------------------------------------------
 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
 *Syntax*:
 -------------------------------------------------------
 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]

-resize set <width> [px | ppt] <height> [px | ppt]
+resize set [width] <width> [px | ppt]
+resize set height <height> [px | ppt]
+resize set [width] <width> [px | ppt] [height] <height> [px | ppt]

 -------------------------------------------------------
 
 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
 -------------------------------------------------------
 
 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be


@@ -2466,7 +2479,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


@@ -2474,8 +2489,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