Merge pull request #3138 from clawoflight/default-border

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 7a1621da86e86af18c423da3f1f42ec02ac3ee8f..ba314af111a62493477dad54d4f030d743fdd0b4 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

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


@@ -1377,7 +1379,7 @@ and will be removed in a future release. We strongly recommend using the more ge
 
 *Syntax*:
 ----------------------------
 
 *Syntax*:
 ----------------------------

-bindsym button<n> <command>
+bindsym [--release] button<n> <command>

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


@@ -1385,6 +1387,8 @@ bindsym button<n> <command>
 bar {
     # disable clicking on workspace buttons
     bindsym button1 nop
 bar {
     # disable clicking on workspace buttons
     bindsym button1 nop

+    # Take a screenshot by right clicking on the bar
+    bindsym --release button3 exec --no-startup-id import /tmp/latest-screenshot.png

     # execute custom script when scrolling downwards
     bindsym button5 exec ~/.i3/scripts/custom_wheel_down
 }
     # execute custom script when scrolling downwards
     bindsym button5 exec ~/.i3/scripts/custom_wheel_down
 }


@@ -1949,6 +1953,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::


@@ -1968,6 +1975,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>


@@ -1975,6 +1983,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


@@ -2311,8 +2322,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