]> git.sur5r.net Git - i3/i3.github.io/commitdiff
update docs for 4.14
authorMichael Stapelberg <michael@stapelberg.de>
Mon, 4 Sep 2017 05:56:12 +0000 (07:56 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Mon, 4 Sep 2017 05:56:12 +0000 (07:56 +0200)
12 files changed:
_docs/debugging
_docs/hacking-howto
_docs/ipc
_docs/layout-saving
_docs/testsuite
_docs/userguide
docs/debugging.html
docs/hacking-howto.html
docs/ipc.html
docs/layout-saving.html
docs/testsuite.html
docs/userguide.html

index e4c4fa93db6d23ff773c04383216974d746d5929..925618acb9c9610a44b309c06081088bb9482422 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.13
+== Verify you are using i3 ≥ 4.14
 
 Only the latest major version of i3 is supported. To verify which version
 you are running, use:
index 74a690e7c1ef65d323d5a5f0b03338b3c7b60c79..52436da67418adf62578d1637e5752a09bf96f25 100644 (file)
@@ -119,9 +119,6 @@ src/config.c::
 Contains all functions handling the configuration file (calling the parser
 src/config_parser.c) with the correct path, switching key bindings mode).
 
-src/debug.c::
-Contains debugging functions to print unhandled X events.
-
 src/ewmh.c::
 Functions to get/set certain EWMH properties easily.
 
@@ -993,6 +990,47 @@ New features are only found in the “next” branch. Therefore, if you are work
 on a new feature, use the “next” branch. If you are working on a bugfix, use the
 “next” branch, too, but make sure your code also works on “master”.
 
+=== How to build?
+
+You can build i3 like you build any other software package which uses autotools.
+Here’s a memory refresher:
+
+    $ autoreconf -fi
+    $ mkdir -p build && cd build
+    $ ../configure
+    $ make -j8
+
+(The autoreconf -fi step is unnecessary if you are building from a release tarball,
+ but shouldn’t hurt either.)
+
+==== Build system features
+
+* We use the AX_ENABLE_BUILDDIR macro to enforce builds happening in a separate
+  directory. This is a prerequisite for the AX_EXTEND_SRCDIR macro and building
+  in a separate directory is common practice anyway. In case this causes any
+  trouble when packaging i3 for your distribution, please open an issue.
+
+* “make check” runs the i3 testsuite. See docs/testsuite for details.
+
+* “make distcheck” (runs testsuite on “make dist” result, tiny bit quicker
+  feedback cycle than waiting for the travis build to catch the issue).
+
+* “make uninstall” (occasionally requested by users who compile from source)
+
+* “make” will build manpages/docs by default if the tools are installed.
+  Conversely, manpages/docs are not tried to be built for users who don’t want
+  to install all these dependencies to get started hacking on i3.
+
+* non-release builds will enable address sanitizer by default. Use the
+  --disable-sanitizers configure option to turn off all sanitizers, and see
+  --help for available sanitizers.
+
+* Support for pre-compiled headers (PCH) has been dropped for now in the
+  interest of simplicity. If you need support for PCH, please open an issue.
+
+* Coverage reports are now generated using “make check-code-coverage”, which
+  requires specifying --enable-code-coverage when calling configure.
+
 == Thought experiments
 
 In this section, we collect thought experiments, so that we don’t forget our
index fda289a0a21c2776d30c29a7c4207c7b6484b3bb..6572357704a92064a0b33cb7c830f22f10623e5d 100644 (file)
--- a/_docs/ipc
+++ b/_docs/ipc
@@ -232,6 +232,8 @@ name (string)::
        The name of this output (as seen in +xrandr(1)+). Encoded in UTF-8.
 active (boolean)::
        Whether this output is currently active (has a valid mode).
+primary (boolean)::
+       Whether this output is currently the primary output.
 current_workspace (string)::
        The name of the current workspace that is visible on this output. +null+ if
        the output is not active.
@@ -262,7 +264,7 @@ rect (map)::
    "y": 0,
    "width": 1280,
    "height": 1024
-  },
+  }
  }
 ]
 -------------------
@@ -390,7 +392,7 @@ JSON dump:
         "y": 0,
         "width": 1280,
         "height": 0
-       },
+       }
       },
 
       {
@@ -671,6 +673,8 @@ barconfig_update (4)::
 binding (5)::
        Sent when a configured command binding is triggered with the keyboard or
        mouse
+shutdown (6)::
+       Sent when the ipc shuts down because of a restart or exit by user command
 
 *Example:*
 --------------------------------------------------------------------
@@ -694,9 +698,9 @@ if ($is_event) {
 
 This event consists of a single serialized map containing a property
 +change (string)+ which indicates the type of the change ("focus", "init",
-"empty", "urgent"). A +current (object)+ property will be present with the
-affected workspace whenever the type of event affects a workspace (otherwise,
-it will be +null).
+"empty", "urgent", "reload", "rename", "restored", "move"). A
++current (object)+ property will be present with the affected workspace
+whenever the type of event affects a workspace (otherwise, it will be +null).
 
 When the change is "focus", an +old (object)+ property will be present with the
 previous workspace.  When the first switch occurs (when i3 focuses the
@@ -791,7 +795,7 @@ same as a +GET_BAR_CONFIG+ reply for the bar with the given id.
 === binding event
 
 This event consists of a single serialized map reporting on the details of a
-binding that ran a command because of user input. The +change (sring)+ field
+binding that ran a command because of user input. The +change (string)+ field
 indicates what sort of binding event was triggered (right now it will always be
 +"run"+ but may be expanded in the future).
 
@@ -829,6 +833,20 @@ input_type (string)::
 }
 ---------------------------
 
+=== shutdown event
+
+This event is triggered when the connection to the ipc is about to shutdown
+because of a user action such as a +restart+ or +exit+ command. The +change
+(string)+ field indicates why the ipc is shutting down. It can be either
++"restart"+ or +"exit"+.
+
+*Example:*
+---------------------------
+{
+ "change": "restart"
+}
+---------------------------
+
 == See also (existing libraries)
 
 [[libraries]]
@@ -843,7 +861,7 @@ C::
 C++::
        * https://github.com/drmgc/i3ipcpp
 Go::
-       * https://github.com/proxypoke/i3ipc
+       * https://github.com/mdirkse/i3ipc-go
 JavaScript::
        * https://github.com/acrisci/i3ipc-gjs
 Lua::
@@ -859,3 +877,5 @@ Ruby::
        * https://github.com/badboy/i3-ipc (not maintained)
 Rust::
        * https://github.com/tmerr/i3ipc-rs
+OCaml::
+       * https://github.com/Armael/ocaml-i3ipc
index 5897036e5143f310e2b665e68db6174f7318198b..6ca08fa239dbe7bd38ac2221e987c153cf3162c0 100644 (file)
@@ -259,3 +259,27 @@ container:
     ]
 }
 --------------------------------------------------------------------------------
