]> git.sur5r.net Git - i3/i3.github.io/commitdiff
update docs for 4.15
authorMichael Stapelberg <michael@stapelberg.de>
Sat, 10 Mar 2018 17:30:15 +0000 (18:30 +0100)
committerMichael Stapelberg <michael@stapelberg.de>
Sat, 10 Mar 2018 17:30:15 +0000 (18:30 +0100)
_docs/debugging
_docs/i3bar-protocol
_docs/ipc
_docs/testsuite
_docs/userguide
docs/debugging.html
docs/i3bar-protocol.html
docs/ipc.html
docs/testsuite.html
docs/userguide.html

index 8c6b2b7ca5147d577284c4bb0b17745ad943861d..9734b212e16325ef5e0d789d2674d95ed8ef71af 100644 (file)
@@ -10,7 +10,7 @@ Thank you for being interested in debugging i3. It really means
 something to us to get your bug fixed. If you have any questions about the
 process and/or need further help, do not hesitate to contact us!
 
-== Verify you are using i3 ≥ 4.14.1
+== Verify you are using i3 ≥ 4.15
 
 Only the latest major version of i3 is supported. To verify which version
 you are running, use:
@@ -153,7 +153,7 @@ When sending bug reports, please attach the *whole* log file. Even if you think
 you found the section which clearly highlights the problem, additional
 information might be necessary to completely diagnose the problem.
 
-When debugging with us in IRC, be prepared to use a so called nopaste service
+When debugging with us in IRC, be prepared to use a so-called nopaste service
 such as https://pastebin.com because pasting large amounts of text in IRC
 sometimes leads to incomplete lines (servers have line length limitations) or
 flood kicks.
index b8c2b5ad774be7c700632fb359e2ef5e7c3e92d3..cf86531cc5f399774e983770719245729693c17a 100644 (file)
@@ -177,7 +177,8 @@ separator_block_width::
 markup::
        A string that indicates how the text of the block should be parsed. Set to
        +"pango"+ to use https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup].
-       Set to +"none"+ to not use any markup (default).
+       Set to +"none"+ to not use any markup (default). Pango markup only works
+       if you use a pango font.
 
 If you want to put in your own entries into a block, prefix the key with an
 underscore (_). i3bar will ignore all keys it doesn’t understand, and prefixing
@@ -236,6 +237,11 @@ x, y::
        X11 root window coordinates where the click occurred
 button::
        X11 button ID (for example 1 to 3 for left/middle/right mouse button)
+relative_x, relative_y::
+    Coordinates where the click occurred, with respect to the top left corner
+    of the block
+width, height::
+    Width and height (in px) of the block
 
 *Example*:
 ------------------------------------------
@@ -244,6 +250,10 @@ button::
  "instance": "eth0",
  "button": 1,
  "x": 1320,
- "y": 1400
+ "y": 1400,
+ "relative_x": 12,
+ "relative_y": 8,
+ "width": 50,
+ "height": 22
 }
 ------------------------------------------
index 2a6112bde87598e2211856c8b4f9824e1fb1ed19..8b767adebffa127bab432c2c9607b57ce491567b 100644 (file)
--- a/_docs/ipc
+++ b/_docs/ipc
@@ -64,6 +64,7 @@ to do that).
 | 7 | +GET_VERSION+ | <<_version_reply,VERSION>> | Gets the i3 version.
 | 8 | +GET_BINDING_MODES+ | <<_binding_modes_reply,BINDING_MODES>> | Gets the names of all currently configured binding modes.
 | 9 | +GET_CONFIG+ | <<_config_reply,CONFIG>> | Returns the last loaded i3 config.
+| 10 | +SEND_TICK+ | <<_tick_reply,TICK>> | Sends a tick event with the specified payload.
 |======================================================
 
 So, a typical message could look like this:
@@ -126,6 +127,8 @@ BINDING_MODES (8)::
         Reply to the GET_BINDING_MODES message.
 GET_CONFIG (9)::
        Reply to the GET_CONFIG message.
+TICK (10)::
+       Reply to the SEND_TICK message.
 
 [[_command_reply]]
 === COMMAND reply
@@ -637,6 +640,19 @@ which is a string containing the config file as loaded by i3 most recently.
 { "config": "font pango:monospace 8\nbindsym Mod4+q exit\n" }
 -------------------
 
+[[_tick_reply]]
+=== TICK reply
+
+The reply is a map containing the "success" member. After the reply was
+received, the tick event has been written to all IPC connections which subscribe
+to tick events. UNIX sockets are usually buffered, but you can be certain that
+once you receive the tick event you just triggered, you must have received all
+events generated prior to the +SEND_TICK+ message (happened-before relation).
+
+*Example:*
+-------------------
+{ "success": true }
+-------------------
 
 == Events
 
@@ -694,6 +710,10 @@ binding (5)::
        mouse
 shutdown (6)::
        Sent when the ipc shuts down because of a restart or exit by user command
+tick (7)::
+       Sent when the ipc client subscribes to the tick event (with +"first":
+       true+) or when any ipc client sends a SEND_TICK message (with +"first":
+       false+).
 
 *Example:*
 --------------------------------------------------------------------
@@ -866,6 +886,27 @@ because of a user action such as a +restart+ or +exit+ command. The +change
 }
 ---------------------------
 
+=== tick event
+
+This event is triggered by a subscription to tick events or by a +SEND_TICK+
+message.
+
+*Example (upon subscription):*
+--------------------------------------------------------------------------------
+{
+ "first": true,
+ "payload": ""
+}
+--------------------------------------------------------------------------------
+
+*Example (upon +SEND_TICK+ with a payload of +arbitrary string+):*
+--------------------------------------------------------------------------------
+{
+ "first": false,
+ "payload": "arbitrary string"
+}
+--------------------------------------------------------------------------------
+
 == See also (existing libraries)
 
 [[libraries]]
@@ -879,10 +920,9 @@ C::
        * https://github.com/acrisci/i3ipc-glib
 C++::
        * https://github.com/drmgc/i3ipcpp
