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 windows (Mod4)
30 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 inplace (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 a window
160 are not managed by i3, but by you. Using this mode violates the tiling
161 paradigm but can be useful for some corner cases like "Save as" dialog
162 windows, or toolbar windows (GIMP or similar). Those windows usually set the
163 appropriate hint and are opened in floating mode by default.
165 You can toggle floating mode for a window by pressing +$mod+Shift+Space+. By
166 dragging the window’s titlebar with your mouse you can move the window
167 around. By grabbing the borders and moving them you can resize the window. You
168 can also do that by using the <<floating_modifier>>.
170 For resizing floating windows with your keyboard, see <<resizingconfig>>.
172 Floating windows are always on top of tiling windows.
176 i3 stores all information about the X11 outputs, workspaces and layout of the
177 windows on them in a tree. The root node is the X11 root window, followed by
178 the X11 outputs, then dock areas and a content container, then workspaces and
179 finally the windows themselves. In previous versions of i3 we had multiple lists
180 (of outputs, workspaces) and a table for each workspace. That approach turned
181 out to be complicated to use (snapping), understand and implement.
183 === The tree consists of Containers
185 The building blocks of our tree are so called +Containers+. A +Container+ can
186 host a window (meaning an X11 window, one that you can actually see and use,
187 like a browser). Alternatively, it could contain one or more +Containers+. A
188 simple example is the workspace: When you start i3 with a single monitor, a
189 single workspace and you open two terminal windows, you will end up with a tree
192 image::tree-layout2.png["layout2",float="right"]
193 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
195 === Orientation and Split Containers
199 It is only natural to use so-called +Split Containers+ in order to build a
200 layout when using a tree as data structure. In i3, every +Container+ has an
201 orientation (horizontal, vertical or unspecified) and the orientation depends
202 on the layout the container is in (vertical for splitv and stacking, horizontal
203 for splith and tabbed). So, in our example with the workspace, the default
204 layout of the workspace +Container+ is splith (most monitors are widescreen
205 nowadays). If you change the layout to splitv (+$mod+l+ in the default config)
206 and *then* open two terminals, i3 will configure your windows like this:
208 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
210 An interesting new feature of i3 since version 4 is the ability to split anything:
211 Let’s assume you have two terminals on a workspace (with splith layout, that is
212 horizontal orientation), focus is on the right terminal. Now you want to open
213 another terminal window below the current one. If you would just open a new
214 terminal window, it would show up to the right due to the splith layout.
215 Instead, press +$mod+v+ to split the container with the splitv layout (to
216 open a +Horizontal Split Container+, use +$mod+h+). Now you can open a new
217 terminal and it will open below the current one:
219 image::tree-layout1.png["Layout",float="right"]
220 image::tree-shot1.png["shot",title="Vertical Split Container"]
224 You probably guessed it already: There is no limit on how deep your hierarchy
229 Let’s stay with our example from above. We have a terminal on the left and two
230 vertically split terminals on the right, focus is on the bottom right one. When
231 you open a new terminal, it will open below the current one.
233 So, how can you open a new terminal window to the *right* of the current one?
234 The solution is to use +focus parent+, which will focus the +Parent Container+ of
235 the current +Container+. In this case, you would focus the +Vertical Split
236 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
237 windows will be opened to the right of the +Vertical Split Container+:
239 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
241 === Implicit containers
243 In some cases, i3 needs to implicitly create a container to fulfill your
246 One example is the following scenario: You start i3 with a single monitor and a
247 single workspace on which you open three terminal windows. All these terminal
248 windows are directly attached to one node inside i3’s layout tree, the
249 workspace node. By default, the workspace node’s orientation is +horizontal+.
251 Now you move one of these terminals down (+$mod+k+ by default). The workspace
252 node’s orientation will be changed to +vertical+. The terminal window you moved
253 down is directly attached to the workspace and appears on the bottom of the
254 screen. A new (horizontal) container was created to accomodate the other two
255 terminal windows. You will notice this when switching to tabbed mode (for
256 example). You would end up having one tab called "another container" and the
257 other one being the terminal window you moved down.
262 This is where the real fun begins ;-). Most things are very dependant on your
263 ideal working environment so we can’t make reasonable defaults for them.
265 While not using a programming language for the configuration, i3 stays
266 quite flexible in regards to the things you usually want your window manager
269 For example, you can configure bindings to jump to specific windows,
270 you can set specific applications to start on specific workspaces, you can
271 automatically start applications, you can change the colors of i3, and you
272 can bind your keys to do useful things.
274 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
275 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
278 On first start (and on all following starts, unless you have a configuration
279 file), i3 will offer you to create a configuration file. You can tell the
280 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
281 file. Also, the created config file will use the key symbols of your current
282 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
283 Please note that you must not have +~/.i3/config+, otherwise the wizard will
288 It is possible and recommended to use comments in your configuration file to
289 properly document your setup for later reference. Comments are started with
290 a # and can only be used at the beginning of a line:
301 i3 has support for both X core fonts and FreeType fonts (through Pango) to
302 render window titles.
304 To generate an X core font description, you can use +xfontsel(1)+. To see
305 special characters (Unicode), you need to use a font which supports the
308 A FreeType font description is composed by a font family, a style, a weight,
309 a variant, a stretch and a size.
310 FreeType fonts support right-to-left rendering and contain often more
311 Unicode glyphs than X core fonts.
313 If i3 cannot open the configured font, it will output an error in the logfile
314 and fall back to a working font.
317 ------------------------------
318 font <X core font description>
319 font pango:[family list] [style options] [size]
320 ------------------------------
323 --------------------------------------------------------------
324 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
325 font pango:DejaVu Sans Mono 10
326 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
327 font pango:Terminus 11x
328 --------------------------------------------------------------
332 === Keyboard bindings
334 A keyboard binding makes i3 execute a command (see below) upon pressing a
335 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
336 also mix your bindings, though i3 will not protect you from overlapping ones).
338 * A keysym (key symbol) is a description for a specific symbol, like "a"
339 or "b", but also more strange ones like "underscore" instead of "_". These
340 are the ones you use in Xmodmap to remap your keys. To get the current
341 mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
342 see what keysym it is configured to, use +xev+.
344 * Keycodes do not need to have a symbol assigned (handy for custom vendor
345 hotkeys on some notebooks) and they will not change their meaning as you
346 switch to a different keyboard layout (when using +xmodmap+).
348 My recommendation is: If you often switch keyboard layouts but you want to keep
349 your bindings in the same physical location on the keyboard, use keycodes.
350 If you don’t switch layouts, and want a clean and simple config file, use
353 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
354 KeyPress event, because the keyboard/pointer is still grabbed. For these
355 situations, the +--release+ flag can be used, which will execute the command
356 after the keys have been released.
359 ----------------------------------
360 bindsym [--release] [Modifiers+]keysym command
361 bindcode [--release] [Modifiers+]keycode command
362 ----------------------------------
365 --------------------------------
367 bindsym $mod+f fullscreen
370 bindsym $mod+Shift+r restart
372 # Notebook-specific hotkeys
373 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
375 # Simulate ctrl+v upon pressing $mod+x
376 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
378 # Take a screenshot upon pressing $mod+x (select an area)
379 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
380 --------------------------------
384 Mod1-Mod5, Shift, Control::
385 Standard modifiers, see +xmodmap(1)+
388 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
389 you to remap capslock (for example) to Mode_switch and use it for both: typing
390 umlauts or special characters 'and' having some comfortably reachable key
391 bindings. For example, when typing, capslock+1 or capslock+2 for switching
392 workspaces is totally convenient. Try it :-).
394 [[floating_modifier]]
396 === The floating modifier
398 To move floating windows with your mouse, you can either grab their titlebar
399 or configure the so called floating modifier which you can then press and
400 click anywhere in the window itself to move it. The most common setup is to
401 use the same key you use for managing windows (Mod1 for example). Then
402 you can press Mod1, click into a window using your left mouse button, and drag
403 it to the position you want.
405 When holding the floating modifier, you can resize a floating window by
406 pressing the right mouse button on it and moving around while holding it. If
407 you hold the shift button as well, the resize will be proportional (the aspect
408 ratio will be preserved).
411 --------------------------------
412 floating_modifier <Modifiers>
413 --------------------------------
416 --------------------------------
417 floating_modifier Mod1
418 --------------------------------
420 === Constraining floating window size
422 The maximum and minimum dimensions of floating windows can be specified. If
423 either dimension of +floating_maximum_size+ is specified as -1, that dimension
424 will be unconstrained with respect to its maximum value. If either dimension of
425 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
426 value to constrain the maximum size. +floating_minimum_size+ is treated in a
427 manner analogous to +floating_maximum_size+.
430 ----------------------------------------
431 floating_minimum_size <width> x <height>
432 floating_maximum_size <width> x <height>
433 ----------------------------------------
436 --------------------------------------
437 floating_minimum_size 75 x 50
438 floating_maximum_size -1 x -1
439 --------------------------------------
441 === Orientation for new workspaces
443 New workspaces get a reasonable default orientation: Wide-screen monitors
444 (anything wider than high) get horizontal orientation, rotated monitors
445 (anything higher than wide) get vertical orientation.
447 With the +default_orientation+ configuration directive, you can override that
451 ----------------------------------------------
452 default_orientation <horizontal|vertical|auto>
453 ----------------------------------------------
456 ----------------------------
457 default_orientation vertical
458 ----------------------------
460 === Layout mode for new containers
462 This option determines in which mode new containers on workspace level will
464 ///////////////////////////////
465 See also <<stack-limit>>.
466 //////////////////////////////
469 ---------------------------------------------
470 workspace_layout <default|stacking|tabbed>
471 ---------------------------------------------
472 /////////////////////////////////////////////
473 new_container stack-limit <cols|rows> <value>
474 /////////////////////////////////////////////
477 ---------------------
478 workspace_layout tabbed
479 ---------------------
481 === Border style for new windows
483 This option determines which border style new windows will have. The default is
487 ---------------------------------------------
488 new_window <normal|1pixel|none|pixel>
489 ---------------------------------------------
491 ---------------------
493 ---------------------
495 The "normal" and "pixel" border styles support an optional border width in
499 ---------------------
500 # The same as new_window none
505 ---------------------
508 === Hiding vertical borders
510 You can hide vertical borders adjacent to the screen edges using
511 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
512 to waste even two pixels in displayspace. Default is none.
515 ----------------------------
516 hide_edge_borders <none|vertical|horizontal|both>
517 ----------------------------
520 ----------------------
521 hide_edge_borders vertical
522 ----------------------
524 === Arbitrary commands for specific windows (for_window)
526 With the +for_window+ command, you can let i3 execute any command when it
527 encounters a specific window. This can be used to set windows to floating or to
528 change their border style, for example.
531 -----------------------------
532 for_window <criteria> command
533 -----------------------------
536 ------------------------------------------------
537 # enable floating mode for all XTerm windows
538 for_window [class="XTerm"] floating enable
540 # Make all urxvts use a 1-pixel border:
541 for_window [class="urxvt"] border 1pixel
543 # A less useful, but rather funny example:
544 # makes the window floating as soon as I change
545 # directory to ~/work
546 for_window [title="x200: ~/work"] floating enable
547 ------------------------------------------------
549 The valid criteria are the same as those for commands, see <<command_criteria>>.
553 As you learned in the section about keyboard bindings, you will have
554 to configure lots of bindings containing modifier keys. If you want to save
555 yourself some typing and be able to change the modifier you use later,
556 variables can be handy.
564 ------------------------
566 bindsym $m+Shift+r restart
567 ------------------------
569 Variables are directly replaced in the file when parsing. There is no fancy
570 handling and there are absolutely no plans to change this. If you need a more
571 dynamic configuration you should create a little script which generates a
572 configuration file and run it before starting i3 (for example in your
575 === Automatically putting clients on specific workspaces
579 To automatically make a specific window show up on a specific workspace, you
580 can use an *assignment*. You can match windows by using any criteria,
581 see <<command_criteria>>. It is recommended that you match on window classes
582 (and instances, when appropriate) instead of window titles whenever possible
583 because some applications first create their window, and then worry about
584 setting the correct title. Firefox with Vimperator comes to mind. The window
585 starts up being named Firefox, and only when Vimperator is loaded does the
586 title change. As i3 will get the title as soon as the application maps the
587 window (mapping means actually displaying it on the screen), you’d need to have
588 to match on 'Firefox' in this case.
591 ------------------------------------------------------------
592 assign <criteria> [→] workspace
593 ------------------------------------------------------------
596 ----------------------
597 # Assign URxvt terminals to workspace 2
598 assign [class="URxvt"] 2
600 # Same thing, but more precise (exact match instead of substring)
601 assign [class="^URxvt$"] 2
603 # Same thing, but with a beautiful arrow :)
604 assign [class="^URxvt$"] → 2
606 # Assignment to a named workspace
607 assign [class="^URxvt$"] → work
609 # Start urxvt -name irssi
610 assign [class="^URxvt$" instance="^irssi$"] → 3
611 ----------------------
613 Note that the arrow is not required, it just looks good :-). If you decide to
614 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
616 To get the class and instance, you can use +xprop+. After clicking on the
617 window, you will see the following output:
620 -----------------------------------
621 WM_CLASS(STRING) = "irssi", "URxvt"
622 -----------------------------------
624 The first part of the WM_CLASS is the instance ("irssi" in this example), the
625 second part is the class ("URxvt" in this example).
627 Should you have any problems with assignments, make sure to check the i3
628 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
629 details about the matching process and the window’s actual class, instance and
630 title when starting up.
632 Note that if you want to start an application just once on a specific
633 workspace, but you don’t want to assign all instances of it permanently, you
634 can make use of i3’s startup-notification support (see <<exec>>) in your config
635 file in the following way:
637 *Start iceweasel on workspace 3 (once)*:
638 -------------------------------------------------------------------------------
639 # Start iceweasel on workspace 3, then switch back to workspace 1
640 # (Being a command-line utility, i3-msg does not support startup notifications,
641 # hence the exec --no-startup-id.)
642 # (Starting iceweasel with i3’s exec command is important in order to make i3
643 # create a startup notification context, without which the iceweasel window(s)
644 # cannot be matched onto the workspace on which the command was started.)
645 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
646 -------------------------------------------------------------------------------
648 === Automatically starting applications on i3 startup
650 By using the +exec+ keyword outside a keybinding, you can configure
651 which commands will be performed by i3 on initial startup. +exec+
652 commands will not run when restarting i3, if you need a command to run
653 also when restarting i3 you should use the +exec_always+
654 keyword. These commands will be run in order.
658 exec [--no-startup-id] command
659 exec_always [--no-startup-id] command
663 --------------------------------
665 exec_always ~/my_script.sh
667 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
668 exec --no-startup-id urxvt
669 --------------------------------
671 The flag --no-startup-id is explained in <<exec>>.
675 === Automatically putting workspaces on specific screens
677 If you assign clients to workspaces, it might be handy to put the
678 workspaces on specific screens. Also, the assignment of workspaces to screens
679 will determine which workspace i3 uses for a new screen when adding screens
680 or when starting (e.g., by default it will use 1 for the first screen, 2 for
681 the second screen and so on).
684 ----------------------------------
685 workspace <workspace> output <output>
686 ----------------------------------
688 The 'output' is the name of the RandR output you attach your screen to. On a
689 laptop, you might have VGA1 and LVDS1 as output names. You can see the
690 available outputs by running +xrandr --current+.
692 If you use named workspaces, they must be quoted:
695 ---------------------------
696 workspace 1 output LVDS1
697 workspace 5 output VGA1
698 workspace "2: vim" output VGA1
699 ---------------------------
703 You can change all colors which i3 uses to draw the window decorations.
706 --------------------------------------------
707 colorclass border background text indicator
708 --------------------------------------------
710 Where colorclass can be one of:
713 A client which currently has the focus.
714 client.focused_inactive::
715 A client which is the focused one of its container, but it does not have
716 the focus at the moment.
718 A client which is not the focused one of its container.
720 A client which has its urgency hint activated.
722 You can also specify the color to be used to paint the background of the client
723 windows. This color will be used to paint the window on top of which the client
727 -----------------------
728 client.background color
729 -----------------------
731 Only clients that do not cover the whole area of this window expose the color
732 used to paint it. If you use a color other than black for your terminals, you
733 most likely want to set the client background color to the same color as your
734 terminal program's background color to avoid black gaps between the rendered
735 area of the terminal and the i3 border.
737 Colors are in HTML hex format (#rrggbb), see the following example:
739 *Examples (default colors)*:
740 ---------------------------------------------------------
741 # class border backgr. text indicator
742 client.focused #4c7899 #285577 #ffffff #2e9ef4
743 client.focused_inactive #333333 #5f676a #ffffff #484e50
744 client.unfocused #333333 #222222 #888888 #292d2e
745 client.urgent #2f343a #900000 #ffffff #900000
746 ---------------------------------------------------------
748 Note that for the window decorations, the color around the child window is the
749 background color, and the border color is only the two thin lines at the top of
752 The indicator color is used for indicating where a new window will be opened.
753 For horizontal split containers, the right border will be painted in indicator
754 color, for vertical split containers, the bottom border. This only applies to
755 single windows within a split container, which are otherwise indistinguishable
756 from single windows outside of a split container.
758 === Interprocess communication
760 i3 uses unix sockets to provide an IPC interface. This allows third-party
761 programs to get information from i3, such as the current workspaces
762 (to display a workspace bar), and to control i3.
764 The IPC socket is enabled by default and will be created in
765 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
766 the PID of i3 and XXXXXX is a string of random characters from the portable
767 filename character set (see mkdtemp(3)).
769 You can override the default path through the environment-variable +I3SOCK+ or
770 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
771 does the right thing by default. If you decide to change it, it is strongly
772 recommended to set this to a location in your home directory so that no other
773 user can create that directory.
776 ----------------------------
777 ipc-socket ~/.i3/i3-ipc.sock
778 ----------------------------
780 You can then use the +i3-msg+ application to perform any command listed in
783 === Focus follows mouse
785 By default, window focus follows your mouse movements. However, if you have a
786 setup where your mouse usually is in your way (like a touchpad on your laptop
787 which you do not want to disable completely), you might want to disable 'focus
788 follows mouse' and control focus only by using your keyboard. The mouse will
789 still be useful inside the currently active window (for example to click on
790 links in your browser window).
793 ----------------------------
794 focus_follows_mouse <yes|no>
795 ----------------------------
798 ----------------------
799 focus_follows_mouse no
800 ----------------------
802 === Popups during fullscreen mode
804 When you are in fullscreen mode, some applications still open popup windows
805 (take Xpdf for example). This is because these applications may not be aware
806 that they are in fullscreen mode (they do not check the corresponding hint).
807 There are three things which are possible to do in this situation:
809 1. Display the popup if it belongs to the fullscreen application only. This is
810 the default and should be reasonable behavior for most users.
811 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
812 in fullscreen. However, some apps might react badly to this (deadlock until
813 you go out of fullscreen).
814 3. Leave fullscreen mode.
817 -------------------------------------------------
818 popup_during_fullscreen <smart|ignore|leave_fullscreen>
819 -------------------------------------------------
822 ------------------------------
823 popup_during_fullscreen smart
824 ------------------------------
828 When being in a tabbed or stacked container, the first container will be
829 focused when you use +focus down+ on the last container -- the focus wraps. If
830 however there is another stacked/tabbed container in that direction, focus will
831 be set on that container. This is the default behaviour so you can navigate to
832 all your windows without having to use +focus parent+.
834 If you want the focus to *always* wrap and you are aware of using +focus
835 parent+ to switch to different containers, you can use the
836 +force_focus_wrapping+ configuration directive. After enabling it, the focus
840 -----------------------------
841 force_focus_wrapping <yes|no>
842 -----------------------------
845 ------------------------
846 force_focus_wrapping yes
847 ------------------------
851 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
852 video drivers (especially the nVidia binary driver) only provide support for
853 Xinerama instead of RandR. In such a situation, i3 must be told to use the
854 inferior Xinerama API explicitly and therefore don’t provide support for
855 reconfiguring your screens on the fly (they are read only once on startup and
858 For people who do cannot modify their +~/.xsession+ to add the
859 +--force-xinerama+ commandline parameter, a configuration option is provided:
862 -----------------------
863 force_xinerama <yes|no>
864 -----------------------
871 Also note that your output names are not descriptive (like +HDMI1+) when using
872 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
874 === Automatic back-and-forth when switching to the current workspace
876 This configuration directive enables automatic +workspace back_and_forth+ (see
877 <<back_and_forth>>) when switching to the workspace that is currently focused.
879 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
880 mod+2 because somebody sent you a message. You don’t need to remember where you
881 came from now, you can just press $mod+2 again to switch back to "1: www".
884 --------------------------------------
885 workspace_auto_back_and_forth <yes|no>
886 --------------------------------------
889 ---------------------------------
890 workspace_auto_back_and_forth yes
891 ---------------------------------
893 === Delaying urgency hint reset on workspace change
895 If an application on another workspace sets an urgency hint, switching to this
896 workspace may lead to immediate focus of the application, which also means the
897 window decoration color would be immediately resetted to +client.focused+. This
898 may make it unnecessarily hard to tell which window originally raised the
901 In order to prevent this, you can tell i3 to delay resetting the urgency state
902 by a certain time using the +force_display_urgency_hint+ directive. Setting the
903 value to 0 disables this feature.
905 The default is 500ms.
908 ---------------------------------------
909 force_display_urgency_hint <timeout> ms
910 ---------------------------------------
913 ---------------------------------
914 force_display_urgency_hint 500 ms
915 ---------------------------------
919 The bar at the bottom of your monitor is drawn by a separate process called
920 i3bar. Having this part of "the i3 user interface" in a separate process has
923 1. It is a modular approach. If you don’t need a workspace bar at all, or if
924 you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
925 just remove the i3bar configuration and start your favorite bar instead.
926 2. It follows the UNIX philosophy of "Make each program do one thing well".
927 While i3 manages your windows well, i3bar is good at displaying a bar on
928 each monitor (unless you configure it otherwise).
929 3. It leads to two separate, clean codebases. If you want to understand i3, you
930 don’t need to bother with the details of i3bar and vice versa.
932 That said, i3bar is configured in the same configuration file as i3. This is
933 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
934 are useful for people using other window managers). Therefore, it makes no
935 sense to use a different configuration place when we already have a good
936 configuration infrastructure in place.
938 Configuring your workspace bar starts with opening a +bar+ block. You can have
939 multiple bar blocks to use different settings for different outputs (monitors):
942 ---------------------------
944 status_command i3status
946 ---------------------------
950 By default i3 will just pass +i3bar+ and let your shell handle the execution,
951 searching your +$PATH+ for a correct version.
952 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
953 tell i3 what to execute.
955 The specified command will be passed to +sh -c+, so you can use globbing and
956 have to have correct quoting etc.
959 ----------------------
960 i3bar_command command
961 ----------------------
964 -------------------------------------------------
966 i3bar_command /home/user/bin/i3bar
968 -------------------------------------------------
971 === Statusline command
973 i3bar can run a program and display every line of its +stdout+ output on the
974 right hand side of the bar. This is useful to display system information like
975 your current IP address, battery status or date/time.
977 The specified command will be passed to +sh -c+, so you can use globbing and
978 have to have correct quoting etc.
981 ----------------------
982 status_command command
983 ----------------------
986 -------------------------------------------------
988 status_command i3status --config ~/.i3status.conf
990 -------------------------------------------------
994 You can have i3bar either be visible permanently at one edge of the screen
995 (+dock+ mode) or make it show up when you press your modifier key (+hide+
996 mode). The modifier key can be configured using the +modifier+ option.
998 The hide mode maximizes screen space that can be used for actual windows. Also,
999 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1002 The default is dock mode; in hide mode, the default modifier is Mod4 (usually
1019 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
1024 This option determines in which edge of the screen i3bar should show up.
1026 The default is bottom.
1029 ---------------------
1030 position <top|bottom>
1031 ---------------------
1034 ---------------------
1038 ---------------------
1042 You can restrict i3bar to one or more outputs (monitors). The default is to
1043 handle all outputs. Restricting the outputs is useful for using different
1044 options for different outputs by using multiple 'bar' blocks.
1046 To make a particular i3bar instance handle multiple outputs, specify the output
1047 directive multiple times.
1055 -------------------------------
1056 # big monitor: everything
1058 # The display is connected either via HDMI or via DisplayPort
1061 status_command i3status
1064 # laptop monitor: bright colors and i3status with less modules.
1067 status_command i3status --config ~/.i3status-small.conf
1073 -------------------------------
1077 i3bar by default provides a system tray area where programs such as
1078 NetworkManager, VLC, Pidgin, etc. can place little icons.
1080 You can configure on which output (monitor) the icons should be displayed or
1081 you can turn off the functionality entirely.
1084 -------------------------
1085 tray_output <none|primary|output>
1086 -------------------------
1089 -------------------------
1090 # disable system tray
1095 # show tray icons on the primary monitor
1098 # show tray icons on the big monitor
1102 -------------------------
1104 Note that you might not have a primary output configured yet. To do so, run:
1105 -------------------------
1106 xrandr --output <output> --primary
1107 -------------------------
1111 Specifies the font to be used in the bar. See <<fonts>>.
1114 ---------------------
1116 ---------------------
1119 --------------------------------------------------------------
1121 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1122 font pango:DejaVu Sans Mono 10
1124 --------------------------------------------------------------
1126 === Workspace buttons
1128 Specifies whether workspace buttons should be shown or not. This is useful if
1129 you want to display a statusline-only bar containing additional information.
1131 The default is to show workspace buttons.
1134 --------------------------
1135 workspace_buttons <yes|no>
1136 --------------------------
1139 --------------------
1141 workspace_buttons no
1143 --------------------
1147 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1148 be configured at the moment:
1151 Background color of the bar.
1153 Text color to be used for the statusline.
1155 Border, background and text color for a workspace button when the workspace
1158 Border, background and text color for a workspace button when the workspace
1159 is active (visible) on some output, but the focus is on another one.
1160 You can only tell this apart from the focused workspace when you are
1161 using multiple monitors.
1162 inactive_workspace::
1163 Border, background and text color for a workspace button when the workspace
1164 does not have focus and is not active (visible) on any output. This
1165 will be the case for most workspaces.
1167 Border, background and text color for a workspace button when the workspace
1168 window with the urgency hint set.
1171 ----------------------------------------
1176 colorclass <border> <background> <text>
1178 ----------------------------------------
1180 *Example (default colors)*:
1181 --------------------------------------
1187 focused_workspace #4c7899 #285577 #ffffff
1188 active_workspace #333333 #5f676a #ffffff
1189 inactive_workspace #333333 #222222 #888888
1190 urgent_workspace #2f343a #900000 #ffffff
1193 --------------------------------------
1197 Commands are what you bind to specific keypresses. You can also issue commands
1198 at runtime without pressing a key by using the IPC interface. An easy way to
1199 do this is to use the +i3-msg+ utility:
1202 --------------------------
1203 # execute this on your shell to make the current container borderless
1205 --------------------------
1207 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1208 specific workspace and immediately switch to that workspace, you can configure
1209 the following keybinding:
1212 --------------------------------------------------------
1213 bindsym $mod+x move container to workspace 3; workspace 3
1214 --------------------------------------------------------
1216 [[command_criteria]]
1218 Furthermore, you can change the scope of a command, that is, which containers
1219 should be affected by that command, by using various criteria. These are
1220 prefixed in square brackets to every command. If you want to kill all windows
1221 which have the class Firefox, use:
1224 ------------------------------------
1225 bindsym $mod+x [class="Firefox"] kill
1227 # same thing, but case-insensitive
1228 bindsym $mod+x [class="(?i)firefox"] kill
1229 ------------------------------------
1231 The criteria which are currently implemented are:
1234 Compares the window class (the second part of WM_CLASS)
1236 Compares the window instance (the first part of WM_CLASS)
1238 Compares the window role (WM_WINDOW_ROLE).
1240 Compares the X11 window ID, which you can get via +xwininfo+ for example.
1242 Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
1244 Compares the urgent state of the window. Can be "latest" or "oldest".
1245 Matches the latest or oldest urgent window, respectively.
1246 (The following aliases are also available: newest, last, recent, first)
1248 Compares the mark set for this container, see <<vim_like_marks>>.
1250 Compares the i3-internal container ID, which you can get via the IPC
1251 interface. Handy for scripting.
1253 The criteria +class+, +instance+, +role+, +title+ and +mark+ are actually
1254 regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1255 information on how to use them.
1259 === Executing applications (exec)
1261 What good is a window manager if you can’t actually start any applications?
1262 The exec command starts an application by passing the command you specify to a
1263 shell. This implies that you can use globbing (wildcards) and programs will be
1264 searched in your $PATH.
1267 ------------------------------
1268 exec [--no-startup-id] command
1269 ------------------------------
1272 ------------------------------
1274 bindsym $mod+g exec gimp
1276 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1277 bindsym $mod+Return exec --no-startup-id urxvt
1278 ------------------------------
1280 The +--no-startup-id+ parameter disables startup-notification support for this
1281 particular exec command. With startup-notification, i3 can make sure that a
1282 window appears on the workspace on which you used the exec command. Also, it
1283 will change the X11 cursor to +watch+ (a clock) while the application is
1284 launching. So, if an application is not startup-notification aware (most GTK
1285 and Qt using applications seem to be, though), you will end up with a watch
1286 cursor for 60 seconds.
1288 === Splitting containers
1290 The split command makes the current window a split container. Split containers
1291 can contain multiple windows. Depending on the layout of the split container,
1292 new windows get placed to the right of the current one (splith) or new windows
1293 get placed below the current one (splitv).
1295 If you apply this command to a split container with the same orientation,
1296 nothing will happen. If you use a different orientation, the split container’s
1297 orientation will be changed (if it does not have more than one window). Use
1298 +layout toggle split+ to change the layout of any split container from splitv
1299 to splith or vice-versa.
1302 ---------------------------
1303 split <vertical|horizontal>
1304 ---------------------------
1307 ------------------------------
1308 bindsym $mod+v split vertical
1309 bindsym $mod+h split horizontal
1310 ------------------------------
1312 === Manipulating layout
1314 Use +layout toggle split+, +layout stacking+ or +layout tabbed+ to change the
1315 current container layout to splith/splitv, stacking or tabbed layout,
1318 To make the current window (!) fullscreen, use +fullscreen+, to make
1319 it floating (or tiling again) use +floating enable+ respectively +floating disable+
1320 (or +floating toggle+):
1324 layout <tabbed|stacking>
1325 layout toggle [split|all]
1330 bindsym $mod+s layout stacking
1331 bindsym $mod+l layout toggle split
1332 bindsym $mod+w layout tabbed
1334 # Toggle between stacking/tabbed/split:
1335 bindsym $mod+x layout toggle
1337 # Toggle between stacking/tabbed/splith/splitv:
1338 bindsym $mod+x layout toggle all
1341 bindsym $mod+f fullscreen
1343 # Toggle floating/tiling
1344 bindsym $mod+t floating toggle
1347 === Focusing/Moving containers
1349 To change the focus, use the focus command: +focus left+, +focus right+, +focus
1350 down+ and +focus up+.
1352 There are a few special parameters you can use for the focus command:
1355 Sets focus to the +Parent Container+ of the current +Container+.
1357 The opposite of +focus parent+, sets the focus to the last focused
1360 Sets focus to the last focused floating container.
1362 Sets focus to the last focused tiling container.
1364 Toggles between floating/tiling containers.
1366 Followed by a direction or an output name, this will focus the
1367 corresponding output.
1369 For moving, use +move left+, +move right+, +move down+ and +move up+.
1372 -----------------------------------
1373 focus <left|right|down|up>
1374 focus <parent|child|floating|tiling|mode_toggle>
1375 focus output <<left|right|down|up>|output>
1376 move <left|right|down|up> [<px> px]
1377 move [absolute] position [[<px> px] [<px> px]|center]
1378 -----------------------------------
1380 Note that the amount of pixels you can specify for the +move+ command is only
1381 relevant for floating containers. The default amount is 10 pixels.
1384 ----------------------
1385 # Focus container on the left, bottom, top, right:
1386 bindsym $mod+j focus left
1387 bindsym $mod+k focus down
1388 bindsym $mod+l focus up
1389 bindsym $mod+semicolon focus right
1391 # Focus parent container
1392 bindsym $mod+u focus parent
1394 # Focus last floating/tiling container
1395 bindsym $mod+g focus mode_toggle
1397 # Focus the output right to the current one
1398 bindsym $mod+x focus output right
1400 # Focus the big output
1401 bindsym $mod+x focus output HDMI-2
1403 # Move container to the left, bottom, top, right:
1404 bindsym $mod+j move left
1405 bindsym $mod+k move down
1406 bindsym $mod+l move up
1407 bindsym $mod+semicolon move right
1409 # Move container, but make floating containers
1410 # move more than the default
1411 bindsym $mod+j move left 20 px
1413 # Move floating container to the center
1415 bindsym $mod+c move absolute position center
1416 ----------------------
1418 === Changing (named) workspaces/moving to workspaces
1420 To change to a specific workspace, use the +workspace+ command, followed by the
1421 number or name of the workspace. To move containers to specific workspaces, use
1422 +move container to workspace+.
1424 You can also switch to the next and previous workspace with the commands
1425 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1426 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1427 combination. To restrict those to the current output, use +workspace
1428 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1429 container to workspace next+, +move container to workspace prev+ to move a
1430 container to the next/previous workspace and +move container to workspace current+
1431 (the last one makes sense only when used with criteria).
1433 See <<move_to_outputs>> for how to move a container/workspace to a different
1437 To switch back to the previously focused workspace, use +workspace
1438 back_and_forth+; likewise, you can move containers to the previously focused
1439 workspace using +move container to workspace back_and_forth+.
1442 -----------------------------------
1443 workspace <next|prev|next_on_output|prev_on_output>
1444 workspace back_and_forth
1446 workspace number <name>
1448 move [window|container] [to] workspace <name>
1449 move [window|container] [to] workspace number <name>
1450 move [window|container] [to] workspace <prev|next|current>
1451 -----------------------------------
1454 -------------------------
1455 bindsym $mod+1 workspace 1
1456 bindsym $mod+2 workspace 2
1459 bindsym $mod+Shift+1 move container to workspace 1
1460 bindsym $mod+Shift+2 move container to workspace 2
1463 # switch between the current and the previously focused one
1464 bindsym $mod+b workspace back_and_forth
1465 bindsym $mod+Shift+b move container to workspace back_and_forth
1467 # move the whole workspace to the next output
1468 bindsym $mod+x move workspace to output right
1470 # move firefox to current workspace
1471 bindsym $mod+F1 [class="Firefox"] move workspace current
1472 -------------------------
1474 ==== Named workspaces
1476 Workspaces are identified by their name. So, instead of using numbers in the
1477 workspace command, you can use an arbitrary name:
1480 -------------------------
1481 bindsym $mod+1 workspace mail
1483 -------------------------
1485 If you want the workspace to have a number *and* a name, just prefix the
1489 -------------------------
1490 bindsym $mod+1 workspace 1: mail
1491 bindsym $mod+2 workspace 2: www
1493 -------------------------
1495 Note that the workspace will really be named "1: mail". i3 treats workspace
1496 names beginning with a number in a slightly special way. Normally, named
1497 workspaces are ordered the way they appeared. When they start with a number, i3
1498 will order them numerically. Also, you will be able to use +workspace number 1+
1499 to switch to the workspace which begins with number 1, regardless of which name
1500 it has. This is useful in case you are changing the workspace’s name
1501 dynamically. To combine both commands you can use +workspace number 1: mail+ to
1502 specify a default name if there's currently no workspace starting with a "1".
1504 ==== Renaming workspaces
1506 You can rename workspaces. This might be useful to start with the default
1507 numbered workspaces, do your work, and rename the workspaces afterwards to
1508 reflect what’s actually on them. You can also omit the old name to rename
1509 the currently focused workspace. This is handy if you wan't to use the
1510 rename command with +i3-input+.
1513 ----------------------------------------------------
1514 rename workspace <old_name> to <new_name>
1515 rename workspace to <new_name>
1516 ----------------------------------------------------
1519 --------------------------------------------------------------------------
1520 i3-msg 'rename workspace 5 to 6'
1521 i3-msg 'rename workspace 1 to "1: www"'
1522 i3-msg 'rename workspace "1: www" to "10: www"'
1523 i3-msg 'rename workspace to "2: mail"
1524 bindsym $mod+r exec i3-input -F 'rename workspace to %s' -P 'New name: '
1525 --------------------------------------------------------------------------
1527 === Moving workspaces to a different screen
1529 See <<move_to_outputs>> for how to move a container/workspace to a different
1532 === Moving containers/workspaces to RandR outputs
1536 To move a container to another RandR output (addressed by names like +LVDS1+ or
1537 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
1538 +right+, +up+ or +down+), there are two commands:
1541 --------------------------------------------------------
1542 move container to output <<left|right|down|up>|<output>>
1543 move workspace to output <<left|right|down|up>|<output>>
1544 --------------------------------------------------------
1547 --------------------------------------------------------
1548 # Move the current workspace to the next output
1549 # (effectively toggles when you only have two outputs)
1550 bindsym $mod+x move workspace to output right
1552 # Put this window on the presentation output.
1553 bindsym $mod+x move container to output VGA1
1554 --------------------------------------------------------
1558 === Resizing containers/windows
1560 If you want to resize containers/windows using your keyboard, you can use the
1564 ---------------------------------------------------------
1565 resize <grow|shrink> <direction> [<px> px] [or <ppt> ppt]
1566 ---------------------------------------------------------
1568 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
1569 less specific and use +width+ or +height+, in which case i3 will take/give
1570 space from all the other containers. The optional pixel argument specifies by
1571 how many pixels a *floating container* should be grown or shrunk (the default
1572 is 10 pixels). The ppt argument means percentage points and specifies by how
1573 many percentage points a *tiling container* should be grown or shrunk (the
1574 default is 10 percentage points).
1576 I recommend using the resize command inside a so called +mode+:
1578 .Example: Configuration file, defining a mode for resizing
1579 ----------------------------------------------------------------------
1581 # These bindings trigger as soon as you enter the resize mode
1583 # Pressing left will shrink the window’s width.
1584 # Pressing right will grow the window’s width.
1585 # Pressing up will shrink the window’s height.
1586 # Pressing down will grow the window’s height.
1587 bindsym j resize shrink width 10 px or 10 ppt
1588 bindsym k resize grow height 10 px or 10 ppt
1589 bindsym l resize shrink height 10 px or 10 ppt
1590 bindsym semicolon resize grow width 10 px or 10 ppt
1592 # same bindings, but for the arrow keys
1593 bindsym Left resize shrink width 10 px or 10 ppt
1594 bindsym Down resize grow height 10 px or 10 ppt
1595 bindsym Up resize shrink height 10 px or 10 ppt
1596 bindsym Right resize grow width 10 px or 10 ppt
1598 # back to normal: Enter or Escape
1599 bindsym Return mode "default"
1600 bindsym Escape mode "default"
1604 bindsym $mod+r mode "resize"
1605 ----------------------------------------------------------------------
1607 === Jumping to specific windows
1609 Often when in a multi-monitor environment, you want to quickly jump to a
1610 specific window. For example, while working on workspace 3 you may want to
1611 jump to your mail client to email your boss that you’ve achieved some
1612 important goal. Instead of figuring out how to navigate to your mailclient,
1613 it would be more convenient to have a shortcut. You can use the +focus+ command
1614 with criteria for that.
1617 ----------------------------------------------------
1618 [class="class"] focus
1619 [title="title"] focus
1620 ----------------------------------------------------
1623 ------------------------------------------------
1624 # Get me to the next open VIM instance
1625 bindsym $mod+a [class="urxvt" title="VIM"] focus
1626 ------------------------------------------------
1628 === VIM-like marks (mark/goto)
1632 This feature is like the jump feature: It allows you to directly jump to a
1633 specific window (this means switching to the appropriate workspace and setting
1634 focus to the windows). However, you can directly mark a specific window with
1635 an arbitrary label and use it afterwards. You do not need to ensure that your
1636 windows have unique classes or titles, and you do not need to change your
1639 As the command needs to include the label with which you want to mark the
1640 window, you cannot simply bind it to a key. +i3-input+ is a tool created
1641 for this purpose: It lets you input a command and sends the command to i3. It
1642 can also prefix this command and display a custom prompt for the input dialog.
1645 ------------------------------
1647 [con_mark="identifier"] focus
1648 ------------------------------
1650 *Example (in a terminal)*:
1651 ------------------------------
1653 $ i3-msg '[con_mark="irssi"] focus'
1654 ------------------------------
1656 ///////////////////////////////////////////////////////////////////
1657 TODO: make i3-input replace %s
1659 ---------------------------------------
1660 # Read 1 character and mark the current window with this character
1661 bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
1663 # Read 1 character and go to the window with the character
1664 bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
1665 ---------------------------------------
1667 Alternatively, if you do not want to mess with +i3-input+, you could create
1668 seperate bindings for a specific set of labels and then only use those labels.
1669 ///////////////////////////////////////////////////////////////////
1671 === Changing border style
1673 To change the border of the current client, you can use +border normal+ to use the normal
1674 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
1675 and +border none+ to make the client borderless.
1677 There is also +border toggle+ which will toggle the different border styles.
1680 ----------------------------
1681 bindsym $mod+t border normal
1682 bindsym $mod+y border 1pixel
1683 bindsym $mod+u border none
1684 ----------------------------
1688 ///////////////////////////////////////////////////////////////////////////////
1689 TODO: not yet implemented
1690 === Changing the stack-limit of a container
1692 If you have a single container with a lot of windows inside it (say, more than
1693 10), the default layout of a stacking container can get a little unhandy.
1694 Depending on your screen’s size, you might end up with only half of the title
1695 lines being actually used, wasting a lot of screen space.
1697 Using the +stack-limit+ command, you can limit the number of rows or columns
1698 in a stacking container. i3 will create columns or rows (depending on what
1699 you limited) automatically as needed.
1702 --------------------------------
1703 stack-limit <cols|rows> <value>
1704 --------------------------------
1708 # I always want to have two window titles in one line
1711 # Not more than 5 rows in this stacking container
1715 image:stacklimit.png[Container limited to two columns]
1716 ///////////////////////////////////////////////////////////////////////////////
1718 === Reloading/Restarting/Exiting
1720 You can make i3 reload its configuration file with +reload+. You can also
1721 restart i3 inplace with the +restart+ command to get it out of some weird state
1722 (if that should ever happen) or to perform an upgrade without having to restart
1723 your X session. To exit i3 properly, you can use the +exit+ command,
1724 however you don’t need to (simply killing your X session is fine as well).
1727 ----------------------------
1728 bindsym $mod+Shift+r restart
1729 bindsym $mod+Shift+w reload
1730 bindsym $mod+Shift+e exit
1731 ----------------------------
1735 There are two commands to use any existing window as scratchpad window. +move
1736 scratchpad+ will move a window to the scratchpad workspace. This will make it
1737 invisible until you show it again. There is no way to open that workspace.
1738 Instead, when using +scratchpad show+, the window will be shown again, as a
1739 floating window, centered on your current workspace (using +scratchpad show+ on
1740 a visible scratchpad window will make it hidden again, so you can have a
1741 keybinding to toggle). Note that this is just a normal floating window, so if
1742 you want to "remove it from scratchpad", you can simple make it tiling again
1743 (+floating toggle+).
1745 As the name indicates, this is useful for having a window with your favorite
1746 editor always at hand. However, you can also use this for other permanently
1747 running applications which you don’t want to see all the time: Your music
1748 player, alsamixer, maybe even your mail client…?
1758 ------------------------------------------------
1759 # Make the currently focused window a scratchpad
1760 bindsym $mod+Shift+minus move scratchpad
1762 # Show the first scratchpad window
1763 bindsym $mod+minus scratchpad show
1765 # Show the sup-mail scratchpad window, if any.
1766 bindsym mod4+s [title="^Sup ::"] scratchpad show
1767 ------------------------------------------------
1771 == Multiple monitors
1773 As you can see in the goal list on the website, i3 was specifically developed
1774 with support for multiple monitors in mind. This section will explain how to
1775 handle multiple monitors.
1777 When you have only one monitor, things are simple. You usually start with
1778 workspace 1 on your monitor and open new ones as you need them.
1780 When you have more than one monitor, each monitor will get an initial
1781 workspace. The first monitor gets 1, the second gets 2 and a possible third
1782 would get 3. When you switch to a workspace on a different monitor, i3 will
1783 switch to that monitor and then switch to the workspace. This way, you don’t
1784 need shortcuts to switch to a specific monitor, and you don’t need to remember
1785 where you put which workspace. New workspaces will be opened on the currently
1786 active monitor. It is not possible to have a monitor without a workspace.
1788 The idea of making workspaces global is based on the observation that most
1789 users have a very limited set of workspaces on their additional monitors.
1790 They are often used for a specific task (browser, shell) or for monitoring
1791 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
1792 and "the rest" on the other monitors often makes sense. However, as you can
1793 create an unlimited number of workspaces in i3 and tie them to specific
1794 screens, you can have the "traditional" approach of having X workspaces per
1795 screen by changing your configuration (using modes, for example).
1797 === Configuring your monitors
1799 To help you get going if you have never used multiple monitors before, here is
1800 a short overview of the xrandr options which will probably be of interest to
1801 you. It is always useful to get an overview of the current screen configuration.
1802 Just run "xrandr" and you will get an output like the following:
1803 -------------------------------------------------------------------------------
1805 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
1806 VGA1 disconnected (normal left inverted right x axis y axis)
1807 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
1808 1280x800 60.0*+ 50.0
1809 1024x768 85.0 75.0 70.1 60.0
1811 800x600 85.1 72.2 75.0 60.3 56.2
1812 640x480 85.0 72.8 75.0 59.9
1816 --------------------------------------------------------------------------------------
1818 Several things are important here: You can see that +LVDS1+ is connected (of
1819 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
1820 connected to one of the ports but xrandr still says "disconnected", you should
1821 check your cable, monitor or graphics driver.
1823 The maximum resolution you can see at the end of the first line is the maximum
1824 combined resolution of your monitors. By default, it is usually too low and has
1825 to be increased by editing +/etc/X11/xorg.conf+.
1827 So, say you connected VGA1 and want to use it as an additional screen:
1828 -------------------------------------------
1829 xrandr --output VGA1 --auto --left-of LVDS1
1830 -------------------------------------------
1831 This command makes xrandr try to find the native resolution of the device
1832 connected to +VGA1+ and configures it to the left of your internal flat panel.
1833 When running "xrandr" again, the output looks like this:
1834 -------------------------------------------------------------------------------
1836 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
1837 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
1838 1280x1024 60.0*+ 75.0
1841 1024x768 75.1 70.1 60.0
1843 800x600 72.2 75.0 60.3 56.2
1844 640x480 72.8 75.0 66.7 60.0
1846 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
1847 1280x800 60.0*+ 50.0
1848 1024x768 85.0 75.0 70.1 60.0
1850 800x600 85.1 72.2 75.0 60.3 56.2
1851 640x480 85.0 72.8 75.0 59.9
1855 -------------------------------------------------------------------------------
1856 Please note that i3 uses exactly the same API as xrandr does, so it will see
1857 only what you can see in xrandr.
1859 See also <<presentations>> for more examples of multi-monitor setups.
1861 === Interesting configuration for multi-monitor environments
1863 There are several things to configure in i3 which may be interesting if you
1864 have more than one monitor:
1866 1. You can specify which workspace should be put on which screen. This
1867 allows you to have a different set of workspaces when starting than just
1868 1 for the first monitor, 2 for the second and so on. See
1869 <<workspace_screen>>.
1870 2. If you want some applications to generally open on the bigger screen
1871 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
1872 <<assign_workspace>>.
1873 3. If you have many workspaces on many monitors, it might get hard to keep
1874 track of which window you put where. Thus, you can use vim-like marks to
1875 quickly switch between windows. See <<vim_like_marks>>.
1876 4. For information on how to move existing workspaces between monitors,
1877 see <<_moving_containers_workspaces_to_randr_outputs>>.
1879 == i3 and the rest of your software world
1881 === Displaying a status line
1883 A very common thing amongst users of exotic window managers is a status line at
1884 some corner of the screen. It is an often superior replacement to the widget
1885 approach you have in the task bar of a traditional desktop environment.
1887 If you don’t already have your favorite way of generating such a status line
1888 (self-written scripts, conky, …), then i3status is the recommended tool for
1889 this task. It was written in C with the goal of using as few syscalls as
1890 possible to reduce the time your CPU is woken up from sleep states. Because
1891 i3status only spits out text, you need to combine it with some other tool, like
1892 i3bar. See <<status_command>> for how to display i3status in i3bar.
1894 Regardless of which application you use to display the status line, you
1895 want to make sure that it registers as a dock window using EWMH hints. i3 will
1896 position the window either at the top or at the bottom of the screen, depending
1897 on which hint the application sets. With i3bar, you can configure its position,
1898 see <<i3bar_position>>.
1900 === Giving presentations (multi-monitor)
1902 When giving a presentation, you typically want the audience to see what you see
1903 on your screen and then go through a series of slides (if the presentation is
1904 simple). For more complex presentations, you might want to have some notes
1905 which only you can see on your screen, while the audience can only see the
1909 ==== Case 1: everybody gets the same output
1910 This is the simple case. You connect your computer to the video projector,
1911 turn on both (computer and video projector) and configure your X server to
1912 clone the internal flat panel of your computer to the video output:
1913 -----------------------------------------------------
1914 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
1915 -----------------------------------------------------
1916 i3 will then use the lowest common subset of screen resolutions, the rest of
1917 your screen will be left untouched (it will show the X background). So, in
1918 our example, this would be 1024x768 (my notebook has 1280x800).
1920 ==== Case 2: you can see more than your audience
1921 This case is a bit harder. First of all, you should configure the VGA output
1922 somewhere near your internal flat panel, say right of it:
1923 -----------------------------------------------------
1924 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
1925 -----------------------------------------------------
1926 Now, i3 will put a new workspace (depending on your settings) on the new screen
1927 and you are in multi-monitor mode (see <<multi_monitor>>).
1929 Because i3 is not a compositing window manager, there is no ability to
1930 display a window on two screens at the same time. Instead, your presentation
1931 software needs to do this job (that is, open a window on each screen).