+
+=== Placeholders using window title matches don't swallow the window
+
+If you use the +title+ attribute to match a window and find that it doesn't
+work or only works sometimes, the reason might be that the application sets the
+title only after making the window visible. This will be especially true for
+programs running inside terminal emulators, e.g., +urxvt -e irssi+ when
+matching on +title: "irssi"+.
+
+One way to deal with this is to not rely on the title, but instead use, e.g.,
+the +instance+ attribute and running the program to set this window instance to
+that value:
+
+--------------------------------------------------------------------------------
+# Run irssi via
+# urxvt -name "irssi-container" -e irssi
+
+"swallows": [
+    {
+        "class": "URxvt",
+        "instance": "irssi-container"
+    }
+]
+--------------------------------------------------------------------------------
index 71c6a427862fb4b4a46c32f093923a25e21c2c63..795be0424fa477cf50d1e97b484881f37058d3c9 100644 (file)
@@ -82,6 +82,8 @@ The tests additionally require +Xephyr(1)+ to run a nested X server. Install
 $ cd ~/i3/testcases
 $ sudo apt-get install cpanminus
 $ sudo cpanm .
+$ cd ~/i3/AnyEvent-I3
+$ sudo cpanm .
 --------------------------------------------------------------------------------
 
 If you don’t want to use cpanminus for some reason, the same works with cpan:
@@ -90,6 +92,8 @@ If you don’t want to use cpanminus for some reason, the same works with cpan:
 --------------------------------------------------------------------------------
 $ cd ~/i3/testcases
 $ sudo cpan .
+$ cd ~/i3/AnyEvent-I3
+$ sudo cpan .
 --------------------------------------------------------------------------------
 
 In case you don’t have root permissions, you can also install into your home
@@ -112,9 +116,20 @@ 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.
 
-.Example invocation of complete-run.pl+
+.Example invocation of +complete-run.pl+
 ---------------------------------------
-$ cd ~/i3/testcases
+$ cd ~/i3
+
+$ autoreconf -fi
+
+$ mkdir -p build && cd build
+
+$ ../configure
+
+$ make -j8
+# output omitted because it is very long
+
+$ cd testcases
 
 $ ./complete-run.pl
 # output omitted because it is very long
@@ -160,6 +175,41 @@ $ ./complete-run.pl --parallel=1 --keep-xserver-output
 This will show the output of Xephyr, which is the X server implementation we
 use for testing.
 
+===== make command: +make check+
+Make check runs the i3 testsuite.
+You can still use ./testcases/complete-run.pl to get the interactive progress output.
+
+.Example invocation of +make check+
+---------------------------------------
+$ cd ~/i3
+
+$ autoreconf -fi
+
+$ mkdir -p build && cd build
+
+$ ../configure
+
+$ make -j8
+# output omitted because it is very long
+
+$ make check
+# output omitted because it is very long
+PASS: testcases/complete-run.pl
+============================================================================
+Testsuite summary for i3 4.13
+============================================================================
+# TOTAL: 1
+# PASS:  1
+# SKIP:  0
+# XFAIL: 0
+# FAIL:  0
+# XPASS: 0
+# ERROR: 0
+============================================================================
+
+$ less test-suite.log
+----------------------------------------
+
 ==== Coverage testing
 
 Coverage testing is possible with +lcov+, the front-end for GCC's coverage
index acdc0a587e1834854fb6aebf532388e8cfde8d92..0d5de3b9056c86eff0e483124825d27192588e6e 100644 (file)
@@ -297,6 +297,15 @@ keyboard layout. To start the wizard, use the command +i3-config-wizard+.
 Please note that you must not have +~/.i3/config+, otherwise the wizard will
 exit.
 
+Since i3 4.0, a new configuration format is used. i3 will try to automatically
+detect the format version of a config file based on a few different keywords,
+but if you want to make sure that your config is read with the new format,
+include the following line in your config file:
+
+---------------------
+# i3 config file (v4)
+---------------------
+
 === Comments
 
 It is possible and recommended to use comments in your configuration file to
@@ -412,9 +421,9 @@ button in the scope of the clicked container (see <<command_criteria>>). You
 can configure mouse bindings in a similar way to key bindings.
 
 *Syntax*:
--------------------------------------------------------------------------------
-bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
--------------------------------------------------------------------------------
+----------------------------------------------------------------------------------------------------
+bindsym [--release] [--border] [--whole-window] [--exclude-titlebar] [<Modifiers>+]button<n> command
+----------------------------------------------------------------------------------------------------
 
 By default, the binding will only run when you click on the titlebar of the
 window. If the +--release+ flag is given, it will run when the mouse button
@@ -424,6 +433,9 @@ If the +--whole-window+ flag is given, the binding will also run when any part
 of the window is clicked, with the exception of the border. To have a bind run
 when the border is clicked, specify the +--border+ flag.
 
+If the +--exclude-titlebar+ flag is given, the titlebar will not be considered
+for the keybinding.
+
 *Examples*:
 --------------------------------
 # The middle button over a titlebar kills the window
@@ -479,7 +491,7 @@ mode <name>
 
 *Example*:
 ------------------------------------------------------------------------
-# Press $mod+o followed by either f, t, Esc or Return to launch firefox,
+# Press $mod+o followed by either f, t, Escape or Return to launch firefox,
 # thunderbird or return to the default mode, respectively.
 set $mode_launcher Launch: [f]irefox [t]hunderbird
 bindsym $mod+o mode "$mode_launcher"
@@ -488,7 +500,7 @@ mode "$mode_launcher" {
     bindsym f exec firefox
     bindsym t exec thunderbird
 
-    bindsym Esc mode "default"
+    bindsym Escape mode "default"
     bindsym Return mode "default"
 }
 ------------------------------------------------------------------------
@@ -946,12 +958,12 @@ the next section.
 
 === Focus follows mouse
 
-By default, window focus follows your mouse movements. However, if you have a
-setup where your mouse usually is in your way (like a touchpad on your laptop
-which you do not want to disable completely), you might want to disable 'focus
-follows mouse' and control focus only by using your keyboard.  The mouse will
-still be useful inside the currently active window (for example to click on
-links in your browser window).
+By default, window focus follows your mouse movements as the mouse crosses
+window borders. However, if you have a setup where your mouse usually is in your
+way (like a touchpad on your laptop which you do not want to disable
+completely), you might want to disable 'focus follows mouse' and control focus
+only by using your keyboard.  The mouse will still be useful inside the
+currently active window (for example to click on links in your browser window).
 
 *Syntax*:
 --------------------------
