]> git.sur5r.net Git - i3/i3.github.io/commitdiff
update docs/userguide
authorMichael Stapelberg <michael@stapelberg.de>
Thu, 25 Aug 2011 12:14:55 +0000 (14:14 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Thu, 25 Aug 2011 12:14:55 +0000 (14:14 +0200)
_docs/userguide
docs/4.0/userguide.html

index 158ed55321c1549bbad26b15a0e367f982945b08..e61c254cbea223faba8e4fd8374a5f6a3502bb35 100644 (file)
@@ -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
index c1a3883ab8208c22cddd2a512984c1010dadaa31..ff702153f5bb217bcf4b1b4b795efba6dd3871ee 100644 (file)
@@ -693,7 +693,8 @@ programs to get information from i3, such as the current workspaces
 <tt>/tmp/i3-%u/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username and <tt>%p</tt> is the PID\r
 of i3.</p></div>\r
 <div class="paragraph"><p>You can override the default path through the environment-variable <tt>I3SOCK</tt> or\r
-by specifying the <tt>ipc-socket</tt> directive.</p></div>\r
+by specifying the <tt>ipc-socket</tt> directive. This is discouraged, though, since i3\r
+does the right thing by default.</p></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -869,7 +870,7 @@ bindsym mod+semicolon move right</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_changing_workspaces_moving_containers_to_workspaces">5.4. Changing workspaces/moving containers to workspaces</h3>\r
+<h3 id="_changing_named_workspaces_moving_to_workspaces">5.4. Changing (named) workspaces/moving to workspaces</h3>\r
 <div class="paragraph"><p>To change to a specific workspace, use the <tt>workspace</tt> command, followed by the\r
 number or name of the workspace. To move containers to specific workspaces, use\r
 <tt>move workspace</tt>.</p></div>\r
@@ -888,6 +889,30 @@ bindsym mod+Shift+1 move workspace 1
 bindsym mod+Shift+2 move workspace 2\r
 ...</tt></pre>\r
 </div></div>\r
+<div class="sect3">\r
+<h4 id="_named_workspaces">5.4.1. Named workspaces</h4>\r
+<div class="paragraph"><p>Workspaces are identified by their name. So, instead of using numbers in the\r
+workspace command, you can use an arbitrary name:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym mod+1 workspace mail\r
+...</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>If you want the workspace to have a number <strong>and</strong> a name, just prefix the\r
+number, like this:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym mod+1 workspace 1: mail\r
+bindsym mod+2 workspace 2: www\r
+...</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Note that the workspace will really be named "1: mail". i3 treats workspace\r
+names beginning with a number in a slightly special way. Normally, named\r
+workspaces are ordered the way they appeared. When they start with a number, i3\r
+will order them numerically.</p></div>\r
+</div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="resizingconfig">5.5. Resizing containers/windows</h3>\r