<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">August 2011</span>\r
+<span id="revdate">April 2012</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 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
+available outputs (the command is <tt>fullscreen global</tt>).</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_opening_other_applications">2.4. Opening other applications</h3>\r
paradigm but can be useful for some corner cases like "Save as" dialog\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 enable floating mode for a window by pressing <tt>mod+Shift+Space</tt>. By\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 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 themselve. In previous versions of i3 we had multiple lists\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
A keysym (key symbol) is a description for a specific symbol, like "a"\r
or "b", but also more strange ones like "underscore" instead of "_". These\r
are the ones you use in Xmodmap to remap your keys. To get the current\r
- mapping of your keys, use <tt>xmodmap -pke</tt>.\r
+ mapping of your keys, use <tt>xmodmap -pke</tt>. To interactively enter a key and\r
+ see what keysym it is configured to, use <tt>xev</tt>.\r
</p>\r
</li>\r
<li>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt># Fullscreen\r
-bindsym mod+f f\r
+bindsym mod+f fullscreen\r
\r
# Restart\r
bindsym mod+Shift+r restart\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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_orientation_for_new_workspaces">4.5. Orientation for new workspaces</h3>\r
+<h3 id="_constraining_floating_window_size">4.5. 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
+<tt>floating_maximum_size</tt> is undefined, or specified as 0, i3 will use a default\r
+value to constrain the maximum size. <tt>floating_minimum_size</tt> is treated in a\r
+manner analogous to <tt>floating_maximum_size</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>floating_minimum_size <width> x <height>\r
+floating_maximum_size <width> x <height></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>floating_minimum_size 75 x 50\r
+floating_maximum_size -1 x -1</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_orientation_for_new_workspaces">4.6. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_layout_mode_for_new_containers">4.6. Layout mode for new containers</h3>\r
+<h3 id="_layout_mode_for_new_containers">4.7. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_border_style_for_new_windows">4.7. Border style for new windows</h3>\r
+<h3 id="_border_style_for_new_windows">4.8. 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 <normal|1pixel|borderless></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></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
+<h3 id="_arbitrary_commands_for_specific_windows_for_window">4.9. 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
# 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">4.9. Variables</h3>\r
+<h3 id="_variables">4.10. 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
<tt>~/.xsession</tt> file).</p></div>\r
</div>\r
<div class="sect2">\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>Specific windows can be matched by window class and/or window title. It is\r
-recommended that you match on window classes instead of window titles whenever\r
-possible because some applications first create their window, and then worry\r
-about setting the correct title. Firefox with Vimperator comes to mind. The\r
-window starts up being named Firefox, and only when Vimperator is loaded does\r
-the title change. As i3 will get the title as soon as the application maps the\r
+<h3 id="_automatically_putting_clients_on_specific_workspaces">4.11. 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>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
<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 → work\r
-assign "urxvt" → 2\r
-assign "urxvt/VIM" → 3\r
-assign "gecko" → 4</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 <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">4.11. Automatically starting applications on i3 startup</h3>\r
+<h3 id="_automatically_starting_applications_on_i3_startup">4.12. 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
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><tt>exec command\r
-exec_always 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 i3status | i3bar -d\r
-exec_always ~/my_script.sh</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">4.12. Automatically putting workspaces on specific screens</h3>\r
+<h3 id="workspace_screen">4.13. 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
+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">4.13. Changing colors</h3>\r
+<h3 id="_changing_colors">4.14. 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</tt></pre>\r
+<pre><tt>colorclass border background text indicator</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Where colorclass can be one of:</p></div>\r
<div class="dlist"><dl>\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 (default colors)</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\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
+<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</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 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
+single windows within a split container, which are otherwise indistinguishable\r
+from single windows outside of a split container.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_interprocess_communication">4.14. Interprocess communication</h3>\r
+<h3 id="_interprocess_communication">4.15. 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>The IPC socket is enabled by default and will be created in\r
-<tt>/tmp/i3-%u/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username and <tt>%p</tt> is the PID\r
-of i3.</p></div>\r
+<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.</p></div>\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 /tmp/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="_focus_follows_mouse">4.15. Focus follows mouse</h3>\r
+<h3 id="_focus_follows_mouse">4.16. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_popups_during_fullscreen_mode">4.16. Popups during fullscreen mode</h3>\r
+<h3 id="_popups_during_fullscreen_mode">4.17. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focus_wrapping">4.17. Focus wrapping</h3>\r
+<h3 id="_focus_wrapping">4.18. 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
<pre><tt>force_focus_wrapping yes</tt></pre>\r
</div></div>\r
</div>\r
+<div class="sect2">\r
+<h3 id="_forcing_xinerama">4.19. 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.20. 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="_i3bar_command">5.1. i3bar command</h3>\r
+<div class="paragraph"><p>By default i3 will just pass <tt>i3bar</tt> and let your shell handle the execution,\r
+searching your <tt>$PATH</tt> for a correct version.\r
+If you have a different <tt>i3bar</tt> somewhere or the binary is not in your <tt>$PATH</tt> you can\r
+tell i3 what to execute.</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>i3bar_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
+ i3bar_command /home/user/bin/i3bar\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="status_command">5.2. 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>bar {\r
+ status_command i3status --config ~/.i3status.conf\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_display_mode">5.3. 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). The modifier key can be configured using the <tt>modifier</tt> option.</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; in hide mode, the default modifier is Mod4 (usually\r
+the windows key).</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>\r
+modifier <Modifier></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
+ mode hide\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>\r
+<div class="sect2">\r
+<h3 id="i3bar_position">5.4. 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>bar {\r
+ position top\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_output_s">5.5. 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>To make a particular i3bar instance handle multiple outputs, specify the output\r
+directive multiple times.</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
+ # The display is connected either via HDMI or via DisplayPort\r
+ output HDMI2\r
+ output DP2\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.6. 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|primary|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
+bar {\r
+ tray_output none\r
+}\r
+\r
+# show tray icons on the primary monitor\r
+tray_output primary\r
+\r
+# show tray icons on the big monitor\r
+bar {\r
+ tray_output HDMI2\r
+}</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>xrandr --output <output> --primary</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_font">5.7. 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>bar {\r
+ font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_workspace_buttons">5.8. 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>bar {\r
+ workspace_buttons no\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_colors">5.9. 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
+ Border, background and text 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
+ Border, background and text 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
+ Border, background and text 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
+ Border, background and text color for a workspace button when the workspace\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 <border> <background> <text>\r
+}</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example (default colors)</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bar {\r
+ colors {\r
+ background #000000\r
+ statusline #ffffff\r
+\r
+ focused_workspace #4c7899 #285577 #ffffff\r
+ active_workspace #333333 #5f676a #ffffff\r
+ inactive_workspace #333333 #222222 #888888\r
+ urgent_workspace #2f343a #900000 #ffffff\r
+ }\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_list_of_commands">5. 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 container to 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
+urgent\r
+</dt>\r
+<dd>\r
+<p>\r
+ Compares the urgent state of the window. Can be "latest" or "oldest".\r
+ Matches the latest or oldest urgent window, respectively.\r
+ (The following aliases are also available: newest, last, recent, first)\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+Return 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">5.1. Splitting containers</h3>\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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_manipulating_layout">5.2. Manipulating layout</h3>\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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focusing_moving_containers">5.3. 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
+<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
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
Toggles between floating/tiling containers.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+output\r
+</dt>\r
+<dd>\r
+<p>\r
+ Followed by a direction or an output name, this will focus the\r
+ corresponding output.\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
+</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
+<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
# Focus last floating/tiling container\r
bindsym mod+g focus mode_toggle\r
\r
-# Move client to the left, bottom, top, right:\r
+# Focus the output right to the current one\r
+bindsym mod+x focus output right\r
+\r
+# Focus the big output\r
+bindsym mod+x focus output HDMI-2\r
+\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</tt></pre>\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\r
+\r
+# Move floating container to the center\r
+# of all outputs\r
+bindsym mod+c move absolute position center</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_named_workspaces_moving_to_workspaces">5.4. Changing (named) workspaces/moving to workspaces</h3>\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
+<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
-combination.</p></div>\r
+combination. To restrict those to the current output, use <tt>workspace\r
+next_on_output</tt> and <tt>workspace prev_on_output</tt>. Similarly, you can use <tt>move\r
+container to workspace next</tt> and <tt>move container to workspace prev</tt> to move a\r
+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 container to output</tt> command followed by the name of the target\r
+output. You may also use <tt>left</tt>, <tt>right</tt>, <tt>up</tt>, <tt>down</tt> instead of the xrandr\r
+output name to move to the next output in the specified direction.</p></div>\r
+<div class="paragraph"><p>To move a whole workspace to another xrandr output such as <tt>LVDS1</tt> or <tt>VGA1</tt>,\r
+you can use the <tt>move workspace to output</tt> command followed by the name of the\r
+target output. You may also use <tt>left</tt>, <tt>right</tt>, <tt>up</tt>, <tt>down</tt> instead of the\r
+xrandr output name to 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
bindsym mod+2 workspace 2\r
...\r
\r
-bindsym mod+Shift+1 move workspace 1\r
-bindsym mod+Shift+2 move workspace 2\r
-...</tt></pre>\r
+bindsym mod+Shift+1 move container to workspace 1\r
+bindsym mod+Shift+2 move container to workspace 2\r
+...\r
+\r
+# switch between the current and the previously focused one\r
+bindsym mod+b workspace back_and_forth\r
+\r
+# move the whole workspace to the next output\r
+bindsym mod+x move workspace to output right</tt></pre>\r
</div></div>\r
<div class="sect3">\r
-<h4 id="_named_workspaces">5.4.1. Named workspaces</h4>\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="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
+will order them numerically. Also, you will be able to use <tt>workspace number 1</tt>\r
+to switch to the workspace which begins with number 1, regardless of which name\r
+it has. This is useful in case you are changing the workspace’s name\r
+dynamically.</p></div>\r
</div>\r
</div>\r
<div class="sect2">\r
-<h3 id="resizingconfig">5.5. Resizing containers/windows</h3>\r
+<h3 id="_renaming_workspaces">6.6. Renaming workspaces</h3>\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.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>rename workspace <old_name> to <new_name></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>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"'</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="resizingconfig">6.7. 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, I recommend using it inside a so called <tt>mode</tt>:</p></div>\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 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
+space from all the other containers. The optional pixel argument specifies by\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
- # They resize the border in the direction you pressed, e.g.\r
- # when pressing left, the window is resized so that it has\r
- # more space on its left\r
-\r
- bindsym j resize shrink left\r
- bindsym Shift+j resize grow left\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
- bindsym k resize grow down\r
- bindsym Shift+k resize shrink down\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
- bindsym l resize shrink up\r
- bindsym Shift+l resize grow up\r
-\r
- bindsym semicolon resize grow right\r
- bindsym Shift+semicolon resize shrink right\r
-\r
- bindcode 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_jumping_to_specific_windows">5.6. Jumping to specific windows</h3>\r
+<h3 id="_jumping_to_specific_windows">6.8. 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">5.7. VIM-like marks (mark/goto)</h3>\r
+<h3 id="_vim_like_marks_mark_goto">6.9. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_border_style">5.8. Changing border style</h3>\r
+<h3 id="_changing_border_style">6.10. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="stack-limit">5.9. Reloading/Restarting/Exiting</h3>\r
+<h3 id="stack-limit">6.11. 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
bindsym mod+Shift+e exit</tt></pre>\r
</div></div>\r
</div>\r
+<div class="sect2">\r
+<h3 id="_scratchpad">6.12. 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
+Instead, when using <tt>scratchpad show</tt>, the window will be shown again, as a\r
+floating window, centered on your current workspace (using <tt>scratchpad show</tt> on\r
+a visible scratchpad window will make it hidden again, so you can have a\r
+keybinding to toggle).</p></div>\r
+<div class="paragraph"><p>As the name indicates, this is useful for having a window with your favorite\r
+editor always at hand. However, you can also use this for other permanently\r
+running applications which you don’t want to see all the time: Your music\r
+player, alsamixer, maybe even your mail client…?</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>move scratchpad\r
+\r
+scratchpad show</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 the currently focused window a scratchpad\r
+bindsym mod+Shift+minus move scratchpad\r
+\r
+# Show the first scratchpad window\r
+bindsym mod+minus scratchpad show\r
+\r
+# Show the sup-mail scratchpad window, if any.\r
+bindsym mod4+s [title="^Sup ::"] scratchpad show</tt></pre>\r
+</div></div>\r
+</div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="multi_monitor">6. 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">6.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">6.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">7. 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">7.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
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. 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
+i3bar. See <a href="#status_command">[status_command]</a> for how to display i3status in i3bar.</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
+on which hint the application sets. With i3bar, you can configure its position,\r
+see <a href="#i3bar_position">[i3bar_position]</a>.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_giving_presentations_multi_monitor">7.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">7.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">7.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