-Crystal::
-    * https://github.com/woodruffw/i3.cr
 Go::
        * https://github.com/mdirkse/i3ipc-go
+       * https://github.com/i3/go-i3
 JavaScript::
        * https://github.com/acrisci/i3ipc-gjs
 Lua::
@@ -891,7 +931,6 @@ Perl::
        * https://metacpan.org/module/AnyEvent::I3
 Python::
        * https://github.com/acrisci/i3ipc-python
-       * https://github.com/Ceryn/i3msg-python
        * https://github.com/whitelynx/i3ipc (not maintained)
        * https://github.com/ziberna/i3-py (not maintained)
 Ruby::
@@ -961,3 +1000,6 @@ detect the byte order i3 is using:
      payload. Then, receive the pending +COMMAND+ message reply in big endian.
 
 5. From here on out, send/receive all messages using the detected byte order.
+
+Find an example implementation of this technique in
+https://github.com/i3/go-i3/blob/master/byteorder.go
index bf85cb1fbe34411cffa0c19b71d79dd4b6ea6193..b535e7c141ca994b9f453771097868e9150c8104 100644 (file)
@@ -113,10 +113,8 @@ containing the appropriate i3 logfile for each testcase. The latest folder can
 always be found under the symlink +latest/+. Unless told differently, it will
 run the tests on a separate X server instance (using Xephyr).
 
-Xephyr will open a window where you can inspect the running test. You can run
-the tests without an X session with Xvfb, such as with +xvfb-run
-./complete-run+. This will also speed up the tests significantly especially on
-machines without a powerful video card.
+Xephyr will open a window where you can inspect the running test. By default,
+tests are run under Xvfb.
 
 .Example invocation of +complete-run.pl+
 ---------------------------------------
index 67a00b19189db4576a13f379a40a37f30874c709..ba314af111a62493477dad54d4f030d743fdd0b4 100644 (file)
@@ -1,7 +1,6 @@
 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/
@@ -11,7 +10,7 @@ mailing list.
 == Default keybindings
 
 For the "too long; didn’t read" people, here is an overview of the default
-keybindings (click to see the full size image):
+keybindings (click to see the full-size image):
 
 *Keys to use with $mod (Alt):*
 
@@ -35,7 +34,8 @@ above, just decline i3-config-wizard’s offer and base your config on
 
 Throughout this guide, the keyword +$mod+ will be used to refer to the
 configured modifier. This is the Alt key (+Mod1+) by default, with the Windows
-key (+Mod4+) being a popular alternative.
+key (+Mod4+) being a popular alternative that largely prevents conflicts with
+application-defined shortcuts.
 
 === Opening terminals and moving around
 
@@ -196,7 +196,7 @@ out to be complicated to use (snapping), understand and implement.
 
 === The tree consists of Containers
 
-The building blocks of our tree are so called +Containers+. A +Container+ can
+The building blocks of our tree are so-called +Containers+. A +Container+ can
 host a window (meaning an X11 window, one that you can actually see and use,
 like a browser). Alternatively, it could contain one or more +Containers+. A
 simple example is the workspace: When you start i3 with a single monitor, a
@@ -244,7 +244,7 @@ vertically split terminals on the right, focus is on the bottom right one. When
 you open a new terminal, it will open below the current one.
 
 So, how can you open a new terminal window to the *right* of the current one?
-The solution is to use +focus parent+ (+$mod+a+ by default), which will focus the +Parent Container+ of
+The solution is to use +focus parent+, which will focus the +Parent Container+ of
 the current +Container+. In this case, you would focus the +Vertical Split
 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
 windows will be opened to the right of the +Vertical Split Container+:
@@ -509,7 +509,7 @@ mode "$mode_launcher" {
 === The floating modifier
 
 To move floating windows with your mouse, you can either grab their titlebar
-or configure the so called floating modifier which you can then press and
+or configure the so-called floating modifier which you can then press and
 click anywhere in the window itself to move it. The most common setup is to
 use the same key you use for managing windows (Mod1 for example). Then
 you can press Mod1, click into a window using your left mouse button, and drag
@@ -585,23 +585,26 @@ workspace_layout default|stacking|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
-+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*:
 ---------------------------------------------
-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*:
 ---------------------
-new_window pixel
+default_border pixel
 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in
@@ -609,11 +612,11 @@ pixels:
 
 *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
-new_window pixel 3
+default_border pixel 3
 ---------------------
 
 
@@ -760,13 +763,18 @@ title change. As i3 will get the title as soon as the application maps the
 window (mapping means actually displaying it on the screen), you’d need to have
 to match on 'Firefox' in this case.
 
+You can also assign a window to show up on a specific output. You can use RandR
+names such as +VGA1+ or names relative to the output with the currently focused
+workspace such as +left+ and +down+.
+
 Assignments are processed by i3 in the order in which they appear in the config
 file. The first one which matches the window wins and later assignments are not
 considered.
 
 *Syntax*:
 ------------------------------------------------------------
-assign <criteria> [→] [workspace] <workspace>
+assign <criteria> [→] [workspace] [number] <workspace>
+assign <criteria> [→] output left|right|up|down|primary|<output>
 ------------------------------------------------------------
 
 *Examples*:
@@ -783,11 +791,28 @@ assign [class="^URxvt$"] → 2
 # Assignment to a named workspace
 assign [class="^URxvt$"] → work
 
+# Assign to the workspace with number 2, regardless of name
+assign [class="^URxvt$"] → number 2
+
+# You can also specify a number + name. If the workspace with number 2 exists, assign will skip the text part.
+assign [class="^URxvt$"] → number "2: work"
+
 # Start urxvt -name irssi
 assign [class="^URxvt$" instance="^irssi$"] → 3
+
+# Assign urxvt to the output right of the current one
+assign [class="^URxvt$"] → output right
+
+# Assign urxvt to the primary output
+assign [class="^URxvt$"] → output primary
 ----------------------
 
-Note that the arrow is not required, it just looks good :-). If you decide to
+Note that you might not have a primary output configured yet. To do so, run:
+-------------------------
+xrandr --output <output> --primary
+-------------------------
+
+Also, the arrow is not required, it just looks good :-). If you decide to
 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
 
 To get the class and instance, you can use +xprop+. After clicking on the
