From 3d98ab63ed52f8a68d7388b44de348bd71abb6e5 Mon Sep 17 00:00:00 2001
From: Michael Stapelberg
Date: Thu, 25 Aug 2011 14:14:55 +0200
Subject: [PATCH] update docs/userguide
---
_docs/userguide | 31 +++++++++++++++++++++++++++++--
docs/4.0/userguide.html | 29 +++++++++++++++++++++++++++--
2 files changed, 56 insertions(+), 4 deletions(-)
diff --git a/_docs/userguide b/_docs/userguide
index 158ed55..e61c254 100644
--- a/_docs/userguide
+++ b/_docs/userguide
@@ -611,7 +611,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
-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*:
----------------------------
@@ -748,7 +749,7 @@ bindsym mod+l move up
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
@@ -770,6 +771,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
diff --git a/docs/4.0/userguide.html b/docs/4.0/userguide.html
index c1a3883..ff70215 100644
--- a/docs/4.0/userguide.html
+++ b/docs/4.0/userguide.html
@@ -693,7 +693,8 @@ programs to get information from i3, such as the current workspaces
/tmp/i3-%u/ipc-socket.%p where %u is your UNIX username and %p is the PID
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.
@@ -869,7 +870,7 @@ bindsym mod+semicolon move right
-
5.4. Changing workspaces/moving containers to workspaces
+
5.4. 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
move workspace.
@@ -888,6 +889,30 @@ bindsym mod+Shift+1 move workspace 1
bindsym mod+Shift+2 move workspace 2
...
+
+
5.4.1. Named workspaces
+
Workspaces are identified by their name. So, instead of using numbers in the
+workspace command, you can use an arbitrary name:
+
+
+
+
bindsym mod+1 workspace mail
+...
+
+
If you want the workspace to have a number and a name, just prefix the
+number, like this:
+
+
+
+
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.
+
5.5. Resizing containers/windows
--
2.39.5