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