@@ -1033,26 +1058,39 @@ popup_during_fullscreen smart
 
 === 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 behavior so you can navigate to
-all your windows without having to use +focus parent+.
+By default, when in a container with several windows or child containers, the
+opposite window will be focused when trying to move the focus over the edge of
+a container (and there are no other containers in that direction) -- the focus
+wraps.
+
+If desired, you can disable this behavior by setting the +focus_wrapping+
+configuration directive to the value +no+.
+
+When enabled, focus wrapping does not occur by default if there is another
+window or container in the specified direction, and focus will instead be set
+on that window or container. This is the default behavior 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.
+parent+ to switch to different containers, you can instead set +focus_wrapping+
+to the value +force+.
 
 *Syntax*:
 ---------------------------
-force_focus_wrapping yes|no
----------------------------
+focus_wrapping yes|no|force
 
-*Example*:
-------------------------
+# Legacy syntax, equivalent to "focus_wrapping force"
 force_focus_wrapping yes
-------------------------
+---------------------------
+
+*Examples*:
+-----------------
+# Disable focus wrapping
+focus_wrapping no
+
+# Force focus wrapping
+focus_wrapping force
+-----------------
 
 === Forcing Xinerama
 
@@ -1341,7 +1379,7 @@ and will be removed in a future release. We strongly recommend using the more ge
 
 *Syntax*:
 ----------------------------
-bindsym button<n> <command>
+bindsym [--release] button<n> <command>
 ----------------------------
 
 *Example*:
@@ -1349,6 +1387,8 @@ bindsym button<n> <command>
 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
 }
@@ -1913,6 +1953,9 @@ bindsym $mod+t floating toggle
 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::
@@ -1932,6 +1975,7 @@ output::
 
 *Syntax*:
 ----------------------------------------------
+<criteria> focus
 focus left|right|down|up
 focus parent|child|floating|tiling|mode_toggle
 focus output left|right|up|down|primary|<output>
@@ -1939,6 +1983,9 @@ focus output left|right|up|down|primary|<output>
 
 *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
@@ -2266,7 +2313,7 @@ If you want to resize containers/windows using your keyboard, you can use the
 *Syntax*:
 -------------------------------------------------------
 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
-resize set <width> [px] <height> [px]
+resize set <width> [px | ppt] <height> [px | ppt]
 -------------------------------------------------------
 
 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
@@ -2275,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
-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
@@ -2362,10 +2412,10 @@ TODO: make i3-input replace %s
 *Examples*:
 ---------------------------------------
 # Read 1 character and mark the current window with this character
-bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
+bindsym $mod+m exec i3-input -F 'mark %s' -l 1 -P 'Mark: '
 
 # Read 1 character and go to the window with the character
-bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
+bindsym $mod+g exec i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Goto: '
 ---------------------------------------
 
 Alternatively, if you do not want to mess with +i3-input+, you could create
index a98a417a698d25efa0511e502a01d37679b750ad..da9dca0fb1c503d33cd06cdb1dc4e9b266215775 100644 (file)
@@ -44,7 +44,7 @@ process and/or need further help, do not hesitate to contact us!</p></div>
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="_verify_you_are_using_i3_4_14_1">1. Verify you are using i3 ≥ 4.14.1</h2>\r
+<h2 id="_verify_you_are_using_i3_4_15">1. Verify you are using i3 ≥ 4.15</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Only the latest major version of i3 is supported. To verify which version\r
 you are running, use:</p></div>\r
@@ -221,7 +221,7 @@ starting at 0.</p></div>
 <div class="paragraph"><p>When sending bug reports, please attach the <strong>whole</strong> log file. Even if you think\r
 you found the section which clearly highlights the problem, additional\r
 information might be necessary to completely diagnose the problem.</p></div>\r
-<div class="paragraph"><p>When debugging with us in IRC, be prepared to use a so called nopaste service\r
+<div class="paragraph"><p>When debugging with us in IRC, be prepared to use a so-called nopaste service\r
 such as <a href="https://pastebin.com">https://pastebin.com</a> because pasting large amounts of text in IRC\r
 sometimes leads to incomplete lines (servers have line length limitations) or\r
 flood kicks.</p></div>\r
index 4955b8900fe1e533787df23811855051c28be995..e84e177719130eb4e489f8f19376cb2d1b321b1e 100644 (file)
@@ -322,7 +322,8 @@ markup
 <p>\r
         A string that indicates how the text of the block should be parsed. Set to\r
         <tt>"pango"</tt> to use <a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>.\r
-        Set to <tt>"none"</tt> to not use any markup (default).\r
+        Set to <tt>"none"</tt> to not use any markup (default). Pango markup only works\r
+        if you use a pango font.\r
 </p>\r
 </dd>\r
 </dl></div>\r
@@ -405,6 +406,23 @@ button
         X11 button ID (for example 1 to 3 for left/middle/right mouse button)\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+relative_x, relative_y\r
+</dt>\r
+<dd>\r
+<p>\r
+    Coordinates where the click occurred, with respect to the top left corner\r
+    of the block\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+width, height\r
+</dt>\r
+<dd>\r
+<p>\r
+    Width and height (in px) of the block\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -414,7 +432,11 @@ button
  "instance": "eth0",\r
  "button": 1,\r
  "x": 1320,\r
- "y": 1400\r
+ "y": 1400,\r
+ "relative_x": 12,\r
+ "relative_y": 8,\r
+ "width": 50,\r
+ "height": 22\r
 }</tt></pre>\r
 </div></div>\r
 </div>\r
index 34a55eaf82ac70a6b11b9509f6e6be4b59b23250..350483e33f37c8463906ac6da522aa4867504de3 100644 (file)
@@ -171,6 +171,12 @@ cellspacing="0" cellpadding="4">
 <td align="center" valign="top"><p class="table"><a href="#_config_reply">CONFIG</a></p></td>\r
 <td align="center" valign="top"><p class="table">Returns the last loaded i3 config.</p></td>\r
 </tr>\r
