<head>\r
<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>i3: i3 User’s Guide</title>\r
<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
<ul id="nav">\r
<li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
<li><a href="/screenshots">Screens</a></li>\r
- <li><a href="https://faq.i3wm.org/">FAQ</a></li>\r
+ <li><a href="https://www.reddit.com/r/i3wm/">FAQ</a></li>\r
<li><a href="/contact">Contact</a></li>\r
<li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
</ul>\r
<div id="preamble">\r
<div class="sectionbody">\r
<div class="paragraph"><p>This document contains all the information you need to configure and use the i3\r
-window manager. If it does not, please check <a href="http://faq.i3wm.org/">http://faq.i3wm.org/</a> first, then\r
-contact us on IRC (preferred) or post your question(s) on the mailing list.</p></div>\r
+window manager. If it does not, please check <a href="https://www.reddit.com/r/i3wm/">https://www.reddit.com/r/i3wm/</a>\r
+first, then contact us on IRC (preferred) or post your question(s) on the\r
+mailing list.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
</span></p></div>\r
<div class="paragraph"><p>The red keys are the modifiers you need to press (by default), the blue keys\r
are your homerow.</p></div>\r
+<div class="paragraph"><p>Note that when starting i3 without a config file, i3-config-wizard will offer\r
+you to create a config file in which the key positions (!) match what you see\r
+in the image above, regardless of the keyboard layout you are using. If you\r
+prefer to use a config file where the key letters match what you are seeing\r
+above, just decline i3-config-wizard’s offer and base your config on\r
+<tt>/etc/i3/config</tt>.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<h2 id="_using_i3">2. Using i3</h2>\r
<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 (Mod1) by default, with the Windows\r
-key (Mod4) being a popular alternative.</p></div>\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
<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
-for this is $mod+Enter, that is Alt+Enter in the default configuration. By\r
-pressing $mod+Enter, a new terminal will be opened. It will fill the whole\r
-space available on your screen.</p></div>\r
+for this is <tt>$mod+Enter</tt>, that is Alt+Enter (<tt>Mod1+Enter</tt>) in the default\r
+configuration. By pressing <tt>$mod+Enter</tt>, a new terminal will be opened. It\r
+will fill the whole space available on your screen.</p></div>\r
<div class="paragraph"><p><span class="image">\r
<img src="single_terminal.png" alt="Single terminal" />\r
</span></p></div>\r
<div class="paragraph"><p>To move the focus between the two terminals, you can use the direction keys\r
which you may know from the editor <tt>vi</tt>. However, in i3, your homerow is used\r
for these keys (in <tt>vi</tt>, the keys are shifted to the left by one for\r
-compatibility with most keyboard layouts). Therefore, <tt>$mod+J</tt> is left, <tt>$mod+K</tt>\r
-is down, <tt>$mod+L</tt> is up and <tt>$mod+;</tt> is right. So, to switch between the\r
-terminals, use <tt>$mod+K</tt> or <tt>$mod+L</tt>. Of course, you can also use the arrow keys.</p></div>\r
+compatibility with most keyboard layouts). Therefore, <tt>$mod+j</tt> is left, <tt>$mod+k</tt>\r
+is down, <tt>$mod+l</tt> is up and <tt>$mod+;</tt> is right. So, to switch between the\r
+terminals, use <tt>$mod+k</tt> or <tt>$mod+l</tt>. Of course, you can also use the arrow keys.</p></div>\r
<div class="paragraph"><p>At the moment, your workspace is split (it contains two terminals) in a\r
specific direction (horizontal by default). Every window can be split\r
horizontally or vertically again, just like the workspace. The terminology is\r
<div class="sect2">\r
<h3 id="_closing_windows">2.5. Closing windows</h3>\r
<div class="paragraph"><p>If an application does not provide a mechanism for closing (most applications\r
-provide a menu, the escape key or a shortcut like <tt>Control+W</tt> to close), you\r
+provide a menu, the escape key or a shortcut like <tt>Control+w</tt> to close), you\r
can press <tt>$mod+Shift+q</tt> to kill a window. For applications which support\r
the WM_DELETE protocol, this will correctly close the application (saving\r
any modifications or doing other cleanup). If the application doesn’t support\r
<h3 id="_resizing">2.8. Resizing</h3>\r
<div class="paragraph"><p>The easiest way to resize a container is by using the mouse: Grab the border\r
and move it to the wanted size.</p></div>\r
-<div class="paragraph"><p>See <a href="#resizingconfig">[resizingconfig]</a> for how to configure i3 to be able to resize\r
-columns/rows with your keyboard.</p></div>\r
+<div class="paragraph"><p>You can also use <a href="#binding_modes">[binding_modes]</a> to define a mode for resizing via the\r
+keyboard. To see an example for this, look at the\r
+<a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a> provided\r
+by i3.</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_restarting_i3_inplace">2.9. Restarting i3 inplace</h3>\r
around. By grabbing the borders and moving them you can resize the window. You\r
can also do that by using the <a href="#floating_modifier">[floating_modifier]</a>. Another way to resize\r
floating windows using the mouse is to right-click on the titlebar and drag.</p></div>\r
-<div class="paragraph"><p>For resizing floating windows with your keyboard, see <a href="#resizingconfig">[resizingconfig]</a>.</p></div>\r
+<div class="paragraph"><p>For resizing floating windows with your keyboard, see the resizing binding mode\r
+provided by the i3 <a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a>.</p></div>\r
<div class="paragraph"><p>Floating windows are always on top of tiling windows.</p></div>\r
</div>\r
</div>\r
</div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_orientation_and_split_containers">3.2. Orientation and Split Containers</h3>\r
-<div class="paragraph"
id="OrientationSplit"><p>It is only natural to use so-called <tt>Split Containers</tt> in order to build a
\r+<h3 id="OrientationSplit">3.2. Orientation and Split Containers</h3>\r
+<div class="paragraph"><p>It is only natural to use so-called <tt>Split Containers</tt> in order to build a\r
layout when using a tree as data structure. In i3, every <tt>Container</tt> has an\r
orientation (horizontal, vertical or unspecified) and the orientation depends\r
on the layout the container is in (vertical for splitv and stacking, horizontal\r
you moved down is directly attached to the workspace and appears on the bottom\r
of the screen. A new (horizontal) container was created to accommodate the\r
other two terminal windows. You will notice this when switching to tabbed mode\r
-(for example). You would end up having one tab called "another container" and\r
-the other one being the terminal window you moved down.</p></div>\r
+(for example). You would end up having one tab with a representation of the split\r
+container (e.g., "H[urxvt firefox]") and the other one being the terminal window\r
+you moved down.</p></div>\r
</div>\r
</div>\r
</div>\r
with a text editor.</p></div>\r
<div class="paragraph"><p>On first start (and on all following starts, unless you have a configuration\r
file), i3 will offer you to create a configuration file. You can tell the\r
-wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config\r
+wizard to use either Alt (<tt>Mod1</tt>) or Windows (<tt>Mod4</tt>) as modifier in the config\r
file. Also, the created config file will use the key symbols of your current\r
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
<div class="listingblock">\r
<div class="content">\r
<pre><tt>font <X core font description>\r
-font pango:[family list] [style options] [size]</tt></pre>\r
+font pango:<family list> [<style options>] <size></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>bindsym [--release] [Modifiers+]keysym command\r
-bindcode [--release] [Modifiers+]keycode command</tt></pre>\r
+<pre><tt>bindsym [--release] [<Group>+][<Modifiers>+]<keysym> command\r
+bindcode [--release] [<Group>+][<Modifiers>+]<keycode> command</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
-Mode_switch\r
+Group1, Group2, Group3, Group4\r
</dt>\r
<dd>\r
<p>\r
-Unlike other window managers, i3 can use Mode_switch as a modifier. This allows\r
-you to remap capslock (for example) to Mode_switch and use it for both: typing\r
-umlauts or special characters <em>and</em> having some comfortably reachable key\r
-bindings. For example, when typing, capslock+1 or capslock+2 for switching\r
-workspaces is totally convenient. Try it :-).\r
+When using multiple keyboard layouts (e.g. with <tt>setxkbmap -layout us,ru</tt>), you\r
+can specify in which XKB group (also called “layout”) a keybinding should be\r
+active. By default, keybindings are translated in Group1 and are active in all\r
+groups. If you want to override keybindings in one of your layouts, specify the\r
+corresponding group. For backwards compatibility, the group “Mode_switch” is an\r
+alias for Group2.\r
</p>\r
</dd>\r
</dl></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>bindsym [--release] [--whole-window] [Modifiers+]button[n] command</tt></pre>\r
+<pre><tt>bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> 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>--whole-window</tt> flag is given, it will run when any part of the\r
-window is clicked. If the <tt>--release</tt> flag is given, it will run when the mouse\r
-button is released.</p></div>\r
+window. If the <tt>--release</tt> flag is given, it will run when the mouse button\r
+is released.</p></div>\r
+<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><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="floating_modifier">4.5. The floating modifier</h3>\r
+<h3 id="binding_modes">4.5. Binding modes</h3>\r
+<div class="paragraph"><p>You can have multiple sets of bindings by using different binding modes. When\r
+you switch to another binding mode, all bindings from the current mode are\r
+released and only the bindings defined in the new mode are valid for as long as\r
+you stay in that binding mode. The only predefined binding mode is <tt>default</tt>,\r
+which is the mode i3 starts out with and to which all bindings not defined in a\r
+specific binding mode belong.</p></div>\r
+<div class="paragraph"><p>Working with binding modes consists of two parts: defining a binding mode and\r
+switching to it. For these purposes, there are one config directive and one\r
+command, both of which are called <tt>mode</tt>. The directive is used to define the\r
+bindings belonging to a certain binding mode, while the command will switch to\r
+the specified mode.</p></div>\r
+<div class="paragraph"><p>It is recommended to use binding modes in combination with <a href="#variables">[variables]</a> in\r
+order to make maintenance easier. Below is an example of how to use a binding\r
+mode.</p></div>\r
+<div class="paragraph"><p>Note that it is advisable to define bindings for switching back to the default\r
+mode.</p></div>\r
+<div class="paragraph"><p>Note that it is possible to use <a href="#pango_markup">[pango_markup]</a> for binding modes, but you\r
+need to enable it explicitly by passing the <tt>--pango_markup</tt> flag to the mode\r
+definition.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># config directive\r
+mode [--pango_markup] <name>\r
+\r
+# command\r
+mode <name></tt></pre>\r
+</div></div>\r
+<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
+# 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
+\r
+mode "$mode_launcher" {\r
+ bindsym f exec firefox\r
+ bindsym t exec thunderbird\r
+\r
+ bindsym Esc mode "default"\r
+ bindsym Return mode "default"\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<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
click anywhere in the window itself to move it. The most common setup is to\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>floating_modifier <Modifiers></tt></pre>\r
+<pre><tt>floating_modifier <Modifier></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_constraining_floating_window_size">4.6. Constraining floating window size</h3>\r
+<h3 id="_constraining_floating_window_size">4.7. Constraining floating window size</h3>\r
<div class="paragraph"><p>The maximum and minimum dimensions of floating windows can be specified. If\r
either dimension of <tt>floating_maximum_size</tt> is specified as -1, that dimension\r
will be unconstrained with respect to its maximum value. If either dimension of\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_orientation_for_new_workspaces">4.7. Orientation for new workspaces</h3>\r
+<h3 id="_orientation_for_new_workspaces">4.8. Orientation for new workspaces</h3>\r
<div class="paragraph"><p>New workspaces get a reasonable default orientation: Wide-screen monitors\r
(anything wider than high) get horizontal orientation, rotated monitors\r
(anything higher than wide) get vertical orientation.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>default_orientation <horizontal|vertical|auto></tt></pre>\r
+<pre><tt>default_orientation horizontal|vertical|auto</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_layout_mode_for_new_containers">4.8. Layout mode for new containers</h3>\r
+<h3 id="_layout_mode_for_new_containers">4.9. Layout mode for new containers</h3>\r
<div class="paragraph"><p>This option determines in which mode new containers on workspace level will\r
start.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace_layout <default|stacking|tabbed></tt></pre>\r
+<pre><tt>workspace_layout default|stacking|tabbed</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_border_style_for_new_windows">4.9. Border style for new windows</h3>\r
+<h3 id="_border_style_for_new_windows">4.10. 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
-"normal". Note that new_float applies only to windows which are starting out as\r
-floating windows, e.g. dialog windows.</p></div>\r
+<tt>normal</tt>. Note that new_float 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|1pixel|none|pixel>\r
-new_float <normal|1pixel|none|pixel></tt></pre>\r
+<pre><tt>new_window normal|none|pixel\r
+new_window normal|pixel <px>\r
+new_float normal|none|pixel\r
+new_float normal|pixel <px></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>new_window 1pixel</tt></pre>\r
+<pre><tt>new_window 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_hiding_vertical_borders">4.10. Hiding vertical borders</h3>\r
-<div class="paragraph"><p>You can hide vertical borders adjacent to the screen edges using\r
+<h3 id="_hiding_vertical_borders">4.11. Hiding borders adjacent to the screen edges</h3>\r
+<div class="paragraph"><p>You can hide container borders adjacent to the screen edges using\r
<tt>hide_edge_borders</tt>. This is useful if you are using scrollbars, or do not want\r
-to waste even two pixels in displayspace. Default is none.</p></div>\r
+to waste even two pixels in displayspace. The "smart" setting hides borders on\r
+workspaces with only one window visible, but keeps them on workspaces with\r
+multiple windows visible. Default is none.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>hide_edge_borders <none|vertical|horizontal|both></tt></pre>\r
+<pre><tt>hide_edge_borders none|vertical|horizontal|both|smart</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_arbitrary_commands_for_specific_windows_for_window">4.11. Arbitrary commands for specific windows (for_window)</h3>\r
+<h3 id="for_window">4.12. Arbitrary commands for specific windows (for_window)</h3>\r
<div class="paragraph"><p>With the <tt>for_window</tt> command, you can let i3 execute any command when it\r
encounters a specific window. This can be used to set windows to floating or to\r
change their border style, for example.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>for_window <criteria> command</tt></pre>\r
+<pre><tt>for_window <criteria> <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
for_window [class="XTerm"] floating enable\r
\r
# Make all urxvts use a 1-pixel border:\r
-for_window [class="urxvt"] border 1pixel\r
+for_window [class="urxvt"] border pixel 1\r
\r
# A less useful, but rather funny example:\r
# makes the window floating as soon as I change\r
<div class="paragraph"><p>The valid criteria are the same as those for commands, see <a href="#command_criteria">[command_criteria]</a>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_variables">4.12. Variables</h3>\r
+<h3 id="no_focus">4.13. Don’t focus window upon opening</h3>\r
+<div class="paragraph"><p>When a new window appears, it will be focused. The <tt>no_focus</tt> directive allows preventing\r
+this from happening and must be used in combination with <a href="#command_criteria">[command_criteria]</a>.</p></div>\r
+<div class="paragraph"><p>Note that this does not apply to all cases, e.g., when feeding data into a running application\r
+causing it to request being focused. To configure the behavior in such cases, refer to\r
+<a href="#focus_on_window_activation">[focus_on_window_activation]</a>.</p></div>\r
+<div class="paragraph"><p><tt>no_focus</tt> will also be ignored for the first window on a workspace as there shouldn’t be\r
+a reason to not focus the window in this case. This allows for better usability in\r
+combination with <tt>workspace_layout</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>no_focus <criteria></tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>no_focus [window_role="pop-up"]</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="variables">4.14. Variables</h3>\r
<div class="paragraph"><p>As you learned in the section about keyboard bindings, you will have\r
to configure lots of bindings containing modifier keys. If you want to save\r
yourself some typing and be able to change the modifier you use later,\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>set $name value</tt></pre>\r
+<pre><tt>set $<name> <value></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
absolutely no plans to change this. If you need a more dynamic configuration\r
you should create a little script which generates a configuration file and run\r
it before starting i3 (for example in your <tt>~/.xsession</tt> file).</p></div>\r
+<div class="paragraph"><p>Also see <a href="#xresources">[xresources]</a> to learn how to create variables based on resources\r
+loaded from the X resource database.</p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="xresources">4.15. X resources</h3>\r
+<div class="paragraph"><p><a href="#variables">[variables]</a> can also be created using a value configured in the X resource\r
+database. This is useful, for example, to avoid configuring color values within\r
+the i3 configuration. Instead, the values can be configured, once, in the X\r
+resource database to achieve an easily maintainable, consistent color theme\r
+across many X applications.</p></div>\r
+<div class="paragraph"><p>Defining a resource will load this resource from the resource database and\r
+assign its value to the specified variable. A fallback must be specified in\r
+case the resource cannot be loaded from the database.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>set_from_resource $<name> <resource_name> <fallback></tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># The ~/.Xresources should contain a line such as\r
+# *color0: #121212\r
+# and must be loaded properly, e.g., by using\r
+# xrdb ~/.Xresources\r
+# This value is picked up on by other applications (e.g., the URxvt terminal\r
+# emulator) and can be used in i3 like this:\r
+set_from_resource $black i3wm.color0 #000000</tt></pre>\r
+</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_putting_clients_on_specific_workspaces">4.13. Automatically putting clients on specific workspaces</h3>\r
-<div class="paragraph"
id="assign_workspace"><p>To automatically make a specific window show up on a specific workspace, you
\r+<h3 id="assign_workspace">4.16. Automatically putting clients on specific workspaces</h3>\r
+<div class="paragraph"><p>To automatically make a specific window show up on a specific workspace, you\r
can use an <strong>assignment</strong>. You can match windows by using any criteria,\r
see <a href="#command_criteria">[command_criteria]</a>. It is recommended that you match on window classes\r
(and instances, when appropriate) instead of window titles whenever possible\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>assign <criteria> [→] workspace</tt></pre>\r
+<pre><tt>assign <criteria> [→] [workspace] <workspace></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_starting_applications_on_i3_startup">4.14. Automatically starting applications on i3 startup</h3>\r
+<h3 id="_automatically_starting_applications_on_i3_startup">4.17. Automatically starting applications on i3 startup</h3>\r
<div class="paragraph"><p>By using the <tt>exec</tt> keyword outside a keybinding, you can configure\r
which commands will be performed by i3 on initial startup. <tt>exec</tt>\r
commands will not run when restarting i3, if you need a command to run\r
also when restarting i3 you should use the <tt>exec_always</tt>\r
keyword. These commands will be run in order.</p></div>\r
+<div class="paragraph"><p>See <a href="#command_chaining">[command_chaining]</a> for details on the special meaning of <tt>;</tt> (semicolon)\r
+and <tt>,</tt> (comma): they chain commands together in i3, so you need to use quoted\r
+strings (as shown in <a href="#exec_quoting">[exec_quoting]</a>) if they appear in your command.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>exec [--no-startup-id] command\r
-exec_always [--no-startup-id] command</tt></pre>\r
+<pre><tt>exec [--no-startup-id] <command>\r
+exec_always [--no-startup-id] <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="paragraph"><p>The flag --no-startup-id is explained in <a href="#exec">[exec]</a>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="workspace_screen">4.15. Automatically putting workspaces on specific screens</h3>\r
+<h3 id="workspace_screen">4.18. Automatically putting workspaces on specific screens</h3>\r
<div class="paragraph"><p>If you assign clients to workspaces, it might be handy to put the\r
workspaces on specific screens. Also, the assignment of workspaces to screens\r
will determine which workspace i3 uses for a new screen when adding screens\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_colors">4.16. Changing colors</h3>\r
+<h3 id="_changing_colors">4.19. Changing colors</h3>\r
<div class="paragraph"><p>You can change all colors which i3 uses to draw the window decorations.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>colorclass border background text indicator</tt></pre>\r
+<pre><tt><colorclass> <border> <background> <text> <indicator> <child_border></tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Where colorclass can be one of:</p></div>\r
<div class="dlist"><dl>\r
(when restoring layouts). Border and indicator are ignored.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+client.background\r
+</dt>\r
+<dd>\r
+<p>\r
+ Background color which will be used to paint the background of the\r
+ client window on top of which the client will be rendered. Only clients\r
+ which do not cover the whole area of this window expose the color. Note\r
+ that this colorclass only takes a single color.\r
+</p>\r
+</dd>\r
</dl></div>\r
-<div class="paragraph"><p>You can also specify the color to be used to paint the background of the client\r
-windows. This color will be used to paint the window on top of which the client\r
-will be rendered.</p></div>\r
-<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>client.background color</tt></pre>\r
-</div></div>\r
-<div class="paragraph"><p>Only clients that do not cover the whole area of this window expose the color\r
-used to paint it.</p></div>\r
<div class="paragraph"><p>Colors are in HTML hex format (#rrggbb), see the following example:</p></div>\r
<div class="paragraph"><p><strong>Examples (default colors)</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt># class border backgr. text indicator\r
-client.focused #4c7899 #285577 #ffffff #2e9ef4\r
-client.focused_inactive #333333 #5f676a #ffffff #484e50\r
-client.unfocused #333333 #222222 #888888 #292d2e\r
-client.urgent #2f343a #900000 #ffffff #900000\r
-client.placeholder #000000 #0c0c0c #ffffff #000000</tt></pre>\r
+<pre><tt># class border backgr. text indicator child_border\r
+client.focused #4c7899 #285577 #ffffff #2e9ef4 #285577\r
+client.focused_inactive #333333 #5f676a #ffffff #484e50 #5f676a\r
+client.unfocused #333333 #222222 #888888 #292d2e #222222\r
+client.urgent #2f343a #900000 #ffffff #900000 #900000\r
+client.placeholder #000000 #0c0c0c #ffffff #000000 #0c0c0c\r
+\r
+client.background #ffffff</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Note that for the window decorations, the color around the child window is the\r
-background color, and the border color is only the two thin lines at the top of\r
-the window.</p></div>\r
+"child_border", and "border" color is only the two thin lines around the\r
+titlebar.</p></div>\r
<div class="paragraph"><p>The indicator color is used for indicating where a new window will be opened.\r
For horizontal split containers, the right border will be painted in indicator\r
color, for vertical split containers, the bottom border. This only applies to\r
from single windows outside of a split container.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_interprocess_communication">4.17. Interprocess communication</h3>\r
+<h3 id="_interprocess_communication">4.20. Interprocess communication</h3>\r
<div class="paragraph"><p>i3 uses Unix sockets to provide an IPC interface. This allows third-party\r
programs to get information from i3, such as the current workspaces\r
(to display a workspace bar), and to control i3.</p></div>\r
the next section.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focus_follows_mouse">4.18. Focus follows mouse</h3>\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
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>focus_follows_mouse <yes|no></tt></pre>\r
+<pre><tt>focus_follows_mouse yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_mouse_warping">4.19. Mouse warping</h3>\r
+<h3 id="_mouse_warping">4.22. Mouse warping</h3>\r
<div class="paragraph"><p>By default, when switching focus to a window on a different output (e.g.\r
focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on\r
LVDS-1), the mouse cursor is warped to the center of that window.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>mouse_warping <output|none></tt></pre>\r
+<pre><tt>mouse_warping output|none</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_popups_during_fullscreen_mode">4.20. Popups during fullscreen mode</h3>\r
+<h3 id="_popups_during_fullscreen_mode">4.23. Popups during fullscreen mode</h3>\r
<div class="paragraph"><p>When you are in fullscreen mode, some applications still open popup windows\r
(take Xpdf for example). This is because these applications may not be aware\r
that they are in fullscreen mode (they do not check the corresponding hint).\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>popup_during_fullscreen <smart|ignore|leave_fullscreen></tt></pre>\r
+<pre><tt>popup_during_fullscreen smart|ignore|leave_fullscreen</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focus_wrapping">4.21. Focus wrapping</h3>\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 — the focus wraps. If\r
however there is another stacked/tabbed container in that direction, focus will\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>force_focus_wrapping yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_forcing_xinerama">4.22. Forcing Xinerama</h3>\r
+<h3 id="_forcing_xinerama">4.25. Forcing Xinerama</h3>\r
<div class="paragraph"><p>As explained in-depth in <a href="http://i3wm.org/docs/multi-monitor.html">http://i3wm.org/docs/multi-monitor.html</a>, some X11\r
video drivers (especially the nVidia binary driver) only provide support for\r
Xinerama instead of RandR. In such a situation, i3 must be told to use the\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>force_xinerama <yes|no></tt></pre>\r
+<pre><tt>force_xinerama yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
Xinerama, instead they are counted up, starting at 0: <tt>xinerama-0</tt>, <tt>xinerama-1</tt>, …</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatic_back_and_forth_when_switching_to_the_current_workspace">4.23. Automatic back-and-forth when switching to the current workspace</h3>\r
+<h3 id="_automatic_back_and_forth_when_switching_to_the_current_workspace">4.26. Automatic back-and-forth when switching to the current workspace</h3>\r
<div class="paragraph"><p>This configuration directive enables automatic <tt>workspace back_and_forth</tt> (see\r
<a href="#back_and_forth">[back_and_forth]</a>) when switching to the workspace that is currently focused.</p></div>\r
<div class="paragraph"><p>For instance: Assume you are on workspace "1: www" and switch to "2: IM" using\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace_auto_back_and_forth <yes|no></tt></pre>\r
+<pre><tt>workspace_auto_back_and_forth yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.24. Delaying urgency hint reset on workspace change</h3>\r
+<h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.27. Delaying urgency hint reset on workspace change</h3>\r
<div class="paragraph"><p>If an application on another workspace sets an urgency hint, switching to this\r
workspace may lead to immediate focus of the application, which also means the\r
window decoration color would be immediately reset to <tt>client.focused</tt>. This\r
<pre><tt>force_display_urgency_hint 500 ms</tt></pre>\r
</div></div>\r
</div>\r
+<div class="sect2">\r
+<h3 id="focus_on_window_activation">4.28. Focus on window activation</h3>\r
+<div class="paragraph"><p>If a window is activated, e.g., via <tt>google-chrome www.google.com</tt>, it may request\r
+to take focus. Since this may not preferable, different reactions can be configured.</p></div>\r
+<div class="paragraph"><p>Note that this may not affect windows that are being opened. To prevent new windows\r
+from being focused, see <a href="#no_focus">[no_focus]</a>.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>focus_on_window_activation smart|urgent|focus|none</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>The different modes will act as follows:</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+smart\r
+</dt>\r
+<dd>\r
+<p>\r
+ This is the default behavior. If the window requesting focus is on an active\r
+ workspace, it will receive the focus. Otherwise, the urgency hint will be set.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+urgent\r
+</dt>\r
+<dd>\r
+<p>\r
+ The window will always be marked urgent, but the focus will not be stolen.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focus\r
+</dt>\r
+<dd>\r
+<p>\r
+ The window will always be focused and not be marked urgent.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+none\r
+</dt>\r
+<dd>\r
+<p>\r
+ The window will neither be focused, nor be marked urgent.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</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>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
+<div class="content">\r
+<pre><tt>show_marks yes|no</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>show_marks yes</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="line_continuation">4.30. Line continuation</h3>\r
+<div class="paragraph"><p>Config files support line continuation, meaning when you end a line in a\r
+backslash character (<tt>\</tt>), the line-break will be ignored by the parser. This\r
+feature can be used to create more readable configuration files.\r
+Commented lines are not continued.</p></div>\r
+<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym Mod1+f \\r
+fullscreen toggle\r
+\r
+# this line is not continued \\r
+bindsym Mod1+F fullscreen toggle</tt></pre>\r
+</div></div>\r
+</div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>i3bar_command command</tt></pre>\r
+<pre><tt>i3bar_command <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
right hand side of the bar. This is useful to display system information like\r
your current IP address, battery status or date/time.</p></div>\r
<div class="paragraph"><p>The specified command will be passed to <tt>sh -c</tt>, so you can use globbing and\r
-have to have correct quoting etc.</p></div>\r
+have to have correct quoting etc. Note that for signal handling, depending on\r
+your shell (users of dash(1) are known to be affected), you have to use the\r
+shell’s exec command so that signals are passed to your program, not to the\r
+shell.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>status_command command</tt></pre>\r
+<pre><tt>status_command <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>bar {\r
status_command i3status --config ~/.i3status.conf\r
+\r
+ # For dash(1) users who want signal handling to work:\r
+ status_command exec ~/.bin/my_status_command\r
}</tt></pre>\r
</div></div>\r
</div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>mode <dock|hide|invisible>\r
-hidden_state <hide|show>\r
-modifier <Modifier></tt></pre>\r
+<pre><tt>mode dock|hide|invisible\r
+hidden_state hide|show\r
+modifier <Modifier>|none</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
modifier Mod1\r
}</tt></pre>\r
</div></div>\r
-<div class="paragraph"><p>Available modifiers are Mod1-Mod5, Shift, Control (see <tt>xmodmap(1)</tt>).</p></div>\r
+<div class="paragraph"><p>Available modifiers are Mod1-Mod5, Shift, Control (see <tt>xmodmap(1)</tt>). You can\r
+also use "none" if you don’t want any modifier to trigger this behavior.</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_mouse_button_commands">5.4. Mouse button commands</h3>\r
<div class="paragraph"><p>Specifies a command to run when a button was pressed on i3bar to override the\r
-default behavior. Currently only the mouse wheel buttons are supported. This is\r
-useful for disabling the scroll wheel action or running scripts that implement\r
-custom behavior for these buttons.</p></div>\r
+default behavior. This is useful, e.g., for disabling the scroll wheel action\r
+or running scripts that implement custom behavior for these buttons.</p></div>\r
+<div class="paragraph"><p>A button is always named <tt>button<n></tt>, where 1 to 5 are default buttons as follows and higher\r
+numbers can be special buttons on devices offering more buttons:</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+button1\r
+</dt>\r
+<dd>\r
+<p>\r
+ Left mouse button.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+button2\r
+</dt>\r
+<dd>\r
+<p>\r
+ Middle mouse button.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+button3\r
+</dt>\r
+<dd>\r
+<p>\r
+ Right mouse button.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+button4\r
+</dt>\r
+<dd>\r
+<p>\r
+ Scroll wheel up.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+button5\r
+</dt>\r
+<dd>\r
+<p>\r
+ Scroll wheel down.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+<div class="paragraph"><p>Please note that the old <tt>wheel_up_cmd</tt> and <tt>wheel_down_cmd</tt> commands are deprecated\r
+and will be removed in a future release. We strongly recommend using the more general\r
+<tt>bindsym</tt> with <tt>button4</tt> and <tt>button5</tt> instead.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>wheel_up_cmd <command>\r
-wheel_down_cmd <command></tt></pre>\r
+<pre><tt>bindsym button<n> <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>bar {\r
- wheel_up_cmd nop\r
- wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down\r
+ # disable clicking on workspace buttons\r
+ bindsym button1 nop\r
+ # execute custom script when scrolling downwards\r
+ bindsym button5 exec ~/.i3/scripts/custom_wheel_down\r
}</tt></pre>\r
</div></div>\r
</div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>position <top|bottom></tt></pre>\r
+<pre><tt>position top|bottom</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
NetworkManager, VLC, Pidgin, etc. can place little icons.</p></div>\r
<div class="paragraph"><p>You can configure on which output (monitor) the icons should be displayed or\r
you can turn off the functionality entirely.</p></div>\r
+<div class="paragraph"><p>You can use multiple <tt>tray_output</tt> directives in your config to specify a list\r
+of outputs on which you want the tray to appear. The first available output in\r
+that list as defined by the order of the directives will be used for the tray\r
+output.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>tray_output <none|primary|output></tt></pre>\r
+<pre><tt>tray_output none|primary|<output></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
}\r
\r
# show tray icons on the primary monitor\r
-tray_output primary\r
+bar {\r
+ tray_output primary\r
+}\r
\r
# show tray icons on the big monitor\r
bar {\r
<div class="content">\r
<pre><tt>xrandr --output <output> --primary</tt></pre>\r
</div></div>\r
+<div class="paragraph"><p>Note that when you use multiple bar configuration blocks, either specify\r
+<tt>tray_output primary</tt> in all of them or explicitly specify <tt>tray_output none</tt>\r
+in bars which should not display the tray, otherwise the different instances\r
+might race each other in trying to display tray icons.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_font">5.9. Font</h3>\r
+<h3 id="_tray_padding">5.9. Tray padding</h3>\r
+<div class="paragraph"><p>The tray is shown on the right-hand side of the bar. By default, a padding of 2\r
+pixels is used for the upper, lower and right-hand side of the tray area and\r
+between the individual icons.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>tray_padding <px> [px]</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># Obey Fitts's law\r
+tray_padding 0</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_font">5.10. Font</h3>\r
<div class="paragraph"><p>Specifies the font to be used in the bar. See <a href="#fonts">[fonts]</a>.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_custom_separator_symbol">5.10. Custom separator symbol</h3>\r
+<h3 id="_custom_separator_symbol">5.11. Custom separator symbol</h3>\r
<div class="paragraph"><p>Specifies a custom symbol to be used for the separator as opposed to the vertical,\r
one pixel thick separator.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_workspace_buttons">5.11. Workspace buttons</h3>\r
+<h3 id="_workspace_buttons">5.12. Workspace buttons</h3>\r
<div class="paragraph"><p>Specifies whether workspace buttons should be shown or not. This is useful if\r
you want to display a statusline-only bar containing additional information.</p></div>\r
<div class="paragraph"><p>The default is to show workspace buttons.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace_buttons <yes|no></tt></pre>\r
+<pre><tt>workspace_buttons yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_strip_workspace_numbers">5.12. Strip workspace numbers</h3>\r
+<h3 id="_strip_workspace_numbers">5.13. Strip workspace numbers</h3>\r
<div class="paragraph"><p>Specifies whether workspace numbers should be displayed within the workspace\r
buttons. This is useful if you want to have a named workspace that stays in\r
order on the bar according to its number without displaying the number prefix.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>strip_workspace_numbers <yes|no></tt></pre>\r
+<pre><tt>strip_workspace_numbers yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_binding_mode_indicator">5.13. Binding Mode indicator</h3>\r
+<h3 id="_binding_mode_indicator">5.14. Binding Mode indicator</h3>\r
<div class="paragraph"><p>Specifies whether the current binding mode indicator should be shown or not.\r
This is useful if you want to hide the workspace buttons but still be able\r
-to see the current binding mode indicator.\r
-For an example of a <tt>mode</tt> definition, see <a href="#resizingconfig">[resizingconfig]</a>.</p></div>\r
+to see the current binding mode indicator. See <a href="#binding_modes">[binding_modes]</a> to learn what\r
+modes are and how to use them.</p></div>\r
<div class="paragraph"><p>The default is to show the mode indicator.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>binding_mode_indicator <yes|no></tt></pre>\r
+<pre><tt>binding_mode_indicator yes|no</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_colors">5.14. Colors</h3>\r
+<h3 id="_colors">5.15. Colors</h3>\r
<div class="paragraph"><p>As with i3, colors are in HTML hex format (#rrggbb). The following colors can\r
be configured at the moment:</p></div>\r
<div class="dlist"><dl>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+focused_background\r
+</dt>\r
+<dd>\r
+<p>\r
+ Background color of the bar on the currently focused monitor output. If\r
+ not used, the color will be taken from <tt>background</tt>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_statusline\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color to be used for the statusline on the currently focused\r
+ monitor output. If not used, the color will be taken from <tt>statusline</tt>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_separator\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color to be used for the separator on the currently focused\r
+ monitor output. If not used, the color will be taken from <tt>separator</tt>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
focused_workspace\r
</dt>\r
<dd>\r
<dd>\r
<p>\r
Border, background and text color for a workspace button when the workspace\r
- contains a window with the urgency hint set. Also applies to <tt>mode</tt> indicators.\r
+ contains a window with the urgency hint set.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+binding_mode\r
+</dt>\r
+<dd>\r
+<p>\r
+ Border, background and text color for the binding mode indicator. If not used,\r
+ the colors will be taken from <tt>urgent_workspace</tt>.\r
</p>\r
</dd>\r
</dl></div>\r
statusline <color>\r
separator <color>\r
\r
- colorclass <border> <background> <text>\r
+ <colorclass> <border> <background> <text>\r
}</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example (default colors)</strong>:</p></div>\r
active_workspace #333333 #5f676a #ffffff\r
inactive_workspace #333333 #222222 #888888\r
urgent_workspace #2f343a #900000 #ffffff\r
+ binding_mode #2f343a #900000 #ffffff\r
}\r
}</tt></pre>\r
</div></div>\r
<pre><tt># execute this on your shell to make the current container borderless\r
i3-msg border none</tt></pre>\r
</div></div>\r
-<div class="paragraph"><p>Commands can be chained by using <tt>;</tt> (a semicolon). So, to move a window to a\r
+<div class="paragraph"
id="command_chaining"><p>Commands can be chained by using <tt>;</tt> (a semicolon). So, to move a window to a
\r specific workspace and immediately switch to that workspace, you can configure\r
the following keybinding:</p></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
bindsym $mod+x [class="Firefox" window_role="About"] kill\r
\r
# enable floating mode and move container to workspace 4\r
-for_window [class="^evil-app$"] floating enable, move container to workspace 4</tt></pre>\r
+for_window [class="^evil-app$"] floating enable, move container to workspace 4\r
+\r
+# move all floating windows to the scratchpad\r
+bindsym $mod+x [floating] move scratchpad</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>The criteria which are currently implemented are:</p></div>\r
<div class="dlist"><dl>\r
</dt>\r
<dd>\r
<p>\r
- Compares the window class (the second part of WM_CLASS)\r
+ Compares the window class (the second part of WM_CLASS). Use the\r
+ special value <tt>__focused__</tt> to match all windows having the same window\r
+ class as the currently focused window.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Compares the window instance (the first part of WM_CLASS)\r
+ Compares the window instance (the first part of WM_CLASS). Use the\r
+ special value <tt>__focused__</tt> to match all windows having the same window\r
+ instance as the currently focused window.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Compares the window role (WM_WINDOW_ROLE).\r
+ Compares the window role (WM_WINDOW_ROLE). Use the special value\r
+ <tt>__focused__</tt> to match all windows having the same window role as the\r
+ currently focused window.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+window_type\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are\r
+ <tt>normal</tt>, <tt>dialog</tt>, <tt>utility</tt>, <tt>toolbar</tt>, <tt>splash</tt>, <tt>menu</tt>, <tt>dropdown_menu</tt>,\r
+ <tt>popup_menu</tt>, <tt>tooltip</tt> and <tt>notification</tt>.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<dd>\r
<p>\r
Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).\r
+ Use the special value <tt>__focused__</tt> to match all windows having the\r
+ same window title as the currently focused window.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the workspace name of the workspace the window belongs to. Use\r
+ the special value <tt>__focused__</tt> to match all windows in the currently\r
+ focused workspace.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
con_mark\r
</dt>\r
<dd>\r
<p>\r
- Compares the mark set for this container, see <a href="#vim_like_marks">[vim_like_marks]</a>.\r
+ Compares the marks set for this container, see <a href="#vim_like_marks">[vim_like_marks]</a>. A\r
+ match is made if any of the container’s marks matches the specified\r
+ mark.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<dd>\r
<p>\r
Compares the i3-internal container ID, which you can get via the IPC\r
- interface. Handy for scripting.\r
+ interface. Handy for scripting. Use the special value <tt>__focused__</tt>\r
+ to match only the currently focused window.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+floating\r
+</dt>\r
+<dd>\r
+<p>\r
+ Only matches floating windows. This criterion requires no value.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+tiling\r
+</dt>\r
+<dd>\r
+<p>\r
+ Only matches tiling windows. This criterion requires no value.\r
</p>\r
</dd>\r
</dl></div>\r
-<div class="paragraph"><p>The criteria <tt>class</tt>, <tt>instance</tt>, <tt>role</tt>, <tt>title</tt> and <tt>mark</tt> are actually\r
-regular expressions (PCRE). See <tt>pcresyntax(3)</tt> or <tt>perldoc perlre</tt> for\r
+<div class="paragraph"><p>The criteria <tt>class</tt>, <tt>instance</tt>, <tt>role</tt>, <tt>title</tt>, <tt>workspace</tt> and <tt>mark</tt> are\r
+actually regular expressions (PCRE). See <tt>pcresyntax(3)</tt> or <tt>perldoc perlre</tt> for\r
information on how to use them.</p></div>\r
<div class="sect2">\r
<h3 id="exec">6.1. Executing applications (exec)</h3>\r
<div class="paragraph"><p>What good is a window manager if you can’t actually start any applications?\r
The exec command starts an application by passing the command you specify to a\r
shell. This implies that you can use globbing (wildcards) and programs will be\r
-searched in your $PATH.</p></div>\r
+searched in your <tt>$PATH</tt>.</p></div>\r
+<div class="paragraph"><p>See <a href="#command_chaining">[command_chaining]</a> for details on the special meaning of <tt>;</tt> (semicolon)\r
+and <tt>,</tt> (comma): they chain commands together in i3, so you need to use quoted\r
+strings (as shown in <a href="#exec_quoting">[exec_quoting]</a>) if they appear in your command.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>exec [--no-startup-id] command</tt></pre>\r
+<pre><tt>exec [--no-startup-id] <command></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
launching. So, if an application is not startup-notification aware (most GTK\r
and Qt using applications seem to be, though), you will end up with a watch\r
cursor for 60 seconds.</p></div>\r
+<div class="paragraph" id="exec_quoting"><p>If the command to be executed contains a <tt>;</tt> (semicolon) and/or a <tt>,</tt> (comma),\r
+the entire command must be quoted. For example, to have a keybinding for the\r
+shell command <tt>notify-send Hello, i3</tt>, you would add an entry to your\r
+configuration file 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># Execute a command with a comma in it\r
+bindsym $mod+p exec "notify-send Hello, i3"</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>If however a command with a comma and/or semicolon itself requires quotes, you\r
+must escape the internal quotation marks with double backslashes, 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># Execute a command with a comma, semicolon and internal quotes\r
+bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\""</tt></pre>\r
+</div></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_splitting_containers">6.2. Splitting containers</h3>\r
get placed below the current one (splitv).</p></div>\r
<div class="paragraph"><p>If you apply this command to a split container with the same orientation,\r
nothing will happen. If you use a different orientation, the split container’s\r
-orientation will be changed (if it does not have more than one window). Use\r
-<tt>layout toggle split</tt> to change the layout of any split container from splitv\r
-to splith or vice-versa.</p></div>\r
+orientation will be changed (if it does not have more than one window).\r
+The <tt>toggle</tt> option will toggle the orientation of the split container if it\r
+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
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>split <vertical|horizontal></tt></pre>\r
+<pre><tt>split vertical|horizontal|toggle</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>bindsym $mod+v split vertical\r
-bindsym $mod+h split horizontal</tt></pre>\r
+bindsym $mod+h split horizontal\r
+bindsym $mod+t split toggle</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>layout <default|tabbed|stacking|splitv|splith>\r
+<pre><tt>layout default|tabbed|stacking|splitv|splith\r
layout toggle [split|all]</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focusing_moving_containers">6.4. Focusing/Moving containers</h3>\r
-<div class="paragraph"><p>To change the focus, use the focus command: <tt>focus left</tt>, <tt>focus right</tt>, <tt>focus\r
-down</tt> and <tt>focus up</tt>.</p></div>\r
-<div class="paragraph"><p>There are a few special parameters you can use for the focus command:</p></div>\r
+<h3 id="_focusing_moving_containers">6.4. Focusing containers</h3>\r
+<div class="paragraph"><p>To change focus, you can use the <tt>focus</tt> command. The following options are\r
+available:</p></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
+left|right|up|down\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sets focus to the nearest container in the given direction.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
parent\r
</dt>\r
<dd>\r
<p>\r
- Sets focus to the <tt>Parent Container</tt> of the current <tt>Container</tt>.\r
+ Sets focus to the parent container of the current container.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
</dl></div>\r
-<div class="paragraph"><p>For moving, use <tt>move left</tt>, <tt>move right</tt>, <tt>move down</tt> and <tt>move up</tt>.</p></div>\r
<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
-focus <parent|child|floating|tiling|mode_toggle>\r
-focus output <<left|right|down|up>|output>\r
-move <left|right|down|up> [<px> px]\r
-move [absolute] position [[<px> px] [<px> px]|center]</tt></pre>\r
+<pre><tt>focus left|right|down|up\r
+focus parent|child|floating|tiling|mode_toggle\r
+focus output left|right|up|down|<output></tt></pre>\r
</div></div>\r
-<div class="paragraph"><p>Note that the amount of pixels you can specify for the <tt>move</tt> command is only\r
-relevant for floating containers. The default amount is 10 pixels.</p></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 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
bindsym $mod+x focus output right\r
\r
# Focus the big output\r
-bindsym $mod+x focus output HDMI-2\r
+bindsym $mod+x focus output HDMI-2</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
+# 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 <left|right|down|up> [<px> px]\r
+\r
+# Moves the container either to a specific location\r
+# or to the center of the screen. If 'absolute' is\r
+# used, it is moved to the center of all outputs.\r
+move [absolute] position [[<px> px] [<px> px]|center]\r
\r
-# Move container to the left, bottom, top, right:\r
+# 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
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># 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
# move more than the default\r
bindsym $mod+j move left 20 px\r
\r
-# Move floating container to the center\r
-# of all outputs\r
-bindsym $mod+c move absolute position center</tt></pre>\r
+# Move floating container to the center of all outputs\r
+bindsym $mod+c move absolute position center\r
+\r
+# Move container to the current position of the cursor\r
+bindsym $mod+m move position mouse</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_sticky_floating_windows">6.6. 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
+window.</p></div>\r
+<div class="paragraph"><p>Note that while any window can be made sticky through this command, it will\r
+only take effect if the window is floating.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>sticky enable|disable|toggle</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># make a terminal sticky that was started as a notepad\r
+for_window [instance=notepad] sticky enable</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_named_workspaces_moving_to_workspaces">6.5. Changing (named) workspaces/moving to workspaces</h3>\r
+<h3 id="_changing_named_workspaces_moving_to_workspaces">6.7. Changing (named) workspaces/moving to workspaces</h3>\r
<div class="paragraph"><p>To change to a specific workspace, use the <tt>workspace</tt> command, followed by the\r
-number or name of the workspace. To move containers to specific workspaces, use\r
-<tt>move container to workspace</tt>.</p></div>\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
+only.</p></div>\r
+<div class="paragraph"><p>To move containers to specific workspaces, use <tt>move container to workspace</tt>.</p></div>\r
<div class="paragraph"><p>You can also switch to the next and previous workspace with the commands\r
<tt>workspace next</tt> and <tt>workspace prev</tt>, which is handy, for example, if you have\r
workspace 1, 3, 4 and 9 and you want to cycle through them with a single key\r
container to workspace next</tt>, <tt>move container to workspace prev</tt> to move a\r
container to the next/previous workspace and <tt>move container to workspace current</tt>\r
(the last one makes sense only when used with criteria).</p></div>\r
+<div class="paragraph"><p><tt>workspace next</tt> cycles through either numbered or named workspaces. But when it\r
+reaches the last numbered/named workspace, it looks for named workspaces after\r
+exhausting numbered ones and looks for numbered ones after exhausting named ones.</p></div>\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 class="paragraph"><p>Workspace names are parsed as\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace <next|prev|next_on_output|prev_on_output>\r
+<pre><tt>workspace next|prev|next_on_output|prev_on_output\r
workspace back_and_forth\r
-workspace <name>\r
-workspace number <name>\r
+workspace [--no-auto-back-and-forth] <name>\r
+workspace [--no-auto-back-and-forth] number <name>\r
\r
-move [window|container] [to] workspace <name>\r
-move [window|container] [to] workspace number <name>\r
-move [window|container] [to] workspace <prev|next|current></tt></pre>\r
+move [--no-auto-back-and-forth] [window|container] [to] workspace <name>\r
+move [--no-auto-back-and-forth] [window|container] [to] workspace number <name>\r
+move [window|container] [to] workspace prev|next|current</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
bindsym $mod+F1 [class="Firefox"] move workspace current</tt></pre>\r
</div></div>\r
<div class="sect3">\r
-<h4 id="_named_workspaces">6.5.1. Named workspaces</h4>\r
+<h4 id="_named_workspaces">6.7.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
specify a default name if there’s currently no workspace starting with a "1".</p></div>\r
</div>\r
<div class="sect3">\r
-<h4 id="_renaming_workspaces">6.5.2. Renaming workspaces</h4>\r
+<h4 id="_renaming_workspaces">6.7.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
<pre><tt>i3-msg 'rename workspace 5 to 6'\r
i3-msg 'rename workspace 1 to "1: www"'\r
i3-msg 'rename workspace "1: www" to "10: www"'\r
-i3-msg 'rename workspace to "2: mail"\r
+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>\r
</div>\r
<div class="sect2">\r
-<h3 id="_moving_workspaces_to_a_different_screen">6.6. Moving workspaces to a different screen</h3>\r
+<h3 id="_moving_workspaces_to_a_different_screen">6.8. 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.7. Moving containers/workspaces to RandR outputs</h3>\r
-<div class="paragraph"
id="move_to_outputs"><p>To move a container to another RandR output (addressed by names like <tt>LVDS1</tt> or
\r+<h3 id="_moving_containers_workspaces_to_randr_outputs">6.9. 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>|<output>>\r
-move workspace to output <<left|right|down|up>|<output>></tt></pre>\r
+<pre><tt>move container to output left|right|down|up|current|<output>\r
+move workspace to output left|right|down|up|current|<output></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="resizingconfig">6.8. Resizing containers/windows</h3>\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 <mark></tt></pre>\r
+</div></div>\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
<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> <direction> [<px> px [or <ppt> ppt]]</tt></pre>\r
+<pre><tt>resize grow|shrink <direction> [<px> px [or <ppt> ppt]]\r
+resize set <width> [px] <height> [px]</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
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).</p></div>\r
-<div class="paragraph"><p>I recommend using the resize command inside a so called <tt>mode</tt>:</p></div>\r
-<div class="listingblock">\r
-<div class="title">Example: Configuration file, defining a mode for resizing</div>\r
-<div class="content">\r
-<pre><tt>mode "resize" {\r
- # These bindings trigger as soon as you enter the resize mode\r
-\r
- # Pressing left will shrink the window’s width.\r
- # Pressing right will grow the window’s width.\r
- # Pressing up will shrink the window’s height.\r
- # Pressing down will grow the window’s height.\r
- bindsym j resize shrink width 10 px or 10 ppt\r
- bindsym k resize grow height 10 px or 10 ppt\r
- bindsym l resize shrink height 10 px or 10 ppt\r
- bindsym semicolon resize grow width 10 px or 10 ppt\r
-\r
- # same bindings, but for the arrow keys\r
- bindsym Left resize shrink width 10 px or 10 ppt\r
- bindsym Down resize grow height 10 px or 10 ppt\r
- bindsym Up resize shrink height 10 px or 10 ppt\r
- bindsym Right resize grow width 10 px or 10 ppt\r
-\r
- # back to normal: Enter or Escape\r
- bindsym Return mode "default"\r
- bindsym Escape mode "default"\r
-}\r
-\r
-# Enter resize mode\r
-bindsym $mod+r mode "resize"</tt></pre>\r
+default is 10 percentage points). Note that <tt>resize set</tt> will only work for\r
+floating containers.</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
+context.</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>for_window [class="urxvt"] resize set 640 480</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_jumping_to_specific_windows">6.9. Jumping to specific windows</h3>\r
+<h3 id="_jumping_to_specific_windows">6.12. 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_vim_like_marks_mark_goto">6.10. VIM-like marks (mark/goto)</h3>\r
-<div class="paragraph"
id="vim_like_marks"><p>This feature is like the jump feature: It allows you to directly jump to a
\r+<h3 id="vim_like_marks">6.13. 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
an arbitrary label and use it afterwards. You can unmark the label in the same\r
window, you cannot simply bind it to a key. <tt>i3-input</tt> is a tool created\r
for this purpose: It lets you input a command and sends the command to i3. It\r
can also prefix this command and display a custom prompt for the input dialog.</p></div>\r
+<div class="paragraph"><p>The additional <tt>--toggle</tt> option will remove the mark if the window already has\r
+this mark or add it otherwise. Note that you may need to use this in\r
+combination with <tt>--add</tt> (see below) as any other marks will otherwise be\r
+removed.</p></div>\r
+<div class="paragraph"><p>By default, a window can only have one mark. You can use the <tt>--add</tt> flag to\r
+put more than one mark on a window.</p></div>\r
+<div class="paragraph"><p>Refer to <a href="#show_marks">[show_marks]</a> if you don’t want marks to be shown in the window decoration.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>mark identifier\r
+<pre><tt>mark [--add|--replace] [--toggle] <identifier>\r
[con_mark="identifier"] focus\r
-unmark identifier</tt></pre>\r
+unmark <identifier></tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Example (in a terminal)</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>$ i3-msg mark irssi\r
-$ i3-msg '[con_mark="irssi"] focus'\r
-$ i3-msg unmark irssi</tt></pre>\r
+<pre><tt># marks the focused container\r
+mark irssi\r
+\r
+# focus the container with the mark "irssi"\r
+'[con_mark="irssi"] focus'\r
+\r
+# remove the mark "irssi" from whichever container has it\r
+unmark irssi\r
+\r
+# remove all marks on all firefox windows\r
+[class="(?i)firefox"] unmark</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_border_style">6.11. Changing border style</h3>\r
+<h3 id="pango_markup">6.14. 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
+<a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>\r
+and the following placeholders which will be replaced:</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+<tt>%title</tt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME\r
+ as fallback). When used on containers without a window (e.g., a split\r
+ container inside a tabbed/stacked layout), this will be the tree\r
+ representation of the container (e.g., "H[xterm xterm]").\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<tt>%class</tt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The X11 window class (second part of WM_CLASS). This corresponds to the\r
+ <tt>class</tt> criterion, see <a href="#command_criteria">[command_criteria]</a>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<tt>%instance</tt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ The X11 window instance (first part of WM_CLASS). This corresponds to the\r
+ <tt>instance</tt> criterion, see <a href="#command_criteria">[command_criteria]</a>.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+<div class="paragraph"><p>Using the <a href="#for_window">[for_window]</a> directive, you can set the title format for any window\r
+based on <a href="#command_criteria">[command_criteria]</a>.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>title_format <format></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># give the focused window a prefix\r
+bindsym $mod+p title_format "Important | %title"\r
+\r
+# print all window titles bold\r
+for_window [class=".*"] title_format "<b>%title</b>"\r
+\r
+# print window titles of firefox windows red\r
+for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_changing_border_style">6.15. 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 1pixel</tt> to use a 1-pixel border (no window title)\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
<div class="paragraph"><p>There is also <tt>border toggle</tt> which will toggle the different border styles.</p></div>\r
+<div class="paragraph"><p>Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel\r
+may be represented by multiple physical pixels, so <tt>pixel 1</tt> might not\r
+necessarily translate into a single pixel row wide border.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>border normal|pixel [<n>]\r
+border none|toggle\r
+\r
+# legacy syntax, equivalent to "border pixel 1"\r
+border 1pixel</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>bindsym $mod+t border normal\r
-bindsym $mod+y border 1pixel\r
+<pre><tt># use window title, but no border\r
+bindsym $mod+t border normal 0\r
+# use no window title and a thick border\r
+bindsym $mod+y border pixel 3\r
+# use neither window title nor border\r
bindsym $mod+u border none</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="shmlog">6.12. Enabling shared memory logging</h3>\r
+<h3 id="shmlog">6.16. 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
<div class="listingblock">\r
<div class="content">\r
<pre><tt>shmlog <size_in_bytes>\r
-shmlog <on|off|toggle></tt></pre>\r
+shmlog on|off|toggle</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_enabling_debug_logging">6.13. Enabling debug logging</h3>\r
+<h3 id="_enabling_debug_logging">6.17. 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
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>debuglog <on|off|toggle></tt></pre>\r
+<pre><tt>debuglog on|off|toggle</tt></pre>\r
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_reloading_restarting_exiting">6.14. Reloading/Restarting/Exiting</h3>\r
+<h3 id="_reloading_restarting_exiting">6.18. 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_scratchpad">6.15. Scratchpad</h3>\r
+<h3 id="_scratchpad">6.19. 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_nop">6.16. Nop</h3>\r
+<h3 id="_nop">6.20. 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_i3bar_control">6.17. i3bar control</h3>\r
+<h3 id="_i3bar_control">6.21. 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
<li>\r
<p>\r
For information on how to move existing workspaces between monitors,\r
- see <a href="#_moving_containers_workspaces_to_randr_outputs">[_moving_containers_workspaces_to_randr_outputs]</a>.\r
+ see <a href="#move_to_outputs">[move_to_outputs]</a>.\r
</p>\r
</li>\r
</ol></div>\r
see <a href="#i3bar_position">[i3bar_position]</a>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_giving_presentations_multi_monitor">8.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="presentations">8.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
projects / i3 / i3.github.io / blobdiff