@@ -1127,9 +1139,9 @@ none::
 [[show_marks]]
 === Drawing marks on window decoration
 
-If activated, marks on windows are drawn in their window decoration. However,
-any mark starting with an underscore in its name (+_+) will not be drawn even if
-this option is activated.
+If activated, marks (see <<vim_like_marks>>) on windows are drawn in their window
+decoration. However, any mark starting with an underscore in its name (+_+) will
+not be drawn even if this option is activated.
 
 The default for this option is +yes+.
 
@@ -1378,7 +1390,7 @@ directive multiple times.
 
 *Syntax*:
 ---------------
-output <output>
+output primary|<output>
 ---------------
 
 *Example*:
@@ -1400,7 +1412,19 @@ bar {
         statusline #ffffff
     }
 }
+
+# show bar on the primary monitor and on HDMI2
+bar {
+    output primary
+    output HDMI2
+    status_command i3status
+}
+
 -------------------------------
+Note that you might not have a primary output configured yet. To do so, run:
+-------------------------
+xrandr --output <output> --primary
+-------------------------
 
 === Tray output
 
@@ -1802,7 +1826,8 @@ The +toggle+ option will toggle the orientation of the split container if it
 contains a single window. Otherwise it makes the current window a split
 container with opposite orientation compared to the parent container.
 Use +layout toggle split+ to change the layout of any split container from
-splitv to splith or vice-versa.
+splitv to splith or vice-versa. You can also define a custom sequence of layouts
+to cycle through with +layout toggle+, see <<manipulating_layout>>.
 
 *Syntax*:
 --------------------------------
@@ -1822,6 +1847,11 @@ Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
 or +layout splith+ to change the current container layout to splith/splitv,
 stacking, tabbed layout, splitv or splith, respectively.
 
+Specify up to four layouts after +layout toggle+ to cycle through them. Every
+time the command is executed, the layout specified after the currently active
+one will be applied. If the currently active layout is not in the list, the
+first layout in the list will be activated.
+
 To make the current window (!) fullscreen, use +fullscreen enable+ (or
 +fullscreen enable global+ for the global mode), to leave either fullscreen
 mode use +fullscreen disable+, and to toggle between these two states use
@@ -1834,6 +1864,7 @@ enable+ respectively +floating disable+ (or +floating toggle+):
 --------------------------------------------
 layout default|tabbed|stacking|splitv|splith
 layout toggle [split|all]
+layout toggle [split|tabbed|stacking|splitv|splith] [split|tabbed|stacking|splitv|splith]…
 --------------------------------------------
 
 *Examples*:
@@ -1848,6 +1879,15 @@ bindsym $mod+x layout toggle
 # Toggle between stacking/tabbed/splith/splitv:
 bindsym $mod+x layout toggle all
 
+# Toggle between stacking/tabbed/splith:
+bindsym $mod+x layout toggle stacking tabbed splith
+
+# Toggle between splitv/tabbed
+bindsym $mod+x layout toggle splitv tabbed
+
+# Toggle between last split layout/tabbed/stacking
+bindsym $mod+x layout toggle split tabbed stacking
+
 # Toggle fullscreen
 bindsym $mod+f fullscreen toggle
 
@@ -1882,7 +1922,7 @@ output::
 ----------------------------------------------
 focus left|right|down|up
 focus parent|child|floating|tiling|mode_toggle
-focus output left|right|up|down|<output>
+focus output left|right|up|down|primary|<output>
 ----------------------------------------------
 
 *Examples*:
@@ -1904,8 +1944,17 @@ bindsym $mod+x focus output right
 
 # Focus the big output
 bindsym $mod+x focus output HDMI-2
+
+# Focus the primary output
+bindsym $mod+x focus output primary
 -------------------------------------------------
 
+-------------------------------
+Note that you might not have a primary output configured yet. To do so, run:
+-------------------------
+xrandr --output <output> --primary
+-------------------------
+
 === Moving containers
 
 Use the +move+ command to move a container.
@@ -1921,7 +1970,8 @@ move <left|right|down|up> [<px> px]
 # Moves the container either to a specific location
 # or to the center of the screen. If 'absolute' is
 # used, it is moved to the center of all outputs.
-move [absolute] position [[<px> px] [<px> px]|center]
+move [absolute] position <pos_x> [px] <pos_y> [px]
+move [absolute] position center
 
 # Moves the container to the current position of the
 # mouse cursor. Only affects floating containers.
@@ -1947,6 +1997,39 @@ bindsym $mod+c move absolute position center
 bindsym $mod+m move position mouse
 -------------------------------------------------------
 