+<tr>\r
+<td align="center" valign="top"><p class="table">10</p></td>\r
+<td align="center" valign="top"><p class="table"><tt>SEND_TICK</tt></p></td>\r
+<td align="center" valign="top"><p class="table"><a href="#_tick_reply">TICK</a></p></td>\r
+<td align="center" valign="top"><p class="table">Sends a tick event with the specified payload.</p></td>\r
+</tr>\r
 </tbody>\r
 </table>\r
 </div>\r
@@ -295,6 +301,14 @@ GET_CONFIG (9)
         Reply to the GET_CONFIG message.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+TICK (10)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Reply to the SEND_TICK message.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1186,6 +1200,19 @@ which is a string containing the config file as loaded by i3 most recently.</p><
 <pre><tt>{ "config": "font pango:monospace 8\nbindsym Mod4+q exit\n" }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_tick_reply">3.12. TICK reply</h3>\r
+<div class="paragraph"><p>The reply is a map containing the "success" member. After the reply was\r
+received, the tick event has been written to all IPC connections which subscribe\r
+to tick events. UNIX sockets are usually buffered, but you can be certain that\r
+once you receive the tick event you just triggered, you must have received all\r
+events generated prior to the <tt>SEND_TICK</tt> message (happened-before relation).</p></div>\r
+<div class="paragraph"><p><strong>Example:</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>{ "success": true }</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1282,6 +1309,16 @@ shutdown (6)
         Sent when the ipc shuts down because of a restart or exit by user command\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+tick (7)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Sent when the ipc client subscribes to the tick event (with <tt>"first":\r
+        true</tt>) or when any ipc client sends a SEND_TICK message (with <tt>"first":\r
+        false</tt>).\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 <div class="listingblock">\r
@@ -1520,6 +1557,27 @@ because of a user action such as a <tt>restart</tt> or <tt>exit</tt> command. Th
 }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_tick_event">4.10. tick event</h3>\r
