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