3 Michael Stapelberg <michael@i3wm.org>
5 This document contains all the information you need to configure and use the i3
6 window manager. If it does not, please check https://www.reddit.com/r/i3wm/
7 first, then contact us on IRC (preferred) or post your question(s) on the
10 == Default keybindings
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):
15 *Keys to use with $mod (Alt):*
17 image:keyboard-layer1.png["Keys to use with $mod (Alt)",width=600,link="keyboard-layer1.png"]
19 *Keys to use with Shift+$mod:*
21 image:keyboard-layer2.png["Keys to use with Shift+$mod",width=600,link="keyboard-layer2.png"]
23 The red keys are the modifiers you need to press (by default), the blue keys
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
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 that largely prevents conflicts with
38 application-defined shortcuts.
40 === Opening terminals and moving around
42 One very basic operation is opening a new terminal. By default, the keybinding
43 for this is +$mod+Enter+, that is Alt+Enter (+Mod1+Enter+) in the default
44 configuration. By pressing +$mod+Enter+, a new terminal will be opened. It
45 will fill the whole space available on your screen.
47 image:single_terminal.png[Single terminal]
49 If you now open another terminal, i3 will place it next to the current one,
50 splitting the screen size in half. Depending on your monitor, i3 will put the
51 created window beside the existing window (on wide displays) or below the
52 existing window (rotated displays).
54 image:two_terminals.png[Two terminals]
56 To move the focus between the two terminals, you can use the direction keys
57 which you may know from the editor +vi+. However, in i3, your homerow is used
58 for these keys (in +vi+, the keys are shifted to the left by one for
59 compatibility with most keyboard layouts). Therefore, +$mod+j+ is left, +$mod+k+
60 is down, +$mod+l+ is up and `$mod+;` is right. So, to switch between the
61 terminals, use +$mod+k+ or +$mod+l+. Of course, you can also use the arrow keys.
63 At the moment, your workspace is split (it contains two terminals) in a
64 specific direction (horizontal by default). Every window can be split
65 horizontally or vertically again, just like the workspace. The terminology is
66 "window" for a container that actually contains an X11 window (like a terminal
67 or browser) and "split container" for containers that consist of one or more
70 TODO: picture of the tree
72 To split a window vertically, press +$mod+v+ before you create the new window.
73 To split it horizontally, press +$mod+h+.
75 === Changing the container layout
77 A split container can have one of the following layouts:
80 Windows are sized so that every window gets an equal amount of space in the
81 container. splith distributes the windows horizontally (windows are right next
82 to each other), splitv distributes them vertically (windows are on top of each
85 Only the focused window in the container is displayed. You get a list of
86 windows at the top of the container.
88 The same principle as +stacking+, but the list of windows at the top is only
89 a single line which is vertically split.
91 To switch modes, press +$mod+e+ for splith/splitv (it toggles), +$mod+s+ for
92 stacking and +$mod+w+ for tabbed.
94 image:modes.png[Container modes]
96 === Toggling fullscreen mode for a window
98 To display a window in fullscreen mode or to go out of fullscreen mode again,
101 There is also a global fullscreen mode in i3 in which the client will span all
102 available outputs (the command is +fullscreen toggle global+).
104 === Opening other applications
106 Aside from opening applications from a terminal, you can also use the handy
107 +dmenu+ which is opened by pressing +$mod+d+ by default. Just type the name
108 (or a part of it) of the application which you want to open. The corresponding
109 application has to be in your +$PATH+ for this to work.
111 Additionally, if you have applications you open very frequently, you can
112 create a keybinding for starting the application directly. See the section
113 <<configuring>> for details.
117 If an application does not provide a mechanism for closing (most applications
118 provide a menu, the escape key or a shortcut like +Control+w+ to close), you
119 can press +$mod+Shift+q+ to kill a window. For applications which support
120 the WM_DELETE protocol, this will correctly close the application (saving
121 any modifications or doing other cleanup). If the application doesn’t support
122 the WM_DELETE protocol your X server will kill the window and the behaviour
123 depends on the application.
127 Workspaces are an easy way to group a set of windows. By default, you are on
128 the first workspace, as the bar on the bottom left indicates. To switch to
129 another workspace, press +$mod+num+ where +num+ is the number of the workspace
130 you want to use. If the workspace does not exist yet, it will be created.
132 A common paradigm is to put the web browser on one workspace, communication
133 applications (+mutt+, +irssi+, ...) on another one, and the ones with which you
134 work, on the third one. Of course, there is no need to follow this approach.
136 If you have multiple screens, a workspace will be created on each screen at
137 startup. If you open a new workspace, it will be bound to the screen you
138 created it on. When you switch to a workspace on another screen, i3 will set
139 focus to that screen.
141 === Moving windows to workspaces
143 To move a window to another workspace, simply press +$mod+Shift+num+ where
144 +num+ is (like when switching workspaces) the number of the target workspace.
145 Similarly to switching workspaces, the target workspace will be created if
146 it does not yet exist.
150 The easiest way to resize a container is by using the mouse: Grab the border
151 and move it to the wanted size.
153 You can also use <<binding_modes>> to define a mode for resizing via the
154 keyboard. To see an example for this, look at the
155 https://github.com/i3/i3/blob/next/etc/config.keycodes[default config] provided
158 === Restarting i3 inplace
160 To restart i3 in place (and thus get into a clean state if there is a bug, or
161 to upgrade to a newer version of i3) you can use +$mod+Shift+r+.
165 To cleanly exit i3 without killing your X server, you can use +$mod+Shift+e+.
166 By default, a dialog will ask you to confirm if you really want to quit.
170 Floating mode is the opposite of tiling mode. The position and size of
171 a window are not managed automatically by i3, but manually by
172 you. Using this mode violates the tiling paradigm but can be useful
173 for some corner cases like "Save as" dialog windows, or toolbar
174 windows (GIMP or similar). Those windows usually set the appropriate
175 hint and are opened in floating mode by default.
177 You can toggle floating mode for a window by pressing +$mod+Shift+Space+. By
178 dragging the window’s titlebar with your mouse you can move the window
179 around. By grabbing the borders and moving them you can resize the window. You
180 can also do that by using the <<floating_modifier>>. Another way to resize
181 floating windows using the mouse is to right-click on the titlebar and drag.
183 For resizing floating windows with your keyboard, see the resizing binding mode
184 provided by the i3 https://github.com/i3/i3/blob/next/etc/config.keycodes[default config].
186 Floating windows are always on top of tiling windows.
190 i3 stores all information about the X11 outputs, workspaces and layout of the
191 windows on them in a tree. The root node is the X11 root window, followed by
192 the X11 outputs, then dock areas and a content container, then workspaces and
193 finally the windows themselves. In previous versions of i3 we had multiple lists
194 (of outputs, workspaces) and a table for each workspace. That approach turned
195 out to be complicated to use (snapping), understand and implement.
197 === The tree consists of Containers
199 The building blocks of our tree are so-called +Containers+. A +Container+ can
200 host a window (meaning an X11 window, one that you can actually see and use,
201 like a browser). Alternatively, it could contain one or more +Containers+. A
202 simple example is the workspace: When you start i3 with a single monitor, a
203 single workspace and you open two terminal windows, you will end up with a tree
206 image::tree-layout2.png["layout2",float="right"]
207 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
210 === Orientation and Split Containers
212 It is only natural to use so-called +Split Containers+ in order to build a
213 layout when using a tree as data structure. In i3, every +Container+ has an
214 orientation (horizontal, vertical or unspecified) and the orientation depends
215 on the layout the container is in (vertical for splitv and stacking, horizontal
216 for splith and tabbed). So, in our example with the workspace, the default
217 layout of the workspace +Container+ is splith (most monitors are widescreen
218 nowadays). If you change the layout to splitv (+$mod+v+ in the default config)
219 and *then* open two terminals, i3 will configure your windows like this:
221 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
223 An interesting new feature of i3 since version 4 is the ability to split anything:
224 Let’s assume you have two terminals on a workspace (with splith layout, that is
225 horizontal orientation), focus is on the right terminal. Now you want to open
226 another terminal window below the current one. If you would just open a new
227 terminal window, it would show up to the right due to the splith layout.
228 Instead, press +$mod+v+ to split the container with the splitv layout (to
229 open a +Horizontal Split Container+, use +$mod+h+). Now you can open a new
230 terminal and it will open below the current one:
232 image::tree-layout1.png["Layout",float="right"]
233 image::tree-shot1.png["shot",title="Vertical Split Container"]
237 You probably guessed it already: There is no limit on how deep your hierarchy
242 Let’s stay with our example from above. We have a terminal on the left and two
243 vertically split terminals on the right, focus is on the bottom right one. When
244 you open a new terminal, it will open below the current one.
246 So, how can you open a new terminal window to the *right* of the current one?
247 The solution is to use +focus parent+, which will focus the +Parent Container+ of
248 the current +Container+. In this case, you would focus the +Vertical Split
249 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
250 windows will be opened to the right of the +Vertical Split Container+:
252 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
254 === Implicit containers
256 In some cases, i3 needs to implicitly create a container to fulfill your
259 One example is the following scenario: You start i3 with a single monitor and a
260 single workspace on which you open three terminal windows. All these terminal
261 windows are directly attached to one node inside i3’s layout tree, the
262 workspace node. By default, the workspace node’s orientation is +horizontal+.
264 Now you move one of these terminals down (+$mod+Shift+k+ by default). The
265 workspace node’s orientation will be changed to +vertical+. The terminal window
266 you moved down is directly attached to the workspace and appears on the bottom
267 of the screen. A new (horizontal) container was created to accommodate the
268 other two terminal windows. You will notice this when switching to tabbed mode
269 (for example). You would end up having one tab with a representation of the split
270 container (e.g., "H[urxvt firefox]") and the other one being the terminal window
276 This is where the real fun begins ;-). Most things are very dependent on your
277 ideal working environment so we can’t make reasonable defaults for them.
279 While not using a programming language for the configuration, i3 stays
280 quite flexible in regards to the things you usually want your window manager
283 For example, you can configure bindings to jump to specific windows,
284 you can set specific applications to start on specific workspaces, you can
285 automatically start applications, you can change the colors of i3, and you
286 can bind your keys to do useful things.
288 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
289 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
292 On first start (and on all following starts, unless you have a configuration
293 file), i3 will offer you to create a configuration file. You can tell the
294 wizard to use either Alt (+Mod1+) or Windows (+Mod4+) as modifier in the config
295 file. Also, the created config file will use the key symbols of your current
296 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
297 Please note that you must not have +~/.i3/config+, otherwise the wizard will
300 Since i3 4.0, a new configuration format is used. i3 will try to automatically
301 detect the format version of a config file based on a few different keywords,
302 but if you want to make sure that your config is read with the new format,
303 include the following line in your config file:
305 ---------------------
306 # i3 config file (v4)
307 ---------------------
311 It is possible and recommended to use comments in your configuration file to
312 properly document your setup for later reference. Comments are started with
313 a # and can only be used at the beginning of a line:
323 i3 has support for both X core fonts and FreeType fonts (through Pango) to
324 render window titles.
326 To generate an X core font description, you can use +xfontsel(1)+. To see
327 special characters (Unicode), you need to use a font which supports the
330 A FreeType font description is composed by a font family, a style, a weight,
331 a variant, a stretch and a size.
332 FreeType fonts support right-to-left rendering and contain often more
333 Unicode glyphs than X core fonts.
335 If i3 cannot open the configured font, it will output an error in the logfile
336 and fall back to a working font.
339 ------------------------------
340 font <X core font description>
341 font pango:<family list> [<style options>] <size>
342 ------------------------------
345 --------------------------------------------------------------
346 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
347 font pango:DejaVu Sans Mono 10
348 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
349 font pango:Terminus 11px
350 --------------------------------------------------------------
353 === Keyboard bindings
355 A keyboard binding makes i3 execute a command (see below) upon pressing a
356 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
357 also mix your bindings, though i3 will not protect you from overlapping ones).
359 * A keysym (key symbol) is a description for a specific symbol, like "a"
360 or "b", but also more strange ones like "underscore" instead of "_". These
361 are the ones you use in Xmodmap to remap your keys. To get the current
362 mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
363 see what keysym it is configured to, use +xev+.
365 * Keycodes do not need to have a symbol assigned (handy for custom vendor
366 hotkeys on some notebooks) and they will not change their meaning as you
367 switch to a different keyboard layout (when using +xmodmap+).
369 My recommendation is: If you often switch keyboard layouts but you want to keep
370 your bindings in the same physical location on the keyboard, use keycodes.
371 If you don’t switch layouts, and want a clean and simple config file, use
374 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
375 KeyPress event, because the keyboard/pointer is still grabbed. For these
376 situations, the +--release+ flag can be used, which will execute the command
377 after the keys have been released.
380 ----------------------------------
381 bindsym [--release] [<Group>+][<Modifiers>+]<keysym> command
382 bindcode [--release] [<Group>+][<Modifiers>+]<keycode> command
383 ----------------------------------
386 --------------------------------
388 bindsym $mod+f fullscreen toggle
391 bindsym $mod+Shift+r restart
393 # Notebook-specific hotkeys
394 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
396 # Simulate ctrl+v upon pressing $mod+x
397 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
399 # Take a screenshot upon pressing $mod+x (select an area)
400 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
401 --------------------------------
405 Mod1-Mod5, Shift, Control::
406 Standard modifiers, see +xmodmap(1)+
408 Group1, Group2, Group3, Group4::
409 When using multiple keyboard layouts (e.g. with `setxkbmap -layout us,ru`), you
410 can specify in which XKB group (also called “layout”) a keybinding should be
411 active. By default, keybindings are translated in Group1 and are active in all
412 groups. If you want to override keybindings in one of your layouts, specify the
413 corresponding group. For backwards compatibility, the group “Mode_switch” is an
419 A mouse binding makes i3 execute a command upon pressing a specific mouse
420 button in the scope of the clicked container (see <<command_criteria>>). You
421 can configure mouse bindings in a similar way to key bindings.
424 ----------------------------------------------------------------------------------------------------
425 bindsym [--release] [--border] [--whole-window] [--exclude-titlebar] [<Modifiers>+]button<n> command
426 ----------------------------------------------------------------------------------------------------
428 By default, the binding will only run when you click on the titlebar of the
429 window. If the +--release+ flag is given, it will run when the mouse button
432 If the +--whole-window+ flag is given, the binding will also run when any part
433 of the window is clicked, with the exception of the border. To have a bind run
434 when the border is clicked, specify the +--border+ flag.
436 If the +--exclude-titlebar+ flag is given, the titlebar will not be considered
440 --------------------------------
441 # The middle button over a titlebar kills the window
442 bindsym --release button2 kill
444 # The middle button and a modifer over any part of the window kills the window
445 bindsym --whole-window $mod+button2 kill
447 # The right button toggles floating
448 bindsym button3 floating toggle
449 bindsym $mod+button3 floating toggle
451 # The side buttons move the window around
452 bindsym button9 move left
453 bindsym button8 move right
454 --------------------------------
459 You can have multiple sets of bindings by using different binding modes. When
460 you switch to another binding mode, all bindings from the current mode are
461 released and only the bindings defined in the new mode are valid for as long as
462 you stay in that binding mode. The only predefined binding mode is +default+,
463 which is the mode i3 starts out with and to which all bindings not defined in a
464 specific binding mode belong.
466 Working with binding modes consists of two parts: defining a binding mode and
467 switching to it. For these purposes, there are one config directive and one
468 command, both of which are called +mode+. The directive is used to define the
469 bindings belonging to a certain binding mode, while the command will switch to
472 It is recommended to use binding modes in combination with <<variables>> in
473 order to make maintenance easier. Below is an example of how to use a binding
476 Note that it is advisable to define bindings for switching back to the default
479 Note that it is possible to use <<pango_markup>> for binding modes, but you
480 need to enable it explicitly by passing the +--pango_markup+ flag to the mode
484 ----------------------------
486 mode [--pango_markup] <name>
490 ----------------------------
493 ------------------------------------------------------------------------
494 # Press $mod+o followed by either f, t, Escape or Return to launch firefox,
495 # thunderbird or return to the default mode, respectively.
496 set $mode_launcher Launch: [f]irefox [t]hunderbird
497 bindsym $mod+o mode "$mode_launcher"
499 mode "$mode_launcher" {
500 bindsym f exec firefox
501 bindsym t exec thunderbird
503 bindsym Escape mode "default"
504 bindsym Return mode "default"
506 ------------------------------------------------------------------------
508 [[floating_modifier]]
509 === The floating modifier
511 To move floating windows with your mouse, you can either grab their titlebar
512 or configure the so-called floating modifier which you can then press and
513 click anywhere in the window itself to move it. The most common setup is to
514 use the same key you use for managing windows (Mod1 for example). Then
515 you can press Mod1, click into a window using your left mouse button, and drag
516 it to the position you want.
518 When holding the floating modifier, you can resize a floating window by
519 pressing the right mouse button on it and moving around while holding it. If
520 you hold the shift button as well, the resize will be proportional (the aspect
521 ratio will be preserved).
524 --------------------------------
525 floating_modifier <Modifier>
526 --------------------------------
529 --------------------------------
530 floating_modifier Mod1
531 --------------------------------
533 === Constraining floating window size
535 The maximum and minimum dimensions of floating windows can be specified. If
536 either dimension of +floating_maximum_size+ is specified as -1, that dimension
537 will be unconstrained with respect to its maximum value. If either dimension of
538 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
539 value to constrain the maximum size. +floating_minimum_size+ is treated in a
540 manner analogous to +floating_maximum_size+.
543 ----------------------------------------
544 floating_minimum_size <width> x <height>
545 floating_maximum_size <width> x <height>
546 ----------------------------------------
549 --------------------------------------
550 floating_minimum_size 75 x 50
551 floating_maximum_size -1 x -1
552 --------------------------------------
554 === Orientation for new workspaces
556 New workspaces get a reasonable default orientation: Wide-screen monitors
557 (anything wider than high) get horizontal orientation, rotated monitors
558 (anything higher than wide) get vertical orientation.
560 With the +default_orientation+ configuration directive, you can override that
564 --------------------------------------------
565 default_orientation horizontal|vertical|auto
566 --------------------------------------------
569 ----------------------------
570 default_orientation vertical
571 ----------------------------
573 === Layout mode for new containers
575 This option determines in which mode new containers on workspace level will
579 ---------------------------------------------
580 workspace_layout default|stacking|tabbed
581 ---------------------------------------------
584 ---------------------
585 workspace_layout tabbed
586 ---------------------
588 === Default border style for new windows
590 This option determines which border style new windows will have. The default is
591 +normal+. Note that default_floating_border applies only to windows which are starting out as
592 floating windows, e.g., dialog windows, but not windows that are floated later on.
595 ---------------------------------------------
596 default_border normal|none|pixel
597 default_border normal|pixel <px>
598 default_floating_border normal|none|pixel
599 default_floating_border normal|pixel <px>
600 ---------------------------------------------
602 Please note that +new_window+ and +new_float+ have been deprecated in favor of the above options
603 and will be removed in a future release. We strongly recommend using the new options instead.
606 ---------------------
608 ---------------------
610 The "normal" and "pixel" border styles support an optional border width in
614 ---------------------
615 # The same as default_border none
616 default_border pixel 0
619 default_border pixel 3
620 ---------------------
623 [[_hiding_vertical_borders]]
624 === Hiding borders adjacent to the screen edges
626 You can hide container borders adjacent to the screen edges using
627 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
628 to waste even two pixels in displayspace. The "smart" setting hides borders on
629 workspaces with only one window visible, but keeps them on workspaces with
630 multiple windows visible. Default is none.
633 -----------------------------------------------
634 hide_edge_borders none|vertical|horizontal|both|smart
635 -----------------------------------------------
638 ----------------------
639 hide_edge_borders vertical
640 ----------------------
643 === Arbitrary commands for specific windows (for_window)
645 With the +for_window+ command, you can let i3 execute any command when it
646 encounters a specific window. This can be used to set windows to floating or to
647 change their border style, for example.
650 -------------------------------
651 for_window <criteria> <command>
652 -------------------------------
655 ------------------------------------------------
656 # enable floating mode for all XTerm windows
657 for_window [class="XTerm"] floating enable
659 # Make all urxvts use a 1-pixel border:
660 for_window [class="urxvt"] border pixel 1
662 # A less useful, but rather funny example:
663 # makes the window floating as soon as I change
664 # directory to ~/work
665 for_window [title="x200: ~/work"] floating enable
666 ------------------------------------------------
668 The valid criteria are the same as those for commands, see <<command_criteria>>.
671 === Don't focus window upon opening
673 When a new window appears, it will be focused. The +no_focus+ directive allows preventing
674 this from happening and must be used in combination with <<command_criteria>>.
676 Note that this does not apply to all cases, e.g., when feeding data into a running application
677 causing it to request being focused. To configure the behavior in such cases, refer to
678 <<focus_on_window_activation>>.
680 +no_focus+ will also be ignored for the first window on a workspace as there shouldn't be
681 a reason to not focus the window in this case. This allows for better usability in
682 combination with +workspace_layout+.
690 -------------------------------
691 no_focus [window_role="pop-up"]
692 -------------------------------
697 As you learned in the section about keyboard bindings, you will have
698 to configure lots of bindings containing modifier keys. If you want to save
699 yourself some typing and be able to change the modifier you use later,
700 variables can be handy.
708 ------------------------
710 bindsym $m+Shift+r restart
711 ------------------------
713 Variables are directly replaced in the file when parsing. Variables expansion
714 is not recursive so it is not possible to define a variable with a value
715 containing another variable. There is no fancy handling and there are
716 absolutely no plans to change this. If you need a more dynamic configuration
717 you should create a little script which generates a configuration file and run
718 it before starting i3 (for example in your +~/.xsession+ file).
720 Also see <<xresources>> to learn how to create variables based on resources
721 loaded from the X resource database.
726 <<variables>> can also be created using a value configured in the X resource
727 database. This is useful, for example, to avoid configuring color values within
728 the i3 configuration. Instead, the values can be configured, once, in the X
729 resource database to achieve an easily maintainable, consistent color theme
730 across many X applications.
732 Defining a resource will load this resource from the resource database and
733 assign its value to the specified variable. This is done verbatim and the value
734 must therefore be in the format that i3 uses. A fallback must be specified in
735 case the resource cannot be loaded from the database.
738 ----------------------------------------------------
739 set_from_resource $<name> <resource_name> <fallback>
740 ----------------------------------------------------
743 ----------------------------------------------------------------------------
744 # The ~/.Xresources should contain a line such as
746 # and must be loaded properly, e.g., by using
748 # This value is picked up on by other applications (e.g., the URxvt terminal
749 # emulator) and can be used in i3 like this:
750 set_from_resource $black i3wm.color0 #000000
751 ----------------------------------------------------------------------------
754 === Automatically putting clients on specific workspaces
756 To automatically make a specific window show up on a specific workspace, you
757 can use an *assignment*. You can match windows by using any criteria,
758 see <<command_criteria>>. The difference between +assign+ and
759 +for_window <criteria> move to workspace+ is that the former will only be
760 executed when the application maps the window (mapping means actually displaying
761 it on the screen) but the latter will be executed whenever a window changes its
762 properties to something that matches the specified criteria.
764 Thus, it is recommended that you match on window classes (and instances, when
765 appropriate) instead of window titles whenever possible because some
766 applications first create their window, and then worry about setting the correct
767 title. Firefox with Vimperator comes to mind. The window starts up being named
768 Firefox, and only when Vimperator is loaded does the title change. As i3 will
769 get the title as soon as the application maps the window, you’d need to have to
770 match on 'Firefox' in this case.
771 Another known issue is with Spotify, which doesn't set the class hints when
772 mapping the window, meaning you'll have to use a +for_window+ rule to assign
773 Spotify to a specific workspace.
774 Finally, using +assign [tiling]+ and +assign [floating]+ is not supported.
776 You can also assign a window to show up on a specific output. You can use RandR
777 names such as +VGA1+ or names relative to the output with the currently focused
778 workspace such as +left+ and +down+.
780 Assignments are processed by i3 in the order in which they appear in the config
781 file. The first one which matches the window wins and later assignments are not
785 ------------------------------------------------------------
786 assign <criteria> [→] [workspace] [number] <workspace>
787 assign <criteria> [→] output left|right|up|down|primary|<output>
788 ------------------------------------------------------------
791 ----------------------
792 # Assign URxvt terminals to workspace 2
793 assign [class="URxvt"] 2
795 # Same thing, but more precise (exact match instead of substring)
796 assign [class="^URxvt$"] 2
798 # Same thing, but with a beautiful arrow :)
799 assign [class="^URxvt$"] → 2
801 # Assignment to a named workspace
802 assign [class="^URxvt$"] → work
804 # Assign to the workspace with number 2, regardless of name
805 assign [class="^URxvt$"] → number 2
807 # You can also specify a number + name. If the workspace with number 2 exists, assign will skip the text part.
808 assign [class="^URxvt$"] → number "2: work"
810 # Start urxvt -name irssi
811 assign [class="^URxvt$" instance="^irssi$"] → 3
813 # Assign urxvt to the output right of the current one
814 assign [class="^URxvt$"] → output right
816 # Assign urxvt to the primary output
817 assign [class="^URxvt$"] → output primary
818 ----------------------
820 Note that you might not have a primary output configured yet. To do so, run:
821 -------------------------
822 xrandr --output <output> --primary
823 -------------------------
825 Also, the arrow is not required, it just looks good :-). If you decide to
826 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
828 To get the class and instance, you can use +xprop+. After clicking on the
829 window, you will see the following output:
832 -----------------------------------
833 WM_CLASS(STRING) = "irssi", "URxvt"
834 -----------------------------------
836 The first part of the WM_CLASS is the instance ("irssi" in this example), the
837 second part is the class ("URxvt" in this example).
839 Should you have any problems with assignments, make sure to check the i3
840 logfile first (see https://i3wm.org/docs/debugging.html). It includes more
841 details about the matching process and the window’s actual class, instance and
842 title when starting up.
844 Note that if you want to start an application just once on a specific
845 workspace, but you don’t want to assign all instances of it permanently, you
846 can make use of i3’s startup-notification support (see <<exec>>) in your config
847 file in the following way:
849 *Start iceweasel on workspace 3 (once)*:
850 -------------------------------------------------------------------------------
851 # Start iceweasel on workspace 3, then switch back to workspace 1
852 # (Being a command-line utility, i3-msg does not support startup notifications,
853 # hence the exec --no-startup-id.)
854 # (Starting iceweasel with i3’s exec command is important in order to make i3
855 # create a startup notification context, without which the iceweasel window(s)
856 # cannot be matched onto the workspace on which the command was started.)
857 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
858 -------------------------------------------------------------------------------
860 === Automatically starting applications on i3 startup
862 By using the +exec+ keyword outside a keybinding, you can configure
863 which commands will be performed by i3 on initial startup. +exec+
864 commands will not run when restarting i3, if you need a command to run
865 also when restarting i3 you should use the +exec_always+
866 keyword. These commands will be run in order.
868 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
869 and +,+ (comma): they chain commands together in i3, so you need to use quoted
870 strings (as shown in <<exec_quoting>>) if they appear in your command.
873 ---------------------------------------
874 exec [--no-startup-id] <command>
875 exec_always [--no-startup-id] <command>
876 ---------------------------------------
879 --------------------------------
881 exec_always ~/my_script.sh
883 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
884 exec --no-startup-id urxvt
885 --------------------------------
887 The flag --no-startup-id is explained in <<exec>>.
890 === Automatically putting workspaces on specific screens
892 If you assign clients to workspaces, it might be handy to put the
893 workspaces on specific screens. Also, the assignment of workspaces to screens
894 will determine which workspace i3 uses for a new screen when adding screens
895 or when starting (e.g., by default it will use 1 for the first screen, 2 for
896 the second screen and so on).
899 -------------------------------------
900 workspace <workspace> output <output1> [output2]…
901 -------------------------------------
903 The 'output' is the name of the RandR output you attach your screen to. On a
904 laptop, you might have VGA1 and LVDS1 as output names. You can see the
905 available outputs by running +xrandr --current+.
907 If your X server supports RandR 1.5 or newer, i3 will use RandR monitor objects
908 instead of output objects. Run +xrandr --listmonitors+ to see a list. Usually,
909 a monitor object contains exactly one output, and has the same name as the
910 output; but should that not be the case, you may specify the name of either the
911 monitor or the output in i3's configuration. For example, the Dell UP2414Q uses
912 two scalers internally, so its output names might be “DP1” and “DP2”, but the
913 monitor name is “Dell UP2414Q”.
915 (Note that even if you specify the name of an output which doesn't span the
916 entire monitor, i3 will still use the entire area of the containing monitor
917 rather than that of just the output's.)
919 You can specify multiple outputs. The first available will be used.
921 If you use named workspaces, they must be quoted:
924 ---------------------------
925 workspace 1 output LVDS1
926 workspace 2 output primary
927 workspace 5 output VGA1 LVDS1
928 workspace "2: vim" output VGA1
929 ---------------------------
933 You can change all colors which i3 uses to draw the window decorations.
936 --------------------------------------------------------------------
937 <colorclass> <border> <background> <text> <indicator> <child_border>
938 --------------------------------------------------------------------
940 Where colorclass can be one of:
943 A client which currently has the focus.
944 client.focused_inactive::
945 A client which is the focused one of its container, but it does not have
946 the focus at the moment.
948 A client which is not the focused one of its container.
950 A client which has its urgency hint activated.
952 Background and text color are used to draw placeholder window contents
953 (when restoring layouts). Border and indicator are ignored.
955 Background color which will be used to paint the background of the
956 client window on top of which the client will be rendered. Only clients
957 which do not cover the whole area of this window expose the color. Note
958 that this colorclass only takes a single color.
960 Colors are in HTML hex format (#rrggbb), see the following example:
962 *Examples (default colors)*:
963 ----------------------------------------------------------------------
964 # class border backgr. text indicator child_border
965 client.focused #4c7899 #285577 #ffffff #2e9ef4 #285577
966 client.focused_inactive #333333 #5f676a #ffffff #484e50 #5f676a
967 client.unfocused #333333 #222222 #888888 #292d2e #222222
968 client.urgent #2f343a #900000 #ffffff #900000 #900000
969 client.placeholder #000000 #0c0c0c #ffffff #000000 #0c0c0c
971 client.background #ffffff
972 ----------------------------------------------------------------------
974 Note that for the window decorations, the color around the child window is the
975 "child_border", and "border" color is only the two thin lines around the
978 The indicator color is used for indicating where a new window will be opened.
979 For horizontal split containers, the right border will be painted in indicator
980 color, for vertical split containers, the bottom border. This only applies to
981 single windows within a split container, which are otherwise indistinguishable
982 from single windows outside of a split container.
984 === Interprocess communication
986 i3 uses Unix sockets to provide an IPC interface. This allows third-party
987 programs to get information from i3, such as the current workspaces
988 (to display a workspace bar), and to control i3.
990 The IPC socket is enabled by default and will be created in
991 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
992 the PID of i3 and XXXXXX is a string of random characters from the portable
993 filename character set (see mkdtemp(3)).
995 You can override the default path through the environment-variable +I3SOCK+ or
996 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
997 does the right thing by default. If you decide to change it, it is strongly
998 recommended to set this to a location in your home directory so that no other
999 user can create that directory.
1002 ----------------------------
1003 ipc-socket ~/.i3/i3-ipc.sock
1004 ----------------------------
1006 You can then use the +i3-msg+ application to perform any command listed in
1007 <<list_of_commands>>.
1009 === Focus follows mouse
1011 By default, window focus follows your mouse movements as the mouse crosses
1012 window borders. However, if you have a setup where your mouse usually is in your
1013 way (like a touchpad on your laptop which you do not want to disable
1014 completely), you might want to disable 'focus follows mouse' and control focus
1015 only by using your keyboard. The mouse will still be useful inside the
1016 currently active window (for example to click on links in your browser window).
1019 --------------------------
1020 focus_follows_mouse yes|no
1021 --------------------------
1024 ----------------------
1025 focus_follows_mouse no
1026 ----------------------
1030 By default, when switching focus to a window on a different output (e.g.
1031 focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on
1032 LVDS-1), the mouse cursor is warped to the center of that window.
1034 With the +mouse_warping+ option, you can control when the mouse cursor should
1035 be warped. +none+ disables warping entirely, whereas +output+ is the default
1036 behavior described above.
1039 -------------------------
1040 mouse_warping output|none
1041 -------------------------
1048 === Popups during fullscreen mode
1050 When you are in fullscreen mode, some applications still open popup windows
1051 (take Xpdf for example). This is because these applications may not be aware
1052 that they are in fullscreen mode (they do not check the corresponding hint).
1053 There are three things which are possible to do in this situation:
1055 1. Display the popup if it belongs to the fullscreen application only. This is
1056 the default and should be reasonable behavior for most users.
1057 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
1058 in fullscreen. However, some apps might react badly to this (deadlock until
1059 you go out of fullscreen).
1060 3. Leave fullscreen mode.
1063 -----------------------------------------------------
1064 popup_during_fullscreen smart|ignore|leave_fullscreen
1065 -----------------------------------------------------
1068 ------------------------------
1069 popup_during_fullscreen smart
1070 ------------------------------
1074 By default, when in a container with several windows or child containers, the
1075 opposite window will be focused when trying to move the focus over the edge of
1076 a container (and there are no other containers in that direction) -- the focus
1079 If desired, you can disable this behavior by setting the +focus_wrapping+
1080 configuration directive to the value +no+.
1082 When enabled, focus wrapping does not occur by default if there is another
1083 window or container in the specified direction, and focus will instead be set
1084 on that window or container. This is the default behavior so you can navigate
1085 to all your windows without having to use +focus parent+.
1087 If you want the focus to *always* wrap and you are aware of using +focus
1088 parent+ to switch to different containers, you can instead set +focus_wrapping+
1089 to the value +force+.
1092 ---------------------------
1093 focus_wrapping yes|no|force
1095 # Legacy syntax, equivalent to "focus_wrapping force"
1096 force_focus_wrapping yes
1097 ---------------------------
1101 # Disable focus wrapping
1104 # Force focus wrapping
1105 focus_wrapping force
1108 === Forcing Xinerama
1110 As explained in-depth in <https://i3wm.org/docs/multi-monitor.html>, some X11
1111 video drivers (especially the nVidia binary driver) only provide support for
1112 Xinerama instead of RandR. In such a situation, i3 must be told to use the
1113 inferior Xinerama API explicitly and therefore don’t provide support for
1114 reconfiguring your screens on the fly (they are read only once on startup and
1117 For people who cannot modify their +~/.xsession+ to add the
1118 +--force-xinerama+ commandline parameter, a configuration option is provided:
1121 ---------------------
1122 force_xinerama yes|no
1123 ---------------------
1130 Also note that your output names are not descriptive (like +HDMI1+) when using
1131 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
1133 [[workspace_auto_back_and_forth]]
1134 === Automatic back-and-forth when switching to the current workspace
1136 This configuration directive enables automatic +workspace back_and_forth+ (see
1137 <<back_and_forth>>) when switching to the workspace that is currently focused.
1139 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
1140 mod+2 because somebody sent you a message. You don’t need to remember where you
1141 came from now, you can just press $mod+2 again to switch back to "1: www".
1144 ------------------------------------
1145 workspace_auto_back_and_forth yes|no
1146 ------------------------------------
1149 ---------------------------------
1150 workspace_auto_back_and_forth yes
1151 ---------------------------------
1153 === Delaying urgency hint reset on workspace change
1155 If an application on another workspace sets an urgency hint, switching to this
1156 workspace may lead to immediate focus of the application, which also means the
1157 window decoration color would be immediately reset to +client.focused+. This
1158 may make it unnecessarily hard to tell which window originally raised the
1161 In order to prevent this, you can tell i3 to delay resetting the urgency state
1162 by a certain time using the +force_display_urgency_hint+ directive. Setting the
1163 value to 0 disables this feature.
1165 The default is 500ms.
1168 ---------------------------------------
1169 force_display_urgency_hint <timeout> ms
1170 ---------------------------------------
1173 ---------------------------------
1174 force_display_urgency_hint 500 ms
1175 ---------------------------------
1177 [[focus_on_window_activation]]
1178 === Focus on window activation
1180 If a window is activated, e.g., via +google-chrome www.google.com+, it may request
1181 to take focus. Since this may not preferable, different reactions can be configured.
1183 Note that this may not affect windows that are being opened. To prevent new windows
1184 from being focused, see <<no_focus>>.
1187 --------------------------------------------------
1188 focus_on_window_activation smart|urgent|focus|none
1189 --------------------------------------------------
1191 The different modes will act as follows:
1194 This is the default behavior. If the window requesting focus is on an active
1195 workspace, it will receive the focus. Otherwise, the urgency hint will be set.
1197 The window will always be marked urgent, but the focus will not be stolen.
1199 The window will always be focused and not be marked urgent.
1201 The window will neither be focused, nor be marked urgent.
1204 === Drawing marks on window decoration
1206 If activated, marks (see <<vim_like_marks>>) on windows are drawn in their window
1207 decoration. However, any mark starting with an underscore in its name (+_+) will
1208 not be drawn even if this option is activated.
1210 The default for this option is +yes+.
1222 [[line_continuation]]
1223 === Line continuation
1225 Config files support line continuation, meaning when you end a line in a
1226 backslash character (`\`), the line-break will be ignored by the parser. This
1227 feature can be used to create more readable configuration files.
1228 Commented lines are not continued.
1235 # this line is not continued \
1236 bindsym Mod1+F fullscreen toggle
1239 == Configuring i3bar
1241 The bar at the bottom of your monitor is drawn by a separate process called
1242 i3bar. Having this part of "the i3 user interface" in a separate process has
1245 1. It is a modular approach. If you don’t need a workspace bar at all, or if
1246 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
1247 just remove the i3bar configuration and start your favorite bar instead.
1248 2. It follows the UNIX philosophy of "Make each program do one thing well".
1249 While i3 manages your windows well, i3bar is good at displaying a bar on
1250 each monitor (unless you configure it otherwise).
1251 3. It leads to two separate, clean codebases. If you want to understand i3, you
1252 don’t need to bother with the details of i3bar and vice versa.
1254 That said, i3bar is configured in the same configuration file as i3. This is
1255 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
1256 are useful for people using other window managers). Therefore, it makes no
1257 sense to use a different configuration place when we already have a good
1258 configuration infrastructure in place.
1260 Configuring your workspace bar starts with opening a +bar+ block. You can have
1261 multiple bar blocks to use different settings for different outputs (monitors):
1264 ---------------------------
1266 status_command i3status
1268 ---------------------------
1272 By default i3 will just pass +i3bar+ and let your shell handle the execution,
1273 searching your +$PATH+ for a correct version.
1274 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
1275 tell i3 what to execute.
1277 The specified command will be passed to +sh -c+, so you can use globbing and
1278 have to have correct quoting etc.
1281 -----------------------
1282 i3bar_command <command>
1283 -----------------------
1286 -------------------------------------------------
1288 i3bar_command /home/user/bin/i3bar
1290 -------------------------------------------------
1293 === Statusline command
1295 i3bar can run a program and display every line of its +stdout+ output on the
1296 right hand side of the bar. This is useful to display system information like
1297 your current IP address, battery status or date/time.
1299 The specified command will be passed to +sh -c+, so you can use globbing and
1300 have to have correct quoting etc. Note that for signal handling, depending on
1301 your shell (users of dash(1) are known to be affected), you have to use the
1302 shell’s exec command so that signals are passed to your program, not to the
1306 ------------------------
1307 status_command <command>
1308 ------------------------
1311 -------------------------------------------------
1313 status_command i3status --config ~/.i3status.conf
1315 # For dash(1) users who want signal handling to work:
1316 status_command exec ~/.bin/my_status_command
1318 -------------------------------------------------
1322 You can either have i3bar be visible permanently at one edge of the screen
1323 (+dock+ mode) or make it show up when you press your modifier key (+hide+ mode).
1324 It is also possible to force i3bar to always stay hidden (+invisible+
1325 mode). The modifier key can be configured using the +modifier+ option.
1327 The mode option can be changed during runtime through the +bar mode+ command.
1328 On reload the mode will be reverted to its configured value.
1330 The hide mode maximizes screen space that can be used for actual windows. Also,
1331 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1334 Invisible mode allows to permanently maximize screen space, as the bar is never
1335 shown. Thus, you can configure i3bar to not disturb you by popping up because
1336 of an urgency hint or because the modifier key is pressed.
1338 In order to control whether i3bar is hidden or shown in hide mode, there exists
1339 the hidden_state option, which has no effect in dock mode or invisible mode. It
1340 indicates the current hidden_state of the bar: (1) The bar acts like in normal
1341 hide mode, it is hidden and is only unhidden in case of urgency hints or by
1342 pressing the modifier key (+hide+ state), or (2) it is drawn on top of the
1343 currently visible workspace (+show+ state).
1345 Like the mode, the hidden_state can also be controlled through i3, this can be
1346 done by using the +bar hidden_state+ command.
1348 The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
1349 the windows key). The default value for the hidden_state is hide.
1352 -------------------------
1353 mode dock|hide|invisible
1354 hidden_state hide|show
1355 modifier <Modifier>|none
1356 ------------------------
1367 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+). You can
1368 also use "none" if you don't want any modifier to trigger this behavior.
1370 === Mouse button commands
1372 Specifies a command to run when a button was pressed on i3bar to override the
1373 default behavior. This is useful, e.g., for disabling the scroll wheel action
1374 or running scripts that implement custom behavior for these buttons.
1376 A button is always named +button<n>+, where 1 to 5 are default buttons as follows and higher
1377 numbers can be special buttons on devices offering more buttons:
1382 Middle mouse button.
1390 Please note that the old +wheel_up_cmd+ and +wheel_down_cmd+ commands are deprecated
1391 and will be removed in a future release. We strongly recommend using the more general
1392 +bindsym+ with +button4+ and +button5+ instead.
1395 ----------------------------
1396 bindsym [--release] button<n> <command>
1397 ----------------------------
1400 ---------------------------------------------------------
1402 # disable clicking on workspace buttons
1404 # Take a screenshot by right clicking on the bar
1405 bindsym --release button3 exec --no-startup-id import /tmp/latest-screenshot.png
1406 # execute custom script when scrolling downwards
1407 bindsym button5 exec ~/.i3/scripts/custom_wheel_down
1409 ---------------------------------------------------------
1413 Specifies the bar ID for the configured bar instance. If this option is missing,
1414 the ID is set to 'bar-x', where x corresponds to the position of the embedding
1415 bar block in the config file ('bar-0', 'bar-1', ...).
1418 ---------------------
1420 ---------------------
1423 ---------------------
1427 ---------------------
1432 This option determines in which edge of the screen i3bar should show up.
1434 The default is bottom.
1442 ---------------------
1446 ---------------------
1450 You can restrict i3bar to one or more outputs (monitors). The default is to
1451 handle all outputs. Restricting the outputs is useful for using different
1452 options for different outputs by using multiple 'bar' blocks.
1454 To make a particular i3bar instance handle multiple outputs, specify the output
1455 directive multiple times.
1459 output primary|<output>
1463 -------------------------------
1464 # big monitor: everything
1466 # The display is connected either via HDMI or via DisplayPort
1469 status_command i3status
1472 # laptop monitor: bright colors and i3status with less modules.
1475 status_command i3status --config ~/.i3status-small.conf
1482 # show bar on the primary monitor and on HDMI2
1486 status_command i3status
1489 -------------------------------
1490 Note that you might not have a primary output configured yet. To do so, run:
1491 -------------------------
1492 xrandr --output <output> --primary
1493 -------------------------
1497 i3bar by default provides a system tray area where programs such as
1498 NetworkManager, VLC, Pidgin, etc. can place little icons.
1500 You can configure on which output (monitor) the icons should be displayed or
1501 you can turn off the functionality entirely.
1503 You can use multiple +tray_output+ directives in your config to specify a list
1504 of outputs on which you want the tray to appear. The first available output in
1505 that list as defined by the order of the directives will be used for the tray
1509 ---------------------------------
1510 tray_output none|primary|<output>
1511 ---------------------------------
1514 -------------------------
1515 # disable system tray
1520 # show tray icons on the primary monitor
1525 # show tray icons on the big monitor
1529 -------------------------
1531 Note that you might not have a primary output configured yet. To do so, run:
1532 -------------------------
1533 xrandr --output <output> --primary
1534 -------------------------
1536 Note that when you use multiple bar configuration blocks, either specify
1537 `tray_output primary` in all of them or explicitly specify `tray_output none`
1538 in bars which should not display the tray, otherwise the different instances
1539 might race each other in trying to display tray icons.
1543 The tray is shown on the right-hand side of the bar. By default, a padding of 2
1544 pixels is used for the upper, lower and right-hand side of the tray area and
1545 between the individual icons.
1548 -------------------------
1549 tray_padding <px> [px]
1550 -------------------------
1553 -------------------------
1556 -------------------------
1560 Specifies the font to be used in the bar. See <<fonts>>.
1563 ---------------------
1565 ---------------------
1568 --------------------------------------------------------------
1570 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1571 font pango:DejaVu Sans Mono 10
1573 --------------------------------------------------------------
1575 === Custom separator symbol
1577 Specifies a custom symbol to be used for the separator as opposed to the vertical,
1578 one pixel thick separator.
1581 -------------------------
1582 separator_symbol <symbol>
1583 -------------------------
1586 ------------------------
1588 separator_symbol ":|:"
1590 ------------------------
1592 === Workspace buttons
1594 Specifies whether workspace buttons should be shown or not. This is useful if
1595 you want to display a statusline-only bar containing additional information.
1597 The default is to show workspace buttons.
1600 ------------------------
1601 workspace_buttons yes|no
1602 ------------------------
1605 ------------------------
1607 workspace_buttons no
1609 ------------------------
1611 === Strip workspace numbers/name
1613 Specifies whether workspace numbers should be displayed within the workspace
1614 buttons. This is useful if you want to have a named workspace that stays in
1615 order on the bar according to its number without displaying the number prefix.
1617 When +strip_workspace_numbers+ is set to +yes+, any workspace that has a name of
1618 the form "[n]:[NAME]" will display only the name. You could use this, for
1619 instance, to display Roman numerals rather than digits by naming your
1620 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
1622 When +strip_workspace_name+ is set to +yes+, any workspace that has a name of
1623 the form "[n]:[NAME]" will display only the number.
1625 The default is to display the full name within the workspace button.
1628 ------------------------------
1629 strip_workspace_numbers yes|no
1630 strip_workspace_name yes|no
1631 ------------------------------
1634 ----------------------------
1636 strip_workspace_numbers yes
1638 ----------------------------
1640 === Binding Mode indicator
1642 Specifies whether the current binding mode indicator should be shown or not.
1643 This is useful if you want to hide the workspace buttons but still be able
1644 to see the current binding mode indicator. See <<binding_modes>> to learn what
1645 modes are and how to use them.
1647 The default is to show the mode indicator.
1650 -----------------------------
1651 binding_mode_indicator yes|no
1652 -----------------------------
1655 -----------------------------
1657 binding_mode_indicator no
1659 -----------------------------
1663 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1664 be configured at the moment:
1667 Background color of the bar.
1669 Text color to be used for the statusline.
1671 Text color to be used for the separator.
1672 focused_background::
1673 Background color of the bar on the currently focused monitor output. If
1674 not used, the color will be taken from +background+.
1675 focused_statusline::
1676 Text color to be used for the statusline on the currently focused
1677 monitor output. If not used, the color will be taken from +statusline+.
1679 Text color to be used for the separator on the currently focused
1680 monitor output. If not used, the color will be taken from +separator+.
1682 Border, background and text color for a workspace button when the workspace
1685 Border, background and text color for a workspace button when the workspace
1686 is active (visible) on some output, but the focus is on another one.
1687 You can only tell this apart from the focused workspace when you are
1688 using multiple monitors.
1689 inactive_workspace::
1690 Border, background and text color for a workspace button when the workspace
1691 does not have focus and is not active (visible) on any output. This
1692 will be the case for most workspaces.
1694 Border, background and text color for a workspace button when the workspace
1695 contains a window with the urgency hint set.
1697 Border, background and text color for the binding mode indicator. If not used,
1698 the colors will be taken from +urgent_workspace+.
1701 ----------------------------------------
1707 <colorclass> <border> <background> <text>
1709 ----------------------------------------
1711 *Example (default colors)*:
1712 --------------------------------------
1719 focused_workspace #4c7899 #285577 #ffffff
1720 active_workspace #333333 #5f676a #ffffff
1721 inactive_workspace #333333 #222222 #888888
1722 urgent_workspace #2f343a #900000 #ffffff
1723 binding_mode #2f343a #900000 #ffffff
1726 --------------------------------------
1728 [[list_of_commands]]
1731 Commands are what you bind to specific keypresses. You can also issue commands
1732 at runtime without pressing a key by using the IPC interface. An easy way to
1733 do this is to use the +i3-msg+ utility:
1736 --------------------------
1737 # execute this on your shell to make the current container borderless
1739 --------------------------
1741 [[command_chaining]]
1743 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1744 specific workspace and immediately switch to that workspace, you can configure
1745 the following keybinding:
1748 --------------------------------------------------------
1749 bindsym $mod+x move container to workspace 3; workspace 3
1750 --------------------------------------------------------
1752 [[command_criteria]]
1754 Furthermore, you can change the scope of a command - that is, which containers
1755 should be affected by that command, by using various criteria. The criteria
1756 are specified before any command in a pair of square brackets and are separated
1759 When using multiple commands, separate them by using a +,+ (a comma) instead of
1760 a semicolon. Criteria apply only until the next semicolon, so if you use a
1761 semicolon to separate commands, only the first one will be executed for the
1765 ------------------------------------
1766 # if you want to kill all windows which have the class Firefox, use:
1767 bindsym $mod+x [class="Firefox"] kill
1769 # same thing, but case-insensitive
1770 bindsym $mod+x [class="(?i)firefox"] kill
1772 # kill only the About dialog from Firefox
1773 bindsym $mod+x [class="Firefox" window_role="About"] kill
1775 # enable floating mode and move container to workspace 4
1776 for_window [class="^evil-app$"] floating enable, move container to workspace 4
1778 # move all floating windows to the scratchpad
1779 bindsym $mod+x [floating] move scratchpad
1780 ------------------------------------
1782 The criteria which are currently implemented are:
1785 Compares the window class (the second part of WM_CLASS). Use the
1786 special value +\_\_focused__+ to match all windows having the same window
1787 class as the currently focused window.
1789 Compares the window instance (the first part of WM_CLASS). Use the
1790 special value +\_\_focused__+ to match all windows having the same window
1791 instance as the currently focused window.
1793 Compares the window role (WM_WINDOW_ROLE). Use the special value
1794 +\_\_focused__+ to match all windows having the same window role as the
1795 currently focused window.
1797 Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
1798 +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+,
1799 +popup_menu+, +tooltip+ and +notification+.
1801 Compares the X11 window ID, which you can get via +xwininfo+ for example.
1803 Compares the X11 window title (\_NET_WM_NAME or WM_NAME as fallback).
1804 Use the special value +\_\_focused__+ to match all windows having the
1805 same window title as the currently focused window.
1807 Compares the urgent state of the window. Can be "latest" or "oldest".
1808 Matches the latest or oldest urgent window, respectively.
1809 (The following aliases are also available: newest, last, recent, first)
1811 Compares the workspace name of the workspace the window belongs to. Use
1812 the special value +\_\_focused__+ to match all windows in the currently
1815 Compares the marks set for this container, see <<vim_like_marks>>. A
1816 match is made if any of the container's marks matches the specified
1819 Compares the i3-internal container ID, which you can get via the IPC
1820 interface. Handy for scripting. Use the special value +\_\_focused__+
1821 to match only the currently focused window.
1823 Only matches floating windows. This criterion requires no value.
1825 Only matches tiling windows. This criterion requires no value.
1827 The criteria +class+, +instance+, +role+, +title+, +workspace+ and +mark+ are
1828 actually regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1829 information on how to use them.
1832 === Executing applications (exec)
1834 What good is a window manager if you can’t actually start any applications?
1835 The exec command starts an application by passing the command you specify to a
1836 shell. This implies that you can use globbing (wildcards) and programs will be
1837 searched in your +$PATH+.
1839 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
1840 and +,+ (comma): they chain commands together in i3, so you need to use quoted
1841 strings (as shown in <<exec_quoting>>) if they appear in your command.
1844 --------------------------------
1845 exec [--no-startup-id] <command>
1846 --------------------------------
1849 ------------------------------
1851 bindsym $mod+g exec gimp
1853 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1854 bindsym $mod+Return exec --no-startup-id urxvt
1855 ------------------------------
1857 The +--no-startup-id+ parameter disables startup-notification support for this
1858 particular exec command. With startup-notification, i3 can make sure that a
1859 window appears on the workspace on which you used the exec command. Also, it
1860 will change the X11 cursor to +watch+ (a clock) while the application is
1861 launching. So, if an application is not startup-notification aware (most GTK
1862 and Qt using applications seem to be, though), you will end up with a watch
1863 cursor for 60 seconds.
1866 If the command to be executed contains a +;+ (semicolon) and/or a +,+ (comma),
1867 the entire command must be quoted. For example, to have a keybinding for the
1868 shell command +notify-send Hello, i3+, you would add an entry to your
1869 configuration file like this:
1872 ------------------------------
1873 # Execute a command with a comma in it
1874 bindsym $mod+p exec "notify-send Hello, i3"
1875 ------------------------------
1877 If however a command with a comma and/or semicolon itself requires quotes, you
1878 must escape the internal quotation marks with double backslashes, like this:
1881 ------------------------------
1882 # Execute a command with a comma, semicolon and internal quotes
1883 bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\""
1884 ------------------------------
1886 === Splitting containers
1888 The split command makes the current window a split container. Split containers
1889 can contain multiple windows. Depending on the layout of the split container,
1890 new windows get placed to the right of the current one (splith) or new windows
1891 get placed below the current one (splitv).
1893 If you apply this command to a split container with the same orientation,
1894 nothing will happen. If you use a different orientation, the split container’s
1895 orientation will be changed (if it does not have more than one window).
1896 The +toggle+ option will toggle the orientation of the split container if it
1897 contains a single window. Otherwise it makes the current window a split
1898 container with opposite orientation compared to the parent container.
1899 Use +layout toggle split+ to change the layout of any split container from
1900 splitv to splith or vice-versa. You can also define a custom sequence of layouts
1901 to cycle through with +layout toggle+, see <<manipulating_layout>>.
1904 --------------------------------
1905 split vertical|horizontal|toggle
1906 --------------------------------
1909 -------------------------------
1910 bindsym $mod+v split vertical
1911 bindsym $mod+h split horizontal
1912 bindsym $mod+t split toggle
1913 -------------------------------
1915 === Manipulating layout
1917 Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
1918 or +layout splith+ to change the current container layout to splith/splitv,
1919 stacking, tabbed layout, splitv or splith, respectively.
1921 Specify up to four layouts after +layout toggle+ to cycle through them. Every
1922 time the command is executed, the layout specified after the currently active
1923 one will be applied. If the currently active layout is not in the list, the
1924 first layout in the list will be activated.
1926 To make the current window (!) fullscreen, use +fullscreen enable+ (or
1927 +fullscreen enable global+ for the global mode), to leave either fullscreen
1928 mode use +fullscreen disable+, and to toggle between these two states use
1929 +fullscreen toggle+ (or +fullscreen toggle global+).
1931 Likewise, to make the current window floating (or tiling again) use +floating
1932 enable+ respectively +floating disable+ (or +floating toggle+):
1935 --------------------------------------------
1936 layout default|tabbed|stacking|splitv|splith
1937 layout toggle [split|all]
1938 layout toggle [split|tabbed|stacking|splitv|splith] [split|tabbed|stacking|splitv|splith]…
1939 --------------------------------------------
1943 bindsym $mod+s layout stacking
1944 bindsym $mod+l layout toggle split
1945 bindsym $mod+w layout tabbed
1947 # Toggle between stacking/tabbed/split:
1948 bindsym $mod+x layout toggle
1950 # Toggle between stacking/tabbed/splith/splitv:
1951 bindsym $mod+x layout toggle all
1953 # Toggle between stacking/tabbed/splith:
1954 bindsym $mod+x layout toggle stacking tabbed splith
1956 # Toggle between splitv/tabbed
1957 bindsym $mod+x layout toggle splitv tabbed
1959 # Toggle between last split layout/tabbed/stacking
1960 bindsym $mod+x layout toggle split tabbed stacking
1963 bindsym $mod+f fullscreen toggle
1965 # Toggle floating/tiling
1966 bindsym $mod+t floating toggle
1969 [[_focusing_moving_containers]]
1970 === Focusing containers
1972 To change focus, you can use the +focus+ command. The following options are
1976 Sets focus to the container that matches the specified criteria.
1977 See <<command_criteria>>.
1978 left|right|up|down::
1979 Sets focus to the nearest container in the given direction.
1981 Sets focus to the parent container of the current container.
1983 The opposite of +focus parent+, sets the focus to the last focused
1986 Sets focus to the last focused floating container.
1988 Sets focus to the last focused tiling container.
1990 Toggles between floating/tiling containers.
1992 Followed by a direction or an output name, this will focus the
1993 corresponding output.
1996 ----------------------------------------------
1998 focus left|right|down|up
1999 focus parent|child|floating|tiling|mode_toggle
2000 focus output left|right|up|down|primary|<output>
2001 ----------------------------------------------
2004 -------------------------------------------------
2006 bindsym $mod+F1 [class="Firefox"] focus
2008 # Focus container on the left, bottom, top, right
2009 bindsym $mod+j focus left
2010 bindsym $mod+k focus down
2011 bindsym $mod+l focus up
2012 bindsym $mod+semicolon focus right
2014 # Focus parent container
2015 bindsym $mod+u focus parent
2017 # Focus last floating/tiling container
2018 bindsym $mod+g focus mode_toggle
2020 # Focus the output right to the current one
2021 bindsym $mod+x focus output right
2023 # Focus the big output
2024 bindsym $mod+x focus output HDMI-2
2026 # Focus the primary output
2027 bindsym $mod+x focus output primary
2028 -------------------------------------------------
2030 Note that you might not have a primary output configured yet. To do so, run:
2031 -------------------------
2032 xrandr --output <output> --primary
2033 -------------------------
2035 === Moving containers
2037 Use the +move+ command to move a container.
2040 -----------------------------------------------------
2041 # Moves the container into the given direction.
2042 # The optional pixel argument specifies how far the
2043 # container should be moved if it is floating and
2044 # defaults to 10 pixels.
2045 move <left|right|down|up> [<px> px]
2047 # Moves the container to the specified pos_x and pos_y
2048 # coordinates on the screen.
2049 move position <pos_x> [px] <pos_y> [px]
2051 # Moves the container to the center of the screen.
2052 # If 'absolute' is used, it is moved to the center of
2054 move [absolute] position center
2056 # Moves the container to the current position of the
2057 # mouse cursor. Only affects floating containers.
2059 -----------------------------------------------------
2062 -------------------------------------------------------
2063 # Move container to the left, bottom, top, right
2064 bindsym $mod+j move left
2065 bindsym $mod+k move down
2066 bindsym $mod+l move up
2067 bindsym $mod+semicolon move right
2069 # Move container, but make floating containers
2070 # move more than the default
2071 bindsym $mod+j move left 20 px
2073 # Move floating container to the center of all outputs
2074 bindsym $mod+c move absolute position center
2076 # Move container to the current position of the cursor
2077 bindsym $mod+m move position mouse
2078 -------------------------------------------------------
2080 === Swapping containers
2082 Two containers can be swapped (i.e., move to each other's position) by using
2083 the +swap+ command. They will assume the position and geometry of the container
2084 they are swapped with.
2086 The first container to participate in the swapping can be selected through the
2087 normal command criteria process with the focused window being the usual
2088 fallback if no criteria are specified. The second container can be selected
2089 using one of the following methods:
2091 +id+:: The X11 window ID of a client window.
2092 +con_id+:: The i3 container ID of a container.
2093 +mark+:: A container with the specified mark, see <<vim_like_marks>>.
2095 Note that swapping does not work with all containers. Most notably, swapping
2096 floating containers or containers that have a parent-child relationship to one
2097 another does not work.
2100 ----------------------------------------
2101 swap container with id|con_id|mark <arg>
2102 ----------------------------------------
2105 -----------------------------------------------------------------
2106 # Swaps the focused container with the container marked »swapee«.
2107 swap container with mark swapee
2109 # Swaps container marked »A« and »B«
2110 [con_mark="^A$"] swap container with mark B
2111 -----------------------------------------------------------------
2113 === Sticky floating windows
2115 If you want a window to stick to the glass, i.e., have it stay on screen even
2116 if you switch to another workspace, you can use the +sticky+ command. For
2117 example, this can be useful for notepads, a media player or a video chat
2120 Note that while any window can be made sticky through this command, it will
2121 only take effect if the window is floating.
2124 ----------------------------
2125 sticky enable|disable|toggle
2126 ----------------------------
2129 ------------------------------------------------------
2130 # make a terminal sticky that was started as a notepad
2131 for_window [instance=notepad] sticky enable
2132 ------------------------------------------------------
2134 === Changing (named) workspaces/moving to workspaces
2136 To change to a specific workspace, use the +workspace+ command, followed by the
2137 number or name of the workspace. Pass the optional flag
2138 +--no-auto-back-and-forth+ to disable <<workspace_auto_back_and_forth>> for this
2141 To move containers to specific workspaces, use +move container to workspace+.
2143 You can also switch to the next and previous workspace with the commands
2144 +workspace next+ and +workspace prev+, which is handy, for example, if you have
2145 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
2146 combination. To restrict those to the current output, use +workspace
2147 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
2148 container to workspace next+, +move container to workspace prev+ to move a
2149 container to the next/previous workspace and +move container to workspace current+
2150 (the last one makes sense only when used with criteria).
2152 +workspace next+ cycles through either numbered or named workspaces. But when it
2153 reaches the last numbered/named workspace, it looks for named workspaces after
2154 exhausting numbered ones and looks for numbered ones after exhausting named ones.
2156 See <<move_to_outputs>> for how to move a container/workspace to a different
2159 Workspace names are parsed as
2160 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
2164 To switch back to the previously focused workspace, use +workspace
2165 back_and_forth+; likewise, you can move containers to the previously focused
2166 workspace using +move container to workspace back_and_forth+.
2169 --------------------------------------------------------------------------------
2170 workspace next|prev|next_on_output|prev_on_output
2171 workspace back_and_forth
2172 workspace [--no-auto-back-and-forth] <name>
2173 workspace [--no-auto-back-and-forth] number <name>
2175 move [--no-auto-back-and-forth] [window|container] [to] workspace <name>
2176 move [--no-auto-back-and-forth] [window|container] [to] workspace number <name>
2177 move [window|container] [to] workspace prev|next|current
2178 --------------------------------------------------------------------------------
2181 -------------------------
2182 bindsym $mod+1 workspace 1
2183 bindsym $mod+2 workspace 2
2184 bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
2187 bindsym $mod+Shift+1 move container to workspace 1
2188 bindsym $mod+Shift+2 move container to workspace 2
2191 # switch between the current and the previously focused one
2192 bindsym $mod+b workspace back_and_forth
2193 bindsym $mod+Shift+b move container to workspace back_and_forth
2195 # move the whole workspace to the next output
2196 bindsym $mod+x move workspace to output right
2198 # move firefox to current workspace
2199 bindsym $mod+F1 [class="Firefox"] move workspace current
2200 -------------------------
2202 ==== Named workspaces
2204 Workspaces are identified by their name. So, instead of using numbers in the
2205 workspace command, you can use an arbitrary name:
2208 -------------------------
2209 bindsym $mod+1 workspace mail
2211 -------------------------
2213 If you want the workspace to have a number *and* a name, just prefix the
2217 -------------------------
2218 bindsym $mod+1 workspace 1: mail
2219 bindsym $mod+2 workspace 2: www
2221 -------------------------
2223 Note that the workspace will really be named "1: mail". i3 treats workspace
2224 names beginning with a number in a slightly special way. Normally, named
2225 workspaces are ordered the way they appeared. When they start with a number, i3
2226 will order them numerically. Also, you will be able to use +workspace number 1+
2227 to switch to the workspace which begins with number 1, regardless of which name
2228 it has. This is useful in case you are changing the workspace’s name
2229 dynamically. To combine both commands you can use +workspace number 1: mail+ to
2230 specify a default name if there's currently no workspace starting with a "1".
2232 ==== Renaming workspaces
2234 You can rename workspaces. This might be useful to start with the default
2235 numbered workspaces, do your work, and rename the workspaces afterwards to
2236 reflect what’s actually on them. You can also omit the old name to rename
2237 the currently focused workspace. This is handy if you want to use the
2238 rename command with +i3-input+.
2241 ----------------------------------------------------
2242 rename workspace <old_name> to <new_name>
2243 rename workspace to <new_name>
2244 ----------------------------------------------------
2247 --------------------------------------------------------------------------
2248 i3-msg 'rename workspace 5 to 6'
2249 i3-msg 'rename workspace 1 to "1: www"'
2250 i3-msg 'rename workspace "1: www" to "10: www"'
2251 i3-msg 'rename workspace to "2: mail"'
2252 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
2253 --------------------------------------------------------------------------
2255 If you want to rename workspaces on demand while keeping the navigation stable,
2256 you can use a setup like this:
2259 -------------------------
2260 bindsym $mod+1 workspace number "1: www"
2261 bindsym $mod+2 workspace number "2: mail"
2263 -------------------------
2265 If a workspace does not exist, the command +workspace number "1: mail"+ will
2266 create workspace "1: mail".
2268 If a workspace with number 1 does already exist, the command will switch to this
2269 workspace and ignore the text part. So even when the workspace has been renamed
2270 to "1: web", the above command will still switch to it.
2272 === Moving workspaces to a different screen
2274 See <<move_to_outputs>> for how to move a container/workspace to a different
2278 === [[_moving_containers_workspaces_to_randr_outputs]]Moving containers/workspaces to RandR outputs
2280 To move a container to another RandR output (addressed by names like +LVDS1+ or
2281 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
2282 +right+, +up+ or +down+), there are two commands:
2285 ------------------------------------------------------------
2286 move container to output left|right|down|up|current|primary|<output>
2287 move workspace to output left|right|down|up|current|primary|<output>
2288 ------------------------------------------------------------
2291 --------------------------------------------------------
2292 # Move the current workspace to the next output
2293 # (effectively toggles when you only have two outputs)
2294 bindsym $mod+x move workspace to output right
2296 # Put this window on the presentation output.
2297 bindsym $mod+x move container to output VGA1
2299 # Put this window on the primary output.
2300 bindsym $mod+x move container to output primary
2301 --------------------------------------------------------
2303 Note that you might not have a primary output configured yet. To do so, run:
2304 -------------------------
2305 xrandr --output <output> --primary
2306 -------------------------
2308 === Moving containers/windows to marks
2310 To move a container to another container with a specific mark (see <<vim_like_marks>>),
2311 you can use the following command.
2313 The window will be moved right after the marked container in the tree, i.e., it ends up
2314 in the same position as if you had opened a new window when the marked container was
2315 focused. If the mark is on a split container, the window will appear as a new child
2316 after the currently focused child within that container.
2319 ------------------------------------
2320 move window|container to mark <mark>
2321 ------------------------------------
2324 --------------------------------------------------------
2325 for_window [instance="tabme"] move window to mark target
2326 --------------------------------------------------------
2329 === Resizing containers/windows
2331 If you want to resize containers/windows using your keyboard, you can use the
2335 -------------------------------------------------------
2336 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
2337 resize set [width] <width> [px | ppt]
2338 resize set height <height> [px | ppt]
2339 resize set [width] <width> [px | ppt] [height] <height> [px | ppt]
2340 -------------------------------------------------------
2342 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
2343 less specific and use +width+ or +height+, in which case i3 will take/give space
2344 from all the other containers. The optional pixel argument specifies by how many
2345 pixels a container should be grown or shrunk (the default is 10 pixels). The
2346 optional ppt argument means "percentage points", and if specified it indicates
2347 that a *tiling container* should be grown or shrunk by that many points, instead
2348 of by the +px+ value.
2350 Note about +resize set+: a value of 0 for <width> or <height> means "do not
2351 resize in this direction".
2353 It is recommended to define bindings for resizing in a dedicated binding mode.
2354 See <<binding_modes>> and the example in the i3
2355 https://github.com/i3/i3/blob/next/etc/config.keycodes[default config] for more
2359 ------------------------------------------------
2360 for_window [class="urxvt"] resize set 640 480
2361 ------------------------------------------------
2363 === Jumping to specific windows
2365 Often when in a multi-monitor environment, you want to quickly jump to a
2366 specific window. For example, while working on workspace 3 you may want to
2367 jump to your mail client to email your boss that you’ve achieved some
2368 important goal. Instead of figuring out how to navigate to your mail client,
2369 it would be more convenient to have a shortcut. You can use the +focus+ command
2370 with criteria for that.
2373 ----------------------------------------------------
2374 [class="class"] focus
2375 [title="title"] focus
2376 ----------------------------------------------------
2379 ------------------------------------------------
2380 # Get me to the next open VIM instance
2381 bindsym $mod+a [class="urxvt" title="VIM"] focus
2382 ------------------------------------------------
2385 === VIM-like marks (mark/goto)
2387 This feature is like the jump feature: It allows you to directly jump to a
2388 specific window (this means switching to the appropriate workspace and setting
2389 focus to the windows). However, you can directly mark a specific window with
2390 an arbitrary label and use it afterwards. You can unmark the label in the same
2391 way, using the unmark command. If you don't specify a label, unmark removes all
2392 marks. You do not need to ensure that your windows have unique classes or
2393 titles, and you do not need to change your configuration file.
2395 As the command needs to include the label with which you want to mark the
2396 window, you cannot simply bind it to a key. +i3-input+ is a tool created
2397 for this purpose: It lets you input a command and sends the command to i3. It
2398 can also prefix this command and display a custom prompt for the input dialog.
2400 The additional +--toggle+ option will remove the mark if the window already has
2401 this mark or add it otherwise. Note that you may need to use this in
2402 combination with +--add+ (see below) as any other marks will otherwise be
2405 By default, a window can only have one mark. You can use the +--add+ flag to
2406 put more than one mark on a window.
2408 Refer to <<show_marks>> if you don't want marks to be shown in the window decoration.
2411 ----------------------------------------------
2412 mark [--add|--replace] [--toggle] <identifier>
2413 [con_mark="identifier"] focus
2415 ----------------------------------------------
2417 *Example (in a terminal)*:
2418 ---------------------------------------------------------
2419 # marks the focused container
2422 # focus the container with the mark "irssi"
2423 '[con_mark="irssi"] focus'
2425 # remove the mark "irssi" from whichever container has it
2428 # remove all marks on all firefox windows
2429 [class="(?i)firefox"] unmark
2430 ---------------------------------------------------------
2432 ///////////////////////////////////////////////////////////////////
2433 TODO: make i3-input replace %s
2435 ---------------------------------------
2436 # Read 1 character and mark the current window with this character
2437 bindsym $mod+m exec i3-input -F 'mark %s' -l 1 -P 'Mark: '
2439 # Read 1 character and go to the window with the character
2440 bindsym $mod+g exec i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Goto: '
2441 ---------------------------------------
2443 Alternatively, if you do not want to mess with +i3-input+, you could create
2444 separate bindings for a specific set of labels and then only use those labels.
2445 ///////////////////////////////////////////////////////////////////
2448 === Window title format
2450 By default, i3 will simply print the X11 window title. Using +title_format+,
2451 this can be customized by setting the format to the desired output. This
2453 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
2454 and the following placeholders which will be replaced:
2457 For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME
2458 as fallback). When used on containers without a window (e.g., a split
2459 container inside a tabbed/stacked layout), this will be the tree
2460 representation of the container (e.g., "H[xterm xterm]").
2462 The X11 window class (second part of WM_CLASS). This corresponds to the
2463 +class+ criterion, see <<command_criteria>>.
2465 The X11 window instance (first part of WM_CLASS). This corresponds to the
2466 +instance+ criterion, see <<command_criteria>>.
2468 Using the <<for_window>> directive, you can set the title format for any window
2469 based on <<command_criteria>>.
2472 ---------------------
2473 title_format <format>
2474 ---------------------
2477 -------------------------------------------------------------------------------------
2478 # give the focused window a prefix
2479 bindsym $mod+p title_format "Important | %title"
2481 # print all window titles bold
2482 for_window [class=".*"] title_format "<b>%title</b>"
2484 # print window titles of firefox windows red
2485 for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"
2486 -------------------------------------------------------------------------------------
2488 === Changing border style
2490 To change the border of the current client, you can use +border normal+ to use the normal
2491 border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
2492 and +border none+ to make the client borderless.
2494 There is also +border toggle+ which will toggle the different border styles. The
2495 optional pixel argument can be used to specify the border width when switching
2496 to the normal and pixel styles.
2498 Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel
2499 may be represented by multiple physical pixels, so +pixel 1+ might not
2500 necessarily translate into a single pixel row wide border.
2503 -----------------------------------------------
2504 border normal|pixel|toggle [<n>]
2507 # legacy syntax, equivalent to "border pixel 1"
2509 -----------------------------------------------
2512 ----------------------------------------------
2513 # use window title, but no border
2514 bindsym $mod+t border normal 0
2515 # use no window title and a thick border
2516 bindsym $mod+y border pixel 3
2517 # use neither window title nor border
2518 bindsym $mod+u border none
2519 ----------------------------------------------
2522 === Enabling shared memory logging
2524 As described in https://i3wm.org/docs/debugging.html, i3 can log to a shared
2525 memory buffer, which you can dump using +i3-dump-log+. The +shmlog+ command
2526 allows you to enable or disable the shared memory logging at runtime.
2528 Note that when using +shmlog <size_in_bytes>+, the current log will be
2529 discarded and a new one will be started.
2532 ------------------------------
2533 shmlog <size_in_bytes>
2534 shmlog on|off|toggle
2535 ------------------------------
2539 # Enable/disable logging
2540 bindsym $mod+x shmlog toggle
2542 # or, from a terminal:
2543 # increase the shared memory log buffer to 50 MiB
2544 i3-msg shmlog $((50*1024*1024))
2547 === Enabling debug logging
2549 The +debuglog+ command allows you to enable or disable debug logging at
2550 runtime. Debug logging is much more verbose than non-debug logging. This
2551 command does not activate shared memory logging (shmlog), and as such is most
2552 likely useful in combination with the above-described <<shmlog>> command.
2555 ----------------------
2556 debuglog on|off|toggle
2557 ----------------------
2560 ------------------------
2561 # Enable/disable logging
2562 bindsym $mod+x debuglog toggle
2563 ------------------------
2565 === Reloading/Restarting/Exiting
2567 You can make i3 reload its configuration file with +reload+. You can also
2568 restart i3 inplace with the +restart+ command to get it out of some weird state
2569 (if that should ever happen) or to perform an upgrade without having to restart
2570 your X session. To exit i3 properly, you can use the +exit+ command,
2571 however you don’t need to (simply killing your X session is fine as well).
2574 ----------------------------
2575 bindsym $mod+Shift+r restart
2576 bindsym $mod+Shift+w reload
2577 bindsym $mod+Shift+e exit
2578 ----------------------------
2582 There are two commands to use any existing window as scratchpad window. +move
2583 scratchpad+ will move a window to the scratchpad workspace. This will make it
2584 invisible until you show it again. There is no way to open that workspace.
2585 Instead, when using +scratchpad show+, the window will be shown again, as a
2586 floating window, centered on your current workspace (using +scratchpad show+ on
2587 a visible scratchpad window will make it hidden again, so you can have a
2588 keybinding to toggle). Note that this is just a normal floating window, so if
2589 you want to "remove it from scratchpad", you can simple make it tiling again
2590 (+floating toggle+).
2592 As the name indicates, this is useful for having a window with your favorite
2593 editor always at hand. However, you can also use this for other permanently
2594 running applications which you don’t want to see all the time: Your music
2595 player, alsamixer, maybe even your mail client…?
2605 ------------------------------------------------
2606 # Make the currently focused window a scratchpad
2607 bindsym $mod+Shift+minus move scratchpad
2609 # Show the first scratchpad window
2610 bindsym $mod+minus scratchpad show
2612 # Show the sup-mail scratchpad window, if any.
2613 bindsym mod4+s [title="^Sup ::"] scratchpad show
2614 ------------------------------------------------
2618 There is a no operation command +nop+ which allows you to override default
2619 behavior. This can be useful for, e.g., disabling a focus change on clicks with
2620 the middle mouse button.
2622 The optional +comment+ argument is ignored, but will be printed to the log file
2623 for debugging purposes.
2631 ----------------------------------------------
2632 # Disable focus change for clicks on titlebars
2633 # with the middle mouse button
2635 ----------------------------------------------
2639 There are two options in the configuration of each i3bar instance that can be
2640 changed during runtime by invoking a command through i3. The commands +bar
2641 hidden_state+ and +bar mode+ allow setting the current hidden_state
2642 respectively mode option of each bar. It is also possible to toggle between
2643 hide state and show state as well as between dock mode and hide mode. Each
2644 i3bar instance can be controlled individually by specifying a bar_id, if none
2645 is given, the command is executed for all bar instances.
2649 bar hidden_state hide|show|toggle [<bar_id>]
2651 bar mode dock|hide|invisible|toggle [<bar_id>]
2655 ------------------------------------------------
2656 # Toggle between hide state and show state
2657 bindsym $mod+m bar hidden_state toggle
2659 # Toggle between dock mode and hide mode
2660 bindsym $mod+n bar mode toggle
2662 # Set the bar instance with id 'bar-1' to switch to hide mode
2663 bindsym $mod+b bar mode hide bar-1
2665 # Set the bar instance with id 'bar-1' to always stay hidden
2666 bindsym $mod+Shift+b bar mode invisible bar-1
2667 ------------------------------------------------
2670 == Multiple monitors
2672 As you can see in the goal list on the website, i3 was specifically developed
2673 with support for multiple monitors in mind. This section will explain how to
2674 handle multiple monitors.
2676 When you have only one monitor, things are simple. You usually start with
2677 workspace 1 on your monitor and open new ones as you need them.
2679 When you have more than one monitor, each monitor will get an initial
2680 workspace. The first monitor gets 1, the second gets 2 and a possible third
2681 would get 3. When you switch to a workspace on a different monitor, i3 will
2682 switch to that monitor and then switch to the workspace. This way, you don’t
2683 need shortcuts to switch to a specific monitor, and you don’t need to remember
2684 where you put which workspace. New workspaces will be opened on the currently
2685 active monitor. It is not possible to have a monitor without a workspace.
2687 The idea of making workspaces global is based on the observation that most
2688 users have a very limited set of workspaces on their additional monitors.
2689 They are often used for a specific task (browser, shell) or for monitoring
2690 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
2691 and "the rest" on the other monitors often makes sense. However, as you can
2692 create an unlimited number of workspaces in i3 and tie them to specific
2693 screens, you can have the "traditional" approach of having X workspaces per
2694 screen by changing your configuration (using modes, for example).
2696 === Configuring your monitors
2698 To help you get going if you have never used multiple monitors before, here is
2699 a short overview of the xrandr options which will probably be of interest to
2700 you. It is always useful to get an overview of the current screen configuration.
2701 Just run "xrandr" and you will get an output like the following:
2702 -------------------------------------------------------------------------------
2704 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
2705 VGA1 disconnected (normal left inverted right x axis y axis)
2706 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
2707 1280x800 60.0*+ 50.0
2708 1024x768 85.0 75.0 70.1 60.0
2710 800x600 85.1 72.2 75.0 60.3 56.2
2711 640x480 85.0 72.8 75.0 59.9
2715 --------------------------------------------------------------------------------------
2717 Several things are important here: You can see that +LVDS1+ is connected (of
2718 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
2719 connected to one of the ports but xrandr still says "disconnected", you should
2720 check your cable, monitor or graphics driver.
2722 The maximum resolution you can see at the end of the first line is the maximum
2723 combined resolution of your monitors. By default, it is usually too low and has
2724 to be increased by editing +/etc/X11/xorg.conf+.
2726 So, say you connected VGA1 and want to use it as an additional screen:
2727 -------------------------------------------
2728 xrandr --output VGA1 --auto --left-of LVDS1
2729 -------------------------------------------
2730 This command makes xrandr try to find the native resolution of the device
2731 connected to +VGA1+ and configures it to the left of your internal flat panel.
2732 When running "xrandr" again, the output looks like this:
2733 -------------------------------------------------------------------------------
2735 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
2736 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
2737 1280x1024 60.0*+ 75.0
2740 1024x768 75.1 70.1 60.0
2742 800x600 72.2 75.0 60.3 56.2
2743 640x480 72.8 75.0 66.7 60.0
2745 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
2746 1280x800 60.0*+ 50.0
2747 1024x768 85.0 75.0 70.1 60.0
2749 800x600 85.1 72.2 75.0 60.3 56.2
2750 640x480 85.0 72.8 75.0 59.9
2754 -------------------------------------------------------------------------------
2755 Please note that i3 uses exactly the same API as xrandr does, so it will see
2756 only what you can see in xrandr.
2758 See also <<presentations>> for more examples of multi-monitor setups.
2760 === Interesting configuration for multi-monitor environments
2762 There are several things to configure in i3 which may be interesting if you
2763 have more than one monitor:
2765 1. You can specify which workspace should be put on which screen. This
2766 allows you to have a different set of workspaces when starting than just
2767 1 for the first monitor, 2 for the second and so on. See
2768 <<workspace_screen>>.
2769 2. If you want some applications to generally open on the bigger screen
2770 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
2771 <<assign_workspace>>.
2772 3. If you have many workspaces on many monitors, it might get hard to keep
2773 track of which window you put where. Thus, you can use vim-like marks to
2774 quickly switch between windows. See <<vim_like_marks>>.
2775 4. For information on how to move existing workspaces between monitors,
2776 see <<move_to_outputs>>.
2778 == i3 and the rest of your software world
2780 === Displaying a status line
2782 A very common thing amongst users of exotic window managers is a status line at
2783 some corner of the screen. It is an often superior replacement to the widget
2784 approach you have in the task bar of a traditional desktop environment.
2786 If you don’t already have your favorite way of generating such a status line
2787 (self-written scripts, conky, …), then i3status is the recommended tool for
2788 this task. It was written in C with the goal of using as few syscalls as
2789 possible to reduce the time your CPU is woken up from sleep states. Because
2790 i3status only spits out text, you need to combine it with some other tool, like
2791 i3bar. See <<status_command>> for how to display i3status in i3bar.
2793 Regardless of which application you use to display the status line, you
2794 want to make sure that it registers as a dock window using EWMH hints. i3 will
2795 position the window either at the top or at the bottom of the screen, depending
2796 on which hint the application sets. With i3bar, you can configure its position,
2797 see <<i3bar_position>>.
2800 === Giving presentations (multi-monitor)
2802 When giving a presentation, you typically want the audience to see what you see
2803 on your screen and then go through a series of slides (if the presentation is
2804 simple). For more complex presentations, you might want to have some notes
2805 which only you can see on your screen, while the audience can only see the
2808 ==== Case 1: everybody gets the same output
2809 This is the simple case. You connect your computer to the video projector,
2810 turn on both (computer and video projector) and configure your X server to
2811 clone the internal flat panel of your computer to the video output:
2812 -----------------------------------------------------
2813 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
2814 -----------------------------------------------------
2815 i3 will then use the lowest common subset of screen resolutions, the rest of
2816 your screen will be left untouched (it will show the X background). So, in
2817 our example, this would be 1024x768 (my notebook has 1280x800).
2819 ==== Case 2: you can see more than your audience
2820 This case is a bit harder. First of all, you should configure the VGA output
2821 somewhere near your internal flat panel, say right of it:
2822 -----------------------------------------------------
2823 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
2824 -----------------------------------------------------
2825 Now, i3 will put a new workspace (depending on your settings) on the new screen
2826 and you are in multi-monitor mode (see <<multi_monitor>>).
2828 Because i3 is not a compositing window manager, there is no ability to
2829 display a window on two screens at the same time. Instead, your presentation
2830 software needs to do this job (that is, open a window on each screen).