+=== Swapping containers
+
+Two containers can be swapped (i.e., move to each other's position) by using
+the +swap+ command. They will assume the position and geometry of the container
+they are swapped with.
+
+The first container to participate in the swapping can be selected through the
+normal command criteria process with the focused window being the usual
+fallback if no criteria are specified. The second container can be selected
+using one of the following methods:
+
++id+:: The X11 window ID of a client window.
++con_id+:: The i3 container ID of a container.
++mark+:: A container with the specified mark, see <<vim_like_marks>>.
+
+Note that swapping does not work with all containers. Most notably, swapping
+floating containers or containers that have a parent-child relationship to one
+another does not work.
+
+*Syntax*:
+----------------------------------------
+swap container with id|con_id|mark <arg>
+----------------------------------------
+
+*Examples*:
+-----------------------------------------------------------------
+# Swaps the focused container with the container marked »swapee«.
+swap container with mark swapee
+
+# Swaps container marked »A« and »B«
+[con_mark="^A$"] swap container with mark B
+-----------------------------------------------------------------
+
 === Sticky floating windows
 
 If you want a window to stick to the glass, i.e., have it stay on screen even
@@ -2089,6 +2172,23 @@ i3-msg 'rename workspace to "2: mail"'
 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
 --------------------------------------------------------------------------
 
+If you want to rename workspaces on demand while keeping the navigation stable,
+you can use a setup like this:
+
+*Example*:
+-------------------------
+bindsym $mod+1 workspace number "1: www"
+bindsym $mod+2 workspace number "2: mail"
+...
+-------------------------
+
+If a workspace does not exist, the command +workspace number "1: mail"+ will
+create workspace "1: mail".
+
+If a workspace with number 1 does already exist, the command will switch to this
+workspace and ignore the text part. So even when the workspace has been renamed
+to "1: web", the above command will still switch to it.
+
 === Moving workspaces to a different screen
 
 See <<move_to_outputs>> for how to move a container/workspace to a different
@@ -2104,8 +2204,8 @@ To move a container to another RandR output (addressed by names like +LVDS1+ or
 
 *Syntax*:
 ------------------------------------------------------------
-move container to output left|right|down|up|current|<output>
-move workspace to output left|right|down|up|current|<output>
+move container to output left|right|down|up|current|primary|<output>
+move workspace to output left|right|down|up|current|primary|<output>
 ------------------------------------------------------------
 
 *Examples*:
@@ -2116,8 +2216,17 @@ bindsym $mod+x move workspace to output right
 
 # Put this window on the presentation output.
 bindsym $mod+x move container to output VGA1
+
+# Put this window on the primary output.
+bindsym $mod+x move container to output primary
 --------------------------------------------------------
 
+-------------------------------
+Note that you might not have a primary output configured yet. To do so, run:
+-------------------------
+xrandr --output <output> --primary
+-------------------------
+
 === Moving containers/windows to marks
 
 To move a container to another container with a specific mark (see <<vim_like_marks>>),
index 88d37e2613246dc64e3baece460c3bf0e9975d6f..47e90fc37d50ec48d9320988fa577d5fb1d09acc 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_13">1. Verify you are using i3 ≥ 4.13</h2>\r
+<h2 id="_verify_you_are_using_i3_4_14">1. Verify you are using i3 ≥ 4.14</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
index 791b6af2b5f9918807ba66cac49d0e93a37102c2..606fad646b1c4ae78fcb674757606e8a873f2e23 100644 (file)
@@ -240,14 +240,6 @@ src/config_parser.c) with the correct path, switching key bindings mode).
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-src/debug.c\r
-</dt>\r
-<dd>\r
-<p>\r
-Contains debugging functions to print unhandled X events.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
 src/ewmh.c\r
 </dt>\r
 <dd>\r
@@ -1529,6 +1521,75 @@ of the latest release, plus any bugfixes that were applied since that release.</
 on a new feature, use the “next” branch. If you are working on a bugfix, use the\r
 “next” branch, too, but make sure your code also works on “master”.</p></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_how_to_build">20.3. How to build?</h3>\r
+<div class="paragraph"><p>You can build i3 like you build any other software package which uses autotools.\r
+Here’s a memory refresher:</p></div>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>$ autoreconf -fi\r
+$ mkdir -p build &amp;&amp; cd build\r
+$ ../configure\r
+$ make -j8</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>(The autoreconf -fi step is unnecessary if you are building from a release tarball,\r
+ but shouldn’t hurt either.)</p></div>\r
+<div class="sect3">\r
+<h4 id="_build_system_features">20.3.1. Build system features</h4>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+We use the AX_ENABLE_BUILDDIR macro to enforce builds happening in a separate\r
+  directory. This is a prerequisite for the AX_EXTEND_SRCDIR macro and building\r
+  in a separate directory is common practice anyway. In case this causes any\r
+  trouble when packaging i3 for your distribution, please open an issue.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+“make check” runs the i3 testsuite. See docs/testsuite for details.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+“make distcheck” (runs testsuite on “make dist” result, tiny bit quicker\r
+  feedback cycle than waiting for the travis build to catch the issue).\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+“make uninstall” (occasionally requested by users who compile from source)\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+“make” will build manpages/docs by default if the tools are installed.\r
+  Conversely, manpages/docs are not tried to be built for users who don’t want\r
+  to install all these dependencies to get started hacking on i3.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+non-release builds will enable address sanitizer by default. Use the\r
+  --disable-sanitizers configure option to turn off all sanitizers, and see\r
+  --help for available sanitizers.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Support for pre-compiled headers (PCH) has been dropped for now in the\r
+  interest of simplicity. If you need support for PCH, please open an issue.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Coverage reports are now generated using “make check-code-coverage”, which\r
+  requires specifying --enable-code-coverage when calling configure.\r
+</p>\r
+</li>\r
+</ul></div>\r
+</div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
index 39f6182959aa8b4e95e8ae52e7dfb05daaaf683e..8780aed6288127da18d055d4189f1a0189456c85 100644 (file)
@@ -440,6 +440,14 @@ active (boolean)
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+primary (boolean)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Whether this output is currently the primary output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 current_workspace (string)\r
 </dt>\r
 <dd>\r
@@ -482,7 +490,7 @@ rect (map)
    "y": 0,\r
    "width": 1280,\r
    "height": 1024\r
-  },\r
+  }\r
  }\r
 ]</tt></pre>\r
 </div></div>\r
@@ -746,7 +754,7 @@ VGA1
          "y": 0,\r
          "width": 1280,\r
          "height": 0\r
-       },\r
+       }\r
       },\r
 \r
       {\r
@@ -1222,6 +1230,14 @@ binding (5)
         mouse\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+shutdown (6)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Sent when the ipc shuts down because of a restart or exit by user command\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 <div class="listingblock">\r
@@ -1246,9 +1262,9 @@ if ($is_event) {
 <h3 id="_workspace_event">4.3. workspace event</h3>\r
 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
 <tt>change (string)</tt> which indicates the type of the change ("focus", "init",\r
-"empty", "urgent"). A <tt>current (object)</tt> property will be present with the\r
-affected workspace whenever the type of event affects a workspace (otherwise,\r
-it will be +null).</p></div>\r
+"empty", "urgent", "reload", "rename", "restored", "move"). A\r
+<tt>current (object)</tt> property will be present with the affected workspace\r
+whenever the type of event affects a workspace (otherwise, it will be +null).</p></div>\r
 <div class="paragraph"><p>When the change is "focus", an <tt>old (object)</tt> property will be present with the\r
 previous workspace.  When the first switch occurs (when i3 focuses the\r
 workspace visible at the beginning) there is no previous workspace, and the\r
@@ -1378,7 +1394,7 @@ same as a <tt>GET_BAR_CONFIG</tt> reply for the bar with the given id.</p></div>
 <div class="sect2">\r
 <h3 id="_binding_event">4.8. binding event</h3>\r
 <div class="paragraph"><p>This event consists of a single serialized map reporting on the details of a\r
-binding that ran a command because of user input. The <tt>change (sring)</tt> field\r
+binding that ran a command because of user input. The <tt>change (string)</tt> field\r
 indicates what sort of binding event was triggered (right now it will always be\r
 <tt>"run"</tt> but may be expanded in the future).</p></div>\r
 <div class="paragraph"><p>The <tt>binding (object)</tt> field contains details about the binding that was run:</p></div>\r
@@ -1446,6 +1462,20 @@ input_type (string)
 }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_shutdown_event">4.9. shutdown event</h3>\r
