3 Michael Stapelberg <michael+i3@stapelberg.de>
6 *********************************************************************************
7 This document is not yet finished. The tree branch is still in development. The
8 information provided here should be correct, just not complete yet.
9 *********************************************************************************
11 This document contains all the information you need to configure and use the i3
12 window manager. If it does not, please contact us on IRC (preferred) or post your
13 question(s) on the mailing list.
15 //////////////////////////////////////////////////////////////////////////////
16 == Default keybindings
18 For the "too long; didn’t read" people, here is an overview of the default
19 keybindings (click to see the full size image):
21 *Keys to use with mod (alt):*
23 image:keyboard-layer1.png["Keys to use with mod (alt)",width=600,link="keyboard-layer1.png"]
25 *Keys to use with Shift+mod:*
27 image:keyboard-layer2.png["Keys to use with Shift+mod",width=600,link="keyboard-layer2.png"]
29 As i3 uses keycodes in the default configuration, it does not matter which
30 keyboard layout you actually use. The key positions are what matters (of course
31 you can also use keysymbols, see <<keybindings>>).
33 The red keys are the modifiers you need to press (by default), the blue keys
35 //////////////////////////////////////////////////////////////////////////////
39 Throughout this guide, the keyword +mod+ will be used to refer to the
40 configured modifier. This is the alt key (Mod1) by default, with windows (Mod4)
41 being a popular alternative.
43 === Opening terminals and moving around
45 One very basic operation is opening a new terminal. By default, the keybinding
46 for this is mod+Enter, that is Alt+Enter in the default configuration. By
47 pressing mod+Enter, a new terminal will be opened. It will fill the whole
48 space available on your screen.
50 image:single_terminal.png[Single terminal]
52 If you now open another terminal, i3 will place it next to the current one,
53 splitting the screen size in half. Depending on your monitor, i3 will put the
54 created window beside the existing window (on wide displays) or below the
55 existing window (rotated displays).
57 image:two_terminals.png[Two terminals]
59 To move the focus between the two terminals, you can use the direction keys
60 which you may know from the editor +vi+. However, in i3, your homerow is used
61 for these keys (in +vi+, the keys are shifted to the left by one for
62 compatibility with most keyboard layouts). Therefore, +mod+J+ is left, +mod+K+
63 is down, +mod+L+ is up and `mod+;` is right. So, to switch between the
64 terminals, use +mod+K+ or +mod+L+. Of course, you can also use the arrow keys.
66 At the moment, your workspace is split (it contains two terminals) in a
67 specific direction (horizontal by default). Every window can be split
68 horizontally or vertically again, just like the workspace. The terminology is
69 "window" for a container that actually contains an X11 window (like a terminal
70 or browser) and "split container" for containers that consist of one or more
73 TODO: picture of the tree
75 To split a window vertically, press +mod+v+. To split it horizontally, press
78 === Changing the container layout
80 A split container can have one of the following layouts:
83 Windows are sized so that every window gets an equal amount of space in the
86 Only the focused window in the container is displayed. You get a list of
87 windows at the top of the container.
89 The same principle as +stacking+, but the list of windows at the top is only
90 a single line which is vertically split.
92 To switch modes, press +mod+e+ for default, +mod+h+ for stacking and
95 image:modes.png[Container modes]
97 === Toggling fullscreen mode for a window
99 To display a window in fullscreen mode or to go out of fullscreen mode again,
102 There is also a global fullscreen mode in i3 in which the client will span all
105 === Opening other applications
107 Aside from opening applications from a terminal, you can also use the handy
108 +dmenu+ which is opened by pressing +mod+d+ by default. Just type the name
109 (or a part of it) of the application which you want to open. The corresponding
110 application has to be in your +$PATH+ for this to work.
112 Additionally, if you have applications you open very frequently, you can
113 create a keybinding for starting the application directly. See the section
114 <<configuring>> for details.
118 If an application does not provide a mechanism for closing (most applications
119 provide a menu, the escape key or a shortcut like +Control+W+ to close), you
120 can press +mod+Shift+q+ to kill a window. For applications which support
121 the WM_DELETE protocol, this will correctly close the application (saving
122 any modifications or doing other cleanup). If the application doesn’t support
123 the WM_DELETE protocol your X server will kill the window and the behaviour
124 depends on the application.
128 Workspaces are an easy way to group a set of windows. By default, you are on
129 the first workspace, as the bar on the bottom left indicates. To switch to
130 another workspace, press +mod+num+ where +num+ is the number of the workspace
131 you want to use. If the workspace does not exist yet, it will be created.
133 A common paradigm is to put the web browser on one workspace, communication
134 applications (+mutt+, +irssi+, ...) on another one, and the ones with which you
135 work, on the third one. Of course, there is no need to follow this approach.
137 If you have multiple screens, a workspace will be created on each screen at
138 startup. If you open a new workspace, it will be bound to the screen you
139 created it on. When you switch to a workspace on another screen, i3 will set
140 focus to that screen.
142 === Moving windows to workspaces
144 To move a window to another workspace, simply press +mod+Shift+num+ where
145 +num+ is (like when switching workspaces) the number of the target workspace.
146 Similarly to switching workspaces, the target workspace will be created if
147 it does not yet exist.
151 The easiest way to resize a container is by using the mouse: Grab the border
152 and move it to the wanted size.
154 See <<resizingconfig>> for how to configure i3 to be able to resize
155 columns/rows with your keyboard.
157 === Restarting i3 inplace
159 To restart i3 inplace (and thus get into a clean state if there is a bug, or
160 to upgrade to a newer version of i3) you can use +mod+Shift+r+.
164 To cleanly exit i3 without killing your X server, you can use +mod+Shift+e+.
168 Floating mode is the opposite of tiling mode. The position and size of a window
169 are not managed by i3, but by you. Using this mode violates the tiling
170 paradigm but can be useful for some corner cases like "Save as" dialog
171 windows, or toolbar windows (GIMP or similar). Those windows usually set the
172 appropriate hint and are opened in floating mode by default.
174 You can enable floating mode for a window by pressing +mod+Shift+Space+. By
175 dragging the window’s titlebar with your mouse you can move the window
176 around. By grabbing the borders and moving them you can resize the window. You
177 can also do that by using the <<floating_modifier>>.
179 For resizing floating windows with your keyboard, see <<resizingconfig>>.
181 Floating windows are always on top of tiling windows.
185 i3 stores all information about the X11 outputs, workspaces and layout of the
186 windows on them in a tree. The root node is the X11 root window, followed by
187 the X11 outputs, then dock areas and a content container, then workspaces and
188 finally the windows themselve. In previous versions of i3 we had multiple lists
189 (of outputs, workspaces) and a table for each workspace. That approach turned
190 out to be complicated to use (snapping), understand and implement.
192 === The tree consists of Containers
194 The building blocks of our tree are so called +Containers+. A +Container+ can
195 host a window (meaning an X11 window, one that you can actually see and use,
196 like a browser). Alternatively, it could contain one or more +Containers+. A
197 simple example is the workspace: When you start i3 with a single monitor, a
198 single workspace and you open two terminal windows, you will end up with a tree
201 image::tree-layout2.png["layout2",float="right"]
202 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
204 === Orientation and Split Containers
208 It is only natural to use so-called +Split Containers+ in order to build a
209 layout when using a tree as data structure. In i3, every +Container+ has an
210 orientation (horizontal, vertical or unspecified). So, in our example with the
211 workspace, the default orientation of the workspace +Container+ is horizontal
212 (most monitors are widescreen nowadays). If you change the orientation to
213 vertical (+mod+v+ in the default config) and *then* open two terminals, i3 will
214 configure your windows like this:
216 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
218 An interesting new feature of the tree branch is the ability to split anything:
219 Let’s assume you have two terminals on a workspace (with horizontal
220 orientation), focus is on the right terminal. Now you want to open another
221 terminal window below the current one. If you would just open a new terminal
222 window, it would show up to the right due to the horizontal workspace
223 orientation. Instead, press +mod+v+ to create a +Vertical Split Container+ (to
224 open a +Horizontal Split Container+, use +mod+h+). Now you can open a new
225 terminal and it will open below the current one:
227 image::tree-layout1.png["Layout",float="right"]
228 image::tree-shot1.png["shot",title="Vertical Split Container"]
232 You probably guessed it already: There is no limit on how deep your hierarchy
237 Let’s stay with our example from above. We have a terminal on the left and two
238 vertically split terminals on the right, focus is on the bottom right one. When
239 you open a new terminal, it will open below the current one.
241 So, how can you open a new terminal window to the *right* of the current one?
242 The solution is to use +focus parent+, which will focus the +Parent Container+ of
243 the current +Container+. In this case, you would focus the +Vertical Split
244 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
245 windows will be opened to the right of the +Vertical Split Container+:
247 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
252 This is where the real fun begins ;-). Most things are very dependant on your
253 ideal working environment so we can’t make reasonable defaults for them.
255 While not using a programming language for the configuration, i3 stays
256 quite flexible in regards to the things you usually want your window manager
259 For example, you can configure bindings to jump to specific windows,
260 you can set specific applications to start on specific workspaces, you can
261 automatically start applications, you can change the colors of i3, and you
262 can bind your keys to do useful things.
264 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
265 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
268 On first start (and on all following starts, unless you have a configuration
269 file), i3 will offer you to create a configuration file. You can tell the
270 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
271 file. Also, the created config file will use the key symbols of your current
272 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
273 Please note that you must not have +~/.i3/config+, otherwise the wizard will
278 It is possible and recommended to use comments in your configuration file to
279 properly document your setup for later reference. Comments are started with
280 a # and can only be used at the beginning of a line:
289 i3 uses X core fonts (not Xft) for rendering window titles. You can use
290 +xfontsel(1)+ to generate such a font description. To see special characters
291 (Unicode), you need to use a font which supports the ISO-10646 encoding.
293 If i3 cannot open the configured font, it will output an error in the logfile
294 and fall back to a working font.
297 ------------------------------
298 font <X core font description>
299 ------------------------------
302 --------------------------------------------------------------
303 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
304 --------------------------------------------------------------
308 === Keyboard bindings
310 A keyboard binding makes i3 execute a command (see below) upon pressing a
311 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
312 also mix your bindings, though i3 will not protect you from overlapping ones).
314 * A keysym (key symbol) is a description for a specific symbol, like "a"
315 or "b", but also more strange ones like "underscore" instead of "_". These
316 are the ones you use in Xmodmap to remap your keys. To get the current
317 mapping of your keys, use +xmodmap -pke+.
319 * Keycodes do not need to have a symbol assigned (handy for custom vendor
320 hotkeys on some notebooks) and they will not change their meaning as you
321 switch to a different keyboard layout (when using +xmodmap+).
323 My recommendation is: If you often switch keyboard layouts but you want to keep
324 your bindings in the same physical location on the keyboard, use keycodes.
325 If you don’t switch layouts, and want a clean and simple config file, use
329 ----------------------------------
330 bindsym [Modifiers+]keysym command
331 bindcode [Modifiers+]keycode command
332 ----------------------------------
335 --------------------------------
340 bindsym mod+Shift+r restart
342 # Notebook-specific hotkeys
343 bindcode 214 exec /home/michael/toggle_beamer.sh
344 --------------------------------
348 Mod1-Mod5, Shift, Control::
349 Standard modifiers, see +xmodmap(1)+
352 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
353 you to remap capslock (for example) to Mode_switch and use it for both: typing
354 umlauts or special characters 'and' having some comfortably reachable key
355 bindings. For example, when typing, capslock+1 or capslock+2 for switching
356 workspaces is totally convenient. Try it :-).
358 [[floating_modifier]]
360 === The floating modifier
362 To move floating windows with your mouse, you can either grab their titlebar
363 or configure the so called floating modifier which you can then press and
364 click anywhere in the window itself to move it. The most common setup is to
365 use the same key you use for managing windows (Mod1 for example). Then
366 you can press Mod1, click into a window using your left mouse button, and drag
367 it to the position you want.
369 When holding the floating modifier, you can resize a floating window by
370 pressing the right mouse button on it and moving around while holding it. If
371 you hold the shift button as well, the resize will be proportional.
374 --------------------------------
375 floating_modifier <Modifiers>
376 --------------------------------
379 --------------------------------
380 floating_modifier Mod1
381 --------------------------------
383 === Orientation for new workspaces
385 New workspaces get a reasonable default orientation: Wide-screen monitors
386 (anything wider than high) get horizontal orientation, rotated monitors
387 (anything higher than wide) get vertical orientation.
389 With the +default_orientation+ configuration directive, you can override that
393 ----------------------------------------------
394 default_orientation <horizontal|vertical|auto>
395 ----------------------------------------------
398 ----------------------------
399 default_orientation vertical
400 ----------------------------
402 === Layout mode for new containers
404 This option determines in which mode new containers on workspace level will
406 ///////////////////////////////
407 See also <<stack-limit>>.
408 //////////////////////////////
411 ---------------------------------------------
412 workspace_layout <default|stacking|tabbed>
413 ---------------------------------------------
414 /////////////////////////////////////////////
415 new_container stack-limit <cols|rows> <value>
416 /////////////////////////////////////////////
419 ---------------------
420 workspace_layout tabbed
421 ---------------------
423 === Border style for new windows
425 This option determines which border style new windows will have.
428 ---------------------------------------------
429 new_window <normal|1pixel|borderless>
430 ---------------------------------------------
433 ---------------------
435 ---------------------
439 As you learned in the section about keyboard bindings, you will have
440 to configure lots of bindings containing modifier keys. If you want to save
441 yourself some typing and be able to change the modifier you use later,
442 variables can be handy.
450 ------------------------
452 bindsym $m+Shift+r restart
453 ------------------------
455 Variables are directly replaced in the file when parsing. There is no fancy
456 handling and there are absolutely no plans to change this. If you need a more
457 dynamic configuration you should create a little script which generates a
458 configuration file and run it before starting i3 (for example in your
461 === Automatically putting clients on specific workspaces
465 Specific windows can be matched by window class and/or window title. It is
466 recommended that you match on window classes instead of window titles whenever
467 possible because some applications first create their window, and then worry
468 about setting the correct title. Firefox with Vimperator comes to mind. The
469 window starts up being named Firefox, and only when Vimperator is loaded does
470 the title change. As i3 will get the title as soon as the application maps the
471 window (mapping means actually displaying it on the screen), you’d need to have
472 to match on 'Firefox' in this case.
474 You can prefix or suffix workspaces with a `~` to specify that matching clients
475 should be put into floating mode. If you specify only a `~`, the client will
476 not be put onto any workspace, but will be set floating on the current one.
479 ------------------------------------------------------------
480 assign ["]window class[/window title]["] [→] [workspace]
481 ------------------------------------------------------------
484 ----------------------
489 assign "urxvt/VIM" → 3
491 ----------------------
493 Note that the arrow is not required, it just looks good :-). If you decide to
494 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
496 === Automatically starting applications on i3 startup
498 By using the +exec+ keyword outside a keybinding, you can configure
499 which commands will be performed by i3 on initial startup. +exec+
500 commands will not run when restarting i3, if you need a command to run
501 also when restarting i3 you should use the +exec_always+
502 keyword. These commands will be run in order.
511 --------------------------------
512 exec i3status | dzen2 -dock
513 exec_always ~/my_script.sh
514 --------------------------------
518 === Automatically putting workspaces on specific screens
520 If you assign clients to workspaces, it might be handy to put the
521 workspaces on specific screens. Also, the assignment of workspaces to screens
522 will determine which workspace i3 uses for a new screen when adding screens
523 or when starting (e.g., by default it will use 1 for the first screen, 2 for
524 the second screen and so on).
527 ----------------------------------
528 workspace <number> output <output>
529 ----------------------------------
531 The 'output' is the name of the RandR output you attach your screen to. On a
532 laptop, you might have VGA1 and LVDS1 as output names. You can see the
533 available outputs by running +xrandr --current+.
536 ---------------------------
537 workspace 1 output LVDS1
538 workspace 5 output VGA1
539 ---------------------------
543 You can change all colors which i3 uses to draw the window decorations.
546 --------------------------------------------
547 colorclass border background text
548 --------------------------------------------
550 Where colorclass can be one of:
553 A client which currently has the focus.
554 client.focused_inactive::
555 A client which is the focused one of its container, but it does not have
556 the focus at the moment.
558 A client which is not the focused one of its container.
560 A client which has its urgency hint activated.
562 The current workspace in the bottom bar.
564 All other workspaces in the bottom bar.
566 A workspace which has at least one client with an activated urgency hint.
568 You can also specify the color to be used to paint the background of the client
569 windows. This color will be used to paint the window on top of which the client
573 -----------------------
574 client.background color
575 -----------------------
577 Only clients that do not cover the whole area of this window expose the color
578 used to paint it. If you use a color other than black for your terminals, you
579 most likely want to set the client background color to the same color as your
580 terminal program's background color to avoid black gaps between the rendered
581 area of the termianal and the i3 border.
583 Colors are in HTML hex format (#rrggbb), see the following example:
586 --------------------------------------
587 # class border backgr. text
588 client.focused #2F343A #900000 #FFFFFF
589 --------------------------------------
591 Note that for the window decorations, the color around the child window is the
592 background color, and the border color is only the two thin lines at the top of
595 === Interprocess communication
597 i3 uses unix sockets to provide an IPC interface. This allows third-party
598 programs to get information from i3, such as the current workspaces
599 (to display a workspace bar), and to control i3.
601 The IPC socket is enabled by default and will be created in
602 +/tmp/i3-%u/ipc-socket.%p+ where +%u+ is your UNIX username and +%p+ is the PID
605 You can override the default path through the environment-variable +I3SOCK+ or
606 by specifying the +ipc-socket+ directive.
609 ----------------------------
610 ipc-socket /tmp/i3-ipc.sock
611 ----------------------------
613 You can then use the +i3-msg+ application to perform any command listed in
616 === Focus follows mouse
618 If you have a setup where your mouse usually is in your way (like a touchpad
619 on your laptop which you do not want to disable completely), you might want
620 to disable 'focus follows mouse' and control focus only by using your keyboard.
621 The mouse will still be useful inside the currently active window (for example
622 to click on links in your browser window).
625 ----------------------------
626 focus_follows_mouse <yes|no>
627 ----------------------------
630 ----------------------
631 focus_follows_mouse no
632 ----------------------
634 === Popups during fullscreen mode
636 When you are in fullscreen mode, some applications still open popup windows
637 (take Xpdf for example). This is because these applications may not be aware
638 that they are in fullscreen mode (they do not check the corresponding hint).
639 There are two things which are possible to do in this situation:
641 1. Just ignore the popup (don’t map it). This won’t interrupt you while you are
642 in fullscreen. However, some apps might react badly to this (deadlock until
643 you go out of fullscreen).
644 2. Leave fullscreen mode. This is the default.
647 -------------------------------------------------
648 popup_during_fullscreen <ignore|leave_fullscreen>
649 -------------------------------------------------
652 ------------------------------
653 popup_during_fullscreen ignore
654 ------------------------------
658 === Splitting containers
660 The split command makes the current window a split container. Split containers
661 can contain multiple windows. Every split container has an orientation, it is
662 either split horizontally (a new window gets placed to the right of the current
663 one) or vertically (a new window gets placed below the current one).
665 If you apply this command to a split container with the same orientation,
666 nothing will happen. If you use a different orientation, the split container’s
667 orientation will be changed (if it does not have more than one window).
670 ---------------------------
671 split <vertical|horizontal>
672 ---------------------------
679 === Manipulating layout
681 Use +layout default+, +layout stacking+ or +layout tabbed+ to change the
682 current container layout to default, stacking or tabbed layout, respectively.
684 To make the current window (!) fullscreen, use +fullscreen+, to make
685 it floating (or tiling again) use +floating enable+ respectively +floating disable+
686 (or +floating toggle+):
690 bindsym mod+s layout stacking
691 bindsym mod+l layout default
692 bindsym mod+w layout tabbed
695 bindsym mod+f fullscreen
697 # Toggle floating/tiling
698 bindsym mod+t floating toggle
701 === Focusing/Moving containers
703 To change the focus, use the focus command: +focus left+, +focus right+, +focus down+ and +focus up+.
705 There are a few special parameters you can use for the focus command:
708 Sets focus to the +Parent Container+ of the current +Container+.
710 The opposite of +focus parent+, sets the focus to the last focused
713 Sets focus to the last focused floating container.
715 Sets focus to the last focused tiling container.
717 Toggles between floating/tiling containers.
719 For moving, use +move left+, +move right+, +move down+ and +move up+.
722 ----------------------
723 # Focus clients on the left, bottom, top, right:
724 bindsym mod+j focus left
725 bindsym mod+k focus down
726 bindsym mod+l focus up
727 bindsym mod+semicolon focus right
729 # Focus parent container
730 bindsym mod+u focus parent
732 # Focus last floating/tiling container
733 bindsym mod+g focus mode_toggle
735 # Move client to the left, bottom, top, right:
736 bindsym mod+j move left
737 bindsym mod+k move down
738 bindsym mod+l move up
739 bindsym mod+semicolon move right
740 ----------------------
742 === Changing workspaces/moving containers to workspaces
744 To change to a specific workspace, use the +workspace+ command, followed by the
745 number or name of the workspace. To move containers to specific workspaces, use
748 You can also switch to the next and previous workspace with the commands
749 +workspace next+ and +workspace prev+, which is handy, for example, if you have
750 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
754 -------------------------
755 bindsym mod+1 workspace 1
756 bindsym mod+2 workspace 2
759 bindsym mod+Shift+1 move workspace 1
760 bindsym mod+Shift+2 move workspace 2
762 -------------------------
766 === Resizing containers/windows
768 If you want to resize containers/windows using your keyboard, you can use the
769 +resize+ command, I recommend using it inside a so called +mode+:
771 .Example: Configuration file, defining a mode for resizing
772 ----------------------------------------------------------------------
774 # These bindings trigger as soon as you enter the resize mode
776 # They resize the border in the direction you pressed, e.g.
777 # when pressing left, the window is resized so that it has
778 # more space on its left
780 bindsym j resize shrink left
781 bindsym Shift+j resize grow left
783 bindsym k resize grow bottom
784 bindsym Shift+k resize shrink bottom
786 bindsym l resize shrink top
787 bindsym Shift+l resize grow top
789 bindsym semicolon resize grow right
790 bindsym Shift+semicolon resize shrink right
792 bindcode 36 mode default
796 bindsym mod+r mode "resize"
797 ----------------------------------------------------------------------
799 === Jumping to specific windows
801 Often when in a multi-monitor environment, you want to quickly jump to a
802 specific window. For example, while working on workspace 3 you may want to
803 jump to your mail client to email your boss that you’ve achieved some
804 important goal. Instead of figuring out how to navigate to your mailclient,
805 it would be more convenient to have a shortcut. You can use the +focus+ command
806 with criteria for that.
809 ----------------------------------------------------
810 [class="class"] focus
811 [title="title"] focus
812 ----------------------------------------------------
815 ------------------------------------------------
816 # Get me to the next open VIM instance
817 bindsym mod+a [class="urxvt" title="VIM"] focus
818 ------------------------------------------------
820 === VIM-like marks (mark/goto)
824 This feature is like the jump feature: It allows you to directly jump to a
825 specific window (this means switching to the appropriate workspace and setting
826 focus to the windows). However, you can directly mark a specific window with
827 an arbitrary label and use it afterwards. You do not need to ensure that your
828 windows have unique classes or titles, and you do not need to change your
831 As the command needs to include the label with which you want to mark the
832 window, you cannot simply bind it to a key. +i3-input+ is a tool created
833 for this purpose: It lets you input a command and sends the command to i3. It
834 can also prefix this command and display a custom prompt for the input dialog.
837 ------------------------------
839 [con_mark="identifier"] focus
840 ------------------------------
842 *Example (in a terminal)*:
843 ------------------------------
845 $ i3-msg '[con_mark="irssi"] focus'
846 ------------------------------
848 ///////////////////////////////////////////////////////////////////
849 TODO: make i3-input replace %s
851 ---------------------------------------
852 # Read 1 character and mark the current window with this character
853 bindsym mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
855 # Read 1 character and go to the window with the character
856 bindsym mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
857 ---------------------------------------
859 Alternatively, if you do not want to mess with +i3-input+, you could create
860 seperate bindings for a specific set of labels and then only use those labels.
861 ///////////////////////////////////////////////////////////////////
863 === Changing border style
865 To change the border of the current client, you can use +border normal+ to use the normal
866 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
867 and +border none+ to make the client borderless.
869 There is also +border toggle+ which will toggle the different border styles.
872 ----------------------------
873 bindsym mod+t border normal
874 bindsym mod+y border 1pixel
875 bindsym mod+u border none
876 ----------------------------
880 ///////////////////////////////////////////////////////////////////////////////
881 TODO: not yet implemented
882 === Changing the stack-limit of a container
884 If you have a single container with a lot of windows inside it (say, more than
885 10), the default layout of a stacking container can get a little unhandy.
886 Depending on your screen’s size, you might end up with only half of the title
887 lines being actually used, wasting a lot of screen space.
889 Using the +stack-limit+ command, you can limit the number of rows or columns
890 in a stacking container. i3 will create columns or rows (depending on what
891 you limited) automatically as needed.
894 --------------------------------
895 stack-limit <cols|rows> <value>
896 --------------------------------
900 # I always want to have two window titles in one line
903 # Not more than 5 rows in this stacking container
907 image:stacklimit.png[Container limited to two columns]
908 ///////////////////////////////////////////////////////////////////////////////
910 === Reloading/Restarting/Exiting
912 You can make i3 reload its configuration file with +reload+. You can also
913 restart i3 inplace with the +restart+ command to get it out of some weird state
914 (if that should ever happen) or to perform an upgrade without having to restart
915 your X session. To exit i3 properly, you can use the +exit+ command,
916 however you don’t need to (simply killing your X session is fine as well).
919 ----------------------------
920 bindsym mod+Shift+r restart
921 bindsym mod+Shift+w reload
922 bindsym mod+Shift+e exit
923 ----------------------------
929 As you can see in the goal list on the website, i3 was specifically developed
930 with support for multiple monitors in mind. This section will explain how to
931 handle multiple monitors.
933 When you have only one monitor, things are simple. You usually start with
934 workspace 1 on your monitor and open new ones as you need them.
936 When you have more than one monitor, each monitor will get an initial
937 workspace. The first monitor gets 1, the second gets 2 and a possible third
938 would get 3. When you switch to a workspace on a different monitor, i3 will
939 switch to that monitor and then switch to the workspace. This way, you don’t
940 need shortcuts to switch to a specific monitor, and you don’t need to remember
941 where you put which workspace. New workspaces will be opened on the currently
942 active monitor. It is not possible to have a monitor without a workspace.
944 The idea of making workspaces global is based on the observation that most
945 users have a very limited set of workspaces on their additional monitors.
946 They are often used for a specific task (browser, shell) or for monitoring
947 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
948 and "the rest" on the other monitors often makes sense. However, as you can
949 create an unlimited number of workspaces in i3 and tie them to specific
950 screens, you can have the "traditional" approach of having X workspaces per
951 screen by changing your configuration (using modes, for example).
953 === Configuring your monitors
955 To help you get going if you have never used multiple monitors before, here is
956 a short overview of the xrandr options which will probably be of interest to
957 you. It is always useful to get an overview of the current screen configuration.
958 Just run "xrandr" and you will get an output like the following:
959 -------------------------------------------------------------------------------
961 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
962 VGA1 disconnected (normal left inverted right x axis y axis)
963 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
965 1024x768 85.0 75.0 70.1 60.0
967 800x600 85.1 72.2 75.0 60.3 56.2
968 640x480 85.0 72.8 75.0 59.9
972 --------------------------------------------------------------------------------------
974 Several things are important here: You can see that +LVDS1+ is connected (of
975 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
976 connected to one of the ports but xrandr still says "disconnected", you should
977 check your cable, monitor or graphics driver.
979 The maximum resolution you can see at the end of the first line is the maximum
980 combined resolution of your monitors. By default, it is usually too low and has
981 to be increased by editing +/etc/X11/xorg.conf+.
983 So, say you connected VGA1 and want to use it as an additional screen:
984 -------------------------------------------
985 xrandr --output VGA1 --auto --left-of LVDS1
986 -------------------------------------------
987 This command makes xrandr try to find the native resolution of the device
988 connected to +VGA1+ and configures it to the left of your internal flat panel.
989 When running "xrandr" again, the output looks like this:
990 -------------------------------------------------------------------------------
992 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
993 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
994 1280x1024 60.0*+ 75.0
997 1024x768 75.1 70.1 60.0
999 800x600 72.2 75.0 60.3 56.2
1000 640x480 72.8 75.0 66.7 60.0
1002 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
1003 1280x800 60.0*+ 50.0
1004 1024x768 85.0 75.0 70.1 60.0
1006 800x600 85.1 72.2 75.0 60.3 56.2
1007 640x480 85.0 72.8 75.0 59.9
1011 -------------------------------------------------------------------------------
1012 Please note that i3 uses exactly the same API as xrandr does, so it will see
1013 only what you can see in xrandr.
1015 See also <<presentations>> for more examples of multi-monitor setups.
1017 === Interesting configuration for multi-monitor environments
1019 There are several things to configure in i3 which may be interesting if you
1020 have more than one monitor:
1022 1. You can specify which workspace should be put on which screen. This
1023 allows you to have a different set of workspaces when starting than just
1024 1 for the first monitor, 2 for the second and so on. See
1025 <<workspace_screen>>.
1026 2. If you want some applications to generally open on the bigger screen
1027 (MPlayer, Firefox, …), you can assign them to a specific workspace, see
1028 <<assign_workspace>>.
1029 3. If you have many workspaces on many monitors, it might get hard to keep
1030 track of which window you put where. Thus, you can use vim-like marks to
1031 quickly switch between windows. See <<vim_like_marks>>.
1033 == i3 and the rest of your software world
1035 === Displaying a status line
1037 A very common thing amongst users of exotic window managers is a status line at
1038 some corner of the screen. It is an often superior replacement to the widget
1039 approach you have in the task bar of a traditional desktop environment.
1041 If you don’t already have your favorite way of generating such a status line
1042 (self-written scripts, conky, …), then i3status is the recommended tool for
1043 this task. It was written in C with the goal of using as few syscalls as
1044 possible to reduce the time your CPU is woken up from sleep states. Because
1045 i3status only spits out text, you need to combine it with some other tool, like
1046 i3bar. Use a pipe to connect them: +i3status | i3bar -d+.
1048 Regardless of which application you use to display the status line, you
1049 want to make sure that it registers as a dock window using EWMH hints. i3 will
1050 position the window either at the top or at the bottom of the screen, depending
1051 on which hint the application sets. With i3bar, you can use +-d+ or +-dbottom+
1052 for positioning it at the bottom and +-dtop+ to position it at the top of the
1055 === Giving presentations (multi-monitor)
1057 When giving a presentation, you typically want the audience to see what you see
1058 on your screen and then go through a series of slides (if the presentation is
1059 simple). For more complex presentations, you might want to have some notes
1060 which only you can see on your screen, while the audience can only see the
1064 ==== Case 1: everybody gets the same output
1065 This is the simple case. You connect your computer to the video projector,
1066 turn on both (computer and video projector) and configure your X server to
1067 clone the internal flat panel of your computer to the video output:
1068 -----------------------------------------------------
1069 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
1070 -----------------------------------------------------
1071 i3 will then use the lowest common subset of screen resolutions, the rest of
1072 your screen will be left untouched (it will show the X background). So, in
1073 our example, this would be 1024x768 (my notebook has 1280x800).
1075 ==== Case 2: you can see more than your audience
1076 This case is a bit harder. First of all, you should configure the VGA output
1077 somewhere near your internal flat panel, say right of it:
1078 -----------------------------------------------------
1079 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
1080 -----------------------------------------------------
1081 Now, i3 will put a new workspace (depending on your settings) on the new screen
1082 and you are in multi-monitor mode (see <<multi_monitor>>).
1084 Because i3 is not a compositing window manager, there is no ability to
1085 display a window on two screens at the same time. Instead, your presentation
1086 software needs to do this job (that is, open a window on each screen).