"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
-<link rel="icon" type="image/png" href="/favicon.png">\r
+<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.9" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
<title>i3: i3 User’s Guide</title>\r
<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
<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 (the command is <tt>fullscreen global</tt>).</p></div>\r
+available outputs (the command is <tt>fullscreen toggle global</tt>).</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_opening_other_applications">2.4. Opening other applications</h3>\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>$mod+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>.\r
+By default, a dialog will ask you to confirm if you really want to quit.</p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_floating">2.11. Floating</h3>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt># Fullscreen\r
-bindsym $mod+f fullscreen\r
+bindsym $mod+f fullscreen toggle\r
\r
# Restart\r
bindsym $mod+Shift+r restart\r
</dl></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="floating_modifier">4.4. The floating modifier</h3>\r
+<h3 id="mousebindings">4.4. Mouse bindings</h3>\r
+<div class="paragraph"><p>A mouse binding makes i3 execute a command upon pressing a specific mouse\r
+button in the scope of the clicked container (see <a href="#command_criteria">[command_criteria]</a>). You\r
+can configure mouse bindings in a similar way to key bindings.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bindsym [--release] [--whole-window] [Modifiers+]button[n] command</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>By default, the binding will only run when you click on the titlebar of the\r
+window. If the <tt>--whole-window</tt> flag is given, it will run when any part of the\r
+window is clicked. If the <tt>--release</tt> flag is given, it will run when the mouse\r
+button is released.</p></div>\r
+<div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt># The middle button over a titlebar kills the window\r
+bindsym --release button2 kill\r
+\r
+# The middle button and a modifer over any part of the window kills the window\r
+bindsym --whole-window $mod+button2 kill\r
+\r
+# The right button toggles floating\r
+bindsym button3 floating toggle\r
+bindsym $mod+button3 floating toggle\r
+\r
+# The side buttons move the window around\r
+bindsym button9 move left\r
+bindsym button8 move right</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="floating_modifier">4.5. The floating modifier</h3>\r
<div class="paragraph"><p>To move floating windows with your mouse, you can either grab their titlebar\r
or configure the so called floating modifier which you can then press and\r
click anywhere in the window itself to move it. The most common setup is to\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_constraining_floating_window_size">4.5. Constraining floating window size</h3>\r
+<h3 id="_constraining_floating_window_size">4.6. Constraining floating window size</h3>\r
<div class="paragraph"><p>The maximum and minimum dimensions of floating windows can be specified. If\r
either dimension of <tt>floating_maximum_size</tt> is specified as -1, that dimension\r
will be unconstrained with respect to its maximum value. If either dimension of\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_orientation_for_new_workspaces">4.6. Orientation for new workspaces</h3>\r
+<h3 id="_orientation_for_new_workspaces">4.7. 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.7. Layout mode for new containers</h3>\r
+<h3 id="_layout_mode_for_new_containers">4.8. 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.8. Border style for new windows</h3>\r
+<h3 id="_border_style_for_new_windows">4.9. Border style for new windows</h3>\r
<div class="paragraph"><p>This option determines which border style new windows will have. The default is\r
"normal". Note that new_float applies only to windows which are starting out as\r
floating windows, e.g. dialog windows.</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_hiding_vertical_borders">4.9. Hiding vertical borders</h3>\r
+<h3 id="_hiding_vertical_borders">4.10. Hiding vertical borders</h3>\r
<div class="paragraph"><p>You can hide vertical borders adjacent to the screen edges using\r
<tt>hide_edge_borders</tt>. This is useful if you are using scrollbars, or do not want\r
to waste even two pixels in displayspace. Default is none.</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_arbitrary_commands_for_specific_windows_for_window">4.10. Arbitrary commands for specific windows (for_window)</h3>\r
+<h3 id="_arbitrary_commands_for_specific_windows_for_window">4.11. 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>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.11. Variables</h3>\r
+<h3 id="_variables">4.12. 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
it before starting i3 (for example in your <tt>~/.xsession</tt> file).</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_putting_clients_on_specific_workspaces">4.12. Automatically putting clients on specific workspaces</h3>\r
+<h3 id="_automatically_putting_clients_on_specific_workspaces">4.13. Automatically putting clients on specific workspaces</h3>\r
<div class="paragraph" id="assign_workspace"><p>To automatically make a specific window show up on a specific workspace, you\r
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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_automatically_starting_applications_on_i3_startup">4.13. Automatically starting applications on i3 startup</h3>\r
+<h3 id="_automatically_starting_applications_on_i3_startup">4.14. 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>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.14. Automatically putting workspaces on specific screens</h3>\r
+<h3 id="workspace_screen">4.15. Automatically putting workspaces on specific screens</h3>\r
<div class="paragraph"><p>If you assign clients to workspaces, it might be handy to put the\r
workspaces on specific screens. Also, the assignment of workspaces to screens\r
will determine which workspace i3 uses for a new screen when adding screens\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_changing_colors">4.15. Changing colors</h3>\r
+<h3 id="_changing_colors">4.16. 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
from single windows outside of a split container.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_interprocess_communication">4.16. Interprocess communication</h3>\r
+<h3 id="_interprocess_communication">4.17. Interprocess communication</h3>\r
<div class="paragraph"><p>i3 uses Unix sockets to provide an IPC interface. This allows third-party\r
programs to get information from i3, such as the current workspaces\r
(to display a workspace bar), and to control i3.</p></div>\r
the next section.</p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_focus_follows_mouse">4.17. Focus follows mouse</h3>\r
+<h3 id="_focus_follows_mouse">4.18. Focus follows mouse</h3>\r
<div class="paragraph"><p>By default, window focus follows your mouse movements. However, if you have a\r
setup where your mouse usually is in your way (like a touchpad on your laptop\r
which you do not want to disable completely), you might want to disable <em>focus\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_mouse_warping">4.18. Mouse warping</h3>\r
+<h3 id="_mouse_warping">4.19. Mouse warping</h3>\r
<div class="paragraph"><p>By default, when switching focus to a window on a different output (e.g.\r
focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on\r
LVDS-1), the mouse cursor is warped to the center of that window.</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_popups_during_fullscreen_mode">4.19. Popups during fullscreen mode</h3>\r
+<h3 id="_popups_during_fullscreen_mode">4.20. 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.20. Focus wrapping</h3>\r
+<h3 id="_focus_wrapping">4.21. Focus wrapping</h3>\r
<div class="paragraph"><p>When being in a tabbed or stacked container, the first container will be\r
focused when you use <tt>focus down</tt> on the last container — the focus wraps. If\r
however there is another stacked/tabbed container in that direction, focus will\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_forcing_xinerama">4.21. Forcing Xinerama</h3>\r
+<h3 id="_forcing_xinerama">4.22. 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
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.22. Automatic back-and-forth when switching to the current workspace</h3>\r
+<h3 id="_automatic_back_and_forth_when_switching_to_the_current_workspace">4.23. Automatic back-and-forth when switching to the current workspace</h3>\r
<div class="paragraph"><p>This configuration directive enables automatic <tt>workspace back_and_forth</tt> (see\r
<a href="#back_and_forth">[back_and_forth]</a>) when switching to the workspace that is currently focused.</p></div>\r
<div class="paragraph"><p>For instance: Assume you are on workspace "1: www" and switch to "2: IM" using\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.23. Delaying urgency hint reset on workspace change</h3>\r
+<h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.24. Delaying urgency hint reset on workspace change</h3>\r
<div class="paragraph"><p>If an application on another workspace sets an urgency hint, switching to this\r
workspace may lead to immediate focus of the application, which also means the\r
window decoration color would be immediately reset to <tt>client.focused</tt>. This\r
<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="_bar_id">5.4. Bar ID</h3>\r
+<h3 id="_mouse_button_commands">5.4. Mouse button commands</h3>\r
+<div class="paragraph"><p>Specifies a command to run when a button was pressed on i3bar to override the\r
+default behavior. Currently only the mouse wheel buttons are supported. This is\r
+useful for disabling the scroll wheel action or running scripts that implement\r
+custom behavior for these buttons.</p></div>\r
+<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>wheel_up_cmd <command>\r
+wheel_down_cmd <command></tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>bar {\r
+ wheel_up_cmd nop\r
+ wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_bar_id">5.5. Bar ID</h3>\r
<div class="paragraph"><p>Specifies the bar ID for the configured bar instance. If this option is missing,\r
the ID is set to <em>bar-x</em>, where x corresponds to the position of the embedding\r
bar block in the config file (<em>bar-0</em>, <em>bar-1</em>, …).</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="i3bar_position">5.5. Position</h3>\r
+<h3 id="i3bar_position">5.6. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_output_s">5.6. Output(s)</h3>\r
+<h3 id="_output_s">5.7. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_tray_output">5.7. Tray output</h3>\r
+<h3 id="_tray_output">5.8. 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
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_font">5.8. Font</h3>\r
+<h3 id="_font">5.9. Font</h3>\r
<div class="paragraph"><p>Specifies the font to be used in the bar. See <a href="#fonts">[fonts]</a>.</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_workspace_buttons">5.9. Workspace buttons</h3>\r
+<h3 id="_workspace_buttons">5.10. 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></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_strip_workspace_numbers">5.10. Strip workspace numbers</h3>\r
+<h3 id="_strip_workspace_numbers">5.11. Strip workspace numbers</h3>\r
<div class="paragraph"><p>Specifies whether workspace numbers should be displayed within the workspace\r
buttons. This is useful if you want to have a named workspace that stays in\r
order on the bar according to its number without displaying the number prefix.</p></div>\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_binding_mode_indicator">5.11. Binding Mode indicator</h3>\r
+<h3 id="_binding_mode_indicator">5.12. Binding Mode indicator</h3>\r
<div class="paragraph"><p>Specifies whether the current binding mode indicator should be shown or not.\r
This is useful if you want to hide the workspace buttons but still be able\r
to see the current binding mode indicator.\r
</div></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_colors">5.12. Colors</h3>\r
+<h3 id="_colors">5.13. 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
<div class="paragraph"><p>Use <tt>layout toggle split</tt>, <tt>layout stacking</tt>, <tt>layout tabbed</tt>, <tt>layout splitv</tt>\r
or <tt>layout splith</tt> to change the current container layout to splith/splitv,\r
stacking, tabbed layout, splitv or splith, respectively.</p></div>\r
-<div class="paragraph"><p>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>To make the current window (!) fullscreen, use <tt>fullscreen enable</tt> (or\r
+<tt>fullscreen enable global</tt> for the global mode), to leave either fullscreen\r
+mode use <tt>fullscreen disable</tt>, and to toggle between these two states use\r
+<tt>fullscreen toggle</tt> (or <tt>fullscreen toggle global</tt>).</p></div>\r
+<div class="paragraph"><p>Likewise, to make the current window floating (or tiling again) use <tt>floating\r
+enable</tt> respectively <tt>floating disable</tt> (or <tt>floating toggle</tt>):</p></div>\r
<div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
bindsym $mod+x layout toggle all\r
\r
# Toggle fullscreen\r
-bindsym $mod+f fullscreen\r
+bindsym $mod+f fullscreen toggle\r
\r
# Toggle floating/tiling\r
bindsym $mod+t floating toggle</tt></pre>\r
(the last one makes sense only when used with criteria).</p></div>\r
<div class="paragraph"><p>See <a href="#move_to_outputs">[move_to_outputs]</a> for how to move a container/workspace to a different\r
RandR output.</p></div>\r
+<div class="paragraph"><p>Workspace names are parsed as\r
+<a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>\r
+by i3bar.</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>; likewise, you can move containers to the previously focused\r
workspace using <tt>move container to workspace back_and_forth</tt>.</p></div>\r
<div class="content">\r
<pre><tt>bindsym $mod+1 workspace 1\r
bindsym $mod+2 workspace 2\r
+bindsym $mod+3 workspace 3:<span foreground="red">vim</span>\r
...\r
\r
bindsym $mod+Shift+1 move container to workspace 1\r
projects / i3 / i3.github.io / blobdiff