+<div class="paragraph"><p>This event is triggered by a subscription to tick events or by a <tt>SEND_TICK</tt>\r
+message.</p></div>\r
+<div class="paragraph"><p><strong>Example (upon subscription):</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>{\r
+ "first": true,\r
+ "payload": ""\r
+}</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example (upon <tt>SEND_TICK</tt> with a payload of <tt>arbitrary string</tt>):</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>{\r
+ "first": false,\r
+ "payload": "arbitrary string"\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1568,6 +1626,11 @@ Go
 <a href="https://github.com/mdirkse/i3ipc-go">https://github.com/mdirkse/i3ipc-go</a>\r
 </p>\r
 </li>\r
+<li>\r
+<p>\r
+<a href="https://github.com/i3/go-i3">https://github.com/i3/go-i3</a>\r
+</p>\r
+</li>\r
 </ul></div>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -1618,11 +1681,6 @@ Python
 </li>\r
 <li>\r
 <p>\r
-<a href="https://github.com/Ceryn/i3msg-python">https://github.com/Ceryn/i3msg-python</a>\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
 <a href="https://github.com/whitelynx/i3ipc">https://github.com/whitelynx/i3ipc</a> (not maintained)\r
 </p>\r
 </li>\r
@@ -1785,6 +1843,8 @@ From here on out, send/receive all messages using the detected byte order.
 </p>\r
 </li>\r
 </ol></div>\r
+<div class="paragraph"><p>Find an example implementation of this technique in\r
+<a href="https://github.com/i3/go-i3/blob/master/byteorder.go">https://github.com/i3/go-i3/blob/master/byteorder.go</a></p></div>\r
 </div>\r
 </div>\r
 </div>\r
index 894676538921354360ce01bfe05f69ec8f0f6a06..375b246de02404504681591a08a358683c42cb44 100644 (file)
@@ -175,10 +175,8 @@ with an appropriate configuration file and creates a folder for each run
 containing the appropriate i3 logfile for each testcase. The latest folder can\r
 always be found under the symlink <tt>latest/</tt>. Unless told differently, it will\r
 run the tests on a separate X server instance (using Xephyr).</p></div>\r
-<div class="paragraph"><p>Xephyr will open a window where you can inspect the running test. You can run\r
-the tests without an X session with Xvfb, such as with <tt>xvfb-run\r
-./complete-run</tt>. This will also speed up the tests significantly especially on\r
-machines without a powerful video card.</p></div>\r
+<div class="paragraph"><p>Xephyr will open a window where you can inspect the running test. By default,\r
+tests are run under Xvfb.</p></div>\r
 <div class="listingblock">\r
 <div class="title">Example invocation of <tt>complete-run.pl</tt></div>\r
 <div class="content">\r
index d2e4c3a8fa1a701b642ece3bbb532686fa859c0c..d98a8c5193b4ab58ad20ca589b26e32acd652220 100644 (file)
@@ -32,7 +32,6 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
 <h1>i3 User’s Guide</h1>\r
 <span id="author">Michael Stapelberg</span><br />\r
 <span id="email"><tt>&lt;<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>&gt;</tt></span><br />\r
-<span id="revdate">March 2013</span>\r
 <div id="toc">
   <div id="toctitle">Table of Contents</div>
   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
@@ -50,7 +49,7 @@ mailing list.</p></div>
 <h2 id="_default_keybindings">1. Default keybindings</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>For the "too long; didn’t read" people, here is an overview of the default\r
-keybindings (click to see the full size image):</p></div>\r
+keybindings (click to see the full-size image):</p></div>\r
 <div class="paragraph"><p><strong>Keys to use with $mod (Alt):</strong></p></div>\r
 <div class="paragraph"><p><span class="image">\r
 <a class="image" href="keyboard-layer1.png">\r
@@ -78,7 +77,8 @@ above, just decline i3-config-wizard’s offer and base your config on
 <div class="sectionbody">\r
 <div class="paragraph"><p>Throughout this guide, the keyword <tt>$mod</tt> will be used to refer to the\r
 configured modifier. This is the Alt key (<tt>Mod1</tt>) by default, with the Windows\r
-key (<tt>Mod4</tt>) being a popular alternative.</p></div>\r
+key (<tt>Mod4</tt>) being a popular alternative that largely prevents conflicts with\r
+application-defined shortcuts.</p></div>\r
 <div class="sect2">\r
 <h3 id="_opening_terminals_and_moving_around">2.1. Opening terminals and moving around</h3>\r
 <div class="paragraph"><p>One very basic operation is opening a new terminal. By default, the keybinding\r
@@ -248,7 +248,7 @@ finally the windows themselves. In previous versions of i3 we had multiple lists
 out to be complicated to use (snapping), understand and implement.</p></div>\r
 <div class="sect2">\r
 <h3 id="_the_tree_consists_of_containers">3.1. The tree consists of Containers</h3>\r
-<div class="paragraph"><p>The building blocks of our tree are so called <tt>Containers</tt>. A <tt>Container</tt> can\r
+<div class="paragraph"><p>The building blocks of our tree are so-called <tt>Containers</tt>. A <tt>Container</tt> can\r
 host a window (meaning an X11 window, one that you can actually see and use,\r
 like a browser). Alternatively, it could contain one or more <tt>Containers</tt>. A\r
 simple example is the workspace: When you start i3 with a single monitor, a\r
@@ -311,7 +311,7 @@ of splits can be.</p></div>
 vertically split terminals on the right, focus is on the bottom right one. When\r
 you open a new terminal, it will open below the current one.</p></div>\r
 <div class="paragraph"><p>So, how can you open a new terminal window to the <strong>right</strong> of the current one?\r
-The solution is to use <tt>focus parent</tt> (<tt>$mod+a</tt> by default), which will focus the <tt>Parent Container</tt> of\r
+The solution is to use <tt>focus parent</tt>, which will focus the <tt>Parent Container</tt> of\r
 the current <tt>Container</tt>. In this case, you would focus the <tt>Vertical Split\r
 Container</tt> which is <strong>inside</strong> the horizontally oriented workspace. Thus, now new\r
 windows will be opened to the right of the <tt>Vertical Split Container</tt>:</p></div>\r
@@ -576,7 +576,7 @@ mode "$mode_launcher" {
 <div class="sect2">\r
 <h3 id="floating_modifier">4.6. The floating modifier</h3>\r
 <div class="paragraph"><p>To move floating windows with your mouse, you can either grab their titlebar\r
-or configure the so called floating modifier which you can then press and\r
+or configure the so-called floating modifier which you can then press and\r
 click anywhere in the window itself to move it. The most common setup is to\r
 use the same key you use for managing windows (Mod1 for example). Then\r
 you can press Mod1, click into a window using your left mouse button, and drag\r
@@ -651,33 +651,35 @@ start.</p></div>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_border_style_for_new_windows">4.10. Border style for new windows</h3>\r
+<h3 id="_default_border_style_for_new_windows">4.10. Default border style for new windows</h3>\r
 <div class="paragraph"><p>This option determines which border style new windows will have. The default is\r
-<tt>normal</tt>. Note that new_float applies only to windows which are starting out as\r
+<tt>normal</tt>. Note that default_floating_border applies only to windows which are starting out as\r
 floating windows, e.g., dialog windows, but not windows that are floated later on.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>new_window normal|none|pixel\r
-new_window normal|pixel &lt;px&gt;\r
-new_float normal|none|pixel\r
-new_float normal|pixel &lt;px&gt;</tt></pre>\r
+<pre><tt>default_border normal|none|pixel\r
+default_border normal|pixel &lt;px&gt;\r
+default_floating_border normal|none|pixel\r
+default_floating_border normal|pixel &lt;px&gt;</tt></pre>\r
 </div></div>\r
+<div class="paragraph"><p>Please note that <tt>new_window</tt> and <tt>new_float</tt> have been deprecated in favor of the above options\r
+and will be removed in a future release. We strongly recommend using the new options instead.</p></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>new_window pixel</tt></pre>\r
+<pre><tt>default_border pixel</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>The "normal" and "pixel" border styles support an optional border width in\r
 pixels:</p></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># The same as new_window none\r
-new_window pixel 0\r
+<pre><tt># The same as default_border none\r
+default_border pixel 0\r
 \r
 # A 3 px border\r
-new_window pixel 3</tt></pre>\r
+default_border pixel 3</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -810,13 +812,17 @@ starts up being named Firefox, and only when Vimperator is loaded does the
 title change. As i3 will get the title as soon as the application maps the\r
 window (mapping means actually displaying it on the screen), you’d need to have\r
 to match on <em>Firefox</em> in this case.</p></div>\r
+<div class="paragraph"><p>You can also assign a window to show up on a specific output. You can use RandR\r
+names such as <tt>VGA1</tt> or names relative to the output with the currently focused\r
+workspace such as <tt>left</tt> and <tt>down</tt>.</p></div>\r
 <div class="paragraph"><p>Assignments are processed by i3 in the order in which they appear in the config\r
 file. The first one which matches the window wins and later assignments are not\r
 considered.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>assign &lt;criteria&gt; [→] [workspace] &lt;workspace&gt;</tt></pre>\r
+<pre><tt>assign &lt;criteria&gt; [→] [workspace] [number] &lt;workspace&gt;\r
+assign &lt;criteria&gt; [→] output left|right|up|down|primary|&lt;output&gt;</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -833,10 +839,27 @@ assign [class="^URxvt$"] → 2
 # Assignment to a named workspace\r
 assign [class="^URxvt$"] → work\r
 \r
+# Assign to the workspace with number 2, regardless of name\r
+assign [class="^URxvt$"] → number 2\r
+\r
+# You can also specify a number + name. If the workspace with number 2 exists, assign will skip the text part.\r
+assign [class="^URxvt$"] → number "2: work"\r
+\r
 # Start urxvt -name irssi\r
-assign [class="^URxvt$" instance="^irssi$"] → 3</tt></pre>\r
+assign [class="^URxvt$" instance="^irssi$"] → 3\r
+\r
+# Assign urxvt to the output right of the current one\r
+assign [class="^URxvt$"] → output right\r
+\r
+# Assign urxvt to the primary output\r
+assign [class="^URxvt$"] → output primary</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>xrandr --output &lt;output&gt; --primary</tt></pre>\r
 </div></div>\r
-<div class="paragraph"><p>Note that the arrow is not required, it just looks good :-). If you decide to\r
+<div class="paragraph"><p>Also, the arrow is not required, it just looks good :-). If you decide to\r
 use it, it has to be a UTF-8 encoded arrow, not <tt>-&gt;</tt> or something like that.</p></div>\r
 <div class="paragraph"><p>To get the class and instance, you can use <tt>xprop</tt>. After clicking on the\r
 window, you will see the following output:</p></div>\r
