Merge branch 'master' into next

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index e5533d0e50cf3d92155395be220b4aa9d8761843..05a0b1e8fb8ed33d07d7448dcec75d3d5baf7920 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -78,7 +78,7 @@ tabbed::
 The same principle as +stacking+, but the list of windows at the top is only
 a single line which is vertically split.
 
 The same principle as +stacking+, but the list of windows at the top is only
 a single line which is vertically split.
 

-To switch modes, press +mod+e+ for default, +mod+h+ for stacking and
+To switch modes, press +mod+e+ for default, +mod+s+ for stacking and

 +mod+w+ for tabbed.
 
 image:modes.png[Container modes]
 +mod+w+ for tabbed.
 
 image:modes.png[Container modes]


@@ -590,11 +590,14 @@ area of the termianal and the i3 border.
 
 Colors are in HTML hex format (#rrggbb), see the following example:
 
 
 Colors are in HTML hex format (#rrggbb), see the following example:
 

-*Examples*:
---------------------------------------
-# class        border  backgr. text
-client.focused #2F343A #900000 #FFFFFF
---------------------------------------
+*Examples (default colors)*:
+-----------------------------------------------
+# class                 border  backgr. text
+client.focused          #4c7899 #285577 #ffffff
+client.focused_inactive #333333 #5f676a #ffffff
+client.unfocused        #333333 #222222 #888888
+client.urgent           #2f343a #900000 #ffffff
+-----------------------------------------------

 
 Note that for the window decorations, the color around the child window is the
 background color, and the border color is only the two thin lines at the top of
 
 Note that for the window decorations, the color around the child window is the
 background color, and the border color is only the two thin lines at the top of


@@ -611,7 +614,8 @@ The IPC socket is enabled by default and will be created in
 of i3.
 
 You can override the default path through the environment-variable +I3SOCK+ or
 of i3.
 
 You can override the default path through the environment-variable +I3SOCK+ or

-by specifying the +ipc-socket+ directive.
+by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
+does the right thing by default.

 
 *Examples*:
 ----------------------------
 
 *Examples*:
 ----------------------------


@@ -661,6 +665,29 @@ popup_during_fullscreen <ignore|leave_fullscreen>
 popup_during_fullscreen ignore
 ------------------------------
 
 popup_during_fullscreen ignore
 ------------------------------
 

+=== Focus wrapping
+
+When being in a tabbed or stacked container, the first container will be
+focused when you use +focus down+ on the last container -- the focus wraps. If
+however there is another stacked/tabbed container in that direction, focus will
+be set on that container. This is the default behaviour so you can navigate to
+all your windows without having to use +focus parent+.
+
+If you want the focus to *always* wrap and you are aware of using +focus
+parent+ to switch to different containers, you can use the
++force_focus_wrapping+ configuration directive. After enabling it, the focus
+will always wrap.
+
+*Syntax*:
+-----------------------------
+force_focus_wrapping <yes|no>
+-----------------------------
+
+*Example*:
+------------------------
+force_focus_wrapping yes
+------------------------
+

 == List of commands
 
 === Splitting containers
 == List of commands
 
 === Splitting containers


@@ -748,7 +775,7 @@ bindsym mod+l move up
 bindsym mod+semicolon move right
 ----------------------
 
 bindsym mod+semicolon move right
 ----------------------
 

-=== Changing workspaces/moving containers to workspaces
+=== Changing (named) workspaces/moving to workspaces

 
 To change to a specific workspace, use the +workspace+ command, followed by the
 number or name of the workspace. To move containers to specific workspaces, use
 
 To change to a specific workspace, use the +workspace+ command, followed by the
 number or name of the workspace. To move containers to specific workspaces, use


@@ -775,6 +802,32 @@ bindsym mod+Shift+2 move workspace 2
 ...
 -------------------------
 
 ...
 -------------------------
 

+==== Named workspaces
+
+Workspaces are identified by their name. So, instead of using numbers in the
+workspace command, you can use an arbitrary name:
+
+*Example*:
+-------------------------
+bindsym mod+1 workspace mail
+...
+-------------------------
+
+If you want the workspace to have a number *and* a name, just prefix the
+number, like this:
+
+*Example*:
+-------------------------
+bindsym mod+1 workspace 1: mail
+bindsym mod+2 workspace 2: www
+...
+-------------------------
+
+Note that the workspace will really be named "1: mail". i3 treats workspace
+names beginning with a number in a slightly special way. Normally, named
+workspaces are ordered the way they appeared. When they start with a number, i3
+will order them numerically.
+

 [[resizingconfig]]
 
 === Resizing containers/windows
 [[resizingconfig]]
 
 === Resizing containers/windows