git.sur5r.net Git - i3/i3.github.io/blob - docs/userguide.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <link rel="icon" type="image/png" href="/favicon.png">\r
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
   7 <meta name="generator" content="AsciiDoc 8.6.7" />\r
   8 <title>i3: i3 User’s Guide</title>\r
   9 <link rel="stylesheet" href="/css/style.css" type="text/css" />\r
  10 <link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
  11 <script type="text/javascript">\r
  12 /*<![CDATA[*/\r
  13 window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}\r
  14 /*]]>*/\r
  15 </script>\r
  16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
  17 </head>\r
  18 <body class="article">\r
  19 \r
  20         <div id="main">\r
  21             <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
  22                         <ul id="nav">\r
  23                                 <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
  24                                 <li><a href="/screenshots">Screens</a></li>\r
  25                                 <li><a href="/contact">Contact</a></li>\r
  26                                 <li><a href="http://bugs.i3wm.org/">Bugs</a></li>\r
  27                         </ul>\r
  28         <br style="clear: both">\r
  29 <div id="content">\r
  30 <div id="header">\r
  31 <h1>i3 User’s Guide</h1>\r
  32 <span id="author">Michael Stapelberg</span><br />\r
  33 <span id="email"><tt>&lt;<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>&gt;</tt></span><br />\r
  34 <span id="revdate">March 2013</span>\r
  35 <div id="toc">
  36   <div id="toctitle">Table of Contents</div>
  37   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
  38 </div>\r
  39 </div>\r
  40 <div id="preamble">\r
  41 <div class="sectionbody">\r
  42 <div class="paragraph"><p>This document contains all the information you need to configure and use the i3\r
  43 window manager. If it does not, please check <a href="http://faq.i3wm.org/">http://faq.i3wm.org/</a> first, then\r
  44 contact us on IRC (preferred) or post your question(s) on the mailing list.</p></div>\r
  45 </div>\r
  46 </div>\r
  47 <div class="sect1">\r
  48 <h2 id="_default_keybindings">1. Default keybindings</h2>\r
  49 <div class="sectionbody">\r
  50 <div class="paragraph"><p>For the "too long; didn’t read" people, here is an overview of the default\r
  51 keybindings (click to see the full size image):</p></div>\r
  52 <div class="paragraph"><p><strong>Keys to use with $mod (Alt):</strong></p></div>\r
  53 <div class="paragraph"><p><span class="image">\r
  54 <a class="image" href="keyboard-layer1.png">\r
  55 <img src="keyboard-layer1.png" alt="Keys to use with $mod (Alt)" width="600" />\r
  56 </a>\r
  57 </span></p></div>\r
  58 <div class="paragraph"><p><strong>Keys to use with Shift+$mod:</strong></p></div>\r
  59 <div class="paragraph"><p><span class="image">\r
  60 <a class="image" href="keyboard-layer2.png">\r
  61 <img src="keyboard-layer2.png" alt="Keys to use with Shift+$mod" width="600" />\r
  62 </a>\r
  63 </span></p></div>\r
  64 <div class="paragraph"><p>The red keys are the modifiers you need to press (by default), the blue keys\r
  65 are your homerow.</p></div>\r
  66 </div>\r
  67 </div>\r
  68 <div class="sect1">\r
  69 <h2 id="_using_i3">2. Using i3</h2>\r
  70 <div class="sectionbody">\r
  71 <div class="paragraph"><p>Throughout this guide, the keyword <tt>$mod</tt> will be used to refer to the\r
  72 configured modifier. This is the Alt key (Mod1) by default, with the Windows\r
  73 key (Mod4) being a popular alternative.</p></div>\r
  74 <div class="sect2">\r
  75 <h3 id="_opening_terminals_and_moving_around">2.1. Opening terminals and moving around</h3>\r
  76 <div class="paragraph"><p>One very basic operation is opening a new terminal. By default, the keybinding\r
  77 for this is $mod+Enter, that is Alt+Enter in the default configuration. By\r
  78 pressing $mod+Enter, a new terminal will be opened.  It will fill the whole\r
  79 space available on your screen.</p></div>\r
  80 <div class="paragraph"><p><span class="image">\r
  81 <img src="single_terminal.png" alt="Single terminal" />\r
  82 </span></p></div>\r
  83 <div class="paragraph"><p>If you now open another terminal, i3 will place it next to the current one,\r
  84 splitting the screen size in half. Depending on your monitor, i3 will put the\r
  85 created window beside the existing window (on wide displays) or below the\r
  86 existing window (rotated displays).</p></div>\r
  87 <div class="paragraph"><p><span class="image">\r
  88 <img src="two_terminals.png" alt="Two terminals" />\r
  89 </span></p></div>\r
  90 <div class="paragraph"><p>To move the focus between the two terminals, you can use the direction keys\r
  91 which you may know from the editor <tt>vi</tt>. However, in i3, your homerow is used\r
  92 for these keys (in <tt>vi</tt>, the keys are shifted to the left by one for\r
  93 compatibility with most keyboard layouts). Therefore, <tt>$mod+J</tt> is left, <tt>$mod+K</tt>\r
  94 is down, <tt>$mod+L</tt> is up and <tt>$mod+;</tt> is right. So, to switch between the\r
  95 terminals, use <tt>$mod+K</tt> or <tt>$mod+L</tt>. Of course, you can also use the arrow keys.</p></div>\r
  96 <div class="paragraph"><p>At the moment, your workspace is split (it contains two terminals) in a\r
  97 specific direction (horizontal by default). Every window can be split\r
  98 horizontally or vertically again, just like the workspace. The terminology is\r
  99 "window" for a container that actually contains an X11 window (like a terminal\r
 100 or browser) and "split container" for containers that consist of one or more\r
 101 windows.</p></div>\r
 102 <div class="paragraph"><p>TODO: picture of the tree</p></div>\r
 103 <div class="paragraph"><p>To split a window vertically, press <tt>$mod+v</tt> before you create the new window.\r
 104 To split it horizontally, press <tt>$mod+h</tt>.</p></div>\r
 105 </div>\r
 106 <div class="sect2">\r
 107 <h3 id="_changing_the_container_layout">2.2. Changing the container layout</h3>\r
 108 <div class="paragraph"><p>A split container can have one of the following layouts:</p></div>\r
 109 <div class="dlist"><dl>\r
 110 <dt class="hdlist1">\r
 111 splith/splitv\r
 112 </dt>\r
 113 <dd>\r
 114 <p>\r
 115 Windows are sized so that every window gets an equal amount of space in the\r
 116 container. splith distributes the windows horizontally (windows are right next\r
 117 to each other), splitv distributes them vertically (windows are on top of each\r
 118 other).\r
 119 </p>\r
 120 </dd>\r
 121 <dt class="hdlist1">\r
 122 stacking\r
 123 </dt>\r
 124 <dd>\r
 125 <p>\r
 126 Only the focused window in the container is displayed. You get a list of\r
 127 windows at the top of the container.\r
 128 </p>\r
 129 </dd>\r
 130 <dt class="hdlist1">\r
 131 tabbed\r
 132 </dt>\r
 133 <dd>\r
 134 <p>\r
 135 The same principle as <tt>stacking</tt>, but the list of windows at the top is only\r
 136 a single line which is vertically split.\r
 137 </p>\r
 138 </dd>\r
 139 </dl></div>\r
 140 <div class="paragraph"><p>To switch modes, press <tt>$mod+e</tt> for splith/splitv (it toggles), <tt>$mod+s</tt> for\r
 141 stacking and <tt>$mod+w</tt> for tabbed.</p></div>\r
 142 <div class="paragraph"><p><span class="image">\r
 143 <img src="modes.png" alt="Container modes" />\r
 144 </span></p></div>\r
 145 </div>\r
 146 <div class="sect2">\r
 147 <h3 id="_toggling_fullscreen_mode_for_a_window">2.3. Toggling fullscreen mode for a window</h3>\r
 148 <div class="paragraph"><p>To display a window in fullscreen mode or to go out of fullscreen mode again,\r
 149 press <tt>$mod+f</tt>.</p></div>\r
 150 <div class="paragraph"><p>There is also a global fullscreen mode in i3 in which the client will span all\r
 151 available outputs (the command is <tt>fullscreen global</tt>).</p></div>\r
 152 </div>\r
 153 <div class="sect2">\r
 154 <h3 id="_opening_other_applications">2.4. Opening other applications</h3>\r
 155 <div class="paragraph"><p>Aside from opening applications from a terminal, you can also use the handy\r
 156 <tt>dmenu</tt> which is opened by pressing <tt>$mod+d</tt> by default. Just type the name\r
 157 (or a part of it) of the application which you want to open. The corresponding\r
 158 application has to be in your <tt>$PATH</tt> for this to work.</p></div>\r
 159 <div class="paragraph"><p>Additionally, if you have applications you open very frequently, you can\r
 160 create a keybinding for starting the application directly. See the section\r
 161 <a href="#configuring">[configuring]</a> for details.</p></div>\r
 162 </div>\r
 163 <div class="sect2">\r
 164 <h3 id="_closing_windows">2.5. Closing windows</h3>\r
 165 <div class="paragraph"><p>If an application does not provide a mechanism for closing (most applications\r
 166 provide a menu, the escape key or a shortcut like <tt>Control+W</tt> to close), you\r
 167 can press <tt>$mod+Shift+q</tt> to kill a window. For applications which support\r
 168 the WM_DELETE protocol, this will correctly close the application (saving\r
 169 any modifications or doing other cleanup). If the application doesn’t support\r
 170 the WM_DELETE protocol your X server will kill the window and the behaviour\r
 171 depends on the application.</p></div>\r
 172 </div>\r
 173 <div class="sect2">\r
 174 <h3 id="_using_workspaces">2.6. Using workspaces</h3>\r
 175 <div class="paragraph"><p>Workspaces are an easy way to group a set of windows. By default, you are on\r
 176 the first workspace, as the bar on the bottom left indicates. To switch to\r
 177 another workspace, press <tt>$mod+num</tt> where <tt>num</tt> is the number of the workspace\r
 178 you want to use. If the workspace does not exist yet, it will be created.</p></div>\r
 179 <div class="paragraph"><p>A common paradigm is to put the web browser on one workspace, communication\r
 180 applications (<tt>mutt</tt>, <tt>irssi</tt>, &#8230;) on another one, and the ones with which you\r
 181 work, on the third one. Of course, there is no need to follow this approach.</p></div>\r
 182 <div class="paragraph"><p>If you have multiple screens, a workspace will be created on each screen at\r
 183 startup. If you open a new workspace, it will be bound to the screen you\r
 184 created it on.  When you switch to a workspace on another screen, i3 will set\r
 185 focus to that screen.</p></div>\r
 186 </div>\r
 187 <div class="sect2">\r
 188 <h3 id="_moving_windows_to_workspaces">2.7. Moving windows to workspaces</h3>\r
 189 <div class="paragraph"><p>To move a window to another workspace, simply press <tt>$mod+Shift+num</tt> where\r
 190 <tt>num</tt> is (like when switching workspaces) the number of the target workspace.\r
 191 Similarly to switching workspaces, the target workspace will be created if\r
 192 it does not yet exist.</p></div>\r
 193 </div>\r
 194 <div class="sect2">\r
 195 <h3 id="_resizing">2.8. Resizing</h3>\r
 196 <div class="paragraph"><p>The easiest way to resize a container is by using the mouse: Grab the border\r
 197 and move it to the wanted size.</p></div>\r
 198 <div class="paragraph"><p>See <a href="#resizingconfig">[resizingconfig]</a> for how to configure i3 to be able to resize\r
 199 columns/rows with your keyboard.</p></div>\r
 200 </div>\r
 201 <div class="sect2">\r
 202 <h3 id="_restarting_i3_inplace">2.9. Restarting i3 inplace</h3>\r
 203 <div class="paragraph"><p>To restart i3 in place (and thus get into a clean state if there is a bug, or\r
 204 to upgrade to a newer version of i3) you can use <tt>$mod+Shift+r</tt>.</p></div>\r
 205 </div>\r
 206 <div class="sect2">\r
 207 <h3 id="_exiting_i3">2.10. Exiting i3</h3>\r
 208 <div class="paragraph"><p>To cleanly exit i3 without killing your X server, you can use <tt>$mod+Shift+e</tt>.</p></div>\r
 209 </div>\r
 210 <div class="sect2">\r
 211 <h3 id="_floating">2.11. Floating</h3>\r
 212 <div class="paragraph"><p>Floating mode is the opposite of tiling mode. The position and size of\r
 213 a window are not managed automatically by i3, but manually by\r
 214 you. Using this mode violates the tiling paradigm but can be useful\r
 215 for some corner cases like "Save as" dialog windows, or toolbar\r
 216 windows (GIMP or similar). Those windows usually set the appropriate\r
 217 hint and are opened in floating mode by default.</p></div>\r
 218 <div class="paragraph"><p>You can toggle floating mode for a window by pressing <tt>$mod+Shift+Space</tt>. By\r
 219 dragging the window’s titlebar with your mouse you can move the window\r
 220 around. By grabbing the borders and moving them you can resize the window. You\r
 221 can also do that by using the <a href="#floating_modifier">[floating_modifier]</a>.</p></div>\r
 222 <div class="paragraph"><p>For resizing floating windows with your keyboard, see <a href="#resizingconfig">[resizingconfig]</a>.</p></div>\r
 223 <div class="paragraph"><p>Floating windows are always on top of tiling windows.</p></div>\r
 224 </div>\r
 225 </div>\r
 226 </div>\r
 227 <div class="sect1">\r
 228 <h2 id="_tree">3. Tree</h2>\r
 229 <div class="sectionbody">\r
 230 <div class="paragraph"><p>i3 stores all information about the X11 outputs, workspaces and layout of the\r
 231 windows on them in a tree. The root node is the X11 root window, followed by\r
 232 the X11 outputs, then dock areas and a content container, then workspaces and\r
 233 finally the windows themselves. In previous versions of i3 we had multiple lists\r
 234 (of outputs, workspaces) and a table for each workspace. That approach turned\r
 235 out to be complicated to use (snapping), understand and implement.</p></div>\r
 236 <div class="sect2">\r
 237 <h3 id="_the_tree_consists_of_containers">3.1. The tree consists of Containers</h3>\r
 238 <div class="paragraph"><p>The building blocks of our tree are so called <tt>Containers</tt>. A <tt>Container</tt> can\r
 239 host a window (meaning an X11 window, one that you can actually see and use,\r
 240 like a browser). Alternatively, it could contain one or more <tt>Containers</tt>. A\r
 241 simple example is the workspace: When you start i3 with a single monitor, a\r
 242 single workspace and you open two terminal windows, you will end up with a tree\r
 243 like this:</p></div>\r
 244 <div class="imageblock" style="float:right;">\r
 245 <div class="content">\r
 246 <img src="tree-layout2.png" alt="layout2" />\r
 247 </div>\r
 248 </div>\r
 249 <div class="imageblock">\r
 250 <div class="content">\r
 251 <img src="tree-shot4.png" alt="shot4" />\r
 252 </div>\r
 253 <div class="title">Figure 1. Two terminals on standard workspace</div>\r
 254 </div>\r
 255 </div>\r
 256 <div class="sect2">\r
 257 <h3 id="_orientation_and_split_containers">3.2. Orientation and Split Containers</h3>\r
 258 <div class="paragraph" id="OrientationSplit"><p>It is only natural to use so-called <tt>Split Containers</tt> in order to build a\r
 259 layout when using a tree as data structure. In i3, every <tt>Container</tt> has an\r
 260 orientation (horizontal, vertical or unspecified) and the orientation depends\r
 261 on the layout the container is in (vertical for splitv and stacking, horizontal\r
 262 for splith and tabbed). So, in our example with the workspace, the default\r
 263 layout of the workspace <tt>Container</tt> is splith (most monitors are widescreen\r
 264 nowadays). If you change the layout to splitv (<tt>$mod+l</tt> in the default config)\r
 265 and <strong>then</strong> open two terminals, i3 will configure your windows like this:</p></div>\r
 266 <div class="imageblock">\r
 267 <div class="content">\r
 268 <img src="tree-shot2.png" alt="shot2" />\r
 269 </div>\r
 270 <div class="title">Figure 2. Vertical Workspace Orientation</div>\r
 271 </div>\r
 272 <div class="paragraph"><p>An interesting new feature of i3 since version 4 is the ability to split anything:\r
 273 Let’s assume you have two terminals on a workspace (with splith layout, that is\r
 274 horizontal orientation), focus is on the right terminal. Now you want to open\r
 275 another terminal window below the current one. If you would just open a new\r
 276 terminal window, it would show up to the right due to the splith layout.\r
 277 Instead, press <tt>$mod+v</tt> to split the container with the splitv layout (to\r
 278 open a <tt>Horizontal Split Container</tt>, use <tt>$mod+h</tt>). Now you can open a new\r
 279 terminal and it will open below the current one:</p></div>\r
 280 <div class="imageblock" style="float:right;">\r
 281 <div class="content">\r
 282 <img src="tree-layout1.png" alt="Layout" />\r
 283 </div>\r
 284 </div>\r
 285 <div class="imageblock">\r
 286 <div class="content">\r
 287 <img src="tree-shot1.png" alt="shot" />\r
 288 </div>\r
 289 <div class="title">Figure 3. Vertical Split Container</div>\r
 290 </div>\r
 291 <div style="clear:both;"></div>\r
 292 <div class="paragraph"><p>You probably guessed it already: There is no limit on how deep your hierarchy\r
 293 of splits can be.</p></div>\r
 294 </div>\r
 295 <div class="sect2">\r
 296 <h3 id="_focus_parent">3.3. Focus parent</h3>\r
 297 <div class="paragraph"><p>Let’s stay with our example from above. We have a terminal on the left and two\r
 298 vertically split terminals on the right, focus is on the bottom right one. When\r
 299 you open a new terminal, it will open below the current one.</p></div>\r
 300 <div class="paragraph"><p>So, how can you open a new terminal window to the <strong>right</strong> of the current one?\r
 301 The solution is to use <tt>focus parent</tt>, which will focus the <tt>Parent Container</tt> of\r
 302 the current <tt>Container</tt>. In this case, you would focus the <tt>Vertical Split\r
 303 Container</tt> which is <strong>inside</strong> the horizontally oriented workspace. Thus, now new\r
 304 windows will be opened to the right of the <tt>Vertical Split Container</tt>:</p></div>\r
 305 <div class="imageblock">\r
 306 <div class="content">\r
 307 <img src="tree-shot3.png" alt="shot3" />\r
 308 </div>\r
 309 <div class="title">Figure 4. Focus parent, then open new terminal</div>\r
 310 </div>\r
 311 </div>\r
 312 <div class="sect2">\r
 313 <h3 id="_implicit_containers">3.4. Implicit containers</h3>\r
 314 <div class="paragraph"><p>In some cases, i3 needs to implicitly create a container to fulfill your\r
 315 command.</p></div>\r
 316 <div class="paragraph"><p>One example is the following scenario: You start i3 with a single monitor and a\r
 317 single workspace on which you open three terminal windows. All these terminal\r
 318 windows are directly attached to one node inside i3’s layout tree, the\r
 319 workspace node. By default, the workspace node’s orientation is <tt>horizontal</tt>.</p></div>\r
 320 <div class="paragraph"><p>Now you move one of these terminals down (<tt>$mod+k</tt> by default). The workspace\r
 321 node’s orientation will be changed to <tt>vertical</tt>. The terminal window you moved\r
 322 down is directly attached to the workspace and appears on the bottom of the\r
 323 screen. A new (horizontal) container was created to accomodate the other two\r
 324 terminal windows. You will notice this when switching to tabbed mode (for\r
 325 example). You would end up having one tab called "another container" and the\r
 326 other one being the terminal window you moved down.</p></div>\r
 327 </div>\r
 328 </div>\r
 329 </div>\r
 330 <div class="sect1">\r
 331 <h2 id="configuring">4. Configuring i3</h2>\r
 332 <div class="sectionbody">\r
 333 <div class="paragraph"><p>This is where the real fun begins ;-). Most things are very dependent on your\r
 334 ideal working environment so we can’t make reasonable defaults for them.</p></div>\r
 335 <div class="paragraph"><p>While not using a programming language for the configuration, i3 stays\r
 336 quite flexible in regards to the things you usually want your window manager\r
 337 to do.</p></div>\r
 338 <div class="paragraph"><p>For example, you can configure bindings to jump to specific windows,\r
 339 you can set specific applications to start on specific workspaces, you can\r
 340 automatically start applications, you can change the colors of i3, and you\r
 341 can bind your keys to do useful things.</p></div>\r
 342 <div class="paragraph"><p>To change the configuration of i3, copy <tt>/etc/i3/config</tt> to <tt>~/.i3/config</tt>\r
 343 (or <tt>~/.config/i3/config</tt> if you like the XDG directory scheme) and edit it\r
 344 with a text editor.</p></div>\r
 345 <div class="paragraph"><p>On first start (and on all following starts, unless you have a configuration\r
 346 file), i3 will offer you to create a configuration file. You can tell the\r
 347 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config\r
 348 file. Also, the created config file will use the key symbols of your current\r
 349 keyboard layout. To start the wizard, use the command <tt>i3-config-wizard</tt>.\r
 350 Please note that you must not have <tt>~/.i3/config</tt>, otherwise the wizard will\r
 351 exit.</p></div>\r
 352 <div class="sect2">\r
 353 <h3 id="_comments">4.1. Comments</h3>\r
 354 <div class="paragraph"><p>It is possible and recommended to use comments in your configuration file to\r
 355 properly document your setup for later reference. Comments are started with\r
 356 a # and can only be used at the beginning of a line:</p></div>\r
 357 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 358 <div class="listingblock">\r
 359 <div class="content">\r
 360 <pre><tt># This is a comment</tt></pre>\r
 361 </div></div>\r
 362 </div>\r
 363 <div class="sect2">\r
 364 <h3 id="fonts">4.2. Fonts</h3>\r
 365 <div class="paragraph"><p>i3 has support for both X core fonts and FreeType fonts (through Pango) to\r
 366 render window titles.</p></div>\r
 367 <div class="paragraph"><p>To generate an X core font description, you can use <tt>xfontsel(1)</tt>. To see\r
 368 special characters (Unicode), you need to use a font which supports the\r
 369 ISO-10646 encoding.</p></div>\r
 370 <div class="paragraph"><p>A FreeType font description is composed by a font family, a style, a weight,\r
 371 a variant, a stretch and a size.\r
 372 FreeType fonts support right-to-left rendering and contain often more\r
 373 Unicode glyphs than X core fonts.</p></div>\r
 374 <div class="paragraph"><p>If i3 cannot open the configured font, it will output an error in the logfile\r
 375 and fall back to a working font.</p></div>\r
 376 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 377 <div class="listingblock">\r
 378 <div class="content">\r
 379 <pre><tt>font &lt;X core font description&gt;\r
 380 font pango:[family list] [style options] [size]</tt></pre>\r
 381 </div></div>\r
 382 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 383 <div class="listingblock">\r
 384 <div class="content">\r
 385 <pre><tt>font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
 386 font pango:DejaVu Sans Mono 10\r
 387 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11\r
 388 font pango:Terminus 11px</tt></pre>\r
 389 </div></div>\r
 390 </div>\r
 391 <div class="sect2">\r
 392 <h3 id="keybindings">4.3. Keyboard bindings</h3>\r
 393 <div class="paragraph"><p>A keyboard binding makes i3 execute a command (see below) upon pressing a\r
 394 specific key. i3 allows you to bind either on keycodes or on keysyms (you can\r
 395 also mix your bindings, though i3 will not protect you from overlapping ones).</p></div>\r
 396 <div class="ulist"><ul>\r
 397 <li>\r
 398 <p>\r
 399 A keysym (key symbol) is a description for a specific symbol, like "a"\r
 400   or "b", but also more strange ones like "underscore" instead of "_". These\r
 401   are the ones you use in Xmodmap to remap your keys. To get the current\r
 402   mapping of your keys, use <tt>xmodmap -pke</tt>. To interactively enter a key and\r
 403   see what keysym it is configured to, use <tt>xev</tt>.\r
 404 </p>\r
 405 </li>\r
 406 <li>\r
 407 <p>\r
 408 Keycodes do not need to have a symbol assigned (handy for custom vendor\r
 409   hotkeys on some notebooks) and they will not change their meaning as you\r
 410   switch to a different keyboard layout (when using <tt>xmodmap</tt>).\r
 411 </p>\r
 412 </li>\r
 413 </ul></div>\r
 414 <div class="paragraph"><p>My recommendation is: If you often switch keyboard layouts but you want to keep\r
 415 your bindings in the same physical location on the keyboard, use keycodes.\r
 416 If you don’t switch layouts, and want a clean and simple config file, use\r
 417 keysyms.</p></div>\r
 418 <div class="paragraph"><p>Some tools (such as <tt>import</tt> or <tt>xdotool</tt>) might be unable to run upon a\r
 419 KeyPress event, because the keyboard/pointer is still grabbed. For these\r
 420 situations, the <tt>--release</tt> flag can be used, which will execute the command\r
 421 after the keys have been released.</p></div>\r
 422 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 423 <div class="listingblock">\r
 424 <div class="content">\r
 425 <pre><tt>bindsym [--release] [Modifiers+]keysym command\r
 426 bindcode [--release] [Modifiers+]keycode command</tt></pre>\r
 427 </div></div>\r
 428 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 429 <div class="listingblock">\r
 430 <div class="content">\r
 431 <pre><tt># Fullscreen\r
 432 bindsym $mod+f fullscreen\r
 433 \r
 434 # Restart\r
 435 bindsym $mod+Shift+r restart\r
 436 \r
 437 # Notebook-specific hotkeys\r
 438 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh\r
 439 \r
 440 # Simulate ctrl+v upon pressing $mod+x\r
 441 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v\r
 442 \r
 443 # Take a screenshot upon pressing $mod+x (select an area)\r
 444 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png</tt></pre>\r
 445 </div></div>\r
 446 <div class="paragraph"><p>Available Modifiers:</p></div>\r
 447 <div class="dlist"><dl>\r
 448 <dt class="hdlist1">\r
 449 Mod1-Mod5, Shift, Control\r
 450 </dt>\r
 451 <dd>\r
 452 <p>\r
 453 Standard modifiers, see <tt>xmodmap(1)</tt>\r
 454 </p>\r
 455 </dd>\r
 456 <dt class="hdlist1">\r
 457 Mode_switch\r
 458 </dt>\r
 459 <dd>\r
 460 <p>\r
 461 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows\r
 462 you to remap capslock (for example) to Mode_switch and use it for both: typing\r
 463 umlauts or special characters <em>and</em> having some comfortably reachable key\r
 464 bindings. For example, when typing, capslock+1 or capslock+2 for switching\r
 465 workspaces is totally convenient. Try it :-).\r
 466 </p>\r
 467 </dd>\r
 468 </dl></div>\r
 469 </div>\r
 470 <div class="sect2">\r
 471 <h3 id="floating_modifier">4.4. The floating modifier</h3>\r
 472 <div class="paragraph"><p>To move floating windows with your mouse, you can either grab their titlebar\r
 473 or configure the so called floating modifier which you can then press and\r
 474 click anywhere in the window itself to move it. The most common setup is to\r
 475 use the same key you use for managing windows (Mod1 for example). Then\r
 476 you can press Mod1, click into a window using your left mouse button, and drag\r
 477 it to the position you want.</p></div>\r
 478 <div class="paragraph"><p>When holding the floating modifier, you can resize a floating window by\r
 479 pressing the right mouse button on it and moving around while holding it. If\r
 480 you hold the shift button as well, the resize will be proportional (the aspect\r
 481 ratio will be preserved).</p></div>\r
 482 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 483 <div class="listingblock">\r
 484 <div class="content">\r
 485 <pre><tt>floating_modifier &lt;Modifiers&gt;</tt></pre>\r
 486 </div></div>\r
 487 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 488 <div class="listingblock">\r
 489 <div class="content">\r
 490 <pre><tt>floating_modifier Mod1</tt></pre>\r
 491 </div></div>\r
 492 </div>\r
 493 <div class="sect2">\r
 494 <h3 id="_constraining_floating_window_size">4.5. Constraining floating window size</h3>\r
 495 <div class="paragraph"><p>The maximum and minimum dimensions of floating windows can be specified. If\r
 496 either dimension of <tt>floating_maximum_size</tt> is specified as -1, that dimension\r
 497 will be unconstrained with respect to its maximum value. If either dimension of\r
 498 <tt>floating_maximum_size</tt> is undefined, or specified as 0, i3 will use a default\r
 499 value to constrain the maximum size. <tt>floating_minimum_size</tt> is treated in a\r
 500 manner analogous to <tt>floating_maximum_size</tt>.</p></div>\r
 501 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 502 <div class="listingblock">\r
 503 <div class="content">\r
 504 <pre><tt>floating_minimum_size &lt;width&gt; x &lt;height&gt;\r
 505 floating_maximum_size &lt;width&gt; x &lt;height&gt;</tt></pre>\r
 506 </div></div>\r
 507 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 508 <div class="listingblock">\r
 509 <div class="content">\r
 510 <pre><tt>floating_minimum_size 75 x 50\r
 511 floating_maximum_size -1 x -1</tt></pre>\r
 512 </div></div>\r
 513 </div>\r
 514 <div class="sect2">\r
 515 <h3 id="_orientation_for_new_workspaces">4.6. Orientation for new workspaces</h3>\r
 516 <div class="paragraph"><p>New workspaces get a reasonable default orientation: Wide-screen monitors\r
 517 (anything wider than high) get horizontal orientation, rotated monitors\r
 518 (anything higher than wide) get vertical orientation.</p></div>\r
 519 <div class="paragraph"><p>With the <tt>default_orientation</tt> configuration directive, you can override that\r
 520 behaviour.</p></div>\r
 521 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 522 <div class="listingblock">\r
 523 <div class="content">\r
 524 <pre><tt>default_orientation &lt;horizontal|vertical|auto&gt;</tt></pre>\r
 525 </div></div>\r
 526 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 527 <div class="listingblock">\r
 528 <div class="content">\r
 529 <pre><tt>default_orientation vertical</tt></pre>\r
 530 </div></div>\r
 531 </div>\r
 532 <div class="sect2">\r
 533 <h3 id="_layout_mode_for_new_containers">4.7. Layout mode for new containers</h3>\r
 534 <div class="paragraph"><p>This option determines in which mode new containers on workspace level will\r
 535 start.</p></div>\r
 536 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 537 <div class="listingblock">\r
 538 <div class="content">\r
 539 <pre><tt>workspace_layout &lt;default|stacking|tabbed&gt;</tt></pre>\r
 540 </div></div>\r
 541 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 542 <div class="listingblock">\r
 543 <div class="content">\r
 544 <pre><tt>workspace_layout tabbed</tt></pre>\r
 545 </div></div>\r
 546 </div>\r
 547 <div class="sect2">\r
 548 <h3 id="_border_style_for_new_windows">4.8. Border style for new windows</h3>\r
 549 <div class="paragraph"><p>This option determines which border style new windows will have. The default is\r
 550 "normal". Note that new_float applies only to windows which are starting out as\r
 551 floating windows, e.g. dialog windows.</p></div>\r
 552 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 553 <div class="listingblock">\r
 554 <div class="content">\r
 555 <pre><tt>new_window &lt;normal|1pixel|none|pixel&gt;\r
 556 new_float &lt;normal|1pixel|none|pixel&gt;</tt></pre>\r
 557 </div></div>\r
 558 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 559 <div class="listingblock">\r
 560 <div class="content">\r
 561 <pre><tt>new_window 1pixel</tt></pre>\r
 562 </div></div>\r
 563 <div class="paragraph"><p>The "normal" and "pixel" border styles support an optional border width in\r
 564 pixels:</p></div>\r
 565 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 566 <div class="listingblock">\r
 567 <div class="content">\r
 568 <pre><tt># The same as new_window none\r
 569 new_window pixel 0\r
 570 \r
 571 # A 3 px border\r
 572 new_window pixel 3</tt></pre>\r
 573 </div></div>\r
 574 </div>\r
 575 <div class="sect2">\r
 576 <h3 id="_hiding_vertical_borders">4.9. Hiding vertical borders</h3>\r
 577 <div class="paragraph"><p>You can hide vertical borders adjacent to the screen edges using\r
 578 <tt>hide_edge_borders</tt>. This is useful if you are using scrollbars, or do not want\r
 579 to waste even two pixels in displayspace. Default is none.</p></div>\r
 580 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 581 <div class="listingblock">\r
 582 <div class="content">\r
 583 <pre><tt>hide_edge_borders &lt;none|vertical|horizontal|both&gt;</tt></pre>\r
 584 </div></div>\r
 585 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 586 <div class="listingblock">\r
 587 <div class="content">\r
 588 <pre><tt>hide_edge_borders vertical</tt></pre>\r
 589 </div></div>\r
 590 </div>\r
 591 <div class="sect2">\r
 592 <h3 id="_arbitrary_commands_for_specific_windows_for_window">4.10. Arbitrary commands for specific windows (for_window)</h3>\r
 593 <div class="paragraph"><p>With the <tt>for_window</tt> command, you can let i3 execute any command when it\r
 594 encounters a specific window. This can be used to set windows to floating or to\r
 595 change their border style, for example.</p></div>\r
 596 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 597 <div class="listingblock">\r
 598 <div class="content">\r
 599 <pre><tt>for_window &lt;criteria&gt; command</tt></pre>\r
 600 </div></div>\r
 601 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 602 <div class="listingblock">\r
 603 <div class="content">\r
 604 <pre><tt># enable floating mode for all XTerm windows\r
 605 for_window [class="XTerm"] floating enable\r
 606 \r
 607 # Make all urxvts use a 1-pixel border:\r
 608 for_window [class="urxvt"] border 1pixel\r
 609 \r
 610 # A less useful, but rather funny example:\r
 611 # makes the window floating as soon as I change\r
 612 # directory to ~/work\r
 613 for_window [title="x200: ~/work"] floating enable</tt></pre>\r
 614 </div></div>\r
 615 <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
 616 </div>\r
 617 <div class="sect2">\r
 618 <h3 id="_variables">4.11. Variables</h3>\r
 619 <div class="paragraph"><p>As you learned in the section about keyboard bindings, you will have\r
 620 to configure lots of bindings containing modifier keys. If you want to save\r
 621 yourself some typing and be able to change the modifier you use later,\r
 622 variables can be handy.</p></div>\r
 623 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 624 <div class="listingblock">\r
 625 <div class="content">\r
 626 <pre><tt>set $name value</tt></pre>\r
 627 </div></div>\r
 628 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 629 <div class="listingblock">\r
 630 <div class="content">\r
 631 <pre><tt>set $m Mod1\r
 632 bindsym $m+Shift+r restart</tt></pre>\r
 633 </div></div>\r
 634 <div class="paragraph"><p>Variables are directly replaced in the file when parsing. There is no fancy\r
 635 handling and there are absolutely no plans to change this. If you need a more\r
 636 dynamic configuration you should create a little script which generates a\r
 637 configuration file and run it before starting i3 (for example in your\r
 638 <tt>~/.xsession</tt> file).</p></div>\r
 639 </div>\r
 640 <div class="sect2">\r
 641 <h3 id="_automatically_putting_clients_on_specific_workspaces">4.12. Automatically putting clients on specific workspaces</h3>\r
 642 <div class="paragraph" id="assign_workspace"><p>To automatically make a specific window show up on a specific workspace, you\r
 643 can use an <strong>assignment</strong>. You can match windows by using any criteria,\r
 644 see <a href="#command_criteria">[command_criteria]</a>. It is recommended that you match on window classes\r
 645 (and instances, when appropriate) instead of window titles whenever possible\r
 646 because some applications first create their window, and then worry about\r
 647 setting the correct title. Firefox with Vimperator comes to mind. The window\r
 648 starts up being named Firefox, and only when Vimperator is loaded does the\r
 649 title change. As i3 will get the title as soon as the application maps the\r
 650 window (mapping means actually displaying it on the screen), you’d need to have\r
 651 to match on <em>Firefox</em> in this case.</p></div>\r
 652 <div class="paragraph"><p>Assignments are processed by i3 in the order in which they appear in the config\r
 653 file. The first one which matches the window wins and later assignments are not\r
 654 considered.</p></div>\r
 655 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 656 <div class="listingblock">\r
 657 <div class="content">\r
 658 <pre><tt>assign &lt;criteria&gt; [→] workspace</tt></pre>\r
 659 </div></div>\r
 660 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 661 <div class="listingblock">\r
 662 <div class="content">\r
 663 <pre><tt># Assign URxvt terminals to workspace 2\r
 664 assign [class="URxvt"] 2\r
 665 \r
 666 # Same thing, but more precise (exact match instead of substring)\r
 667 assign [class="^URxvt$"] 2\r
 668 \r
 669 # Same thing, but with a beautiful arrow :)\r
 670 assign [class="^URxvt$"] → 2\r
 671 \r
 672 # Assignment to a named workspace\r
 673 assign [class="^URxvt$"] → work\r
 674 \r
 675 # Start urxvt -name irssi\r
 676 assign [class="^URxvt$" instance="^irssi$"] → 3</tt></pre>\r
 677 </div></div>\r
 678 <div class="paragraph"><p>Note that the arrow is not required, it just looks good :-). If you decide to\r
 679 use it, it has to be a UTF-8 encoded arrow, not <tt>-&gt;</tt> or something like that.</p></div>\r
 680 <div class="paragraph"><p>To get the class and instance, you can use <tt>xprop</tt>. After clicking on the\r
 681 window, you will see the following output:</p></div>\r
 682 <div class="paragraph"><p><strong>xprop</strong>:</p></div>\r
 683 <div class="listingblock">\r
 684 <div class="content">\r
 685 <pre><tt>WM_CLASS(STRING) = "irssi", "URxvt"</tt></pre>\r
 686 </div></div>\r
 687 <div class="paragraph"><p>The first part of the WM_CLASS is the instance ("irssi" in this example), the\r
 688 second part is the class ("URxvt" in this example).</p></div>\r
 689 <div class="paragraph"><p>Should you have any problems with assignments, make sure to check the i3\r
 690 logfile first (see <a href="http://i3wm.org/docs/debugging.html">http://i3wm.org/docs/debugging.html</a>). It includes more\r
 691 details about the matching process and the window’s actual class, instance and\r
 692 title when starting up.</p></div>\r
 693 <div class="paragraph"><p>Note that if you want to start an application just once on a specific\r
 694 workspace, but you don’t want to assign all instances of it permanently, you\r
 695 can make use of i3’s startup-notification support (see <a href="#exec">[exec]</a>) in your config\r
 696 file in the following way:</p></div>\r
 697 <div class="paragraph"><p><strong>Start iceweasel on workspace 3 (once)</strong>:</p></div>\r
 698 <div class="listingblock">\r
 699 <div class="content">\r
 700 <pre><tt># Start iceweasel on workspace 3, then switch back to workspace 1\r
 701 # (Being a command-line utility, i3-msg does not support startup notifications,\r
 702 #  hence the exec --no-startup-id.)\r
 703 # (Starting iceweasel with i3’s exec command is important in order to make i3\r
 704 #  create a startup notification context, without which the iceweasel window(s)\r
 705 #  cannot be matched onto the workspace on which the command was started.)\r
 706 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'</tt></pre>\r
 707 </div></div>\r
 708 </div>\r
 709 <div class="sect2">\r
 710 <h3 id="_automatically_starting_applications_on_i3_startup">4.13. Automatically starting applications on i3 startup</h3>\r
 711 <div class="paragraph"><p>By using the <tt>exec</tt> keyword outside a keybinding, you can configure\r
 712 which commands will be performed by i3 on initial startup. <tt>exec</tt>\r
 713 commands will not run when restarting i3, if you need a command to run\r
 714 also when restarting i3 you should use the <tt>exec_always</tt>\r
 715 keyword. These commands will be run in order.</p></div>\r
 716 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 717 <div class="listingblock">\r
 718 <div class="content">\r
 719 <pre><tt>exec [--no-startup-id] command\r
 720 exec_always [--no-startup-id] command</tt></pre>\r
 721 </div></div>\r
 722 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 723 <div class="listingblock">\r
 724 <div class="content">\r
 725 <pre><tt>exec chromium\r
 726 exec_always ~/my_script.sh\r
 727 \r
 728 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.\r
 729 exec --no-startup-id urxvt</tt></pre>\r
 730 </div></div>\r
 731 <div class="paragraph"><p>The flag --no-startup-id is explained in <a href="#exec">[exec]</a>.</p></div>\r
 732 </div>\r
 733 <div class="sect2">\r
 734 <h3 id="workspace_screen">4.14. Automatically putting workspaces on specific screens</h3>\r
 735 <div class="paragraph"><p>If you assign clients to workspaces, it might be handy to put the\r
 736 workspaces on specific screens. Also, the assignment of workspaces to screens\r
 737 will determine which workspace i3 uses for a new screen when adding screens\r
 738 or when starting (e.g., by default it will use 1 for the first screen, 2 for\r
 739 the second screen and so on).</p></div>\r
 740 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 741 <div class="listingblock">\r
 742 <div class="content">\r
 743 <pre><tt>workspace &lt;workspace&gt; output &lt;output&gt;</tt></pre>\r
 744 </div></div>\r
 745 <div class="paragraph"><p>The <em>output</em> is the name of the RandR output you attach your screen to. On a\r
 746 laptop, you might have VGA1 and LVDS1 as output names. You can see the\r
 747 available outputs by running <tt>xrandr --current</tt>.</p></div>\r
 748 <div class="paragraph"><p>If you use named workspaces, they must be quoted:</p></div>\r
 749 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 750 <div class="listingblock">\r
 751 <div class="content">\r
 752 <pre><tt>workspace 1 output LVDS1\r
 753 workspace 5 output VGA1\r
 754 workspace "2: vim" output VGA1</tt></pre>\r
 755 </div></div>\r
 756 </div>\r
 757 <div class="sect2">\r
 758 <h3 id="_changing_colors">4.15. Changing colors</h3>\r
 759 <div class="paragraph"><p>You can change all colors which i3 uses to draw the window decorations.</p></div>\r
 760 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 761 <div class="listingblock">\r
 762 <div class="content">\r
 763 <pre><tt>colorclass border background text indicator</tt></pre>\r
 764 </div></div>\r
 765 <div class="paragraph"><p>Where colorclass can be one of:</p></div>\r
 766 <div class="dlist"><dl>\r
 767 <dt class="hdlist1">\r
 768 client.focused\r
 769 </dt>\r
 770 <dd>\r
 771 <p>\r
 772         A client which currently has the focus.\r
 773 </p>\r
 774 </dd>\r
 775 <dt class="hdlist1">\r
 776 client.focused_inactive\r
 777 </dt>\r
 778 <dd>\r
 779 <p>\r
 780         A client which is the focused one of its container, but it does not have\r
 781         the focus at the moment.\r
 782 </p>\r
 783 </dd>\r
 784 <dt class="hdlist1">\r
 785 client.unfocused\r
 786 </dt>\r
 787 <dd>\r
 788 <p>\r
 789         A client which is not the focused one of its container.\r
 790 </p>\r
 791 </dd>\r
 792 <dt class="hdlist1">\r
 793 client.urgent\r
 794 </dt>\r
 795 <dd>\r
 796 <p>\r
 797         A client which has its urgency hint activated.\r
 798 </p>\r
 799 </dd>\r
 800 </dl></div>\r
 801 <div class="paragraph"><p>You can also specify the color to be used to paint the background of the client\r
 802 windows. This color will be used to paint the window on top of which the client\r
 803 will be rendered.</p></div>\r
 804 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 805 <div class="listingblock">\r
 806 <div class="content">\r
 807 <pre><tt>client.background color</tt></pre>\r
 808 </div></div>\r
 809 <div class="paragraph"><p>Only clients that do not cover the whole area of this window expose the color\r
 810 used to paint it.</p></div>\r
 811 <div class="paragraph"><p>Colors are in HTML hex format (#rrggbb), see the following example:</p></div>\r
 812 <div class="paragraph"><p><strong>Examples (default colors)</strong>:</p></div>\r
 813 <div class="listingblock">\r
 814 <div class="content">\r
 815 <pre><tt># class                 border  backgr. text    indicator\r
 816 client.focused          #4c7899 #285577 #ffffff #2e9ef4\r
 817 client.focused_inactive #333333 #5f676a #ffffff #484e50\r
 818 client.unfocused        #333333 #222222 #888888 #292d2e\r
 819 client.urgent           #2f343a #900000 #ffffff #900000</tt></pre>\r
 820 </div></div>\r
 821 <div class="paragraph"><p>Note that for the window decorations, the color around the child window is the\r
 822 background color, and the border color is only the two thin lines at the top of\r
 823 the window.</p></div>\r
 824 <div class="paragraph"><p>The indicator color is used for indicating where a new window will be opened.\r
 825 For horizontal split containers, the right border will be painted in indicator\r
 826 color, for vertical split containers, the bottom border. This only applies to\r
 827 single windows within a split container, which are otherwise indistinguishable\r
 828 from single windows outside of a split container.</p></div>\r
 829 </div>\r
 830 <div class="sect2">\r
 831 <h3 id="_interprocess_communication">4.16. Interprocess communication</h3>\r
 832 <div class="paragraph"><p>i3 uses Unix sockets to provide an IPC interface. This allows third-party\r
 833 programs to get information from i3, such as the current workspaces\r
 834 (to display a workspace bar), and to control i3.</p></div>\r
 835 <div class="paragraph"><p>The IPC socket is enabled by default and will be created in\r
 836 <tt>/tmp/i3-%u.XXXXXX/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username, <tt>%p</tt> is\r
 837 the PID of i3 and XXXXXX is a string of random characters from the portable\r
 838 filename character set (see mkdtemp(3)).</p></div>\r
 839 <div class="paragraph"><p>You can override the default path through the environment-variable <tt>I3SOCK</tt> or\r
 840 by specifying the <tt>ipc-socket</tt> directive. This is discouraged, though, since i3\r
 841 does the right thing by default. If you decide to change it, it is strongly\r
 842 recommended to set this to a location in your home directory so that no other\r
 843 user can create that directory.</p></div>\r
 844 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
 845 <div class="listingblock">\r
 846 <div class="content">\r
 847 <pre><tt>ipc-socket ~/.i3/i3-ipc.sock</tt></pre>\r
 848 </div></div>\r
 849 <div class="paragraph"><p>You can then use the <tt>i3-msg</tt> application to perform any command listed in\r
 850 the next section.</p></div>\r
 851 </div>\r
 852 <div class="sect2">\r
 853 <h3 id="_focus_follows_mouse">4.17. Focus follows mouse</h3>\r
 854 <div class="paragraph"><p>By default, window focus follows your mouse movements. However, if you have a\r
 855 setup where your mouse usually is in your way (like a touchpad on your laptop\r
 856 which you do not want to disable completely), you might want to disable <em>focus\r
 857 follows mouse</em> and control focus only by using your keyboard.  The mouse will\r
 858 still be useful inside the currently active window (for example to click on\r
 859 links in your browser window).</p></div>\r
 860 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 861 <div class="listingblock">\r
 862 <div class="content">\r
 863 <pre><tt>focus_follows_mouse &lt;yes|no&gt;</tt></pre>\r
 864 </div></div>\r
 865 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 866 <div class="listingblock">\r
 867 <div class="content">\r
 868 <pre><tt>focus_follows_mouse no</tt></pre>\r
 869 </div></div>\r
 870 </div>\r
 871 <div class="sect2">\r
 872 <h3 id="_popups_during_fullscreen_mode">4.18. Popups during fullscreen mode</h3>\r
 873 <div class="paragraph"><p>When you are in fullscreen mode, some applications still open popup windows\r
 874 (take Xpdf for example). This is because these applications may not be aware\r
 875 that they are in fullscreen mode (they do not check the corresponding hint).\r
 876 There are three things which are possible to do in this situation:</p></div>\r
 877 <div class="olist arabic"><ol class="arabic">\r
 878 <li>\r
 879 <p>\r
 880 Display the popup if it belongs to the fullscreen application only. This is\r
 881    the default and should be reasonable behavior for most users.\r
 882 </p>\r
 883 </li>\r
 884 <li>\r
 885 <p>\r
 886 Just ignore the popup (don’t map it). This won’t interrupt you while you are\r
 887    in fullscreen. However, some apps might react badly to this (deadlock until\r
 888    you go out of fullscreen).\r
 889 </p>\r
 890 </li>\r
 891 <li>\r
 892 <p>\r
 893 Leave fullscreen mode.\r
 894 </p>\r
 895 </li>\r
 896 </ol></div>\r
 897 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 898 <div class="listingblock">\r
 899 <div class="content">\r
 900 <pre><tt>popup_during_fullscreen &lt;smart|ignore|leave_fullscreen&gt;</tt></pre>\r
 901 </div></div>\r
 902 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 903 <div class="listingblock">\r
 904 <div class="content">\r
 905 <pre><tt>popup_during_fullscreen smart</tt></pre>\r
 906 </div></div>\r
 907 </div>\r
 908 <div class="sect2">\r
 909 <h3 id="_focus_wrapping">4.19. Focus wrapping</h3>\r
 910 <div class="paragraph"><p>When being in a tabbed or stacked container, the first container will be\r
 911 focused when you use <tt>focus down</tt> on the last container&#8201;&#8212;&#8201;the focus wraps. If\r
 912 however there is another stacked/tabbed container in that direction, focus will\r
 913 be set on that container. This is the default behaviour so you can navigate to\r
 914 all your windows without having to use <tt>focus parent</tt>.</p></div>\r
 915 <div class="paragraph"><p>If you want the focus to <strong>always</strong> wrap and you are aware of using <tt>focus\r
 916 parent</tt> to switch to different containers, you can use the\r
 917 <tt>force_focus_wrapping</tt> configuration directive. After enabling it, the focus\r
 918 will always wrap.</p></div>\r
 919 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 920 <div class="listingblock">\r
 921 <div class="content">\r
 922 <pre><tt>force_focus_wrapping &lt;yes|no&gt;</tt></pre>\r
 923 </div></div>\r
 924 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 925 <div class="listingblock">\r
 926 <div class="content">\r
 927 <pre><tt>force_focus_wrapping yes</tt></pre>\r
 928 </div></div>\r
 929 </div>\r
 930 <div class="sect2">\r
 931 <h3 id="_forcing_xinerama">4.20. Forcing Xinerama</h3>\r
 932 <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
 933 video drivers (especially the nVidia binary driver) only provide support for\r
 934 Xinerama instead of RandR. In such a situation, i3 must be told to use the\r
 935 inferior Xinerama API explicitly and therefore don’t provide support for\r
 936 reconfiguring your screens on the fly (they are read only once on startup and\r
 937 that’s it).</p></div>\r
 938 <div class="paragraph"><p>For people who do cannot modify their <tt>~/.xsession</tt> to add the\r
 939 <tt>--force-xinerama</tt> commandline parameter, a configuration option is provided:</p></div>\r
 940 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 941 <div class="listingblock">\r
 942 <div class="content">\r
 943 <pre><tt>force_xinerama &lt;yes|no&gt;</tt></pre>\r
 944 </div></div>\r
 945 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 946 <div class="listingblock">\r
 947 <div class="content">\r
 948 <pre><tt>force_xinerama yes</tt></pre>\r
 949 </div></div>\r
 950 <div class="paragraph"><p>Also note that your output names are not descriptive (like <tt>HDMI1</tt>) when using\r
 951 Xinerama, instead they are counted up, starting at 0: <tt>xinerama-0</tt>, <tt>xinerama-1</tt>, …</p></div>\r
 952 </div>\r
 953 <div class="sect2">\r
 954 <h3 id="_automatic_back_and_forth_when_switching_to_the_current_workspace">4.21. Automatic back-and-forth when switching to the current workspace</h3>\r
 955 <div class="paragraph"><p>This configuration directive enables automatic <tt>workspace back_and_forth</tt> (see\r
 956 <a href="#back_and_forth">[back_and_forth]</a>) when switching to the workspace that is currently focused.</p></div>\r
 957 <div class="paragraph"><p>For instance: Assume you are on workspace "1: www" and switch to "2: IM" using\r
 958 mod+2 because somebody sent you a message. You don’t need to remember where you\r
 959 came from now, you can just press $mod+2 again to switch back to "1: www".</p></div>\r
 960 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 961 <div class="listingblock">\r
 962 <div class="content">\r
 963 <pre><tt>workspace_auto_back_and_forth &lt;yes|no&gt;</tt></pre>\r
 964 </div></div>\r
 965 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 966 <div class="listingblock">\r
 967 <div class="content">\r
 968 <pre><tt>workspace_auto_back_and_forth yes</tt></pre>\r
 969 </div></div>\r
 970 </div>\r
 971 <div class="sect2">\r
 972 <h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.22. Delaying urgency hint reset on workspace change</h3>\r
 973 <div class="paragraph"><p>If an application on another workspace sets an urgency hint, switching to this\r
 974 workspace may lead to immediate focus of the application, which also means the\r
 975 window decoration color would be immediately resetted to <tt>client.focused</tt>. This\r
 976 may make it unnecessarily hard to tell which window originally raised the\r
 977 event.</p></div>\r
 978 <div class="paragraph"><p>In order to prevent this, you can tell i3 to delay resetting the urgency state\r
 979 by a certain time using the <tt>force_display_urgency_hint</tt> directive. Setting the\r
 980 value to 0 disables this feature.</p></div>\r
 981 <div class="paragraph"><p>The default is 500ms.</p></div>\r
 982 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 983 <div class="listingblock">\r
 984 <div class="content">\r
 985 <pre><tt>force_display_urgency_hint &lt;timeout&gt; ms</tt></pre>\r
 986 </div></div>\r
 987 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 988 <div class="listingblock">\r
 989 <div class="content">\r
 990 <pre><tt>force_display_urgency_hint 500 ms</tt></pre>\r
 991 </div></div>\r
 992 </div>\r
 993 </div>\r
 994 </div>\r
 995 <div class="sect1">\r
 996 <h2 id="_configuring_i3bar">5. Configuring i3bar</h2>\r
 997 <div class="sectionbody">\r
 998 <div class="paragraph"><p>The bar at the bottom of your monitor is drawn by a separate process called\r
 999 i3bar. Having this part of "the i3 user interface" in a separate process has\r
1000 several advantages:</p></div>\r
1001 <div class="olist arabic"><ol class="arabic">\r
1002 <li>\r
1003 <p>\r
1004 It is a modular approach. If you don’t need a workspace bar at all, or if\r
1005    you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can\r
1006    just remove the i3bar configuration and start your favorite bar instead.\r
1007 </p>\r
1008 </li>\r
1009 <li>\r
1010 <p>\r
1011 It follows the UNIX philosophy of "Make each program do one thing well".\r
1012    While i3 manages your windows well, i3bar is good at displaying a bar on\r
1013    each monitor (unless you configure it otherwise).\r
1014 </p>\r
1015 </li>\r
1016 <li>\r
1017 <p>\r
1018 It leads to two separate, clean codebases. If you want to understand i3, you\r
1019    don’t need to bother with the details of i3bar and vice versa.\r
1020 </p>\r
1021 </li>\r
1022 </ol></div>\r
1023 <div class="paragraph"><p>That said, i3bar is configured in the same configuration file as i3. This is\r
1024 because it is tightly coupled with i3 (in contrary to i3lock or i3status which\r
1025 are useful for people using other window managers). Therefore, it makes no\r
1026 sense to use a different configuration place when we already have a good\r
1027 configuration infrastructure in place.</p></div>\r
1028 <div class="paragraph"><p>Configuring your workspace bar starts with opening a <tt>bar</tt> block. You can have\r
1029 multiple bar blocks to use different settings for different outputs (monitors):</p></div>\r
1030 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1031 <div class="listingblock">\r
1032 <div class="content">\r
1033 <pre><tt>bar {\r
1034     status_command i3status\r
1035 }</tt></pre>\r
1036 </div></div>\r
1037 <div class="sect2">\r
1038 <h3 id="_i3bar_command">5.1. i3bar command</h3>\r
1039 <div class="paragraph"><p>By default i3 will just pass <tt>i3bar</tt> and let your shell handle the execution,\r
1040 searching your <tt>$PATH</tt> for a correct version.\r
1041 If you have a different <tt>i3bar</tt> somewhere or the binary is not in your <tt>$PATH</tt> you can\r
1042 tell i3 what to execute.</p></div>\r
1043 <div class="paragraph"><p>The specified command will be passed to <tt>sh -c</tt>, so you can use globbing and\r
1044 have to have correct quoting etc.</p></div>\r
1045 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1046 <div class="listingblock">\r
1047 <div class="content">\r
1048 <pre><tt>i3bar_command command</tt></pre>\r
1049 </div></div>\r
1050 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1051 <div class="listingblock">\r
1052 <div class="content">\r
1053 <pre><tt>bar {\r
1054     i3bar_command /home/user/bin/i3bar\r
1055 }</tt></pre>\r
1056 </div></div>\r
1057 </div>\r
1058 <div class="sect2">\r
1059 <h3 id="status_command">5.2. Statusline command</h3>\r
1060 <div class="paragraph"><p>i3bar can run a program and display every line of its <tt>stdout</tt> output on the\r
1061 right hand side of the bar. This is useful to display system information like\r
1062 your current IP address, battery status or date/time.</p></div>\r
1063 <div class="paragraph"><p>The specified command will be passed to <tt>sh -c</tt>, so you can use globbing and\r
1064 have to have correct quoting etc.</p></div>\r
1065 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1066 <div class="listingblock">\r
1067 <div class="content">\r
1068 <pre><tt>status_command command</tt></pre>\r
1069 </div></div>\r
1070 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1071 <div class="listingblock">\r
1072 <div class="content">\r
1073 <pre><tt>bar {\r
1074     status_command i3status --config ~/.i3status.conf\r
1075 }</tt></pre>\r
1076 </div></div>\r
1077 </div>\r
1078 <div class="sect2">\r
1079 <h3 id="_display_mode">5.3. Display mode</h3>\r
1080 <div class="paragraph"><p>You can either have i3bar be visible permanently at one edge of the screen\r
1081 (<tt>dock</tt> mode) or make it show up when you press your modifier key (<tt>hide</tt> mode).\r
1082 It is also possible to force i3bar to always stay hidden (<tt>invisible</tt>\r
1083 mode). The modifier key can be configured using the <tt>modifier</tt> option.</p></div>\r
1084 <div class="paragraph"><p>The mode option can be changed during runtime through the <tt>bar mode</tt> command.\r
1085 On reload the mode will be reverted to its configured value.</p></div>\r
1086 <div class="paragraph"><p>The hide mode maximizes screen space that can be used for actual windows. Also,\r
1087 i3bar sends the <tt>SIGSTOP</tt> and <tt>SIGCONT</tt> signals to the statusline process to\r
1088 save battery power.</p></div>\r
1089 <div class="paragraph"><p>Invisible mode allows to permanently maximize screen space, as the bar is never\r
1090 shown. Thus, you can configure i3bar to not disturb you by popping up because\r
1091 of an urgency hint or because the modifier key is pressed.</p></div>\r
1092 <div class="paragraph"><p>In order to control whether i3bar is hidden or shown in hide mode, there exists\r
1093 the hidden_state option, which has no effect in dock mode or invisible mode. It\r
1094 indicates the current hidden_state of the bar: (1) The bar acts like in normal\r
1095 hide mode, it is hidden and is only unhidden in case of urgency hints or by\r
1096 pressing the modifier key (<tt>hide</tt> state), or (2) it is drawn on top of the\r
1097 currently visible workspace (<tt>show</tt> state).</p></div>\r
1098 <div class="paragraph"><p>Like the mode, the hidden_state can also be controlled through i3, this can be\r
1099 done by using the <tt>bar hidden_state</tt> command.</p></div>\r
1100 <div class="paragraph"><p>The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually\r
1101 the windows key). The default value for the hidden_state is hide.</p></div>\r
1102 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1103 <div class="listingblock">\r
1104 <div class="content">\r
1105 <pre><tt>mode &lt;dock|hide|invisible&gt;\r
1106 hidden_state &lt;hide|show&gt;\r
1107 modifier &lt;Modifier&gt;</tt></pre>\r
1108 </div></div>\r
1109 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1110 <div class="listingblock">\r
1111 <div class="content">\r
1112 <pre><tt>bar {\r
1113     mode hide\r
1114     hidden_state hide\r
1115     modifier Mod1\r
1116 }</tt></pre>\r
1117 </div></div>\r
1118 <div class="paragraph"><p>Available modifiers are Mod1-Mod5, Shift, Control (see <tt>xmodmap(1)</tt>).</p></div>\r
1119 </div>\r
1120 <div class="sect2">\r
1121 <h3 id="_bar_id">5.4. Bar ID</h3>\r
1122 <div class="paragraph"><p>Specifies the bar ID for the configured bar instance. If this option is missing,\r
1123 the ID is set to <em>bar-x</em>, where x corresponds to the position of the embedding\r
1124 bar block in the config file (<em>bar-0</em>, <em>bar-1</em>, &#8230;).</p></div>\r
1125 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1126 <div class="listingblock">\r
1127 <div class="content">\r
1128 <pre><tt>id &lt;bar_id&gt;</tt></pre>\r
1129 </div></div>\r
1130 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1131 <div class="listingblock">\r
1132 <div class="content">\r
1133 <pre><tt>bar {\r
1134     id bar-1\r
1135 }</tt></pre>\r
1136 </div></div>\r
1137 </div>\r
1138 <div class="sect2">\r
1139 <h3 id="i3bar_position">5.5. Position</h3>\r
1140 <div class="paragraph"><p>This option determines in which edge of the screen i3bar should show up.</p></div>\r
1141 <div class="paragraph"><p>The default is bottom.</p></div>\r
1142 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1143 <div class="listingblock">\r
1144 <div class="content">\r
1145 <pre><tt>position &lt;top|bottom&gt;</tt></pre>\r
1146 </div></div>\r
1147 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1148 <div class="listingblock">\r
1149 <div class="content">\r
1150 <pre><tt>bar {\r
1151     position top\r
1152 }</tt></pre>\r
1153 </div></div>\r
1154 </div>\r
1155 <div class="sect2">\r
1156 <h3 id="_output_s">5.6. Output(s)</h3>\r
1157 <div class="paragraph"><p>You can restrict i3bar to one or more outputs (monitors). The default is to\r
1158 handle all outputs. Restricting the outputs is useful for using different\r
1159 options for different outputs by using multiple <em>bar</em> blocks.</p></div>\r
1160 <div class="paragraph"><p>To make a particular i3bar instance handle multiple outputs, specify the output\r
1161 directive multiple times.</p></div>\r
1162 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1163 <div class="listingblock">\r
1164 <div class="content">\r
1165 <pre><tt>output &lt;output&gt;</tt></pre>\r
1166 </div></div>\r
1167 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1168 <div class="listingblock">\r
1169 <div class="content">\r
1170 <pre><tt># big monitor: everything\r
1171 bar {\r
1172     # The display is connected either via HDMI or via DisplayPort\r
1173     output HDMI2\r
1174     output DP2\r
1175     status_command i3status\r
1176 }\r
1177 \r
1178 # laptop monitor: bright colors and i3status with less modules.\r
1179 bar {\r
1180     output LVDS1\r
1181     status_command i3status --config ~/.i3status-small.conf\r
1182     colors {\r
1183         background #000000\r
1184         statusline #ffffff\r
1185     }\r
1186 }</tt></pre>\r
1187 </div></div>\r
1188 </div>\r
1189 <div class="sect2">\r
1190 <h3 id="_tray_output">5.7. Tray output</h3>\r
1191 <div class="paragraph"><p>i3bar by default provides a system tray area where programs such as\r
1192 NetworkManager, VLC, Pidgin, etc. can place little icons.</p></div>\r
1193 <div class="paragraph"><p>You can configure on which output (monitor) the icons should be displayed or\r
1194 you can turn off the functionality entirely.</p></div>\r
1195 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1196 <div class="listingblock">\r
1197 <div class="content">\r
1198 <pre><tt>tray_output &lt;none|primary|output&gt;</tt></pre>\r
1199 </div></div>\r
1200 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1201 <div class="listingblock">\r
1202 <div class="content">\r
1203 <pre><tt># disable system tray\r
1204 bar {\r
1205     tray_output none\r
1206 }\r
1207 \r
1208 # show tray icons on the primary monitor\r
1209 tray_output primary\r
1210 \r
1211 # show tray icons on the big monitor\r
1212 bar {\r
1213     tray_output HDMI2\r
1214 }</tt></pre>\r
1215 </div></div>\r
1216 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>\r
1217 <div class="listingblock">\r
1218 <div class="content">\r
1219 <pre><tt>xrandr --output &lt;output&gt; --primary</tt></pre>\r
1220 </div></div>\r
1221 </div>\r
1222 <div class="sect2">\r
1223 <h3 id="_font">5.8. Font</h3>\r
1224 <div class="paragraph"><p>Specifies the font to be used in the bar. See <a href="#fonts">[fonts]</a>.</p></div>\r
1225 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1226 <div class="listingblock">\r
1227 <div class="content">\r
1228 <pre><tt>font &lt;font&gt;</tt></pre>\r
1229 </div></div>\r
1230 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1231 <div class="listingblock">\r
1232 <div class="content">\r
1233 <pre><tt>bar {\r
1234     font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
1235     font pango:DejaVu Sans Mono 10\r
1236 }</tt></pre>\r
1237 </div></div>\r
1238 </div>\r
1239 <div class="sect2">\r
1240 <h3 id="_workspace_buttons">5.9. Workspace buttons</h3>\r
1241 <div class="paragraph"><p>Specifies whether workspace buttons should be shown or not. This is useful if\r
1242 you want to display a statusline-only bar containing additional information.</p></div>\r
1243 <div class="paragraph"><p>The default is to show workspace buttons.</p></div>\r
1244 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1245 <div class="listingblock">\r
1246 <div class="content">\r
1247 <pre><tt>workspace_buttons &lt;yes|no&gt;</tt></pre>\r
1248 </div></div>\r
1249 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1250 <div class="listingblock">\r
1251 <div class="content">\r
1252 <pre><tt>bar {\r
1253     workspace_buttons no\r
1254 }</tt></pre>\r
1255 </div></div>\r
1256 </div>\r
1257 <div class="sect2">\r
1258 <h3 id="_colors">5.10. Colors</h3>\r
1259 <div class="paragraph"><p>As with i3, colors are in HTML hex format (#rrggbb). The following colors can\r
1260 be configured at the moment:</p></div>\r
1261 <div class="dlist"><dl>\r
1262 <dt class="hdlist1">\r
1263 background\r
1264 </dt>\r
1265 <dd>\r
1266 <p>\r
1267         Background color of the bar.\r
1268 </p>\r
1269 </dd>\r
1270 <dt class="hdlist1">\r
1271 statusline\r
1272 </dt>\r
1273 <dd>\r
1274 <p>\r
1275         Text color to be used for the statusline.\r
1276 </p>\r
1277 </dd>\r
1278 <dt class="hdlist1">\r
1279 separator\r
1280 </dt>\r
1281 <dd>\r
1282 <p>\r
1283         Text color to be used for the separator.\r
1284 </p>\r
1285 </dd>\r
1286 <dt class="hdlist1">\r
1287 focused_workspace\r
1288 </dt>\r
1289 <dd>\r
1290 <p>\r
1291         Border, background and text color for a workspace button when the workspace\r
1292         has focus.\r
1293 </p>\r
1294 </dd>\r
1295 <dt class="hdlist1">\r
1296 active_workspace\r
1297 </dt>\r
1298 <dd>\r
1299 <p>\r
1300         Border, background and text color for a workspace button when the workspace\r
1301         is active (visible) on some output, but the focus is on another one.\r
1302         You can only tell this apart from the focused workspace when you are\r
1303         using multiple monitors.\r
1304 </p>\r
1305 </dd>\r
1306 <dt class="hdlist1">\r
1307 inactive_workspace\r
1308 </dt>\r
1309 <dd>\r
1310 <p>\r
1311         Border, background and text color for a workspace button when the workspace\r
1312         does not have focus and is not active (visible) on any output. This\r
1313         will be the case for most workspaces.\r
1314 </p>\r
1315 </dd>\r
1316 <dt class="hdlist1">\r
1317 urgent_workspace\r
1318 </dt>\r
1319 <dd>\r
1320 <p>\r
1321         Border, background and text color for a workspace button when the workspace\r
1322         window with the urgency hint set.\r
1323 </p>\r
1324 </dd>\r
1325 </dl></div>\r
1326 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1327 <div class="listingblock">\r
1328 <div class="content">\r
1329 <pre><tt>colors {\r
1330     background &lt;color&gt;\r
1331     statusline &lt;color&gt;\r
1332     separator &lt;color&gt;\r
1333 \r
1334     colorclass &lt;border&gt; &lt;background&gt; &lt;text&gt;\r
1335 }</tt></pre>\r
1336 </div></div>\r
1337 <div class="paragraph"><p><strong>Example (default colors)</strong>:</p></div>\r
1338 <div class="listingblock">\r
1339 <div class="content">\r
1340 <pre><tt>bar {\r
1341     colors {\r
1342         background #000000\r
1343         statusline #ffffff\r
1344         separator #666666\r
1345 \r
1346         focused_workspace  #4c7899 #285577 #ffffff\r
1347         active_workspace   #333333 #5f676a #ffffff\r
1348         inactive_workspace #333333 #222222 #888888\r
1349         urgent_workspace   #2f343a #900000 #ffffff\r
1350     }\r
1351 }</tt></pre>\r
1352 </div></div>\r
1353 </div>\r
1354 </div>\r
1355 </div>\r
1356 <div class="sect1">\r
1357 <h2 id="_list_of_commands">6. List of commands</h2>\r
1358 <div class="sectionbody">\r
1359 <div class="paragraph"><p>Commands are what you bind to specific keypresses. You can also issue commands\r
1360 at runtime without pressing a key by using the IPC interface. An easy way to\r
1361 do this is to use the <tt>i3-msg</tt> utility:</p></div>\r
1362 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1363 <div class="listingblock">\r
1364 <div class="content">\r
1365 <pre><tt># execute this on your shell to make the current container borderless\r
1366 i3-msg border none</tt></pre>\r
1367 </div></div>\r
1368 <div class="paragraph"><p>Commands can be chained by using <tt>;</tt> (a semicolon). So, to move a window to a\r
1369 specific workspace and immediately switch to that workspace, you can configure\r
1370 the following keybinding:</p></div>\r
1371 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1372 <div class="listingblock">\r
1373 <div class="content">\r
1374 <pre><tt>bindsym $mod+x move container to workspace 3; workspace 3</tt></pre>\r
1375 </div></div>\r
1376 <div class="paragraph" id="command_criteria"><p>Furthermore, you can change the scope of a command - that is, which containers\r
1377 should be affected by that command, by using various criteria. These are\r
1378 prefixed in square brackets to every command. If you want to kill all windows\r
1379 which have the class Firefox, use:</p></div>\r
1380 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1381 <div class="listingblock">\r
1382 <div class="content">\r
1383 <pre><tt>bindsym $mod+x [class="Firefox"] kill\r
1384 \r
1385 # same thing, but case-insensitive\r
1386 bindsym $mod+x [class="(?i)firefox"] kill</tt></pre>\r
1387 </div></div>\r
1388 <div class="paragraph"><p>The criteria which are currently implemented are:</p></div>\r
1389 <div class="dlist"><dl>\r
1390 <dt class="hdlist1">\r
1391 class\r
1392 </dt>\r
1393 <dd>\r
1394 <p>\r
1395         Compares the window class (the second part of WM_CLASS)\r
1396 </p>\r
1397 </dd>\r
1398 <dt class="hdlist1">\r
1399 instance\r
1400 </dt>\r
1401 <dd>\r
1402 <p>\r
1403         Compares the window instance (the first part of WM_CLASS)\r
1404 </p>\r
1405 </dd>\r
1406 <dt class="hdlist1">\r
1407 window_role\r
1408 </dt>\r
1409 <dd>\r
1410 <p>\r
1411         Compares the window role (WM_WINDOW_ROLE).\r
1412 </p>\r
1413 </dd>\r
1414 <dt class="hdlist1">\r
1415 id\r
1416 </dt>\r
1417 <dd>\r
1418 <p>\r
1419         Compares the X11 window ID, which you can get via <tt>xwininfo</tt> for example.\r
1420 </p>\r
1421 </dd>\r
1422 <dt class="hdlist1">\r
1423 title\r
1424 </dt>\r
1425 <dd>\r
1426 <p>\r
1427         Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).\r
1428 </p>\r
1429 </dd>\r
1430 <dt class="hdlist1">\r
1431 urgent\r
1432 </dt>\r
1433 <dd>\r
1434 <p>\r
1435         Compares the urgent state of the window. Can be "latest" or "oldest".\r
1436         Matches the latest or oldest urgent window, respectively.\r
1437         (The following aliases are also available: newest, last, recent, first)\r
1438 </p>\r
1439 </dd>\r
1440 <dt class="hdlist1">\r
1441 con_mark\r
1442 </dt>\r
1443 <dd>\r
1444 <p>\r
1445         Compares the mark set for this container, see <a href="#vim_like_marks">[vim_like_marks]</a>.\r
1446 </p>\r
1447 </dd>\r
1448 <dt class="hdlist1">\r
1449 con_id\r
1450 </dt>\r
1451 <dd>\r
1452 <p>\r
1453         Compares the i3-internal container ID, which you can get via the IPC\r
1454         interface. Handy for scripting.\r
1455 </p>\r
1456 </dd>\r
1457 </dl></div>\r
1458 <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
1459 regular expressions (PCRE). See <tt>pcresyntax(3)</tt> or <tt>perldoc perlre</tt> for\r
1460 information on how to use them.</p></div>\r
1461 <div class="sect2">\r
1462 <h3 id="exec">6.1. Executing applications (exec)</h3>\r
1463 <div class="paragraph"><p>What good is a window manager if you can’t actually start any applications?\r
1464 The exec command starts an application by passing the command you specify to a\r
1465 shell. This implies that you can use globbing (wildcards) and programs will be\r
1466 searched in your $PATH.</p></div>\r
1467 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1468 <div class="listingblock">\r
1469 <div class="content">\r
1470 <pre><tt>exec [--no-startup-id] command</tt></pre>\r
1471 </div></div>\r
1472 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1473 <div class="listingblock">\r
1474 <div class="content">\r
1475 <pre><tt># Start the GIMP\r
1476 bindsym $mod+g exec gimp\r
1477 \r
1478 # Start the terminal emulator urxvt which is not yet startup-notification-aware\r
1479 bindsym $mod+Return exec --no-startup-id urxvt</tt></pre>\r
1480 </div></div>\r
1481 <div class="paragraph"><p>The <tt>--no-startup-id</tt> parameter disables startup-notification support for this\r
1482 particular exec command. With startup-notification, i3 can make sure that a\r
1483 window appears on the workspace on which you used the exec command. Also, it\r
1484 will change the X11 cursor to <tt>watch</tt> (a clock) while the application is\r
1485 launching. So, if an application is not startup-notification aware (most GTK\r
1486 and Qt using applications seem to be, though), you will end up with a watch\r
1487 cursor for 60 seconds.</p></div>\r
1488 </div>\r
1489 <div class="sect2">\r
1490 <h3 id="_splitting_containers">6.2. Splitting containers</h3>\r
1491 <div class="paragraph"><p>The split command makes the current window a split container. Split containers\r
1492 can contain multiple windows. Depending on the layout of the split container,\r
1493 new windows get placed to the right of the current one (splith) or new windows\r
1494 get placed below the current one (splitv).</p></div>\r
1495 <div class="paragraph"><p>If you apply this command to a split container with the same orientation,\r
1496 nothing will happen. If you use a different orientation, the split container’s\r
1497 orientation will be changed (if it does not have more than one window). Use\r
1498 <tt>layout toggle split</tt> to change the layout of any split container from splitv\r
1499 to splith or vice-versa.</p></div>\r
1500 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1501 <div class="listingblock">\r
1502 <div class="content">\r
1503 <pre><tt>split &lt;vertical|horizontal&gt;</tt></pre>\r
1504 </div></div>\r
1505 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1506 <div class="listingblock">\r
1507 <div class="content">\r
1508 <pre><tt>bindsym $mod+v split vertical\r
1509 bindsym $mod+h split horizontal</tt></pre>\r
1510 </div></div>\r
1511 </div>\r
1512 <div class="sect2">\r
1513 <h3 id="_manipulating_layout">6.3. Manipulating layout</h3>\r
1514 <div class="paragraph"><p>Use <tt>layout toggle split</tt>, <tt>layout stacking</tt>, <tt>layout tabbed</tt>, <tt>layout splitv</tt>\r
1515 or <tt>layout splith</tt> to change the current container layout to splith/splitv,\r
1516 stacking, tabbed layout, splitv or splith, respectively.</p></div>\r
1517 <div class="paragraph"><p>To make the current window (!) fullscreen, use <tt>fullscreen</tt>, to make\r
1518 it floating (or tiling again) use <tt>floating enable</tt> respectively <tt>floating disable</tt>\r
1519 (or <tt>floating toggle</tt>):</p></div>\r
1520 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1521 <div class="listingblock">\r
1522 <div class="content">\r
1523 <pre><tt>layout &lt;default|tabbed|stacking|splitv|splith&gt;\r
1524 layout toggle [split|all]</tt></pre>\r
1525 </div></div>\r
1526 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1527 <div class="listingblock">\r
1528 <div class="content">\r
1529 <pre><tt>bindsym $mod+s layout stacking\r
1530 bindsym $mod+l layout toggle split\r
1531 bindsym $mod+w layout tabbed\r
1532 \r
1533 # Toggle between stacking/tabbed/split:\r
1534 bindsym $mod+x layout toggle\r
1535 \r
1536 # Toggle between stacking/tabbed/splith/splitv:\r
1537 bindsym $mod+x layout toggle all\r
1538 \r
1539 # Toggle fullscreen\r
1540 bindsym $mod+f fullscreen\r
1541 \r
1542 # Toggle floating/tiling\r
1543 bindsym $mod+t floating toggle</tt></pre>\r
1544 </div></div>\r
1545 </div>\r
1546 <div class="sect2">\r
1547 <h3 id="_focusing_moving_containers">6.4. Focusing/Moving containers</h3>\r
1548 <div class="paragraph"><p>To change the focus, use the focus command: <tt>focus left</tt>, <tt>focus right</tt>, <tt>focus\r
1549 down</tt> and <tt>focus up</tt>.</p></div>\r
1550 <div class="paragraph"><p>There are a few special parameters you can use for the focus command:</p></div>\r
1551 <div class="dlist"><dl>\r
1552 <dt class="hdlist1">\r
1553 parent\r
1554 </dt>\r
1555 <dd>\r
1556 <p>\r
1557         Sets focus to the <tt>Parent Container</tt> of the current <tt>Container</tt>.\r
1558 </p>\r
1559 </dd>\r
1560 <dt class="hdlist1">\r
1561 child\r
1562 </dt>\r
1563 <dd>\r
1564 <p>\r
1565         The opposite of <tt>focus parent</tt>, sets the focus to the last focused\r
1566         child container.\r
1567 </p>\r
1568 </dd>\r
1569 <dt class="hdlist1">\r
1570 floating\r
1571 </dt>\r
1572 <dd>\r
1573 <p>\r
1574         Sets focus to the last focused floating container.\r
1575 </p>\r
1576 </dd>\r
1577 <dt class="hdlist1">\r
1578 tiling\r
1579 </dt>\r
1580 <dd>\r
1581 <p>\r
1582         Sets focus to the last focused tiling container.\r
1583 </p>\r
1584 </dd>\r
1585 <dt class="hdlist1">\r
1586 mode_toggle\r
1587 </dt>\r
1588 <dd>\r
1589 <p>\r
1590         Toggles between floating/tiling containers.\r
1591 </p>\r
1592 </dd>\r
1593 <dt class="hdlist1">\r
1594 output\r
1595 </dt>\r
1596 <dd>\r
1597 <p>\r
1598         Followed by a direction or an output name, this will focus the\r
1599         corresponding output.\r
1600 </p>\r
1601 </dd>\r
1602 </dl></div>\r
1603 <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
1604 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1605 <div class="listingblock">\r
1606 <div class="content">\r
1607 <pre><tt>focus &lt;left|right|down|up&gt;\r
1608 focus &lt;parent|child|floating|tiling|mode_toggle&gt;\r
1609 focus output &lt;&lt;left|right|down|up&gt;|output&gt;\r
1610 move &lt;left|right|down|up&gt; [&lt;px&gt; px]\r
1611 move [absolute] position [[&lt;px&gt; px] [&lt;px&gt; px]|center]</tt></pre>\r
1612 </div></div>\r
1613 <div class="paragraph"><p>Note that the amount of pixels you can specify for the <tt>move</tt> command is only\r
1614 relevant for floating containers. The default amount is 10 pixels.</p></div>\r
1615 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1616 <div class="listingblock">\r
1617 <div class="content">\r
1618 <pre><tt># Focus container on the left, bottom, top, right:\r
1619 bindsym $mod+j focus left\r
1620 bindsym $mod+k focus down\r
1621 bindsym $mod+l focus up\r
1622 bindsym $mod+semicolon focus right\r
1623 \r
1624 # Focus parent container\r
1625 bindsym $mod+u focus parent\r
1626 \r
1627 # Focus last floating/tiling container\r
1628 bindsym $mod+g focus mode_toggle\r
1629 \r
1630 # Focus the output right to the current one\r
1631 bindsym $mod+x focus output right\r
1632 \r
1633 # Focus the big output\r
1634 bindsym $mod+x focus output HDMI-2\r
1635 \r
1636 # Move container to the left, bottom, top, right:\r
1637 bindsym $mod+j move left\r
1638 bindsym $mod+k move down\r
1639 bindsym $mod+l move up\r
1640 bindsym $mod+semicolon move right\r
1641 \r
1642 # Move container, but make floating containers\r
1643 # move more than the default\r
1644 bindsym $mod+j move left 20 px\r
1645 \r
1646 # Move floating container to the center\r
1647 # of all outputs\r
1648 bindsym $mod+c move absolute position center</tt></pre>\r
1649 </div></div>\r
1650 </div>\r
1651 <div class="sect2">\r
1652 <h3 id="_changing_named_workspaces_moving_to_workspaces">6.5. Changing (named) workspaces/moving to workspaces</h3>\r
1653 <div class="paragraph"><p>To change to a specific workspace, use the <tt>workspace</tt> command, followed by the\r
1654 number or name of the workspace. To move containers to specific workspaces, use\r
1655 <tt>move container to workspace</tt>.</p></div>\r
1656 <div class="paragraph"><p>You can also switch to the next and previous workspace with the commands\r
1657 <tt>workspace next</tt> and <tt>workspace prev</tt>, which is handy, for example, if you have\r
1658 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key\r
1659 combination. To restrict those to the current output, use <tt>workspace\r
1660 next_on_output</tt> and <tt>workspace prev_on_output</tt>. Similarly, you can use <tt>move\r
1661 container to workspace next</tt>, <tt>move container to workspace prev</tt> to move a\r
1662 container to the next/previous workspace and <tt>move container to workspace current</tt>\r
1663 (the last one makes sense only when used with criteria).</p></div>\r
1664 <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
1665 RandR output.</p></div>\r
1666 <div class="paragraph" id="back_and_forth"><p>To switch back to the previously focused workspace, use <tt>workspace\r
1667 back_and_forth</tt>; likewise, you can move containers to the previously focused\r
1668 workspace using <tt>move container to workspace back_and_forth</tt>.</p></div>\r
1669 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1670 <div class="listingblock">\r
1671 <div class="content">\r
1672 <pre><tt>workspace &lt;next|prev|next_on_output|prev_on_output&gt;\r
1673 workspace back_and_forth\r
1674 workspace &lt;name&gt;\r
1675 workspace number &lt;name&gt;\r
1676 \r
1677 move [window|container] [to] workspace &lt;name&gt;\r
1678 move [window|container] [to] workspace number &lt;name&gt;\r
1679 move [window|container] [to] workspace &lt;prev|next|current&gt;</tt></pre>\r
1680 </div></div>\r
1681 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1682 <div class="listingblock">\r
1683 <div class="content">\r
1684 <pre><tt>bindsym $mod+1 workspace 1\r
1685 bindsym $mod+2 workspace 2\r
1686 ...\r
1687 \r
1688 bindsym $mod+Shift+1 move container to workspace 1\r
1689 bindsym $mod+Shift+2 move container to workspace 2\r
1690 ...\r
1691 \r
1692 # switch between the current and the previously focused one\r
1693 bindsym $mod+b workspace back_and_forth\r
1694 bindsym $mod+Shift+b move container to workspace back_and_forth\r
1695 \r
1696 # move the whole workspace to the next output\r
1697 bindsym $mod+x move workspace to output right\r
1698 \r
1699 # move firefox to current workspace\r
1700 bindsym $mod+F1 [class="Firefox"] move workspace current</tt></pre>\r
1701 </div></div>\r
1702 <div class="sect3">\r
1703 <h4 id="_named_workspaces">6.5.1. Named workspaces</h4>\r
1704 <div class="paragraph"><p>Workspaces are identified by their name. So, instead of using numbers in the\r
1705 workspace command, you can use an arbitrary name:</p></div>\r
1706 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1707 <div class="listingblock">\r
1708 <div class="content">\r
1709 <pre><tt>bindsym $mod+1 workspace mail\r
1710 ...</tt></pre>\r
1711 </div></div>\r
1712 <div class="paragraph"><p>If you want the workspace to have a number <strong>and</strong> a name, just prefix the\r
1713 number, like this:</p></div>\r
1714 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
1715 <div class="listingblock">\r
1716 <div class="content">\r
1717 <pre><tt>bindsym $mod+1 workspace 1: mail\r
1718 bindsym $mod+2 workspace 2: www\r
1719 ...</tt></pre>\r
1720 </div></div>\r
1721 <div class="paragraph"><p>Note that the workspace will really be named "1: mail". i3 treats workspace\r
1722 names beginning with a number in a slightly special way. Normally, named\r
1723 workspaces are ordered the way they appeared. When they start with a number, i3\r
1724 will order them numerically. Also, you will be able to use <tt>workspace number 1</tt>\r
1725 to switch to the workspace which begins with number 1, regardless of which name\r
1726 it has. This is useful in case you are changing the workspace’s name\r
1727 dynamically. To combine both commands you can use <tt>workspace number 1: mail</tt> to\r
1728 specify a default name if there&#8217;s currently no workspace starting with a "1".</p></div>\r
1729 </div>\r
1730 <div class="sect3">\r
1731 <h4 id="_renaming_workspaces">6.5.2. Renaming workspaces</h4>\r
1732 <div class="paragraph"><p>You can rename workspaces. This might be useful to start with the default\r
1733 numbered workspaces, do your work, and rename the workspaces afterwards to\r
1734 reflect what’s actually on them. You can also omit the old name to rename\r
1735 the currently focused workspace. This is handy if you wan&#8217;t to use the\r
1736 rename command with <tt>i3-input</tt>.</p></div>\r
1737 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1738 <div class="listingblock">\r
1739 <div class="content">\r
1740 <pre><tt>rename workspace &lt;old_name&gt; to &lt;new_name&gt;\r
1741 rename workspace to &lt;new_name&gt;</tt></pre>\r
1742 </div></div>\r
1743 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1744 <div class="listingblock">\r
1745 <div class="content">\r
1746 <pre><tt>i3-msg 'rename workspace 5 to 6'\r
1747 i3-msg 'rename workspace 1 to "1: www"'\r
1748 i3-msg 'rename workspace "1: www" to "10: www"'\r
1749 i3-msg 'rename workspace to "2: mail"\r
1750 bindsym $mod+r exec i3-input -F 'rename workspace to %s' -P 'New name: '</tt></pre>\r
1751 </div></div>\r
1752 </div>\r
1753 </div>\r
1754 <div class="sect2">\r
1755 <h3 id="_moving_workspaces_to_a_different_screen">6.6. Moving workspaces to a different screen</h3>\r
1756 <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
1757 RandR output.</p></div>\r
1758 </div>\r
1759 <div class="sect2">\r
1760 <h3 id="_moving_containers_workspaces_to_randr_outputs">6.7. Moving containers/workspaces to RandR outputs</h3>\r
1761 <div class="paragraph" id="move_to_outputs"><p>To move a container to another RandR output (addressed by names like <tt>LVDS1</tt> or\r
1762 <tt>VGA1</tt>) or to a RandR output identified by a specific direction (like <tt>left</tt>,\r
1763 <tt>right</tt>, <tt>up</tt> or <tt>down</tt>), there are two commands:</p></div>\r
1764 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1765 <div class="listingblock">\r
1766 <div class="content">\r
1767 <pre><tt>move container to output &lt;&lt;left|right|down|up&gt;|&lt;output&gt;&gt;\r
1768 move workspace to output &lt;&lt;left|right|down|up&gt;|&lt;output&gt;&gt;</tt></pre>\r
1769 </div></div>\r
1770 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1771 <div class="listingblock">\r
1772 <div class="content">\r
1773 <pre><tt># Move the current workspace to the next output\r
1774 # (effectively toggles when you only have two outputs)\r
1775 bindsym $mod+x move workspace to output right\r
1776 \r
1777 # Put this window on the presentation output.\r
1778 bindsym $mod+x move container to output VGA1</tt></pre>\r
1779 </div></div>\r
1780 </div>\r
1781 <div class="sect2">\r
1782 <h3 id="resizingconfig">6.8. Resizing containers/windows</h3>\r
1783 <div class="paragraph"><p>If you want to resize containers/windows using your keyboard, you can use the\r
1784 <tt>resize</tt> command:</p></div>\r
1785 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1786 <div class="listingblock">\r
1787 <div class="content">\r
1788 <pre><tt>resize &lt;grow|shrink&gt; &lt;direction&gt; [&lt;px&gt; px [or &lt;ppt&gt; ppt]]</tt></pre>\r
1789 </div></div>\r
1790 <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
1791 less specific and use <tt>width</tt> or <tt>height</tt>, in which case i3 will take/give\r
1792 space from all the other containers. The optional pixel argument specifies by\r
1793 how many pixels a <strong>floating container</strong> should be grown or shrunk (the default\r
1794 is 10 pixels). The ppt argument means percentage points and specifies by how\r
1795 many percentage points a <strong>tiling container</strong> should be grown or shrunk (the\r
1796 default is 10 percentage points).</p></div>\r
1797 <div class="paragraph"><p>I recommend using the resize command inside a so called <tt>mode</tt>:</p></div>\r
1798 <div class="listingblock">\r
1799 <div class="title">Example: Configuration file, defining a mode for resizing</div>\r
1800 <div class="content">\r
1801 <pre><tt>mode "resize" {\r
1802         # These bindings trigger as soon as you enter the resize mode\r
1803 \r
1804         # Pressing left will shrink the window’s width.\r
1805         # Pressing right will grow the window’s width.\r
1806         # Pressing up will shrink the window’s height.\r
1807         # Pressing down will grow the window’s height.\r
1808         bindsym j           resize shrink width 10 px or 10 ppt\r
1809         bindsym k           resize grow height 10 px or 10 ppt\r
1810         bindsym l           resize shrink height 10 px or 10 ppt\r
1811         bindsym semicolon   resize grow width 10 px or 10 ppt\r
1812 \r
1813         # same bindings, but for the arrow keys\r
1814         bindsym Left        resize shrink width 10 px or 10 ppt\r
1815         bindsym Down        resize grow height 10 px or 10 ppt\r
1816         bindsym Up          resize shrink height 10 px or 10 ppt\r
1817         bindsym Right       resize grow width 10 px or 10 ppt\r
1818 \r
1819         # back to normal: Enter or Escape\r
1820         bindsym Return mode "default"\r
1821         bindsym Escape mode "default"\r
1822 }\r
1823 \r
1824 # Enter resize mode\r
1825 bindsym $mod+r mode "resize"</tt></pre>\r
1826 </div></div>\r
1827 </div>\r
1828 <div class="sect2">\r
1829 <h3 id="_jumping_to_specific_windows">6.9. Jumping to specific windows</h3>\r
1830 <div class="paragraph"><p>Often when in a multi-monitor environment, you want to quickly jump to a\r
1831 specific window. For example, while working on workspace 3 you may want to\r
1832 jump to your mail client to email your boss that you’ve achieved some\r
1833 important goal. Instead of figuring out how to navigate to your mail client,\r
1834 it would be more convenient to have a shortcut. You can use the <tt>focus</tt> command\r
1835 with criteria for that.</p></div>\r
1836 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1837 <div class="listingblock">\r
1838 <div class="content">\r
1839 <pre><tt>[class="class"] focus\r
1840 [title="title"] focus</tt></pre>\r
1841 </div></div>\r
1842 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1843 <div class="listingblock">\r
1844 <div class="content">\r
1845 <pre><tt># Get me to the next open VIM instance\r
1846 bindsym $mod+a [class="urxvt" title="VIM"] focus</tt></pre>\r
1847 </div></div>\r
1848 </div>\r
1849 <div class="sect2">\r
1850 <h3 id="_vim_like_marks_mark_goto">6.10. VIM-like marks (mark/goto)</h3>\r
1851 <div class="paragraph" id="vim_like_marks"><p>This feature is like the jump feature: It allows you to directly jump to a\r
1852 specific window (this means switching to the appropriate workspace and setting\r
1853 focus to the windows). However, you can directly mark a specific window with\r
1854 an arbitrary label and use it afterwards. You can unmark the label in the same\r
1855 way, using the unmark command. If you don&#8217;t specify a label, unmark removes all\r
1856 marks. You do not need to ensure that your windows have unique classes or\r
1857 titles, and you do not need to change your configuration file.</p></div>\r
1858 <div class="paragraph"><p>As the command needs to include the label with which you want to mark the\r
1859 window, you cannot simply bind it to a key.  <tt>i3-input</tt> is a tool created\r
1860 for this purpose: It lets you input a command and sends the command to i3. It\r
1861 can also prefix this command and display a custom prompt for the input dialog.</p></div>\r
1862 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1863 <div class="listingblock">\r
1864 <div class="content">\r
1865 <pre><tt>mark identifier\r
1866 [con_mark="identifier"] focus\r
1867 unmark identifier</tt></pre>\r
1868 </div></div>\r
1869 <div class="paragraph"><p><strong>Example (in a terminal)</strong>:</p></div>\r
1870 <div class="listingblock">\r
1871 <div class="content">\r
1872 <pre><tt>$ i3-msg mark irssi\r
1873 $ i3-msg '[con_mark="irssi"] focus'\r
1874 $ i3-msg unmark irssi</tt></pre>\r
1875 </div></div>\r
1876 </div>\r
1877 <div class="sect2">\r
1878 <h3 id="_changing_border_style">6.11. Changing border style</h3>\r
1879 <div class="paragraph"><p>To change the border of the current client, you can use <tt>border normal</tt> to use the normal\r
1880 border (including window title), <tt>border 1pixel</tt> to use a 1-pixel border (no window title)\r
1881 and <tt>border none</tt> to make the client borderless.</p></div>\r
1882 <div class="paragraph"><p>There is also <tt>border toggle</tt> which will toggle the different border styles.</p></div>\r
1883 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1884 <div class="listingblock">\r
1885 <div class="content">\r
1886 <pre><tt>bindsym $mod+t border normal\r
1887 bindsym $mod+y border 1pixel\r
1888 bindsym $mod+u border none</tt></pre>\r
1889 </div></div>\r
1890 </div>\r
1891 <div class="sect2">\r
1892 <h3 id="shmlog">6.12. Enabling shared memory logging</h3>\r
1893 <div class="paragraph"><p>As described in <a href="http://i3wm.org/docs/debugging.html">http://i3wm.org/docs/debugging.html</a>, i3 can log to a shared\r
1894 memory buffer, which you can dump using <tt>i3-dump-log</tt>. The <tt>shmlog</tt> command\r
1895 allows you to enable or disable the shared memory logging at runtime.</p></div>\r
1896 <div class="paragraph"><p>Note that when using <tt>shmlog &lt;size_in_bytes&gt;</tt>, the current log will be\r
1897 discarded and a new one will be started.</p></div>\r
1898 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1899 <div class="listingblock">\r
1900 <div class="content">\r
1901 <pre><tt>shmlog &lt;size_in_bytes&gt;\r
1902 shmlog &lt;on|off|toggle&gt;</tt></pre>\r
1903 </div></div>\r
1904 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1905 <div class="listingblock">\r
1906 <div class="content">\r
1907 <pre><tt># Enable/disable logging\r
1908 bindsym $mod+x shmlog toggle\r
1909 \r
1910 # or, from a terminal:\r
1911 # increase the shared memory log buffer to 50 MiB\r
1912 i3-msg shmlog $((50*1024*1024))</tt></pre>\r
1913 </div></div>\r
1914 </div>\r
1915 <div class="sect2">\r
1916 <h3 id="_enabling_debug_logging">6.13. Enabling debug logging</h3>\r
1917 <div class="paragraph"><p>The <tt>debuglog</tt> command allows you to enable or disable debug logging at\r
1918 runtime. Debug logging is much more verbose than non-debug logging. This\r
1919 command does not activate shared memory logging (shmlog), and as such is most\r
1920 likely useful in combination with the above-described <a href="#shmlog">[shmlog]</a> command.</p></div>\r
1921 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1922 <div class="listingblock">\r
1923 <div class="content">\r
1924 <pre><tt>debuglog &lt;on|off|toggle&gt;</tt></pre>\r
1925 </div></div>\r
1926 </div>\r
1927 </div>\r
1928 </div>\r
1929 <div class="sect1">\r
1930 <h2 id="_strong_examples_strong">7. <strong>Examples</strong>:</h2>\r
1931 <div class="sectionbody">\r
1932 <div class="paragraph"><p># Enable/disable logging\r
1933 bindsym $mod+x debuglog toggle</p></div>\r
1934 <div class="listingblock">\r
1935 <div class="content">\r
1936 <pre><tt>=== Reloading/Restarting/Exiting\r
1937 \r
1938 You can make i3 reload its configuration file with +reload+. You can also\r
1939 restart i3 inplace with the +restart+ command to get it out of some weird state\r
1940 (if that should ever happen) or to perform an upgrade without having to restart\r
1941 your X session. To exit i3 properly, you can use the +exit+ command,\r
1942 however you don’t need to (simply killing your X session is fine as well).\r
1943 \r
1944 *Examples*:</tt></pre>\r
1945 </div></div>\r
1946 <div class="paragraph"><p>bindsym $mod+Shift+r restart\r
1947 bindsym $mod+Shift+w reload\r
1948 bindsym $mod+Shift+e exit</p></div>\r
1949 <div class="listingblock">\r
1950 <div class="content">\r
1951 <pre><tt>=== Scratchpad\r
1952 \r
1953 There are two commands to use any existing window as scratchpad window. +move\r
1954 scratchpad+ will move a window to the scratchpad workspace. This will make it\r
1955 invisible until you show it again. There is no way to open that workspace.\r
1956 Instead, when using +scratchpad show+, the window will be shown again, as a\r
1957 floating window, centered on your current workspace (using +scratchpad show+ on\r
1958 a visible scratchpad window will make it hidden again, so you can have a\r
1959 keybinding to toggle). Note that this is just a normal floating window, so if\r
1960 you want to "remove it from scratchpad", you can simple make it tiling again\r
1961 (+floating toggle+).\r
1962 \r
1963 As the name indicates, this is useful for having a window with your favorite\r
1964 editor always at hand. However, you can also use this for other permanently\r
1965 running applications which you don’t want to see all the time: Your music\r
1966 player, alsamixer, maybe even your mail client…?\r
1967 \r
1968 *Syntax*:</tt></pre>\r
1969 </div></div>\r
1970 <div class="paragraph"><p>move scratchpad</p></div>\r
1971 </div>\r
1972 </div>\r
1973 <div class="sect1">\r
1974 <h2 id="_scratchpad_show">8. scratchpad show</h2>\r
1975 <div class="sectionbody">\r
1976 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
1977 <div class="listingblock">\r
1978 <div class="content">\r
1979 <pre><tt># Make the currently focused window a scratchpad\r
1980 bindsym $mod+Shift+minus move scratchpad\r
1981 \r
1982 # Show the first scratchpad window\r
1983 bindsym $mod+minus scratchpad show\r
1984 \r
1985 # Show the sup-mail scratchpad window, if any.\r
1986 bindsym mod4+s [title="^Sup ::"] scratchpad show</tt></pre>\r
1987 </div></div>\r
1988 <div class="sect2">\r
1989 <h3 id="_i3bar_control">8.1. i3bar control</h3>\r
1990 <div class="paragraph"><p>There are two options in the configuration of each i3bar instance that can be\r
1991 changed during runtime by invoking a command through i3. The commands <tt>bar\r
1992 hidden_state</tt> and <tt>bar mode</tt> allow setting the current hidden_state\r
1993 respectively mode option of each bar. It is also possible to toggle between\r
1994 hide state and show state as well as between dock mode and hide mode. Each\r
1995 i3bar instance can be controlled individually by specifying a bar_id, if none\r
1996 is given, the command is executed for all bar instances.</p></div>\r
1997 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
1998 <div class="listingblock">\r
1999 <div class="content">\r
2000 <pre><tt>bar hidden_state hide|show|toggle [&lt;bar_id&gt;]\r
2001 \r
2002 bar mode dock|hide|invisible|toggle [&lt;bar_id&gt;]</tt></pre>\r
2003 </div></div>\r
2004 <div class="paragraph"><p><strong>Examples</strong>:</p></div>\r
2005 <div class="listingblock">\r
2006 <div class="content">\r
2007 <pre><tt># Toggle between hide state and show state\r
2008 bindsym $mod+m bar hidden_state toggle\r
2009 \r
2010 # Toggle between dock mode and hide mode\r
2011 bindsym $mod+n bar mode toggle\r
2012 \r
2013 # Set the bar instance with id 'bar-1' to switch to hide mode\r
2014 bindsym $mod+b bar mode hide bar-1\r
2015 \r
2016 # Set the bar instance with id 'bar-1' to always stay hidden\r
2017 bindsym $mod+Shift+b bar mode invisible bar-1</tt></pre>\r
2018 </div></div>\r
2019 </div>\r
2020 </div>\r
2021 </div>\r
2022 <div class="sect1">\r
2023 <h2 id="multi_monitor">9. Multiple monitors</h2>\r
2024 <div class="sectionbody">\r
2025 <div class="paragraph"><p>As you can see in the goal list on the website, i3 was specifically developed\r
2026 with support for multiple monitors in mind. This section will explain how to\r
2027 handle multiple monitors.</p></div>\r
2028 <div class="paragraph"><p>When you have only one monitor, things are simple. You usually start with\r
2029 workspace 1 on your monitor and open new ones as you need them.</p></div>\r
2030 <div class="paragraph"><p>When you have more than one monitor, each monitor will get an initial\r
2031 workspace.  The first monitor gets 1, the second gets 2 and a possible third\r
2032 would get 3. When you switch to a workspace on a different monitor, i3 will\r
2033 switch to that monitor and then switch to the workspace. This way, you don’t\r
2034 need shortcuts to switch to a specific monitor, and you don’t need to remember\r
2035 where you put which workspace. New workspaces will be opened on the currently\r
2036 active monitor.  It is not possible to have a monitor without a workspace.</p></div>\r
2037 <div class="paragraph"><p>The idea of making workspaces global is based on the observation that most\r
2038 users have a very limited set of workspaces on their additional monitors.\r
2039 They are often used for a specific task (browser, shell) or for monitoring\r
2040 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor\r
2041 and "the rest" on the other monitors often makes sense. However, as you can\r
2042 create an unlimited number of workspaces in i3 and tie them to specific\r
2043 screens, you can have the "traditional" approach of having X workspaces per\r
2044 screen by changing your configuration (using modes, for example).</p></div>\r
2045 <div class="sect2">\r
2046 <h3 id="_configuring_your_monitors">9.1. Configuring your monitors</h3>\r
2047 <div class="paragraph"><p>To help you get going if you have never used multiple monitors before, here is\r
2048 a short overview of the xrandr options which will probably be of interest to\r
2049 you. It is always useful to get an overview of the current screen configuration.\r
2050 Just run "xrandr" and you will get an output like the following:</p></div>\r
2051 <div class="listingblock">\r
2052 <div class="content">\r
2053 <pre><tt>$ xrandr\r
2054 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192\r
2055 VGA1 disconnected (normal left inverted right x axis y axis)\r
2056 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm\r
2057    1280x800       60.0*+   50.0\r
2058    1024x768       85.0     75.0     70.1     60.0\r
2059    832x624        74.6\r
2060    800x600        85.1     72.2     75.0     60.3     56.2\r
2061    640x480        85.0     72.8     75.0     59.9\r
2062    720x400        85.0\r
2063    640x400        85.1\r
2064    640x350        85.1</tt></pre>\r
2065 </div></div>\r
2066 <div class="paragraph"><p>Several things are important here: You can see that <tt>LVDS1</tt> is connected (of\r
2067 course, it is the internal flat panel) but <tt>VGA1</tt> is not. If you have a monitor\r
2068 connected to one of the ports but xrandr still says "disconnected", you should\r
2069 check your cable, monitor or graphics driver.</p></div>\r
2070 <div class="paragraph"><p>The maximum resolution you can see at the end of the first line is the maximum\r
2071 combined resolution of your monitors. By default, it is usually too low and has\r
2072 to be increased by editing <tt>/etc/X11/xorg.conf</tt>.</p></div>\r
2073 <div class="paragraph"><p>So, say you connected VGA1 and want to use it as an additional screen:</p></div>\r
2074 <div class="listingblock">\r
2075 <div class="content">\r
2076 <pre><tt>xrandr --output VGA1 --auto --left-of LVDS1</tt></pre>\r
2077 </div></div>\r
2078 <div class="paragraph"><p>This command makes xrandr try to find the native resolution of the device\r
2079 connected to <tt>VGA1</tt> and configures it to the left of your internal flat panel.\r
2080 When running "xrandr" again, the output looks like this:</p></div>\r
2081 <div class="listingblock">\r
2082 <div class="content">\r
2083 <pre><tt>$ xrandr\r
2084 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192\r
2085 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm\r
2086    1280x1024      60.0*+   75.0\r
2087    1280x960       60.0\r
2088    1152x864       75.0\r
2089    1024x768       75.1     70.1     60.0\r
2090    832x624        74.6\r
2091    800x600        72.2     75.0     60.3     56.2\r
2092    640x480        72.8     75.0     66.7     60.0\r
2093    720x400        70.1\r
2094 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm\r
2095    1280x800       60.0*+   50.0\r
2096    1024x768       85.0     75.0     70.1     60.0\r
2097    832x624        74.6\r
2098    800x600        85.1     72.2     75.0     60.3     56.2\r
2099    640x480        85.0     72.8     75.0     59.9\r
2100    720x400        85.0\r
2101    640x400        85.1\r
2102    640x350        85.1</tt></pre>\r
2103 </div></div>\r
2104 <div class="paragraph"><p>Please note that i3 uses exactly the same API as xrandr does, so it will see\r
2105 only what you can see in xrandr.</p></div>\r
2106 <div class="paragraph"><p>See also <a href="#presentations">[presentations]</a> for more examples of multi-monitor setups.</p></div>\r
2107 </div>\r
2108 <div class="sect2">\r
2109 <h3 id="_interesting_configuration_for_multi_monitor_environments">9.2. Interesting configuration for multi-monitor environments</h3>\r
2110 <div class="paragraph"><p>There are several things to configure in i3 which may be interesting if you\r
2111 have more than one monitor:</p></div>\r
2112 <div class="olist arabic"><ol class="arabic">\r
2113 <li>\r
2114 <p>\r
2115 You can specify which workspace should be put on which screen. This\r
2116    allows you to have a different set of workspaces when starting than just\r
2117    1 for the first monitor, 2 for the second and so on. See\r
2118    <a href="#workspace_screen">[workspace_screen]</a>.\r
2119 </p>\r
2120 </li>\r
2121 <li>\r
2122 <p>\r
2123 If you want some applications to generally open on the bigger screen\r
2124    (MPlayer, Firefox, …), you can assign them to a specific workspace, see\r
2125    <a href="#assign_workspace">[assign_workspace]</a>.\r
2126 </p>\r
2127 </li>\r
2128 <li>\r
2129 <p>\r
2130 If you have many workspaces on many monitors, it might get hard to keep\r
2131    track of which window you put where. Thus, you can use vim-like marks to\r
2132    quickly switch between windows. See <a href="#vim_like_marks">[vim_like_marks]</a>.\r
2133 </p>\r
2134 </li>\r
2135 <li>\r
2136 <p>\r
2137 For information on how to move existing workspaces between monitors,\r
2138    see <a href="#_moving_containers_workspaces_to_randr_outputs">[_moving_containers_workspaces_to_randr_outputs]</a>.\r
2139 </p>\r
2140 </li>\r
2141 </ol></div>\r
2142 </div>\r
2143 </div>\r
2144 </div>\r
2145 <div class="sect1">\r
2146 <h2 id="_i3_and_the_rest_of_your_software_world">10. i3 and the rest of your software world</h2>\r
2147 <div class="sectionbody">\r
2148 <div class="sect2">\r
2149 <h3 id="_displaying_a_status_line">10.1. Displaying a status line</h3>\r
2150 <div class="paragraph"><p>A very common thing amongst users of exotic window managers is a status line at\r
2151 some corner of the screen. It is an often superior replacement to the widget\r
2152 approach you have in the task bar of a traditional desktop environment.</p></div>\r
2153 <div class="paragraph"><p>If you don’t already have your favorite way of generating such a status line\r
2154 (self-written scripts, conky, …), then i3status is the recommended tool for\r
2155 this task. It was written in C with the goal of using as few syscalls as\r
2156 possible to reduce the time your CPU is woken up from sleep states. Because\r
2157 i3status only spits out text, you need to combine it with some other tool, like\r
2158 i3bar. See <a href="#status_command">[status_command]</a> for how to display i3status in i3bar.</p></div>\r
2159 <div class="paragraph"><p>Regardless of which application you use to display the status line, you\r
2160 want to make sure that it registers as a dock window using EWMH hints. i3 will\r
2161 position the window either at the top or at the bottom of the screen, depending\r
2162 on which hint the application sets. With i3bar, you can configure its position,\r
2163 see <a href="#i3bar_position">[i3bar_position]</a>.</p></div>\r
2164 </div>\r
2165 <div class="sect2">\r
2166 <h3 id="_giving_presentations_multi_monitor">10.2. Giving presentations (multi-monitor)</h3>\r
2167 <div class="paragraph"><p>When giving a presentation, you typically want the audience to see what you see\r
2168 on your screen and then go through a series of slides (if the presentation is\r
2169 simple). For more complex presentations, you might want to have some notes\r
2170 which only you can see on your screen, while the audience can only see the\r
2171 slides.</p></div>\r
2172 <div class="sect3">\r
2173 <h4 id="presentations">10.2.1. Case 1: everybody gets the same output</h4>\r
2174 <div class="paragraph"><p>This is the simple case. You connect your computer to the video projector,\r
2175 turn on both (computer and video projector) and configure your X server to\r
2176 clone the internal flat panel of your computer to the video output:</p></div>\r
2177 <div class="listingblock">\r
2178 <div class="content">\r
2179 <pre><tt>xrandr --output VGA1 --mode 1024x768 --same-as LVDS1</tt></pre>\r
2180 </div></div>\r
2181 <div class="paragraph"><p>i3 will then use the lowest common subset of screen resolutions, the rest of\r
2182 your screen will be left untouched (it will show the X background). So, in\r
2183 our example, this would be 1024x768 (my notebook has 1280x800).</p></div>\r
2184 </div>\r
2185 <div class="sect3">\r
2186 <h4 id="_case_2_you_can_see_more_than_your_audience">10.2.2. Case 2: you can see more than your audience</h4>\r
2187 <div class="paragraph"><p>This case is a bit harder. First of all, you should configure the VGA output\r
2188 somewhere near your internal flat panel, say right of it:</p></div>\r
2189 <div class="listingblock">\r
2190 <div class="content">\r
2191 <pre><tt>xrandr --output VGA1 --mode 1024x768 --right-of LVDS1</tt></pre>\r
2192 </div></div>\r
2193 <div class="paragraph"><p>Now, i3 will put a new workspace (depending on your settings) on the new screen\r
2194 and you are in multi-monitor mode (see <a href="#multi_monitor">[multi_monitor]</a>).</p></div>\r
2195 <div class="paragraph"><p>Because i3 is not a compositing window manager, there is no ability to\r
2196 display a window on two screens at the same time. Instead, your presentation\r
2197 software needs to do this job (that is, open a window on each screen).</p></div>\r
2198 </div>\r
2199 </div>\r
2200 </div>\r
2201 </div>\r
2202 </div>\r
2203 <div id="footnotes"><hr /></div>\r
2204 <div id="footer" lang="de">\r
2205 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
2206 </div>\r
2207 </body>\r
2208 </html>\r