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
5 <link rel="icon" type="image/x-icon" href="/favicon.ico">
\r
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
\r
7 <meta name="generator" content="AsciiDoc 8.6.9" />
\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
13 document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);
\r
16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>
\r
18 <body class="article">
\r
21 <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>
\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="https://www.reddit.com/r/i3wm/">FAQ</a></li>
\r
26 <li><a href="/contact">Contact</a></li>
\r
27 <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>
\r
29 <br style="clear: both">
\r
32 <h1>i3 User’s Guide</h1>
\r
33 <span id="author">Michael Stapelberg</span><br />
\r
34 <span id="email"><tt><<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>></tt></span><br />
\r
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>
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="https://www.reddit.com/r/i3wm/">https://www.reddit.com/r/i3wm/</a>
\r
44 first, then contact us on IRC (preferred) or post your question(s) on the
\r
45 mailing list.</p></div>
\r
49 <h2 id="_default_keybindings">1. Default keybindings</h2>
\r
50 <div class="sectionbody">
\r
51 <div class="paragraph"><p>For the "too long; didn’t read" people, here is an overview of the default
\r
52 keybindings (click to see the full-size image):</p></div>
\r
53 <div class="paragraph"><p><strong>Keys to use with $mod (Alt):</strong></p></div>
\r
54 <div class="paragraph"><p><span class="image">
\r
55 <a class="image" href="keyboard-layer1.png">
\r
56 <img src="keyboard-layer1.png" alt="Keys to use with $mod (Alt)" width="600" />
\r
59 <div class="paragraph"><p><strong>Keys to use with Shift+$mod:</strong></p></div>
\r
60 <div class="paragraph"><p><span class="image">
\r
61 <a class="image" href="keyboard-layer2.png">
\r
62 <img src="keyboard-layer2.png" alt="Keys to use with Shift+$mod" width="600" />
\r
65 <div class="paragraph"><p>The red keys are the modifiers you need to press (by default), the blue keys
\r
66 are your homerow.</p></div>
\r
67 <div class="paragraph"><p>Note that when starting i3 without a config file, i3-config-wizard will offer
\r
68 you to create a config file in which the key positions (!) match what you see
\r
69 in the image above, regardless of the keyboard layout you are using. If you
\r
70 prefer to use a config file where the key letters match what you are seeing
\r
71 above, just decline i3-config-wizard’s offer and base your config on
\r
72 <tt>/etc/i3/config</tt>.</p></div>
\r
76 <h2 id="_using_i3">2. Using i3</h2>
\r
77 <div class="sectionbody">
\r
78 <div class="paragraph"><p>Throughout this guide, the keyword <tt>$mod</tt> will be used to refer to the
\r
79 configured modifier. This is the Alt key (<tt>Mod1</tt>) by default, with the Windows
\r
80 key (<tt>Mod4</tt>) being a popular alternative that largely prevents conflicts with
\r
81 application-defined shortcuts.</p></div>
\r
83 <h3 id="_opening_terminals_and_moving_around">2.1. Opening terminals and moving around</h3>
\r
84 <div class="paragraph"><p>One very basic operation is opening a new terminal. By default, the keybinding
\r
85 for this is <tt>$mod+Enter</tt>, that is Alt+Enter (<tt>Mod1+Enter</tt>) in the default
\r
86 configuration. By pressing <tt>$mod+Enter</tt>, a new terminal will be opened. It
\r
87 will fill the whole space available on your screen.</p></div>
\r
88 <div class="paragraph"><p><span class="image">
\r
89 <img src="single_terminal.png" alt="Single terminal" />
\r
91 <div class="paragraph"><p>If you now open another terminal, i3 will place it next to the current one,
\r
92 splitting the screen size in half. Depending on your monitor, i3 will put the
\r
93 created window beside the existing window (on wide displays) or below the
\r
94 existing window (rotated displays).</p></div>
\r
95 <div class="paragraph"><p><span class="image">
\r
96 <img src="two_terminals.png" alt="Two terminals" />
\r
98 <div class="paragraph"><p>To move the focus between the two terminals, you can use the direction keys
\r
99 which you may know from the editor <tt>vi</tt>. However, in i3, your homerow is used
\r
100 for these keys (in <tt>vi</tt>, the keys are shifted to the left by one for
\r
101 compatibility with most keyboard layouts). Therefore, <tt>$mod+j</tt> is left, <tt>$mod+k</tt>
\r
102 is down, <tt>$mod+l</tt> is up and <tt>$mod+;</tt> is right. So, to switch between the
\r
103 terminals, use <tt>$mod+k</tt> or <tt>$mod+l</tt>. Of course, you can also use the arrow keys.</p></div>
\r
104 <div class="paragraph"><p>At the moment, your workspace is split (it contains two terminals) in a
\r
105 specific direction (horizontal by default). Every window can be split
\r
106 horizontally or vertically again, just like the workspace. The terminology is
\r
107 "window" for a container that actually contains an X11 window (like a terminal
\r
108 or browser) and "split container" for containers that consist of one or more
\r
110 <div class="paragraph"><p>TODO: picture of the tree</p></div>
\r
111 <div class="paragraph"><p>To split a window vertically, press <tt>$mod+v</tt> before you create the new window.
\r
112 To split it horizontally, press <tt>$mod+h</tt>.</p></div>
\r
114 <div class="sect2">
\r
115 <h3 id="_changing_the_container_layout">2.2. Changing the container layout</h3>
\r
116 <div class="paragraph"><p>A split container can have one of the following layouts:</p></div>
\r
117 <div class="dlist"><dl>
\r
118 <dt class="hdlist1">
\r
123 Windows are sized so that every window gets an equal amount of space in the
\r
124 container. splith distributes the windows horizontally (windows are right next
\r
125 to each other), splitv distributes them vertically (windows are on top of each
\r
129 <dt class="hdlist1">
\r
134 Only the focused window in the container is displayed. You get a list of
\r
135 windows at the top of the container.
\r
138 <dt class="hdlist1">
\r
143 The same principle as <tt>stacking</tt>, but the list of windows at the top is only
\r
144 a single line which is vertically split.
\r
148 <div class="paragraph"><p>To switch modes, press <tt>$mod+e</tt> for splith/splitv (it toggles), <tt>$mod+s</tt> for
\r
149 stacking and <tt>$mod+w</tt> for tabbed.</p></div>
\r
150 <div class="paragraph"><p><span class="image">
\r
151 <img src="modes.png" alt="Container modes" />
\r
154 <div class="sect2">
\r
155 <h3 id="_toggling_fullscreen_mode_for_a_window">2.3. Toggling fullscreen mode for a window</h3>
\r
156 <div class="paragraph"><p>To display a window in fullscreen mode or to go out of fullscreen mode again,
\r
157 press <tt>$mod+f</tt>.</p></div>
\r
158 <div class="paragraph"><p>There is also a global fullscreen mode in i3 in which the client will span all
\r
159 available outputs (the command is <tt>fullscreen toggle global</tt>).</p></div>
\r
161 <div class="sect2">
\r
162 <h3 id="_opening_other_applications">2.4. Opening other applications</h3>
\r
163 <div class="paragraph"><p>Aside from opening applications from a terminal, you can also use the handy
\r
164 <tt>dmenu</tt> which is opened by pressing <tt>$mod+d</tt> by default. Just type the name
\r
165 (or a part of it) of the application which you want to open. The corresponding
\r
166 application has to be in your <tt>$PATH</tt> for this to work.</p></div>
\r
167 <div class="paragraph"><p>Additionally, if you have applications you open very frequently, you can
\r
168 create a keybinding for starting the application directly. See the section
\r
169 <a href="#configuring">[configuring]</a> for details.</p></div>
\r
171 <div class="sect2">
\r
172 <h3 id="_closing_windows">2.5. Closing windows</h3>
\r
173 <div class="paragraph"><p>If an application does not provide a mechanism for closing (most applications
\r
174 provide a menu, the escape key or a shortcut like <tt>Control+w</tt> to close), you
\r
175 can press <tt>$mod+Shift+q</tt> to kill a window. For applications which support
\r
176 the WM_DELETE protocol, this will correctly close the application (saving
\r
177 any modifications or doing other cleanup). If the application doesn’t support
\r
178 the WM_DELETE protocol your X server will kill the window and the behaviour
\r
179 depends on the application.</p></div>
\r
181 <div class="sect2">
\r
182 <h3 id="_using_workspaces">2.6. Using workspaces</h3>
\r
183 <div class="paragraph"><p>Workspaces are an easy way to group a set of windows. By default, you are on
\r
184 the first workspace, as the bar on the bottom left indicates. To switch to
\r
185 another workspace, press <tt>$mod+num</tt> where <tt>num</tt> is the number of the workspace
\r
186 you want to use. If the workspace does not exist yet, it will be created.</p></div>
\r
187 <div class="paragraph"><p>A common paradigm is to put the web browser on one workspace, communication
\r
188 applications (<tt>mutt</tt>, <tt>irssi</tt>, …) on another one, and the ones with which you
\r
189 work, on the third one. Of course, there is no need to follow this approach.</p></div>
\r
190 <div class="paragraph"><p>If you have multiple screens, a workspace will be created on each screen at
\r
191 startup. If you open a new workspace, it will be bound to the screen you
\r
192 created it on. When you switch to a workspace on another screen, i3 will set
\r
193 focus to that screen.</p></div>
\r
195 <div class="sect2">
\r
196 <h3 id="_moving_windows_to_workspaces">2.7. Moving windows to workspaces</h3>
\r
197 <div class="paragraph"><p>To move a window to another workspace, simply press <tt>$mod+Shift+num</tt> where
\r
198 <tt>num</tt> is (like when switching workspaces) the number of the target workspace.
\r
199 Similarly to switching workspaces, the target workspace will be created if
\r
200 it does not yet exist.</p></div>
\r
202 <div class="sect2">
\r
203 <h3 id="_resizing">2.8. Resizing</h3>
\r
204 <div class="paragraph"><p>The easiest way to resize a container is by using the mouse: Grab the border
\r
205 and move it to the wanted size.</p></div>
\r
206 <div class="paragraph"><p>You can also use <a href="#binding_modes">[binding_modes]</a> to define a mode for resizing via the
\r
207 keyboard. To see an example for this, look at the
\r
208 <a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a> provided
\r
211 <div class="sect2">
\r
212 <h3 id="_restarting_i3_inplace">2.9. Restarting i3 inplace</h3>
\r
213 <div class="paragraph"><p>To restart i3 in place (and thus get into a clean state if there is a bug, or
\r
214 to upgrade to a newer version of i3) you can use <tt>$mod+Shift+r</tt>.</p></div>
\r
216 <div class="sect2">
\r
217 <h3 id="_exiting_i3">2.10. Exiting i3</h3>
\r
218 <div class="paragraph"><p>To cleanly exit i3 without killing your X server, you can use <tt>$mod+Shift+e</tt>.
\r
219 By default, a dialog will ask you to confirm if you really want to quit.</p></div>
\r
221 <div class="sect2">
\r
222 <h3 id="_floating">2.11. Floating</h3>
\r
223 <div class="paragraph"><p>Floating mode is the opposite of tiling mode. The position and size of
\r
224 a window are not managed automatically by i3, but manually by
\r
225 you. Using this mode violates the tiling paradigm but can be useful
\r
226 for some corner cases like "Save as" dialog windows, or toolbar
\r
227 windows (GIMP or similar). Those windows usually set the appropriate
\r
228 hint and are opened in floating mode by default.</p></div>
\r
229 <div class="paragraph"><p>You can toggle floating mode for a window by pressing <tt>$mod+Shift+Space</tt>. By
\r
230 dragging the window’s titlebar with your mouse you can move the window
\r
231 around. By grabbing the borders and moving them you can resize the window. You
\r
232 can also do that by using the <a href="#floating_modifier">[floating_modifier]</a>. Another way to resize
\r
233 floating windows using the mouse is to right-click on the titlebar and drag.</p></div>
\r
234 <div class="paragraph"><p>For resizing floating windows with your keyboard, see the resizing binding mode
\r
235 provided by the i3 <a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a>.</p></div>
\r
236 <div class="paragraph"><p>Floating windows are always on top of tiling windows.</p></div>
\r
240 <div class="sect1">
\r
241 <h2 id="_tree">3. Tree</h2>
\r
242 <div class="sectionbody">
\r
243 <div class="paragraph"><p>i3 stores all information about the X11 outputs, workspaces and layout of the
\r
244 windows on them in a tree. The root node is the X11 root window, followed by
\r
245 the X11 outputs, then dock areas and a content container, then workspaces and
\r
246 finally the windows themselves. In previous versions of i3 we had multiple lists
\r
247 (of outputs, workspaces) and a table for each workspace. That approach turned
\r
248 out to be complicated to use (snapping), understand and implement.</p></div>
\r
249 <div class="sect2">
\r
250 <h3 id="_the_tree_consists_of_containers">3.1. The tree consists of Containers</h3>
\r
251 <div class="paragraph"><p>The building blocks of our tree are so-called <tt>Containers</tt>. A <tt>Container</tt> can
\r
252 host a window (meaning an X11 window, one that you can actually see and use,
\r
253 like a browser). Alternatively, it could contain one or more <tt>Containers</tt>. A
\r
254 simple example is the workspace: When you start i3 with a single monitor, a
\r
255 single workspace and you open two terminal windows, you will end up with a tree
\r
256 like this:</p></div>
\r
257 <div class="imageblock" style="float:right;">
\r
258 <div class="content">
\r
259 <img src="tree-layout2.png" alt="layout2" />
\r
262 <div class="imageblock">
\r
263 <div class="content">
\r
264 <img src="tree-shot4.png" alt="shot4" />
\r
266 <div class="title">Figure 1. Two terminals on standard workspace</div>
\r
269 <div class="sect2">
\r
270 <h3 id="OrientationSplit">3.2. Orientation and Split Containers</h3>
\r
271 <div class="paragraph"><p>It is only natural to use so-called <tt>Split Containers</tt> in order to build a
\r
272 layout when using a tree as data structure. In i3, every <tt>Container</tt> has an
\r
273 orientation (horizontal, vertical or unspecified) and the orientation depends
\r
274 on the layout the container is in (vertical for splitv and stacking, horizontal
\r
275 for splith and tabbed). So, in our example with the workspace, the default
\r
276 layout of the workspace <tt>Container</tt> is splith (most monitors are widescreen
\r
277 nowadays). If you change the layout to splitv (<tt>$mod+v</tt> in the default config)
\r
278 and <strong>then</strong> open two terminals, i3 will configure your windows like this:</p></div>
\r
279 <div class="imageblock">
\r
280 <div class="content">
\r
281 <img src="tree-shot2.png" alt="shot2" />
\r
283 <div class="title">Figure 2. Vertical Workspace Orientation</div>
\r
285 <div class="paragraph"><p>An interesting new feature of i3 since version 4 is the ability to split anything:
\r
286 Let’s assume you have two terminals on a workspace (with splith layout, that is
\r
287 horizontal orientation), focus is on the right terminal. Now you want to open
\r
288 another terminal window below the current one. If you would just open a new
\r
289 terminal window, it would show up to the right due to the splith layout.
\r
290 Instead, press <tt>$mod+v</tt> to split the container with the splitv layout (to
\r
291 open a <tt>Horizontal Split Container</tt>, use <tt>$mod+h</tt>). Now you can open a new
\r
292 terminal and it will open below the current one:</p></div>
\r
293 <div class="imageblock" style="float:right;">
\r
294 <div class="content">
\r
295 <img src="tree-layout1.png" alt="Layout" />
\r
298 <div class="imageblock">
\r
299 <div class="content">
\r
300 <img src="tree-shot1.png" alt="shot" />
\r
302 <div class="title">Figure 3. Vertical Split Container</div>
\r
304 <div style="clear:both;"></div>
\r
305 <div class="paragraph"><p>You probably guessed it already: There is no limit on how deep your hierarchy
\r
306 of splits can be.</p></div>
\r
308 <div class="sect2">
\r
309 <h3 id="_focus_parent">3.3. Focus parent</h3>
\r
310 <div class="paragraph"><p>Let’s stay with our example from above. We have a terminal on the left and two
\r
311 vertically split terminals on the right, focus is on the bottom right one. When
\r
312 you open a new terminal, it will open below the current one.</p></div>
\r
313 <div class="paragraph"><p>So, how can you open a new terminal window to the <strong>right</strong> of the current one?
\r
314 The solution is to use <tt>focus parent</tt>, which will focus the <tt>Parent Container</tt> of
\r
315 the current <tt>Container</tt>. In this case, you would focus the <tt>Vertical Split
\r
316 Container</tt> which is <strong>inside</strong> the horizontally oriented workspace. Thus, now new
\r
317 windows will be opened to the right of the <tt>Vertical Split Container</tt>:</p></div>
\r
318 <div class="imageblock">
\r
319 <div class="content">
\r
320 <img src="tree-shot3.png" alt="shot3" />
\r
322 <div class="title">Figure 4. Focus parent, then open new terminal</div>
\r
325 <div class="sect2">
\r
326 <h3 id="_implicit_containers">3.4. Implicit containers</h3>
\r
327 <div class="paragraph"><p>In some cases, i3 needs to implicitly create a container to fulfill your
\r
329 <div class="paragraph"><p>One example is the following scenario: You start i3 with a single monitor and a
\r
330 single workspace on which you open three terminal windows. All these terminal
\r
331 windows are directly attached to one node inside i3’s layout tree, the
\r
332 workspace node. By default, the workspace node’s orientation is <tt>horizontal</tt>.</p></div>
\r
333 <div class="paragraph"><p>Now you move one of these terminals down (<tt>$mod+Shift+k</tt> by default). The
\r
334 workspace node’s orientation will be changed to <tt>vertical</tt>. The terminal window
\r
335 you moved down is directly attached to the workspace and appears on the bottom
\r
336 of the screen. A new (horizontal) container was created to accommodate the
\r
337 other two terminal windows. You will notice this when switching to tabbed mode
\r
338 (for example). You would end up having one tab with a representation of the split
\r
339 container (e.g., "H[urxvt firefox]") and the other one being the terminal window
\r
340 you moved down.</p></div>
\r
344 <div class="sect1">
\r
345 <h2 id="configuring">4. Configuring i3</h2>
\r
346 <div class="sectionbody">
\r
347 <div class="paragraph"><p>This is where the real fun begins ;-). Most things are very dependent on your
\r
348 ideal working environment so we can’t make reasonable defaults for them.</p></div>
\r
349 <div class="paragraph"><p>While not using a programming language for the configuration, i3 stays
\r
350 quite flexible in regards to the things you usually want your window manager
\r
352 <div class="paragraph"><p>For example, you can configure bindings to jump to specific windows,
\r
353 you can set specific applications to start on specific workspaces, you can
\r
354 automatically start applications, you can change the colors of i3, and you
\r
355 can bind your keys to do useful things.</p></div>
\r
356 <div class="paragraph"><p>To change the configuration of i3, copy <tt>/etc/i3/config</tt> to <tt>~/.i3/config</tt>
\r
357 (or <tt>~/.config/i3/config</tt> if you like the XDG directory scheme) and edit it
\r
358 with a text editor.</p></div>
\r
359 <div class="paragraph"><p>On first start (and on all following starts, unless you have a configuration
\r
360 file), i3 will offer you to create a configuration file. You can tell the
\r
361 wizard to use either Alt (<tt>Mod1</tt>) or Windows (<tt>Mod4</tt>) as modifier in the config
\r
362 file. Also, the created config file will use the key symbols of your current
\r
363 keyboard layout. To start the wizard, use the command <tt>i3-config-wizard</tt>.
\r
364 Please note that you must not have <tt>~/.i3/config</tt>, otherwise the wizard will
\r
366 <div class="paragraph"><p>Since i3 4.0, a new configuration format is used. i3 will try to automatically
\r
367 detect the format version of a config file based on a few different keywords,
\r
368 but if you want to make sure that your config is read with the new format,
\r
369 include the following line in your config file:</p></div>
\r
370 <div class="listingblock">
\r
371 <div class="content">
\r
372 <pre><tt># i3 config file (v4)</tt></pre>
\r
374 <div class="sect2">
\r
375 <h3 id="_comments">4.1. Comments</h3>
\r
376 <div class="paragraph"><p>It is possible and recommended to use comments in your configuration file to
\r
377 properly document your setup for later reference. Comments are started with
\r
378 a # and can only be used at the beginning of a line:</p></div>
\r
379 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
380 <div class="listingblock">
\r
381 <div class="content">
\r
382 <pre><tt># This is a comment</tt></pre>
\r
385 <div class="sect2">
\r
386 <h3 id="fonts">4.2. Fonts</h3>
\r
387 <div class="paragraph"><p>i3 has support for both X core fonts and FreeType fonts (through Pango) to
\r
388 render window titles.</p></div>
\r
389 <div class="paragraph"><p>To generate an X core font description, you can use <tt>xfontsel(1)</tt>. To see
\r
390 special characters (Unicode), you need to use a font which supports the
\r
391 ISO-10646 encoding.</p></div>
\r
392 <div class="paragraph"><p>A FreeType font description is composed by a font family, a style, a weight,
\r
393 a variant, a stretch and a size.
\r
394 FreeType fonts support right-to-left rendering and contain often more
\r
395 Unicode glyphs than X core fonts.</p></div>
\r
396 <div class="paragraph"><p>If i3 cannot open the configured font, it will output an error in the logfile
\r
397 and fall back to a working font.</p></div>
\r
398 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
399 <div class="listingblock">
\r
400 <div class="content">
\r
401 <pre><tt>font <X core font description>
\r
402 font pango:<family list> [<style options>] <size></tt></pre>
\r
404 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
405 <div class="listingblock">
\r
406 <div class="content">
\r
407 <pre><tt>font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
\r
408 font pango:DejaVu Sans Mono 10
\r
409 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
\r
410 font pango:Terminus 11px</tt></pre>
\r
413 <div class="sect2">
\r
414 <h3 id="keybindings">4.3. Keyboard bindings</h3>
\r
415 <div class="paragraph"><p>A keyboard binding makes i3 execute a command (see below) upon pressing a
\r
416 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
\r
417 also mix your bindings, though i3 will not protect you from overlapping ones).</p></div>
\r
418 <div class="ulist"><ul>
\r
421 A keysym (key symbol) is a description for a specific symbol, like "a"
\r
422 or "b", but also more strange ones like "underscore" instead of "_". These
\r
423 are the ones you use in Xmodmap to remap your keys. To get the current
\r
424 mapping of your keys, use <tt>xmodmap -pke</tt>. To interactively enter a key and
\r
425 see what keysym it is configured to, use <tt>xev</tt>.
\r
430 Keycodes do not need to have a symbol assigned (handy for custom vendor
\r
431 hotkeys on some notebooks) and they will not change their meaning as you
\r
432 switch to a different keyboard layout (when using <tt>xmodmap</tt>).
\r
436 <div class="paragraph"><p>My recommendation is: If you often switch keyboard layouts but you want to keep
\r
437 your bindings in the same physical location on the keyboard, use keycodes.
\r
438 If you don’t switch layouts, and want a clean and simple config file, use
\r
440 <div class="paragraph"><p>Some tools (such as <tt>import</tt> or <tt>xdotool</tt>) might be unable to run upon a
\r
441 KeyPress event, because the keyboard/pointer is still grabbed. For these
\r
442 situations, the <tt>--release</tt> flag can be used, which will execute the command
\r
443 after the keys have been released.</p></div>
\r
444 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
445 <div class="listingblock">
\r
446 <div class="content">
\r
447 <pre><tt>bindsym [--release] [<Group>+][<Modifiers>+]<keysym> command
\r
448 bindcode [--release] [<Group>+][<Modifiers>+]<keycode> command</tt></pre>
\r
450 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
451 <div class="listingblock">
\r
452 <div class="content">
\r
453 <pre><tt># Fullscreen
\r
454 bindsym $mod+f fullscreen toggle
\r
457 bindsym $mod+Shift+r restart
\r
459 # Notebook-specific hotkeys
\r
460 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
\r
462 # Simulate ctrl+v upon pressing $mod+x
\r
463 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
\r
465 # Take a screenshot upon pressing $mod+x (select an area)
\r
466 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png</tt></pre>
\r
468 <div class="paragraph"><p>Available Modifiers:</p></div>
\r
469 <div class="dlist"><dl>
\r
470 <dt class="hdlist1">
\r
471 Mod1-Mod5, Shift, Control
\r
475 Standard modifiers, see <tt>xmodmap(1)</tt>
\r
478 <dt class="hdlist1">
\r
479 Group1, Group2, Group3, Group4
\r
483 When using multiple keyboard layouts (e.g. with <tt>setxkbmap -layout us,ru</tt>), you
\r
484 can specify in which XKB group (also called “layout”) a keybinding should be
\r
485 active. By default, keybindings are translated in Group1 and are active in all
\r
486 groups. If you want to override keybindings in one of your layouts, specify the
\r
487 corresponding group. For backwards compatibility, the group “Mode_switch” is an
\r
493 <div class="sect2">
\r
494 <h3 id="mousebindings">4.4. Mouse bindings</h3>
\r
495 <div class="paragraph"><p>A mouse binding makes i3 execute a command upon pressing a specific mouse
\r
496 button in the scope of the clicked container (see <a href="#command_criteria">[command_criteria]</a>). You
\r
497 can configure mouse bindings in a similar way to key bindings.</p></div>
\r
498 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
499 <div class="listingblock">
\r
500 <div class="content">
\r
501 <pre><tt>bindsym [--release] [--border] [--whole-window] [--exclude-titlebar] [<Modifiers>+]button<n> command</tt></pre>
\r
503 <div class="paragraph"><p>By default, the binding will only run when you click on the titlebar of the
\r
504 window. If the <tt>--release</tt> flag is given, it will run when the mouse button
\r
505 is released.</p></div>
\r
506 <div class="paragraph"><p>If the <tt>--whole-window</tt> flag is given, the binding will also run when any part
\r
507 of the window is clicked, with the exception of the border. To have a bind run
\r
508 when the border is clicked, specify the <tt>--border</tt> flag.</p></div>
\r
509 <div class="paragraph"><p>If the <tt>--exclude-titlebar</tt> flag is given, the titlebar will not be considered
\r
510 for the keybinding.</p></div>
\r
511 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
512 <div class="listingblock">
\r
513 <div class="content">
\r
514 <pre><tt># The middle button over a titlebar kills the window
\r
515 bindsym --release button2 kill
\r
517 # The middle button and a modifer over any part of the window kills the window
\r
518 bindsym --whole-window $mod+button2 kill
\r
520 # The right button toggles floating
\r
521 bindsym button3 floating toggle
\r
522 bindsym $mod+button3 floating toggle
\r
524 # The side buttons move the window around
\r
525 bindsym button9 move left
\r
526 bindsym button8 move right</tt></pre>
\r
529 <div class="sect2">
\r
530 <h3 id="binding_modes">4.5. Binding modes</h3>
\r
531 <div class="paragraph"><p>You can have multiple sets of bindings by using different binding modes. When
\r
532 you switch to another binding mode, all bindings from the current mode are
\r
533 released and only the bindings defined in the new mode are valid for as long as
\r
534 you stay in that binding mode. The only predefined binding mode is <tt>default</tt>,
\r
535 which is the mode i3 starts out with and to which all bindings not defined in a
\r
536 specific binding mode belong.</p></div>
\r
537 <div class="paragraph"><p>Working with binding modes consists of two parts: defining a binding mode and
\r
538 switching to it. For these purposes, there are one config directive and one
\r
539 command, both of which are called <tt>mode</tt>. The directive is used to define the
\r
540 bindings belonging to a certain binding mode, while the command will switch to
\r
541 the specified mode.</p></div>
\r
542 <div class="paragraph"><p>It is recommended to use binding modes in combination with <a href="#variables">[variables]</a> in
\r
543 order to make maintenance easier. Below is an example of how to use a binding
\r
545 <div class="paragraph"><p>Note that it is advisable to define bindings for switching back to the default
\r
547 <div class="paragraph"><p>Note that it is possible to use <a href="#pango_markup">[pango_markup]</a> for binding modes, but you
\r
548 need to enable it explicitly by passing the <tt>--pango_markup</tt> flag to the mode
\r
549 definition.</p></div>
\r
550 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
551 <div class="listingblock">
\r
552 <div class="content">
\r
553 <pre><tt># config directive
\r
554 mode [--pango_markup] <name>
\r
557 mode <name></tt></pre>
\r
559 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
560 <div class="listingblock">
\r
561 <div class="content">
\r
562 <pre><tt># Press $mod+o followed by either f, t, Escape or Return to launch firefox,
\r
563 # thunderbird or return to the default mode, respectively.
\r
564 set $mode_launcher Launch: [f]irefox [t]hunderbird
\r
565 bindsym $mod+o mode "$mode_launcher"
\r
567 mode "$mode_launcher" {
\r
568 bindsym f exec firefox
\r
569 bindsym t exec thunderbird
\r
571 bindsym Escape mode "default"
\r
572 bindsym Return mode "default"
\r
576 <div class="sect2">
\r
577 <h3 id="floating_modifier">4.6. The floating modifier</h3>
\r
578 <div class="paragraph"><p>To move floating windows with your mouse, you can either grab their titlebar
\r
579 or configure the so-called floating modifier which you can then press and
\r
580 click anywhere in the window itself to move it. The most common setup is to
\r
581 use the same key you use for managing windows (Mod1 for example). Then
\r
582 you can press Mod1, click into a window using your left mouse button, and drag
\r
583 it to the position you want.</p></div>
\r
584 <div class="paragraph"><p>When holding the floating modifier, you can resize a floating window by
\r
585 pressing the right mouse button on it and moving around while holding it. If
\r
586 you hold the shift button as well, the resize will be proportional (the aspect
\r
587 ratio will be preserved).</p></div>
\r
588 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
589 <div class="listingblock">
\r
590 <div class="content">
\r
591 <pre><tt>floating_modifier <Modifier></tt></pre>
\r
593 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
594 <div class="listingblock">
\r
595 <div class="content">
\r
596 <pre><tt>floating_modifier Mod1</tt></pre>
\r
599 <div class="sect2">
\r
600 <h3 id="_constraining_floating_window_size">4.7. Constraining floating window size</h3>
\r
601 <div class="paragraph"><p>The maximum and minimum dimensions of floating windows can be specified. If
\r
602 either dimension of <tt>floating_maximum_size</tt> is specified as -1, that dimension
\r
603 will be unconstrained with respect to its maximum value. If either dimension of
\r
604 <tt>floating_maximum_size</tt> is undefined, or specified as 0, i3 will use a default
\r
605 value to constrain the maximum size. <tt>floating_minimum_size</tt> is treated in a
\r
606 manner analogous to <tt>floating_maximum_size</tt>.</p></div>
\r
607 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
608 <div class="listingblock">
\r
609 <div class="content">
\r
610 <pre><tt>floating_minimum_size <width> x <height>
\r
611 floating_maximum_size <width> x <height></tt></pre>
\r
613 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
614 <div class="listingblock">
\r
615 <div class="content">
\r
616 <pre><tt>floating_minimum_size 75 x 50
\r
617 floating_maximum_size -1 x -1</tt></pre>
\r
620 <div class="sect2">
\r
621 <h3 id="_orientation_for_new_workspaces">4.8. Orientation for new workspaces</h3>
\r
622 <div class="paragraph"><p>New workspaces get a reasonable default orientation: Wide-screen monitors
\r
623 (anything wider than high) get horizontal orientation, rotated monitors
\r
624 (anything higher than wide) get vertical orientation.</p></div>
\r
625 <div class="paragraph"><p>With the <tt>default_orientation</tt> configuration directive, you can override that
\r
626 behavior.</p></div>
\r
627 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
628 <div class="listingblock">
\r
629 <div class="content">
\r
630 <pre><tt>default_orientation horizontal|vertical|auto</tt></pre>
\r
632 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
633 <div class="listingblock">
\r
634 <div class="content">
\r
635 <pre><tt>default_orientation vertical</tt></pre>
\r
638 <div class="sect2">
\r
639 <h3 id="_layout_mode_for_new_containers">4.9. Layout mode for new containers</h3>
\r
640 <div class="paragraph"><p>This option determines in which mode new containers on workspace level will
\r
642 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
643 <div class="listingblock">
\r
644 <div class="content">
\r
645 <pre><tt>workspace_layout default|stacking|tabbed</tt></pre>
\r
647 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
648 <div class="listingblock">
\r
649 <div class="content">
\r
650 <pre><tt>workspace_layout tabbed</tt></pre>
\r
653 <div class="sect2">
\r
654 <h3 id="_default_border_style_for_new_windows">4.10. Default border style for new windows</h3>
\r
655 <div class="paragraph"><p>This option determines which border style new windows will have. The default is
\r
656 <tt>normal</tt>. Note that default_floating_border applies only to windows which are starting out as
\r
657 floating windows, e.g., dialog windows, but not windows that are floated later on.</p></div>
\r
658 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
659 <div class="listingblock">
\r
660 <div class="content">
\r
661 <pre><tt>default_border normal|none|pixel
\r
662 default_border normal|pixel <px>
\r
663 default_floating_border normal|none|pixel
\r
664 default_floating_border normal|pixel <px></tt></pre>
\r
666 <div class="paragraph"><p>Please note that <tt>new_window</tt> and <tt>new_float</tt> have been deprecated in favor of the above options
\r
667 and will be removed in a future release. We strongly recommend using the new options instead.</p></div>
\r
668 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
669 <div class="listingblock">
\r
670 <div class="content">
\r
671 <pre><tt>default_border pixel</tt></pre>
\r
673 <div class="paragraph"><p>The "normal" and "pixel" border styles support an optional border width in
\r
675 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
676 <div class="listingblock">
\r
677 <div class="content">
\r
678 <pre><tt># The same as default_border none
\r
679 default_border pixel 0
\r
682 default_border pixel 3</tt></pre>
\r
685 <div class="sect2">
\r
686 <h3 id="_hiding_vertical_borders">4.11. Hiding borders adjacent to the screen edges</h3>
\r
687 <div class="paragraph"><p>You can hide container borders adjacent to the screen edges using
\r
688 <tt>hide_edge_borders</tt>. This is useful if you are using scrollbars, or do not want
\r
689 to waste even two pixels in displayspace. The "smart" setting hides borders on
\r
690 workspaces with only one window visible, but keeps them on workspaces with
\r
691 multiple windows visible. Default is none.</p></div>
\r
692 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
693 <div class="listingblock">
\r
694 <div class="content">
\r
695 <pre><tt>hide_edge_borders none|vertical|horizontal|both|smart</tt></pre>
\r
697 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
698 <div class="listingblock">
\r
699 <div class="content">
\r
700 <pre><tt>hide_edge_borders vertical</tt></pre>
\r
703 <div class="sect2">
\r
704 <h3 id="for_window">4.12. Arbitrary commands for specific windows (for_window)</h3>
\r
705 <div class="paragraph"><p>With the <tt>for_window</tt> command, you can let i3 execute any command when it
\r
706 encounters a specific window. This can be used to set windows to floating or to
\r
707 change their border style, for example.</p></div>
\r
708 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
709 <div class="listingblock">
\r
710 <div class="content">
\r
711 <pre><tt>for_window <criteria> <command></tt></pre>
\r
713 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
714 <div class="listingblock">
\r
715 <div class="content">
\r
716 <pre><tt># enable floating mode for all XTerm windows
\r
717 for_window [class="XTerm"] floating enable
\r
719 # Make all urxvts use a 1-pixel border:
\r
720 for_window [class="urxvt"] border pixel 1
\r
722 # A less useful, but rather funny example:
\r
723 # makes the window floating as soon as I change
\r
724 # directory to ~/work
\r
725 for_window [title="x200: ~/work"] floating enable</tt></pre>
\r
727 <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
729 <div class="sect2">
\r
730 <h3 id="no_focus">4.13. Don’t focus window upon opening</h3>
\r
731 <div class="paragraph"><p>When a new window appears, it will be focused. The <tt>no_focus</tt> directive allows preventing
\r
732 this from happening and must be used in combination with <a href="#command_criteria">[command_criteria]</a>.</p></div>
\r
733 <div class="paragraph"><p>Note that this does not apply to all cases, e.g., when feeding data into a running application
\r
734 causing it to request being focused. To configure the behavior in such cases, refer to
\r
735 <a href="#focus_on_window_activation">[focus_on_window_activation]</a>.</p></div>
\r
736 <div class="paragraph"><p><tt>no_focus</tt> will also be ignored for the first window on a workspace as there shouldn’t be
\r
737 a reason to not focus the window in this case. This allows for better usability in
\r
738 combination with <tt>workspace_layout</tt>.</p></div>
\r
739 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
740 <div class="listingblock">
\r
741 <div class="content">
\r
742 <pre><tt>no_focus <criteria></tt></pre>
\r
744 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
745 <div class="listingblock">
\r
746 <div class="content">
\r
747 <pre><tt>no_focus [window_role="pop-up"]</tt></pre>
\r
750 <div class="sect2">
\r
751 <h3 id="variables">4.14. Variables</h3>
\r
752 <div class="paragraph"><p>As you learned in the section about keyboard bindings, you will have
\r
753 to configure lots of bindings containing modifier keys. If you want to save
\r
754 yourself some typing and be able to change the modifier you use later,
\r
755 variables can be handy.</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>set $<name> <value></tt></pre>
\r
761 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
762 <div class="listingblock">
\r
763 <div class="content">
\r
764 <pre><tt>set $m Mod1
\r
765 bindsym $m+Shift+r restart</tt></pre>
\r
767 <div class="paragraph"><p>Variables are directly replaced in the file when parsing. Variables expansion
\r
768 is not recursive so it is not possible to define a variable with a value
\r
769 containing another variable. There is no fancy handling and there are
\r
770 absolutely no plans to change this. If you need a more dynamic configuration
\r
771 you should create a little script which generates a configuration file and run
\r
772 it before starting i3 (for example in your <tt>~/.xsession</tt> file).</p></div>
\r
773 <div class="paragraph"><p>Also see <a href="#xresources">[xresources]</a> to learn how to create variables based on resources
\r
774 loaded from the X resource database.</p></div>
\r
776 <div class="sect2">
\r
777 <h3 id="xresources">4.15. X resources</h3>
\r
778 <div class="paragraph"><p><a href="#variables">[variables]</a> can also be created using a value configured in the X resource
\r
779 database. This is useful, for example, to avoid configuring color values within
\r
780 the i3 configuration. Instead, the values can be configured, once, in the X
\r
781 resource database to achieve an easily maintainable, consistent color theme
\r
782 across many X applications.</p></div>
\r
783 <div class="paragraph"><p>Defining a resource will load this resource from the resource database and
\r
784 assign its value to the specified variable. A fallback must be specified in
\r
785 case the resource cannot be loaded from the database.</p></div>
\r
786 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
787 <div class="listingblock">
\r
788 <div class="content">
\r
789 <pre><tt>set_from_resource $<name> <resource_name> <fallback></tt></pre>
\r
791 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
792 <div class="listingblock">
\r
793 <div class="content">
\r
794 <pre><tt># The ~/.Xresources should contain a line such as
\r
796 # and must be loaded properly, e.g., by using
\r
797 # xrdb ~/.Xresources
\r
798 # This value is picked up on by other applications (e.g., the URxvt terminal
\r
799 # emulator) and can be used in i3 like this:
\r
800 set_from_resource $black i3wm.color0 #000000</tt></pre>
\r
803 <div class="sect2">
\r
804 <h3 id="assign_workspace">4.16. Automatically putting clients on specific workspaces</h3>
\r
805 <div class="paragraph"><p>To automatically make a specific window show up on a specific workspace, you
\r
806 can use an <strong>assignment</strong>. You can match windows by using any criteria,
\r
807 see <a href="#command_criteria">[command_criteria]</a>. It is recommended that you match on window classes
\r
808 (and instances, when appropriate) instead of window titles whenever possible
\r
809 because some applications first create their window, and then worry about
\r
810 setting the correct title. Firefox with Vimperator comes to mind. The window
\r
811 starts up being named Firefox, and only when Vimperator is loaded does the
\r
812 title change. As i3 will get the title as soon as the application maps the
\r
813 window (mapping means actually displaying it on the screen), you’d need to have
\r
814 to match on <em>Firefox</em> in this case.</p></div>
\r
815 <div class="paragraph"><p>You can also assign a window to show up on a specific output. You can use RandR
\r
816 names such as <tt>VGA1</tt> or names relative to the output with the currently focused
\r
817 workspace such as <tt>left</tt> and <tt>down</tt>.</p></div>
\r
818 <div class="paragraph"><p>Assignments are processed by i3 in the order in which they appear in the config
\r
819 file. The first one which matches the window wins and later assignments are not
\r
820 considered.</p></div>
\r
821 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
822 <div class="listingblock">
\r
823 <div class="content">
\r
824 <pre><tt>assign <criteria> [→] [workspace] [number] <workspace>
\r
825 assign <criteria> [→] output left|right|up|down|primary|<output></tt></pre>
\r
827 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
828 <div class="listingblock">
\r
829 <div class="content">
\r
830 <pre><tt># Assign URxvt terminals to workspace 2
\r
831 assign [class="URxvt"] 2
\r
833 # Same thing, but more precise (exact match instead of substring)
\r
834 assign [class="^URxvt$"] 2
\r
836 # Same thing, but with a beautiful arrow :)
\r
837 assign [class="^URxvt$"] → 2
\r
839 # Assignment to a named workspace
\r
840 assign [class="^URxvt$"] → work
\r
842 # Assign to the workspace with number 2, regardless of name
\r
843 assign [class="^URxvt$"] → number 2
\r
845 # You can also specify a number + name. If the workspace with number 2 exists, assign will skip the text part.
\r
846 assign [class="^URxvt$"] → number "2: work"
\r
848 # Start urxvt -name irssi
\r
849 assign [class="^URxvt$" instance="^irssi$"] → 3
\r
851 # Assign urxvt to the output right of the current one
\r
852 assign [class="^URxvt$"] → output right
\r
854 # Assign urxvt to the primary output
\r
855 assign [class="^URxvt$"] → output primary</tt></pre>
\r
857 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>
\r
858 <div class="listingblock">
\r
859 <div class="content">
\r
860 <pre><tt>xrandr --output <output> --primary</tt></pre>
\r
862 <div class="paragraph"><p>Also, the arrow is not required, it just looks good :-). If you decide to
\r
863 use it, it has to be a UTF-8 encoded arrow, not <tt>-></tt> or something like that.</p></div>
\r
864 <div class="paragraph"><p>To get the class and instance, you can use <tt>xprop</tt>. After clicking on the
\r
865 window, you will see the following output:</p></div>
\r
866 <div class="paragraph"><p><strong>xprop</strong>:</p></div>
\r
867 <div class="listingblock">
\r
868 <div class="content">
\r
869 <pre><tt>WM_CLASS(STRING) = "irssi", "URxvt"</tt></pre>
\r
871 <div class="paragraph"><p>The first part of the WM_CLASS is the instance ("irssi" in this example), the
\r
872 second part is the class ("URxvt" in this example).</p></div>
\r
873 <div class="paragraph"><p>Should you have any problems with assignments, make sure to check the i3
\r
874 logfile first (see <a href="https://i3wm.org/docs/debugging.html">https://i3wm.org/docs/debugging.html</a>). It includes more
\r
875 details about the matching process and the window’s actual class, instance and
\r
876 title when starting up.</p></div>
\r
877 <div class="paragraph"><p>Note that if you want to start an application just once on a specific
\r
878 workspace, but you don’t want to assign all instances of it permanently, you
\r
879 can make use of i3’s startup-notification support (see <a href="#exec">[exec]</a>) in your config
\r
880 file in the following way:</p></div>
\r
881 <div class="paragraph"><p><strong>Start iceweasel on workspace 3 (once)</strong>:</p></div>
\r
882 <div class="listingblock">
\r
883 <div class="content">
\r
884 <pre><tt># Start iceweasel on workspace 3, then switch back to workspace 1
\r
885 # (Being a command-line utility, i3-msg does not support startup notifications,
\r
886 # hence the exec --no-startup-id.)
\r
887 # (Starting iceweasel with i3’s exec command is important in order to make i3
\r
888 # create a startup notification context, without which the iceweasel window(s)
\r
889 # cannot be matched onto the workspace on which the command was started.)
\r
890 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'</tt></pre>
\r
893 <div class="sect2">
\r
894 <h3 id="_automatically_starting_applications_on_i3_startup">4.17. Automatically starting applications on i3 startup</h3>
\r
895 <div class="paragraph"><p>By using the <tt>exec</tt> keyword outside a keybinding, you can configure
\r
896 which commands will be performed by i3 on initial startup. <tt>exec</tt>
\r
897 commands will not run when restarting i3, if you need a command to run
\r
898 also when restarting i3 you should use the <tt>exec_always</tt>
\r
899 keyword. These commands will be run in order.</p></div>
\r
900 <div class="paragraph"><p>See <a href="#command_chaining">[command_chaining]</a> for details on the special meaning of <tt>;</tt> (semicolon)
\r
901 and <tt>,</tt> (comma): they chain commands together in i3, so you need to use quoted
\r
902 strings (as shown in <a href="#exec_quoting">[exec_quoting]</a>) if they appear in your command.</p></div>
\r
903 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
904 <div class="listingblock">
\r
905 <div class="content">
\r
906 <pre><tt>exec [--no-startup-id] <command>
\r
907 exec_always [--no-startup-id] <command></tt></pre>
\r
909 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
910 <div class="listingblock">
\r
911 <div class="content">
\r
912 <pre><tt>exec chromium
\r
913 exec_always ~/my_script.sh
\r
915 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
\r
916 exec --no-startup-id urxvt</tt></pre>
\r
918 <div class="paragraph"><p>The flag --no-startup-id is explained in <a href="#exec">[exec]</a>.</p></div>
\r
920 <div class="sect2">
\r
921 <h3 id="workspace_screen">4.18. Automatically putting workspaces on specific screens</h3>
\r
922 <div class="paragraph"><p>If you assign clients to workspaces, it might be handy to put the
\r
923 workspaces on specific screens. Also, the assignment of workspaces to screens
\r
924 will determine which workspace i3 uses for a new screen when adding screens
\r
925 or when starting (e.g., by default it will use 1 for the first screen, 2 for
\r
926 the second screen and so on).</p></div>
\r
927 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
928 <div class="listingblock">
\r
929 <div class="content">
\r
930 <pre><tt>workspace <workspace> output <output></tt></pre>
\r
932 <div class="paragraph"><p>The <em>output</em> is the name of the RandR output you attach your screen to. On a
\r
933 laptop, you might have VGA1 and LVDS1 as output names. You can see the
\r
934 available outputs by running <tt>xrandr --current</tt>.</p></div>
\r
935 <div class="paragraph"><p>If your X server supports RandR 1.5 or newer, i3 will use RandR monitor objects
\r
936 instead of output objects. Run <tt>xrandr --listmonitors</tt> to see a list. Usually,
\r
937 a monitor object contains exactly one output, and has the same name as the
\r
938 output; but should that not be the case, you may specify the name of either the
\r
939 monitor or the output in i3’s configuration. For example, the Dell UP2414Q uses
\r
940 two scalers internally, so its output names might be “DP1” and “DP2”, but the
\r
941 monitor name is “Dell UP2414Q”.</p></div>
\r
942 <div class="paragraph"><p>(Note that even if you specify the name of an output which doesn’t span the
\r
943 entire monitor, i3 will still use the entire area of the containing monitor
\r
944 rather than that of just the output’s.)</p></div>
\r
945 <div class="paragraph"><p>If you use named workspaces, they must be quoted:</p></div>
\r
946 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
947 <div class="listingblock">
\r
948 <div class="content">
\r
949 <pre><tt>workspace 1 output LVDS1
\r
950 workspace 5 output VGA1
\r
951 workspace "2: vim" output VGA1</tt></pre>
\r
954 <div class="sect2">
\r
955 <h3 id="_changing_colors">4.19. Changing colors</h3>
\r
956 <div class="paragraph"><p>You can change all colors which i3 uses to draw the window decorations.</p></div>
\r
957 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
958 <div class="listingblock">
\r
959 <div class="content">
\r
960 <pre><tt><colorclass> <border> <background> <text> <indicator> <child_border></tt></pre>
\r
962 <div class="paragraph"><p>Where colorclass can be one of:</p></div>
\r
963 <div class="dlist"><dl>
\r
964 <dt class="hdlist1">
\r
969 A client which currently has the focus.
\r
972 <dt class="hdlist1">
\r
973 client.focused_inactive
\r
977 A client which is the focused one of its container, but it does not have
\r
978 the focus at the moment.
\r
981 <dt class="hdlist1">
\r
986 A client which is not the focused one of its container.
\r
989 <dt class="hdlist1">
\r
994 A client which has its urgency hint activated.
\r
997 <dt class="hdlist1">
\r
1002 Background and text color are used to draw placeholder window contents
\r
1003 (when restoring layouts). Border and indicator are ignored.
\r
1006 <dt class="hdlist1">
\r
1011 Background color which will be used to paint the background of the
\r
1012 client window on top of which the client will be rendered. Only clients
\r
1013 which do not cover the whole area of this window expose the color. Note
\r
1014 that this colorclass only takes a single color.
\r
1018 <div class="paragraph"><p>Colors are in HTML hex format (#rrggbb), see the following example:</p></div>
\r
1019 <div class="paragraph"><p><strong>Examples (default colors)</strong>:</p></div>
\r
1020 <div class="listingblock">
\r
1021 <div class="content">
\r
1022 <pre><tt># class border backgr. text indicator child_border
\r
1023 client.focused #4c7899 #285577 #ffffff #2e9ef4 #285577
\r
1024 client.focused_inactive #333333 #5f676a #ffffff #484e50 #5f676a
\r
1025 client.unfocused #333333 #222222 #888888 #292d2e #222222
\r
1026 client.urgent #2f343a #900000 #ffffff #900000 #900000
\r
1027 client.placeholder #000000 #0c0c0c #ffffff #000000 #0c0c0c
\r
1029 client.background #ffffff</tt></pre>
\r
1031 <div class="paragraph"><p>Note that for the window decorations, the color around the child window is the
\r
1032 "child_border", and "border" color is only the two thin lines around the
\r
1033 titlebar.</p></div>
\r
1034 <div class="paragraph"><p>The indicator color is used for indicating where a new window will be opened.
\r
1035 For horizontal split containers, the right border will be painted in indicator
\r
1036 color, for vertical split containers, the bottom border. This only applies to
\r
1037 single windows within a split container, which are otherwise indistinguishable
\r
1038 from single windows outside of a split container.</p></div>
\r
1040 <div class="sect2">
\r
1041 <h3 id="_interprocess_communication">4.20. Interprocess communication</h3>
\r
1042 <div class="paragraph"><p>i3 uses Unix sockets to provide an IPC interface. This allows third-party
\r
1043 programs to get information from i3, such as the current workspaces
\r
1044 (to display a workspace bar), and to control i3.</p></div>
\r
1045 <div class="paragraph"><p>The IPC socket is enabled by default and will be created in
\r
1046 <tt>/tmp/i3-%u.XXXXXX/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username, <tt>%p</tt> is
\r
1047 the PID of i3 and XXXXXX is a string of random characters from the portable
\r
1048 filename character set (see mkdtemp(3)).</p></div>
\r
1049 <div class="paragraph"><p>You can override the default path through the environment-variable <tt>I3SOCK</tt> or
\r
1050 by specifying the <tt>ipc-socket</tt> directive. This is discouraged, though, since i3
\r
1051 does the right thing by default. If you decide to change it, it is strongly
\r
1052 recommended to set this to a location in your home directory so that no other
\r
1053 user can create that directory.</p></div>
\r
1054 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
1055 <div class="listingblock">
\r
1056 <div class="content">
\r
1057 <pre><tt>ipc-socket ~/.i3/i3-ipc.sock</tt></pre>
\r
1059 <div class="paragraph"><p>You can then use the <tt>i3-msg</tt> application to perform any command listed in
\r
1060 the next section.</p></div>
\r
1062 <div class="sect2">
\r
1063 <h3 id="_focus_follows_mouse">4.21. Focus follows mouse</h3>
\r
1064 <div class="paragraph"><p>By default, window focus follows your mouse movements as the mouse crosses
\r
1065 window borders. However, if you have a setup where your mouse usually is in your
\r
1066 way (like a touchpad on your laptop which you do not want to disable
\r
1067 completely), you might want to disable <em>focus follows mouse</em> and control focus
\r
1068 only by using your keyboard. The mouse will still be useful inside the
\r
1069 currently active window (for example to click on links in your browser window).</p></div>
\r
1070 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1071 <div class="listingblock">
\r
1072 <div class="content">
\r
1073 <pre><tt>focus_follows_mouse yes|no</tt></pre>
\r
1075 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1076 <div class="listingblock">
\r
1077 <div class="content">
\r
1078 <pre><tt>focus_follows_mouse no</tt></pre>
\r
1081 <div class="sect2">
\r
1082 <h3 id="_mouse_warping">4.22. Mouse warping</h3>
\r
1083 <div class="paragraph"><p>By default, when switching focus to a window on a different output (e.g.
\r
1084 focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on
\r
1085 LVDS-1), the mouse cursor is warped to the center of that window.</p></div>
\r
1086 <div class="paragraph"><p>With the <tt>mouse_warping</tt> option, you can control when the mouse cursor should
\r
1087 be warped. <tt>none</tt> disables warping entirely, whereas <tt>output</tt> is the default
\r
1088 behavior described above.</p></div>
\r
1089 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1090 <div class="listingblock">
\r
1091 <div class="content">
\r
1092 <pre><tt>mouse_warping output|none</tt></pre>
\r
1094 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1095 <div class="listingblock">
\r
1096 <div class="content">
\r
1097 <pre><tt>mouse_warping none</tt></pre>
\r
1100 <div class="sect2">
\r
1101 <h3 id="_popups_during_fullscreen_mode">4.23. Popups during fullscreen mode</h3>
\r
1102 <div class="paragraph"><p>When you are in fullscreen mode, some applications still open popup windows
\r
1103 (take Xpdf for example). This is because these applications may not be aware
\r
1104 that they are in fullscreen mode (they do not check the corresponding hint).
\r
1105 There are three things which are possible to do in this situation:</p></div>
\r
1106 <div class="olist arabic"><ol class="arabic">
\r
1109 Display the popup if it belongs to the fullscreen application only. This is
\r
1110 the default and should be reasonable behavior for most users.
\r
1115 Just ignore the popup (don’t map it). This won’t interrupt you while you are
\r
1116 in fullscreen. However, some apps might react badly to this (deadlock until
\r
1117 you go out of fullscreen).
\r
1122 Leave fullscreen mode.
\r
1126 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1127 <div class="listingblock">
\r
1128 <div class="content">
\r
1129 <pre><tt>popup_during_fullscreen smart|ignore|leave_fullscreen</tt></pre>
\r
1131 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1132 <div class="listingblock">
\r
1133 <div class="content">
\r
1134 <pre><tt>popup_during_fullscreen smart</tt></pre>
\r
1137 <div class="sect2">
\r
1138 <h3 id="_focus_wrapping">4.24. Focus wrapping</h3>
\r
1139 <div class="paragraph"><p>By default, when in a container with several windows or child containers, the
\r
1140 opposite window will be focused when trying to move the focus over the edge of
\r
1141 a container (and there are no other containers in that direction) — the focus
\r
1143 <div class="paragraph"><p>If desired, you can disable this behavior by setting the <tt>focus_wrapping</tt>
\r
1144 configuration directive to the value <tt>no</tt>.</p></div>
\r
1145 <div class="paragraph"><p>When enabled, focus wrapping does not occur by default if there is another
\r
1146 window or container in the specified direction, and focus will instead be set
\r
1147 on that window or container. This is the default behavior so you can navigate
\r
1148 to all your windows without having to use <tt>focus parent</tt>.</p></div>
\r
1149 <div class="paragraph"><p>If you want the focus to <strong>always</strong> wrap and you are aware of using <tt>focus
\r
1150 parent</tt> to switch to different containers, you can instead set <tt>focus_wrapping</tt>
\r
1151 to the value <tt>force</tt>.</p></div>
\r
1152 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1153 <div class="listingblock">
\r
1154 <div class="content">
\r
1155 <pre><tt>focus_wrapping yes|no|force
\r
1157 # Legacy syntax, equivalent to "focus_wrapping force"
\r
1158 force_focus_wrapping yes</tt></pre>
\r
1160 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
1161 <div class="listingblock">
\r
1162 <div class="content">
\r
1163 <pre><tt># Disable focus wrapping
\r
1166 # Force focus wrapping
\r
1167 focus_wrapping force</tt></pre>
\r
1170 <div class="sect2">
\r
1171 <h3 id="_forcing_xinerama">4.25. Forcing Xinerama</h3>
\r
1172 <div class="paragraph"><p>As explained in-depth in <a href="https://i3wm.org/docs/multi-monitor.html">https://i3wm.org/docs/multi-monitor.html</a>, some X11
\r
1173 video drivers (especially the nVidia binary driver) only provide support for
\r
1174 Xinerama instead of RandR. In such a situation, i3 must be told to use the
\r
1175 inferior Xinerama API explicitly and therefore don’t provide support for
\r
1176 reconfiguring your screens on the fly (they are read only once on startup and
\r
1177 that’s it).</p></div>
\r
1178 <div class="paragraph"><p>For people who cannot modify their <tt>~/.xsession</tt> to add the
\r
1179 <tt>--force-xinerama</tt> commandline parameter, a configuration option is provided:</p></div>
\r
1180 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1181 <div class="listingblock">
\r
1182 <div class="content">
\r
1183 <pre><tt>force_xinerama yes|no</tt></pre>
\r
1185 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1186 <div class="listingblock">
\r
1187 <div class="content">
\r
1188 <pre><tt>force_xinerama yes</tt></pre>
\r
1190 <div class="paragraph"><p>Also note that your output names are not descriptive (like <tt>HDMI1</tt>) when using
\r
1191 Xinerama, instead they are counted up, starting at 0: <tt>xinerama-0</tt>, <tt>xinerama-1</tt>, …</p></div>
\r
1193 <div class="sect2">
\r
1194 <h3 id="_automatic_back_and_forth_when_switching_to_the_current_workspace">4.26. Automatic back-and-forth when switching to the current workspace</h3>
\r
1195 <div class="paragraph"><p>This configuration directive enables automatic <tt>workspace back_and_forth</tt> (see
\r
1196 <a href="#back_and_forth">[back_and_forth]</a>) when switching to the workspace that is currently focused.</p></div>
\r
1197 <div class="paragraph"><p>For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
\r
1198 mod+2 because somebody sent you a message. You don’t need to remember where you
\r
1199 came from now, you can just press $mod+2 again to switch back to "1: www".</p></div>
\r
1200 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1201 <div class="listingblock">
\r
1202 <div class="content">
\r
1203 <pre><tt>workspace_auto_back_and_forth yes|no</tt></pre>
\r
1205 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1206 <div class="listingblock">
\r
1207 <div class="content">
\r
1208 <pre><tt>workspace_auto_back_and_forth yes</tt></pre>
\r
1211 <div class="sect2">
\r
1212 <h3 id="_delaying_urgency_hint_reset_on_workspace_change">4.27. Delaying urgency hint reset on workspace change</h3>
\r
1213 <div class="paragraph"><p>If an application on another workspace sets an urgency hint, switching to this
\r
1214 workspace may lead to immediate focus of the application, which also means the
\r
1215 window decoration color would be immediately reset to <tt>client.focused</tt>. This
\r
1216 may make it unnecessarily hard to tell which window originally raised the
\r
1218 <div class="paragraph"><p>In order to prevent this, you can tell i3 to delay resetting the urgency state
\r
1219 by a certain time using the <tt>force_display_urgency_hint</tt> directive. Setting the
\r
1220 value to 0 disables this feature.</p></div>
\r
1221 <div class="paragraph"><p>The default is 500ms.</p></div>
\r
1222 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1223 <div class="listingblock">
\r
1224 <div class="content">
\r
1225 <pre><tt>force_display_urgency_hint <timeout> ms</tt></pre>
\r
1227 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1228 <div class="listingblock">
\r
1229 <div class="content">
\r
1230 <pre><tt>force_display_urgency_hint 500 ms</tt></pre>
\r
1233 <div class="sect2">
\r
1234 <h3 id="focus_on_window_activation">4.28. Focus on window activation</h3>
\r
1235 <div class="paragraph"><p>If a window is activated, e.g., via <tt>google-chrome www.google.com</tt>, it may request
\r
1236 to take focus. Since this may not preferable, different reactions can be configured.</p></div>
\r
1237 <div class="paragraph"><p>Note that this may not affect windows that are being opened. To prevent new windows
\r
1238 from being focused, see <a href="#no_focus">[no_focus]</a>.</p></div>
\r
1239 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1240 <div class="listingblock">
\r
1241 <div class="content">
\r
1242 <pre><tt>focus_on_window_activation smart|urgent|focus|none</tt></pre>
\r
1244 <div class="paragraph"><p>The different modes will act as follows:</p></div>
\r
1245 <div class="dlist"><dl>
\r
1246 <dt class="hdlist1">
\r
1251 This is the default behavior. If the window requesting focus is on an active
\r
1252 workspace, it will receive the focus. Otherwise, the urgency hint will be set.
\r
1255 <dt class="hdlist1">
\r
1260 The window will always be marked urgent, but the focus will not be stolen.
\r
1263 <dt class="hdlist1">
\r
1268 The window will always be focused and not be marked urgent.
\r
1271 <dt class="hdlist1">
\r
1276 The window will neither be focused, nor be marked urgent.
\r
1281 <div class="sect2">
\r
1282 <h3 id="show_marks">4.29. Drawing marks on window decoration</h3>
\r
1283 <div class="paragraph"><p>If activated, marks (see <a href="#vim_like_marks">[vim_like_marks]</a>) on windows are drawn in their window
\r
1284 decoration. However, any mark starting with an underscore in its name (<tt>_</tt>) will
\r
1285 not be drawn even if this option is activated.</p></div>
\r
1286 <div class="paragraph"><p>The default for this option is <tt>yes</tt>.</p></div>
\r
1287 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1288 <div class="listingblock">
\r
1289 <div class="content">
\r
1290 <pre><tt>show_marks yes|no</tt></pre>
\r
1292 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1293 <div class="listingblock">
\r
1294 <div class="content">
\r
1295 <pre><tt>show_marks yes</tt></pre>
\r
1298 <div class="sect2">
\r
1299 <h3 id="line_continuation">4.30. Line continuation</h3>
\r
1300 <div class="paragraph"><p>Config files support line continuation, meaning when you end a line in a
\r
1301 backslash character (<tt>\</tt>), the line-break will be ignored by the parser. This
\r
1302 feature can be used to create more readable configuration files.
\r
1303 Commented lines are not continued.</p></div>
\r
1304 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
1305 <div class="listingblock">
\r
1306 <div class="content">
\r
1307 <pre><tt>bindsym Mod1+f \
\r
1310 # this line is not continued \
\r
1311 bindsym Mod1+F fullscreen toggle</tt></pre>
\r
1316 <div class="sect1">
\r
1317 <h2 id="_configuring_i3bar">5. Configuring i3bar</h2>
\r
1318 <div class="sectionbody">
\r
1319 <div class="paragraph"><p>The bar at the bottom of your monitor is drawn by a separate process called
\r
1320 i3bar. Having this part of "the i3 user interface" in a separate process has
\r
1321 several advantages:</p></div>
\r
1322 <div class="olist arabic"><ol class="arabic">
\r
1325 It is a modular approach. If you don’t need a workspace bar at all, or if
\r
1326 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
\r
1327 just remove the i3bar configuration and start your favorite bar instead.
\r
1332 It follows the UNIX philosophy of "Make each program do one thing well".
\r
1333 While i3 manages your windows well, i3bar is good at displaying a bar on
\r
1334 each monitor (unless you configure it otherwise).
\r
1339 It leads to two separate, clean codebases. If you want to understand i3, you
\r
1340 don’t need to bother with the details of i3bar and vice versa.
\r
1344 <div class="paragraph"><p>That said, i3bar is configured in the same configuration file as i3. This is
\r
1345 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
\r
1346 are useful for people using other window managers). Therefore, it makes no
\r
1347 sense to use a different configuration place when we already have a good
\r
1348 configuration infrastructure in place.</p></div>
\r
1349 <div class="paragraph"><p>Configuring your workspace bar starts with opening a <tt>bar</tt> block. You can have
\r
1350 multiple bar blocks to use different settings for different outputs (monitors):</p></div>
\r
1351 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1352 <div class="listingblock">
\r
1353 <div class="content">
\r
1355 status_command i3status
\r
1358 <div class="sect2">
\r
1359 <h3 id="_i3bar_command">5.1. i3bar command</h3>
\r
1360 <div class="paragraph"><p>By default i3 will just pass <tt>i3bar</tt> and let your shell handle the execution,
\r
1361 searching your <tt>$PATH</tt> for a correct version.
\r
1362 If you have a different <tt>i3bar</tt> somewhere or the binary is not in your <tt>$PATH</tt> you can
\r
1363 tell i3 what to execute.</p></div>
\r
1364 <div class="paragraph"><p>The specified command will be passed to <tt>sh -c</tt>, so you can use globbing and
\r
1365 have to have correct quoting etc.</p></div>
\r
1366 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1367 <div class="listingblock">
\r
1368 <div class="content">
\r
1369 <pre><tt>i3bar_command <command></tt></pre>
\r
1371 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1372 <div class="listingblock">
\r
1373 <div class="content">
\r
1375 i3bar_command /home/user/bin/i3bar
\r
1379 <div class="sect2">
\r
1380 <h3 id="status_command">5.2. Statusline command</h3>
\r
1381 <div class="paragraph"><p>i3bar can run a program and display every line of its <tt>stdout</tt> output on the
\r
1382 right hand side of the bar. This is useful to display system information like
\r
1383 your current IP address, battery status or date/time.</p></div>
\r
1384 <div class="paragraph"><p>The specified command will be passed to <tt>sh -c</tt>, so you can use globbing and
\r
1385 have to have correct quoting etc. Note that for signal handling, depending on
\r
1386 your shell (users of dash(1) are known to be affected), you have to use the
\r
1387 shell’s exec command so that signals are passed to your program, not to the
\r
1389 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1390 <div class="listingblock">
\r
1391 <div class="content">
\r
1392 <pre><tt>status_command <command></tt></pre>
\r
1394 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1395 <div class="listingblock">
\r
1396 <div class="content">
\r
1398 status_command i3status --config ~/.i3status.conf
\r
1400 # For dash(1) users who want signal handling to work:
\r
1401 status_command exec ~/.bin/my_status_command
\r
1405 <div class="sect2">
\r
1406 <h3 id="_display_mode">5.3. Display mode</h3>
\r
1407 <div class="paragraph"><p>You can either have i3bar be visible permanently at one edge of the screen
\r
1408 (<tt>dock</tt> mode) or make it show up when you press your modifier key (<tt>hide</tt> mode).
\r
1409 It is also possible to force i3bar to always stay hidden (<tt>invisible</tt>
\r
1410 mode). The modifier key can be configured using the <tt>modifier</tt> option.</p></div>
\r
1411 <div class="paragraph"><p>The mode option can be changed during runtime through the <tt>bar mode</tt> command.
\r
1412 On reload the mode will be reverted to its configured value.</p></div>
\r
1413 <div class="paragraph"><p>The hide mode maximizes screen space that can be used for actual windows. Also,
\r
1414 i3bar sends the <tt>SIGSTOP</tt> and <tt>SIGCONT</tt> signals to the statusline process to
\r
1415 save battery power.</p></div>
\r
1416 <div class="paragraph"><p>Invisible mode allows to permanently maximize screen space, as the bar is never
\r
1417 shown. Thus, you can configure i3bar to not disturb you by popping up because
\r
1418 of an urgency hint or because the modifier key is pressed.</p></div>
\r
1419 <div class="paragraph"><p>In order to control whether i3bar is hidden or shown in hide mode, there exists
\r
1420 the hidden_state option, which has no effect in dock mode or invisible mode. It
\r
1421 indicates the current hidden_state of the bar: (1) The bar acts like in normal
\r
1422 hide mode, it is hidden and is only unhidden in case of urgency hints or by
\r
1423 pressing the modifier key (<tt>hide</tt> state), or (2) it is drawn on top of the
\r
1424 currently visible workspace (<tt>show</tt> state).</p></div>
\r
1425 <div class="paragraph"><p>Like the mode, the hidden_state can also be controlled through i3, this can be
\r
1426 done by using the <tt>bar hidden_state</tt> command.</p></div>
\r
1427 <div class="paragraph"><p>The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
\r
1428 the windows key). The default value for the hidden_state is hide.</p></div>
\r
1429 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1430 <div class="listingblock">
\r
1431 <div class="content">
\r
1432 <pre><tt>mode dock|hide|invisible
\r
1433 hidden_state hide|show
\r
1434 modifier <Modifier>|none</tt></pre>
\r
1436 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1437 <div class="listingblock">
\r
1438 <div class="content">
\r
1445 <div class="paragraph"><p>Available modifiers are Mod1-Mod5, Shift, Control (see <tt>xmodmap(1)</tt>). You can
\r
1446 also use "none" if you don’t want any modifier to trigger this behavior.</p></div>
\r
1448 <div class="sect2">
\r
1449 <h3 id="_mouse_button_commands">5.4. Mouse button commands</h3>
\r
1450 <div class="paragraph"><p>Specifies a command to run when a button was pressed on i3bar to override the
\r
1451 default behavior. This is useful, e.g., for disabling the scroll wheel action
\r
1452 or running scripts that implement custom behavior for these buttons.</p></div>
\r
1453 <div class="paragraph"><p>A button is always named <tt>button<n></tt>, where 1 to 5 are default buttons as follows and higher
\r
1454 numbers can be special buttons on devices offering more buttons:</p></div>
\r
1455 <div class="dlist"><dl>
\r
1456 <dt class="hdlist1">
\r
1461 Left mouse button.
\r
1464 <dt class="hdlist1">
\r
1469 Middle mouse button.
\r
1472 <dt class="hdlist1">
\r
1477 Right mouse button.
\r
1480 <dt class="hdlist1">
\r
1488 <dt class="hdlist1">
\r
1493 Scroll wheel down.
\r
1497 <div class="paragraph"><p>Please note that the old <tt>wheel_up_cmd</tt> and <tt>wheel_down_cmd</tt> commands are deprecated
\r
1498 and will be removed in a future release. We strongly recommend using the more general
\r
1499 <tt>bindsym</tt> with <tt>button4</tt> and <tt>button5</tt> instead.</p></div>
\r
1500 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1501 <div class="listingblock">
\r
1502 <div class="content">
\r
1503 <pre><tt>bindsym [--release] button<n> <command></tt></pre>
\r
1505 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1506 <div class="listingblock">
\r
1507 <div class="content">
\r
1509 # disable clicking on workspace buttons
\r
1510 bindsym button1 nop
\r
1511 # Take a screenshot by right clicking on the bar
\r
1512 bindsym --release button3 exec --no-startup-id import /tmp/latest-screenshot.png
\r
1513 # execute custom script when scrolling downwards
\r
1514 bindsym button5 exec ~/.i3/scripts/custom_wheel_down
\r
1518 <div class="sect2">
\r
1519 <h3 id="_bar_id">5.5. Bar ID</h3>
\r
1520 <div class="paragraph"><p>Specifies the bar ID for the configured bar instance. If this option is missing,
\r
1521 the ID is set to <em>bar-x</em>, where x corresponds to the position of the embedding
\r
1522 bar block in the config file (<em>bar-0</em>, <em>bar-1</em>, …).</p></div>
\r
1523 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1524 <div class="listingblock">
\r
1525 <div class="content">
\r
1526 <pre><tt>id <bar_id></tt></pre>
\r
1528 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1529 <div class="listingblock">
\r
1530 <div class="content">
\r
1536 <div class="sect2">
\r
1537 <h3 id="i3bar_position">5.6. Position</h3>
\r
1538 <div class="paragraph"><p>This option determines in which edge of the screen i3bar should show up.</p></div>
\r
1539 <div class="paragraph"><p>The default is bottom.</p></div>
\r
1540 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1541 <div class="listingblock">
\r
1542 <div class="content">
\r
1543 <pre><tt>position top|bottom</tt></pre>
\r
1545 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1546 <div class="listingblock">
\r
1547 <div class="content">
\r
1553 <div class="sect2">
\r
1554 <h3 id="_output_s">5.7. Output(s)</h3>
\r
1555 <div class="paragraph"><p>You can restrict i3bar to one or more outputs (monitors). The default is to
\r
1556 handle all outputs. Restricting the outputs is useful for using different
\r
1557 options for different outputs by using multiple <em>bar</em> blocks.</p></div>
\r
1558 <div class="paragraph"><p>To make a particular i3bar instance handle multiple outputs, specify the output
\r
1559 directive multiple times.</p></div>
\r
1560 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1561 <div class="listingblock">
\r
1562 <div class="content">
\r
1563 <pre><tt>output primary|<output></tt></pre>
\r
1565 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1566 <div class="listingblock">
\r
1567 <div class="content">
\r
1568 <pre><tt># big monitor: everything
\r
1570 # The display is connected either via HDMI or via DisplayPort
\r
1573 status_command i3status
\r
1576 # laptop monitor: bright colors and i3status with less modules.
\r
1579 status_command i3status --config ~/.i3status-small.conf
\r
1581 background #000000
\r
1582 statusline #ffffff
\r
1586 # show bar on the primary monitor and on HDMI2
\r
1590 status_command i3status
\r
1593 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>
\r
1594 <div class="listingblock">
\r
1595 <div class="content">
\r
1596 <pre><tt>xrandr --output <output> --primary</tt></pre>
\r
1599 <div class="sect2">
\r
1600 <h3 id="_tray_output">5.8. Tray output</h3>
\r
1601 <div class="paragraph"><p>i3bar by default provides a system tray area where programs such as
\r
1602 NetworkManager, VLC, Pidgin, etc. can place little icons.</p></div>
\r
1603 <div class="paragraph"><p>You can configure on which output (monitor) the icons should be displayed or
\r
1604 you can turn off the functionality entirely.</p></div>
\r
1605 <div class="paragraph"><p>You can use multiple <tt>tray_output</tt> directives in your config to specify a list
\r
1606 of outputs on which you want the tray to appear. The first available output in
\r
1607 that list as defined by the order of the directives will be used for the tray
\r
1609 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1610 <div class="listingblock">
\r
1611 <div class="content">
\r
1612 <pre><tt>tray_output none|primary|<output></tt></pre>
\r
1614 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1615 <div class="listingblock">
\r
1616 <div class="content">
\r
1617 <pre><tt># disable system tray
\r
1622 # show tray icons on the primary monitor
\r
1624 tray_output primary
\r
1627 # show tray icons on the big monitor
\r
1632 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>
\r
1633 <div class="listingblock">
\r
1634 <div class="content">
\r
1635 <pre><tt>xrandr --output <output> --primary</tt></pre>
\r
1637 <div class="paragraph"><p>Note that when you use multiple bar configuration blocks, either specify
\r
1638 <tt>tray_output primary</tt> in all of them or explicitly specify <tt>tray_output none</tt>
\r
1639 in bars which should not display the tray, otherwise the different instances
\r
1640 might race each other in trying to display tray icons.</p></div>
\r
1642 <div class="sect2">
\r
1643 <h3 id="_tray_padding">5.9. Tray padding</h3>
\r
1644 <div class="paragraph"><p>The tray is shown on the right-hand side of the bar. By default, a padding of 2
\r
1645 pixels is used for the upper, lower and right-hand side of the tray area and
\r
1646 between the individual icons.</p></div>
\r
1647 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1648 <div class="listingblock">
\r
1649 <div class="content">
\r
1650 <pre><tt>tray_padding <px> [px]</tt></pre>
\r
1652 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1653 <div class="listingblock">
\r
1654 <div class="content">
\r
1655 <pre><tt># Obey Fitts's law
\r
1656 tray_padding 0</tt></pre>
\r
1659 <div class="sect2">
\r
1660 <h3 id="_font">5.10. Font</h3>
\r
1661 <div class="paragraph"><p>Specifies the font to be used in the bar. See <a href="#fonts">[fonts]</a>.</p></div>
\r
1662 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1663 <div class="listingblock">
\r
1664 <div class="content">
\r
1665 <pre><tt>font <font></tt></pre>
\r
1667 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1668 <div class="listingblock">
\r
1669 <div class="content">
\r
1671 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
\r
1672 font pango:DejaVu Sans Mono 10
\r
1676 <div class="sect2">
\r
1677 <h3 id="_custom_separator_symbol">5.11. Custom separator symbol</h3>
\r
1678 <div class="paragraph"><p>Specifies a custom symbol to be used for the separator as opposed to the vertical,
\r
1679 one pixel thick separator.</p></div>
\r
1680 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1681 <div class="listingblock">
\r
1682 <div class="content">
\r
1683 <pre><tt>separator_symbol <symbol></tt></pre>
\r
1685 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1686 <div class="listingblock">
\r
1687 <div class="content">
\r
1689 separator_symbol ":|:"
\r
1693 <div class="sect2">
\r
1694 <h3 id="_workspace_buttons">5.12. Workspace buttons</h3>
\r
1695 <div class="paragraph"><p>Specifies whether workspace buttons should be shown or not. This is useful if
\r
1696 you want to display a statusline-only bar containing additional information.</p></div>
\r
1697 <div class="paragraph"><p>The default is to show workspace buttons.</p></div>
\r
1698 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1699 <div class="listingblock">
\r
1700 <div class="content">
\r
1701 <pre><tt>workspace_buttons yes|no</tt></pre>
\r
1703 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1704 <div class="listingblock">
\r
1705 <div class="content">
\r
1707 workspace_buttons no
\r
1711 <div class="sect2">
\r
1712 <h3 id="_strip_workspace_numbers">5.13. Strip workspace numbers</h3>
\r
1713 <div class="paragraph"><p>Specifies whether workspace numbers should be displayed within the workspace
\r
1714 buttons. This is useful if you want to have a named workspace that stays in
\r
1715 order on the bar according to its number without displaying the number prefix.</p></div>
\r
1716 <div class="paragraph"><p>When <tt>strip_workspace_numbers</tt> is set to <tt>yes</tt>, any workspace that has a name of
\r
1717 the form "[n]:[NAME]" will display only the name. You could use this, for
\r
1718 instance, to display Roman numerals rather than digits by naming your
\r
1719 workspaces to "1:I", "2:II", "3:III", "4:IV", …</p></div>
\r
1720 <div class="paragraph"><p>The default is to display the full name within the workspace button.</p></div>
\r
1721 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1722 <div class="listingblock">
\r
1723 <div class="content">
\r
1724 <pre><tt>strip_workspace_numbers yes|no</tt></pre>
\r
1726 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1727 <div class="listingblock">
\r
1728 <div class="content">
\r
1730 strip_workspace_numbers yes
\r
1734 <div class="sect2">
\r
1735 <h3 id="_binding_mode_indicator">5.14. Binding Mode indicator</h3>
\r
1736 <div class="paragraph"><p>Specifies whether the current binding mode indicator should be shown or not.
\r
1737 This is useful if you want to hide the workspace buttons but still be able
\r
1738 to see the current binding mode indicator. See <a href="#binding_modes">[binding_modes]</a> to learn what
\r
1739 modes are and how to use them.</p></div>
\r
1740 <div class="paragraph"><p>The default is to show the mode indicator.</p></div>
\r
1741 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1742 <div class="listingblock">
\r
1743 <div class="content">
\r
1744 <pre><tt>binding_mode_indicator yes|no</tt></pre>
\r
1746 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1747 <div class="listingblock">
\r
1748 <div class="content">
\r
1750 binding_mode_indicator no
\r
1754 <div class="sect2">
\r
1755 <h3 id="_colors">5.15. Colors</h3>
\r
1756 <div class="paragraph"><p>As with i3, colors are in HTML hex format (#rrggbb). The following colors can
\r
1757 be configured at the moment:</p></div>
\r
1758 <div class="dlist"><dl>
\r
1759 <dt class="hdlist1">
\r
1764 Background color of the bar.
\r
1767 <dt class="hdlist1">
\r
1772 Text color to be used for the statusline.
\r
1775 <dt class="hdlist1">
\r
1780 Text color to be used for the separator.
\r
1783 <dt class="hdlist1">
\r
1784 focused_background
\r
1788 Background color of the bar on the currently focused monitor output. If
\r
1789 not used, the color will be taken from <tt>background</tt>.
\r
1792 <dt class="hdlist1">
\r
1793 focused_statusline
\r
1797 Text color to be used for the statusline on the currently focused
\r
1798 monitor output. If not used, the color will be taken from <tt>statusline</tt>.
\r
1801 <dt class="hdlist1">
\r
1806 Text color to be used for the separator on the currently focused
\r
1807 monitor output. If not used, the color will be taken from <tt>separator</tt>.
\r
1810 <dt class="hdlist1">
\r
1815 Border, background and text color for a workspace button when the workspace
\r
1819 <dt class="hdlist1">
\r
1824 Border, background and text color for a workspace button when the workspace
\r
1825 is active (visible) on some output, but the focus is on another one.
\r
1826 You can only tell this apart from the focused workspace when you are
\r
1827 using multiple monitors.
\r
1830 <dt class="hdlist1">
\r
1831 inactive_workspace
\r
1835 Border, background and text color for a workspace button when the workspace
\r
1836 does not have focus and is not active (visible) on any output. This
\r
1837 will be the case for most workspaces.
\r
1840 <dt class="hdlist1">
\r
1845 Border, background and text color for a workspace button when the workspace
\r
1846 contains a window with the urgency hint set.
\r
1849 <dt class="hdlist1">
\r
1854 Border, background and text color for the binding mode indicator. If not used,
\r
1855 the colors will be taken from <tt>urgent_workspace</tt>.
\r
1859 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
1860 <div class="listingblock">
\r
1861 <div class="content">
\r
1863 background <color>
\r
1864 statusline <color>
\r
1865 separator <color>
\r
1867 <colorclass> <border> <background> <text>
\r
1870 <div class="paragraph"><p><strong>Example (default colors)</strong>:</p></div>
\r
1871 <div class="listingblock">
\r
1872 <div class="content">
\r
1875 background #000000
\r
1876 statusline #ffffff
\r
1879 focused_workspace #4c7899 #285577 #ffffff
\r
1880 active_workspace #333333 #5f676a #ffffff
\r
1881 inactive_workspace #333333 #222222 #888888
\r
1882 urgent_workspace #2f343a #900000 #ffffff
\r
1883 binding_mode #2f343a #900000 #ffffff
\r
1890 <div class="sect1">
\r
1891 <h2 id="_list_of_commands">6. List of commands</h2>
\r
1892 <div class="sectionbody">
\r
1893 <div class="paragraph"><p>Commands are what you bind to specific keypresses. You can also issue commands
\r
1894 at runtime without pressing a key by using the IPC interface. An easy way to
\r
1895 do this is to use the <tt>i3-msg</tt> utility:</p></div>
\r
1896 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1897 <div class="listingblock">
\r
1898 <div class="content">
\r
1899 <pre><tt># execute this on your shell to make the current container borderless
\r
1900 i3-msg border none</tt></pre>
\r
1902 <div class="paragraph" id="command_chaining"><p>Commands can be chained by using <tt>;</tt> (a semicolon). So, to move a window to a
\r
1903 specific workspace and immediately switch to that workspace, you can configure
\r
1904 the following keybinding:</p></div>
\r
1905 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1906 <div class="listingblock">
\r
1907 <div class="content">
\r
1908 <pre><tt>bindsym $mod+x move container to workspace 3; workspace 3</tt></pre>
\r
1910 <div class="paragraph" id="command_criteria"><p>Furthermore, you can change the scope of a command - that is, which containers
\r
1911 should be affected by that command, by using various criteria. The criteria
\r
1912 are specified before any command in a pair of square brackets and are separated
\r
1913 by space.</p></div>
\r
1914 <div class="paragraph"><p>When using multiple commands, separate them by using a <tt>,</tt> (a comma) instead of
\r
1915 a semicolon. Criteria apply only until the next semicolon, so if you use a
\r
1916 semicolon to separate commands, only the first one will be executed for the
\r
1917 matched window(s).</p></div>
\r
1918 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
1919 <div class="listingblock">
\r
1920 <div class="content">
\r
1921 <pre><tt># if you want to kill all windows which have the class Firefox, use:
\r
1922 bindsym $mod+x [class="Firefox"] kill
\r
1924 # same thing, but case-insensitive
\r
1925 bindsym $mod+x [class="(?i)firefox"] kill
\r
1927 # kill only the About dialog from Firefox
\r
1928 bindsym $mod+x [class="Firefox" window_role="About"] kill
\r
1930 # enable floating mode and move container to workspace 4
\r
1931 for_window [class="^evil-app$"] floating enable, move container to workspace 4
\r
1933 # move all floating windows to the scratchpad
\r
1934 bindsym $mod+x [floating] move scratchpad</tt></pre>
\r
1936 <div class="paragraph"><p>The criteria which are currently implemented are:</p></div>
\r
1937 <div class="dlist"><dl>
\r
1938 <dt class="hdlist1">
\r
1943 Compares the window class (the second part of WM_CLASS). Use the
\r
1944 special value <tt>__focused__</tt> to match all windows having the same window
\r
1945 class as the currently focused window.
\r
1948 <dt class="hdlist1">
\r
1953 Compares the window instance (the first part of WM_CLASS). Use the
\r
1954 special value <tt>__focused__</tt> to match all windows having the same window
\r
1955 instance as the currently focused window.
\r
1958 <dt class="hdlist1">
\r
1963 Compares the window role (WM_WINDOW_ROLE). Use the special value
\r
1964 <tt>__focused__</tt> to match all windows having the same window role as the
\r
1965 currently focused window.
\r
1968 <dt class="hdlist1">
\r
1973 Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
\r
1974 <tt>normal</tt>, <tt>dialog</tt>, <tt>utility</tt>, <tt>toolbar</tt>, <tt>splash</tt>, <tt>menu</tt>, <tt>dropdown_menu</tt>,
\r
1975 <tt>popup_menu</tt>, <tt>tooltip</tt> and <tt>notification</tt>.
\r
1978 <dt class="hdlist1">
\r
1983 Compares the X11 window ID, which you can get via <tt>xwininfo</tt> for example.
\r
1986 <dt class="hdlist1">
\r
1991 Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
\r
1992 Use the special value <tt>__focused__</tt> to match all windows having the
\r
1993 same window title as the currently focused window.
\r
1996 <dt class="hdlist1">
\r
2001 Compares the urgent state of the window. Can be "latest" or "oldest".
\r
2002 Matches the latest or oldest urgent window, respectively.
\r
2003 (The following aliases are also available: newest, last, recent, first)
\r
2006 <dt class="hdlist1">
\r
2011 Compares the workspace name of the workspace the window belongs to. Use
\r
2012 the special value <tt>__focused__</tt> to match all windows in the currently
\r
2013 focused workspace.
\r
2016 <dt class="hdlist1">
\r
2021 Compares the marks set for this container, see <a href="#vim_like_marks">[vim_like_marks]</a>. A
\r
2022 match is made if any of the container’s marks matches the specified
\r
2026 <dt class="hdlist1">
\r
2031 Compares the i3-internal container ID, which you can get via the IPC
\r
2032 interface. Handy for scripting. Use the special value <tt>__focused__</tt>
\r
2033 to match only the currently focused window.
\r
2036 <dt class="hdlist1">
\r
2041 Only matches floating windows. This criterion requires no value.
\r
2044 <dt class="hdlist1">
\r
2049 Only matches tiling windows. This criterion requires no value.
\r
2053 <div class="paragraph"><p>The criteria <tt>class</tt>, <tt>instance</tt>, <tt>role</tt>, <tt>title</tt>, <tt>workspace</tt> and <tt>mark</tt> are
\r
2054 actually regular expressions (PCRE). See <tt>pcresyntax(3)</tt> or <tt>perldoc perlre</tt> for
\r
2055 information on how to use them.</p></div>
\r
2056 <div class="sect2">
\r
2057 <h3 id="exec">6.1. Executing applications (exec)</h3>
\r
2058 <div class="paragraph"><p>What good is a window manager if you can’t actually start any applications?
\r
2059 The exec command starts an application by passing the command you specify to a
\r
2060 shell. This implies that you can use globbing (wildcards) and programs will be
\r
2061 searched in your <tt>$PATH</tt>.</p></div>
\r
2062 <div class="paragraph"><p>See <a href="#command_chaining">[command_chaining]</a> for details on the special meaning of <tt>;</tt> (semicolon)
\r
2063 and <tt>,</tt> (comma): they chain commands together in i3, so you need to use quoted
\r
2064 strings (as shown in <a href="#exec_quoting">[exec_quoting]</a>) if they appear in your command.</p></div>
\r
2065 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2066 <div class="listingblock">
\r
2067 <div class="content">
\r
2068 <pre><tt>exec [--no-startup-id] <command></tt></pre>
\r
2070 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2071 <div class="listingblock">
\r
2072 <div class="content">
\r
2073 <pre><tt># Start the GIMP
\r
2074 bindsym $mod+g exec gimp
\r
2076 # Start the terminal emulator urxvt which is not yet startup-notification-aware
\r
2077 bindsym $mod+Return exec --no-startup-id urxvt</tt></pre>
\r
2079 <div class="paragraph"><p>The <tt>--no-startup-id</tt> parameter disables startup-notification support for this
\r
2080 particular exec command. With startup-notification, i3 can make sure that a
\r
2081 window appears on the workspace on which you used the exec command. Also, it
\r
2082 will change the X11 cursor to <tt>watch</tt> (a clock) while the application is
\r
2083 launching. So, if an application is not startup-notification aware (most GTK
\r
2084 and Qt using applications seem to be, though), you will end up with a watch
\r
2085 cursor for 60 seconds.</p></div>
\r
2086 <div class="paragraph" id="exec_quoting"><p>If the command to be executed contains a <tt>;</tt> (semicolon) and/or a <tt>,</tt> (comma),
\r
2087 the entire command must be quoted. For example, to have a keybinding for the
\r
2088 shell command <tt>notify-send Hello, i3</tt>, you would add an entry to your
\r
2089 configuration file like this:</p></div>
\r
2090 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2091 <div class="listingblock">
\r
2092 <div class="content">
\r
2093 <pre><tt># Execute a command with a comma in it
\r
2094 bindsym $mod+p exec "notify-send Hello, i3"</tt></pre>
\r
2096 <div class="paragraph"><p>If however a command with a comma and/or semicolon itself requires quotes, you
\r
2097 must escape the internal quotation marks with double backslashes, like this:</p></div>
\r
2098 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2099 <div class="listingblock">
\r
2100 <div class="content">
\r
2101 <pre><tt># Execute a command with a comma, semicolon and internal quotes
\r
2102 bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\""</tt></pre>
\r
2105 <div class="sect2">
\r
2106 <h3 id="_splitting_containers">6.2. Splitting containers</h3>
\r
2107 <div class="paragraph"><p>The split command makes the current window a split container. Split containers
\r
2108 can contain multiple windows. Depending on the layout of the split container,
\r
2109 new windows get placed to the right of the current one (splith) or new windows
\r
2110 get placed below the current one (splitv).</p></div>
\r
2111 <div class="paragraph"><p>If you apply this command to a split container with the same orientation,
\r
2112 nothing will happen. If you use a different orientation, the split container’s
\r
2113 orientation will be changed (if it does not have more than one window).
\r
2114 The <tt>toggle</tt> option will toggle the orientation of the split container if it
\r
2115 contains a single window. Otherwise it makes the current window a split
\r
2116 container with opposite orientation compared to the parent container.
\r
2117 Use <tt>layout toggle split</tt> to change the layout of any split container from
\r
2118 splitv to splith or vice-versa. You can also define a custom sequence of layouts
\r
2119 to cycle through with <tt>layout toggle</tt>, see <a href="#manipulating_layout">[manipulating_layout]</a>.</p></div>
\r
2120 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2121 <div class="listingblock">
\r
2122 <div class="content">
\r
2123 <pre><tt>split vertical|horizontal|toggle</tt></pre>
\r
2125 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2126 <div class="listingblock">
\r
2127 <div class="content">
\r
2128 <pre><tt>bindsym $mod+v split vertical
\r
2129 bindsym $mod+h split horizontal
\r
2130 bindsym $mod+t split toggle</tt></pre>
\r
2133 <div class="sect2">
\r
2134 <h3 id="_manipulating_layout">6.3. Manipulating layout</h3>
\r
2135 <div class="paragraph"><p>Use <tt>layout toggle split</tt>, <tt>layout stacking</tt>, <tt>layout tabbed</tt>, <tt>layout splitv</tt>
\r
2136 or <tt>layout splith</tt> to change the current container layout to splith/splitv,
\r
2137 stacking, tabbed layout, splitv or splith, respectively.</p></div>
\r
2138 <div class="paragraph"><p>Specify up to four layouts after <tt>layout toggle</tt> to cycle through them. Every
\r
2139 time the command is executed, the layout specified after the currently active
\r
2140 one will be applied. If the currently active layout is not in the list, the
\r
2141 first layout in the list will be activated.</p></div>
\r
2142 <div class="paragraph"><p>To make the current window (!) fullscreen, use <tt>fullscreen enable</tt> (or
\r
2143 <tt>fullscreen enable global</tt> for the global mode), to leave either fullscreen
\r
2144 mode use <tt>fullscreen disable</tt>, and to toggle between these two states use
\r
2145 <tt>fullscreen toggle</tt> (or <tt>fullscreen toggle global</tt>).</p></div>
\r
2146 <div class="paragraph"><p>Likewise, to make the current window floating (or tiling again) use <tt>floating
\r
2147 enable</tt> respectively <tt>floating disable</tt> (or <tt>floating toggle</tt>):</p></div>
\r
2148 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2149 <div class="listingblock">
\r
2150 <div class="content">
\r
2151 <pre><tt>layout default|tabbed|stacking|splitv|splith
\r
2152 layout toggle [split|all]
\r
2153 layout toggle [split|tabbed|stacking|splitv|splith] [split|tabbed|stacking|splitv|splith]…</tt></pre>
\r
2155 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2156 <div class="listingblock">
\r
2157 <div class="content">
\r
2158 <pre><tt>bindsym $mod+s layout stacking
\r
2159 bindsym $mod+l layout toggle split
\r
2160 bindsym $mod+w layout tabbed
\r
2162 # Toggle between stacking/tabbed/split:
\r
2163 bindsym $mod+x layout toggle
\r
2165 # Toggle between stacking/tabbed/splith/splitv:
\r
2166 bindsym $mod+x layout toggle all
\r
2168 # Toggle between stacking/tabbed/splith:
\r
2169 bindsym $mod+x layout toggle stacking tabbed splith
\r
2171 # Toggle between splitv/tabbed
\r
2172 bindsym $mod+x layout toggle splitv tabbed
\r
2174 # Toggle between last split layout/tabbed/stacking
\r
2175 bindsym $mod+x layout toggle split tabbed stacking
\r
2177 # Toggle fullscreen
\r
2178 bindsym $mod+f fullscreen toggle
\r
2180 # Toggle floating/tiling
\r
2181 bindsym $mod+t floating toggle</tt></pre>
\r
2184 <div class="sect2">
\r
2185 <h3 id="_focusing_moving_containers">6.4. Focusing containers</h3>
\r
2186 <div class="paragraph"><p>To change focus, you can use the <tt>focus</tt> command. The following options are
\r
2187 available:</p></div>
\r
2188 <div class="dlist"><dl>
\r
2189 <dt class="hdlist1">
\r
2194 Sets focus to the container that matches the specified criteria.
\r
2195 See <a href="#command_criteria">[command_criteria]</a>.
\r
2198 <dt class="hdlist1">
\r
2199 left|right|up|down
\r
2203 Sets focus to the nearest container in the given direction.
\r
2206 <dt class="hdlist1">
\r
2211 Sets focus to the parent container of the current container.
\r
2214 <dt class="hdlist1">
\r
2219 The opposite of <tt>focus parent</tt>, sets the focus to the last focused
\r
2223 <dt class="hdlist1">
\r
2228 Sets focus to the last focused floating container.
\r
2231 <dt class="hdlist1">
\r
2236 Sets focus to the last focused tiling container.
\r
2239 <dt class="hdlist1">
\r
2244 Toggles between floating/tiling containers.
\r
2247 <dt class="hdlist1">
\r
2252 Followed by a direction or an output name, this will focus the
\r
2253 corresponding output.
\r
2257 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2258 <div class="listingblock">
\r
2259 <div class="content">
\r
2260 <pre><tt><criteria> focus
\r
2261 focus left|right|down|up
\r
2262 focus parent|child|floating|tiling|mode_toggle
\r
2263 focus output left|right|up|down|primary|<output></tt></pre>
\r
2265 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2266 <div class="listingblock">
\r
2267 <div class="content">
\r
2268 <pre><tt># Focus firefox
\r
2269 bindsym $mod+F1 [class="Firefox"] focus
\r
2271 # Focus container on the left, bottom, top, right
\r
2272 bindsym $mod+j focus left
\r
2273 bindsym $mod+k focus down
\r
2274 bindsym $mod+l focus up
\r
2275 bindsym $mod+semicolon focus right
\r
2277 # Focus parent container
\r
2278 bindsym $mod+u focus parent
\r
2280 # Focus last floating/tiling container
\r
2281 bindsym $mod+g focus mode_toggle
\r
2283 # Focus the output right to the current one
\r
2284 bindsym $mod+x focus output right
\r
2286 # Focus the big output
\r
2287 bindsym $mod+x focus output HDMI-2
\r
2289 # Focus the primary output
\r
2290 bindsym $mod+x focus output primary</tt></pre>
\r
2292 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>
\r
2293 <div class="listingblock">
\r
2294 <div class="content">
\r
2295 <pre><tt>xrandr --output <output> --primary</tt></pre>
\r
2298 <div class="sect2">
\r
2299 <h3 id="_moving_containers">6.5. Moving containers</h3>
\r
2300 <div class="paragraph"><p>Use the <tt>move</tt> command to move a container.</p></div>
\r
2301 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2302 <div class="listingblock">
\r
2303 <div class="content">
\r
2304 <pre><tt># Moves the container into the given direction.
\r
2305 # The optional pixel argument specifies how far the
\r
2306 # container should be moved if it is floating and
\r
2307 # defaults to 10 pixels.
\r
2308 move <left|right|down|up> [<px> px]
\r
2310 # Moves the container either to a specific location
\r
2311 # or to the center of the screen. If 'absolute' is
\r
2312 # used, it is moved to the center of all outputs.
\r
2313 move [absolute] position <pos_x> [px] <pos_y> [px]
\r
2314 move [absolute] position center
\r
2316 # Moves the container to the current position of the
\r
2317 # mouse cursor. Only affects floating containers.
\r
2318 move position mouse</tt></pre>
\r
2320 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2321 <div class="listingblock">
\r
2322 <div class="content">
\r
2323 <pre><tt># Move container to the left, bottom, top, right
\r
2324 bindsym $mod+j move left
\r
2325 bindsym $mod+k move down
\r
2326 bindsym $mod+l move up
\r
2327 bindsym $mod+semicolon move right
\r
2329 # Move container, but make floating containers
\r
2330 # move more than the default
\r
2331 bindsym $mod+j move left 20 px
\r
2333 # Move floating container to the center of all outputs
\r
2334 bindsym $mod+c move absolute position center
\r
2336 # Move container to the current position of the cursor
\r
2337 bindsym $mod+m move position mouse</tt></pre>
\r
2340 <div class="sect2">
\r
2341 <h3 id="_swapping_containers">6.6. Swapping containers</h3>
\r
2342 <div class="paragraph"><p>Two containers can be swapped (i.e., move to each other’s position) by using
\r
2343 the <tt>swap</tt> command. They will assume the position and geometry of the container
\r
2344 they are swapped with.</p></div>
\r
2345 <div class="paragraph"><p>The first container to participate in the swapping can be selected through the
\r
2346 normal command criteria process with the focused window being the usual
\r
2347 fallback if no criteria are specified. The second container can be selected
\r
2348 using one of the following methods:</p></div>
\r
2349 <div class="dlist"><dl>
\r
2350 <dt class="hdlist1">
\r
2355 The X11 window ID of a client window.
\r
2358 <dt class="hdlist1">
\r
2363 The i3 container ID of a container.
\r
2366 <dt class="hdlist1">
\r
2371 A container with the specified mark, see <a href="#vim_like_marks">[vim_like_marks]</a>.
\r
2375 <div class="paragraph"><p>Note that swapping does not work with all containers. Most notably, swapping
\r
2376 floating containers or containers that have a parent-child relationship to one
\r
2377 another does not work.</p></div>
\r
2378 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2379 <div class="listingblock">
\r
2380 <div class="content">
\r
2381 <pre><tt>swap container with id|con_id|mark <arg></tt></pre>
\r
2383 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2384 <div class="listingblock">
\r
2385 <div class="content">
\r
2386 <pre><tt># Swaps the focused container with the container marked »swapee«.
\r
2387 swap container with mark swapee
\r
2389 # Swaps container marked »A« and »B«
\r
2390 [con_mark="^A$"] swap container with mark B</tt></pre>
\r
2393 <div class="sect2">
\r
2394 <h3 id="_sticky_floating_windows">6.7. Sticky floating windows</h3>
\r
2395 <div class="paragraph"><p>If you want a window to stick to the glass, i.e., have it stay on screen even
\r
2396 if you switch to another workspace, you can use the <tt>sticky</tt> command. For
\r
2397 example, this can be useful for notepads, a media player or a video chat
\r
2399 <div class="paragraph"><p>Note that while any window can be made sticky through this command, it will
\r
2400 only take effect if the window is floating.</p></div>
\r
2401 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2402 <div class="listingblock">
\r
2403 <div class="content">
\r
2404 <pre><tt>sticky enable|disable|toggle</tt></pre>
\r
2406 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2407 <div class="listingblock">
\r
2408 <div class="content">
\r
2409 <pre><tt># make a terminal sticky that was started as a notepad
\r
2410 for_window [instance=notepad] sticky enable</tt></pre>
\r
2413 <div class="sect2">
\r
2414 <h3 id="_changing_named_workspaces_moving_to_workspaces">6.8. Changing (named) workspaces/moving to workspaces</h3>
\r
2415 <div class="paragraph"><p>To change to a specific workspace, use the <tt>workspace</tt> command, followed by the
\r
2416 number or name of the workspace. Pass the optional flag
\r
2417 <tt>--no-auto-back-and-forth</tt> to disable <a href="#back_and_forth">[back_and_forth]</a> for this specific call
\r
2419 <div class="paragraph"><p>To move containers to specific workspaces, use <tt>move container to workspace</tt>.</p></div>
\r
2420 <div class="paragraph"><p>You can also switch to the next and previous workspace with the commands
\r
2421 <tt>workspace next</tt> and <tt>workspace prev</tt>, which is handy, for example, if you have
\r
2422 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
\r
2423 combination. To restrict those to the current output, use <tt>workspace
\r
2424 next_on_output</tt> and <tt>workspace prev_on_output</tt>. Similarly, you can use <tt>move
\r
2425 container to workspace next</tt>, <tt>move container to workspace prev</tt> to move a
\r
2426 container to the next/previous workspace and <tt>move container to workspace current</tt>
\r
2427 (the last one makes sense only when used with criteria).</p></div>
\r
2428 <div class="paragraph"><p><tt>workspace next</tt> cycles through either numbered or named workspaces. But when it
\r
2429 reaches the last numbered/named workspace, it looks for named workspaces after
\r
2430 exhausting numbered ones and looks for numbered ones after exhausting named ones.</p></div>
\r
2431 <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
2432 RandR output.</p></div>
\r
2433 <div class="paragraph"><p>Workspace names are parsed as
\r
2434 <a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>
\r
2435 by i3bar.</p></div>
\r
2436 <div class="paragraph" id="back_and_forth"><p>To switch back to the previously focused workspace, use <tt>workspace
\r
2437 back_and_forth</tt>; likewise, you can move containers to the previously focused
\r
2438 workspace using <tt>move container to workspace back_and_forth</tt>.</p></div>
\r
2439 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2440 <div class="listingblock">
\r
2441 <div class="content">
\r
2442 <pre><tt>workspace next|prev|next_on_output|prev_on_output
\r
2443 workspace back_and_forth
\r
2444 workspace [--no-auto-back-and-forth] <name>
\r
2445 workspace [--no-auto-back-and-forth] number <name>
\r
2447 move [--no-auto-back-and-forth] [window|container] [to] workspace <name>
\r
2448 move [--no-auto-back-and-forth] [window|container] [to] workspace number <name>
\r
2449 move [window|container] [to] workspace prev|next|current</tt></pre>
\r
2451 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2452 <div class="listingblock">
\r
2453 <div class="content">
\r
2454 <pre><tt>bindsym $mod+1 workspace 1
\r
2455 bindsym $mod+2 workspace 2
\r
2456 bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
\r
2459 bindsym $mod+Shift+1 move container to workspace 1
\r
2460 bindsym $mod+Shift+2 move container to workspace 2
\r
2463 # switch between the current and the previously focused one
\r
2464 bindsym $mod+b workspace back_and_forth
\r
2465 bindsym $mod+Shift+b move container to workspace back_and_forth
\r
2467 # move the whole workspace to the next output
\r
2468 bindsym $mod+x move workspace to output right
\r
2470 # move firefox to current workspace
\r
2471 bindsym $mod+F1 [class="Firefox"] move workspace current</tt></pre>
\r
2473 <div class="sect3">
\r
2474 <h4 id="_named_workspaces">6.8.1. Named workspaces</h4>
\r
2475 <div class="paragraph"><p>Workspaces are identified by their name. So, instead of using numbers in the
\r
2476 workspace command, you can use an arbitrary name:</p></div>
\r
2477 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2478 <div class="listingblock">
\r
2479 <div class="content">
\r
2480 <pre><tt>bindsym $mod+1 workspace mail
\r
2483 <div class="paragraph"><p>If you want the workspace to have a number <strong>and</strong> a name, just prefix the
\r
2484 number, like this:</p></div>
\r
2485 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2486 <div class="listingblock">
\r
2487 <div class="content">
\r
2488 <pre><tt>bindsym $mod+1 workspace 1: mail
\r
2489 bindsym $mod+2 workspace 2: www
\r
2492 <div class="paragraph"><p>Note that the workspace will really be named "1: mail". i3 treats workspace
\r
2493 names beginning with a number in a slightly special way. Normally, named
\r
2494 workspaces are ordered the way they appeared. When they start with a number, i3
\r
2495 will order them numerically. Also, you will be able to use <tt>workspace number 1</tt>
\r
2496 to switch to the workspace which begins with number 1, regardless of which name
\r
2497 it has. This is useful in case you are changing the workspace’s name
\r
2498 dynamically. To combine both commands you can use <tt>workspace number 1: mail</tt> to
\r
2499 specify a default name if there’s currently no workspace starting with a "1".</p></div>
\r
2501 <div class="sect3">
\r
2502 <h4 id="_renaming_workspaces">6.8.2. Renaming workspaces</h4>
\r
2503 <div class="paragraph"><p>You can rename workspaces. This might be useful to start with the default
\r
2504 numbered workspaces, do your work, and rename the workspaces afterwards to
\r
2505 reflect what’s actually on them. You can also omit the old name to rename
\r
2506 the currently focused workspace. This is handy if you want to use the
\r
2507 rename command with <tt>i3-input</tt>.</p></div>
\r
2508 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2509 <div class="listingblock">
\r
2510 <div class="content">
\r
2511 <pre><tt>rename workspace <old_name> to <new_name>
\r
2512 rename workspace to <new_name></tt></pre>
\r
2514 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2515 <div class="listingblock">
\r
2516 <div class="content">
\r
2517 <pre><tt>i3-msg 'rename workspace 5 to 6'
\r
2518 i3-msg 'rename workspace 1 to "1: www"'
\r
2519 i3-msg 'rename workspace "1: www" to "10: www"'
\r
2520 i3-msg 'rename workspace to "2: mail"'
\r
2521 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '</tt></pre>
\r
2523 <div class="paragraph"><p>If you want to rename workspaces on demand while keeping the navigation stable,
\r
2524 you can use a setup like this:</p></div>
\r
2525 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2526 <div class="listingblock">
\r
2527 <div class="content">
\r
2528 <pre><tt>bindsym $mod+1 workspace number "1: www"
\r
2529 bindsym $mod+2 workspace number "2: mail"
\r
2532 <div class="paragraph"><p>If a workspace does not exist, the command <tt>workspace number "1: mail"</tt> will
\r
2533 create workspace "1: mail".</p></div>
\r
2534 <div class="paragraph"><p>If a workspace with number 1 does already exist, the command will switch to this
\r
2535 workspace and ignore the text part. So even when the workspace has been renamed
\r
2536 to "1: web", the above command will still switch to it.</p></div>
\r
2539 <div class="sect2">
\r
2540 <h3 id="_moving_workspaces_to_a_different_screen">6.9. Moving workspaces to a different screen</h3>
\r
2541 <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
2542 RandR output.</p></div>
\r
2544 <div class="sect2">
\r
2545 <h3 id="move_to_outputs">6.10. <a id="_moving_containers_workspaces_to_randr_outputs"></a>Moving containers/workspaces to RandR outputs</h3>
\r
2546 <div class="paragraph"><p>To move a container to another RandR output (addressed by names like <tt>LVDS1</tt> or
\r
2547 <tt>VGA1</tt>) or to a RandR output identified by a specific direction (like <tt>left</tt>,
\r
2548 <tt>right</tt>, <tt>up</tt> or <tt>down</tt>), there are two commands:</p></div>
\r
2549 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2550 <div class="listingblock">
\r
2551 <div class="content">
\r
2552 <pre><tt>move container to output left|right|down|up|current|primary|<output>
\r
2553 move workspace to output left|right|down|up|current|primary|<output></tt></pre>
\r
2555 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2556 <div class="listingblock">
\r
2557 <div class="content">
\r
2558 <pre><tt># Move the current workspace to the next output
\r
2559 # (effectively toggles when you only have two outputs)
\r
2560 bindsym $mod+x move workspace to output right
\r
2562 # Put this window on the presentation output.
\r
2563 bindsym $mod+x move container to output VGA1
\r
2565 # Put this window on the primary output.
\r
2566 bindsym $mod+x move container to output primary</tt></pre>
\r
2568 <div class="paragraph"><p>Note that you might not have a primary output configured yet. To do so, run:</p></div>
\r
2569 <div class="listingblock">
\r
2570 <div class="content">
\r
2571 <pre><tt>xrandr --output <output> --primary</tt></pre>
\r
2574 <div class="sect2">
\r
2575 <h3 id="_moving_containers_windows_to_marks">6.11. Moving containers/windows to marks</h3>
\r
2576 <div class="paragraph"><p>To move a container to another container with a specific mark (see <a href="#vim_like_marks">[vim_like_marks]</a>),
\r
2577 you can use the following command.</p></div>
\r
2578 <div class="paragraph"><p>The window will be moved right after the marked container in the tree, i.e., it ends up
\r
2579 in the same position as if you had opened a new window when the marked container was
\r
2580 focused. If the mark is on a split container, the window will appear as a new child
\r
2581 after the currently focused child within that container.</p></div>
\r
2582 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2583 <div class="listingblock">
\r
2584 <div class="content">
\r
2585 <pre><tt>move window|container to mark <mark></tt></pre>
\r
2587 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2588 <div class="listingblock">
\r
2589 <div class="content">
\r
2590 <pre><tt>for_window [instance="tabme"] move window to mark target</tt></pre>
\r
2593 <div class="sect2">
\r
2594 <h3 id="resizingconfig">6.12. Resizing containers/windows</h3>
\r
2595 <div class="paragraph"><p>If you want to resize containers/windows using your keyboard, you can use the
\r
2596 <tt>resize</tt> command:</p></div>
\r
2597 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2598 <div class="listingblock">
\r
2599 <div class="content">
\r
2600 <pre><tt>resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
\r
2601 resize set <width> [px | ppt] <height> [px | ppt]</tt></pre>
\r
2603 <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
2604 less specific and use <tt>width</tt> or <tt>height</tt>, in which case i3 will take/give
\r
2605 space from all the other containers. The optional pixel argument specifies by
\r
2606 how many pixels a <strong>floating container</strong> should be grown or shrunk (the default
\r
2607 is 10 pixels). The ppt argument means percentage points and specifies by how
\r
2608 many percentage points a <strong>tiling container</strong> should be grown or shrunk (the
\r
2609 default is 10 percentage points).</p></div>
\r
2610 <div class="paragraph"><p>Notes about <tt>resize set</tt>: a value of 0 for <width> or <height> means "do
\r
2611 not resize in this direction", and resizing a tiling container by <tt>px</tt> is not
\r
2612 implemented.</p></div>
\r
2613 <div class="paragraph"><p>It is recommended to define bindings for resizing in a dedicated binding mode.
\r
2614 See <a href="#binding_modes">[binding_modes]</a> and the example in the i3
\r
2615 <a href="https://github.com/i3/i3/blob/next/etc/config.keycodes">default config</a> for more
\r
2616 context.</p></div>
\r
2617 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2618 <div class="listingblock">
\r
2619 <div class="content">
\r
2620 <pre><tt>for_window [class="urxvt"] resize set 640 480</tt></pre>
\r
2623 <div class="sect2">
\r
2624 <h3 id="_jumping_to_specific_windows">6.13. Jumping to specific windows</h3>
\r
2625 <div class="paragraph"><p>Often when in a multi-monitor environment, you want to quickly jump to a
\r
2626 specific window. For example, while working on workspace 3 you may want to
\r
2627 jump to your mail client to email your boss that you’ve achieved some
\r
2628 important goal. Instead of figuring out how to navigate to your mail client,
\r
2629 it would be more convenient to have a shortcut. You can use the <tt>focus</tt> command
\r
2630 with criteria for that.</p></div>
\r
2631 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2632 <div class="listingblock">
\r
2633 <div class="content">
\r
2634 <pre><tt>[class="class"] focus
\r
2635 [title="title"] focus</tt></pre>
\r
2637 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2638 <div class="listingblock">
\r
2639 <div class="content">
\r
2640 <pre><tt># Get me to the next open VIM instance
\r
2641 bindsym $mod+a [class="urxvt" title="VIM"] focus</tt></pre>
\r
2644 <div class="sect2">
\r
2645 <h3 id="vim_like_marks">6.14. VIM-like marks (mark/goto)</h3>
\r
2646 <div class="paragraph"><p>This feature is like the jump feature: It allows you to directly jump to a
\r
2647 specific window (this means switching to the appropriate workspace and setting
\r
2648 focus to the windows). However, you can directly mark a specific window with
\r
2649 an arbitrary label and use it afterwards. You can unmark the label in the same
\r
2650 way, using the unmark command. If you don’t specify a label, unmark removes all
\r
2651 marks. You do not need to ensure that your windows have unique classes or
\r
2652 titles, and you do not need to change your configuration file.</p></div>
\r
2653 <div class="paragraph"><p>As the command needs to include the label with which you want to mark the
\r
2654 window, you cannot simply bind it to a key. <tt>i3-input</tt> is a tool created
\r
2655 for this purpose: It lets you input a command and sends the command to i3. It
\r
2656 can also prefix this command and display a custom prompt for the input dialog.</p></div>
\r
2657 <div class="paragraph"><p>The additional <tt>--toggle</tt> option will remove the mark if the window already has
\r
2658 this mark or add it otherwise. Note that you may need to use this in
\r
2659 combination with <tt>--add</tt> (see below) as any other marks will otherwise be
\r
2660 removed.</p></div>
\r
2661 <div class="paragraph"><p>By default, a window can only have one mark. You can use the <tt>--add</tt> flag to
\r
2662 put more than one mark on a window.</p></div>
\r
2663 <div class="paragraph"><p>Refer to <a href="#show_marks">[show_marks]</a> if you don’t want marks to be shown in the window decoration.</p></div>
\r
2664 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2665 <div class="listingblock">
\r
2666 <div class="content">
\r
2667 <pre><tt>mark [--add|--replace] [--toggle] <identifier>
\r
2668 [con_mark="identifier"] focus
\r
2669 unmark <identifier></tt></pre>
\r
2671 <div class="paragraph"><p><strong>Example (in a terminal)</strong>:</p></div>
\r
2672 <div class="listingblock">
\r
2673 <div class="content">
\r
2674 <pre><tt># marks the focused container
\r
2677 # focus the container with the mark "irssi"
\r
2678 '[con_mark="irssi"] focus'
\r
2680 # remove the mark "irssi" from whichever container has it
\r
2683 # remove all marks on all firefox windows
\r
2684 [class="(?i)firefox"] unmark</tt></pre>
\r
2687 <div class="sect2">
\r
2688 <h3 id="pango_markup">6.15. Window title format</h3>
\r
2689 <div class="paragraph"><p>By default, i3 will simply print the X11 window title. Using <tt>title_format</tt>,
\r
2690 this can be customized by setting the format to the desired output. This
\r
2691 directive supports
\r
2692 <a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>
\r
2693 and the following placeholders which will be replaced:</p></div>
\r
2694 <div class="dlist"><dl>
\r
2695 <dt class="hdlist1">
\r
2700 For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME
\r
2701 as fallback). When used on containers without a window (e.g., a split
\r
2702 container inside a tabbed/stacked layout), this will be the tree
\r
2703 representation of the container (e.g., "H[xterm xterm]").
\r
2706 <dt class="hdlist1">
\r
2711 The X11 window class (second part of WM_CLASS). This corresponds to the
\r
2712 <tt>class</tt> criterion, see <a href="#command_criteria">[command_criteria]</a>.
\r
2715 <dt class="hdlist1">
\r
2716 <tt>%instance</tt>
\r
2720 The X11 window instance (first part of WM_CLASS). This corresponds to the
\r
2721 <tt>instance</tt> criterion, see <a href="#command_criteria">[command_criteria]</a>.
\r
2725 <div class="paragraph"><p>Using the <a href="#for_window">[for_window]</a> directive, you can set the title format for any window
\r
2726 based on <a href="#command_criteria">[command_criteria]</a>.</p></div>
\r
2727 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2728 <div class="listingblock">
\r
2729 <div class="content">
\r
2730 <pre><tt>title_format <format></tt></pre>
\r
2732 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2733 <div class="listingblock">
\r
2734 <div class="content">
\r
2735 <pre><tt># give the focused window a prefix
\r
2736 bindsym $mod+p title_format "Important | %title"
\r
2738 # print all window titles bold
\r
2739 for_window [class=".*"] title_format "<b>%title</b>"
\r
2741 # print window titles of firefox windows red
\r
2742 for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"</tt></pre>
\r
2745 <div class="sect2">
\r
2746 <h3 id="_changing_border_style">6.16. Changing border style</h3>
\r
2747 <div class="paragraph"><p>To change the border of the current client, you can use <tt>border normal</tt> to use the normal
\r
2748 border (including window title), <tt>border pixel 1</tt> to use a 1-pixel border (no window title)
\r
2749 and <tt>border none</tt> to make the client borderless.</p></div>
\r
2750 <div class="paragraph"><p>There is also <tt>border toggle</tt> which will toggle the different border styles.</p></div>
\r
2751 <div class="paragraph"><p>Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel
\r
2752 may be represented by multiple physical pixels, so <tt>pixel 1</tt> might not
\r
2753 necessarily translate into a single pixel row wide border.</p></div>
\r
2754 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2755 <div class="listingblock">
\r
2756 <div class="content">
\r
2757 <pre><tt>border normal|pixel [<n>]
\r
2758 border none|toggle
\r
2760 # legacy syntax, equivalent to "border pixel 1"
\r
2761 border 1pixel</tt></pre>
\r
2763 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2764 <div class="listingblock">
\r
2765 <div class="content">
\r
2766 <pre><tt># use window title, but no border
\r
2767 bindsym $mod+t border normal 0
\r
2768 # use no window title and a thick border
\r
2769 bindsym $mod+y border pixel 3
\r
2770 # use neither window title nor border
\r
2771 bindsym $mod+u border none</tt></pre>
\r
2774 <div class="sect2">
\r
2775 <h3 id="shmlog">6.17. Enabling shared memory logging</h3>
\r
2776 <div class="paragraph"><p>As described in <a href="https://i3wm.org/docs/debugging.html">https://i3wm.org/docs/debugging.html</a>, i3 can log to a shared
\r
2777 memory buffer, which you can dump using <tt>i3-dump-log</tt>. The <tt>shmlog</tt> command
\r
2778 allows you to enable or disable the shared memory logging at runtime.</p></div>
\r
2779 <div class="paragraph"><p>Note that when using <tt>shmlog <size_in_bytes></tt>, the current log will be
\r
2780 discarded and a new one will be started.</p></div>
\r
2781 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2782 <div class="listingblock">
\r
2783 <div class="content">
\r
2784 <pre><tt>shmlog <size_in_bytes>
\r
2785 shmlog on|off|toggle</tt></pre>
\r
2787 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2788 <div class="listingblock">
\r
2789 <div class="content">
\r
2790 <pre><tt># Enable/disable logging
\r
2791 bindsym $mod+x shmlog toggle
\r
2793 # or, from a terminal:
\r
2794 # increase the shared memory log buffer to 50 MiB
\r
2795 i3-msg shmlog $((50*1024*1024))</tt></pre>
\r
2798 <div class="sect2">
\r
2799 <h3 id="_enabling_debug_logging">6.18. Enabling debug logging</h3>
\r
2800 <div class="paragraph"><p>The <tt>debuglog</tt> command allows you to enable or disable debug logging at
\r
2801 runtime. Debug logging is much more verbose than non-debug logging. This
\r
2802 command does not activate shared memory logging (shmlog), and as such is most
\r
2803 likely useful in combination with the above-described <a href="#shmlog">[shmlog]</a> command.</p></div>
\r
2804 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2805 <div class="listingblock">
\r
2806 <div class="content">
\r
2807 <pre><tt>debuglog on|off|toggle</tt></pre>
\r
2809 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2810 <div class="listingblock">
\r
2811 <div class="content">
\r
2812 <pre><tt># Enable/disable logging
\r
2813 bindsym $mod+x debuglog toggle</tt></pre>
\r
2816 <div class="sect2">
\r
2817 <h3 id="_reloading_restarting_exiting">6.19. Reloading/Restarting/Exiting</h3>
\r
2818 <div class="paragraph"><p>You can make i3 reload its configuration file with <tt>reload</tt>. You can also
\r
2819 restart i3 inplace with the <tt>restart</tt> command to get it out of some weird state
\r
2820 (if that should ever happen) or to perform an upgrade without having to restart
\r
2821 your X session. To exit i3 properly, you can use the <tt>exit</tt> command,
\r
2822 however you don’t need to (simply killing your X session is fine as well).</p></div>
\r
2823 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2824 <div class="listingblock">
\r
2825 <div class="content">
\r
2826 <pre><tt>bindsym $mod+Shift+r restart
\r
2827 bindsym $mod+Shift+w reload
\r
2828 bindsym $mod+Shift+e exit</tt></pre>
\r
2831 <div class="sect2">
\r
2832 <h3 id="_scratchpad">6.20. Scratchpad</h3>
\r
2833 <div class="paragraph"><p>There are two commands to use any existing window as scratchpad window. <tt>move
\r
2834 scratchpad</tt> will move a window to the scratchpad workspace. This will make it
\r
2835 invisible until you show it again. There is no way to open that workspace.
\r
2836 Instead, when using <tt>scratchpad show</tt>, the window will be shown again, as a
\r
2837 floating window, centered on your current workspace (using <tt>scratchpad show</tt> on
\r
2838 a visible scratchpad window will make it hidden again, so you can have a
\r
2839 keybinding to toggle). Note that this is just a normal floating window, so if
\r
2840 you want to "remove it from scratchpad", you can simple make it tiling again
\r
2841 (<tt>floating toggle</tt>).</p></div>
\r
2842 <div class="paragraph"><p>As the name indicates, this is useful for having a window with your favorite
\r
2843 editor always at hand. However, you can also use this for other permanently
\r
2844 running applications which you don’t want to see all the time: Your music
\r
2845 player, alsamixer, maybe even your mail client…?</p></div>
\r
2846 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2847 <div class="listingblock">
\r
2848 <div class="content">
\r
2849 <pre><tt>move scratchpad
\r
2851 scratchpad show</tt></pre>
\r
2853 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2854 <div class="listingblock">
\r
2855 <div class="content">
\r
2856 <pre><tt># Make the currently focused window a scratchpad
\r
2857 bindsym $mod+Shift+minus move scratchpad
\r
2859 # Show the first scratchpad window
\r
2860 bindsym $mod+minus scratchpad show
\r
2862 # Show the sup-mail scratchpad window, if any.
\r
2863 bindsym mod4+s [title="^Sup ::"] scratchpad show</tt></pre>
\r
2866 <div class="sect2">
\r
2867 <h3 id="_nop">6.21. Nop</h3>
\r
2868 <div class="paragraph"><p>There is a no operation command <tt>nop</tt> which allows you to override default
\r
2869 behavior. This can be useful for, e.g., disabling a focus change on clicks with
\r
2870 the middle mouse button.</p></div>
\r
2871 <div class="paragraph"><p>The optional <tt>comment</tt> argument is ignored, but will be printed to the log file
\r
2872 for debugging purposes.</p></div>
\r
2873 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2874 <div class="listingblock">
\r
2875 <div class="content">
\r
2876 <pre><tt>nop [<comment>]</tt></pre>
\r
2878 <div class="paragraph"><p><strong>Example</strong>:</p></div>
\r
2879 <div class="listingblock">
\r
2880 <div class="content">
\r
2881 <pre><tt># Disable focus change for clicks on titlebars
\r
2882 # with the middle mouse button
\r
2883 bindsym button2 nop</tt></pre>
\r
2886 <div class="sect2">
\r
2887 <h3 id="_i3bar_control">6.22. i3bar control</h3>
\r
2888 <div class="paragraph"><p>There are two options in the configuration of each i3bar instance that can be
\r
2889 changed during runtime by invoking a command through i3. The commands <tt>bar
\r
2890 hidden_state</tt> and <tt>bar mode</tt> allow setting the current hidden_state
\r
2891 respectively mode option of each bar. It is also possible to toggle between
\r
2892 hide state and show state as well as between dock mode and hide mode. Each
\r
2893 i3bar instance can be controlled individually by specifying a bar_id, if none
\r
2894 is given, the command is executed for all bar instances.</p></div>
\r
2895 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>
\r
2896 <div class="listingblock">
\r
2897 <div class="content">
\r
2898 <pre><tt>bar hidden_state hide|show|toggle [<bar_id>]
\r
2900 bar mode dock|hide|invisible|toggle [<bar_id>]</tt></pre>
\r
2902 <div class="paragraph"><p><strong>Examples</strong>:</p></div>
\r
2903 <div class="listingblock">
\r
2904 <div class="content">
\r
2905 <pre><tt># Toggle between hide state and show state
\r
2906 bindsym $mod+m bar hidden_state toggle
\r
2908 # Toggle between dock mode and hide mode
\r
2909 bindsym $mod+n bar mode toggle
\r
2911 # Set the bar instance with id 'bar-1' to switch to hide mode
\r
2912 bindsym $mod+b bar mode hide bar-1
\r
2914 # Set the bar instance with id 'bar-1' to always stay hidden
\r
2915 bindsym $mod+Shift+b bar mode invisible bar-1</tt></pre>
\r
2920 <div class="sect1">
\r
2921 <h2 id="multi_monitor">7. Multiple monitors</h2>
\r
2922 <div class="sectionbody">
\r
2923 <div class="paragraph"><p>As you can see in the goal list on the website, i3 was specifically developed
\r
2924 with support for multiple monitors in mind. This section will explain how to
\r
2925 handle multiple monitors.</p></div>
\r
2926 <div class="paragraph"><p>When you have only one monitor, things are simple. You usually start with
\r
2927 workspace 1 on your monitor and open new ones as you need them.</p></div>
\r
2928 <div class="paragraph"><p>When you have more than one monitor, each monitor will get an initial
\r
2929 workspace. The first monitor gets 1, the second gets 2 and a possible third
\r
2930 would get 3. When you switch to a workspace on a different monitor, i3 will
\r
2931 switch to that monitor and then switch to the workspace. This way, you don’t
\r
2932 need shortcuts to switch to a specific monitor, and you don’t need to remember
\r
2933 where you put which workspace. New workspaces will be opened on the currently
\r
2934 active monitor. It is not possible to have a monitor without a workspace.</p></div>
\r
2935 <div class="paragraph"><p>The idea of making workspaces global is based on the observation that most
\r
2936 users have a very limited set of workspaces on their additional monitors.
\r
2937 They are often used for a specific task (browser, shell) or for monitoring
\r
2938 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
\r
2939 and "the rest" on the other monitors often makes sense. However, as you can
\r
2940 create an unlimited number of workspaces in i3 and tie them to specific
\r
2941 screens, you can have the "traditional" approach of having X workspaces per
\r
2942 screen by changing your configuration (using modes, for example).</p></div>
\r
2943 <div class="sect2">
\r
2944 <h3 id="_configuring_your_monitors">7.1. Configuring your monitors</h3>
\r
2945 <div class="paragraph"><p>To help you get going if you have never used multiple monitors before, here is
\r
2946 a short overview of the xrandr options which will probably be of interest to
\r
2947 you. It is always useful to get an overview of the current screen configuration.
\r
2948 Just run "xrandr" and you will get an output like the following:</p></div>
\r
2949 <div class="listingblock">
\r
2950 <div class="content">
\r
2952 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
\r
2953 VGA1 disconnected (normal left inverted right x axis y axis)
\r
2954 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
\r
2955 1280x800 60.0*+ 50.0
\r
2956 1024x768 85.0 75.0 70.1 60.0
\r
2958 800x600 85.1 72.2 75.0 60.3 56.2
\r
2959 640x480 85.0 72.8 75.0 59.9
\r
2962 640x350 85.1</tt></pre>
\r
2964 <div class="paragraph"><p>Several things are important here: You can see that <tt>LVDS1</tt> is connected (of
\r
2965 course, it is the internal flat panel) but <tt>VGA1</tt> is not. If you have a monitor
\r
2966 connected to one of the ports but xrandr still says "disconnected", you should
\r
2967 check your cable, monitor or graphics driver.</p></div>
\r
2968 <div class="paragraph"><p>The maximum resolution you can see at the end of the first line is the maximum
\r
2969 combined resolution of your monitors. By default, it is usually too low and has
\r
2970 to be increased by editing <tt>/etc/X11/xorg.conf</tt>.</p></div>
\r
2971 <div class="paragraph"><p>So, say you connected VGA1 and want to use it as an additional screen:</p></div>
\r
2972 <div class="listingblock">
\r
2973 <div class="content">
\r
2974 <pre><tt>xrandr --output VGA1 --auto --left-of LVDS1</tt></pre>
\r
2976 <div class="paragraph"><p>This command makes xrandr try to find the native resolution of the device
\r
2977 connected to <tt>VGA1</tt> and configures it to the left of your internal flat panel.
\r
2978 When running "xrandr" again, the output looks like this:</p></div>
\r
2979 <div class="listingblock">
\r
2980 <div class="content">
\r
2982 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
\r
2983 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
\r
2984 1280x1024 60.0*+ 75.0
\r
2987 1024x768 75.1 70.1 60.0
\r
2989 800x600 72.2 75.0 60.3 56.2
\r
2990 640x480 72.8 75.0 66.7 60.0
\r
2992 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
\r
2993 1280x800 60.0*+ 50.0
\r
2994 1024x768 85.0 75.0 70.1 60.0
\r
2996 800x600 85.1 72.2 75.0 60.3 56.2
\r
2997 640x480 85.0 72.8 75.0 59.9
\r
3000 640x350 85.1</tt></pre>
\r
3002 <div class="paragraph"><p>Please note that i3 uses exactly the same API as xrandr does, so it will see
\r
3003 only what you can see in xrandr.</p></div>
\r
3004 <div class="paragraph"><p>See also <a href="#presentations">[presentations]</a> for more examples of multi-monitor setups.</p></div>
\r
3006 <div class="sect2">
\r
3007 <h3 id="_interesting_configuration_for_multi_monitor_environments">7.2. Interesting configuration for multi-monitor environments</h3>
\r
3008 <div class="paragraph"><p>There are several things to configure in i3 which may be interesting if you
\r
3009 have more than one monitor:</p></div>
\r
3010 <div class="olist arabic"><ol class="arabic">
\r
3013 You can specify which workspace should be put on which screen. This
\r
3014 allows you to have a different set of workspaces when starting than just
\r
3015 1 for the first monitor, 2 for the second and so on. See
\r
3016 <a href="#workspace_screen">[workspace_screen]</a>.
\r
3021 If you want some applications to generally open on the bigger screen
\r
3022 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
\r
3023 <a href="#assign_workspace">[assign_workspace]</a>.
\r
3028 If you have many workspaces on many monitors, it might get hard to keep
\r
3029 track of which window you put where. Thus, you can use vim-like marks to
\r
3030 quickly switch between windows. See <a href="#vim_like_marks">[vim_like_marks]</a>.
\r
3035 For information on how to move existing workspaces between monitors,
\r
3036 see <a href="#move_to_outputs">[move_to_outputs]</a>.
\r
3043 <div class="sect1">
\r
3044 <h2 id="_i3_and_the_rest_of_your_software_world">8. i3 and the rest of your software world</h2>
\r
3045 <div class="sectionbody">
\r
3046 <div class="sect2">
\r
3047 <h3 id="_displaying_a_status_line">8.1. Displaying a status line</h3>
\r
3048 <div class="paragraph"><p>A very common thing amongst users of exotic window managers is a status line at
\r
3049 some corner of the screen. It is an often superior replacement to the widget
\r
3050 approach you have in the task bar of a traditional desktop environment.</p></div>
\r
3051 <div class="paragraph"><p>If you don’t already have your favorite way of generating such a status line
\r
3052 (self-written scripts, conky, …), then i3status is the recommended tool for
\r
3053 this task. It was written in C with the goal of using as few syscalls as
\r
3054 possible to reduce the time your CPU is woken up from sleep states. Because
\r
3055 i3status only spits out text, you need to combine it with some other tool, like
\r
3056 i3bar. See <a href="#status_command">[status_command]</a> for how to display i3status in i3bar.</p></div>
\r
3057 <div class="paragraph"><p>Regardless of which application you use to display the status line, you
\r
3058 want to make sure that it registers as a dock window using EWMH hints. i3 will
\r
3059 position the window either at the top or at the bottom of the screen, depending
\r
3060 on which hint the application sets. With i3bar, you can configure its position,
\r
3061 see <a href="#i3bar_position">[i3bar_position]</a>.</p></div>
\r
3063 <div class="sect2">
\r
3064 <h3 id="presentations">8.2. Giving presentations (multi-monitor)</h3>
\r
3065 <div class="paragraph"><p>When giving a presentation, you typically want the audience to see what you see
\r
3066 on your screen and then go through a series of slides (if the presentation is
\r
3067 simple). For more complex presentations, you might want to have some notes
\r
3068 which only you can see on your screen, while the audience can only see the
\r
3070 <div class="sect3">
\r
3071 <h4 id="_case_1_everybody_gets_the_same_output">8.2.1. Case 1: everybody gets the same output</h4>
\r
3072 <div class="paragraph"><p>This is the simple case. You connect your computer to the video projector,
\r
3073 turn on both (computer and video projector) and configure your X server to
\r
3074 clone the internal flat panel of your computer to the video output:</p></div>
\r
3075 <div class="listingblock">
\r
3076 <div class="content">
\r
3077 <pre><tt>xrandr --output VGA1 --mode 1024x768 --same-as LVDS1</tt></pre>
\r
3079 <div class="paragraph"><p>i3 will then use the lowest common subset of screen resolutions, the rest of
\r
3080 your screen will be left untouched (it will show the X background). So, in
\r
3081 our example, this would be 1024x768 (my notebook has 1280x800).</p></div>
\r
3083 <div class="sect3">
\r
3084 <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
3085 <div class="paragraph"><p>This case is a bit harder. First of all, you should configure the VGA output
\r
3086 somewhere near your internal flat panel, say right of it:</p></div>
\r
3087 <div class="listingblock">
\r
3088 <div class="content">
\r
3089 <pre><tt>xrandr --output VGA1 --mode 1024x768 --right-of LVDS1</tt></pre>
\r
3091 <div class="paragraph"><p>Now, i3 will put a new workspace (depending on your settings) on the new screen
\r
3092 and you are in multi-monitor mode (see <a href="#multi_monitor">[multi_monitor]</a>).</p></div>
\r
3093 <div class="paragraph"><p>Because i3 is not a compositing window manager, there is no ability to
\r
3094 display a window on two screens at the same time. Instead, your presentation
\r
3095 software needs to do this job (that is, open a window on each screen).</p></div>
\r
3101 <div id="footnotes"><hr /></div>
\r
3102 <div id="footer" lang="de">
\r
3103 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>
\r
projects / i3 / i3.github.io / blob