+<div class="paragraph"><p>This event is triggered when the connection to the ipc is about to shutdown\r
+because of a user action such as a <tt>restart</tt> or <tt>exit</tt> command. The <tt>change\r
+(string)</tt> field indicates why the ipc is shutting down. It can be either\r
+<tt>"restart"</tt> or <tt>"exit"</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example:</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>{\r
+ "change": "restart"\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1491,7 +1521,7 @@ Go
 <div class="ulist"><ul>\r
 <li>\r
 <p>\r
-<a href="https://github.com/proxypoke/i3ipc">https://github.com/proxypoke/i3ipc</a>\r
+<a href="https://github.com/mdirkse/i3ipc-go">https://github.com/mdirkse/i3ipc-go</a>\r
 </p>\r
 </li>\r
 </ul></div>\r
@@ -1583,6 +1613,18 @@ Rust
 </li>\r
 </ul></div>\r
 </dd>\r
+<dt class="hdlist1">\r
+OCaml\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/Armael/ocaml-i3ipc">https://github.com/Armael/ocaml-i3ipc</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
index ed61533cc4694785162edc9e7ef31f07bcbdbd36..d699715cab1a1064e5598e3e3fc2d388034e3196 100644 (file)
@@ -301,6 +301,29 @@ container:</p></div>
 }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_placeholders_using_window_title_matches_don_8217_t_swallow_the_window">4.2. Placeholders using window title matches don&#8217;t swallow the window</h3>\r
+<div class="paragraph"><p>If you use the <tt>title</tt> attribute to match a window and find that it doesn&#8217;t\r
+work or only works sometimes, the reason might be that the application sets the\r
+title only after making the window visible. This will be especially true for\r
+programs running inside terminal emulators, e.g., <tt>urxvt -e irssi</tt> when\r
+matching on <tt>title: "irssi"</tt>.</p></div>\r
+<div class="paragraph"><p>One way to deal with this is to not rely on the title, but instead use, e.g.,\r
+the <tt>instance</tt> attribute and running the program to set this window instance to\r
+that value:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># Run irssi via\r
+# urxvt -name "irssi-container" -e irssi\r
+\r
+"swallows": [\r
+    {\r
+        "class": "URxvt",\r
+        "instance": "irssi-container"\r
+    }\r
+]</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 </div>\r
index 9fa9202743fd9881c9cc376bff7074c750c3e51f..35631251d65c3a92b012d9227bd312f6fa90106f 100644 (file)
@@ -146,6 +146,8 @@ used to install the testsuite. Many users prefer to use the more modern
 <div class="content">\r
 <pre><tt>$ cd ~/i3/testcases\r
 $ sudo apt-get install cpanminus\r
+$ sudo cpanm .\r
+$ cd ~/i3/AnyEvent-I3\r
 $ sudo cpanm .</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>If you don’t want to use cpanminus for some reason, the same works with cpan:</p></div>\r
@@ -153,6 +155,8 @@ $ sudo cpanm .</tt></pre>
 <div class="title">Installing testsuite dependencies using cpan</div>\r
 <div class="content">\r
 <pre><tt>$ cd ~/i3/testcases\r
+$ sudo cpan .\r
+$ cd ~/i3/AnyEvent-I3\r
 $ sudo cpan .</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>In case you don’t have root permissions, you can also install into your home\r
@@ -174,9 +178,20 @@ the tests without an X session with Xvfb, such as with <tt>xvfb-run
 ./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="listingblock">\r
-<div class="title">Example invocation of complete-run.pl+</div>\r
+<div class="title">Example invocation of <tt>complete-run.pl</tt></div>\r
 <div class="content">\r
-<pre><tt>$ cd ~/i3/testcases\r
+<pre><tt>$ cd ~/i3\r
+\r
+$ autoreconf -fi\r
+\r
+$ mkdir -p build &amp;&amp; cd build\r
+\r
+$ ../configure\r
+\r
+$ make -j8\r
+# output omitted because it is very long\r
+\r
+$ cd testcases\r
 \r
 $ ./complete-run.pl\r
 # output omitted because it is very long\r
@@ -219,6 +234,42 @@ $ less latest/i3-log-for-04-floating.t</tt></pre>
 </div></div>\r
 <div class="paragraph"><p>This will show the output of Xephyr, which is the X server implementation we\r
 use for testing.</p></div>\r
+<div class="sect4">\r
+<h5 id="_make_command_tt_make_check_tt">make command: <tt>make check</tt></h5>\r
+<div class="paragraph"><p>Make check runs the i3 testsuite.\r
+You can still use ./testcases/complete-run.pl to get the interactive progress output.</p></div>\r
+<div class="listingblock">\r
+<div class="title">Example invocation of <tt>make check</tt></div>\r
+<div class="content">\r
+<pre><tt>$ cd ~/i3\r
+\r
+$ autoreconf -fi\r
+\r
+$ mkdir -p build &amp;&amp; cd build\r
+\r
+$ ../configure\r
+\r
+$ make -j8\r
+# output omitted because it is very long\r
+\r
+$ make check\r
+# output omitted because it is very long\r
+PASS: testcases/complete-run.pl\r
+============================================================================\r
+Testsuite summary for i3 4.13\r
+============================================================================\r
+# TOTAL: 1\r
+# PASS:  1\r
+# SKIP:  0\r
+# XFAIL: 0\r
+# FAIL:  0\r
+# XPASS: 0\r
+# ERROR: 0\r
+============================================================================\r
+\r
+$ less test-suite.log</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 <div class="sect3">\r
 <h4 id="_coverage_testing">3.2.2. Coverage testing</h4>\r
index e6afdf28c94699e6d8b2c4eed91bd715a4057bab..7362e009e59589ead8d341ebbc791f070c22291d 100644 (file)
@@ -363,6 +363,14 @@ file. Also, the created config file will use the key symbols of your current
 keyboard layout. To start the wizard, use the command <tt>i3-config-wizard</tt>.\r
 Please note that you must not have <tt>~/.i3/config</tt>, otherwise the wizard will\r
 exit.</p></div>\r
+<div class="paragraph"><p>Since i3 4.0, a new configuration format is used. i3 will try to automatically\r
+detect the format version of a config file based on a few different keywords,\r
+but if you want to make sure that your config is read with the new format,\r
+include the following line in your config file:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># i3 config file (v4)</tt></pre>\r
+</div></div>\r
 <div class="sect2">\r
 <h3 id="_comments">4.1. Comments</h3>\r
 <div class="paragraph"><p>It is possible and recommended to use comments in your configuration file to\r
