Docs [#3164]: Clarification about X resource value

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 0258e2ab78e82ef8942130938897cf6b7cd3ca48..ccedc577924ff53997aa18560c4d488164b31ba1 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*:


@@ -1951,6 +1958,9 @@ bindsym $mod+t floating toggle
 To change focus, you can use the +focus+ command. The following options are
 available:
 
 To change focus, you can use the +focus+ command. The following options are
 available:
 

+<criteria>::
+    Sets focus to the container that matches the specified criteria.
+    See <<command_criteria>>.

 left|right|up|down::
         Sets focus to the nearest container in the given direction.
 parent::
 left|right|up|down::
         Sets focus to the nearest container in the given direction.
 parent::


@@ -1970,6 +1980,7 @@ output::
 
 *Syntax*:
 ----------------------------------------------
 
 *Syntax*:
 ----------------------------------------------

+<criteria> focus

 focus left|right|down|up
 focus parent|child|floating|tiling|mode_toggle
 focus output left|right|up|down|primary|<output>
 focus left|right|down|up
 focus parent|child|floating|tiling|mode_toggle
 focus output left|right|up|down|primary|<output>


@@ -1977,6 +1988,9 @@ focus output left|right|up|down|primary|<output>
 
 *Examples*:
 -------------------------------------------------
 
 *Examples*:
 -------------------------------------------------

+# Focus firefox
+bindsym $mod+F1 [class="Firefox"] focus
+

 # Focus container on the left, bottom, top, right
 bindsym $mod+j focus left
 bindsym $mod+k focus down
 # Focus container on the left, bottom, top, right
 bindsym $mod+j focus left
 bindsym $mod+k focus down


@@ -2313,8 +2327,11 @@ space from all the other containers. The optional pixel argument specifies by
 how many pixels a *floating container* should be grown or shrunk (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 shrunk (the
 how many pixels a *floating container* should be grown or shrunk (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 shrunk (the

-default is 10 percentage points). Note that +resize set+ will only work for
-floating containers.
+default is 10 percentage points).
+
+Notes about +resize set+: a value of 0 for <width> or <height> means "do
+not resize in this direction", and resizing a tiling container by +px+ is not
+implemented.

 
 It is recommended to define bindings for resizing in a dedicated binding mode.
 See <<binding_modes>> and the example in the i3
 
 It is recommended to define bindings for resizing in a dedicated binding mode.
 See <<binding_modes>> and the example in the i3