@@ -1113,24 +1136,35 @@ Leave fullscreen mode.
 </div>\r
 <div class="sect2">\r
 <h3 id="_focus_wrapping">4.24. Focus wrapping</h3>\r
-<div class="paragraph"><p>When being in a tabbed or stacked container, the first container will be\r
-focused when you use <tt>focus down</tt> on the last container&#8201;&#8212;&#8201;the focus wraps. If\r
-however there is another stacked/tabbed container in that direction, focus will\r
-be set on that container. This is the default behavior so you can navigate to\r
-all your windows without having to use <tt>focus parent</tt>.</p></div>\r
+<div class="paragraph"><p>By default, when in a container with several windows or child containers, the\r
+opposite window will be focused when trying to move the focus over the edge of\r
+a container (and there are no other containers in that direction)&#8201;&#8212;&#8201;the focus\r
+wraps.</p></div>\r
+<div class="paragraph"><p>If desired, you can disable this behavior by setting the <tt>focus_wrapping</tt>\r
+configuration directive to the value <tt>no</tt>.</p></div>\r
+<div class="paragraph"><p>When enabled, focus wrapping does not occur by default if there is another\r
+window or container in the specified direction, and focus will instead be set\r
+on that window or container. This is the default behavior so you can navigate\r
+to all your windows without having to use <tt>focus parent</tt>.</p></div>\r
 <div class="paragraph"><p>If you want the focus to <strong>always</strong> wrap and you are aware of using <tt>focus\r
-parent</tt> to switch to different containers, you can use the\r
-<tt>force_focus_wrapping</tt> configuration directive. After enabling it, the focus\r
-will always wrap.</p></div>\r
+parent</tt> to switch to different containers, you can instead set <tt>focus_wrapping</tt>\r
+to the value <tt>force</tt>.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>force_focus_wrapping yes|no</tt></pre>\r
+<pre><tt>focus_wrapping yes|no|force\r
+\r
+# Legacy syntax, equivalent to "focus_wrapping force"\r
+force_focus_wrapping yes</tt></pre>\r
 </div></div>\r
-<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>force_focus_wrapping yes</tt></pre>\r
+<pre><tt># Disable focus wrapping\r
+focus_wrapping no\r
+\r
+# Force focus wrapping\r
+focus_wrapping force</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1466,7 +1500,7 @@ and will be removed in a future release. We strongly recommend using the more ge
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>bindsym button&lt;n&gt; &lt;command&gt;</tt></pre>\r
+<pre><tt>bindsym [--release] button&lt;n&gt; &lt;command&gt;</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -1474,6 +1508,8 @@ and will be removed in a future release. We strongly recommend using the more ge
 <pre><tt>bar {\r
     # disable clicking on workspace buttons\r
     bindsym button1 nop\r
+    # Take a screenshot by right clicking on the bar\r
+    bindsym --release button3 exec --no-startup-id import /tmp/latest-screenshot.png\r
     # execute custom script when scrolling downwards\r
     bindsym button5 exec ~/.i3/scripts/custom_wheel_down\r
 }</tt></pre>\r
@@ -2151,6 +2187,15 @@ bindsym $mod+t floating toggle</tt></pre>
 available:</p></div>\r
 <div class="dlist"><dl>\r
 <dt class="hdlist1">\r
+&lt;criteria&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+    Sets focus to the container that matches the specified criteria.\r
+    See <a href="#command_criteria">[command_criteria]</a>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 left|right|up|down\r
 </dt>\r
 <dd>\r
@@ -2212,14 +2257,18 @@ output
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>focus left|right|down|up\r
+<pre><tt>&lt;criteria&gt; focus\r
+focus left|right|down|up\r
 focus parent|child|floating|tiling|mode_toggle\r
 focus output left|right|up|down|primary|&lt;output&gt;</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># Focus container on the left, bottom, top, right\r
+<pre><tt># Focus firefox\r
+bindsym $mod+F1 [class="Firefox"] focus\r
+\r
+# Focus container on the left, bottom, top, right\r
 bindsym $mod+j focus left\r
 bindsym $mod+k focus down\r
 bindsym $mod+l focus up\r
@@ -2516,45 +2565,40 @@ bindsym $mod+x move container to output VGA1
 # Put this window on the primary output.\r
 bindsym $mod+x move container to output primary</tt></pre>\r
 </div></div>\r
+<div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>Note that you might not have a primary output configured yet. To do so, run:</tt></pre>\r
+<pre><tt>xrandr --output &lt;output&gt; --primary</tt></pre>\r
 </div></div>\r
-<div class="paragraph"><p>xrandr --output &lt;output&gt; --primary</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>=== Moving containers/windows to marks\r
-\r
-To move a container to another container with a specific mark (see &lt;&lt;vim_like_marks&gt;&gt;),\r
-you can use the following command.\r
-\r
-The window will be moved right after the marked container in the tree, i.e., it ends up\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_moving_containers_windows_to_marks">6.11. Moving containers/windows to marks</h3>\r
+<div class="paragraph"><p>To move a container to another container with a specific mark (see <a href="#vim_like_marks">[vim_like_marks]</a>),\r
+you can use the following command.</p></div>\r
+<div class="paragraph"><p>The window will be moved right after the marked container in the tree, i.e., it ends up\r
 in the same position as if you had opened a new window when the marked container was\r
 focused. If the mark is on a split container, the window will appear as a new child\r