@@ -490,7 +498,7 @@ can configure mouse bindings in a similar way to key bindings.</p></div>
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>bindsym [--release] [--border] [--whole-window] [&lt;Modifiers&gt;+]button&lt;n&gt; command</tt></pre>\r
+<pre><tt>bindsym [--release] [--border] [--whole-window] [--exclude-titlebar] [&lt;Modifiers&gt;+]button&lt;n&gt; command</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>By default, the binding will only run when you click on the titlebar of the\r
 window. If the <tt>--release</tt> flag is given, it will run when the mouse button\r
@@ -498,6 +506,8 @@ is released.</p></div>
 <div class="paragraph"><p>If the <tt>--whole-window</tt> flag is given, the binding will also run when any part\r
 of the window is clicked, with the exception of the border. To have a bind run\r
 when the border is clicked, specify the <tt>--border</tt> flag.</p></div>\r
+<div class="paragraph"><p>If the <tt>--exclude-titlebar</tt> flag is given, the titlebar will not be considered\r
+for the keybinding.</p></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -549,7 +559,7 @@ mode &lt;name&gt;</tt></pre>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># Press $mod+o followed by either f, t, Esc or Return to launch firefox,\r
+<pre><tt># Press $mod+o followed by either f, t, Escape or Return to launch firefox,\r
 # thunderbird or return to the default mode, respectively.\r
 set $mode_launcher Launch: [f]irefox [t]hunderbird\r
 bindsym $mod+o mode "$mode_launcher"\r
@@ -558,7 +568,7 @@ mode "$mode_launcher" {
     bindsym f exec firefox\r
     bindsym t exec thunderbird\r
 \r
-    bindsym Esc mode "default"\r
+    bindsym Escape mode "default"\r
     bindsym Return mode "default"\r
 }</tt></pre>\r
 </div></div>\r
@@ -1018,12 +1028,12 @@ the next section.</p></div>
 </div>\r
 <div class="sect2">\r
 <h3 id="_focus_follows_mouse">4.21. Focus follows mouse</h3>\r
-<div class="paragraph"><p>By default, window focus follows your mouse movements. However, if you have a\r
-setup where your mouse usually is in your way (like a touchpad on your laptop\r
-which you do not want to disable completely), you might want to disable <em>focus\r
-follows mouse</em> and control focus only by using your keyboard.  The mouse will\r
-still be useful inside the currently active window (for example to click on\r
-links in your browser window).</p></div>\r
+<div class="paragraph"><p>By default, window focus follows your mouse movements as the mouse crosses\r
+window borders. However, if you have a setup where your mouse usually is in your\r
+way (like a touchpad on your laptop which you do not want to disable\r
+completely), you might want to disable <em>focus follows mouse</em> and control focus\r
+only by using your keyboard.  The mouse will still be useful inside the\r
+currently active window (for example to click on links in your browser window).</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -1226,9 +1236,9 @@ none
 </div>\r
 <div class="sect2">\r
 <h3 id="show_marks">4.29. Drawing marks on window decoration</h3>\r
-<div class="paragraph"><p>If activated, marks on windows are drawn in their window decoration. However,\r
-any mark starting with an underscore in its name (<tt>_</tt>) will not be drawn even if\r
-this option is activated.</p></div>\r
+<div class="paragraph"><p>If activated, marks (see <a href="#vim_like_marks">[vim_like_marks]</a>) on windows are drawn in their window\r
+decoration. However, any mark starting with an underscore in its name (<tt>_</tt>) will\r
+not be drawn even if this option is activated.</p></div>\r
 <div class="paragraph"><p>The default for this option is <tt>yes</tt>.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -1504,7 +1514,7 @@ directive multiple times.</p></div>
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>output &lt;output&gt;</tt></pre>\r
+<pre><tt>output primary|&lt;output&gt;</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -1525,8 +1535,20 @@ bar {
         background #000000\r
         statusline #ffffff\r
     }\r
+}\r
+\r
+# show bar on the primary monitor and on HDMI2\r
+bar {\r
+    output primary\r
+    output HDMI2\r
+    status_command i3status\r
 }</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>\r
 <div class="sect2">\r
 <h3 id="_tray_output">5.8. Tray output</h3>\r
@@ -2047,7 +2069,8 @@ The <tt>toggle</tt> option will toggle the orientation of the split container if
 contains a single window. Otherwise it makes the current window a split\r
 container with opposite orientation compared to the parent container.\r
 Use <tt>layout toggle split</tt> to change the layout of any split container from\r
-splitv to splith or vice-versa.</p></div>\r
+splitv to splith or vice-versa. You can also define a custom sequence of layouts\r
+to cycle through with <tt>layout toggle</tt>, see <a href="#manipulating_layout">[manipulating_layout]</a>.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -2066,6 +2089,10 @@ bindsym $mod+t split toggle</tt></pre>
 <div class="paragraph"><p>Use <tt>layout toggle split</tt>, <tt>layout stacking</tt>, <tt>layout tabbed</tt>, <tt>layout splitv</tt>\r
 or <tt>layout splith</tt> to change the current container layout to splith/splitv,\r
 stacking, tabbed layout, splitv or splith, respectively.</p></div>\r
+<div class="paragraph"><p>Specify up to four layouts after <tt>layout toggle</tt> to cycle through them. Every\r
+time the command is executed, the layout specified after the currently active\r
+one will be applied. If the currently active layout is not in the list, the\r
+first layout in the list will be activated.</p></div>\r
 <div class="paragraph"><p>To make the current window (!) fullscreen, use <tt>fullscreen enable</tt> (or\r
 <tt>fullscreen enable global</tt> for the global mode), to leave either fullscreen\r
 mode use <tt>fullscreen disable</tt>, and to toggle between these two states use\r
@@ -2076,7 +2103,8 @@ enable</tt> respectively <tt>floating disable</tt> (or <tt>floating toggle</tt>)
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>layout default|tabbed|stacking|splitv|splith\r
-layout toggle [split|all]</tt></pre>\r
+layout toggle [split|all]\r
+layout toggle [split|tabbed|stacking|splitv|splith] [split|tabbed|stacking|splitv|splith]…</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -2091,6 +2119,15 @@ bindsym $mod+x layout toggle
 # Toggle between stacking/tabbed/splith/splitv:\r
 bindsym $mod+x layout toggle all\r
 \r
