3 Michael Stapelberg <michael@i3wm.org>
6 This document contains all the information you need to configure and use the i3
7 window manager. If it does not, please check https://www.reddit.com/r/i3wm/
8 first, then contact us on IRC (preferred) or post your question(s) on the
11 == Default keybindings
13 For the "too long; didn’t read" people, here is an overview of the default
14 keybindings (click to see the full size image):
16 *Keys to use with $mod (Alt):*
18 image:keyboard-layer1.png["Keys to use with $mod (Alt)",width=600,link="keyboard-layer1.png"]
20 *Keys to use with Shift+$mod:*
22 image:keyboard-layer2.png["Keys to use with Shift+$mod",width=600,link="keyboard-layer2.png"]
24 The red keys are the modifiers you need to press (by default), the blue keys
27 Note that when starting i3 without a config file, i3-config-wizard will offer
28 you to create a config file in which the key positions (!) match what you see
29 in the image above, regardless of the keyboard layout you are using. If you
30 prefer to use a config file where the key letters match what you are seeing
31 above, just decline i3-config-wizard’s offer and base your config on
36 Throughout this guide, the keyword +$mod+ will be used to refer to the
37 configured modifier. This is the Alt key (+Mod1+) by default, with the Windows
38 key (+Mod4+) being a popular alternative.
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/i3.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/i3.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
302 It is possible and recommended to use comments in your configuration file to
303 properly document your setup for later reference. Comments are started with
304 a # and can only be used at the beginning of a line:
314 i3 has support for both X core fonts and FreeType fonts (through Pango) to
315 render window titles.
317 To generate an X core font description, you can use +xfontsel(1)+. To see
318 special characters (Unicode), you need to use a font which supports the
321 A FreeType font description is composed by a font family, a style, a weight,
322 a variant, a stretch and a size.
323 FreeType fonts support right-to-left rendering and contain often more
324 Unicode glyphs than X core fonts.
326 If i3 cannot open the configured font, it will output an error in the logfile
327 and fall back to a working font.
330 ------------------------------
331 font <X core font description>
332 font pango:<family list> [<style options>] <size>
333 ------------------------------
336 --------------------------------------------------------------
337 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
338 font pango:DejaVu Sans Mono 10
339 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
340 font pango:Terminus 11px
341 --------------------------------------------------------------
344 === Keyboard bindings
346 A keyboard binding makes i3 execute a command (see below) upon pressing a
347 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
348 also mix your bindings, though i3 will not protect you from overlapping ones).
350 * A keysym (key symbol) is a description for a specific symbol, like "a"
351 or "b", but also more strange ones like "underscore" instead of "_". These
352 are the ones you use in Xmodmap to remap your keys. To get the current
353 mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
354 see what keysym it is configured to, use +xev+.
356 * Keycodes do not need to have a symbol assigned (handy for custom vendor
357 hotkeys on some notebooks) and they will not change their meaning as you
358 switch to a different keyboard layout (when using +xmodmap+).
360 My recommendation is: If you often switch keyboard layouts but you want to keep
361 your bindings in the same physical location on the keyboard, use keycodes.
362 If you don’t switch layouts, and want a clean and simple config file, use
365 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
366 KeyPress event, because the keyboard/pointer is still grabbed. For these
367 situations, the +--release+ flag can be used, which will execute the command
368 after the keys have been released.
371 ----------------------------------
372 bindsym [--release] [<Group>+][<Modifiers>+]<keysym> command
373 bindcode [--release] [<Group>+][<Modifiers>+]<keycode> command
374 ----------------------------------
377 --------------------------------
379 bindsym $mod+f fullscreen toggle
382 bindsym $mod+Shift+r restart
384 # Notebook-specific hotkeys
385 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
387 # Simulate ctrl+v upon pressing $mod+x
388 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
390 # Take a screenshot upon pressing $mod+x (select an area)
391 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
392 --------------------------------
396 Mod1-Mod5, Shift, Control::
397 Standard modifiers, see +xmodmap(1)+
399 Group1, Group2, Group3, Group4::
400 When using multiple keyboard layouts (e.g. with `setxkbmap -layout us,ru`), you
401 can specify in which XKB group (also called “layout”) a keybinding should be
402 active. By default, keybindings are translated in Group1 and are active in all
403 groups. If you want to override keybindings in one of your layouts, specify the
404 corresponding group. For backwards compatibility, the group “Mode_switch” is an
410 A mouse binding makes i3 execute a command upon pressing a specific mouse
411 button in the scope of the clicked container (see <<command_criteria>>). You
412 can configure mouse bindings in a similar way to key bindings.
415 -------------------------------------------------------------------------------
416 bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
417 -------------------------------------------------------------------------------
419 By default, the binding will only run when you click on the titlebar of the
420 window. If the +--release+ flag is given, it will run when the mouse button
423 If the +--whole-window+ flag is given, the binding will also run when any part
424 of the window is clicked, with the exception of the border. To have a bind run
425 when the border is clicked, specify the +--border+ flag.
428 --------------------------------
429 # The middle button over a titlebar kills the window
430 bindsym --release button2 kill
432 # The middle button and a modifer over any part of the window kills the window
433 bindsym --whole-window $mod+button2 kill
435 # The right button toggles floating
436 bindsym button3 floating toggle
437 bindsym $mod+button3 floating toggle
439 # The side buttons move the window around
440 bindsym button9 move left
441 bindsym button8 move right
442 --------------------------------
447 You can have multiple sets of bindings by using different binding modes. When
448 you switch to another binding mode, all bindings from the current mode are
449 released and only the bindings defined in the new mode are valid for as long as
450 you stay in that binding mode. The only predefined binding mode is +default+,
451 which is the mode i3 starts out with and to which all bindings not defined in a
452 specific binding mode belong.
454 Working with binding modes consists of two parts: defining a binding mode and
455 switching to it. For these purposes, there are one config directive and one
456 command, both of which are called +mode+. The directive is used to define the
457 bindings belonging to a certain binding mode, while the command will switch to
460 It is recommended to use binding modes in combination with <<variables>> in
461 order to make maintenance easier. Below is an example of how to use a binding
464 Note that it is advisable to define bindings for switching back to the default
467 Note that it is possible to use <<pango_markup>> for binding modes, but you
468 need to enable it explicitly by passing the +--pango_markup+ flag to the mode
472 ----------------------------
474 mode [--pango_markup] <name>
478 ----------------------------
481 ------------------------------------------------------------------------
482 # Press $mod+o followed by either f, t, Esc or Return to launch firefox,
483 # thunderbird or return to the default mode, respectively.
484 set $mode_launcher Launch: [f]irefox [t]hunderbird
485 bindsym $mod+o mode "$mode_launcher"
487 mode "$mode_launcher" {
488 bindsym f exec firefox
489 bindsym t exec thunderbird
491 bindsym Esc mode "default"
492 bindsym Return mode "default"
494 ------------------------------------------------------------------------
496 [[floating_modifier]]
497 === The floating modifier
499 To move floating windows with your mouse, you can either grab their titlebar
500 or configure the so called floating modifier which you can then press and
501 click anywhere in the window itself to move it. The most common setup is to
502 use the same key you use for managing windows (Mod1 for example). Then
503 you can press Mod1, click into a window using your left mouse button, and drag
504 it to the position you want.
506 When holding the floating modifier, you can resize a floating window by
507 pressing the right mouse button on it and moving around while holding it. If
508 you hold the shift button as well, the resize will be proportional (the aspect
509 ratio will be preserved).
512 --------------------------------
513 floating_modifier <Modifier>
514 --------------------------------
517 --------------------------------
518 floating_modifier Mod1
519 --------------------------------
521 === Constraining floating window size
523 The maximum and minimum dimensions of floating windows can be specified. If
524 either dimension of +floating_maximum_size+ is specified as -1, that dimension
525 will be unconstrained with respect to its maximum value. If either dimension of
526 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
527 value to constrain the maximum size. +floating_minimum_size+ is treated in a
528 manner analogous to +floating_maximum_size+.
531 ----------------------------------------
532 floating_minimum_size <width> x <height>
533 floating_maximum_size <width> x <height>
534 ----------------------------------------
537 --------------------------------------
538 floating_minimum_size 75 x 50
539 floating_maximum_size -1 x -1
540 --------------------------------------
542 === Orientation for new workspaces
544 New workspaces get a reasonable default orientation: Wide-screen monitors
545 (anything wider than high) get horizontal orientation, rotated monitors
546 (anything higher than wide) get vertical orientation.
548 With the +default_orientation+ configuration directive, you can override that
552 --------------------------------------------
553 default_orientation horizontal|vertical|auto
554 --------------------------------------------
557 ----------------------------
558 default_orientation vertical
559 ----------------------------
561 === Layout mode for new containers
563 This option determines in which mode new containers on workspace level will
567 ---------------------------------------------
568 workspace_layout default|stacking|tabbed
569 ---------------------------------------------
572 ---------------------
573 workspace_layout tabbed
574 ---------------------
576 === Border style for new windows
578 This option determines which border style new windows will have. The default is
579 +normal+. Note that new_float applies only to windows which are starting out as
580 floating windows, e.g., dialog windows, but not windows that are floated later on.
583 ---------------------------------------------
584 new_window normal|none|pixel
585 new_window normal|pixel <px>
586 new_float normal|none|pixel
587 new_float normal|pixel <px>
588 ---------------------------------------------
591 ---------------------
593 ---------------------
595 The "normal" and "pixel" border styles support an optional border width in
599 ---------------------
600 # The same as new_window none
605 ---------------------
608 [[_hiding_vertical_borders]]
609 === Hiding borders adjacent to the screen edges
611 You can hide container borders adjacent to the screen edges using
612 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
613 to waste even two pixels in displayspace. The "smart" setting hides borders on
614 workspaces with only one window visible, but keeps them on workspaces with
615 multiple windows visible. Default is none.
618 -----------------------------------------------
619 hide_edge_borders none|vertical|horizontal|both|smart
620 -----------------------------------------------
623 ----------------------
624 hide_edge_borders vertical
625 ----------------------
628 === Arbitrary commands for specific windows (for_window)
630 With the +for_window+ command, you can let i3 execute any command when it
631 encounters a specific window. This can be used to set windows to floating or to
632 change their border style, for example.
635 -------------------------------
636 for_window <criteria> <command>
637 -------------------------------
640 ------------------------------------------------
641 # enable floating mode for all XTerm windows
642 for_window [class="XTerm"] floating enable
644 # Make all urxvts use a 1-pixel border:
645 for_window [class="urxvt"] border pixel 1
647 # A less useful, but rather funny example:
648 # makes the window floating as soon as I change
649 # directory to ~/work
650 for_window [title="x200: ~/work"] floating enable
651 ------------------------------------------------
653 The valid criteria are the same as those for commands, see <<command_criteria>>.
656 === Don't focus window upon opening
658 When a new window appears, it will be focused. The +no_focus+ directive allows preventing
659 this from happening and must be used in combination with <<command_criteria>>.
661 Note that this does not apply to all cases, e.g., when feeding data into a running application
662 causing it to request being focused. To configure the behavior in such cases, refer to
663 <<focus_on_window_activation>>.
665 +no_focus+ will also be ignored for the first window on a workspace as there shouldn't be
666 a reason to not focus the window in this case. This allows for better usability in
667 combination with +workspace_layout+.
675 -------------------------------
676 no_focus [window_role="pop-up"]
677 -------------------------------
682 As you learned in the section about keyboard bindings, you will have
683 to configure lots of bindings containing modifier keys. If you want to save
684 yourself some typing and be able to change the modifier you use later,
685 variables can be handy.
693 ------------------------
695 bindsym $m+Shift+r restart
696 ------------------------
698 Variables are directly replaced in the file when parsing. Variables expansion
699 is not recursive so it is not possible to define a variable with a value
700 containing another variable. There is no fancy handling and there are
701 absolutely no plans to change this. If you need a more dynamic configuration
702 you should create a little script which generates a configuration file and run
703 it before starting i3 (for example in your +~/.xsession+ file).
705 Also see <<xresources>> to learn how to create variables based on resources
706 loaded from the X resource database.
711 <<variables>> can also be created using a value configured in the X resource
712 database. This is useful, for example, to avoid configuring color values within
713 the i3 configuration. Instead, the values can be configured, once, in the X
714 resource database to achieve an easily maintainable, consistent color theme
715 across many X applications.
717 Defining a resource will load this resource from the resource database and
718 assign its value to the specified variable. A fallback must be specified in
719 case the resource cannot be loaded from the database.
722 ----------------------------------------------------
723 set_from_resource $<name> <resource_name> <fallback>
724 ----------------------------------------------------
727 ----------------------------------------------------------------------------
728 # The ~/.Xresources should contain a line such as
730 # and must be loaded properly, e.g., by using
732 # This value is picked up on by other applications (e.g., the URxvt terminal
733 # emulator) and can be used in i3 like this:
734 set_from_resource $black i3wm.color0 #000000
735 ----------------------------------------------------------------------------
738 === Automatically putting clients on specific workspaces
740 To automatically make a specific window show up on a specific workspace, you
741 can use an *assignment*. You can match windows by using any criteria,
742 see <<command_criteria>>. It is recommended that you match on window classes
743 (and instances, when appropriate) instead of window titles whenever possible
744 because some applications first create their window, and then worry about
745 setting the correct title. Firefox with Vimperator comes to mind. The window
746 starts up being named Firefox, and only when Vimperator is loaded does the
747 title change. As i3 will get the title as soon as the application maps the
748 window (mapping means actually displaying it on the screen), you’d need to have
749 to match on 'Firefox' in this case.
751 Assignments are processed by i3 in the order in which they appear in the config
752 file. The first one which matches the window wins and later assignments are not
756 ------------------------------------------------------------
757 assign <criteria> [→] [workspace] <workspace>
758 ------------------------------------------------------------
761 ----------------------
762 # Assign URxvt terminals to workspace 2
763 assign [class="URxvt"] 2
765 # Same thing, but more precise (exact match instead of substring)
766 assign [class="^URxvt$"] 2
768 # Same thing, but with a beautiful arrow :)
769 assign [class="^URxvt$"] → 2
771 # Assignment to a named workspace
772 assign [class="^URxvt$"] → work
774 # Start urxvt -name irssi
775 assign [class="^URxvt$" instance="^irssi$"] → 3
776 ----------------------
778 Note that the arrow is not required, it just looks good :-). If you decide to
779 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
781 To get the class and instance, you can use +xprop+. After clicking on the
782 window, you will see the following output:
785 -----------------------------------
786 WM_CLASS(STRING) = "irssi", "URxvt"
787 -----------------------------------
789 The first part of the WM_CLASS is the instance ("irssi" in this example), the
790 second part is the class ("URxvt" in this example).
792 Should you have any problems with assignments, make sure to check the i3
793 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
794 details about the matching process and the window’s actual class, instance and
795 title when starting up.
797 Note that if you want to start an application just once on a specific
798 workspace, but you don’t want to assign all instances of it permanently, you
799 can make use of i3’s startup-notification support (see <<exec>>) in your config
800 file in the following way:
802 *Start iceweasel on workspace 3 (once)*:
803 -------------------------------------------------------------------------------
804 # Start iceweasel on workspace 3, then switch back to workspace 1
805 # (Being a command-line utility, i3-msg does not support startup notifications,
806 # hence the exec --no-startup-id.)
807 # (Starting iceweasel with i3’s exec command is important in order to make i3
808 # create a startup notification context, without which the iceweasel window(s)
809 # cannot be matched onto the workspace on which the command was started.)
810 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
811 -------------------------------------------------------------------------------
813 === Automatically starting applications on i3 startup
815 By using the +exec+ keyword outside a keybinding, you can configure
816 which commands will be performed by i3 on initial startup. +exec+
817 commands will not run when restarting i3, if you need a command to run
818 also when restarting i3 you should use the +exec_always+
819 keyword. These commands will be run in order.
821 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
822 and +,+ (comma): they chain commands together in i3, so you need to use quoted
823 strings (as shown in <<exec_quoting>>) if they appear in your command.
826 ---------------------------------------
827 exec [--no-startup-id] <command>
828 exec_always [--no-startup-id] <command>
829 ---------------------------------------
832 --------------------------------
834 exec_always ~/my_script.sh
836 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
837 exec --no-startup-id urxvt
838 --------------------------------
840 The flag --no-startup-id is explained in <<exec>>.
843 === Automatically putting workspaces on specific screens
845 If you assign clients to workspaces, it might be handy to put the
846 workspaces on specific screens. Also, the assignment of workspaces to screens
847 will determine which workspace i3 uses for a new screen when adding screens
848 or when starting (e.g., by default it will use 1 for the first screen, 2 for
849 the second screen and so on).
852 -------------------------------------
853 workspace <workspace> output <output>
854 -------------------------------------
856 The 'output' is the name of the RandR output you attach your screen to. On a
857 laptop, you might have VGA1 and LVDS1 as output names. You can see the
858 available outputs by running +xrandr --current+.
860 If you use named workspaces, they must be quoted:
863 ---------------------------
864 workspace 1 output LVDS1
865 workspace 5 output VGA1
866 workspace "2: vim" output VGA1
867 ---------------------------
871 You can change all colors which i3 uses to draw the window decorations.
874 --------------------------------------------------------------------
875 <colorclass> <border> <background> <text> <indicator> <child_border>
876 --------------------------------------------------------------------
878 Where colorclass can be one of:
881 A client which currently has the focus.
882 client.focused_inactive::
883 A client which is the focused one of its container, but it does not have
884 the focus at the moment.
886 A client which is not the focused one of its container.
888 A client which has its urgency hint activated.
890 Background and text color are used to draw placeholder window contents
891 (when restoring layouts). Border and indicator are ignored.
893 Background color which will be used to paint the background of the
894 client window on top of which the client will be rendered. Only clients
895 which do not cover the whole area of this window expose the color. Note
896 that this colorclass only takes a single color.
898 Colors are in HTML hex format (#rrggbb), see the following example:
900 *Examples (default colors)*:
901 ----------------------------------------------------------------------
902 # class border backgr. text indicator child_border
903 client.focused #4c7899 #285577 #ffffff #2e9ef4 #285577
904 client.focused_inactive #333333 #5f676a #ffffff #484e50 #5f676a
905 client.unfocused #333333 #222222 #888888 #292d2e #222222
906 client.urgent #2f343a #900000 #ffffff #900000 #900000
907 client.placeholder #000000 #0c0c0c #ffffff #000000 #0c0c0c
909 client.background #ffffff
910 ----------------------------------------------------------------------
912 Note that for the window decorations, the color around the child window is the
913 "child_border", and "border" color is only the two thin lines around the
916 The indicator color is used for indicating where a new window will be opened.
917 For horizontal split containers, the right border will be painted in indicator
918 color, for vertical split containers, the bottom border. This only applies to
919 single windows within a split container, which are otherwise indistinguishable
920 from single windows outside of a split container.
922 === Interprocess communication
924 i3 uses Unix sockets to provide an IPC interface. This allows third-party
925 programs to get information from i3, such as the current workspaces
926 (to display a workspace bar), and to control i3.
928 The IPC socket is enabled by default and will be created in
929 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
930 the PID of i3 and XXXXXX is a string of random characters from the portable
931 filename character set (see mkdtemp(3)).
933 You can override the default path through the environment-variable +I3SOCK+ or
934 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
935 does the right thing by default. If you decide to change it, it is strongly
936 recommended to set this to a location in your home directory so that no other
937 user can create that directory.
940 ----------------------------
941 ipc-socket ~/.i3/i3-ipc.sock
942 ----------------------------
944 You can then use the +i3-msg+ application to perform any command listed in
947 === Focus follows mouse
949 By default, window focus follows your mouse movements. However, if you have a
950 setup where your mouse usually is in your way (like a touchpad on your laptop
951 which you do not want to disable completely), you might want to disable 'focus
952 follows mouse' and control focus only by using your keyboard. The mouse will
953 still be useful inside the currently active window (for example to click on
954 links in your browser window).
957 --------------------------
958 focus_follows_mouse yes|no
959 --------------------------
962 ----------------------
963 focus_follows_mouse no
964 ----------------------
968 By default, when switching focus to a window on a different output (e.g.
969 focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on
970 LVDS-1), the mouse cursor is warped to the center of that window.
972 With the +mouse_warping+ option, you can control when the mouse cursor should
973 be warped. +none+ disables warping entirely, whereas +output+ is the default
974 behavior described above.
977 -------------------------
978 mouse_warping output|none
979 -------------------------
986 === Popups during fullscreen mode
988 When you are in fullscreen mode, some applications still open popup windows
989 (take Xpdf for example). This is because these applications may not be aware
990 that they are in fullscreen mode (they do not check the corresponding hint).
991 There are three things which are possible to do in this situation:
993 1. Display the popup if it belongs to the fullscreen application only. This is
994 the default and should be reasonable behavior for most users.
995 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
996 in fullscreen. However, some apps might react badly to this (deadlock until
997 you go out of fullscreen).
998 3. Leave fullscreen mode.
1001 -----------------------------------------------------
1002 popup_during_fullscreen smart|ignore|leave_fullscreen
1003 -----------------------------------------------------
1006 ------------------------------
1007 popup_during_fullscreen smart
1008 ------------------------------
1012 When being in a tabbed or stacked container, the first container will be
1013 focused when you use +focus down+ on the last container -- the focus wraps. If
1014 however there is another stacked/tabbed container in that direction, focus will
1015 be set on that container. This is the default behavior so you can navigate to
1016 all your windows without having to use +focus parent+.
1018 If you want the focus to *always* wrap and you are aware of using +focus
1019 parent+ to switch to different containers, you can use the
1020 +force_focus_wrapping+ configuration directive. After enabling it, the focus
1024 ---------------------------
1025 force_focus_wrapping yes|no
1026 ---------------------------
1029 ------------------------
1030 force_focus_wrapping yes
1031 ------------------------
1033 === Forcing Xinerama
1035 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
1036 video drivers (especially the nVidia binary driver) only provide support for
1037 Xinerama instead of RandR. In such a situation, i3 must be told to use the
1038 inferior Xinerama API explicitly and therefore don’t provide support for
1039 reconfiguring your screens on the fly (they are read only once on startup and
1042 For people who cannot modify their +~/.xsession+ to add the
1043 +--force-xinerama+ commandline parameter, a configuration option is provided:
1046 ---------------------
1047 force_xinerama yes|no
1048 ---------------------
1055 Also note that your output names are not descriptive (like +HDMI1+) when using
1056 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
1058 === Automatic back-and-forth when switching to the current workspace
1060 This configuration directive enables automatic +workspace back_and_forth+ (see
1061 <<back_and_forth>>) when switching to the workspace that is currently focused.
1063 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
1064 mod+2 because somebody sent you a message. You don’t need to remember where you
1065 came from now, you can just press $mod+2 again to switch back to "1: www".
1068 ------------------------------------
1069 workspace_auto_back_and_forth yes|no
1070 ------------------------------------
1073 ---------------------------------
1074 workspace_auto_back_and_forth yes
1075 ---------------------------------
1077 === Delaying urgency hint reset on workspace change
1079 If an application on another workspace sets an urgency hint, switching to this
1080 workspace may lead to immediate focus of the application, which also means the
1081 window decoration color would be immediately reset to +client.focused+. This
1082 may make it unnecessarily hard to tell which window originally raised the
1085 In order to prevent this, you can tell i3 to delay resetting the urgency state
1086 by a certain time using the +force_display_urgency_hint+ directive. Setting the
1087 value to 0 disables this feature.
1089 The default is 500ms.
1092 ---------------------------------------
1093 force_display_urgency_hint <timeout> ms
1094 ---------------------------------------
1097 ---------------------------------
1098 force_display_urgency_hint 500 ms
1099 ---------------------------------
1101 [[focus_on_window_activation]]
1102 === Focus on window activation
1104 If a window is activated, e.g., via +google-chrome www.google.com+, it may request
1105 to take focus. Since this may not preferable, different reactions can be configured.
1107 Note that this may not affect windows that are being opened. To prevent new windows
1108 from being focused, see <<no_focus>>.
1111 --------------------------------------------------
1112 focus_on_window_activation smart|urgent|focus|none
1113 --------------------------------------------------
1115 The different modes will act as follows:
1118 This is the default behavior. If the window requesting focus is on an active
1119 workspace, it will receive the focus. Otherwise, the urgency hint will be set.
1121 The window will always be marked urgent, but the focus will not be stolen.
1123 The window will always be focused and not be marked urgent.
1125 The window will neither be focused, nor be marked urgent.
1128 === Drawing marks on window decoration
1130 If activated, marks on windows are drawn in their window decoration. However,
1131 any mark starting with an underscore in its name (+_+) will not be drawn even if
1132 this option is activated.
1134 The default for this option is +yes+.
1146 [[line_continuation]]
1147 === Line continuation
1149 Config files support line continuation, meaning when you end a line in a
1150 backslash character (`\`), the line-break will be ignored by the parser. This
1151 feature can be used to create more readable configuration files.
1152 Commented lines are not continued.
1159 # this line is not continued \
1160 bindsym Mod1+F fullscreen toggle
1163 == Configuring i3bar
1165 The bar at the bottom of your monitor is drawn by a separate process called
1166 i3bar. Having this part of "the i3 user interface" in a separate process has
1169 1. It is a modular approach. If you don’t need a workspace bar at all, or if
1170 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
1171 just remove the i3bar configuration and start your favorite bar instead.
1172 2. It follows the UNIX philosophy of "Make each program do one thing well".
1173 While i3 manages your windows well, i3bar is good at displaying a bar on
1174 each monitor (unless you configure it otherwise).
1175 3. It leads to two separate, clean codebases. If you want to understand i3, you
1176 don’t need to bother with the details of i3bar and vice versa.
1178 That said, i3bar is configured in the same configuration file as i3. This is
1179 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
1180 are useful for people using other window managers). Therefore, it makes no
1181 sense to use a different configuration place when we already have a good
1182 configuration infrastructure in place.
1184 Configuring your workspace bar starts with opening a +bar+ block. You can have
1185 multiple bar blocks to use different settings for different outputs (monitors):
1188 ---------------------------
1190 status_command i3status
1192 ---------------------------
1196 By default i3 will just pass +i3bar+ and let your shell handle the execution,
1197 searching your +$PATH+ for a correct version.
1198 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
1199 tell i3 what to execute.
1201 The specified command will be passed to +sh -c+, so you can use globbing and
1202 have to have correct quoting etc.
1205 -----------------------
1206 i3bar_command <command>
1207 -----------------------
1210 -------------------------------------------------
1212 i3bar_command /home/user/bin/i3bar
1214 -------------------------------------------------
1217 === Statusline command
1219 i3bar can run a program and display every line of its +stdout+ output on the
1220 right hand side of the bar. This is useful to display system information like
1221 your current IP address, battery status or date/time.
1223 The specified command will be passed to +sh -c+, so you can use globbing and
1224 have to have correct quoting etc. Note that for signal handling, depending on
1225 your shell (users of dash(1) are known to be affected), you have to use the
1226 shell’s exec command so that signals are passed to your program, not to the
1230 ------------------------
1231 status_command <command>
1232 ------------------------
1235 -------------------------------------------------
1237 status_command i3status --config ~/.i3status.conf
1239 # For dash(1) users who want signal handling to work:
1240 status_command exec ~/.bin/my_status_command
1242 -------------------------------------------------
1246 You can either have i3bar be visible permanently at one edge of the screen
1247 (+dock+ mode) or make it show up when you press your modifier key (+hide+ mode).
1248 It is also possible to force i3bar to always stay hidden (+invisible+
1249 mode). The modifier key can be configured using the +modifier+ option.
1251 The mode option can be changed during runtime through the +bar mode+ command.
1252 On reload the mode will be reverted to its configured value.
1254 The hide mode maximizes screen space that can be used for actual windows. Also,
1255 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1258 Invisible mode allows to permanently maximize screen space, as the bar is never
1259 shown. Thus, you can configure i3bar to not disturb you by popping up because
1260 of an urgency hint or because the modifier key is pressed.
1262 In order to control whether i3bar is hidden or shown in hide mode, there exists
1263 the hidden_state option, which has no effect in dock mode or invisible mode. It
1264 indicates the current hidden_state of the bar: (1) The bar acts like in normal
1265 hide mode, it is hidden and is only unhidden in case of urgency hints or by
1266 pressing the modifier key (+hide+ state), or (2) it is drawn on top of the
1267 currently visible workspace (+show+ state).
1269 Like the mode, the hidden_state can also be controlled through i3, this can be
1270 done by using the +bar hidden_state+ command.
1272 The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
1273 the windows key). The default value for the hidden_state is hide.
1276 -------------------------
1277 mode dock|hide|invisible
1278 hidden_state hide|show
1279 modifier <Modifier>|none
1280 ------------------------
1291 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+). You can
1292 also use "none" if you don't want any modifier to trigger this behavior.
1294 === Mouse button commands
1296 Specifies a command to run when a button was pressed on i3bar to override the
1297 default behavior. This is useful, e.g., for disabling the scroll wheel action
1298 or running scripts that implement custom behavior for these buttons.
1300 A button is always named +button<n>+, where 1 to 5 are default buttons as follows and higher
1301 numbers can be special buttons on devices offering more buttons:
1306 Middle mouse button.
1314 Please note that the old +wheel_up_cmd+ and +wheel_down_cmd+ commands are deprecated
1315 and will be removed in a future release. We strongly recommend using the more general
1316 +bindsym+ with +button4+ and +button5+ instead.
1319 ----------------------------
1320 bindsym button<n> <command>
1321 ----------------------------
1324 ---------------------------------------------------------
1326 # disable clicking on workspace buttons
1328 # execute custom script when scrolling downwards
1329 bindsym button5 exec ~/.i3/scripts/custom_wheel_down
1331 ---------------------------------------------------------
1335 Specifies the bar ID for the configured bar instance. If this option is missing,
1336 the ID is set to 'bar-x', where x corresponds to the position of the embedding
1337 bar block in the config file ('bar-0', 'bar-1', ...).
1340 ---------------------
1342 ---------------------
1345 ---------------------
1349 ---------------------
1354 This option determines in which edge of the screen i3bar should show up.
1356 The default is bottom.
1364 ---------------------
1368 ---------------------
1372 You can restrict i3bar to one or more outputs (monitors). The default is to
1373 handle all outputs. Restricting the outputs is useful for using different
1374 options for different outputs by using multiple 'bar' blocks.
1376 To make a particular i3bar instance handle multiple outputs, specify the output
1377 directive multiple times.
1385 -------------------------------
1386 # big monitor: everything
1388 # The display is connected either via HDMI or via DisplayPort
1391 status_command i3status
1394 # laptop monitor: bright colors and i3status with less modules.
1397 status_command i3status --config ~/.i3status-small.conf
1403 -------------------------------
1407 i3bar by default provides a system tray area where programs such as
1408 NetworkManager, VLC, Pidgin, etc. can place little icons.
1410 You can configure on which output (monitor) the icons should be displayed or
1411 you can turn off the functionality entirely.
1413 You can use multiple +tray_output+ directives in your config to specify a list
1414 of outputs on which you want the tray to appear. The first available output in
1415 that list as defined by the order of the directives will be used for the tray
1419 ---------------------------------
1420 tray_output none|primary|<output>
1421 ---------------------------------
1424 -------------------------
1425 # disable system tray
1430 # show tray icons on the primary monitor
1435 # show tray icons on the big monitor
1439 -------------------------
1441 Note that you might not have a primary output configured yet. To do so, run:
1442 -------------------------
1443 xrandr --output <output> --primary
1444 -------------------------
1446 Note that when you use multiple bar configuration blocks, either specify
1447 `tray_output primary` in all of them or explicitly specify `tray_output none`
1448 in bars which should not display the tray, otherwise the different instances
1449 might race each other in trying to display tray icons.
1453 The tray is shown on the right-hand side of the bar. By default, a padding of 2
1454 pixels is used for the upper, lower and right-hand side of the tray area and
1455 between the individual icons.
1458 -------------------------
1459 tray_padding <px> [px]
1460 -------------------------
1463 -------------------------
1466 -------------------------
1470 Specifies the font to be used in the bar. See <<fonts>>.
1473 ---------------------
1475 ---------------------
1478 --------------------------------------------------------------
1480 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1481 font pango:DejaVu Sans Mono 10
1483 --------------------------------------------------------------
1485 === Custom separator symbol
1487 Specifies a custom symbol to be used for the separator as opposed to the vertical,
1488 one pixel thick separator.
1491 -------------------------
1492 separator_symbol <symbol>
1493 -------------------------
1496 ------------------------
1498 separator_symbol ":|:"
1500 ------------------------
1502 === Workspace buttons
1504 Specifies whether workspace buttons should be shown or not. This is useful if
1505 you want to display a statusline-only bar containing additional information.
1507 The default is to show workspace buttons.
1510 ------------------------
1511 workspace_buttons yes|no
1512 ------------------------
1515 ------------------------
1517 workspace_buttons no
1519 ------------------------
1521 === Strip workspace numbers
1523 Specifies whether workspace numbers should be displayed within the workspace
1524 buttons. This is useful if you want to have a named workspace that stays in
1525 order on the bar according to its number without displaying the number prefix.
1527 When +strip_workspace_numbers+ is set to +yes+, any workspace that has a name of
1528 the form "[n]:[NAME]" will display only the name. You could use this, for
1529 instance, to display Roman numerals rather than digits by naming your
1530 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
1532 The default is to display the full name within the workspace button.
1535 ------------------------------
1536 strip_workspace_numbers yes|no
1537 ------------------------------
1540 ----------------------------
1542 strip_workspace_numbers yes
1544 ----------------------------
1546 === Binding Mode indicator
1548 Specifies whether the current binding mode indicator should be shown or not.
1549 This is useful if you want to hide the workspace buttons but still be able
1550 to see the current binding mode indicator. See <<binding_modes>> to learn what
1551 modes are and how to use them.
1553 The default is to show the mode indicator.
1556 -----------------------------
1557 binding_mode_indicator yes|no
1558 -----------------------------
1561 -----------------------------
1563 binding_mode_indicator no
1565 -----------------------------
1569 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1570 be configured at the moment:
1573 Background color of the bar.
1575 Text color to be used for the statusline.
1577 Text color to be used for the separator.
1578 focused_background::
1579 Background color of the bar on the currently focused monitor output. If
1580 not used, the color will be taken from +background+.
1581 focused_statusline::
1582 Text color to be used for the statusline on the currently focused
1583 monitor output. If not used, the color will be taken from +statusline+.
1585 Text color to be used for the separator on the currently focused
1586 monitor output. If not used, the color will be taken from +separator+.
1588 Border, background and text color for a workspace button when the workspace
1591 Border, background and text color for a workspace button when the workspace
1592 is active (visible) on some output, but the focus is on another one.
1593 You can only tell this apart from the focused workspace when you are
1594 using multiple monitors.
1595 inactive_workspace::
1596 Border, background and text color for a workspace button when the workspace
1597 does not have focus and is not active (visible) on any output. This
1598 will be the case for most workspaces.
1600 Border, background and text color for a workspace button when the workspace
1601 contains a window with the urgency hint set.
1603 Border, background and text color for the binding mode indicator. If not used,
1604 the colors will be taken from +urgent_workspace+.
1607 ----------------------------------------
1613 <colorclass> <border> <background> <text>
1615 ----------------------------------------
1617 *Example (default colors)*:
1618 --------------------------------------
1625 focused_workspace #4c7899 #285577 #ffffff
1626 active_workspace #333333 #5f676a #ffffff
1627 inactive_workspace #333333 #222222 #888888
1628 urgent_workspace #2f343a #900000 #ffffff
1629 binding_mode #2f343a #900000 #ffffff
1632 --------------------------------------
1636 Commands are what you bind to specific keypresses. You can also issue commands
1637 at runtime without pressing a key by using the IPC interface. An easy way to
1638 do this is to use the +i3-msg+ utility:
1641 --------------------------
1642 # execute this on your shell to make the current container borderless
1644 --------------------------
1646 [[command_chaining]]
1648 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1649 specific workspace and immediately switch to that workspace, you can configure
1650 the following keybinding:
1653 --------------------------------------------------------
1654 bindsym $mod+x move container to workspace 3; workspace 3
1655 --------------------------------------------------------
1657 [[command_criteria]]
1659 Furthermore, you can change the scope of a command - that is, which containers
1660 should be affected by that command, by using various criteria. The criteria
1661 are specified before any command in a pair of square brackets and are separated
1664 When using multiple commands, separate them by using a +,+ (a comma) instead of
1665 a semicolon. Criteria apply only until the next semicolon, so if you use a
1666 semicolon to separate commands, only the first one will be executed for the
1670 ------------------------------------
1671 # if you want to kill all windows which have the class Firefox, use:
1672 bindsym $mod+x [class="Firefox"] kill
1674 # same thing, but case-insensitive
1675 bindsym $mod+x [class="(?i)firefox"] kill
1677 # kill only the About dialog from Firefox
1678 bindsym $mod+x [class="Firefox" window_role="About"] kill
1680 # enable floating mode and move container to workspace 4
1681 for_window [class="^evil-app$"] floating enable, move container to workspace 4
1682 ------------------------------------
1684 The criteria which are currently implemented are:
1687 Compares the window class (the second part of WM_CLASS). Use the
1688 special value +\_\_focused__+ to match all windows having the same window
1689 class as the currently focused window.
1691 Compares the window instance (the first part of WM_CLASS). Use the
1692 special value +\_\_focused__+ to match all windows having the same window
1693 instance as the currently focused window.
1695 Compares the window role (WM_WINDOW_ROLE). Use the special value
1696 +\_\_focused__+ to match all windows having the same window role as the
1697 currently focused window.
1699 Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
1700 +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+,
1701 +popup_menu+, +tooltip+ and +notification+.
1703 Compares the X11 window ID, which you can get via +xwininfo+ for example.
1705 Compares the X11 window title (\_NET_WM_NAME or WM_NAME as fallback).
1706 Use the special value +\_\_focused__+ to match all windows having the
1707 same window title as the currently focused window.
1709 Compares the urgent state of the window. Can be "latest" or "oldest".
1710 Matches the latest or oldest urgent window, respectively.
1711 (The following aliases are also available: newest, last, recent, first)
1713 Compares the workspace name of the workspace the window belongs to. Use
1714 the special value +\_\_focused__+ to match all windows in the currently
1717 Compares the marks set for this container, see <<vim_like_marks>>. A
1718 match is made if any of the container's marks matches the specified
1721 Compares the i3-internal container ID, which you can get via the IPC
1722 interface. Handy for scripting. Use the special value +\_\_focused__+
1723 to match only the currently focused window.
1725 The criteria +class+, +instance+, +role+, +title+, +workspace+ and +mark+ are
1726 actually regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1727 information on how to use them.
1730 === Executing applications (exec)
1732 What good is a window manager if you can’t actually start any applications?
1733 The exec command starts an application by passing the command you specify to a
1734 shell. This implies that you can use globbing (wildcards) and programs will be
1735 searched in your +$PATH+.
1737 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
1738 and +,+ (comma): they chain commands together in i3, so you need to use quoted
1739 strings (as shown in <<exec_quoting>>) if they appear in your command.
1742 --------------------------------
1743 exec [--no-startup-id] <command>
1744 --------------------------------
1747 ------------------------------
1749 bindsym $mod+g exec gimp
1751 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1752 bindsym $mod+Return exec --no-startup-id urxvt
1753 ------------------------------
1755 The +--no-startup-id+ parameter disables startup-notification support for this
1756 particular exec command. With startup-notification, i3 can make sure that a
1757 window appears on the workspace on which you used the exec command. Also, it
1758 will change the X11 cursor to +watch+ (a clock) while the application is
1759 launching. So, if an application is not startup-notification aware (most GTK
1760 and Qt using applications seem to be, though), you will end up with a watch
1761 cursor for 60 seconds.
1764 If the command to be executed contains a +;+ (semicolon) and/or a +,+ (comma),
1765 the entire command must be quoted. For example, to have a keybinding for the
1766 shell command +notify-send Hello, i3+, you would add an entry to your
1767 configuration file like this:
1770 ------------------------------
1771 # Execute a command with a comma in it
1772 bindsym $mod+p exec "notify-send Hello, i3"
1773 ------------------------------
1775 If however a command with a comma and/or semicolon itself requires quotes, you
1776 must escape the internal quotation marks with double backslashes, like this:
1779 ------------------------------
1780 # Execute a command with a comma, semicolon and internal quotes
1781 bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\""
1782 ------------------------------
1784 === Splitting containers
1786 The split command makes the current window a split container. Split containers
1787 can contain multiple windows. Depending on the layout of the split container,
1788 new windows get placed to the right of the current one (splith) or new windows
1789 get placed below the current one (splitv).
1791 If you apply this command to a split container with the same orientation,
1792 nothing will happen. If you use a different orientation, the split container’s
1793 orientation will be changed (if it does not have more than one window).
1794 The +toggle+ option will toggle the orientation of the split container if it
1795 contains a single window. Otherwise it makes the current window a split
1796 container with opposite orientation compared to the parent container.
1797 Use +layout toggle split+ to change the layout of any split container from
1798 splitv to splith or vice-versa.
1801 --------------------------------
1802 split vertical|horizontal|toggle
1803 --------------------------------
1806 -------------------------------
1807 bindsym $mod+v split vertical
1808 bindsym $mod+h split horizontal
1809 bindsym $mod+t split toggle
1810 -------------------------------
1812 === Manipulating layout
1814 Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
1815 or +layout splith+ to change the current container layout to splith/splitv,
1816 stacking, tabbed layout, splitv or splith, respectively.
1818 To make the current window (!) fullscreen, use +fullscreen enable+ (or
1819 +fullscreen enable global+ for the global mode), to leave either fullscreen
1820 mode use +fullscreen disable+, and to toggle between these two states use
1821 +fullscreen toggle+ (or +fullscreen toggle global+).
1823 Likewise, to make the current window floating (or tiling again) use +floating
1824 enable+ respectively +floating disable+ (or +floating toggle+):
1827 --------------------------------------------
1828 layout default|tabbed|stacking|splitv|splith
1829 layout toggle [split|all]
1830 --------------------------------------------
1834 bindsym $mod+s layout stacking
1835 bindsym $mod+l layout toggle split
1836 bindsym $mod+w layout tabbed
1838 # Toggle between stacking/tabbed/split:
1839 bindsym $mod+x layout toggle
1841 # Toggle between stacking/tabbed/splith/splitv:
1842 bindsym $mod+x layout toggle all
1845 bindsym $mod+f fullscreen toggle
1847 # Toggle floating/tiling
1848 bindsym $mod+t floating toggle
1851 [[_focusing_moving_containers]]
1852 === Focusing containers
1854 To change focus, you can use the +focus+ command. The following options are
1857 left|right|up|down::
1858 Sets focus to the nearest container in the given direction.
1860 Sets focus to the parent container of the current container.
1862 The opposite of +focus parent+, sets the focus to the last focused
1865 Sets focus to the last focused floating container.
1867 Sets focus to the last focused tiling container.
1869 Toggles between floating/tiling containers.
1871 Followed by a direction or an output name, this will focus the
1872 corresponding output.
1875 ----------------------------------------------
1876 focus left|right|down|up
1877 focus parent|child|floating|tiling|mode_toggle
1878 focus output left|right|up|down|<output>
1879 ----------------------------------------------
1882 -------------------------------------------------
1883 # Focus container on the left, bottom, top, right
1884 bindsym $mod+j focus left
1885 bindsym $mod+k focus down
1886 bindsym $mod+l focus up
1887 bindsym $mod+semicolon focus right
1889 # Focus parent container
1890 bindsym $mod+u focus parent
1892 # Focus last floating/tiling container
1893 bindsym $mod+g focus mode_toggle
1895 # Focus the output right to the current one
1896 bindsym $mod+x focus output right
1898 # Focus the big output
1899 bindsym $mod+x focus output HDMI-2
1900 -------------------------------------------------
1902 === Moving containers
1904 Use the +move+ command to move a container.
1907 -----------------------------------------------------
1908 # Moves the container into the given direction.
1909 # The optional pixel argument specifies how far the
1910 # container should be moved if it is floating and
1911 # defaults to 10 pixels.
1912 move <left|right|down|up> [<px> px]
1914 # Moves the container either to a specific location
1915 # or to the center of the screen. If 'absolute' is
1916 # used, it is moved to the center of all outputs.
1917 move [absolute] position [[<px> px] [<px> px]|center]
1919 # Moves the container to the current position of the
1920 # mouse cursor. Only affects floating containers.
1922 -----------------------------------------------------
1925 -------------------------------------------------------
1926 # Move container to the left, bottom, top, right
1927 bindsym $mod+j move left
1928 bindsym $mod+k move down
1929 bindsym $mod+l move up
1930 bindsym $mod+semicolon move right
1932 # Move container, but make floating containers
1933 # move more than the default
1934 bindsym $mod+j move left 20 px
1936 # Move floating container to the center of all outputs
1937 bindsym $mod+c move absolute position center
1939 # Move container to the current position of the cursor
1940 bindsym $mod+m move position mouse
1941 -------------------------------------------------------
1943 === Sticky floating windows
1945 If you want a window to stick to the glass, i.e., have it stay on screen even
1946 if you switch to another workspace, you can use the +sticky+ command. For
1947 example, this can be useful for notepads, a media player or a video chat
1950 Note that while any window can be made sticky through this command, it will
1951 only take effect if the window is floating.
1954 ----------------------------
1955 sticky enable|disable|toggle
1956 ----------------------------
1959 ------------------------------------------------------
1960 # make a terminal sticky that was started as a notepad
1961 for_window [instance=notepad] sticky enable
1962 ------------------------------------------------------
1964 === Changing (named) workspaces/moving to workspaces
1966 To change to a specific workspace, use the +workspace+ command, followed by the
1967 number or name of the workspace. Pass the optional flag
1968 +--no-auto-back-and-forth+ to disable <<back_and_forth>> for this specific call
1971 To move containers to specific workspaces, use +move container to workspace+.
1973 You can also switch to the next and previous workspace with the commands
1974 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1975 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1976 combination. To restrict those to the current output, use +workspace
1977 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1978 container to workspace next+, +move container to workspace prev+ to move a
1979 container to the next/previous workspace and +move container to workspace current+
1980 (the last one makes sense only when used with criteria).
1982 +workspace next+ cycles through either numbered or named workspaces. But when it
1983 reaches the last numbered/named workspace, it looks for named workspaces after
1984 exhausting numbered ones and looks for numbered ones after exhausting named ones.
1986 See <<move_to_outputs>> for how to move a container/workspace to a different
1989 Workspace names are parsed as
1990 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
1994 To switch back to the previously focused workspace, use +workspace
1995 back_and_forth+; likewise, you can move containers to the previously focused
1996 workspace using +move container to workspace back_and_forth+.
1999 --------------------------------------------------------------------------------
2000 workspace next|prev|next_on_output|prev_on_output
2001 workspace back_and_forth
2002 workspace [--no-auto-back-and-forth] <name>
2003 workspace [--no-auto-back-and-forth] number <name>
2005 move [--no-auto-back-and-forth] [window|container] [to] workspace <name>
2006 move [--no-auto-back-and-forth] [window|container] [to] workspace number <name>
2007 move [window|container] [to] workspace prev|next|current
2008 --------------------------------------------------------------------------------
2011 -------------------------
2012 bindsym $mod+1 workspace 1
2013 bindsym $mod+2 workspace 2
2014 bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
2017 bindsym $mod+Shift+1 move container to workspace 1
2018 bindsym $mod+Shift+2 move container to workspace 2
2021 # switch between the current and the previously focused one
2022 bindsym $mod+b workspace back_and_forth
2023 bindsym $mod+Shift+b move container to workspace back_and_forth
2025 # move the whole workspace to the next output
2026 bindsym $mod+x move workspace to output right
2028 # move firefox to current workspace
2029 bindsym $mod+F1 [class="Firefox"] move workspace current
2030 -------------------------
2032 ==== Named workspaces
2034 Workspaces are identified by their name. So, instead of using numbers in the
2035 workspace command, you can use an arbitrary name:
2038 -------------------------
2039 bindsym $mod+1 workspace mail
2041 -------------------------
2043 If you want the workspace to have a number *and* a name, just prefix the
2047 -------------------------
2048 bindsym $mod+1 workspace 1: mail
2049 bindsym $mod+2 workspace 2: www
2051 -------------------------
2053 Note that the workspace will really be named "1: mail". i3 treats workspace
2054 names beginning with a number in a slightly special way. Normally, named
2055 workspaces are ordered the way they appeared. When they start with a number, i3
2056 will order them numerically. Also, you will be able to use +workspace number 1+
2057 to switch to the workspace which begins with number 1, regardless of which name
2058 it has. This is useful in case you are changing the workspace’s name
2059 dynamically. To combine both commands you can use +workspace number 1: mail+ to
2060 specify a default name if there's currently no workspace starting with a "1".
2062 ==== Renaming workspaces
2064 You can rename workspaces. This might be useful to start with the default
2065 numbered workspaces, do your work, and rename the workspaces afterwards to
2066 reflect what’s actually on them. You can also omit the old name to rename
2067 the currently focused workspace. This is handy if you want to use the
2068 rename command with +i3-input+.
2071 ----------------------------------------------------
2072 rename workspace <old_name> to <new_name>
2073 rename workspace to <new_name>
2074 ----------------------------------------------------
2077 --------------------------------------------------------------------------
2078 i3-msg 'rename workspace 5 to 6'
2079 i3-msg 'rename workspace 1 to "1: www"'
2080 i3-msg 'rename workspace "1: www" to "10: www"'
2081 i3-msg 'rename workspace to "2: mail"'
2082 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
2083 --------------------------------------------------------------------------
2085 === Moving workspaces to a different screen
2087 See <<move_to_outputs>> for how to move a container/workspace to a different
2091 === Moving containers/workspaces to RandR outputs
2093 To move a container to another RandR output (addressed by names like +LVDS1+ or
2094 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
2095 +right+, +up+ or +down+), there are two commands:
2098 ----------------------------------------------------
2099 move container to output left|right|down|up|<output>
2100 move workspace to output left|right|down|up|<output>
2101 ----------------------------------------------------
2104 --------------------------------------------------------
2105 # Move the current workspace to the next output
2106 # (effectively toggles when you only have two outputs)
2107 bindsym $mod+x move workspace to output right
2109 # Put this window on the presentation output.
2110 bindsym $mod+x move container to output VGA1
2111 --------------------------------------------------------
2113 === Moving containers/windows to marks
2115 To move a container to another container with a specific mark (see <<vim_like_marks>>),
2116 you can use the following command.
2118 The window will be moved right after the marked container in the tree, i.e., it ends up
2119 in the same position as if you had opened a new window when the marked container was
2120 focused. If the mark is on a split container, the window will appear as a new child
2121 after the currently focused child within that container.
2124 ------------------------------------
2125 move window|container to mark <mark>
2126 ------------------------------------
2129 --------------------------------------------------------
2130 for_window [instance="tabme"] move window to mark target
2131 --------------------------------------------------------
2134 === Resizing containers/windows
2136 If you want to resize containers/windows using your keyboard, you can use the
2140 -------------------------------------------------------
2141 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
2142 resize set <width> [px] <height> [px]
2143 -------------------------------------------------------
2145 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
2146 less specific and use +width+ or +height+, in which case i3 will take/give
2147 space from all the other containers. The optional pixel argument specifies by
2148 how many pixels a *floating container* should be grown or shrunk (the default
2149 is 10 pixels). The ppt argument means percentage points and specifies by how
2150 many percentage points a *tiling container* should be grown or shrunk (the
2151 default is 10 percentage points). Note that +resize set+ will only work for
2152 floating containers.
2154 It is recommended to define bindings for resizing in a dedicated binding mode.
2155 See <<binding_modes>> and the example in the i3
2156 https://github.com/i3/i3/blob/next/i3.config.keycodes[default config] for more
2160 ------------------------------------------------
2161 for_window [class="urxvt"] resize set 640 480
2162 ------------------------------------------------
2164 === Jumping to specific windows
2166 Often when in a multi-monitor environment, you want to quickly jump to a
2167 specific window. For example, while working on workspace 3 you may want to
2168 jump to your mail client to email your boss that you’ve achieved some
2169 important goal. Instead of figuring out how to navigate to your mail client,
2170 it would be more convenient to have a shortcut. You can use the +focus+ command
2171 with criteria for that.
2174 ----------------------------------------------------
2175 [class="class"] focus
2176 [title="title"] focus
2177 ----------------------------------------------------
2180 ------------------------------------------------
2181 # Get me to the next open VIM instance
2182 bindsym $mod+a [class="urxvt" title="VIM"] focus
2183 ------------------------------------------------
2186 === VIM-like marks (mark/goto)
2188 This feature is like the jump feature: It allows you to directly jump to a
2189 specific window (this means switching to the appropriate workspace and setting
2190 focus to the windows). However, you can directly mark a specific window with
2191 an arbitrary label and use it afterwards. You can unmark the label in the same
2192 way, using the unmark command. If you don't specify a label, unmark removes all
2193 marks. You do not need to ensure that your windows have unique classes or
2194 titles, and you do not need to change your configuration file.
2196 As the command needs to include the label with which you want to mark the
2197 window, you cannot simply bind it to a key. +i3-input+ is a tool created
2198 for this purpose: It lets you input a command and sends the command to i3. It
2199 can also prefix this command and display a custom prompt for the input dialog.
2201 The additional +--toggle+ option will remove the mark if the window already has
2202 this mark or add it otherwise. Note that you may need to use this in
2203 combination with +--add+ (see below) as any other marks will otherwise be
2206 By default, a window can only have one mark. You can use the +--add+ flag to
2207 put more than one mark on a window.
2209 Refer to <<show_marks>> if you don't want marks to be shown in the window decoration.
2212 ----------------------------------------------
2213 mark [--add|--replace] [--toggle] <identifier>
2214 [con_mark="identifier"] focus
2216 ----------------------------------------------
2218 *Example (in a terminal)*:
2219 ---------------------------------------------------------
2220 # marks the focused container
2223 # focus the container with the mark "irssi"
2224 '[con_mark="irssi"] focus'
2226 # remove the mark "irssi" from whichever container has it
2229 # remove all marks on all firefox windows
2230 [class="(?i)firefox"] unmark
2231 ---------------------------------------------------------
2233 ///////////////////////////////////////////////////////////////////
2234 TODO: make i3-input replace %s
2236 ---------------------------------------
2237 # Read 1 character and mark the current window with this character
2238 bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
2240 # Read 1 character and go to the window with the character
2241 bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
2242 ---------------------------------------
2244 Alternatively, if you do not want to mess with +i3-input+, you could create
2245 separate bindings for a specific set of labels and then only use those labels.
2246 ///////////////////////////////////////////////////////////////////
2249 === Window title format
2251 By default, i3 will simply print the X11 window title. Using +title_format+,
2252 this can be customized by setting the format to the desired output. This
2254 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
2255 and the following placeholders which will be replaced:
2258 For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME
2259 as fallback). When used on containers without a window (e.g., a split
2260 container inside a tabbed/stacked layout), this will be the tree
2261 representation of the container (e.g., "H[xterm xterm]").
2263 The X11 window class (second part of WM_CLASS). This corresponds to the
2264 +class+ criterion, see <<command_criteria>>.
2266 The X11 window instance (first part of WM_CLASS). This corresponds to the
2267 +instance+ criterion, see <<command_criteria>>.
2269 Using the <<for_window>> directive, you can set the title format for any window
2270 based on <<command_criteria>>.
2273 ---------------------
2274 title_format <format>
2275 ---------------------
2278 -------------------------------------------------------------------------------------
2279 # give the focused window a prefix
2280 bindsym $mod+p title_format "Important | %title"
2282 # print all window titles bold
2283 for_window [class=".*"] title_format "<b>%title</b>"
2285 # print window titles of firefox windows red
2286 for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"
2287 -------------------------------------------------------------------------------------
2289 === Changing border style
2291 To change the border of the current client, you can use +border normal+ to use the normal
2292 border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
2293 and +border none+ to make the client borderless.
2295 There is also +border toggle+ which will toggle the different border styles.
2297 Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel
2298 may be represented by multiple physical pixels, so +pixel 1+ might not
2299 necessarily translate into a single pixel row wide border.
2302 -----------------------------------------------
2303 border normal|pixel [<n>]
2306 # legacy syntax, equivalent to "border pixel 1"
2308 -----------------------------------------------
2311 ----------------------------------------------
2312 # use window title, but no border
2313 bindsym $mod+t border normal 0
2314 # use no window title and a thick border
2315 bindsym $mod+y border pixel 3
2316 # use neither window title nor border
2317 bindsym $mod+u border none
2318 ----------------------------------------------
2321 === Enabling shared memory logging
2323 As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared
2324 memory buffer, which you can dump using +i3-dump-log+. The +shmlog+ command
2325 allows you to enable or disable the shared memory logging at runtime.
2327 Note that when using +shmlog <size_in_bytes>+, the current log will be
2328 discarded and a new one will be started.
2331 ------------------------------
2332 shmlog <size_in_bytes>
2333 shmlog on|off|toggle
2334 ------------------------------
2338 # Enable/disable logging
2339 bindsym $mod+x shmlog toggle
2341 # or, from a terminal:
2342 # increase the shared memory log buffer to 50 MiB
2343 i3-msg shmlog $((50*1024*1024))
2346 === Enabling debug logging
2348 The +debuglog+ command allows you to enable or disable debug logging at
2349 runtime. Debug logging is much more verbose than non-debug logging. This
2350 command does not activate shared memory logging (shmlog), and as such is most
2351 likely useful in combination with the above-described <<shmlog>> command.
2354 ----------------------
2355 debuglog on|off|toggle
2356 ----------------------
2359 ------------------------
2360 # Enable/disable logging
2361 bindsym $mod+x debuglog toggle
2362 ------------------------
2364 === Reloading/Restarting/Exiting
2366 You can make i3 reload its configuration file with +reload+. You can also
2367 restart i3 inplace with the +restart+ command to get it out of some weird state
2368 (if that should ever happen) or to perform an upgrade without having to restart
2369 your X session. To exit i3 properly, you can use the +exit+ command,
2370 however you don’t need to (simply killing your X session is fine as well).
2373 ----------------------------
2374 bindsym $mod+Shift+r restart
2375 bindsym $mod+Shift+w reload
2376 bindsym $mod+Shift+e exit
2377 ----------------------------
2381 There are two commands to use any existing window as scratchpad window. +move
2382 scratchpad+ will move a window to the scratchpad workspace. This will make it
2383 invisible until you show it again. There is no way to open that workspace.
2384 Instead, when using +scratchpad show+, the window will be shown again, as a
2385 floating window, centered on your current workspace (using +scratchpad show+ on
2386 a visible scratchpad window will make it hidden again, so you can have a
2387 keybinding to toggle). Note that this is just a normal floating window, so if
2388 you want to "remove it from scratchpad", you can simple make it tiling again
2389 (+floating toggle+).
2391 As the name indicates, this is useful for having a window with your favorite
2392 editor always at hand. However, you can also use this for other permanently
2393 running applications which you don’t want to see all the time: Your music
2394 player, alsamixer, maybe even your mail client…?
2404 ------------------------------------------------
2405 # Make the currently focused window a scratchpad
2406 bindsym $mod+Shift+minus move scratchpad
2408 # Show the first scratchpad window
2409 bindsym $mod+minus scratchpad show
2411 # Show the sup-mail scratchpad window, if any.
2412 bindsym mod4+s [title="^Sup ::"] scratchpad show
2413 ------------------------------------------------
2417 There is a no operation command +nop+ which allows you to override default
2418 behavior. This can be useful for, e.g., disabling a focus change on clicks with
2419 the middle mouse button.
2421 The optional +comment+ argument is ignored, but will be printed to the log file
2422 for debugging purposes.
2430 ----------------------------------------------
2431 # Disable focus change for clicks on titlebars
2432 # with the middle mouse button
2434 ----------------------------------------------
2438 There are two options in the configuration of each i3bar instance that can be
2439 changed during runtime by invoking a command through i3. The commands +bar
2440 hidden_state+ and +bar mode+ allow setting the current hidden_state
2441 respectively mode option of each bar. It is also possible to toggle between
2442 hide state and show state as well as between dock mode and hide mode. Each
2443 i3bar instance can be controlled individually by specifying a bar_id, if none
2444 is given, the command is executed for all bar instances.
2448 bar hidden_state hide|show|toggle [<bar_id>]
2450 bar mode dock|hide|invisible|toggle [<bar_id>]
2454 ------------------------------------------------
2455 # Toggle between hide state and show state
2456 bindsym $mod+m bar hidden_state toggle
2458 # Toggle between dock mode and hide mode
2459 bindsym $mod+n bar mode toggle
2461 # Set the bar instance with id 'bar-1' to switch to hide mode
2462 bindsym $mod+b bar mode hide bar-1
2464 # Set the bar instance with id 'bar-1' to always stay hidden
2465 bindsym $mod+Shift+b bar mode invisible bar-1
2466 ------------------------------------------------
2469 == Multiple monitors
2471 As you can see in the goal list on the website, i3 was specifically developed
2472 with support for multiple monitors in mind. This section will explain how to
2473 handle multiple monitors.
2475 When you have only one monitor, things are simple. You usually start with
2476 workspace 1 on your monitor and open new ones as you need them.
2478 When you have more than one monitor, each monitor will get an initial
2479 workspace. The first monitor gets 1, the second gets 2 and a possible third
2480 would get 3. When you switch to a workspace on a different monitor, i3 will
2481 switch to that monitor and then switch to the workspace. This way, you don’t
2482 need shortcuts to switch to a specific monitor, and you don’t need to remember
2483 where you put which workspace. New workspaces will be opened on the currently
2484 active monitor. It is not possible to have a monitor without a workspace.
2486 The idea of making workspaces global is based on the observation that most
2487 users have a very limited set of workspaces on their additional monitors.
2488 They are often used for a specific task (browser, shell) or for monitoring
2489 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
2490 and "the rest" on the other monitors often makes sense. However, as you can
2491 create an unlimited number of workspaces in i3 and tie them to specific
2492 screens, you can have the "traditional" approach of having X workspaces per
2493 screen by changing your configuration (using modes, for example).
2495 === Configuring your monitors
2497 To help you get going if you have never used multiple monitors before, here is
2498 a short overview of the xrandr options which will probably be of interest to
2499 you. It is always useful to get an overview of the current screen configuration.
2500 Just run "xrandr" and you will get an output like the following:
2501 -------------------------------------------------------------------------------
2503 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
2504 VGA1 disconnected (normal left inverted right x axis y axis)
2505 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
2506 1280x800 60.0*+ 50.0
2507 1024x768 85.0 75.0 70.1 60.0
2509 800x600 85.1 72.2 75.0 60.3 56.2
2510 640x480 85.0 72.8 75.0 59.9
2514 --------------------------------------------------------------------------------------
2516 Several things are important here: You can see that +LVDS1+ is connected (of
2517 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
2518 connected to one of the ports but xrandr still says "disconnected", you should
2519 check your cable, monitor or graphics driver.
2521 The maximum resolution you can see at the end of the first line is the maximum
2522 combined resolution of your monitors. By default, it is usually too low and has
2523 to be increased by editing +/etc/X11/xorg.conf+.
2525 So, say you connected VGA1 and want to use it as an additional screen:
2526 -------------------------------------------
2527 xrandr --output VGA1 --auto --left-of LVDS1
2528 -------------------------------------------
2529 This command makes xrandr try to find the native resolution of the device
2530 connected to +VGA1+ and configures it to the left of your internal flat panel.
2531 When running "xrandr" again, the output looks like this:
2532 -------------------------------------------------------------------------------
2534 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
2535 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
2536 1280x1024 60.0*+ 75.0
2539 1024x768 75.1 70.1 60.0
2541 800x600 72.2 75.0 60.3 56.2
2542 640x480 72.8 75.0 66.7 60.0
2544 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
2545 1280x800 60.0*+ 50.0
2546 1024x768 85.0 75.0 70.1 60.0
2548 800x600 85.1 72.2 75.0 60.3 56.2
2549 640x480 85.0 72.8 75.0 59.9
2553 -------------------------------------------------------------------------------
2554 Please note that i3 uses exactly the same API as xrandr does, so it will see
2555 only what you can see in xrandr.
2557 See also <<presentations>> for more examples of multi-monitor setups.
2559 === Interesting configuration for multi-monitor environments
2561 There are several things to configure in i3 which may be interesting if you
2562 have more than one monitor:
2564 1. You can specify which workspace should be put on which screen. This
2565 allows you to have a different set of workspaces when starting than just
2566 1 for the first monitor, 2 for the second and so on. See
2567 <<workspace_screen>>.
2568 2. If you want some applications to generally open on the bigger screen
2569 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
2570 <<assign_workspace>>.
2571 3. If you have many workspaces on many monitors, it might get hard to keep
2572 track of which window you put where. Thus, you can use vim-like marks to
2573 quickly switch between windows. See <<vim_like_marks>>.
2574 4. For information on how to move existing workspaces between monitors,
2575 see <<_moving_containers_workspaces_to_randr_outputs>>.
2577 == i3 and the rest of your software world
2579 === Displaying a status line
2581 A very common thing amongst users of exotic window managers is a status line at
2582 some corner of the screen. It is an often superior replacement to the widget
2583 approach you have in the task bar of a traditional desktop environment.
2585 If you don’t already have your favorite way of generating such a status line
2586 (self-written scripts, conky, …), then i3status is the recommended tool for
2587 this task. It was written in C with the goal of using as few syscalls as
2588 possible to reduce the time your CPU is woken up from sleep states. Because
2589 i3status only spits out text, you need to combine it with some other tool, like
2590 i3bar. See <<status_command>> for how to display i3status in i3bar.
2592 Regardless of which application you use to display the status line, you
2593 want to make sure that it registers as a dock window using EWMH hints. i3 will
2594 position the window either at the top or at the bottom of the screen, depending
2595 on which hint the application sets. With i3bar, you can configure its position,
2596 see <<i3bar_position>>.
2599 === Giving presentations (multi-monitor)
2601 When giving a presentation, you typically want the audience to see what you see
2602 on your screen and then go through a series of slides (if the presentation is
2603 simple). For more complex presentations, you might want to have some notes
2604 which only you can see on your screen, while the audience can only see the
2607 ==== Case 1: everybody gets the same output
2608 This is the simple case. You connect your computer to the video projector,
2609 turn on both (computer and video projector) and configure your X server to
2610 clone the internal flat panel of your computer to the video output:
2611 -----------------------------------------------------
2612 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
2613 -----------------------------------------------------
2614 i3 will then use the lowest common subset of screen resolutions, the rest of
2615 your screen will be left untouched (it will show the X background). So, in
2616 our example, this would be 1024x768 (my notebook has 1280x800).
2618 ==== Case 2: you can see more than your audience
2619 This case is a bit harder. First of all, you should configure the VGA output
2620 somewhere near your internal flat panel, say right of it:
2621 -----------------------------------------------------
2622 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
2623 -----------------------------------------------------
2624 Now, i3 will put a new workspace (depending on your settings) on the new screen
2625 and you are in multi-monitor mode (see <<multi_monitor>>).
2627 Because i3 is not a compositing window manager, there is no ability to
2628 display a window on two screens at the same time. Instead, your presentation
2629 software needs to do this job (that is, open a window on each screen).