-after the currently focused child within that container.\r
-\r
-*Syntax*:</tt></pre>\r
+after the currently focused child within that container.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>move window|container to mark &lt;mark&gt;</tt></pre>\r
 </div></div>\r
-</div>\r
-</div>\r
-</div>\r
-<div class="sect1">\r
-<h2 id="_move_window_container_to_mark_lt_mark_gt">7. move window|container to mark &lt;mark&gt;</h2>\r
-<div class="sectionbody">\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>for_window [instance="tabme"] move window to mark target</tt></pre>\r
 </div></div>\r
+</div>\r
 <div class="sect2">\r
-<h3 id="resizingconfig">7.1. Resizing containers/windows</h3>\r
+<h3 id="resizingconfig">6.12. Resizing containers/windows</h3>\r
 <div class="paragraph"><p>If you want to resize containers/windows using your keyboard, you can use the\r
 <tt>resize</tt> command:</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>resize grow|shrink &lt;direction&gt; [&lt;px&gt; px [or &lt;ppt&gt; ppt]]\r
-resize set &lt;width&gt; [px] &lt;height&gt; [px]</tt></pre>\r
+resize set &lt;width&gt; [px | ppt] &lt;height&gt; [px | ppt]</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>Direction can either be one of <tt>up</tt>, <tt>down</tt>, <tt>left</tt> or <tt>right</tt>. Or you can be\r
 less specific and use <tt>width</tt> or <tt>height</tt>, in which case i3 will take/give\r
@@ -2562,8 +2606,10 @@ space from all the other containers. The optional pixel argument specifies by
 how many pixels a <strong>floating container</strong> should be grown or shrunk (the default\r
 is 10 pixels). The ppt argument means percentage points and specifies by how\r
 many percentage points a <strong>tiling container</strong> should be grown or shrunk (the\r
-default is 10 percentage points). Note that <tt>resize set</tt> will only work for\r
-floating containers.</p></div>\r
+default is 10 percentage points).</p></div>\r
+<div class="paragraph"><p>Notes about <tt>resize set</tt>: a value of 0 for &lt;width&gt; or &lt;height&gt; means "do\r
+not resize in this direction", and resizing a tiling container by <tt>px</tt> is not\r
+implemented.</p></div>\r
 <div class="paragraph"><p>It is recommended to define bindings for resizing in a dedicated binding mode.\r
 See <a href="#binding_modes">[binding_modes]</a> and the example in the i3\r
 <a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a> for more\r
@@ -2575,7 +2621,7 @@ context.</p></div>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_jumping_to_specific_windows">7.2. Jumping to specific windows</h3>\r
+<h3 id="_jumping_to_specific_windows">6.13. Jumping to specific windows</h3>\r
 <div class="paragraph"><p>Often when in a multi-monitor environment, you want to quickly jump to a\r
 specific window. For example, while working on workspace 3 you may want to\r
 jump to your mail client to email your boss that you’ve achieved some\r
@@ -2596,7 +2642,7 @@ bindsym $mod+a [class="urxvt" title="VIM"] focus</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="vim_like_marks">7.3. VIM-like marks (mark/goto)</h3>\r
+<h3 id="vim_like_marks">6.14. VIM-like marks (mark/goto)</h3>\r
 <div class="paragraph"><p>This feature is like the jump feature: It allows you to directly jump to a\r
 specific window (this means switching to the appropriate workspace and setting\r
 focus to the windows). However, you can directly mark a specific window with\r
@@ -2639,7 +2685,7 @@ unmark irssi
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="pango_markup">7.4. Window title format</h3>\r
+<h3 id="pango_markup">6.15. Window title format</h3>\r
 <div class="paragraph"><p>By default, i3 will simply print the X11 window title. Using <tt>title_format</tt>,\r
 this can be customized by setting the format to the desired output. This\r
 directive supports\r
@@ -2697,7 +2743,7 @@ for_window [class="(?i)firefox"] title_format "&lt;span foreground='red'&gt;%tit
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_changing_border_style">7.5. Changing border style</h3>\r
+<h3 id="_changing_border_style">6.16. Changing border style</h3>\r
 <div class="paragraph"><p>To change the border of the current client, you can use <tt>border normal</tt> to use the normal\r
 border (including window title), <tt>border pixel 1</tt> to use a 1-pixel border (no window title)\r
 and <tt>border none</tt> to make the client borderless.</p></div>\r
@@ -2726,7 +2772,7 @@ bindsym $mod+u border none</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="shmlog">7.6. Enabling shared memory logging</h3>\r
+<h3 id="shmlog">6.17. Enabling shared memory logging</h3>\r
 <div class="paragraph"><p>As described in <a href="https://i3wm.org/docs/debugging.html">https://i3wm.org/docs/debugging.html</a>, i3 can log to a shared\r
 memory buffer, which you can dump using <tt>i3-dump-log</tt>. The <tt>shmlog</tt> command\r
 allows you to enable or disable the shared memory logging at runtime.</p></div>\r
@@ -2750,7 +2796,7 @@ i3-msg shmlog $((50*1024*1024))</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_enabling_debug_logging">7.7. Enabling debug logging</h3>\r
+<h3 id="_enabling_debug_logging">6.18. Enabling debug logging</h3>\r
 <div class="paragraph"><p>The <tt>debuglog</tt> command allows you to enable or disable debug logging at\r
 runtime. Debug logging is much more verbose than non-debug logging. This\r
 command does not activate shared memory logging (shmlog), and as such is most\r