+# Toggle between stacking/tabbed/splith:\r
+bindsym $mod+x layout toggle stacking tabbed splith\r
+\r
+# Toggle between splitv/tabbed\r
+bindsym $mod+x layout toggle splitv tabbed\r
+\r
+# Toggle between last split layout/tabbed/stacking\r
+bindsym $mod+x layout toggle split tabbed stacking\r
+\r
 # Toggle fullscreen\r
 bindsym $mod+f fullscreen toggle\r
 \r
@@ -2167,7 +2204,7 @@ output
 <div class="content">\r
 <pre><tt>focus left|right|down|up\r
 focus parent|child|floating|tiling|mode_toggle\r
-focus output left|right|up|down|&lt;output&gt;</tt></pre>\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
@@ -2188,52 +2225,93 @@ bindsym $mod+g focus mode_toggle
 bindsym $mod+x focus output right\r
 \r
 # Focus the big output\r
-bindsym $mod+x focus output HDMI-2</tt></pre>\r
+bindsym $mod+x focus output HDMI-2\r
+\r
+# Focus the primary output\r
+bindsym $mod+x focus output primary</tt></pre>\r
 </div></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_moving_containers">6.5. Moving containers</h3>\r
-<div class="paragraph"><p>Use the <tt>move</tt> command to move a container.</p></div>\r
-<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># Moves the container into the given direction.\r
+<pre><tt>Note that you might not have a primary output configured yet. To do so, run:</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\r
+\r
+Use the +move+ command to move a container.\r
+\r
+*Syntax*:</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p># Moves the container into the given direction.\r
 # The optional pixel argument specifies how far the\r
 # container should be moved if it is floating and\r
 # defaults to 10 pixels.\r
-move &lt;left|right|down|up&gt; [&lt;px&gt; px]\r
-\r
-# Moves the container either to a specific location\r
-# or to the center of the screen. If 'absolute' is\r
+move &lt;left|right|down|up&gt; [&lt;px&gt; px]</p></div>\r
+<div class="paragraph"><p># Moves the container either to a specific location\r
+# or to the center of the screen. If <em>absolute</em> is\r
 # used, it is moved to the center of all outputs.\r
-move [absolute] position [[&lt;px&gt; px] [&lt;px&gt; px]|center]\r
-\r
-# Moves the container to the current position of the\r
+move [absolute] position &lt;pos_x&gt; [px] &lt;pos_y&gt; [px]\r
+move [absolute] position center</p></div>\r
+<div class="paragraph"><p># Moves the container to the current position of the\r
 # mouse cursor. Only affects floating containers.\r
-move position mouse</tt></pre>\r
-</div></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+move position mouse</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># Move container to the left, bottom, top, right\r
+<pre><tt>*Examples*:</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p># Move container to the left, bottom, top, right\r
 bindsym $mod+j move left\r
 bindsym $mod+k move down\r
 bindsym $mod+l move up\r
-bindsym $mod+semicolon move right\r
-\r
-# Move container, but make floating containers\r
+bindsym $mod+semicolon move right</p></div>\r
+<div class="paragraph"><p># Move container, but make floating containers\r
 # move more than the default\r
