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 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+.
159 Floating mode is the opposite of tiling mode. The position and size of
160 a window are not managed automatically by i3, but manually by
161 you. Using this mode violates the tiling paradigm but can be useful
162 for some corner cases like "Save as" dialog windows, or toolbar
163 windows (GIMP or similar). Those windows usually set the appropriate
164 hint and are opened in floating mode by default.
166 You can toggle floating mode for a window by pressing +$mod+Shift+Space+. By
167 dragging the window’s titlebar with your mouse you can move the window
168 around. By grabbing the borders and moving them you can resize the window. You
169 can also do that by using the <<floating_modifier>>.
171 For resizing floating windows with your keyboard, see <<resizingconfig>>.
173 Floating windows are always on top of tiling windows.
177 i3 stores all information about the X11 outputs, workspaces and layout of the
178 windows on them in a tree. The root node is the X11 root window, followed by
179 the X11 outputs, then dock areas and a content container, then workspaces and
180 finally the windows themselves. In previous versions of i3 we had multiple lists
181 (of outputs, workspaces) and a table for each workspace. That approach turned
182 out to be complicated to use (snapping), understand and implement.
184 === The tree consists of Containers
186 The building blocks of our tree are so called +Containers+. A +Container+ can
187 host a window (meaning an X11 window, one that you can actually see and use,
188 like a browser). Alternatively, it could contain one or more +Containers+. A
189 simple example is the workspace: When you start i3 with a single monitor, a
190 single workspace and you open two terminal windows, you will end up with a tree
193 image::tree-layout2.png["layout2",float="right"]
194 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
196 === Orientation and Split Containers
200 It is only natural to use so-called +Split Containers+ in order to build a
201 layout when using a tree as data structure. In i3, every +Container+ has an
202 orientation (horizontal, vertical or unspecified) and the orientation depends
203 on the layout the container is in (vertical for splitv and stacking, horizontal
204 for splith and tabbed). So, in our example with the workspace, the default
205 layout of the workspace +Container+ is splith (most monitors are widescreen
206 nowadays). If you change the layout to splitv (+$mod+l+ in the default config)
207 and *then* open two terminals, i3 will configure your windows like this:
209 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
211 An interesting new feature of i3 since version 4 is the ability to split anything:
212 Let’s assume you have two terminals on a workspace (with splith layout, that is
213 horizontal orientation), focus is on the right terminal. Now you want to open
214 another terminal window below the current one. If you would just open a new
215 terminal window, it would show up to the right due to the splith layout.
216 Instead, press +$mod+v+ to split the container with the splitv layout (to
217 open a +Horizontal Split Container+, use +$mod+h+). Now you can open a new
218 terminal and it will open below the current one:
220 image::tree-layout1.png["Layout",float="right"]
221 image::tree-shot1.png["shot",title="Vertical Split Container"]
225 You probably guessed it already: There is no limit on how deep your hierarchy
230 Let’s stay with our example from above. We have a terminal on the left and two
231 vertically split terminals on the right, focus is on the bottom right one. When
232 you open a new terminal, it will open below the current one.
234 So, how can you open a new terminal window to the *right* of the current one?
235 The solution is to use +focus parent+, which will focus the +Parent Container+ of
236 the current +Container+. In this case, you would focus the +Vertical Split
237 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
238 windows will be opened to the right of the +Vertical Split Container+:
240 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
242 === Implicit containers
244 In some cases, i3 needs to implicitly create a container to fulfill your
247 One example is the following scenario: You start i3 with a single monitor and a
248 single workspace on which you open three terminal windows. All these terminal
249 windows are directly attached to one node inside i3’s layout tree, the
250 workspace node. By default, the workspace node’s orientation is +horizontal+.
252 Now you move one of these terminals down (+$mod+k+ by default). The workspace
253 node’s orientation will be changed to +vertical+. The terminal window you moved
254 down is directly attached to the workspace and appears on the bottom of the
255 screen. A new (horizontal) container was created to accommodate the other two
256 terminal windows. You will notice this when switching to tabbed mode (for
257 example). You would end up having one tab called "another container" and the
258 other one being the terminal window you moved down.
263 This is where the real fun begins ;-). Most things are very dependent on your
264 ideal working environment so we can’t make reasonable defaults for them.
266 While not using a programming language for the configuration, i3 stays
267 quite flexible in regards to the things you usually want your window manager
270 For example, you can configure bindings to jump to specific windows,
271 you can set specific applications to start on specific workspaces, you can
272 automatically start applications, you can change the colors of i3, and you
273 can bind your keys to do useful things.
275 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
276 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
279 On first start (and on all following starts, unless you have a configuration
280 file), i3 will offer you to create a configuration file. You can tell the
281 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
282 file. Also, the created config file will use the key symbols of your current
283 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
284 Please note that you must not have +~/.i3/config+, otherwise the wizard will
289 It is possible and recommended to use comments in your configuration file to
290 properly document your setup for later reference. Comments are started with
291 a # and can only be used at the beginning of a line:
302 i3 has support for both X core fonts and FreeType fonts (through Pango) to
303 render window titles.
305 To generate an X core font description, you can use +xfontsel(1)+. To see
306 special characters (Unicode), you need to use a font which supports the
309 A FreeType font description is composed by a font family, a style, a weight,
310 a variant, a stretch and a size.
311 FreeType fonts support right-to-left rendering and contain often more
312 Unicode glyphs than X core fonts.
314 If i3 cannot open the configured font, it will output an error in the logfile
315 and fall back to a working font.
318 ------------------------------
319 font <X core font description>
320 font pango:[family list] [style options] [size]
321 ------------------------------
324 --------------------------------------------------------------
325 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
326 font pango:DejaVu Sans Mono 10
327 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
328 font pango:Terminus 11px
329 --------------------------------------------------------------
333 === Keyboard bindings
335 A keyboard binding makes i3 execute a command (see below) upon pressing a
336 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
337 also mix your bindings, though i3 will not protect you from overlapping ones).
339 * A keysym (key symbol) is a description for a specific symbol, like "a"
340 or "b", but also more strange ones like "underscore" instead of "_". These
341 are the ones you use in Xmodmap to remap your keys. To get the current
342 mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
343 see what keysym it is configured to, use +xev+.
345 * Keycodes do not need to have a symbol assigned (handy for custom vendor
346 hotkeys on some notebooks) and they will not change their meaning as you
347 switch to a different keyboard layout (when using +xmodmap+).
349 My recommendation is: If you often switch keyboard layouts but you want to keep
350 your bindings in the same physical location on the keyboard, use keycodes.
351 If you don’t switch layouts, and want a clean and simple config file, use
354 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
355 KeyPress event, because the keyboard/pointer is still grabbed. For these
356 situations, the +--release+ flag can be used, which will execute the command
357 after the keys have been released.
360 ----------------------------------
361 bindsym [--release] [Modifiers+]keysym command
362 bindcode [--release] [Modifiers+]keycode command
363 ----------------------------------
366 --------------------------------
368 bindsym $mod+f fullscreen
371 bindsym $mod+Shift+r restart
373 # Notebook-specific hotkeys
374 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
376 # Simulate ctrl+v upon pressing $mod+x
377 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
379 # Take a screenshot upon pressing $mod+x (select an area)
380 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
381 --------------------------------
385 Mod1-Mod5, Shift, Control::
386 Standard modifiers, see +xmodmap(1)+
389 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
390 you to remap capslock (for example) to Mode_switch and use it for both: typing
391 umlauts or special characters 'and' having some comfortably reachable key
392 bindings. For example, when typing, capslock+1 or capslock+2 for switching
393 workspaces is totally convenient. Try it :-).
395 [[floating_modifier]]
397 === The floating modifier
399 To move floating windows with your mouse, you can either grab their titlebar
400 or configure the so called floating modifier which you can then press and
401 click anywhere in the window itself to move it. The most common setup is to
402 use the same key you use for managing windows (Mod1 for example). Then
403 you can press Mod1, click into a window using your left mouse button, and drag
404 it to the position you want.
406 When holding the floating modifier, you can resize a floating window by
407 pressing the right mouse button on it and moving around while holding it. If
408 you hold the shift button as well, the resize will be proportional (the aspect
409 ratio will be preserved).
412 --------------------------------
413 floating_modifier <Modifiers>
414 --------------------------------
417 --------------------------------
418 floating_modifier Mod1
419 --------------------------------
421 === Constraining floating window size
423 The maximum and minimum dimensions of floating windows can be specified. If
424 either dimension of +floating_maximum_size+ is specified as -1, that dimension
425 will be unconstrained with respect to its maximum value. If either dimension of
426 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
427 value to constrain the maximum size. +floating_minimum_size+ is treated in a
428 manner analogous to +floating_maximum_size+.
431 ----------------------------------------
432 floating_minimum_size <width> x <height>
433 floating_maximum_size <width> x <height>
434 ----------------------------------------
437 --------------------------------------
438 floating_minimum_size 75 x 50
439 floating_maximum_size -1 x -1
440 --------------------------------------
442 === Orientation for new workspaces
444 New workspaces get a reasonable default orientation: Wide-screen monitors
445 (anything wider than high) get horizontal orientation, rotated monitors
446 (anything higher than wide) get vertical orientation.
448 With the +default_orientation+ configuration directive, you can override that
452 ----------------------------------------------
453 default_orientation <horizontal|vertical|auto>
454 ----------------------------------------------
457 ----------------------------
458 default_orientation vertical
459 ----------------------------
461 === Layout mode for new containers
463 This option determines in which mode new containers on workspace level will
465 ///////////////////////////////
466 See also <<stack-limit>>.
467 //////////////////////////////
470 ---------------------------------------------
471 workspace_layout <default|stacking|tabbed>
472 ---------------------------------------------
473 /////////////////////////////////////////////
474 new_container stack-limit <cols|rows> <value>
475 /////////////////////////////////////////////
478 ---------------------
479 workspace_layout tabbed
480 ---------------------
482 === Border style for new windows
484 This option determines which border style new windows will have. The default is
485 "normal". Note that new_float applies only to windows which are starting out as
486 floating windows, e.g. dialog windows.
489 ---------------------------------------------
490 new_window <normal|1pixel|none|pixel>
491 new_float <normal|1pixel|none|pixel>
492 ---------------------------------------------
495 ---------------------
497 ---------------------
499 The "normal" and "pixel" border styles support an optional border width in
503 ---------------------
504 # The same as new_window none
509 ---------------------
512 === Hiding vertical borders
514 You can hide vertical borders adjacent to the screen edges using
515 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
516 to waste even two pixels in displayspace. Default is none.
519 ----------------------------
520 hide_edge_borders <none|vertical|horizontal|both>
521 ----------------------------
524 ----------------------
525 hide_edge_borders vertical
526 ----------------------
528 === Arbitrary commands for specific windows (for_window)
530 With the +for_window+ command, you can let i3 execute any command when it
531 encounters a specific window. This can be used to set windows to floating or to
532 change their border style, for example.
535 -----------------------------
536 for_window <criteria> command
537 -----------------------------
540 ------------------------------------------------
541 # enable floating mode for all XTerm windows
542 for_window [class="XTerm"] floating enable
544 # Make all urxvts use a 1-pixel border:
545 for_window [class="urxvt"] border 1pixel
547 # A less useful, but rather funny example:
548 # makes the window floating as soon as I change
549 # directory to ~/work
550 for_window [title="x200: ~/work"] floating enable
551 ------------------------------------------------
553 The valid criteria are the same as those for commands, see <<command_criteria>>.
557 As you learned in the section about keyboard bindings, you will have
558 to configure lots of bindings containing modifier keys. If you want to save
559 yourself some typing and be able to change the modifier you use later,
560 variables can be handy.
568 ------------------------
570 bindsym $m+Shift+r restart
571 ------------------------
573 Variables are directly replaced in the file when parsing. Variables expansion
574 is not recursive so it is not possible to define a variable with a value
575 containing another variable. There is no fancy handling and there are
576 absolutely no plans to change this. If you need a more dynamic configuration
577 you should create a little script which generates a configuration file and run
578 it before starting i3 (for example in your +~/.xsession+ file).
580 === Automatically putting clients on specific workspaces
584 To automatically make a specific window show up on a specific workspace, you
585 can use an *assignment*. You can match windows by using any criteria,
586 see <<command_criteria>>. It is recommended that you match on window classes
587 (and instances, when appropriate) instead of window titles whenever possible
588 because some applications first create their window, and then worry about
589 setting the correct title. Firefox with Vimperator comes to mind. The window
590 starts up being named Firefox, and only when Vimperator is loaded does the
591 title change. As i3 will get the title as soon as the application maps the
592 window (mapping means actually displaying it on the screen), you’d need to have
593 to match on 'Firefox' in this case.
595 Assignments are processed by i3 in the order in which they appear in the config
596 file. The first one which matches the window wins and later assignments are not
600 ------------------------------------------------------------
601 assign <criteria> [→] workspace
602 ------------------------------------------------------------
605 ----------------------
606 # Assign URxvt terminals to workspace 2
607 assign [class="URxvt"] 2
609 # Same thing, but more precise (exact match instead of substring)
610 assign [class="^URxvt$"] 2
612 # Same thing, but with a beautiful arrow :)
613 assign [class="^URxvt$"] → 2
615 # Assignment to a named workspace
616 assign [class="^URxvt$"] → work
618 # Start urxvt -name irssi
619 assign [class="^URxvt$" instance="^irssi$"] → 3
620 ----------------------
622 Note that the arrow is not required, it just looks good :-). If you decide to
623 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
625 To get the class and instance, you can use +xprop+. After clicking on the
626 window, you will see the following output:
629 -----------------------------------
630 WM_CLASS(STRING) = "irssi", "URxvt"
631 -----------------------------------
633 The first part of the WM_CLASS is the instance ("irssi" in this example), the
634 second part is the class ("URxvt" in this example).
636 Should you have any problems with assignments, make sure to check the i3
637 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
638 details about the matching process and the window’s actual class, instance and
639 title when starting up.
641 Note that if you want to start an application just once on a specific
642 workspace, but you don’t want to assign all instances of it permanently, you
643 can make use of i3’s startup-notification support (see <<exec>>) in your config
644 file in the following way:
646 *Start iceweasel on workspace 3 (once)*:
647 -------------------------------------------------------------------------------
648 # Start iceweasel on workspace 3, then switch back to workspace 1
649 # (Being a command-line utility, i3-msg does not support startup notifications,
650 # hence the exec --no-startup-id.)
651 # (Starting iceweasel with i3’s exec command is important in order to make i3
652 # create a startup notification context, without which the iceweasel window(s)
653 # cannot be matched onto the workspace on which the command was started.)
654 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
655 -------------------------------------------------------------------------------
657 === Automatically starting applications on i3 startup
659 By using the +exec+ keyword outside a keybinding, you can configure
660 which commands will be performed by i3 on initial startup. +exec+
661 commands will not run when restarting i3, if you need a command to run
662 also when restarting i3 you should use the +exec_always+
663 keyword. These commands will be run in order.
667 exec [--no-startup-id] command
668 exec_always [--no-startup-id] command
672 --------------------------------
674 exec_always ~/my_script.sh
676 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
677 exec --no-startup-id urxvt
678 --------------------------------
680 The flag --no-startup-id is explained in <<exec>>.
684 === Automatically putting workspaces on specific screens
686 If you assign clients to workspaces, it might be handy to put the
687 workspaces on specific screens. Also, the assignment of workspaces to screens
688 will determine which workspace i3 uses for a new screen when adding screens
689 or when starting (e.g., by default it will use 1 for the first screen, 2 for
690 the second screen and so on).
693 ----------------------------------
694 workspace <workspace> output <output>
695 ----------------------------------
697 The 'output' is the name of the RandR output you attach your screen to. On a
698 laptop, you might have VGA1 and LVDS1 as output names. You can see the
699 available outputs by running +xrandr --current+.
701 If you use named workspaces, they must be quoted:
704 ---------------------------
705 workspace 1 output LVDS1
706 workspace 5 output VGA1
707 workspace "2: vim" output VGA1
708 ---------------------------
712 You can change all colors which i3 uses to draw the window decorations.
715 --------------------------------------------
716 colorclass border background text indicator
717 --------------------------------------------
719 Where colorclass can be one of:
722 A client which currently has the focus.
723 client.focused_inactive::
724 A client which is the focused one of its container, but it does not have
725 the focus at the moment.
727 A client which is not the focused one of its container.
729 A client which has its urgency hint activated.
731 Background and text color are used to draw placeholder window contents
732 (when restoring layouts). Border and indicator are ignored.
734 You can also specify the color to be used to paint the background of the client
735 windows. This color will be used to paint the window on top of which the client
739 -----------------------
740 client.background color
741 -----------------------
743 Only clients that do not cover the whole area of this window expose the color
746 Colors are in HTML hex format (#rrggbb), see the following example:
748 *Examples (default colors)*:
749 ---------------------------------------------------------
750 # class border backgr. text indicator
751 client.focused #4c7899 #285577 #ffffff #2e9ef4
752 client.focused_inactive #333333 #5f676a #ffffff #484e50
753 client.unfocused #333333 #222222 #888888 #292d2e
754 client.urgent #2f343a #900000 #ffffff #900000
755 client.placeholder #000000 #0c0c0c #ffffff #000000
756 ---------------------------------------------------------
758 Note that for the window decorations, the color around the child window is the
759 background color, and the border color is only the two thin lines at the top of
762 The indicator color is used for indicating where a new window will be opened.
763 For horizontal split containers, the right border will be painted in indicator
764 color, for vertical split containers, the bottom border. This only applies to
765 single windows within a split container, which are otherwise indistinguishable
766 from single windows outside of a split container.
768 === Interprocess communication
770 i3 uses Unix sockets to provide an IPC interface. This allows third-party
771 programs to get information from i3, such as the current workspaces
772 (to display a workspace bar), and to control i3.
774 The IPC socket is enabled by default and will be created in
775 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
776 the PID of i3 and XXXXXX is a string of random characters from the portable
777 filename character set (see mkdtemp(3)).
779 You can override the default path through the environment-variable +I3SOCK+ or
780 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
781 does the right thing by default. If you decide to change it, it is strongly
782 recommended to set this to a location in your home directory so that no other
783 user can create that directory.
786 ----------------------------
787 ipc-socket ~/.i3/i3-ipc.sock
788 ----------------------------
790 You can then use the +i3-msg+ application to perform any command listed in
793 === Focus follows mouse
795 By default, window focus follows your mouse movements. However, if you have a
796 setup where your mouse usually is in your way (like a touchpad on your laptop
797 which you do not want to disable completely), you might want to disable 'focus
798 follows mouse' and control focus only by using your keyboard. The mouse will
799 still be useful inside the currently active window (for example to click on
800 links in your browser window).
803 ----------------------------
804 focus_follows_mouse <yes|no>
805 ----------------------------
808 ----------------------
809 focus_follows_mouse no
810 ----------------------
812 === Popups during fullscreen mode
814 When you are in fullscreen mode, some applications still open popup windows
815 (take Xpdf for example). This is because these applications may not be aware
816 that they are in fullscreen mode (they do not check the corresponding hint).
817 There are three things which are possible to do in this situation:
819 1. Display the popup if it belongs to the fullscreen application only. This is
820 the default and should be reasonable behavior for most users.
821 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
822 in fullscreen. However, some apps might react badly to this (deadlock until
823 you go out of fullscreen).
824 3. Leave fullscreen mode.
827 -------------------------------------------------
828 popup_during_fullscreen <smart|ignore|leave_fullscreen>
829 -------------------------------------------------
832 ------------------------------
833 popup_during_fullscreen smart
834 ------------------------------
838 When being in a tabbed or stacked container, the first container will be
839 focused when you use +focus down+ on the last container -- the focus wraps. If
840 however there is another stacked/tabbed container in that direction, focus will
841 be set on that container. This is the default behavior so you can navigate to
842 all your windows without having to use +focus parent+.
844 If you want the focus to *always* wrap and you are aware of using +focus
845 parent+ to switch to different containers, you can use the
846 +force_focus_wrapping+ configuration directive. After enabling it, the focus
850 -----------------------------
851 force_focus_wrapping <yes|no>
852 -----------------------------
855 ------------------------
856 force_focus_wrapping yes
857 ------------------------
861 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
862 video drivers (especially the nVidia binary driver) only provide support for
863 Xinerama instead of RandR. In such a situation, i3 must be told to use the
864 inferior Xinerama API explicitly and therefore don’t provide support for
865 reconfiguring your screens on the fly (they are read only once on startup and
868 For people who do cannot modify their +~/.xsession+ to add the
869 +--force-xinerama+ commandline parameter, a configuration option is provided:
872 -----------------------
873 force_xinerama <yes|no>
874 -----------------------
881 Also note that your output names are not descriptive (like +HDMI1+) when using
882 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
884 === Automatic back-and-forth when switching to the current workspace
886 This configuration directive enables automatic +workspace back_and_forth+ (see
887 <<back_and_forth>>) when switching to the workspace that is currently focused.
889 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
890 mod+2 because somebody sent you a message. You don’t need to remember where you
891 came from now, you can just press $mod+2 again to switch back to "1: www".
894 --------------------------------------
895 workspace_auto_back_and_forth <yes|no>
896 --------------------------------------
899 ---------------------------------
900 workspace_auto_back_and_forth yes
901 ---------------------------------
903 === Delaying urgency hint reset on workspace change
905 If an application on another workspace sets an urgency hint, switching to this
906 workspace may lead to immediate focus of the application, which also means the
907 window decoration color would be immediately reset to +client.focused+. This
908 may make it unnecessarily hard to tell which window originally raised the
911 In order to prevent this, you can tell i3 to delay resetting the urgency state
912 by a certain time using the +force_display_urgency_hint+ directive. Setting the
913 value to 0 disables this feature.
915 The default is 500ms.
918 ---------------------------------------
919 force_display_urgency_hint <timeout> ms
920 ---------------------------------------
923 ---------------------------------
924 force_display_urgency_hint 500 ms
925 ---------------------------------
929 The bar at the bottom of your monitor is drawn by a separate process called
930 i3bar. Having this part of "the i3 user interface" in a separate process has
933 1. It is a modular approach. If you don’t need a workspace bar at all, or if
934 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
935 just remove the i3bar configuration and start your favorite bar instead.
936 2. It follows the UNIX philosophy of "Make each program do one thing well".
937 While i3 manages your windows well, i3bar is good at displaying a bar on
938 each monitor (unless you configure it otherwise).
939 3. It leads to two separate, clean codebases. If you want to understand i3, you
940 don’t need to bother with the details of i3bar and vice versa.
942 That said, i3bar is configured in the same configuration file as i3. This is
943 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
944 are useful for people using other window managers). Therefore, it makes no
945 sense to use a different configuration place when we already have a good
946 configuration infrastructure in place.
948 Configuring your workspace bar starts with opening a +bar+ block. You can have
949 multiple bar blocks to use different settings for different outputs (monitors):
952 ---------------------------
954 status_command i3status
956 ---------------------------
960 By default i3 will just pass +i3bar+ and let your shell handle the execution,
961 searching your +$PATH+ for a correct version.
962 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
963 tell i3 what to execute.
965 The specified command will be passed to +sh -c+, so you can use globbing and
966 have to have correct quoting etc.
969 ----------------------
970 i3bar_command command
971 ----------------------
974 -------------------------------------------------
976 i3bar_command /home/user/bin/i3bar
978 -------------------------------------------------
981 === Statusline command
983 i3bar can run a program and display every line of its +stdout+ output on the
984 right hand side of the bar. This is useful to display system information like
985 your current IP address, battery status or date/time.
987 The specified command will be passed to +sh -c+, so you can use globbing and
988 have to have correct quoting etc.
991 ----------------------
992 status_command command
993 ----------------------
996 -------------------------------------------------
998 status_command i3status --config ~/.i3status.conf
1000 -------------------------------------------------
1004 You can either have i3bar be visible permanently at one edge of the screen
1005 (+dock+ mode) or make it show up when you press your modifier key (+hide+ mode).
1006 It is also possible to force i3bar to always stay hidden (+invisible+
1007 mode). The modifier key can be configured using the +modifier+ option.
1009 The mode option can be changed during runtime through the +bar mode+ command.
1010 On reload the mode will be reverted to its configured value.
1012 The hide mode maximizes screen space that can be used for actual windows. Also,
1013 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1016 Invisible mode allows to permanently maximize screen space, as the bar is never
1017 shown. Thus, you can configure i3bar to not disturb you by popping up because
1018 of an urgency hint or because the modifier key is pressed.
1020 In order to control whether i3bar is hidden or shown in hide mode, there exists
1021 the hidden_state option, which has no effect in dock mode or invisible mode. It
1022 indicates the current hidden_state of the bar: (1) The bar acts like in normal
1023 hide mode, it is hidden and is only unhidden in case of urgency hints or by
1024 pressing the modifier key (+hide+ state), or (2) it is drawn on top of the
1025 currently visible workspace (+show+ state).
1027 Like the mode, the hidden_state can also be controlled through i3, this can be
1028 done by using the +bar hidden_state+ command.
1030 The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
1031 the windows key). The default value for the hidden_state is hide.
1035 mode <dock|hide|invisible>
1036 hidden_state <hide|show>
1049 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
1053 Specifies the bar ID for the configured bar instance. If this option is missing,
1054 the ID is set to 'bar-x', where x corresponds to the position of the embedding
1055 bar block in the config file ('bar-0', 'bar-1', ...).
1058 ---------------------
1060 ---------------------
1063 ---------------------
1067 ---------------------
1072 This option determines in which edge of the screen i3bar should show up.
1074 The default is bottom.
1077 ---------------------
1078 position <top|bottom>
1079 ---------------------
1082 ---------------------
1086 ---------------------
1090 You can restrict i3bar to one or more outputs (monitors). The default is to
1091 handle all outputs. Restricting the outputs is useful for using different
1092 options for different outputs by using multiple 'bar' blocks.
1094 To make a particular i3bar instance handle multiple outputs, specify the output
1095 directive multiple times.
1103 -------------------------------
1104 # big monitor: everything
1106 # The display is connected either via HDMI or via DisplayPort
1109 status_command i3status
1112 # laptop monitor: bright colors and i3status with less modules.
1115 status_command i3status --config ~/.i3status-small.conf
1121 -------------------------------
1125 i3bar by default provides a system tray area where programs such as
1126 NetworkManager, VLC, Pidgin, etc. can place little icons.
1128 You can configure on which output (monitor) the icons should be displayed or
1129 you can turn off the functionality entirely.
1132 -------------------------
1133 tray_output <none|primary|output>
1134 -------------------------
1137 -------------------------
1138 # disable system tray
1143 # show tray icons on the primary monitor
1146 # show tray icons on the big monitor
1150 -------------------------
1152 Note that you might not have a primary output configured yet. To do so, run:
1153 -------------------------
1154 xrandr --output <output> --primary
1155 -------------------------
1159 Specifies the font to be used in the bar. See <<fonts>>.
1162 ---------------------
1164 ---------------------
1167 --------------------------------------------------------------
1169 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1170 font pango:DejaVu Sans Mono 10
1172 --------------------------------------------------------------
1174 === Workspace buttons
1176 Specifies whether workspace buttons should be shown or not. This is useful if
1177 you want to display a statusline-only bar containing additional information.
1179 The default is to show workspace buttons.
1182 --------------------------
1183 workspace_buttons <yes|no>
1184 --------------------------
1187 ------------------------
1189 workspace_buttons no
1191 ------------------------
1193 === Binding Mode indicator
1195 Specifies whether the current binding mode indicator should be shown or not.
1196 This is useful if you want to hide the workspace buttons but still be able
1197 to see the current binding mode indicator.
1198 For an example of a +mode+ definition, see <<resizingconfig>>.
1200 The default is to show the mode indicator.
1203 -------------------------------
1204 binding_mode_indicator <yes|no>
1205 -------------------------------
1208 -----------------------------
1210 binding_mode_indicator no
1212 -----------------------------
1216 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1217 be configured at the moment:
1220 Background color of the bar.
1222 Text color to be used for the statusline.
1224 Text color to be used for the separator.
1226 Border, background and text color for a workspace button when the workspace
1229 Border, background and text color for a workspace button when the workspace
1230 is active (visible) on some output, but the focus is on another one.
1231 You can only tell this apart from the focused workspace when you are
1232 using multiple monitors.
1233 inactive_workspace::
1234 Border, background and text color for a workspace button when the workspace
1235 does not have focus and is not active (visible) on any output. This
1236 will be the case for most workspaces.
1238 Border, background and text color for a workspace button when the workspace
1239 contains a window with the urgency hint set. Also applies to +mode+ indicators.
1242 ----------------------------------------
1248 colorclass <border> <background> <text>
1250 ----------------------------------------
1252 *Example (default colors)*:
1253 --------------------------------------
1260 focused_workspace #4c7899 #285577 #ffffff
1261 active_workspace #333333 #5f676a #ffffff
1262 inactive_workspace #333333 #222222 #888888
1263 urgent_workspace #2f343a #900000 #ffffff
1266 --------------------------------------
1270 Commands are what you bind to specific keypresses. You can also issue commands
1271 at runtime without pressing a key by using the IPC interface. An easy way to
1272 do this is to use the +i3-msg+ utility:
1275 --------------------------
1276 # execute this on your shell to make the current container borderless
1278 --------------------------
1280 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1281 specific workspace and immediately switch to that workspace, you can configure
1282 the following keybinding:
1285 --------------------------------------------------------
1286 bindsym $mod+x move container to workspace 3; workspace 3
1287 --------------------------------------------------------
1289 [[command_criteria]]
1291 Furthermore, you can change the scope of a command - that is, which containers
1292 should be affected by that command, by using various criteria. The criteria
1293 are specified before any command in a pair of square brackets and are separated
1296 When using multiple commands, separate them by using a +,+ (a comma) instead of
1297 a semicolon. Criteria apply only until the next semicolon, so if you use a
1298 semicolon to separate commands, only the first one will be executed for the
1302 ------------------------------------
1303 # if you want to kill all windows which have the class Firefox, use:
1304 bindsym $mod+x [class="Firefox"] kill
1306 # same thing, but case-insensitive
1307 bindsym $mod+x [class="(?i)firefox"] kill
1309 # kill only the About dialog from Firefox
1310 bindsym $mod+x [class="Firefox" window_role="About"] kill
1312 # enable floating mode and move container to workspace 4
1313 for_window [class="^evil-app$"] floating enable, move container to workspace 4
1314 ------------------------------------
1316 The criteria which are currently implemented are:
1319 Compares the window class (the second part of WM_CLASS)
1321 Compares the window instance (the first part of WM_CLASS)
1323 Compares the window role (WM_WINDOW_ROLE).
1325 Compares the X11 window ID, which you can get via +xwininfo+ for example.
1327 Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
1329 Compares the urgent state of the window. Can be "latest" or "oldest".
1330 Matches the latest or oldest urgent window, respectively.
1331 (The following aliases are also available: newest, last, recent, first)
1333 Compares the mark set for this container, see <<vim_like_marks>>.
1335 Compares the i3-internal container ID, which you can get via the IPC
1336 interface. Handy for scripting.
1338 The criteria +class+, +instance+, +role+, +title+ and +mark+ are actually
1339 regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1340 information on how to use them.
1344 === Executing applications (exec)
1346 What good is a window manager if you can’t actually start any applications?
1347 The exec command starts an application by passing the command you specify to a
1348 shell. This implies that you can use globbing (wildcards) and programs will be
1349 searched in your $PATH.
1352 ------------------------------
1353 exec [--no-startup-id] command
1354 ------------------------------
1357 ------------------------------
1359 bindsym $mod+g exec gimp
1361 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1362 bindsym $mod+Return exec --no-startup-id urxvt
1363 ------------------------------
1365 The +--no-startup-id+ parameter disables startup-notification support for this
1366 particular exec command. With startup-notification, i3 can make sure that a
1367 window appears on the workspace on which you used the exec command. Also, it
1368 will change the X11 cursor to +watch+ (a clock) while the application is
1369 launching. So, if an application is not startup-notification aware (most GTK
1370 and Qt using applications seem to be, though), you will end up with a watch
1371 cursor for 60 seconds.
1373 === Splitting containers
1375 The split command makes the current window a split container. Split containers
1376 can contain multiple windows. Depending on the layout of the split container,
1377 new windows get placed to the right of the current one (splith) or new windows
1378 get placed below the current one (splitv).
1380 If you apply this command to a split container with the same orientation,
1381 nothing will happen. If you use a different orientation, the split container’s
1382 orientation will be changed (if it does not have more than one window). Use
1383 +layout toggle split+ to change the layout of any split container from splitv
1384 to splith or vice-versa.
1387 ---------------------------
1388 split <vertical|horizontal>
1389 ---------------------------
1392 ------------------------------
1393 bindsym $mod+v split vertical
1394 bindsym $mod+h split horizontal
1395 ------------------------------
1397 === Manipulating layout
1399 Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
1400 or +layout splith+ to change the current container layout to splith/splitv,
1401 stacking, tabbed layout, splitv or splith, respectively.
1403 To make the current window (!) fullscreen, use +fullscreen+, to make
1404 it floating (or tiling again) use +floating enable+ respectively +floating disable+
1405 (or +floating toggle+):
1409 layout <default|tabbed|stacking|splitv|splith>
1410 layout toggle [split|all]
1415 bindsym $mod+s layout stacking
1416 bindsym $mod+l layout toggle split
1417 bindsym $mod+w layout tabbed
1419 # Toggle between stacking/tabbed/split:
1420 bindsym $mod+x layout toggle
1422 # Toggle between stacking/tabbed/splith/splitv:
1423 bindsym $mod+x layout toggle all
1426 bindsym $mod+f fullscreen
1428 # Toggle floating/tiling
1429 bindsym $mod+t floating toggle
1432 === Focusing/Moving containers
1434 To change the focus, use the focus command: +focus left+, +focus right+, +focus
1435 down+ and +focus up+.
1437 There are a few special parameters you can use for the focus command:
1440 Sets focus to the +Parent Container+ of the current +Container+.
1442 The opposite of +focus parent+, sets the focus to the last focused
1445 Sets focus to the last focused floating container.
1447 Sets focus to the last focused tiling container.
1449 Toggles between floating/tiling containers.
1451 Followed by a direction or an output name, this will focus the
1452 corresponding output.
1454 For moving, use +move left+, +move right+, +move down+ and +move up+.
1457 -----------------------------------
1458 focus <left|right|down|up>
1459 focus <parent|child|floating|tiling|mode_toggle>
1460 focus output <<left|right|down|up>|output>
1461 move <left|right|down|up> [<px> px]
1462 move [absolute] position [[<px> px] [<px> px]|center]
1463 -----------------------------------
1465 Note that the amount of pixels you can specify for the +move+ command is only
1466 relevant for floating containers. The default amount is 10 pixels.
1469 ----------------------
1470 # Focus container on the left, bottom, top, right:
1471 bindsym $mod+j focus left
1472 bindsym $mod+k focus down
1473 bindsym $mod+l focus up
1474 bindsym $mod+semicolon focus right
1476 # Focus parent container
1477 bindsym $mod+u focus parent
1479 # Focus last floating/tiling container
1480 bindsym $mod+g focus mode_toggle
1482 # Focus the output right to the current one
1483 bindsym $mod+x focus output right
1485 # Focus the big output
1486 bindsym $mod+x focus output HDMI-2
1488 # Move container to the left, bottom, top, right:
1489 bindsym $mod+j move left
1490 bindsym $mod+k move down
1491 bindsym $mod+l move up
1492 bindsym $mod+semicolon move right
1494 # Move container, but make floating containers
1495 # move more than the default
1496 bindsym $mod+j move left 20 px
1498 # Move floating container to the center
1500 bindsym $mod+c move absolute position center
1501 ----------------------
1503 === Changing (named) workspaces/moving to workspaces
1505 To change to a specific workspace, use the +workspace+ command, followed by the
1506 number or name of the workspace. To move containers to specific workspaces, use
1507 +move container to workspace+.
1509 You can also switch to the next and previous workspace with the commands
1510 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1511 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1512 combination. To restrict those to the current output, use +workspace
1513 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1514 container to workspace next+, +move container to workspace prev+ to move a
1515 container to the next/previous workspace and +move container to workspace current+
1516 (the last one makes sense only when used with criteria).
1518 See <<move_to_outputs>> for how to move a container/workspace to a different
1522 To switch back to the previously focused workspace, use +workspace
1523 back_and_forth+; likewise, you can move containers to the previously focused
1524 workspace using +move container to workspace back_and_forth+.
1527 -----------------------------------
1528 workspace <next|prev|next_on_output|prev_on_output>
1529 workspace back_and_forth
1531 workspace number <name>
1533 move [window|container] [to] workspace <name>
1534 move [window|container] [to] workspace number <name>
1535 move [window|container] [to] workspace <prev|next|current>
1536 -----------------------------------
1539 -------------------------
1540 bindsym $mod+1 workspace 1
1541 bindsym $mod+2 workspace 2
1544 bindsym $mod+Shift+1 move container to workspace 1
1545 bindsym $mod+Shift+2 move container to workspace 2
1548 # switch between the current and the previously focused one
1549 bindsym $mod+b workspace back_and_forth
1550 bindsym $mod+Shift+b move container to workspace back_and_forth
1552 # move the whole workspace to the next output
1553 bindsym $mod+x move workspace to output right
1555 # move firefox to current workspace
1556 bindsym $mod+F1 [class="Firefox"] move workspace current
1557 -------------------------
1559 ==== Named workspaces
1561 Workspaces are identified by their name. So, instead of using numbers in the
1562 workspace command, you can use an arbitrary name:
1565 -------------------------
1566 bindsym $mod+1 workspace mail
1568 -------------------------
1570 If you want the workspace to have a number *and* a name, just prefix the
1574 -------------------------
1575 bindsym $mod+1 workspace 1: mail
1576 bindsym $mod+2 workspace 2: www
1578 -------------------------
1580 Note that the workspace will really be named "1: mail". i3 treats workspace
1581 names beginning with a number in a slightly special way. Normally, named
1582 workspaces are ordered the way they appeared. When they start with a number, i3
1583 will order them numerically. Also, you will be able to use +workspace number 1+
1584 to switch to the workspace which begins with number 1, regardless of which name
1585 it has. This is useful in case you are changing the workspace’s name
1586 dynamically. To combine both commands you can use +workspace number 1: mail+ to
1587 specify a default name if there's currently no workspace starting with a "1".
1589 ==== Renaming workspaces
1591 You can rename workspaces. This might be useful to start with the default
1592 numbered workspaces, do your work, and rename the workspaces afterwards to
1593 reflect what’s actually on them. You can also omit the old name to rename
1594 the currently focused workspace. This is handy if you want to use the
1595 rename command with +i3-input+.
1598 ----------------------------------------------------
1599 rename workspace <old_name> to <new_name>
1600 rename workspace to <new_name>
1601 ----------------------------------------------------
1604 --------------------------------------------------------------------------
1605 i3-msg 'rename workspace 5 to 6'
1606 i3-msg 'rename workspace 1 to "1: www"'
1607 i3-msg 'rename workspace "1: www" to "10: www"'
1608 i3-msg 'rename workspace to "2: mail"
1609 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
1610 --------------------------------------------------------------------------
1612 === Moving workspaces to a different screen
1614 See <<move_to_outputs>> for how to move a container/workspace to a different
1617 === Moving containers/workspaces to RandR outputs
1621 To move a container to another RandR output (addressed by names like +LVDS1+ or
1622 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
1623 +right+, +up+ or +down+), there are two commands:
1626 --------------------------------------------------------
1627 move container to output <<left|right|down|up>|<output>>
1628 move workspace to output <<left|right|down|up>|<output>>
1629 --------------------------------------------------------
1632 --------------------------------------------------------
1633 # Move the current workspace to the next output
1634 # (effectively toggles when you only have two outputs)
1635 bindsym $mod+x move workspace to output right
1637 # Put this window on the presentation output.
1638 bindsym $mod+x move container to output VGA1
1639 --------------------------------------------------------
1643 === Resizing containers/windows
1645 If you want to resize containers/windows using your keyboard, you can use the
1649 ---------------------------------------------------------
1650 resize <grow|shrink> <direction> [<px> px [or <ppt> ppt]]
1651 ---------------------------------------------------------
1653 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
1654 less specific and use +width+ or +height+, in which case i3 will take/give
1655 space from all the other containers. The optional pixel argument specifies by
1656 how many pixels a *floating container* should be grown or shrunk (the default
1657 is 10 pixels). The ppt argument means percentage points and specifies by how
1658 many percentage points a *tiling container* should be grown or shrunk (the
1659 default is 10 percentage points).
1661 I recommend using the resize command inside a so called +mode+:
1663 .Example: Configuration file, defining a mode for resizing
1664 ----------------------------------------------------------------------
1666 # These bindings trigger as soon as you enter the resize mode
1668 # Pressing left will shrink the window’s width.
1669 # Pressing right will grow the window’s width.
1670 # Pressing up will shrink the window’s height.
1671 # Pressing down will grow the window’s height.
1672 bindsym j resize shrink width 10 px or 10 ppt
1673 bindsym k resize grow height 10 px or 10 ppt
1674 bindsym l resize shrink height 10 px or 10 ppt
1675 bindsym semicolon resize grow width 10 px or 10 ppt
1677 # same bindings, but for the arrow keys
1678 bindsym Left resize shrink width 10 px or 10 ppt
1679 bindsym Down resize grow height 10 px or 10 ppt
1680 bindsym Up resize shrink height 10 px or 10 ppt
1681 bindsym Right resize grow width 10 px or 10 ppt
1683 # back to normal: Enter or Escape
1684 bindsym Return mode "default"
1685 bindsym Escape mode "default"
1689 bindsym $mod+r mode "resize"
1690 ----------------------------------------------------------------------
1692 === Jumping to specific windows
1694 Often when in a multi-monitor environment, you want to quickly jump to a
1695 specific window. For example, while working on workspace 3 you may want to
1696 jump to your mail client to email your boss that you’ve achieved some
1697 important goal. Instead of figuring out how to navigate to your mail client,
1698 it would be more convenient to have a shortcut. You can use the +focus+ command
1699 with criteria for that.
1702 ----------------------------------------------------
1703 [class="class"] focus
1704 [title="title"] focus
1705 ----------------------------------------------------
1708 ------------------------------------------------
1709 # Get me to the next open VIM instance
1710 bindsym $mod+a [class="urxvt" title="VIM"] focus
1711 ------------------------------------------------
1713 === VIM-like marks (mark/goto)
1717 This feature is like the jump feature: It allows you to directly jump to a
1718 specific window (this means switching to the appropriate workspace and setting
1719 focus to the windows). However, you can directly mark a specific window with
1720 an arbitrary label and use it afterwards. You can unmark the label in the same
1721 way, using the unmark command. If you don't specify a label, unmark removes all
1722 marks. You do not need to ensure that your windows have unique classes or
1723 titles, and you do not need to change your configuration file.
1725 As the command needs to include the label with which you want to mark the
1726 window, you cannot simply bind it to a key. +i3-input+ is a tool created
1727 for this purpose: It lets you input a command and sends the command to i3. It
1728 can also prefix this command and display a custom prompt for the input dialog.
1731 ------------------------------
1733 [con_mark="identifier"] focus
1735 ------------------------------
1737 *Example (in a terminal)*:
1738 ------------------------------
1740 $ i3-msg '[con_mark="irssi"] focus'
1741 $ i3-msg unmark irssi
1742 ------------------------------
1744 ///////////////////////////////////////////////////////////////////
1745 TODO: make i3-input replace %s
1747 ---------------------------------------
1748 # Read 1 character and mark the current window with this character
1749 bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
1751 # Read 1 character and go to the window with the character
1752 bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
1753 ---------------------------------------
1755 Alternatively, if you do not want to mess with +i3-input+, you could create
1756 seperate bindings for a specific set of labels and then only use those labels.
1757 ///////////////////////////////////////////////////////////////////
1759 === Changing border style
1761 To change the border of the current client, you can use +border normal+ to use the normal
1762 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
1763 and +border none+ to make the client borderless.
1765 There is also +border toggle+ which will toggle the different border styles.
1768 ----------------------------
1769 bindsym $mod+t border normal
1770 bindsym $mod+y border 1pixel
1771 bindsym $mod+u border none
1772 ----------------------------
1776 ///////////////////////////////////////////////////////////////////////////////
1777 TODO: not yet implemented
1778 === Changing the stack-limit of a container
1780 If you have a single container with a lot of windows inside it (say, more than
1781 10), the default layout of a stacking container can get a little unhandy.
1782 Depending on your screen’s size, you might end up with only half of the title
1783 lines being actually used, wasting a lot of screen space.
1785 Using the +stack-limit+ command, you can limit the number of rows or columns
1786 in a stacking container. i3 will create columns or rows (depending on what
1787 you limited) automatically as needed.
1790 --------------------------------
1791 stack-limit <cols|rows> <value>
1792 --------------------------------
1796 # I always want to have two window titles in one line
1799 # Not more than 5 rows in this stacking container
1803 image:stacklimit.png[Container limited to two columns]
1804 ///////////////////////////////////////////////////////////////////////////////
1808 === Enabling shared memory logging
1810 As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared
1811 memory buffer, which you can dump using +i3-dump-log+. The +shmlog+ command
1812 allows you to enable or disable the shared memory logging at runtime.
1814 Note that when using +shmlog <size_in_bytes>+, the current log will be
1815 discarded and a new one will be started.
1818 ------------------------------
1819 shmlog <size_in_bytes>
1820 shmlog <on|off|toggle>
1821 ------------------------------
1825 # Enable/disable logging
1826 bindsym $mod+x shmlog toggle
1828 # or, from a terminal:
1829 # increase the shared memory log buffer to 50 MiB
1830 i3-msg shmlog $((50*1024*1024))
1833 === Enabling debug logging
1835 The +debuglog+ command allows you to enable or disable debug logging at
1836 runtime. Debug logging is much more verbose than non-debug logging. This
1837 command does not activate shared memory logging (shmlog), and as such is most
1838 likely useful in combination with the above-described <<shmlog>> command.
1841 ------------------------
1842 debuglog <on|off|toggle>
1843 ------------------------
1846 ------------------------
1847 # Enable/disable logging
1848 bindsym $mod+x debuglog toggle
1849 ------------------------
1851 === Reloading/Restarting/Exiting
1853 You can make i3 reload its configuration file with +reload+. You can also
1854 restart i3 inplace with the +restart+ command to get it out of some weird state
1855 (if that should ever happen) or to perform an upgrade without having to restart
1856 your X session. To exit i3 properly, you can use the +exit+ command,
1857 however you don’t need to (simply killing your X session is fine as well).
1860 ----------------------------
1861 bindsym $mod+Shift+r restart
1862 bindsym $mod+Shift+w reload
1863 bindsym $mod+Shift+e exit
1864 ----------------------------
1868 There are two commands to use any existing window as scratchpad window. +move
1869 scratchpad+ will move a window to the scratchpad workspace. This will make it
1870 invisible until you show it again. There is no way to open that workspace.
1871 Instead, when using +scratchpad show+, the window will be shown again, as a
1872 floating window, centered on your current workspace (using +scratchpad show+ on
1873 a visible scratchpad window will make it hidden again, so you can have a
1874 keybinding to toggle). Note that this is just a normal floating window, so if
1875 you want to "remove it from scratchpad", you can simple make it tiling again
1876 (+floating toggle+).
1878 As the name indicates, this is useful for having a window with your favorite
1879 editor always at hand. However, you can also use this for other permanently
1880 running applications which you don’t want to see all the time: Your music
1881 player, alsamixer, maybe even your mail client…?
1891 ------------------------------------------------
1892 # Make the currently focused window a scratchpad
1893 bindsym $mod+Shift+minus move scratchpad
1895 # Show the first scratchpad window
1896 bindsym $mod+minus scratchpad show
1898 # Show the sup-mail scratchpad window, if any.
1899 bindsym mod4+s [title="^Sup ::"] scratchpad show
1900 ------------------------------------------------
1904 There are two options in the configuration of each i3bar instance that can be
1905 changed during runtime by invoking a command through i3. The commands +bar
1906 hidden_state+ and +bar mode+ allow setting the current hidden_state
1907 respectively mode option of each bar. It is also possible to toggle between
1908 hide state and show state as well as between dock mode and hide mode. Each
1909 i3bar instance can be controlled individually by specifying a bar_id, if none
1910 is given, the command is executed for all bar instances.
1914 bar hidden_state hide|show|toggle [<bar_id>]
1916 bar mode dock|hide|invisible|toggle [<bar_id>]
1920 ------------------------------------------------
1921 # Toggle between hide state and show state
1922 bindsym $mod+m bar hidden_state toggle
1924 # Toggle between dock mode and hide mode
1925 bindsym $mod+n bar mode toggle
1927 # Set the bar instance with id 'bar-1' to switch to hide mode
1928 bindsym $mod+b bar mode hide bar-1
1930 # Set the bar instance with id 'bar-1' to always stay hidden
1931 bindsym $mod+Shift+b bar mode invisible bar-1
1932 ------------------------------------------------
1936 == Multiple monitors
1938 As you can see in the goal list on the website, i3 was specifically developed
1939 with support for multiple monitors in mind. This section will explain how to
1940 handle multiple monitors.
1942 When you have only one monitor, things are simple. You usually start with
1943 workspace 1 on your monitor and open new ones as you need them.
1945 When you have more than one monitor, each monitor will get an initial
1946 workspace. The first monitor gets 1, the second gets 2 and a possible third
1947 would get 3. When you switch to a workspace on a different monitor, i3 will
1948 switch to that monitor and then switch to the workspace. This way, you don’t
1949 need shortcuts to switch to a specific monitor, and you don’t need to remember
1950 where you put which workspace. New workspaces will be opened on the currently
1951 active monitor. It is not possible to have a monitor without a workspace.
1953 The idea of making workspaces global is based on the observation that most
1954 users have a very limited set of workspaces on their additional monitors.
1955 They are often used for a specific task (browser, shell) or for monitoring
1956 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
1957 and "the rest" on the other monitors often makes sense. However, as you can
1958 create an unlimited number of workspaces in i3 and tie them to specific
1959 screens, you can have the "traditional" approach of having X workspaces per
1960 screen by changing your configuration (using modes, for example).
1962 === Configuring your monitors
1964 To help you get going if you have never used multiple monitors before, here is
1965 a short overview of the xrandr options which will probably be of interest to
1966 you. It is always useful to get an overview of the current screen configuration.
1967 Just run "xrandr" and you will get an output like the following:
1968 -------------------------------------------------------------------------------
1970 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
1971 VGA1 disconnected (normal left inverted right x axis y axis)
1972 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
1973 1280x800 60.0*+ 50.0
1974 1024x768 85.0 75.0 70.1 60.0
1976 800x600 85.1 72.2 75.0 60.3 56.2
1977 640x480 85.0 72.8 75.0 59.9
1981 --------------------------------------------------------------------------------------
1983 Several things are important here: You can see that +LVDS1+ is connected (of
1984 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
1985 connected to one of the ports but xrandr still says "disconnected", you should
1986 check your cable, monitor or graphics driver.
1988 The maximum resolution you can see at the end of the first line is the maximum
1989 combined resolution of your monitors. By default, it is usually too low and has
1990 to be increased by editing +/etc/X11/xorg.conf+.
1992 So, say you connected VGA1 and want to use it as an additional screen:
1993 -------------------------------------------
1994 xrandr --output VGA1 --auto --left-of LVDS1
1995 -------------------------------------------
1996 This command makes xrandr try to find the native resolution of the device
1997 connected to +VGA1+ and configures it to the left of your internal flat panel.
1998 When running "xrandr" again, the output looks like this:
1999 -------------------------------------------------------------------------------
2001 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
2002 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
2003 1280x1024 60.0*+ 75.0
2006 1024x768 75.1 70.1 60.0
2008 800x600 72.2 75.0 60.3 56.2
2009 640x480 72.8 75.0 66.7 60.0
2011 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
2012 1280x800 60.0*+ 50.0
2013 1024x768 85.0 75.0 70.1 60.0
2015 800x600 85.1 72.2 75.0 60.3 56.2
2016 640x480 85.0 72.8 75.0 59.9
2020 -------------------------------------------------------------------------------
2021 Please note that i3 uses exactly the same API as xrandr does, so it will see
2022 only what you can see in xrandr.
2024 See also <<presentations>> for more examples of multi-monitor setups.
2026 === Interesting configuration for multi-monitor environments
2028 There are several things to configure in i3 which may be interesting if you
2029 have more than one monitor:
2031 1. You can specify which workspace should be put on which screen. This
2032 allows you to have a different set of workspaces when starting than just
2033 1 for the first monitor, 2 for the second and so on. See
2034 <<workspace_screen>>.
2035 2. If you want some applications to generally open on the bigger screen
2036 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
2037 <<assign_workspace>>.
2038 3. If you have many workspaces on many monitors, it might get hard to keep
2039 track of which window you put where. Thus, you can use vim-like marks to
2040 quickly switch between windows. See <<vim_like_marks>>.
2041 4. For information on how to move existing workspaces between monitors,
2042 see <<_moving_containers_workspaces_to_randr_outputs>>.
2044 == i3 and the rest of your software world
2046 === Displaying a status line
2048 A very common thing amongst users of exotic window managers is a status line at
2049 some corner of the screen. It is an often superior replacement to the widget
2050 approach you have in the task bar of a traditional desktop environment.
2052 If you don’t already have your favorite way of generating such a status line
2053 (self-written scripts, conky, …), then i3status is the recommended tool for
2054 this task. It was written in C with the goal of using as few syscalls as
2055 possible to reduce the time your CPU is woken up from sleep states. Because
2056 i3status only spits out text, you need to combine it with some other tool, like
2057 i3bar. See <<status_command>> for how to display i3status in i3bar.
2059 Regardless of which application you use to display the status line, you
2060 want to make sure that it registers as a dock window using EWMH hints. i3 will
2061 position the window either at the top or at the bottom of the screen, depending
2062 on which hint the application sets. With i3bar, you can configure its position,
2063 see <<i3bar_position>>.
2065 === Giving presentations (multi-monitor)
2067 When giving a presentation, you typically want the audience to see what you see
2068 on your screen and then go through a series of slides (if the presentation is
2069 simple). For more complex presentations, you might want to have some notes
2070 which only you can see on your screen, while the audience can only see the
2074 ==== Case 1: everybody gets the same output
2075 This is the simple case. You connect your computer to the video projector,
2076 turn on both (computer and video projector) and configure your X server to
2077 clone the internal flat panel of your computer to the video output:
2078 -----------------------------------------------------
2079 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
2080 -----------------------------------------------------
2081 i3 will then use the lowest common subset of screen resolutions, the rest of
2082 your screen will be left untouched (it will show the X background). So, in
2083 our example, this would be 1024x768 (my notebook has 1280x800).
2085 ==== Case 2: you can see more than your audience
2086 This case is a bit harder. First of all, you should configure the VGA output
2087 somewhere near your internal flat panel, say right of it:
2088 -----------------------------------------------------
2089 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
2090 -----------------------------------------------------
2091 Now, i3 will put a new workspace (depending on your settings) on the new screen
2092 and you are in multi-monitor mode (see <<multi_monitor>>).
2094 Because i3 is not a compositing window manager, there is no ability to
2095 display a window on two screens at the same time. Instead, your presentation
2096 software needs to do this job (that is, open a window on each screen).