@@ -2768,7 +2814,7 @@ bindsym $mod+x debuglog toggle</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_reloading_restarting_exiting">7.8. Reloading/Restarting/Exiting</h3>\r
+<h3 id="_reloading_restarting_exiting">6.19. Reloading/Restarting/Exiting</h3>\r
 <div class="paragraph"><p>You can make i3 reload its configuration file with <tt>reload</tt>. You can also\r
 restart i3 inplace with the <tt>restart</tt> command to get it out of some weird state\r
 (if that should ever happen) or to perform an upgrade without having to restart\r
@@ -2783,7 +2829,7 @@ bindsym $mod+Shift+e exit</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_scratchpad">7.9. Scratchpad</h3>\r
+<h3 id="_scratchpad">6.20. Scratchpad</h3>\r
 <div class="paragraph"><p>There are two commands to use any existing window as scratchpad window. <tt>move\r
 scratchpad</tt> will move a window to the scratchpad workspace. This will make it\r
 invisible until you show it again. There is no way to open that workspace.\r
@@ -2818,7 +2864,7 @@ bindsym mod4+s [title="^Sup ::"] scratchpad show</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_nop">7.10. Nop</h3>\r
+<h3 id="_nop">6.21. Nop</h3>\r
 <div class="paragraph"><p>There is a no operation command <tt>nop</tt> which allows you to override default\r
 behavior. This can be useful for, e.g., disabling a focus change on clicks with\r
 the middle mouse button.</p></div>\r
@@ -2838,7 +2884,7 @@ bindsym button2 nop</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_i3bar_control">7.11. i3bar control</h3>\r
+<h3 id="_i3bar_control">6.22. i3bar control</h3>\r
 <div class="paragraph"><p>There are two options in the configuration of each i3bar instance that can be\r
 changed during runtime by invoking a command through i3. The commands <tt>bar\r
 hidden_state</tt> and <tt>bar mode</tt> allow setting the current hidden_state\r
@@ -2872,7 +2918,7 @@ bindsym $mod+Shift+b bar mode invisible bar-1</tt></pre>
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="multi_monitor">8. Multiple monitors</h2>\r
+<h2 id="multi_monitor">7. Multiple monitors</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>As you can see in the goal list on the website, i3 was specifically developed\r
 with support for multiple monitors in mind. This section will explain how to\r
@@ -2895,7 +2941,7 @@ create an unlimited number of workspaces in i3 and tie them to specific
 screens, you can have the "traditional" approach of having X workspaces per\r
 screen by changing your configuration (using modes, for example).</p></div>\r
 <div class="sect2">\r
-<h3 id="_configuring_your_monitors">8.1. Configuring your monitors</h3>\r
+<h3 id="_configuring_your_monitors">7.1. Configuring your monitors</h3>\r
 <div class="paragraph"><p>To help you get going if you have never used multiple monitors before, here is\r
 a short overview of the xrandr options which will probably be of interest to\r
 you. It is always useful to get an overview of the current screen configuration.\r
@@ -2958,7 +3004,7 @@ only what you can see in xrandr.</p></div>
 <div class="paragraph"><p>See also <a href="#presentations">[presentations]</a> for more examples of multi-monitor setups.</p></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_interesting_configuration_for_multi_monitor_environments">8.2. Interesting configuration for multi-monitor environments</h3>\r
+<h3 id="_interesting_configuration_for_multi_monitor_environments">7.2. Interesting configuration for multi-monitor environments</h3>\r
 <div class="paragraph"><p>There are several things to configure in i3 which may be interesting if you\r
 have more than one monitor:</p></div>\r
 <div class="olist arabic"><ol class="arabic">\r
@@ -2995,10 +3041,10 @@ For information on how to move existing workspaces between monitors,
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="_i3_and_the_rest_of_your_software_world">9. i3 and the rest of your software world</h2>\r
+<h2 id="_i3_and_the_rest_of_your_software_world">8. i3 and the rest of your software world</h2>\r
 <div class="sectionbody">\r
 <div class="sect2">\r
-<h3 id="_displaying_a_status_line">9.1. Displaying a status line</h3>\r
+<h3 id="_displaying_a_status_line">8.1. Displaying a status line</h3>\r
 <div class="paragraph"><p>A very common thing amongst users of exotic window managers is a status line at\r
 some corner of the screen. It is an often superior replacement to the widget\r
 approach you have in the task bar of a traditional desktop environment.</p></div>\r
@@ -3015,14 +3061,14 @@ on which hint the application sets. With i3bar, you can configure its position,
 see <a href="#i3bar_position">[i3bar_position]</a>.</p></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="presentations">9.2. Giving presentations (multi-monitor)</h3>\r
+<h3 id="presentations">8.2. Giving presentations (multi-monitor)</h3>\r
 <div class="paragraph"><p>When giving a presentation, you typically want the audience to see what you see\r
 on your screen and then go through a series of slides (if the presentation is\r
 simple). For more complex presentations, you might want to have some notes\r
 which only you can see on your screen, while the audience can only see the\r
 slides.</p></div>\r
 <div class="sect3">\r
-<h4 id="_case_1_everybody_gets_the_same_output">9.2.1. Case 1: everybody gets the same output</h4>\r
+<h4 id="_case_1_everybody_gets_the_same_output">8.2.1. Case 1: everybody gets the same output</h4>\r
 <div class="paragraph"><p>This is the simple case. You connect your computer to the video projector,\r
 turn on both (computer and video projector) and configure your X server to\r
 clone the internal flat panel of your computer to the video output:</p></div>\r
@@ -3035,7 +3081,7 @@ your screen will be left untouched (it will show the X background). So, in
 our example, this would be 1024x768 (my notebook has 1280x800).</p></div>\r
 </div>\r
 <div class="sect3">\r
-<h4 id="_case_2_you_can_see_more_than_your_audience">9.2.2. Case 2: you can see more than your audience</h4>\r
+<h4 id="_case_2_you_can_see_more_than_your_audience">8.2.2. Case 2: you can see more than your audience</h4>\r
 <div class="paragraph"><p>This case is a bit harder. First of all, you should configure the VGA output\r
 somewhere near your internal flat panel, say right of it:</p></div>\r
 <div class="listingblock">\r