-bindsym $mod+j move left 20 px\r
+bindsym $mod+j move left 20 px</p></div>\r
+<div class="paragraph"><p># Move floating container to the center of all outputs\r
+bindsym $mod+c move absolute position center</p></div>\r
+<div class="paragraph"><p># Move container to the current position of the cursor\r
+bindsym $mod+m move position mouse</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>=== Swapping containers\r
+\r
+Two containers can be swapped (i.e., move to each other's position) by using\r
+the +swap+ command. They will assume the position and geometry of the container\r
+they are swapped with.\r
+\r
+The first container to participate in the swapping can be selected through the\r
+normal command criteria process with the focused window being the usual\r
+fallback if no criteria are specified. The second container can be selected\r
+using one of the following methods:\r
 \r
-# Move floating container to the center of all outputs\r
-bindsym $mod+c move absolute position center\r
++id+:: The X11 window ID of a client window.\r
++con_id+:: The i3 container ID of a container.\r
++mark+:: A container with the specified mark, see &lt;&lt;vim_like_marks&gt;&gt;.\r
 \r
-# Move container to the current position of the cursor\r
-bindsym $mod+m move position mouse</tt></pre>\r
+Note that swapping does not work with all containers. Most notably, swapping\r
+floating containers or containers that have a parent-child relationship to one\r
+another does not work.\r
+\r
+*Syntax*:</tt></pre>\r
 </div></div>\r
 </div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_swap_container_with_id_con_id_mark_lt_arg_gt">7. swap container with id|con_id|mark &lt;arg&gt;</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># Swaps the focused container with the container marked »swapee«.\r
+swap container with mark swapee\r
+\r
+# Swaps container marked »A« and »B«\r
+[con_mark="^A$"] swap container with mark B</tt></pre>\r
+</div></div>\r
 <div class="sect2">\r
-<h3 id="_sticky_floating_windows">6.6. Sticky floating windows</h3>\r
+<h3 id="_sticky_floating_windows">7.1. Sticky floating windows</h3>\r
 <div class="paragraph"><p>If you want a window to stick to the glass, i.e., have it stay on screen even\r
 if you switch to another workspace, you can use the <tt>sticky</tt> command. For\r
 example, this can be useful for notepads, a media player or a video chat\r
@@ -2253,7 +2331,7 @@ for_window [instance=notepad] sticky enable</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_changing_named_workspaces_moving_to_workspaces">6.7. Changing (named) workspaces/moving to workspaces</h3>\r
+<h3 id="_changing_named_workspaces_moving_to_workspaces">7.2. 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. Pass the optional flag\r
 <tt>--no-auto-back-and-forth</tt> to disable <a href="#back_and_forth">[back_and_forth]</a> for this specific call\r
@@ -2313,7 +2391,7 @@ bindsym $mod+x move workspace to output right
 bindsym $mod+F1 [class="Firefox"] move workspace current</tt></pre>\r
 </div></div>\r
 <div class="sect3">\r
-<h4 id="_named_workspaces">6.7.1. Named workspaces</h4>\r
+<h4 id="_named_workspaces">7.2.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
@@ -2341,7 +2419,7 @@ dynamically. To combine both commands you can use <tt>workspace number 1: mail</
 specify a default name if there&#8217;s currently no workspace starting with a "1".</p></div>\r
 </div>\r
 <div class="sect3">\r
-<h4 id="_renaming_workspaces">6.7.2. Renaming workspaces</h4>\r
+<h4 id="_renaming_workspaces">7.2.2. Renaming workspaces</h4>\r
 <div class="paragraph"><p>You can rename workspaces. This might be useful to start with the default\r
 numbered workspaces, do your work, and rename the workspaces afterwards to\r
 reflect what’s actually on them. You can also omit the old name to rename\r
@@ -2362,23 +2440,37 @@ i3-msg 'rename workspace "1: www" to "10: www"'
 i3-msg 'rename workspace to "2: mail"'\r
 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '</tt></pre>\r
 </div></div>\r
+<div class="paragraph"><p>If you want to rename workspaces on demand while keeping the navigation stable,\r
+you can use a setup 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 number "1: www"\r
+bindsym $mod+2 workspace number "2: mail"\r
+...</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>If a workspace does not exist, the command <tt>workspace number "1: mail"</tt> will\r
+create workspace "1: mail".</p></div>\r
+<div class="paragraph"><p>If a workspace with number 1 does already exist, the command will switch to this\r
+workspace and ignore the text part. So even when the workspace has been renamed\r
+to "1: web", the above command will still switch to it.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_moving_workspaces_to_a_different_screen">6.8. Moving workspaces to a different screen</h3>\r
+<h3 id="_moving_workspaces_to_a_different_screen">7.3. Moving workspaces to a different screen</h3>\r
 <div class="paragraph"><p>See <a href="#move_to_outputs">[move_to_outputs]</a> for how to move a container/workspace to a different\r
 RandR output.</p></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_moving_containers_workspaces_to_randr_outputs">6.9. Moving containers/workspaces to RandR outputs</h3>\r
+<h3 id="_moving_containers_workspaces_to_randr_outputs">7.4. Moving containers/workspaces to RandR outputs</h3>\r
 <div class="paragraph"><p>To move a container to another RandR output (addressed by names like <tt>LVDS1</tt> or\r
 <tt>VGA1</tt>) or to a RandR output identified by a specific direction (like <tt>left</tt>,\r
 <tt>right</tt>, <tt>up</tt> or <tt>down</tt>), there are two commands:</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>move container to output left|right|down|up|current|&lt;output&gt;\r
-move workspace to output left|right|down|up|current|&lt;output&gt;</tt></pre>\r
+<pre><tt>move container to output left|right|down|up|current|primary|&lt;output&gt;\r
+move workspace to output left|right|down|up|current|primary|&lt;output&gt;</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -2388,30 +2480,43 @@ move workspace to output left|right|down|up|current|&lt;output&gt;</tt></pre>
 bindsym $mod+x move workspace to output right\r
 \r
 # Put this window on the presentation output.\r
-bindsym $mod+x move container to output VGA1</tt></pre>\r
+bindsym $mod+x move container to output VGA1\r
+\r
+# Put this window on the primary output.\r
+bindsym $mod+x move container to output primary</tt></pre>\r
 </div></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_moving_containers_windows_to_marks">6.10. 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.</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
+<pre><tt>Note that you might not have a primary output configured yet. To do so, run:</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
+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
+</div></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_move_window_container_to_mark_lt_mark_gt">8. 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">6.11. Resizing containers/windows</h3>\r
+<h3 id="resizingconfig">8.1. 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
@@ -2439,7 +2544,7 @@ context.</p></div>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_jumping_to_specific_windows">6.12. Jumping to specific windows</h3>\r
+<h3 id="_jumping_to_specific_windows">8.2. 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
@@ -2460,7 +2565,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">6.13. VIM-like marks (mark/goto)</h3>\r
+<h3 id="vim_like_marks">8.3. 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
@@ -2503,7 +2608,7 @@ unmark irssi
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="pango_markup">6.14. Window title format</h3>\r
+<h3 id="pango_markup">8.4. 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
@@ -2561,7 +2666,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">6.15. Changing border style</h3>\r
+<h3 id="_changing_border_style">8.5. 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
@@ -2590,7 +2695,7 @@ bindsym $mod+u border none</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="shmlog">6.16. Enabling shared memory logging</h3>\r
+<h3 id="shmlog">8.6. Enabling shared memory logging</h3>\r
 <div class="paragraph"><p>As described in <a href="http://i3wm.org/docs/debugging.html">http://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
@@ -2614,7 +2719,7 @@ i3-msg shmlog $((50*1024*1024))</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_enabling_debug_logging">6.17. Enabling debug logging</h3>\r
+<h3 id="_enabling_debug_logging">8.7. 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
@@ -2632,7 +2737,7 @@ bindsym $mod+x debuglog toggle</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_reloading_restarting_exiting">6.18. Reloading/Restarting/Exiting</h3>\r
+<h3 id="_reloading_restarting_exiting">8.8. 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
@@ -2647,7 +2752,7 @@ bindsym $mod+Shift+e exit</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_scratchpad">6.19. Scratchpad</h3>\r
+<h3 id="_scratchpad">8.9. 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
@@ -2682,7 +2787,7 @@ bindsym mod4+s [title="^Sup ::"] scratchpad show</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_nop">6.20. Nop</h3>\r
+<h3 id="_nop">8.10. 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
@@ -2702,7 +2807,7 @@ bindsym button2 nop</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_i3bar_control">6.21. i3bar control</h3>\r
+<h3 id="_i3bar_control">8.11. 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
@@ -2736,7 +2841,7 @@ bindsym $mod+Shift+b bar mode invisible bar-1</tt></pre>
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="multi_monitor">7. Multiple monitors</h2>\r
+<h2 id="multi_monitor">9. 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
@@ -2759,7 +2864,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">7.1. Configuring your monitors</h3>\r
+<h3 id="_configuring_your_monitors">9.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
@@ -2822,7 +2927,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">7.2. Interesting configuration for multi-monitor environments</h3>\r
+<h3 id="_interesting_configuration_for_multi_monitor_environments">9.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
@@ -2859,10 +2964,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">8. i3 and the rest of your software world</h2>\r
+<h2 id="_i3_and_the_rest_of_your_software_world">10. i3 and the rest of your software world</h2>\r
 <div class="sectionbody">\r
 <div class="sect2">\r
-<h3 id="_displaying_a_status_line">8.1. Displaying a status line</h3>\r
+<h3 id="_displaying_a_status_line">10.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
@@ -2879,14 +2984,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">8.2. Giving presentations (multi-monitor)</h3>\r
+<h3 id="presentations">10.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">8.2.1. Case 1: everybody gets the same output</h4>\r
+<h4 id="_case_1_everybody_gets_the_same_output">10.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
@@ -2899,7 +3004,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">8.2.2. Case 2: you can see more than your audience</h4>\r
+<h4 id="_case_2_you_can_see_more_than_your_audience">10.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