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 http://faq.i3wm.org/ first, then
8 contact us on IRC (preferred) or post your question(s) on the mailing list.
10 == Default keybindings
12 For the "too long; didn’t read" people, here is an overview of the default
13 keybindings (click to see the full size image):
15 *Keys to use with $mod (Alt):*
17 image:keyboard-layer1.png["Keys to use with $mod (Alt)",width=600,link="keyboard-layer1.png"]
19 *Keys to use with Shift+$mod:*
21 image:keyboard-layer2.png["Keys to use with Shift+$mod",width=600,link="keyboard-layer2.png"]
23 The red keys are the modifiers you need to press (by default), the blue keys
28 Throughout this guide, the keyword +$mod+ will be used to refer to the
29 configured modifier. This is the Alt key (Mod1) by default, with the Windows
30 key (Mod4) being a popular alternative.
32 === Opening terminals and moving around
34 One very basic operation is opening a new terminal. By default, the keybinding
35 for this is $mod+Enter, that is Alt+Enter in the default configuration. By
36 pressing $mod+Enter, a new terminal will be opened. It will fill the whole
37 space available on your screen.
39 image:single_terminal.png[Single terminal]
41 If you now open another terminal, i3 will place it next to the current one,
42 splitting the screen size in half. Depending on your monitor, i3 will put the
43 created window beside the existing window (on wide displays) or below the
44 existing window (rotated displays).
46 image:two_terminals.png[Two terminals]
48 To move the focus between the two terminals, you can use the direction keys
49 which you may know from the editor +vi+. However, in i3, your homerow is used
50 for these keys (in +vi+, the keys are shifted to the left by one for
51 compatibility with most keyboard layouts). Therefore, +$mod+J+ is left, +$mod+K+
52 is down, +$mod+L+ is up and `$mod+;` is right. So, to switch between the
53 terminals, use +$mod+K+ or +$mod+L+. Of course, you can also use the arrow keys.
55 At the moment, your workspace is split (it contains two terminals) in a
56 specific direction (horizontal by default). Every window can be split
57 horizontally or vertically again, just like the workspace. The terminology is
58 "window" for a container that actually contains an X11 window (like a terminal
59 or browser) and "split container" for containers that consist of one or more
62 TODO: picture of the tree
64 To split a window vertically, press +$mod+v+ before you create the new window.
65 To split it horizontally, press +$mod+h+.
67 === Changing the container layout
69 A split container can have one of the following layouts:
72 Windows are sized so that every window gets an equal amount of space in the
73 container. splith distributes the windows horizontally (windows are right next
74 to each other), splitv distributes them vertically (windows are on top of each
77 Only the focused window in the container is displayed. You get a list of
78 windows at the top of the container.
80 The same principle as +stacking+, but the list of windows at the top is only
81 a single line which is vertically split.
83 To switch modes, press +$mod+e+ for splith/splitv (it toggles), +$mod+s+ for
84 stacking and +$mod+w+ for tabbed.
86 image:modes.png[Container modes]
88 === Toggling fullscreen mode for a window
90 To display a window in fullscreen mode or to go out of fullscreen mode again,
93 There is also a global fullscreen mode in i3 in which the client will span all
94 available outputs (the command is +fullscreen toggle global+).
96 === Opening other applications
98 Aside from opening applications from a terminal, you can also use the handy
99 +dmenu+ which is opened by pressing +$mod+d+ by default. Just type the name
100 (or a part of it) of the application which you want to open. The corresponding
101 application has to be in your +$PATH+ for this to work.
103 Additionally, if you have applications you open very frequently, you can
104 create a keybinding for starting the application directly. See the section
105 <<configuring>> for details.
109 If an application does not provide a mechanism for closing (most applications
110 provide a menu, the escape key or a shortcut like +Control+W+ to close), you
111 can press +$mod+Shift+q+ to kill a window. For applications which support
112 the WM_DELETE protocol, this will correctly close the application (saving
113 any modifications or doing other cleanup). If the application doesn’t support
114 the WM_DELETE protocol your X server will kill the window and the behaviour
115 depends on the application.
119 Workspaces are an easy way to group a set of windows. By default, you are on
120 the first workspace, as the bar on the bottom left indicates. To switch to
121 another workspace, press +$mod+num+ where +num+ is the number of the workspace
122 you want to use. If the workspace does not exist yet, it will be created.
124 A common paradigm is to put the web browser on one workspace, communication
125 applications (+mutt+, +irssi+, ...) on another one, and the ones with which you
126 work, on the third one. Of course, there is no need to follow this approach.
128 If you have multiple screens, a workspace will be created on each screen at
129 startup. If you open a new workspace, it will be bound to the screen you
130 created it on. When you switch to a workspace on another screen, i3 will set
131 focus to that screen.
133 === Moving windows to workspaces
135 To move a window to another workspace, simply press +$mod+Shift+num+ where
136 +num+ is (like when switching workspaces) the number of the target workspace.
137 Similarly to switching workspaces, the target workspace will be created if
138 it does not yet exist.
142 The easiest way to resize a container is by using the mouse: Grab the border
143 and move it to the wanted size.
145 See <<resizingconfig>> for how to configure i3 to be able to resize
146 columns/rows with your keyboard.
148 === Restarting i3 inplace
150 To restart i3 in place (and thus get into a clean state if there is a bug, or
151 to upgrade to a newer version of i3) you can use +$mod+Shift+r+.
155 To cleanly exit i3 without killing your X server, you can use +$mod+Shift+e+.
156 By default, a dialog will ask you to confirm if you really want to quit.
160 Floating mode is the opposite of tiling mode. The position and size of
161 a window are not managed automatically by i3, but manually by
162 you. Using this mode violates the tiling paradigm but can be useful
163 for some corner cases like "Save as" dialog windows, or toolbar
164 windows (GIMP or similar). Those windows usually set the appropriate
165 hint and are opened in floating mode by default.
167 You can toggle floating mode for a window by pressing +$mod+Shift+Space+. By
168 dragging the window’s titlebar with your mouse you can move the window
169 around. By grabbing the borders and moving them you can resize the window. You
170 can also do that by using the <<floating_modifier>>. Another way to resize
171 floating windows using the mouse is to right-click on the titlebar and drag.
173 For resizing floating windows with your keyboard, see <<resizingconfig>>.
175 Floating windows are always on top of tiling windows.
179 i3 stores all information about the X11 outputs, workspaces and layout of the
180 windows on them in a tree. The root node is the X11 root window, followed by
181 the X11 outputs, then dock areas and a content container, then workspaces and
182 finally the windows themselves. In previous versions of i3 we had multiple lists
183 (of outputs, workspaces) and a table for each workspace. That approach turned
184 out to be complicated to use (snapping), understand and implement.
186 === The tree consists of Containers
188 The building blocks of our tree are so called +Containers+. A +Container+ can
189 host a window (meaning an X11 window, one that you can actually see and use,
190 like a browser). Alternatively, it could contain one or more +Containers+. A
191 simple example is the workspace: When you start i3 with a single monitor, a
192 single workspace and you open two terminal windows, you will end up with a tree
195 image::tree-layout2.png["layout2",float="right"]
196 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
198 === Orientation and Split Containers
202 It is only natural to use so-called +Split Containers+ in order to build a
203 layout when using a tree as data structure. In i3, every +Container+ has an
204 orientation (horizontal, vertical or unspecified) and the orientation depends
205 on the layout the container is in (vertical for splitv and stacking, horizontal
206 for splith and tabbed). So, in our example with the workspace, the default
207 layout of the workspace +Container+ is splith (most monitors are widescreen
208 nowadays). If you change the layout to splitv (+$mod+v+ in the default config)
209 and *then* open two terminals, i3 will configure your windows like this:
211 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
213 An interesting new feature of i3 since version 4 is the ability to split anything:
214 Let’s assume you have two terminals on a workspace (with splith layout, that is
215 horizontal orientation), focus is on the right terminal. Now you want to open
216 another terminal window below the current one. If you would just open a new
217 terminal window, it would show up to the right due to the splith layout.
218 Instead, press +$mod+v+ to split the container with the splitv layout (to
219 open a +Horizontal Split Container+, use +$mod+h+). Now you can open a new
220 terminal and it will open below the current one:
222 image::tree-layout1.png["Layout",float="right"]
223 image::tree-shot1.png["shot",title="Vertical Split Container"]
227 You probably guessed it already: There is no limit on how deep your hierarchy
232 Let’s stay with our example from above. We have a terminal on the left and two
233 vertically split terminals on the right, focus is on the bottom right one. When
234 you open a new terminal, it will open below the current one.
236 So, how can you open a new terminal window to the *right* of the current one?
237 The solution is to use +focus parent+, which will focus the +Parent Container+ of
238 the current +Container+. In this case, you would focus the +Vertical Split
239 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
240 windows will be opened to the right of the +Vertical Split Container+:
242 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
244 === Implicit containers
246 In some cases, i3 needs to implicitly create a container to fulfill your
249 One example is the following scenario: You start i3 with a single monitor and a
250 single workspace on which you open three terminal windows. All these terminal
251 windows are directly attached to one node inside i3’s layout tree, the
252 workspace node. By default, the workspace node’s orientation is +horizontal+.
254 Now you move one of these terminals down (+$mod+Shift+k+ by default). The
255 workspace node’s orientation will be changed to +vertical+. The terminal window
256 you moved down is directly attached to the workspace and appears on the bottom
257 of the screen. A new (horizontal) container was created to accommodate the
258 other two terminal windows. You will notice this when switching to tabbed mode
259 (for example). You would end up having one tab with a representation of the split
260 container (e.g., "H[urxvt firefox]") and the other one being the terminal window
266 This is where the real fun begins ;-). Most things are very dependent on your
267 ideal working environment so we can’t make reasonable defaults for them.
269 While not using a programming language for the configuration, i3 stays
270 quite flexible in regards to the things you usually want your window manager
273 For example, you can configure bindings to jump to specific windows,
274 you can set specific applications to start on specific workspaces, you can
275 automatically start applications, you can change the colors of i3, and you
276 can bind your keys to do useful things.
278 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
279 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
282 On first start (and on all following starts, unless you have a configuration
283 file), i3 will offer you to create a configuration file. You can tell the
284 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
285 file. Also, the created config file will use the key symbols of your current
286 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
287 Please note that you must not have +~/.i3/config+, otherwise the wizard will
292 It is possible and recommended to use comments in your configuration file to
293 properly document your setup for later reference. Comments are started with
294 a # and can only be used at the beginning of a line:
305 i3 has support for both X core fonts and FreeType fonts (through Pango) to
306 render window titles.
308 To generate an X core font description, you can use +xfontsel(1)+. To see
309 special characters (Unicode), you need to use a font which supports the
312 A FreeType font description is composed by a font family, a style, a weight,
313 a variant, a stretch and a size.
314 FreeType fonts support right-to-left rendering and contain often more
315 Unicode glyphs than X core fonts.
317 If i3 cannot open the configured font, it will output an error in the logfile
318 and fall back to a working font.
321 ------------------------------
322 font <X core font description>
323 font pango:[family list] [style options] [size]
324 ------------------------------
327 --------------------------------------------------------------
328 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
329 font pango:DejaVu Sans Mono 10
330 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
331 font pango:Terminus 11px
332 --------------------------------------------------------------
336 === Keyboard bindings
338 A keyboard binding makes i3 execute a command (see below) upon pressing a
339 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
340 also mix your bindings, though i3 will not protect you from overlapping ones).
342 * A keysym (key symbol) is a description for a specific symbol, like "a"
343 or "b", but also more strange ones like "underscore" instead of "_". These
344 are the ones you use in Xmodmap to remap your keys. To get the current
345 mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
346 see what keysym it is configured to, use +xev+.
348 * Keycodes do not need to have a symbol assigned (handy for custom vendor
349 hotkeys on some notebooks) and they will not change their meaning as you
350 switch to a different keyboard layout (when using +xmodmap+).
352 My recommendation is: If you often switch keyboard layouts but you want to keep
353 your bindings in the same physical location on the keyboard, use keycodes.
354 If you don’t switch layouts, and want a clean and simple config file, use
357 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
358 KeyPress event, because the keyboard/pointer is still grabbed. For these
359 situations, the +--release+ flag can be used, which will execute the command
360 after the keys have been released.
363 ----------------------------------
364 bindsym [--release] [Modifiers+]keysym command
365 bindcode [--release] [Modifiers+]keycode command
366 ----------------------------------
369 --------------------------------
371 bindsym $mod+f fullscreen toggle
374 bindsym $mod+Shift+r restart
376 # Notebook-specific hotkeys
377 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
379 # Simulate ctrl+v upon pressing $mod+x
380 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
382 # Take a screenshot upon pressing $mod+x (select an area)
383 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
384 --------------------------------
388 Mod1-Mod5, Shift, Control::
389 Standard modifiers, see +xmodmap(1)+
392 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
393 you to remap capslock (for example) to Mode_switch and use it for both: typing
394 umlauts or special characters 'and' having some comfortably reachable key
395 bindings. For example, when typing, capslock+1 or capslock+2 for switching
396 workspaces is totally convenient. Try it :-).
402 A mouse binding makes i3 execute a command upon pressing a specific mouse
403 button in the scope of the clicked container (see <<command_criteria>>). You
404 can configure mouse bindings in a similar way to key bindings.
407 ----------------------------------
408 bindsym [--release] [--border] [--whole-window] [Modifiers+]button[n] command
409 ----------------------------------
411 By default, the binding will only run when you click on the titlebar of the
412 window. If the +--release+ flag is given, it will run when the mouse button
415 If the +--whole-window+ flag is given, the binding will also run when any part
416 of the window is clicked, with the exception of the border. To have a bind run
417 when the border is clicked, specify the +--border+ flag.
420 --------------------------------
421 # The middle button over a titlebar kills the window
422 bindsym --release button2 kill
424 # The middle button and a modifer over any part of the window kills the window
425 bindsym --whole-window $mod+button2 kill
427 # The right button toggles floating
428 bindsym button3 floating toggle
429 bindsym $mod+button3 floating toggle
431 # The side buttons move the window around
432 bindsym button9 move left
433 bindsym button8 move right
434 --------------------------------
436 [[floating_modifier]]
438 === The floating modifier
440 To move floating windows with your mouse, you can either grab their titlebar
441 or configure the so called floating modifier which you can then press and
442 click anywhere in the window itself to move it. The most common setup is to
443 use the same key you use for managing windows (Mod1 for example). Then
444 you can press Mod1, click into a window using your left mouse button, and drag
445 it to the position you want.
447 When holding the floating modifier, you can resize a floating window by
448 pressing the right mouse button on it and moving around while holding it. If
449 you hold the shift button as well, the resize will be proportional (the aspect
450 ratio will be preserved).
453 --------------------------------
454 floating_modifier <Modifiers>
455 --------------------------------
458 --------------------------------
459 floating_modifier Mod1
460 --------------------------------
462 === Constraining floating window size
464 The maximum and minimum dimensions of floating windows can be specified. If
465 either dimension of +floating_maximum_size+ is specified as -1, that dimension
466 will be unconstrained with respect to its maximum value. If either dimension of
467 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
468 value to constrain the maximum size. +floating_minimum_size+ is treated in a
469 manner analogous to +floating_maximum_size+.
472 ----------------------------------------
473 floating_minimum_size <width> x <height>
474 floating_maximum_size <width> x <height>
475 ----------------------------------------
478 --------------------------------------
479 floating_minimum_size 75 x 50
480 floating_maximum_size -1 x -1
481 --------------------------------------
483 === Orientation for new workspaces
485 New workspaces get a reasonable default orientation: Wide-screen monitors
486 (anything wider than high) get horizontal orientation, rotated monitors
487 (anything higher than wide) get vertical orientation.
489 With the +default_orientation+ configuration directive, you can override that
493 ----------------------------------------------
494 default_orientation <horizontal|vertical|auto>
495 ----------------------------------------------
498 ----------------------------
499 default_orientation vertical
500 ----------------------------
502 === Layout mode for new containers
504 This option determines in which mode new containers on workspace level will
506 ///////////////////////////////
507 See also <<stack-limit>>.
508 //////////////////////////////
511 ---------------------------------------------
512 workspace_layout <default|stacking|tabbed>
513 ---------------------------------------------
514 /////////////////////////////////////////////
515 new_container stack-limit <cols|rows> <value>
516 /////////////////////////////////////////////
519 ---------------------
520 workspace_layout tabbed
521 ---------------------
523 === Border style for new windows
525 This option determines which border style new windows will have. The default is
526 "normal". Note that new_float applies only to windows which are starting out as
527 floating windows, e.g. dialog windows.
530 ---------------------------------------------
531 new_window <normal|1pixel|none|pixel>
532 new_float <normal|1pixel|none|pixel>
533 ---------------------------------------------
536 ---------------------
538 ---------------------
540 The "normal" and "pixel" border styles support an optional border width in
544 ---------------------
545 # The same as new_window none
550 ---------------------
553 === Hiding vertical borders
555 You can hide vertical borders adjacent to the screen edges using
556 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
557 to waste even two pixels in displayspace. Default is none.
560 ----------------------------
561 hide_edge_borders <none|vertical|horizontal|both>
562 ----------------------------
565 ----------------------
566 hide_edge_borders vertical
567 ----------------------
569 === Arbitrary commands for specific windows (for_window)
571 With the +for_window+ command, you can let i3 execute any command when it
572 encounters a specific window. This can be used to set windows to floating or to
573 change their border style, for example.
576 -----------------------------
577 for_window <criteria> command
578 -----------------------------
581 ------------------------------------------------
582 # enable floating mode for all XTerm windows
583 for_window [class="XTerm"] floating enable
585 # Make all urxvts use a 1-pixel border:
586 for_window [class="urxvt"] border 1pixel
588 # A less useful, but rather funny example:
589 # makes the window floating as soon as I change
590 # directory to ~/work
591 for_window [title="x200: ~/work"] floating enable
592 ------------------------------------------------
594 The valid criteria are the same as those for commands, see <<command_criteria>>.
596 === Don't focus window upon opening
600 When a new window appears, it will be focused. The +no_focus+ directive allows preventing
601 this from happening and can be used in combination with <<command_criteria>>.
603 Note that this does not apply to all cases, e.g., when feeding data into a running application
604 causing it to request being focused. To configure the behavior in such cases, refer to
605 <<focus_on_window_activation>>.
613 -------------------------------
614 no_focus [window_role="pop-up"]
615 -------------------------------
619 As you learned in the section about keyboard bindings, you will have
620 to configure lots of bindings containing modifier keys. If you want to save
621 yourself some typing and be able to change the modifier you use later,
622 variables can be handy.
630 ------------------------
632 bindsym $m+Shift+r restart
633 ------------------------
635 Variables are directly replaced in the file when parsing. Variables expansion
636 is not recursive so it is not possible to define a variable with a value
637 containing another variable. There is no fancy handling and there are
638 absolutely no plans to change this. If you need a more dynamic configuration
639 you should create a little script which generates a configuration file and run
640 it before starting i3 (for example in your +~/.xsession+ file).
642 === Automatically putting clients on specific workspaces
646 To automatically make a specific window show up on a specific workspace, you
647 can use an *assignment*. You can match windows by using any criteria,
648 see <<command_criteria>>. It is recommended that you match on window classes
649 (and instances, when appropriate) instead of window titles whenever possible
650 because some applications first create their window, and then worry about
651 setting the correct title. Firefox with Vimperator comes to mind. The window
652 starts up being named Firefox, and only when Vimperator is loaded does the
653 title change. As i3 will get the title as soon as the application maps the
654 window (mapping means actually displaying it on the screen), you’d need to have
655 to match on 'Firefox' in this case.
657 Assignments are processed by i3 in the order in which they appear in the config
658 file. The first one which matches the window wins and later assignments are not
662 ------------------------------------------------------------
663 assign <criteria> [→] workspace
664 ------------------------------------------------------------
667 ----------------------
668 # Assign URxvt terminals to workspace 2
669 assign [class="URxvt"] 2
671 # Same thing, but more precise (exact match instead of substring)
672 assign [class="^URxvt$"] 2
674 # Same thing, but with a beautiful arrow :)
675 assign [class="^URxvt$"] → 2
677 # Assignment to a named workspace
678 assign [class="^URxvt$"] → work
680 # Start urxvt -name irssi
681 assign [class="^URxvt$" instance="^irssi$"] → 3
682 ----------------------
684 Note that the arrow is not required, it just looks good :-). If you decide to
685 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
687 To get the class and instance, you can use +xprop+. After clicking on the
688 window, you will see the following output:
691 -----------------------------------
692 WM_CLASS(STRING) = "irssi", "URxvt"
693 -----------------------------------
695 The first part of the WM_CLASS is the instance ("irssi" in this example), the
696 second part is the class ("URxvt" in this example).
698 Should you have any problems with assignments, make sure to check the i3
699 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
700 details about the matching process and the window’s actual class, instance and
701 title when starting up.
703 Note that if you want to start an application just once on a specific
704 workspace, but you don’t want to assign all instances of it permanently, you
705 can make use of i3’s startup-notification support (see <<exec>>) in your config
706 file in the following way:
708 *Start iceweasel on workspace 3 (once)*:
709 -------------------------------------------------------------------------------
710 # Start iceweasel on workspace 3, then switch back to workspace 1
711 # (Being a command-line utility, i3-msg does not support startup notifications,
712 # hence the exec --no-startup-id.)
713 # (Starting iceweasel with i3’s exec command is important in order to make i3
714 # create a startup notification context, without which the iceweasel window(s)
715 # cannot be matched onto the workspace on which the command was started.)
716 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
717 -------------------------------------------------------------------------------
719 === Automatically starting applications on i3 startup
721 By using the +exec+ keyword outside a keybinding, you can configure
722 which commands will be performed by i3 on initial startup. +exec+
723 commands will not run when restarting i3, if you need a command to run
724 also when restarting i3 you should use the +exec_always+
725 keyword. These commands will be run in order.
727 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
728 and +,+ (comma): they chain commands together in i3 and need to be escaped if
729 you want to use them in your command.
733 exec [--no-startup-id] command
734 exec_always [--no-startup-id] command
738 --------------------------------
740 exec_always ~/my_script.sh
742 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
743 exec --no-startup-id urxvt
744 --------------------------------
746 The flag --no-startup-id is explained in <<exec>>.
750 === Automatically putting workspaces on specific screens
752 If you assign clients to workspaces, it might be handy to put the
753 workspaces on specific screens. Also, the assignment of workspaces to screens
754 will determine which workspace i3 uses for a new screen when adding screens
755 or when starting (e.g., by default it will use 1 for the first screen, 2 for
756 the second screen and so on).
759 ----------------------------------
760 workspace <workspace> output <output>
761 ----------------------------------
763 The 'output' is the name of the RandR output you attach your screen to. On a
764 laptop, you might have VGA1 and LVDS1 as output names. You can see the
765 available outputs by running +xrandr --current+.
767 If you use named workspaces, they must be quoted:
770 ---------------------------
771 workspace 1 output LVDS1
772 workspace 5 output VGA1
773 workspace "2: vim" output VGA1
774 ---------------------------
778 You can change all colors which i3 uses to draw the window decorations.
781 --------------------------------------------
782 colorclass border background text indicator
783 --------------------------------------------
785 Where colorclass can be one of:
788 A client which currently has the focus.
789 client.focused_inactive::
790 A client which is the focused one of its container, but it does not have
791 the focus at the moment.
793 A client which is not the focused one of its container.
795 A client which has its urgency hint activated.
797 Background and text color are used to draw placeholder window contents
798 (when restoring layouts). Border and indicator are ignored.
800 You can also specify the color to be used to paint the background of the client
801 windows. This color will be used to paint the window on top of which the client
805 -----------------------
806 client.background color
807 -----------------------
809 Only clients that do not cover the whole area of this window expose the color
812 Colors are in HTML hex format (#rrggbb), see the following example:
814 *Examples (default colors)*:
815 ---------------------------------------------------------
816 # class border backgr. text indicator
817 client.focused #4c7899 #285577 #ffffff #2e9ef4
818 client.focused_inactive #333333 #5f676a #ffffff #484e50
819 client.unfocused #333333 #222222 #888888 #292d2e
820 client.urgent #2f343a #900000 #ffffff #900000
821 client.placeholder #000000 #0c0c0c #ffffff #000000
822 ---------------------------------------------------------
824 Note that for the window decorations, the color around the child window is the
825 background color, and the border color is only the two thin lines at the top of
828 The indicator color is used for indicating where a new window will be opened.
829 For horizontal split containers, the right border will be painted in indicator
830 color, for vertical split containers, the bottom border. This only applies to
831 single windows within a split container, which are otherwise indistinguishable
832 from single windows outside of a split container.
834 === Interprocess communication
836 i3 uses Unix sockets to provide an IPC interface. This allows third-party
837 programs to get information from i3, such as the current workspaces
838 (to display a workspace bar), and to control i3.
840 The IPC socket is enabled by default and will be created in
841 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
842 the PID of i3 and XXXXXX is a string of random characters from the portable
843 filename character set (see mkdtemp(3)).
845 You can override the default path through the environment-variable +I3SOCK+ or
846 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
847 does the right thing by default. If you decide to change it, it is strongly
848 recommended to set this to a location in your home directory so that no other
849 user can create that directory.
852 ----------------------------
853 ipc-socket ~/.i3/i3-ipc.sock
854 ----------------------------
856 You can then use the +i3-msg+ application to perform any command listed in
859 === Focus follows mouse
861 By default, window focus follows your mouse movements. However, if you have a
862 setup where your mouse usually is in your way (like a touchpad on your laptop
863 which you do not want to disable completely), you might want to disable 'focus
864 follows mouse' and control focus only by using your keyboard. The mouse will
865 still be useful inside the currently active window (for example to click on
866 links in your browser window).
869 ----------------------------
870 focus_follows_mouse <yes|no>
871 ----------------------------
874 ----------------------
875 focus_follows_mouse no
876 ----------------------
880 By default, when switching focus to a window on a different output (e.g.
881 focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on
882 LVDS-1), the mouse cursor is warped to the center of that window.
884 With the +mouse_warping+ option, you can control when the mouse cursor should
885 be warped. +none+ disables warping entirely, whereas +output+ is the default
886 behavior described above.
889 ---------------------------
890 mouse_warping <output|none>
891 ---------------------------
898 === Popups during fullscreen mode
900 When you are in fullscreen mode, some applications still open popup windows
901 (take Xpdf for example). This is because these applications may not be aware
902 that they are in fullscreen mode (they do not check the corresponding hint).
903 There are three things which are possible to do in this situation:
905 1. Display the popup if it belongs to the fullscreen application only. This is
906 the default and should be reasonable behavior for most users.
907 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
908 in fullscreen. However, some apps might react badly to this (deadlock until
909 you go out of fullscreen).
910 3. Leave fullscreen mode.
913 -------------------------------------------------
914 popup_during_fullscreen <smart|ignore|leave_fullscreen>
915 -------------------------------------------------
918 ------------------------------
919 popup_during_fullscreen smart
920 ------------------------------
924 When being in a tabbed or stacked container, the first container will be
925 focused when you use +focus down+ on the last container -- the focus wraps. If
926 however there is another stacked/tabbed container in that direction, focus will
927 be set on that container. This is the default behavior so you can navigate to
928 all your windows without having to use +focus parent+.
930 If you want the focus to *always* wrap and you are aware of using +focus
931 parent+ to switch to different containers, you can use the
932 +force_focus_wrapping+ configuration directive. After enabling it, the focus
936 -----------------------------
937 force_focus_wrapping <yes|no>
938 -----------------------------
941 ------------------------
942 force_focus_wrapping yes
943 ------------------------
947 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
948 video drivers (especially the nVidia binary driver) only provide support for
949 Xinerama instead of RandR. In such a situation, i3 must be told to use the
950 inferior Xinerama API explicitly and therefore don’t provide support for
951 reconfiguring your screens on the fly (they are read only once on startup and
954 For people who cannot modify their +~/.xsession+ to add the
955 +--force-xinerama+ commandline parameter, a configuration option is provided:
958 -----------------------
959 force_xinerama <yes|no>
960 -----------------------
967 Also note that your output names are not descriptive (like +HDMI1+) when using
968 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
970 === Automatic back-and-forth when switching to the current workspace
972 This configuration directive enables automatic +workspace back_and_forth+ (see
973 <<back_and_forth>>) when switching to the workspace that is currently focused.
975 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
976 mod+2 because somebody sent you a message. You don’t need to remember where you
977 came from now, you can just press $mod+2 again to switch back to "1: www".
980 --------------------------------------
981 workspace_auto_back_and_forth <yes|no>
982 --------------------------------------
985 ---------------------------------
986 workspace_auto_back_and_forth yes
987 ---------------------------------
989 === Delaying urgency hint reset on workspace change
991 If an application on another workspace sets an urgency hint, switching to this
992 workspace may lead to immediate focus of the application, which also means the
993 window decoration color would be immediately reset to +client.focused+. This
994 may make it unnecessarily hard to tell which window originally raised the
997 In order to prevent this, you can tell i3 to delay resetting the urgency state
998 by a certain time using the +force_display_urgency_hint+ directive. Setting the
999 value to 0 disables this feature.
1001 The default is 500ms.
1004 ---------------------------------------
1005 force_display_urgency_hint <timeout> ms
1006 ---------------------------------------
1009 ---------------------------------
1010 force_display_urgency_hint 500 ms
1011 ---------------------------------
1013 === Focus on window activation
1015 [[focus_on_window_activation]]
1017 If a window is activated, e.g., via +google-chrome www.google.com+, it may request
1018 to take focus. Since this may not preferable, different reactions can be configured.
1020 Note that this may not affect windows that are being opened. To prevent new windows
1021 from being focused, see <<no_focus>>.
1024 ----------------------------------------------------
1025 focus_on_window_activation <smart|urgent|focus|none>
1026 ----------------------------------------------------
1028 The different modes will act as follows:
1031 This is the default behavior. If the window requesting focus is on an active
1032 workspace, it will receive the focus. Otherwise, the urgency hint will be set.
1034 The window will always be marked urgent, but the focus will not be stolen.
1036 The window will always be focused and not be marked urgent.
1038 The window will neither be focused, nor be marked urgent.
1040 === Drawing marks on window decoration
1042 If activated, marks on windows are drawn in their window decoration. However,
1043 any mark starting with an underscore in its name (+_+) will not be drawn even if
1044 this option is activated.
1046 The default for this option is +yes+.
1058 == Configuring i3bar
1060 The bar at the bottom of your monitor is drawn by a separate process called
1061 i3bar. Having this part of "the i3 user interface" in a separate process has
1064 1. It is a modular approach. If you don’t need a workspace bar at all, or if
1065 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
1066 just remove the i3bar configuration and start your favorite bar instead.
1067 2. It follows the UNIX philosophy of "Make each program do one thing well".
1068 While i3 manages your windows well, i3bar is good at displaying a bar on
1069 each monitor (unless you configure it otherwise).
1070 3. It leads to two separate, clean codebases. If you want to understand i3, you
1071 don’t need to bother with the details of i3bar and vice versa.
1073 That said, i3bar is configured in the same configuration file as i3. This is
1074 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
1075 are useful for people using other window managers). Therefore, it makes no
1076 sense to use a different configuration place when we already have a good
1077 configuration infrastructure in place.
1079 Configuring your workspace bar starts with opening a +bar+ block. You can have
1080 multiple bar blocks to use different settings for different outputs (monitors):
1083 ---------------------------
1085 status_command i3status
1087 ---------------------------
1091 By default i3 will just pass +i3bar+ and let your shell handle the execution,
1092 searching your +$PATH+ for a correct version.
1093 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
1094 tell i3 what to execute.
1096 The specified command will be passed to +sh -c+, so you can use globbing and
1097 have to have correct quoting etc.
1100 ----------------------
1101 i3bar_command command
1102 ----------------------
1105 -------------------------------------------------
1107 i3bar_command /home/user/bin/i3bar
1109 -------------------------------------------------
1112 === Statusline command
1114 i3bar can run a program and display every line of its +stdout+ output on the
1115 right hand side of the bar. This is useful to display system information like
1116 your current IP address, battery status or date/time.
1118 The specified command will be passed to +sh -c+, so you can use globbing and
1119 have to have correct quoting etc.
1122 ----------------------
1123 status_command command
1124 ----------------------
1127 -------------------------------------------------
1129 status_command i3status --config ~/.i3status.conf
1131 -------------------------------------------------
1135 You can either have i3bar be visible permanently at one edge of the screen
1136 (+dock+ mode) or make it show up when you press your modifier key (+hide+ mode).
1137 It is also possible to force i3bar to always stay hidden (+invisible+
1138 mode). The modifier key can be configured using the +modifier+ option.
1140 The mode option can be changed during runtime through the +bar mode+ command.
1141 On reload the mode will be reverted to its configured value.
1143 The hide mode maximizes screen space that can be used for actual windows. Also,
1144 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1147 Invisible mode allows to permanently maximize screen space, as the bar is never
1148 shown. Thus, you can configure i3bar to not disturb you by popping up because
1149 of an urgency hint or because the modifier key is pressed.
1151 In order to control whether i3bar is hidden or shown in hide mode, there exists
1152 the hidden_state option, which has no effect in dock mode or invisible mode. It
1153 indicates the current hidden_state of the bar: (1) The bar acts like in normal
1154 hide mode, it is hidden and is only unhidden in case of urgency hints or by
1155 pressing the modifier key (+hide+ state), or (2) it is drawn on top of the
1156 currently visible workspace (+show+ state).
1158 Like the mode, the hidden_state can also be controlled through i3, this can be
1159 done by using the +bar hidden_state+ command.
1161 The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
1162 the windows key). The default value for the hidden_state is hide.
1166 mode <dock|hide|invisible>
1167 hidden_state <hide|show>
1180 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
1182 === Mouse button commands
1184 Specifies a command to run when a button was pressed on i3bar to override the
1185 default behavior. Currently only the mouse wheel buttons are supported. This is
1186 useful for disabling the scroll wheel action or running scripts that implement
1187 custom behavior for these buttons.
1190 ---------------------
1191 wheel_up_cmd <command>
1192 wheel_down_cmd <command>
1193 ---------------------
1196 ---------------------
1199 wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down
1201 ---------------------
1205 Specifies the bar ID for the configured bar instance. If this option is missing,
1206 the ID is set to 'bar-x', where x corresponds to the position of the embedding
1207 bar block in the config file ('bar-0', 'bar-1', ...).
1210 ---------------------
1212 ---------------------
1215 ---------------------
1219 ---------------------
1224 This option determines in which edge of the screen i3bar should show up.
1226 The default is bottom.
1229 ---------------------
1230 position <top|bottom>
1231 ---------------------
1234 ---------------------
1238 ---------------------
1242 You can restrict i3bar to one or more outputs (monitors). The default is to
1243 handle all outputs. Restricting the outputs is useful for using different
1244 options for different outputs by using multiple 'bar' blocks.
1246 To make a particular i3bar instance handle multiple outputs, specify the output
1247 directive multiple times.
1255 -------------------------------
1256 # big monitor: everything
1258 # The display is connected either via HDMI or via DisplayPort
1261 status_command i3status
1264 # laptop monitor: bright colors and i3status with less modules.
1267 status_command i3status --config ~/.i3status-small.conf
1273 -------------------------------
1277 i3bar by default provides a system tray area where programs such as
1278 NetworkManager, VLC, Pidgin, etc. can place little icons.
1280 You can configure on which output (monitor) the icons should be displayed or
1281 you can turn off the functionality entirely.
1284 -------------------------
1285 tray_output <none|primary|output>
1286 -------------------------
1289 -------------------------
1290 # disable system tray
1295 # show tray icons on the primary monitor
1298 # show tray icons on the big monitor
1302 -------------------------
1304 Note that you might not have a primary output configured yet. To do so, run:
1305 -------------------------
1306 xrandr --output <output> --primary
1307 -------------------------
1311 Specifies the font to be used in the bar. See <<fonts>>.
1314 ---------------------
1316 ---------------------
1319 --------------------------------------------------------------
1321 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1322 font pango:DejaVu Sans Mono 10
1324 --------------------------------------------------------------
1326 === Custom separator symbol
1328 Specifies a custom symbol to be used for the separator as opposed to the vertical,
1329 one pixel thick separator.
1332 -------------------------
1333 separator_symbol <symbol>
1334 -------------------------
1337 ------------------------
1339 separator_symbol ":|:"
1341 ------------------------
1343 === Workspace buttons
1345 Specifies whether workspace buttons should be shown or not. This is useful if
1346 you want to display a statusline-only bar containing additional information.
1348 The default is to show workspace buttons.
1351 --------------------------
1352 workspace_buttons <yes|no>
1353 --------------------------
1356 ------------------------
1358 workspace_buttons no
1360 ------------------------
1362 === Strip workspace numbers
1364 Specifies whether workspace numbers should be displayed within the workspace
1365 buttons. This is useful if you want to have a named workspace that stays in
1366 order on the bar according to its number without displaying the number prefix.
1368 When +strip_workspace_numbers+ is set to +yes+, any workspace that has a name of
1369 the form "[n]:[NAME]" will display only the name. You could use this, for
1370 instance, to display Roman numerals rather than digits by naming your
1371 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
1373 The default is to display the full name within the workspace button.
1376 ----------------------------------
1377 strip_workspace_numbers <yes|no>
1378 ----------------------------------
1381 ----------------------------
1383 strip_workspace_numbers yes
1385 ----------------------------
1387 === Binding Mode indicator
1389 Specifies whether the current binding mode indicator should be shown or not.
1390 This is useful if you want to hide the workspace buttons but still be able
1391 to see the current binding mode indicator.
1392 For an example of a +mode+ definition, see <<resizingconfig>>.
1394 The default is to show the mode indicator.
1397 -------------------------------
1398 binding_mode_indicator <yes|no>
1399 -------------------------------
1402 -----------------------------
1404 binding_mode_indicator no
1406 -----------------------------
1410 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1411 be configured at the moment:
1414 Background color of the bar.
1416 Text color to be used for the statusline.
1418 Text color to be used for the separator.
1420 Border, background and text color for a workspace button when the workspace
1423 Border, background and text color for a workspace button when the workspace
1424 is active (visible) on some output, but the focus is on another one.
1425 You can only tell this apart from the focused workspace when you are
1426 using multiple monitors.
1427 inactive_workspace::
1428 Border, background and text color for a workspace button when the workspace
1429 does not have focus and is not active (visible) on any output. This
1430 will be the case for most workspaces.
1432 Border, background and text color for a workspace button when the workspace
1433 contains a window with the urgency hint set. Also applies to +mode+ indicators.
1436 ----------------------------------------
1442 colorclass <border> <background> <text>
1444 ----------------------------------------
1446 *Example (default colors)*:
1447 --------------------------------------
1454 focused_workspace #4c7899 #285577 #ffffff
1455 active_workspace #333333 #5f676a #ffffff
1456 inactive_workspace #333333 #222222 #888888
1457 urgent_workspace #2f343a #900000 #ffffff
1460 --------------------------------------
1464 Commands are what you bind to specific keypresses. You can also issue commands
1465 at runtime without pressing a key by using the IPC interface. An easy way to
1466 do this is to use the +i3-msg+ utility:
1469 --------------------------
1470 # execute this on your shell to make the current container borderless
1472 --------------------------
1474 [[command_chaining]]
1476 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1477 specific workspace and immediately switch to that workspace, you can configure
1478 the following keybinding:
1481 --------------------------------------------------------
1482 bindsym $mod+x move container to workspace 3; workspace 3
1483 --------------------------------------------------------
1485 [[command_criteria]]
1487 Furthermore, you can change the scope of a command - that is, which containers
1488 should be affected by that command, by using various criteria. The criteria
1489 are specified before any command in a pair of square brackets and are separated
1492 When using multiple commands, separate them by using a +,+ (a comma) instead of
1493 a semicolon. Criteria apply only until the next semicolon, so if you use a
1494 semicolon to separate commands, only the first one will be executed for the
1498 ------------------------------------
1499 # if you want to kill all windows which have the class Firefox, use:
1500 bindsym $mod+x [class="Firefox"] kill
1502 # same thing, but case-insensitive
1503 bindsym $mod+x [class="(?i)firefox"] kill
1505 # kill only the About dialog from Firefox
1506 bindsym $mod+x [class="Firefox" window_role="About"] kill
1508 # enable floating mode and move container to workspace 4
1509 for_window [class="^evil-app$"] floating enable, move container to workspace 4
1510 ------------------------------------
1512 The criteria which are currently implemented are:
1515 Compares the window class (the second part of WM_CLASS)
1517 Compares the window instance (the first part of WM_CLASS)
1519 Compares the window role (WM_WINDOW_ROLE).
1521 Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
1522 +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+,
1523 +popup_menu+ and +toolti+.
1525 Compares the X11 window ID, which you can get via +xwininfo+ for example.
1527 Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
1529 Compares the urgent state of the window. Can be "latest" or "oldest".
1530 Matches the latest or oldest urgent window, respectively.
1531 (The following aliases are also available: newest, last, recent, first)
1533 Compares the mark set for this container, see <<vim_like_marks>>.
1535 Compares the i3-internal container ID, which you can get via the IPC
1536 interface. Handy for scripting.
1538 The criteria +class+, +instance+, +role+, +title+ and +mark+ are actually
1539 regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1540 information on how to use them.
1544 === Executing applications (exec)
1546 What good is a window manager if you can’t actually start any applications?
1547 The exec command starts an application by passing the command you specify to a
1548 shell. This implies that you can use globbing (wildcards) and programs will be
1549 searched in your +$PATH+.
1551 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
1552 and +,+ (comma): they chain commands together in i3 and need to be escaped if
1553 you want to use them in your command.
1556 ------------------------------
1557 exec [--no-startup-id] command
1558 ------------------------------
1561 ------------------------------
1563 bindsym $mod+g exec gimp
1565 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1566 bindsym $mod+Return exec --no-startup-id urxvt
1567 ------------------------------
1569 The +--no-startup-id+ parameter disables startup-notification support for this
1570 particular exec command. With startup-notification, i3 can make sure that a
1571 window appears on the workspace on which you used the exec command. Also, it
1572 will change the X11 cursor to +watch+ (a clock) while the application is
1573 launching. So, if an application is not startup-notification aware (most GTK
1574 and Qt using applications seem to be, though), you will end up with a watch
1575 cursor for 60 seconds.
1577 === Splitting containers
1579 The split command makes the current window a split container. Split containers
1580 can contain multiple windows. Depending on the layout of the split container,
1581 new windows get placed to the right of the current one (splith) or new windows
1582 get placed below the current one (splitv).
1584 If you apply this command to a split container with the same orientation,
1585 nothing will happen. If you use a different orientation, the split container’s
1586 orientation will be changed (if it does not have more than one window). Use
1587 +layout toggle split+ to change the layout of any split container from splitv
1588 to splith or vice-versa.
1591 ---------------------------
1592 split <vertical|horizontal>
1593 ---------------------------
1596 ------------------------------
1597 bindsym $mod+v split vertical
1598 bindsym $mod+h split horizontal
1599 ------------------------------
1601 === Manipulating layout
1603 Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
1604 or +layout splith+ to change the current container layout to splith/splitv,
1605 stacking, tabbed layout, splitv or splith, respectively.
1607 To make the current window (!) fullscreen, use +fullscreen enable+ (or
1608 +fullscreen enable global+ for the global mode), to leave either fullscreen
1609 mode use +fullscreen disable+, and to toggle between these two states use
1610 +fullscreen toggle+ (or +fullscreen toggle global+).
1612 Likewise, to make the current window floating (or tiling again) use +floating
1613 enable+ respectively +floating disable+ (or +floating toggle+):
1617 layout <default|tabbed|stacking|splitv|splith>
1618 layout toggle [split|all]
1623 bindsym $mod+s layout stacking
1624 bindsym $mod+l layout toggle split
1625 bindsym $mod+w layout tabbed
1627 # Toggle between stacking/tabbed/split:
1628 bindsym $mod+x layout toggle
1630 # Toggle between stacking/tabbed/splith/splitv:
1631 bindsym $mod+x layout toggle all
1634 bindsym $mod+f fullscreen toggle
1636 # Toggle floating/tiling
1637 bindsym $mod+t floating toggle
1640 [[_focusing_moving_containers]]
1642 === Focusing containers
1644 To change focus, you can use the +focus+ command. The following options are
1647 left|right|up|down::
1648 Sets focus to the nearest container in the given direction.
1650 Sets focus to the parent container of the current container.
1652 The opposite of +focus parent+, sets the focus to the last focused
1655 Sets focus to the last focused floating container.
1657 Sets focus to the last focused tiling container.
1659 Toggles between floating/tiling containers.
1661 Followed by a direction or an output name, this will focus the
1662 corresponding output.
1665 ----------------------------------------------
1666 focus left|right|down|up
1667 focus parent|child|floating|tiling|mode_toggle
1668 focus output left|right|up|down|<output>
1669 ----------------------------------------------
1672 -------------------------------------------------
1673 # Focus container on the left, bottom, top, right
1674 bindsym $mod+j focus left
1675 bindsym $mod+k focus down
1676 bindsym $mod+l focus up
1677 bindsym $mod+semicolon focus right
1679 # Focus parent container
1680 bindsym $mod+u focus parent
1682 # Focus last floating/tiling container
1683 bindsym $mod+g focus mode_toggle
1685 # Focus the output right to the current one
1686 bindsym $mod+x focus output right
1688 # Focus the big output
1689 bindsym $mod+x focus output HDMI-2
1690 -------------------------------------------------
1692 === Moving containers
1694 Use the +move+ command to move a container.
1697 -----------------------------------------------------
1698 # Moves the container into the given direction.
1699 # The optional pixel argument specifies how far the
1700 # container should be moved if it is floating and
1701 # defaults to 10 pixels.
1702 move <left|right|down|up> [<px> px]
1704 # Moves the container either to a specific location
1705 # or to the center of the screen. If 'absolute' is
1706 # used, it is moved to the center of all outputs.
1707 move [absolute] position [[<px> px] [<px> px]|center]
1709 # Moves the container to the current position of the
1710 # mouse cursor. Only affects floating containers.
1712 -----------------------------------------------------
1715 -------------------------------------------------------
1716 # Move container to the left, bottom, top, right
1717 bindsym $mod+j move left
1718 bindsym $mod+k move down
1719 bindsym $mod+l move up
1720 bindsym $mod+semicolon move right
1722 # Move container, but make floating containers
1723 # move more than the default
1724 bindsym $mod+j move left 20 px
1726 # Move floating container to the center of all outputs
1727 bindsym $mod+c move absolute position center
1729 # Move container to the current position of the cursor
1730 bindsym $mod+m move position mouse
1731 -------------------------------------------------------
1733 === Changing (named) workspaces/moving to workspaces
1735 To change to a specific workspace, use the +workspace+ command, followed by the
1736 number or name of the workspace. To move containers to specific workspaces, use
1737 +move container to workspace+.
1739 You can also switch to the next and previous workspace with the commands
1740 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1741 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1742 combination. To restrict those to the current output, use +workspace
1743 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1744 container to workspace next+, +move container to workspace prev+ to move a
1745 container to the next/previous workspace and +move container to workspace current+
1746 (the last one makes sense only when used with criteria).
1748 See <<move_to_outputs>> for how to move a container/workspace to a different
1751 Workspace names are parsed as
1752 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
1756 To switch back to the previously focused workspace, use +workspace
1757 back_and_forth+; likewise, you can move containers to the previously focused
1758 workspace using +move container to workspace back_and_forth+.
1761 -----------------------------------
1762 workspace <next|prev|next_on_output|prev_on_output>
1763 workspace back_and_forth
1765 workspace number <name>
1767 move [window|container] [to] workspace <name>
1768 move [window|container] [to] workspace number <name>
1769 move [window|container] [to] workspace <prev|next|current>
1770 -----------------------------------
1773 -------------------------
1774 bindsym $mod+1 workspace 1
1775 bindsym $mod+2 workspace 2
1776 bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
1779 bindsym $mod+Shift+1 move container to workspace 1
1780 bindsym $mod+Shift+2 move container to workspace 2
1783 # switch between the current and the previously focused one
1784 bindsym $mod+b workspace back_and_forth
1785 bindsym $mod+Shift+b move container to workspace back_and_forth
1787 # move the whole workspace to the next output
1788 bindsym $mod+x move workspace to output right
1790 # move firefox to current workspace
1791 bindsym $mod+F1 [class="Firefox"] move workspace current
1792 -------------------------
1794 ==== Named workspaces
1796 Workspaces are identified by their name. So, instead of using numbers in the
1797 workspace command, you can use an arbitrary name:
1800 -------------------------
1801 bindsym $mod+1 workspace mail
1803 -------------------------
1805 If you want the workspace to have a number *and* a name, just prefix the
1809 -------------------------
1810 bindsym $mod+1 workspace 1: mail
1811 bindsym $mod+2 workspace 2: www
1813 -------------------------
1815 Note that the workspace will really be named "1: mail". i3 treats workspace
1816 names beginning with a number in a slightly special way. Normally, named
1817 workspaces are ordered the way they appeared. When they start with a number, i3
1818 will order them numerically. Also, you will be able to use +workspace number 1+
1819 to switch to the workspace which begins with number 1, regardless of which name
1820 it has. This is useful in case you are changing the workspace’s name
1821 dynamically. To combine both commands you can use +workspace number 1: mail+ to
1822 specify a default name if there's currently no workspace starting with a "1".
1824 ==== Renaming workspaces
1826 You can rename workspaces. This might be useful to start with the default
1827 numbered workspaces, do your work, and rename the workspaces afterwards to
1828 reflect what’s actually on them. You can also omit the old name to rename
1829 the currently focused workspace. This is handy if you want to use the
1830 rename command with +i3-input+.
1833 ----------------------------------------------------
1834 rename workspace <old_name> to <new_name>
1835 rename workspace to <new_name>
1836 ----------------------------------------------------
1839 --------------------------------------------------------------------------
1840 i3-msg 'rename workspace 5 to 6'
1841 i3-msg 'rename workspace 1 to "1: www"'
1842 i3-msg 'rename workspace "1: www" to "10: www"'
1843 i3-msg 'rename workspace to "2: mail"
1844 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
1845 --------------------------------------------------------------------------
1847 === Moving workspaces to a different screen
1849 See <<move_to_outputs>> for how to move a container/workspace to a different
1852 === Moving containers/workspaces to RandR outputs
1856 To move a container to another RandR output (addressed by names like +LVDS1+ or
1857 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
1858 +right+, +up+ or +down+), there are two commands:
1861 --------------------------------------------------------
1862 move container to output <<left|right|down|up>|<output>>
1863 move workspace to output <<left|right|down|up>|<output>>
1864 --------------------------------------------------------
1867 --------------------------------------------------------
1868 # Move the current workspace to the next output
1869 # (effectively toggles when you only have two outputs)
1870 bindsym $mod+x move workspace to output right
1872 # Put this window on the presentation output.
1873 bindsym $mod+x move container to output VGA1
1874 --------------------------------------------------------
1876 === Moving containers/workspaces to marks
1878 To move a container to another container with a specific mark (see <<vim_like_marks>>),
1879 you can use the following command.
1881 The window will be moved right after the marked container in the tree, i.e., it ends up
1882 in the same position as if you had opened a new window when the marked container was
1883 focused. If the mark is on a split container, the window will appear as a new child
1884 after the currently focused child within that container.
1887 ------------------------------------
1888 move window|container to mark <mark>
1889 ------------------------------------
1892 --------------------------------------------------------
1893 for_window [instance="tabme"] move window to mark target
1894 --------------------------------------------------------
1898 === Resizing containers/windows
1900 If you want to resize containers/windows using your keyboard, you can use the
1904 ---------------------------------------------------------
1905 resize <grow|shrink> <direction> [<px> px [or <ppt> ppt]]
1906 ---------------------------------------------------------
1908 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
1909 less specific and use +width+ or +height+, in which case i3 will take/give
1910 space from all the other containers. The optional pixel argument specifies by
1911 how many pixels a *floating container* should be grown or shrunk (the default
1912 is 10 pixels). The ppt argument means percentage points and specifies by how
1913 many percentage points a *tiling container* should be grown or shrunk (the
1914 default is 10 percentage points).
1916 I recommend using the resize command inside a so called +mode+:
1918 .Example: Configuration file, defining a mode for resizing
1919 ----------------------------------------------------------------------
1921 # These bindings trigger as soon as you enter the resize mode
1923 # Pressing left will shrink the window’s width.
1924 # Pressing right will grow the window’s width.
1925 # Pressing up will shrink the window’s height.
1926 # Pressing down will grow the window’s height.
1927 bindsym j resize shrink width 10 px or 10 ppt
1928 bindsym k resize grow height 10 px or 10 ppt
1929 bindsym l resize shrink height 10 px or 10 ppt
1930 bindsym semicolon resize grow width 10 px or 10 ppt
1932 # same bindings, but for the arrow keys
1933 bindsym Left resize shrink width 10 px or 10 ppt
1934 bindsym Down resize grow height 10 px or 10 ppt
1935 bindsym Up resize shrink height 10 px or 10 ppt
1936 bindsym Right resize grow width 10 px or 10 ppt
1938 # back to normal: Enter or Escape
1939 bindsym Return mode "default"
1940 bindsym Escape mode "default"
1944 bindsym $mod+r mode "resize"
1945 ----------------------------------------------------------------------
1947 === Jumping to specific windows
1949 Often when in a multi-monitor environment, you want to quickly jump to a
1950 specific window. For example, while working on workspace 3 you may want to
1951 jump to your mail client to email your boss that you’ve achieved some
1952 important goal. Instead of figuring out how to navigate to your mail client,
1953 it would be more convenient to have a shortcut. You can use the +focus+ command
1954 with criteria for that.
1957 ----------------------------------------------------
1958 [class="class"] focus
1959 [title="title"] focus
1960 ----------------------------------------------------
1963 ------------------------------------------------
1964 # Get me to the next open VIM instance
1965 bindsym $mod+a [class="urxvt" title="VIM"] focus
1966 ------------------------------------------------
1968 === VIM-like marks (mark/goto)
1972 This feature is like the jump feature: It allows you to directly jump to a
1973 specific window (this means switching to the appropriate workspace and setting
1974 focus to the windows). However, you can directly mark a specific window with
1975 an arbitrary label and use it afterwards. You can unmark the label in the same
1976 way, using the unmark command. If you don't specify a label, unmark removes all
1977 marks. You do not need to ensure that your windows have unique classes or
1978 titles, and you do not need to change your configuration file.
1980 As the command needs to include the label with which you want to mark the
1981 window, you cannot simply bind it to a key. +i3-input+ is a tool created
1982 for this purpose: It lets you input a command and sends the command to i3. It
1983 can also prefix this command and display a custom prompt for the input dialog.
1985 The additional +--toggle+ option will remove the mark if the window already has
1986 this mark, add it if the window has none or replace the current mark if it has
1989 Refer to +show_marks+ if you don't want marks to be shown in the window decoration.
1992 ------------------------------
1993 mark [--toggle] identifier
1994 [con_mark="identifier"] focus
1996 ------------------------------
1998 *Example (in a terminal)*:
1999 ------------------------------
2001 $ i3-msg '[con_mark="irssi"] focus'
2002 $ i3-msg unmark irssi
2003 ------------------------------
2005 ///////////////////////////////////////////////////////////////////
2006 TODO: make i3-input replace %s
2008 ---------------------------------------
2009 # Read 1 character and mark the current window with this character
2010 bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
2012 # Read 1 character and go to the window with the character
2013 bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
2014 ---------------------------------------
2016 Alternatively, if you do not want to mess with +i3-input+, you could create
2017 seperate bindings for a specific set of labels and then only use those labels.
2018 ///////////////////////////////////////////////////////////////////
2020 === Changing border style
2022 To change the border of the current client, you can use +border normal+ to use the normal
2023 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
2024 and +border none+ to make the client borderless.
2026 There is also +border toggle+ which will toggle the different border styles.
2029 ----------------------------
2030 bindsym $mod+t border normal
2031 bindsym $mod+y border 1pixel
2032 bindsym $mod+u border none
2033 ----------------------------
2037 ///////////////////////////////////////////////////////////////////////////////
2038 TODO: not yet implemented
2039 === Changing the stack-limit of a container
2041 If you have a single container with a lot of windows inside it (say, more than
2042 10), the default layout of a stacking container can get a little unhandy.
2043 Depending on your screen’s size, you might end up with only half of the title
2044 lines being actually used, wasting a lot of screen space.
2046 Using the +stack-limit+ command, you can limit the number of rows or columns
2047 in a stacking container. i3 will create columns or rows (depending on what
2048 you limited) automatically as needed.
2051 --------------------------------
2052 stack-limit <cols|rows> <value>
2053 --------------------------------
2057 # I always want to have two window titles in one line
2060 # Not more than 5 rows in this stacking container
2064 image:stacklimit.png[Container limited to two columns]
2065 ///////////////////////////////////////////////////////////////////////////////
2069 === Enabling shared memory logging
2071 As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared
2072 memory buffer, which you can dump using +i3-dump-log+. The +shmlog+ command
2073 allows you to enable or disable the shared memory logging at runtime.
2075 Note that when using +shmlog <size_in_bytes>+, the current log will be
2076 discarded and a new one will be started.
2079 ------------------------------
2080 shmlog <size_in_bytes>
2081 shmlog <on|off|toggle>
2082 ------------------------------
2086 # Enable/disable logging
2087 bindsym $mod+x shmlog toggle
2089 # or, from a terminal:
2090 # increase the shared memory log buffer to 50 MiB
2091 i3-msg shmlog $((50*1024*1024))
2094 === Enabling debug logging
2096 The +debuglog+ command allows you to enable or disable debug logging at
2097 runtime. Debug logging is much more verbose than non-debug logging. This
2098 command does not activate shared memory logging (shmlog), and as such is most
2099 likely useful in combination with the above-described <<shmlog>> command.
2102 ------------------------
2103 debuglog <on|off|toggle>
2104 ------------------------
2107 ------------------------
2108 # Enable/disable logging
2109 bindsym $mod+x debuglog toggle
2110 ------------------------
2112 === Reloading/Restarting/Exiting
2114 You can make i3 reload its configuration file with +reload+. You can also
2115 restart i3 inplace with the +restart+ command to get it out of some weird state
2116 (if that should ever happen) or to perform an upgrade without having to restart
2117 your X session. To exit i3 properly, you can use the +exit+ command,
2118 however you don’t need to (simply killing your X session is fine as well).
2121 ----------------------------
2122 bindsym $mod+Shift+r restart
2123 bindsym $mod+Shift+w reload
2124 bindsym $mod+Shift+e exit
2125 ----------------------------
2129 There are two commands to use any existing window as scratchpad window. +move
2130 scratchpad+ will move a window to the scratchpad workspace. This will make it
2131 invisible until you show it again. There is no way to open that workspace.
2132 Instead, when using +scratchpad show+, the window will be shown again, as a
2133 floating window, centered on your current workspace (using +scratchpad show+ on
2134 a visible scratchpad window will make it hidden again, so you can have a
2135 keybinding to toggle). Note that this is just a normal floating window, so if
2136 you want to "remove it from scratchpad", you can simple make it tiling again
2137 (+floating toggle+).
2139 As the name indicates, this is useful for having a window with your favorite
2140 editor always at hand. However, you can also use this for other permanently
2141 running applications which you don’t want to see all the time: Your music
2142 player, alsamixer, maybe even your mail client…?
2152 ------------------------------------------------
2153 # Make the currently focused window a scratchpad
2154 bindsym $mod+Shift+minus move scratchpad
2156 # Show the first scratchpad window
2157 bindsym $mod+minus scratchpad show
2159 # Show the sup-mail scratchpad window, if any.
2160 bindsym mod4+s [title="^Sup ::"] scratchpad show
2161 ------------------------------------------------
2165 There is a no operation command +nop+ which allows you to override default
2166 behavior. This can be useful for, e.g., disabling a focus change on clicks with
2167 the middle mouse button.
2169 The optional +comment+ argument is ignored, but will be printed to the log file
2170 for debugging purposes.
2178 ----------------------------------------------
2179 # Disable focus change for clicks on titlebars
2180 # with the middle mouse button
2182 ----------------------------------------------
2186 There are two options in the configuration of each i3bar instance that can be
2187 changed during runtime by invoking a command through i3. The commands +bar
2188 hidden_state+ and +bar mode+ allow setting the current hidden_state
2189 respectively mode option of each bar. It is also possible to toggle between
2190 hide state and show state as well as between dock mode and hide mode. Each
2191 i3bar instance can be controlled individually by specifying a bar_id, if none
2192 is given, the command is executed for all bar instances.
2196 bar hidden_state hide|show|toggle [<bar_id>]
2198 bar mode dock|hide|invisible|toggle [<bar_id>]
2202 ------------------------------------------------
2203 # Toggle between hide state and show state
2204 bindsym $mod+m bar hidden_state toggle
2206 # Toggle between dock mode and hide mode
2207 bindsym $mod+n bar mode toggle
2209 # Set the bar instance with id 'bar-1' to switch to hide mode
2210 bindsym $mod+b bar mode hide bar-1
2212 # Set the bar instance with id 'bar-1' to always stay hidden
2213 bindsym $mod+Shift+b bar mode invisible bar-1
2214 ------------------------------------------------
2218 == Multiple monitors
2220 As you can see in the goal list on the website, i3 was specifically developed
2221 with support for multiple monitors in mind. This section will explain how to
2222 handle multiple monitors.
2224 When you have only one monitor, things are simple. You usually start with
2225 workspace 1 on your monitor and open new ones as you need them.
2227 When you have more than one monitor, each monitor will get an initial
2228 workspace. The first monitor gets 1, the second gets 2 and a possible third
2229 would get 3. When you switch to a workspace on a different monitor, i3 will
2230 switch to that monitor and then switch to the workspace. This way, you don’t
2231 need shortcuts to switch to a specific monitor, and you don’t need to remember
2232 where you put which workspace. New workspaces will be opened on the currently
2233 active monitor. It is not possible to have a monitor without a workspace.
2235 The idea of making workspaces global is based on the observation that most
2236 users have a very limited set of workspaces on their additional monitors.
2237 They are often used for a specific task (browser, shell) or for monitoring
2238 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
2239 and "the rest" on the other monitors often makes sense. However, as you can
2240 create an unlimited number of workspaces in i3 and tie them to specific
2241 screens, you can have the "traditional" approach of having X workspaces per
2242 screen by changing your configuration (using modes, for example).
2244 === Configuring your monitors
2246 To help you get going if you have never used multiple monitors before, here is
2247 a short overview of the xrandr options which will probably be of interest to
2248 you. It is always useful to get an overview of the current screen configuration.
2249 Just run "xrandr" and you will get an output like the following:
2250 -------------------------------------------------------------------------------
2252 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
2253 VGA1 disconnected (normal left inverted right x axis y axis)
2254 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
2255 1280x800 60.0*+ 50.0
2256 1024x768 85.0 75.0 70.1 60.0
2258 800x600 85.1 72.2 75.0 60.3 56.2
2259 640x480 85.0 72.8 75.0 59.9
2263 --------------------------------------------------------------------------------------
2265 Several things are important here: You can see that +LVDS1+ is connected (of
2266 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
2267 connected to one of the ports but xrandr still says "disconnected", you should
2268 check your cable, monitor or graphics driver.
2270 The maximum resolution you can see at the end of the first line is the maximum
2271 combined resolution of your monitors. By default, it is usually too low and has
2272 to be increased by editing +/etc/X11/xorg.conf+.
2274 So, say you connected VGA1 and want to use it as an additional screen:
2275 -------------------------------------------
2276 xrandr --output VGA1 --auto --left-of LVDS1
2277 -------------------------------------------
2278 This command makes xrandr try to find the native resolution of the device
2279 connected to +VGA1+ and configures it to the left of your internal flat panel.
2280 When running "xrandr" again, the output looks like this:
2281 -------------------------------------------------------------------------------
2283 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
2284 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
2285 1280x1024 60.0*+ 75.0
2288 1024x768 75.1 70.1 60.0
2290 800x600 72.2 75.0 60.3 56.2
2291 640x480 72.8 75.0 66.7 60.0
2293 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
2294 1280x800 60.0*+ 50.0
2295 1024x768 85.0 75.0 70.1 60.0
2297 800x600 85.1 72.2 75.0 60.3 56.2
2298 640x480 85.0 72.8 75.0 59.9
2302 -------------------------------------------------------------------------------
2303 Please note that i3 uses exactly the same API as xrandr does, so it will see
2304 only what you can see in xrandr.
2306 See also <<presentations>> for more examples of multi-monitor setups.
2308 === Interesting configuration for multi-monitor environments
2310 There are several things to configure in i3 which may be interesting if you
2311 have more than one monitor:
2313 1. You can specify which workspace should be put on which screen. This
2314 allows you to have a different set of workspaces when starting than just
2315 1 for the first monitor, 2 for the second and so on. See
2316 <<workspace_screen>>.
2317 2. If you want some applications to generally open on the bigger screen
2318 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
2319 <<assign_workspace>>.
2320 3. If you have many workspaces on many monitors, it might get hard to keep
2321 track of which window you put where. Thus, you can use vim-like marks to
2322 quickly switch between windows. See <<vim_like_marks>>.
2323 4. For information on how to move existing workspaces between monitors,
2324 see <<_moving_containers_workspaces_to_randr_outputs>>.
2326 == i3 and the rest of your software world
2328 === Displaying a status line
2330 A very common thing amongst users of exotic window managers is a status line at
2331 some corner of the screen. It is an often superior replacement to the widget
2332 approach you have in the task bar of a traditional desktop environment.
2334 If you don’t already have your favorite way of generating such a status line
2335 (self-written scripts, conky, …), then i3status is the recommended tool for
2336 this task. It was written in C with the goal of using as few syscalls as
2337 possible to reduce the time your CPU is woken up from sleep states. Because
2338 i3status only spits out text, you need to combine it with some other tool, like
2339 i3bar. See <<status_command>> for how to display i3status in i3bar.
2341 Regardless of which application you use to display the status line, you
2342 want to make sure that it registers as a dock window using EWMH hints. i3 will
2343 position the window either at the top or at the bottom of the screen, depending
2344 on which hint the application sets. With i3bar, you can configure its position,
2345 see <<i3bar_position>>.
2347 === Giving presentations (multi-monitor)
2349 When giving a presentation, you typically want the audience to see what you see
2350 on your screen and then go through a series of slides (if the presentation is
2351 simple). For more complex presentations, you might want to have some notes
2352 which only you can see on your screen, while the audience can only see the
2356 ==== Case 1: everybody gets the same output
2357 This is the simple case. You connect your computer to the video projector,
2358 turn on both (computer and video projector) and configure your X server to
2359 clone the internal flat panel of your computer to the video output:
2360 -----------------------------------------------------
2361 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
2362 -----------------------------------------------------
2363 i3 will then use the lowest common subset of screen resolutions, the rest of
2364 your screen will be left untouched (it will show the X background). So, in
2365 our example, this would be 1024x768 (my notebook has 1280x800).
2367 ==== Case 2: you can see more than your audience
2368 This case is a bit harder. First of all, you should configure the VGA output
2369 somewhere near your internal flat panel, say right of it:
2370 -----------------------------------------------------
2371 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
2372 -----------------------------------------------------
2373 Now, i3 will put a new workspace (depending on your settings) on the new screen
2374 and you are in multi-monitor mode (see <<multi_monitor>>).
2376 Because i3 is not a compositing window manager, there is no ability to
2377 display a window on two screens at the same time. Instead, your presentation
2378 software needs to do this job (that is, open a window on each screen).