<h1>i3 User’s Guide</h1>\r
<span id="author">Michael Stapelberg</span><br />\r
<span id="email"><tt><<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>></tt></span><br />\r
-<span id="revdate">March 2010</span>\r
+<span id="revdate">October 2011</span>\r
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
<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 contact me on IRC, Jabber or E-Mail and\r
-I’ll help you out.</p></div>\r
+window manager. If it does not, please contact us on IRC (preferred) or post your\r
+question(s) on the mailing list.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div class="sectionbody">\r
<div class="paragraph"><p>For the "too long; didn’t read" people, here is an overview of the default\r
keybindings (click to see the full size image):</p></div>\r
-<div class="paragraph"><p><strong>Keys to use with Mod1 (alt):</strong></p></div>\r
+<div class="paragraph"><p><strong>Keys to use with mod (alt):</strong></p></div>\r
<div class="paragraph"><p><span class="image">\r
<a class="image" href="keyboard-layer1.png">\r
-<img src="keyboard-layer1.png" alt="Keys to use with Mod1 (alt)" width="600" />\r
+<img src="keyboard-layer1.png" alt="Keys to use with mod (alt)" width="600" />\r
</a>\r
</span></p></div>\r
-<div class="paragraph"><p><strong>Keys to use with Shift+Mod1:</strong></p></div>\r
+<div class="paragraph"><p><strong>Keys to use with Shift+mod:</strong></p></div>\r
<div class="paragraph"><p><span class="image">\r
<a class="image" href="keyboard-layer2.png">\r
-<img src="keyboard-layer2.png" alt="Keys to use with Shift+Mod1" width="600" />\r
+<img src="keyboard-layer2.png" alt="Keys to use with Shift+mod" width="600" />\r
</a>\r
</span></p></div>\r
-<div class="paragraph"><p>As i3 uses keycodes in the default configuration, it does not matter which\r
-keyboard layout you actually use. The key positions are what matters (of course\r
-you can also use keysymbols, see <a href="#keybindings">[keybindings]</a>).</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>\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 windows (Mod4)\r
+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 Mod1+Enter, that is Alt+Enter in the default configuration. By\r
-pressing Mod1+Enter, a new terminal will be opened. It will fill the whole\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
<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>It is important to keep in mind that i3 uses a table to manage your windows. At\r
-the moment, you have exactly one column and one row which leaves you with one\r
-cell. In this cell there is a container, which is where your new terminal is\r
-opened.</p></div>\r
-<div class="paragraph"><p>If you now open another terminal, you still have only one cell. However, the\r
-container in that cell holds both of your terminals. So, a container is just a\r
-group of clients with a specific layout. Containers can be resized by adjusting\r
-the size of the cell that holds them.</p></div>\r
+<div class="paragraph"><p>If you now open another terminal, i3 will place it next to the current one,\r
+splitting the screen size in half. Depending on your monitor, i3 will put the\r
+created window beside the existing window (on wide displays) or below the\r
+existing window (rotated displays).</p></div>\r
<div class="paragraph"><p><span class="image">\r
<img src="two_terminals.png" alt="Two terminals" />\r
</span></p></div>\r
-<div class="paragraph"><p>To move the focus between the two terminals, you use the direction keys which\r
-you may know from the editor <tt>vi</tt>. However, in i3, your homerow is used for\r
-these keys (in <tt>vi</tt>, the keys are shifted to the left by one for compatibility\r
-with most keyboard layouts). Therefore, <tt>Mod1+J</tt> is left, <tt>Mod1+K</tt> is down,\r
-<tt>Mod1+L</tt> is up and <tt>Mod1+;</tt> is right. So, to switch between the terminals,\r
-use <tt>Mod1+K</tt> or <tt>Mod1+L</tt>.</p></div>\r
-<div class="paragraph"><p>To create a new row/column (and a new cell), you can simply move a terminal (or\r
-any other window) in the direction you want to expand your table. So, let’s\r
-expand the table to the right by pressing <tt>Mod1+Shift+;</tt>.</p></div>\r
-<div class="paragraph"><p><span class="image">\r
-<img src="two_columns.png" alt="Two columns" />\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
+<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
+"window" for a container that actually contains an X11 window (like a terminal\r
+or browser) and "split container" for containers that consist of one or more\r
+windows.</p></div>\r
+<div class="paragraph"><p>TODO: picture of the tree</p></div>\r
+<div class="paragraph"><p>To split a window vertically, press <tt>mod+v</tt>. To split it horizontally, press\r
+<tt>mod+h</tt>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_container_modes">2.2. Changing container modes</h3>\r
-<div class="paragraph"><p>A container can have the following modes:</p></div>\r
+<h3 id="_changing_the_container_layout">2.2. Changing the container layout</h3>\r
+<div class="paragraph"><p>A split container can have one of the following layouts:</p></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
default\r
</p>\r
</dd>\r
</dl></div>\r
-<div class="paragraph"><p>To switch modes, press <tt>Mod1+e</tt> for default, <tt>Mod1+h</tt> for stacking and\r
-<tt>Mod1+w</tt> for tabbed.</p></div>\r
+<div class="paragraph"><p>To switch modes, press <tt>mod+e</tt> for default, <tt>mod+s</tt> for stacking and\r
+<tt>mod+w</tt> for tabbed.</p></div>\r
<div class="paragraph"><p><span class="image">\r
<img src="modes.png" alt="Container modes" />\r
</span></p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_toggling_fullscreen_mode_for_a_window">2.3. Toggling fullscreen mode for a window</h3>\r
-<div class="paragraph"><p>To display a window fullscreen or to go out of fullscreen mode again, press\r
-<tt>Mod1+f</tt>.</p></div>\r
-<div class="paragraph"><p>There is also a global fullscreen mode in i3 in which the client will use all\r
-available outputs. To use it, or to get out of it again, press <tt>Mod1+Shift+f</tt>.</p></div>\r
+<div class="paragraph"><p>To display a window in fullscreen mode or to go out of fullscreen mode again,\r
+press <tt>mod+f</tt>.</p></div>\r
+<div class="paragraph"><p>There is also a global fullscreen mode in i3 in which the client will span all\r
+available outputs.</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_opening_other_applications">2.4. Opening other applications</h3>\r
<div class="paragraph"><p>Aside from opening applications from a terminal, you can also use the handy\r
-<tt>dmenu</tt> which is opened by pressing <tt>Mod1+v</tt> by default. Just type the name\r
-(or a part of it) of the application which you want to open. The application\r
-typed has to be in your <tt>$PATH</tt> for this to work.</p></div>\r
+<tt>dmenu</tt> which is opened by pressing <tt>mod+d</tt> by default. Just type the name\r
+(or a part of it) of the application which you want to open. The corresponding\r
+application has to be in your <tt>$PATH</tt> for this to work.</p></div>\r
<div class="paragraph"><p>Additionally, if you have applications you open very frequently, you can\r
create a keybinding for starting the application directly. See the section\r
-"Configuring i3" for details.</p></div>\r
+<a href="#configuring">[configuring]</a> for details.</p></div>\r
</div>\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
-can press <tt>Mod1+Shift+q</tt> to kill a window. For applications which support\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
the WM_DELETE protocol your X server will kill the window and the behaviour\r
<h3 id="_using_workspaces">2.6. Using workspaces</h3>\r
<div class="paragraph"><p>Workspaces are an easy way to group a set of windows. By default, you are on\r
the first workspace, as the bar on the bottom left indicates. To switch to\r
-another workspace, press <tt>Mod1+num</tt> where <tt>num</tt> is the number of the workspace\r
+another workspace, press <tt>mod+num</tt> where <tt>num</tt> is the number of the workspace\r
you want to use. If the workspace does not exist yet, it will be created.</p></div>\r
<div class="paragraph"><p>A common paradigm is to put the web browser on one workspace, communication\r
applications (<tt>mutt</tt>, <tt>irssi</tt>, …) on another one, and the ones with which you\r
</div>\r
<div class="sect2">\r
<h3 id="_moving_windows_to_workspaces">2.7. Moving windows to workspaces</h3>\r
-<div class="paragraph"><p>To move a window to another workspace, simply press <tt>Mod1+Shift+num</tt> where\r
+<div class="paragraph"><p>To move a window to another workspace, simply press <tt>mod+Shift+num</tt> where\r
<tt>num</tt> is (like when switching workspaces) the number of the target workspace.\r
Similarly to switching workspaces, the target workspace will be created if\r
it does not yet exist.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_resizing_columns_rows">2.8. Resizing columns/rows</h3>\r
-<div class="paragraph"><p>To resize columns or rows, just grab the border between the two columns/rows\r
-and move it to the wanted size. Please keep in mind that each cell of the table\r
-holds a <tt>container</tt> and thus you cannot horizontally resize single windows. If\r
-you need applications with different horizontal sizes, place them in seperate\r
-cells one above the other.</p></div>\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>\r
<div class="sect2">\r
<h3 id="_restarting_i3_inplace">2.9. Restarting i3 inplace</h3>\r
<div class="paragraph"><p>To restart i3 inplace (and thus get into a clean state if there is a bug, or\r
-to upgrade to a newer version of i3) you can use <tt>Mod1+Shift+r</tt>. Be aware,\r
-though, that this kills your current layout and all the windows you have opened\r
-will be put in a default container in only one cell. Saving layouts will be\r
-implemented in a later version.</p></div>\r
+to upgrade to a newer version of i3) you can use <tt>mod+Shift+r</tt>.</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_exiting_i3">2.10. Exiting i3</h3>\r
-<div class="paragraph"><p>To cleanly exit i3 without killing your X server, you can use <tt>Mod1+Shift+e</tt>.</p></div>\r
+<div class="paragraph"><p>To cleanly exit i3 without killing your X server, you can use <tt>mod+Shift+e</tt>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_snapping">2.11. Snapping</h3>\r
-<div class="paragraph"><p>Snapping is a mechanism to increase/decrease the colspan/rowspan of a container.\r
-Colspan/rowspan is the number of columns/rows a specific cell of the table\r
-consumes. This is easier explained by giving an example, so take the following\r
-layout:</p></div>\r
-<div class="paragraph"><p><span class="image">\r
-<img src="snapping.png" alt="Snapping example" />\r
-</span></p></div>\r
-<div class="paragraph"><p>To use the full size of your screen, you can now snap container 3 downwards\r
-by pressing <tt>Mod1+Control+k</tt> (or snap container 2 rightwards).</p></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_floating">2.12. Floating</h3>\r
+<h3 id="_floating">2.11. Floating</h3>\r
<div class="paragraph"><p>Floating mode is the opposite of tiling mode. The position and size of a window\r
are not managed by i3, but by you. Using this mode violates the tiling\r
paradigm but can be useful for some corner cases like "Save as" dialog\r
-windows, or toolbar windows (GIMP or similar).</p></div>\r
-<div class="paragraph"><p>You can enable floating mode for a window by pressing <tt>Mod1+Shift+Space</tt>. By\r
+windows, or toolbar windows (GIMP or similar). Those windows usually set the\r
+appropriate hint and are opened in floating mode by default.</p></div>\r
+<div class="paragraph"><p>You can toggle floating mode for a window by pressing <tt>mod+Shift+Space</tt>. By\r
dragging the window’s titlebar with your mouse you can move the window\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>.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_configuring_i3">3. Configuring i3</h2>\r
+<h2 id="_tree">3. Tree</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3 stores all information about the X11 outputs, workspaces and layout of the\r
+windows on them in a tree. The root node is the X11 root window, followed by\r
+the X11 outputs, then dock areas and a content container, then workspaces and\r
+finally the windows themselves. In previous versions of i3 we had multiple lists\r
+(of outputs, workspaces) and a table for each workspace. That approach turned\r
+out to be complicated to use (snapping), understand and implement.</p></div>\r
+<div class="sect2">\r
+<h3 id="_the_tree_consists_of_containers">3.1. The tree consists of Containers</h3>\r
+<div class="paragraph"><p>The building blocks of our tree are so called <tt>Containers</tt>. A <tt>Container</tt> can\r
+host a window (meaning an X11 window, one that you can actually see and use,\r
+like a browser). Alternatively, it could contain one or more <tt>Containers</tt>. A\r
+simple example is the workspace: When you start i3 with a single monitor, a\r
+single workspace and you open two terminal windows, you will end up with a tree\r
+like this:</p></div>\r
+<div class="imageblock" style="float:right;">\r
+<div class="content">\r
+<img src="tree-layout2.png" alt="layout2" />\r
+</div>\r
+</div>\r
+<div class="imageblock">\r
+<div class="content">\r
+<img src="tree-shot4.png" alt="shot4" />\r
+</div>\r
+<div class="title">Figure 1. Two terminals on standard workspace</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
+layout when using a tree as data structure. In i3, every <tt>Container</tt> has an\r
+orientation (horizontal, vertical or unspecified). So, in our example with the\r
+workspace, the default orientation of the workspace <tt>Container</tt> is horizontal\r
+(most monitors are widescreen nowadays). If you change the orientation to\r
+vertical (<tt>mod+v</tt> in the default config) and <strong>then</strong> open two terminals, i3 will\r
+configure your windows like this:</p></div>\r
+<div class="imageblock">\r
+<div class="content">\r
+<img src="tree-shot2.png" alt="shot2" />\r
+</div>\r
+<div class="title">Figure 2. Vertical Workspace Orientation</div>\r
+</div>\r
+<div class="paragraph"><p>An interesting new feature of the tree branch is the ability to split anything:\r
+Let’s assume you have two terminals on a workspace (with horizontal\r
+orientation), focus is on the right terminal. Now you want to open another\r
+terminal window below the current one. If you would just open a new terminal\r
+window, it would show up to the right due to the horizontal workspace\r
+orientation. Instead, press <tt>mod+v</tt> to create a <tt>Vertical Split Container</tt> (to\r
+open a <tt>Horizontal Split Container</tt>, use <tt>mod+h</tt>). Now you can open a new\r
+terminal and it will open below the current one:</p></div>\r
+<div class="imageblock" style="float:right;">\r
+<div class="content">\r
+<img src="tree-layout1.png" alt="Layout" />\r
+</div>\r
+</div>\r
+<div class="imageblock">\r
+<div class="content">\r
+<img src="tree-shot1.png" alt="shot" />\r
+</div>\r
+<div class="title">Figure 3. Vertical Split Container</div>\r
+</div>\r
+<div style="clear:both;"></div>\r
+<div class="paragraph"><p>You probably guessed it already: There is no limit on how deep your hierarchy\r
+of splits can be.</p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_focus_parent">3.3. Focus parent</h3>\r
+<div class="paragraph"><p>Let’s stay with our example from above. We have a terminal on the left and two\r
+vertically split terminals on the right, focus is on the bottom right one. When\r
+you open a new terminal, it will open below the current one.</p></div>\r
+<div class="paragraph"><p>So, how can you open a new terminal window to the <strong>right</strong> of the current one?\r
+The solution is to use <tt>focus parent</tt>, which will focus the <tt>Parent Container</tt> of\r
+the current <tt>Container</tt>. In this case, you would focus the <tt>Vertical Split\r
+Container</tt> which is <strong>inside</strong> the horizontally oriented workspace. Thus, now new\r
+windows will be opened to the right of the <tt>Vertical Split Container</tt>:</p></div>\r
+<div class="imageblock">\r
+<div class="content">\r
+<img src="tree-shot3.png" alt="shot3" />\r
+</div>\r
+<div class="title">Figure 4. Focus parent, then open new terminal</div>\r
+</div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="configuring">4. Configuring i3</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>This is where the real fun begins ;-). Most things are very dependant on your\r
ideal working environment so we can’t make reasonable defaults for them.</p></div>\r
<div class="paragraph"><p>To change the configuration of i3, copy <tt>/etc/i3/config</tt> to <tt>~/.i3/config</tt>\r
(or <tt>~/.config/i3/config</tt> if you like the XDG directory scheme) and edit it\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
+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
+exit.</p></div>\r
<div class="sect2">\r
-<h3 id="_comments">3.1. Comments</h3>\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
properly document your setup for later reference. Comments are started with\r
a # and can only be used at the beginning of a line:</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_fonts">3.2. Fonts</h3>\r
-<div class="paragraph"><p>i3 uses X core fonts (not Xft) for rendering window titles and the internal\r
-workspace bar. You can use <tt>xfontsel(1)</tt> to generate such a font description.\r
-To see special characters (Unicode), you need to use a font which supports\r
-the ISO-10646 encoding.</p></div>\r
+<h3 id="_fonts">4.2. Fonts</h3>\r
+<div class="paragraph"><p>i3 uses X core fonts (not Xft) for rendering window titles. You can use\r
+<tt>xfontsel(1)</tt> to generate such a font description. To see special characters\r
+(Unicode), you need to use a font which supports the ISO-10646 encoding.</p></div>\r
+<div class="paragraph"><p>If i3 cannot open the configured font, it will output an error in the logfile\r
+and fall back to a working font.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="keybindings">3.3. Keyboard bindings</h3>\r
+<h3 id="keybindings">4.3. Keyboard bindings</h3>\r
<div class="paragraph"><p>A keyboard binding makes i3 execute a command (see below) upon pressing a\r
specific key. i3 allows you to bind either on keycodes or on keysyms (you can\r
also mix your bindings, though i3 will not protect you from overlapping ones).</p></div>\r
</li>\r
<li>\r
<p>\r
-Keycodes do not need to have a symbol assigned (handy for some hotkeys\r
- on some notebooks) and they will not change their meaning as you switch to a\r
- different keyboard layout (when using <tt>xmodmap</tt>).\r
+Keycodes do not need to have a symbol assigned (handy for custom vendor\r
+ hotkeys on some notebooks) and they will not change their meaning as you\r
+ switch to a different keyboard layout (when using <tt>xmodmap</tt>).\r
</p>\r
</li>\r
</ul></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>bindsym [Modifiers+]keysym command\r
-bind [Modifiers+]keycode command</tt></pre>\r
+bindcode [Modifiers+]keycode command</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># Fullscreen\r
-bindsym Mod1+f f\r
+bindsym mod+f fullscreen\r
\r
# Restart\r
-bindsym Mod1+Shift+r restart\r
+bindsym mod+Shift+r restart\r
\r
# Notebook-specific hotkeys\r
-bind 214 exec /home/michael/toggle_beamer.sh</tt></pre>\r
+bindcode 214 exec /home/michael/toggle_beamer.sh</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Available Modifiers:</p></div>\r
<div class="dlist"><dl>\r
</dl></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="floating_modifier">3.4. The floating modifier</h3>\r
+<h3 id="floating_modifier">4.4. 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
it to the position you want.</p></div>\r
<div class="paragraph"><p>When holding the floating modifier, you can resize a floating window by\r
pressing the right mouse button on it and moving around while holding it. If\r
-you hold the shift button as well, the resize will be proportional.</p></div>\r
+you hold the shift button as well, the resize will be proportional (the aspect\r
+ratio will be preserved).</p></div>\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
</div></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>floating_modifier Mod1</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_layout_mode_for_new_containers">3.5. Layout mode for new containers</h3>\r
-<div class="paragraph"><p>This option determines in which mode new containers will start. See also\r
-<a href="#stack-limit">[stack-limit]</a>.</p></div>\r
+<h3 id="_orientation_for_new_workspaces">4.5. 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>With the <tt>default_orientation</tt> configuration directive, you can override that\r
+behaviour.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>new_container <default|stacking|tabbed>\r
-new_container stack-limit <cols|rows> <value></tt></pre>\r
+<pre><tt>default_orientation <horizontal|vertical|auto></tt></pre>\r
</div></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>default_orientation vertical</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_layout_mode_for_new_containers">4.6. 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>new_container 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 class="content">\r
+<pre><tt>workspace_layout tabbed</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_border_style_for_new_windows">3.6. Border style for new windows</h3>\r
+<h3 id="_border_style_for_new_windows">4.7. Border style for new windows</h3>\r
<div class="paragraph"><p>This option determines which border style new windows will have.</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 <bp|bn|bb></tt></pre>\r
+<pre><tt>new_window <normal|1pixel|none></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
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_arbitrary_commands_for_specific_windows_for_window">4.8. 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
</div></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>new_window bp</tt></pre>\r
+<pre><tt># enable floating mode for all XTerm windows\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
+\r
+# A less useful, but rather funny example:\r
+# makes the window floating as soon as I change\r
+# directory to ~/work\r
+for_window [title="x200: ~/work"] floating enable</tt></pre>\r
</div></div>\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">3.7. Variables</h3>\r
+<h3 id="_variables">4.9. 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>Examples</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>set $m Mod1\r
handling and there are absolutely no plans to change this. If you need a more\r
dynamic configuration you should create a little script which generates a\r
configuration file and run it before starting i3 (for example in your\r
-<tt>.xsession</tt> file).</p></div>\r
+<tt>~/.xsession</tt> file).</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_putting_clients_on_specific_workspaces">3.8. Automatically putting clients on specific workspaces</h3>\r
-<div class="paragraph" id="assign_workspace"><p>It is recommended that you match on window classes wherever possible because\r
-some applications first create their window, and then worry about setting the\r
-correct title. Firefox with Vimperator comes to mind. The window starts up\r
-being named Firefox, and only when Vimperator is loaded does the title change.\r
-As i3 will get the title as soon as the application maps the window (mapping\r
-means actually displaying it on the screen), you’d need to have to match on\r
-<em>Firefox</em> in this case.</p></div>\r
-<div class="paragraph"><p>You can prefix or suffix workspaces with a <tt>~</tt> to specify that matching clients\r
-should be put into floating mode. If you specify only a <tt>~</tt>, the client will\r
-not be put onto any workspace, but will be set floating on the current one.</p></div>\r
+<h3 id="_automatically_putting_clients_on_specific_workspaces">4.10. 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
+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
+because some applications first create their window, and then worry about\r
+setting the correct title. Firefox with Vimperator comes to mind. The window\r
+starts up being named Firefox, and only when Vimperator is loaded does the\r
+title change. As i3 will get the title as soon as the application maps the\r
+window (mapping means actually displaying it on the screen), you’d need to have\r
+to match on <em>Firefox</em> in this case.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>assign ["]window class[/window title]["] [→] [~ | workspace]</tt></pre>\r
+<pre><tt>assign <criteria> [→] workspace</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>assign urxvt 2\r
-assign urxvt → 2\r
-assign "urxvt" → 2\r
-assign "urxvt/VIM" → 3\r
-assign "gecko" → ~4\r
-assign "xv/MPlayer" → ~</tt></pre>\r
+<pre><tt># Assign URxvt terminals to workspace 2\r
+assign [class="URxvt"] 2\r
+\r
+# Same thing, but more precise (exact match instead of substring)\r
+assign [class="^URxvt$"] 2\r
+\r
+# Same thing, but with a beautiful arrow :)\r
+assign [class="^URxvt$"] → 2\r
+\r
+# Assignment to a named workspace\r
+assign [class="^URxvt$"] → work\r
+\r
+# Start urxvt -name irssi\r
+assign [class="^URxvt$" instance="^irssi$"] → 3</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Note that the arrow is not required, it just looks good :-). If you decide to\r
-use it, it has to be a UTF-8 encoded arrow, not "→" or something like that.</p></div>\r
+use it, it has to be a UTF-8 encoded arrow, not <tt>-></tt> or something like that.</p></div>\r
+<div class="paragraph"><p>To get the class and instance, you can use <tt>xprop</tt>. After clicking on the\r
+window, you will see the following output:</p></div>\r
+<div class="paragraph"><p><strong>xprop</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>WM_CLASS(STRING) = "irssi", "URxvt"</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>The first part of the WM_CLASS is the instance ("irssi" in this example), the\r
+second part is the class ("URxvt" in this example).</p></div>\r
+<div class="paragraph"><p>Should you have any problems with assignments, make sure to check the i3\r
+logfile first (see <a href="http://i3wm.org/docs/debugging.html">http://i3wm.org/docs/debugging.html</a>). It includes more\r
+details about the matching process and the window’s actual class, instance and\r
+title when starting up.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_starting_applications_on_i3_startup">3.9. 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 which\r
-commands will be performed by i3 on initial startup (not when restarting i3\r
-in-place however). These commands will be run in order.</p></div>\r
+<h3 id="_automatically_starting_applications_on_i3_startup">4.11. 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><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>exec 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="content">\r
-<pre><tt>exec sudo i3status | dzen2 -dock</tt></pre>\r
+<pre><tt>exec chromium\r
+exec_always ~/my_script.sh\r
+\r
+# Execute the terminal emulator urxvt, which is not yet startup-notification aware.\r
+exec --no-startup-id urxvt</tt></pre>\r
</div></div>\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">3.10. Automatically putting workspaces on specific screens</h3>\r
+<h3 id="workspace_screen">4.12. 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 class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace <number> output <output></tt></pre>\r
+<pre><tt>workspace <workspace> output <output></tt></pre>\r
</div></div>\r
<div class="paragraph"><p>The <em>output</em> is the name of the RandR output you attach your screen to. On a\r
laptop, you might have VGA1 and LVDS1 as output names. You can see the\r
available outputs by running <tt>xrandr --current</tt>.</p></div>\r
+<div class="paragraph"><p>If you use named workspaces, they must be quoted:</p></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>workspace 1 output LVDS1\r
-workspace 5 output VGA1</tt></pre>\r
-</div></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_named_workspaces">3.11. Named workspaces</h3>\r
-<div class="paragraph"><p>If you always have a certain arrangement of workspaces, you might want to give\r
-them names (of course UTF-8 is supported):</p></div>\r
-<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>workspace <number> <name>\r
-workspace <number> output <output> name</tt></pre>\r
-</div></div>\r
-<div class="paragraph"><p>For more details about the <em>output</em> part of this command, see above.</p></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>workspace 1 www\r
-workspace 2 work\r
-workspace 3 i ♥ workspaces</tt></pre>\r
+workspace 5 output VGA1\r
+workspace "2: vim" output VGA1</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_colors">3.12. Changing colors</h3>\r
-<div class="paragraph"><p>You can change all colors which i3 uses to draw the window decorations and the\r
-bottom bar.</p></div>\r
+<h3 id="_changing_colors">4.13. 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
A client which has its urgency hint activated.\r
</p>\r
</dd>\r
-<dt class="hdlist1">\r
-bar.focused\r
-</dt>\r
-<dd>\r
-<p>\r
- The current workspace in the bottom bar.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
-bar.unfocused\r
-</dt>\r
-<dd>\r
-<p>\r
- All other workspaces in the bottom bar.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
-bar.urgent\r
-</dt>\r
-<dd>\r
-<p>\r
- A workspace which has at least one client with an activated urgency hint.\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
used to paint it. If you use a color other than black for your terminals, you\r
most likely want to set the client background color to the same color as your\r
terminal program’s background color to avoid black gaps between the rendered\r
-area of the termianal and the i3 border.</p></div>\r
+area of the terminal and the i3 border.</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</strong>:</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\r
-client.focused #2F343A #900000 #FFFFFF</tt></pre>\r
+<pre><tt># class border backgr. text\r
+client.focused #4c7899 #285577 #ffffff\r
+client.focused_inactive #333333 #5f676a #ffffff\r
+client.unfocused #333333 #222222 #888888\r
+client.urgent #2f343a #900000 #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
</div>\r
<div class="sect2">\r
-<h3 id="_interprocess_communication">3.13. Interprocess communication</h3>\r
+<h3 id="_interprocess_communication">4.14. 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
-<div class="paragraph"><p>To enable it, you have to configure a path where the unix socket will be\r
-stored. The default path is <tt>~/.i3/ipc.sock</tt>.</p></div>\r
+<div class="paragraph"><p>The IPC socket is enabled by default and will be created in\r
+<tt>/tmp/i3-%u.XXXXXX/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username, <tt>%p</tt> is\r
+the PID of i3 and XXXXXX is a string of random characters from the portable\r
+filename character set (see mkdtemp(3)).</p></div>\r
+<div class="paragraph"><p>You can override the default path through the environment-variable <tt>I3SOCK</tt> or\r
+by specifying the <tt>ipc-socket</tt> directive. This is discouraged, though, since i3\r
+does the right thing by default. If you decide to change it, it is strongly\r
+recommended to set this to a location in your home directory so that no other\r
+user can create that directory.</p></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>ipc-socket ~/.i3/ipc.sock</tt></pre>\r
+<pre><tt>ipc-socket ~/.i3/i3-ipc.sock</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>You can then use the <tt>i3-msg</tt> application to perform any command listed in\r
the next section.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_disable_focus_follows_mouse">3.14. Disable focus follows mouse</h3>\r
+<h3 id="_focus_follows_mouse">4.15. Focus follows mouse</h3>\r
<div class="paragraph"><p>If you have a setup where your mouse usually is in your way (like a touchpad\r
on your laptop which you do not want to disable completely), you might want\r
to disable <em>focus follows mouse</em> and control focus only by using your keyboard.\r
<div class="content">\r
<pre><tt>focus_follows_mouse <yes|no></tt></pre>\r
</div></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>focus_follows_mouse no</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_internal_workspace_bar">3.15. Internal workspace bar</h3>\r
-<div class="paragraph"><p>The internal workspace bar (the thing at the bottom of your screen) is very\r
-simple — it does not provide a way to display custom text and it does not\r
-offer advanced customization features. This is intended because we do not\r
-want to duplicate functionality of tools like <tt>dzen2</tt>, <tt>xmobar</tt> and so on\r
-(they render bars, we manage windows). Instead, there is an option which will\r
-turn off the internal bar completely, so that you can use a separate program to\r
-display it (see <tt>i3-wsbar</tt>, a sample implementation of such a program):</p></div>\r
+<h3 id="_popups_during_fullscreen_mode">4.16. 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
+There are two things which are possible to do in this situation:</p></div>\r
+<div class="olist arabic"><ol class="arabic">\r
+<li>\r
+<p>\r
+Just ignore the popup (don’t map it). This won’t interrupt you while you are\r
+ in fullscreen. However, some apps might react badly to this (deadlock until\r
+ you go out of fullscreen).\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+Leave fullscreen mode. This is the default.\r
+</p>\r
+</li>\r
+</ol></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>workspace_bar <yes|no></tt></pre>\r
+<pre><tt>popup_during_fullscreen <ignore|leave_fullscreen></tt></pre>\r
</div></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>popup_during_fullscreen ignore</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_focus_wrapping">4.17. 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
+be set on that container. This is the default behaviour so you can navigate to\r
+all your windows without having to use <tt>focus parent</tt>.</p></div>\r
+<div class="paragraph"><p>If you want the focus to <strong>always</strong> wrap and you are aware of using <tt>focus\r
+parent</tt> to switch to different containers, you can use the\r
+<tt>force_focus_wrapping</tt> configuration directive. After enabling it, the focus\r
+will always wrap.</p></div>\r
+<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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>force_focus_wrapping yes</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_forcing_xinerama">4.18. 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
+inferior Xinerama API explicitly and therefore don’t provide support for\r
+reconfiguring your screens on the fly (they are read only once on startup and\r
+that’s it).</p></div>\r
+<div class="paragraph"><p>For people who do cannot modify their <tt>~/.xsession</tt> to add the\r
+<tt>--force-xinerama</tt> commandline parameter, a configuration option is provided:</p></div>\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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>force_xinerama yes</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Also note that your output names are not descriptive (like <tt>HDMI1</tt>) when using\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.19. 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
+mod+2 because somebody sent you a message. You don’t need to remember where you\r
+came from now, you can just press mod+2 again to switch back to "1: www".</p></div>\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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>workspace_auto_back_and_forth yes</tt></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_configuring_i3bar">5. Configuring i3bar</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>The bar at the bottom of your monitor is drawn by a separate process called\r
+i3bar. Having this part of "the i3 user interface" in a separate process has\r
+several advantages:</p></div>\r
+<div class="olist arabic"><ol class="arabic">\r
+<li>\r
+<p>\r
+It is a modular approach. If you don’t need a workspace bar at all, or if\r
+ you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can\r
+ just remove the i3bar configuration and start your favorite bar instead.\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+It follows the UNIX philosophy of "Make each program do one thing well".\r
+ While i3 manages your windows well, i3bar is good at displaying a bar on\r
+ each monitor (unless you configure it otherwise).\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+It leads to two separate, clean codebases. If you want to understand i3, you\r
+ don’t need to bother with the details of i3bar and vice versa.\r
+</p>\r
+</li>\r
+</ol></div>\r
+<div class="paragraph"><p>That said, i3bar is configured in the same configuration file as i3. This is\r
+because it is tightly coupled with i3 (in contrary to i3lock or i3status which\r
+are useful for people using other window managers). Therefore, it makes no\r
+sense to use a different configuration place when we already have a good\r
+configuration infrastructure in place.</p></div>\r
+<div class="paragraph"><p>Configuring your workspace bar starts with opening a <tt>bar</tt> block. You can have\r
+multiple bar blocks to use different settings for different outputs (monitors):</p></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\r
+}</tt></pre>\r
+</div></div>\r
+<div class="sect2">\r
+<h3 id="_statusline_command">5.1. Statusline command</h3>\r
+<div class="paragraph"><p>i3bar can run a program and display every line of its <tt>stdout</tt> output on the\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
+<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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>status_command i3status --config ~/.i3status.conf</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_display_mode">5.2. Display mode</h3>\r
+<div class="paragraph"><p>You can have i3bar either be visible permanently at one edge of the screen\r
+(<tt>dock</tt> mode) or make it show up when you press your modifier key (<tt>hide</tt>\r
+mode).</p></div>\r
+<div class="paragraph"><p>The hide mode maximizes screen space that can be used for actual windows. Also,\r
+i3bar sends the <tt>SIGSTOP</tt> and <tt>SIGCONT</tt> signals to the statusline process to\r
+save battery power.</p></div>\r
+<div class="paragraph"><p>The default is dock mode.</p></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></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>mode hide</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_position">5.3. Position</h3>\r
+<div class="paragraph"><p>This option determines in which edge of the screen i3bar should show up.</p></div>\r
+<div class="paragraph"><p>The default is bottom.</p></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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>position top</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_output_s">5.4. Output(s)</h3>\r
+<div class="paragraph"><p>You can restrict i3bar to one or more outputs (monitors). The default is to\r
+handle all outputs. Restricting the outputs is useful for using different\r
+options for different outputs by using multiple <em>bar</em> blocks.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>output <output></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># big monitor: everything\r
+bar {\r
+ output HDMI2\r
+ status_command i3status\r
+}\r
+\r
+# laptop monitor: bright colors and i3status with less modules.\r
+bar {\r
+ output LVDS1\r
+ status_command i3status --config ~/.i3status-small.conf\r
+ colors {\r
+ background #000000\r
+ statusline #ffffff\r
+ }\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_tray_output">5.5. Tray output</h3>\r
+<div class="paragraph"><p>i3bar by default provides a system tray area where programs such as\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><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>tray_output <none|output></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># disable system tray\r
+tray_output none\r
+\r
+# show tray icons on the big monitor\r
+tray_output HDMI2</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_font">5.6. Font</h3>\r
+<div class="paragraph"><p>Specifies the font (again, X core font, not Xft, just like in i3) to be used in\r
+the bar.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>font <font></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>font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_workspace_buttons">5.7. 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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>workspace_buttons no</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_colors">5.8. 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
+<dt class="hdlist1">\r
+background\r
+</dt>\r
+<dd>\r
+<p>\r
+ Background color of the bar.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+statusline\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color to be used for the statusline.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color/background color for a workspace button when the workspace\r
+ has focus.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+active_workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color/background color for a workspace button when the workspace\r
+ is active (visible) on some output, but the focus is on another one.\r
+ You can only tell this apart from the focused workspace when you are\r
+ using multiple monitors.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+inactive_workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color/background color for a workspace button when the workspace\r
+ does not have focus and is not active (visible) on any output. This\r
+ will be the case for most workspaces.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+urgent_workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+ Text color/background color for workspaces which contain at least one\r
+ window with the urgency hint set.\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>colors {\r
+ background <color>\r
+ statusline <color>\r
+\r
+ colorclass <foreground> <background>\r
+}</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>workspace_bar no</tt></pre>\r
+<pre><tt>colors {\r
+ background #000000\r
+ statusline #ffffff\r
+\r
+ focused_workspace #ffffff #285577\r
+ active_workspace #ffffff #333333\r
+ inactive_workspace #888888 #222222\r
+ urgent_workspace #ffffff #900000\r
+}</tt></pre>\r
</div></div>\r
</div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_list_of_commands">4. List of commands</h2>\r
+<h2 id="_list_of_commands">6. List of commands</h2>\r
<div class="sectionbody">\r
+<div class="paragraph"><p>Commands are what you bind to specific keypresses. You can also issue commands\r
+at runtime without pressing a key by using the IPC interface. An easy way to\r
+do this is to use the <tt>i3-msg</tt> utility:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\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
+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
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym mod+x move workspace 3; workspace 3</tt></pre>\r
+</div></div>\r
+<div class="paragraph" id="command_criteria"><p>Furthermore, you can change the scope of a command, that is, which containers\r
+should be affected by that command, by using various criteria. These are\r
+prefixed in square brackets to every command. If you want to kill all windows\r
+which have the class Firefox, use:</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+x [class="Firefox"] kill\r
+\r
+# same thing, but case-insensitive\r
+bindsym mod+x [class="(?i)firefox"] kill</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 class="hdlist1">\r
+class\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the window class (the second part of WM_CLASS)\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+instance\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the window instance (the first part of WM_CLASS)\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+window_role\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the window role (WM_WINDOW_ROLE).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+id\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the X11 window ID, which you can get via <tt>xwininfo</tt> for example.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+title\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).\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
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+con_id\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the i3-internal container ID, which you can get via the IPC\r
+ interface. Handy for scripting.\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
+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
+<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
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># Start the GIMP\r
+bindsym mod+g exec gimp\r
+\r
+# Start the terminal emulator urxvt which is not yet startup-notification-aware\r
+bindsym mod+enter exec --no-startup-id urxvt</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>The <tt>--no-startup-id</tt> parameter disables startup-notification support for this\r
+particular exec command. With startup-notification, i3 can make sure that a\r
+window appears on the workspace on which you used the exec command. Also, it\r
+will change the X11 cursor to <tt>watch</tt> (a clock) while the application is\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>\r
+<div class="sect2">\r
+<h3 id="_splitting_containers">6.2. Splitting containers</h3>\r
+<div class="paragraph"><p>The split command makes the current window a split container. Split containers\r
+can contain multiple windows. Every split container has an orientation, it is\r
+either split horizontally (a new window gets placed to the right of the current\r
+one) or vertically (a new window gets placed below the current one).</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).</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
+</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
+</div></div>\r
+</div>\r
<div class="sect2">\r
-<h3 id="_manipulating_layout">4.1. Manipulating layout</h3>\r
-<div class="paragraph"><p>To change the layout of the current container to stacking, use <tt>s</tt>, for default\r
-use <tt>d</tt> and for tabbed, use <tt>T</tt>. To make the current client (!) fullscreen,\r
-use <tt>f</tt>, to make it span all outputs, use <tt>fg</tt>, to make it floating (or\r
-tiling again) use <tt>t</tt>:</p></div>\r
+<h3 id="_manipulating_layout">6.3. Manipulating layout</h3>\r
+<div class="paragraph"><p>Use <tt>layout default</tt>, <tt>layout stacking</tt> or <tt>layout tabbed</tt> to change the\r
+current container layout to default, stacking or tabbed layout, respectively.</p></div>\r
+<div class="paragraph"><p>To make the current window (!) fullscreen, use <tt>fullscreen</tt>, to make\r
+it floating (or tiling again) use <tt>floating enable</tt> respectively <tt>floating disable</tt>\r
+(or <tt>floating toggle</tt>):</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+s s\r
-bindsym Mod1+l d\r
-bindsym Mod1+w T\r
+<pre><tt>bindsym mod+s layout stacking\r
+bindsym mod+l layout default\r
+bindsym mod+w layout tabbed\r
\r
# Toggle fullscreen\r
-bindsym Mod1+f f\r
-\r
-# Toggle global fullscreen\r
-bindsym Mod1+Shift+f fg\r
+bindsym mod+f fullscreen\r
\r
# Toggle floating/tiling\r
-bindsym Mod1+t t</tt></pre>\r
+bindsym mod+t floating toggle</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focusing_moving_snapping_clients_containers_screens">4.2. Focusing/Moving/Snapping clients/containers/screens</h3>\r
-<div class="paragraph"><p>To change the focus, use one of the <tt>h</tt>, <tt>j</tt>, <tt>k</tt> and <tt>l</tt> commands, meaning\r
-left, down, up, right (respectively). To focus a container, prefix it with\r
-<tt>wc</tt>. To focus a screen, prefix it with <tt>ws</tt>.</p></div>\r
-<div class="paragraph"><p>The same principle applies for moving and snapping: just prefix the command\r
-with <tt>m</tt> when moving and with <tt>s</tt> when snapping:</p></div>\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 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
+<div class="dlist"><dl>\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
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+child\r
+</dt>\r
+<dd>\r
+<p>\r
+ The opposite of <tt>focus parent</tt>, sets the focus to the last focused\r
+ child container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+floating\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sets focus to the last focused floating container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+tiling\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sets focus to the last focused tiling container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+mode_toggle\r
+</dt>\r
+<dd>\r
+<p>\r
+ Toggles between floating/tiling containers.\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
+move <left|right|down|up> [<px> px]</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 clients on the left, bottom, top, right:\r
-bindsym Mod1+j h\r
-bindsym Mod1+k j\r
-bindsym Mod1+j k\r
-bindsym Mod1+semicolon l\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+semicolon focus right\r
\r
-# Move client to the left, bottom, top, right:\r
-bindsym Mod1+j mh\r
-bindsym Mod1+k mj\r
-bindsym Mod1+j mk\r
-bindsym Mod1+semicolon ml\r
+# Focus parent container\r
+bindsym mod+u focus parent\r
\r
-# Snap client to the left, bottom, top, right:\r
-bindsym Mod1+j sh\r
-bindsym Mod1+k sj\r
-bindsym Mod1+j sk\r
-bindsym Mod1+semicolon sl\r
+# Focus last floating/tiling container\r
+bindsym mod+g focus mode_toggle\r
\r
-# Focus container on the left, bottom, top, right:\r
-bindsym Mod3+j wch\r
-…</tt></pre>\r
+# 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
+# move more than the default\r
+bindsym mod+j move left 20 px</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_workspaces_moving_clients_to_workspaces">4.3. Changing workspaces/moving clients to workspaces</h3>\r
-<div class="paragraph"><p>To change to a specific workspace, the command is just the number of the\r
-workspace, e.g. <tt>1</tt> or <tt>3</tt>. To move the current client to a specific workspace,\r
-prefix the number with an <tt>m</tt>.</p></div>\r
-<div class="paragraph"><p>You can also switch to the next and previous workspace with the commands <tt>nw</tt>\r
-and <tt>pw</tt>, which is handy, for example, if you have workspace 1, 3, 4 and 9 and\r
-you want to cycle through them with a single key combination.</p></div>\r
+<h3 id="_changing_named_workspaces_moving_to_workspaces">6.5. Changing (named) workspaces/moving to workspaces</h3>\r
+<div class="paragraph"><p>To change to a specific workspace, use the <tt>workspace</tt> command, followed by the\r
+number or name of the workspace. To move containers to specific workspaces, use\r
+<tt>move workspace</tt>.</p></div>\r
+<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
+combination. Similarly, you can use <tt>move workspace next</tt> and <tt>move workspace\r
+prev</tt> to move a container to the next/previous workspace.</p></div>\r
+<div class="paragraph" id="back_and_forth"><p>To switch back to the previously focused workspace, use <tt>workspace\r
+back_and_forth</tt>.</p></div>\r
+<div class="paragraph"><p>To move a container to another xrandr output such as <tt>LVDS1</tt> or <tt>VGA1</tt>, you can\r
+use the <tt>move output</tt> command followed by the name of the target output. You\r
+may also use <tt>left</tt>, <tt>right</tt>, <tt>up</tt>, <tt>down</tt> instead of the xrandr output name to\r
+move to the next output in the specified direction.</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+1 1\r
-bindsym Mod1+2 2\r
+<pre><tt>bindsym mod+1 workspace 1\r
+bindsym mod+2 workspace 2\r
...\r
\r
-bindsym Mod1+Shift+1 m1\r
-bindsym Mod1+Shift+2 m2\r
+bindsym mod+Shift+1 move workspace 1\r
+bindsym mod+Shift+2 move workspace 2\r
...\r
\r
-bindsym Mod1+o nw\r
-bindsym Mod1+p pw</tt></pre>\r
+# switch between the current and the previously focused one\r
+bindsym mod+b workspace back_and_forth</tt></pre>\r
+</div></div>\r
+<div class="sect3">\r
+<h4 id="_named_workspaces">6.5.1. Named workspaces</h4>\r
+<div class="paragraph"><p>Workspaces are identified by their name. So, instead of using numbers in the\r
+workspace command, you can use an arbitrary name:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym mod+1 workspace mail\r
+...</tt></pre>\r
</div></div>\r
+<div class="paragraph"><p>If you want the workspace to have a number <strong>and</strong> a name, just prefix the\r
+number, like this:</p></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym mod+1 workspace 1: mail\r
+bindsym mod+2 workspace 2: www\r
+...</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Note that the workspace will really be named "1: mail". i3 treats workspace\r
+names beginning with a number in a slightly special way. Normally, named\r
+workspaces are ordered the way they appeared. When they start with a number, i3\r
+will order them numerically.</p></div>\r
+</div>\r
</div>\r
<div class="sect2">\r
-<h3 id="resizingconfig">4.4. Resizing columns/rows</h3>\r
-<div class="paragraph"><p>If you want to resize columns/rows using your keyboard, you can use the\r
-<tt>resize</tt> command, I recommend using it inside a so called <tt>mode</tt>:</p></div>\r
+<h3 id="resizingconfig">6.6. 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
+</div></div>\r
+<div class="paragraph"><p>Direction can be one of <tt>up</tt>, <tt>down</tt>, <tt>left</tt> or <tt>right</tt>. The optional pixel\r
+argument specifies by how many pixels a <strong>floating container</strong> should be grown or\r
+shrunk (the default is 10 pixels). The ppt argument means percentage points\r
+and specifies by how many percentage points a <strong>tiling container</strong> should be\r
+grown or shrunk (the 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
# when pressing left, the window is resized so that it has\r
# more space on its left\r
\r
- bindsym n resize left -10\r
- bindsym Shift+n resize left +10\r
+ bindsym j resize shrink left\r
+ bindsym Shift+j resize grow left\r
\r
- bindsym r resize bottom +10\r
- bindsym Shift+r resize bottom -10\r
+ bindsym k resize grow down\r
+ bindsym Shift+k resize shrink down\r
\r
- bindsym t resize top -10\r
- bindsym Shift+t resize top +10\r
+ bindsym l resize shrink up\r
+ bindsym Shift+l resize grow up\r
\r
- bindsym d resize right +10\r
- bindsym Shift+d resize right -10\r
+ bindsym semicolon resize grow right\r
+ bindsym Shift+semicolon resize shrink right\r
\r
- bind 36 mode default\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 Mod1+r mode resize</tt></pre>\r
+bindsym mod+r mode "resize"</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_jumping_to_specific_windows">4.5. Jumping to specific windows</h3>\r
+<h3 id="_jumping_to_specific_windows">6.7. 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
important goal. Instead of figuring out how to navigate to your mailclient,\r
-it would be more convenient to have a shortcut.</p></div>\r
+it would be more convenient to have a shortcut. You can use the <tt>focus</tt> command\r
+with criteria for that.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>jump ["]window class[/window title]["]\r
-jump workspace [ column row ]</tt></pre>\r
+<pre><tt>[class="class"] focus\r
+[title="title"] focus</tt></pre>\r
</div></div>\r
-<div class="paragraph"><p>You can either use the same matching algorithm as in the <tt>assign</tt> command\r
-(see above) or you can specify the position of the client if you always use\r
-the same layout.</p></div>\r
<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt># Get me to the next open VIM instance\r
-bindsym Mod1+a jump "urxvt/VIM"</tt></pre>\r
+bindsym mod+a [class="urxvt" title="VIM"] focus</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_vim_like_marks_mark_goto">4.6. VIM-like marks (mark/goto)</h3>\r
+<h3 id="_vim_like_marks_mark_goto">6.8. 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
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
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>mark <identifier>\r
-goto <identifier></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># Read 1 character and mark the current window with this character\r
-bindsym Mod1+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '\r
-\r
-# Read 1 character and go to the window with the character\r
-bindsym Mod1+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '</tt></pre>\r
-</div></div>\r
-<div class="paragraph"><p>Alternatively, if you do not want to mess with <tt>i3-input</tt>, you could create\r
-seperate bindings for a specific set of labels and then only use those labels.</p></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_traveling_the_focus_stack">4.7. Traveling the focus stack</h3>\r
-<div class="paragraph"><p>This mechanism can be thought of as the opposite of the <tt>jump</tt> command.\r
-It travels the focus stack and jumps to the window which had focus previously.</p></div>\r
-<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>focus [number] | floating | tiling | ft</tt></pre>\r
+<pre><tt>mark identifier\r
+[con_mark="identifier"] focus</tt></pre>\r
</div></div>\r
-<div class="paragraph"><p>Where <tt>number</tt> by default is 1 meaning that the next client in the focus stack\r
-will be selected.</p></div>\r
-<div class="paragraph"><p>The special values have the following meaning:</p></div>\r
-<div class="dlist"><dl>\r
-<dt class="hdlist1">\r
-floating\r
-</dt>\r
-<dd>\r
-<p>\r
- The next floating window is selected.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
-tiling\r
-</dt>\r
-<dd>\r
-<p>\r
- The next tiling window is selected.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
-ft\r
-</dt>\r
-<dd>\r
-<p>\r
- If the current window is floating, the next tiling window will be\r
- selected; and vice-versa.\r
-</p>\r
-</dd>\r
-</dl></div>\r
-</div>\r
-<div class="sect2">\r
-<h3 id="_changing_border_style">4.8. Changing border style</h3>\r
-<div class="paragraph"><p>To change the border of the current client, you can use <tt>bn</tt> to use the normal\r
-border (including window title), <tt>bp</tt> to use a 1-pixel border (no window title)\r
-and <tt>bb</tt> to make the client borderless. There is also <tt>bt</tt> which will toggle\r
-the different border styles.</p></div>\r
-<div class="paragraph"><p><strong>Examples</strong>:</p></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>bindsym Mod1+t bn\r
-bindsym Mod1+y bp\r
-bindsym Mod1+u bb</tt></pre>\r
+<pre><tt>$ i3-msg mark irssi\r
+$ i3-msg '[con_mark="irssi"] focus'</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="stack-limit">4.9. Changing the stack-limit of a container</h3>\r
-<div class="paragraph"><p>If you have a single container with a lot of windows inside it (say, more than\r
-10), the default layout of a stacking container can get a little unhandy.\r
-Depending on your screen’s size, you might end up seeing only half of the\r
-titlebars for each window in the container.</p></div>\r
-<div class="paragraph"><p>Using the <tt>stack-limit</tt> command, you can limit the number of rows or columns\r
-in a stacking container. i3 will create columns or rows (depending on what\r
-you limited) automatically as needed.</p></div>\r
-<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>stack-limit <cols|rows> <value></tt></pre>\r
-</div></div>\r
+<h3 id="_changing_border_style">6.9. 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
+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><strong>Examples</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt># I always want to have two window titles in one line\r
-stack-limit cols 2\r
-\r
-# Not more than 5 rows in this stacking container\r
-stack-limit rows 5</tt></pre>\r
+<pre><tt>bindsym mod+t border normal\r
+bindsym mod+y border 1pixel\r
+bindsym mod+u border none</tt></pre>\r
</div></div>\r
-<div class="paragraph"><p><span class="image">\r
-<img src="stacklimit.png" alt="Container limited to two columns" />\r
-</span></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_reloading_restarting_exiting">4.10. Reloading/Restarting/Exiting</h3>\r
+<h3 id="stack-limit">6.10. 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
-your X session. However, your layout is not preserved at the moment, meaning\r
-that all open windows will end up in a single container in default layout\r
-after the restart. To exit i3 properly, you can use the <tt>exit</tt> command,\r
+your X session. To exit i3 properly, you can use the <tt>exit</tt> command,\r
however you don’t need to (simply killing your X session is fine as well).</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+Shift+r restart\r
-bindsym Mod1+Shift+w reload\r
-bindsym Mod1+Shift+e exit</tt></pre>\r
+<pre><tt>bindsym mod+Shift+r restart\r
+bindsym mod+Shift+w reload\r
+bindsym mod+Shift+e exit</tt></pre>\r
</div></div>\r
</div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="multi_monitor">5. Multiple monitors</h2>\r
+<h2 id="multi_monitor">7. Multiple monitors</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>As you can see in the goal list on the website, i3 was specifically developed\r
with support for multiple monitors in mind. This section will explain how to\r
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">5.1. Configuring your monitors</h3>\r
+<h3 id="_configuring_your_monitors">7.1. Configuring your monitors</h3>\r
<div class="paragraph"><p>To help you get going if you have never used multiple monitors before, here is\r
a short overview of the xrandr options which will probably be of interest to\r
you. It is always useful to get an overview of the current screen configuration.\r
<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">5.2. Interesting configuration for multi-monitor environments</h3>\r
+<h3 id="_interesting_configuration_for_multi_monitor_environments">7.2. Interesting configuration for multi-monitor environments</h3>\r
<div class="paragraph"><p>There are several things to configure in i3 which may be interesting if you\r
have more than one monitor:</p></div>\r
<div class="olist arabic"><ol class="arabic">\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_i3_and_the_rest_of_your_software_world">6. i3 and the rest of your software world</h2>\r
+<h2 id="_i3_and_the_rest_of_your_software_world">8. i3 and the rest of your software world</h2>\r
<div class="sectionbody">\r
<div class="sect2">\r
-<h3 id="_displaying_a_status_line">6.1. Displaying a status line</h3>\r
+<h3 id="_displaying_a_status_line">8.1. Displaying a status line</h3>\r
<div class="paragraph"><p>A very common thing amongst users of exotic window managers is a status line at\r
some corner of the screen. It is an often superior replacement to the widget\r
approach you have in the task bar of a traditional desktop environment.</p></div>\r
<div class="paragraph"><p>If you don’t already have your favorite way of generating such a status line\r
(self-written scripts, conky, …), then i3status is the recommended tool for\r
this task. It was written in C with the goal of using as few syscalls as\r
-possible to reduce the time your CPU is woken up from sleep states.</p></div>\r
-<div class="paragraph"><p>Regardless of which application you use to generate the status line, you\r
-want to make sure that the application does one of the following things:</p></div>\r
-<div class="olist arabic"><ol class="arabic">\r
-<li>\r
-<p>\r
-Register as a dock window using EWMH hints. This will make i3 position the\r
- window above the workspace bar but below every other client. This is the\r
- recommended way, but in case of dzen2, for example, you need to check out\r
- the source of dzen2 from subversion, as the -dock option is not present\r
- in the released versions.\r
-</p>\r
-</li>\r
-<li>\r
-<p>\r
-Overlay the internal workspace bar. This method will not waste any space\r
- on the workspace bar, however, it is rather hackish. Just configure\r
- the output window to be over the workspace bar (say -x 200 and -y 780 if\r
- your screen is 800 px height).\r
-</p>\r
-</li>\r
-</ol></div>\r
-<div class="paragraph"><p>The planned solution for this problem is to make the workspace bar optional\r
-and switch to a third party application completely (dzen2 for example)\r
-which will then contain the workspace bar.</p></div>\r
+possible to reduce the time your CPU is woken up from sleep states. Because\r
+i3status only spits out text, you need to combine it with some other tool, like\r
+i3bar. Use a pipe to connect them: <tt>i3status | i3bar -d</tt>.</p></div>\r
+<div class="paragraph"><p>Regardless of which application you use to display the status line, you\r
+want to make sure that it registers as a dock window using EWMH hints. i3 will\r
+position the window either at the top or at the bottom of the screen, depending\r
+on which hint the application sets. With i3bar, you can use <tt>-d</tt> or <tt>-dbottom</tt>\r
+for positioning it at the bottom and <tt>-dtop</tt> to position it at the top of the\r
+screen.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_giving_presentations_multi_monitor">6.2. Giving presentations (multi-monitor)</h3>\r
+<h3 id="_giving_presentations_multi_monitor">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">6.2.1. Case 1: everybody gets the same output</h4>\r
+<h4 id="presentations">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
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">6.2.2. Case 2: you can see more than your audience</h4>\r
+<h4 id="_case_2_you_can_see_more_than_your_audience">8.2.2. Case 2: you can see more than your audience</h4>\r
<div class="paragraph"><p>This case is a bit harder. First of all, you should configure the VGA output\r
somewhere near your internal flat panel, say right of it:</p></div>\r
<div class="listingblock">\r
projects / i3 / i3.github.io / blobdiff