]> git.sur5r.net Git - i3/i3/blob - docs/userguide
0ee565671c038c5589acd2b4997a13eee92a6f5e
[i3/i3] / docs / userguide
1 i3 User’s Guide
2 ===============
3 Michael Stapelberg <michael+i3@stapelberg.de>
4 August 2011
5
6 This document contains all the information you need to configure and use the i3
7 window manager. If it does not, please contact us on IRC (preferred) or post your
8 question(s) on the mailing list.
9
10 == Default keybindings
11
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):
14
15 *Keys to use with mod (alt):*
16
17 image:keyboard-layer1.png["Keys to use with mod (alt)",width=600,link="keyboard-layer1.png"]
18
19 *Keys to use with Shift+mod:*
20
21 image:keyboard-layer2.png["Keys to use with Shift+mod",width=600,link="keyboard-layer2.png"]
22
23 The red keys are the modifiers you need to press (by default), the blue keys
24 are your homerow.
25
26 == Using i3
27
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.
31
32 === Opening terminals and moving around
33
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.
38
39 image:single_terminal.png[Single terminal]
40
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).
45
46 image:two_terminals.png[Two terminals]
47
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.
54
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
60 windows.
61
62 TODO: picture of the tree
63
64 To split a window vertically, press +mod+v+. To split it horizontally, press
65 +mod+h+.
66
67 === Changing the container layout
68
69 A split container can have one of the following layouts:
70
71 default::
72 Windows are sized so that every window gets an equal amount of space in the
73 container.
74 stacking::
75 Only the focused window in the container is displayed. You get a list of
76 windows at the top of the container.
77 tabbed::
78 The same principle as +stacking+, but the list of windows at the top is only
79 a single line which is vertically split.
80
81 To switch modes, press +mod+e+ for default, +mod+s+ for stacking and
82 +mod+w+ for tabbed.
83
84 image:modes.png[Container modes]
85
86 === Toggling fullscreen mode for a window
87
88 To display a window in fullscreen mode or to go out of fullscreen mode again,
89 press +mod+f+.
90
91 There is also a global fullscreen mode in i3 in which the client will span all
92 available outputs.
93
94 === Opening other applications
95
96 Aside from opening applications from a terminal, you can also use the handy
97 +dmenu+ which is opened by pressing +mod+d+ by default. Just type the name
98 (or a part of it) of the application which you want to open. The corresponding
99 application has to be in your +$PATH+ for this to work.
100
101 Additionally, if you have applications you open very frequently, you can
102 create a keybinding for starting the application directly. See the section
103 <<configuring>> for details.
104
105 === Closing windows
106
107 If an application does not provide a mechanism for closing (most applications
108 provide a menu, the escape key or a shortcut like +Control+W+ to close), you
109 can press +mod+Shift+q+ to kill a window. For applications which support
110 the WM_DELETE protocol, this will correctly close the application (saving
111 any modifications or doing other cleanup). If the application doesn’t support
112 the WM_DELETE protocol your X server will kill the window and the behaviour
113 depends on the application.
114
115 === Using workspaces
116
117 Workspaces are an easy way to group a set of windows. By default, you are on
118 the first workspace, as the bar on the bottom left indicates. To switch to
119 another workspace, press +mod+num+ where +num+ is the number of the workspace
120 you want to use. If the workspace does not exist yet, it will be created.
121
122 A common paradigm is to put the web browser on one workspace, communication
123 applications (+mutt+, +irssi+, ...) on another one, and the ones with which you
124 work, on the third one. Of course, there is no need to follow this approach.
125
126 If you have multiple screens, a workspace will be created on each screen at
127 startup. If you open a new workspace, it will be bound to the screen you
128 created it on.  When you switch to a workspace on another screen, i3 will set
129 focus to that screen.
130
131 === Moving windows to workspaces
132
133 To move a window to another workspace, simply press +mod+Shift+num+ where
134 +num+ is (like when switching workspaces) the number of the target workspace.
135 Similarly to switching workspaces, the target workspace will be created if
136 it does not yet exist.
137
138 === Resizing
139
140 The easiest way to resize a container is by using the mouse: Grab the border
141 and move it to the wanted size.
142
143 See <<resizingconfig>> for how to configure i3 to be able to resize
144 columns/rows with your keyboard.
145
146 === Restarting i3 inplace
147
148 To restart i3 inplace (and thus get into a clean state if there is a bug, or
149 to upgrade to a newer version of i3) you can use +mod+Shift+r+.
150
151 === Exiting i3
152
153 To cleanly exit i3 without killing your X server, you can use +mod+Shift+e+.
154
155 === Floating
156
157 Floating mode is the opposite of tiling mode. The position and size of a window
158 are not managed by i3, but by you. Using this mode violates the tiling
159 paradigm but can be useful for some corner cases like "Save as" dialog
160 windows, or toolbar windows (GIMP or similar). Those windows usually set the
161 appropriate hint and are opened in floating mode by default.
162
163 You can toggle floating mode for a window by pressing +mod+Shift+Space+. By
164 dragging the window’s titlebar with your mouse you can move the window
165 around. By grabbing the borders and moving them you can resize the window. You
166 can also do that by using the <<floating_modifier>>.
167
168 For resizing floating windows with your keyboard, see <<resizingconfig>>.
169
170 Floating windows are always on top of tiling windows.
171
172 == Tree
173
174 i3 stores all information about the X11 outputs, workspaces and layout of the
175 windows on them in a tree. The root node is the X11 root window, followed by
176 the X11 outputs, then dock areas and a content container, then workspaces and
177 finally the windows themselve. In previous versions of i3 we had multiple lists
178 (of outputs, workspaces) and a table for each workspace. That approach turned
179 out to be complicated to use (snapping), understand and implement.
180
181 === The tree consists of Containers
182
183 The building blocks of our tree are so called +Containers+. A +Container+ can
184 host a window (meaning an X11 window, one that you can actually see and use,
185 like a browser). Alternatively, it could contain one or more +Containers+. A
186 simple example is the workspace: When you start i3 with a single monitor, a
187 single workspace and you open two terminal windows, you will end up with a tree
188 like this:
189
190 image::tree-layout2.png["layout2",float="right"]
191 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
192
193 === Orientation and Split Containers
194
195 [[OrientationSplit]]
196
197 It is only natural to use so-called +Split Containers+ in order to build a
198 layout when using a tree as data structure. In i3, every +Container+ has an
199 orientation (horizontal, vertical or unspecified). So, in our example with the
200 workspace, the default orientation of the workspace +Container+ is horizontal
201 (most monitors are widescreen nowadays). If you change the orientation to
202 vertical (+mod+v+ in the default config) and *then* open two terminals, i3 will
203 configure your windows like this:
204
205 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
206
207 An interesting new feature of the tree branch is the ability to split anything:
208 Let’s assume you have two terminals on a workspace (with horizontal
209 orientation), focus is on the right terminal. Now you want to open another
210 terminal window below the current one. If you would just open a new terminal
211 window, it would show up to the right due to the horizontal workspace
212 orientation. Instead, press +mod+v+ to create a +Vertical Split Container+ (to
213 open a +Horizontal Split Container+, use +mod+h+). Now you can open a new
214 terminal and it will open below the current one:
215
216 image::tree-layout1.png["Layout",float="right"]
217 image::tree-shot1.png["shot",title="Vertical Split Container"]
218
219 unfloat::[]
220
221 You probably guessed it already: There is no limit on how deep your hierarchy
222 of splits can be.
223
224 === Focus parent
225
226 Let’s stay with our example from above. We have a terminal on the left and two
227 vertically split terminals on the right, focus is on the bottom right one. When
228 you open a new terminal, it will open below the current one.
229
230 So, how can you open a new terminal window to the *right* of the current one?
231 The solution is to use +focus parent+, which will focus the +Parent Container+ of
232 the current +Container+. In this case, you would focus the +Vertical Split
233 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
234 windows will be opened to the right of the +Vertical Split Container+:
235
236 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
237
238 [[configuring]]
239 == Configuring i3
240
241 This is where the real fun begins ;-). Most things are very dependant on your
242 ideal working environment so we can’t make reasonable defaults for them.
243
244 While not using a programming language for the configuration, i3 stays
245 quite flexible in regards to the things you usually want your window manager
246 to do.
247
248 For example, you can configure bindings to jump to specific windows,
249 you can set specific applications to start on specific workspaces, you can
250 automatically start applications, you can change the colors of i3, and you
251 can bind your keys to do useful things.
252
253 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
254 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
255 with a text editor.
256
257 On first start (and on all following starts, unless you have a configuration
258 file), i3 will offer you to create a configuration file. You can tell the
259 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
260 file. Also, the created config file will use the key symbols of your current
261 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
262 Please note that you must not have +~/.i3/config+, otherwise the wizard will
263 exit.
264
265 === Comments
266
267 It is possible and recommended to use comments in your configuration file to
268 properly document your setup for later reference. Comments are started with
269 a # and can only be used at the beginning of a line:
270
271 *Examples*:
272 -------------------
273 # This is a comment
274 -------------------
275
276 === Fonts
277
278 i3 uses X core fonts (not Xft) for rendering window titles. You can use
279 +xfontsel(1)+ to generate such a font description. To see special characters
280 (Unicode), you need to use a font which supports the ISO-10646 encoding.
281
282 If i3 cannot open the configured font, it will output an error in the logfile
283 and fall back to a working font.
284
285 *Syntax*:
286 ------------------------------
287 font <X core font description>
288 ------------------------------
289
290 *Examples*:
291 --------------------------------------------------------------
292 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
293 --------------------------------------------------------------
294
295 [[keybindings]]
296
297 === Keyboard bindings
298
299 A keyboard binding makes i3 execute a command (see below) upon pressing a
300 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
301 also mix your bindings, though i3 will not protect you from overlapping ones).
302
303 * A keysym (key symbol) is a description for a specific symbol, like "a"
304   or "b", but also more strange ones like "underscore" instead of "_". These
305   are the ones you use in Xmodmap to remap your keys. To get the current
306   mapping of your keys, use +xmodmap -pke+.
307
308 * Keycodes do not need to have a symbol assigned (handy for custom vendor
309   hotkeys on some notebooks) and they will not change their meaning as you
310   switch to a different keyboard layout (when using +xmodmap+).
311
312 My recommendation is: If you often switch keyboard layouts but you want to keep
313 your bindings in the same physical location on the keyboard, use keycodes.
314 If you don’t switch layouts, and want a clean and simple config file, use
315 keysyms.
316
317 *Syntax*:
318 ----------------------------------
319 bindsym [Modifiers+]keysym command
320 bindcode [Modifiers+]keycode command
321 ----------------------------------
322
323 *Examples*:
324 --------------------------------
325 # Fullscreen
326 bindsym mod+f f
327
328 # Restart
329 bindsym mod+Shift+r restart
330
331 # Notebook-specific hotkeys
332 bindcode 214 exec /home/michael/toggle_beamer.sh
333 --------------------------------
334
335 Available Modifiers:
336
337 Mod1-Mod5, Shift, Control::
338 Standard modifiers, see +xmodmap(1)+
339
340 Mode_switch::
341 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
342 you to remap capslock (for example) to Mode_switch and use it for both: typing
343 umlauts or special characters 'and' having some comfortably reachable key
344 bindings. For example, when typing, capslock+1 or capslock+2 for switching
345 workspaces is totally convenient. Try it :-).
346
347 [[floating_modifier]]
348
349 === The floating modifier
350
351 To move floating windows with your mouse, you can either grab their titlebar
352 or configure the so called floating modifier which you can then press and
353 click anywhere in the window itself to move it. The most common setup is to
354 use the same key you use for managing windows (Mod1 for example). Then
355 you can press Mod1, click into a window using your left mouse button, and drag
356 it to the position you want.
357
358 When holding the floating modifier, you can resize a floating window by
359 pressing the right mouse button on it and moving around while holding it. If
360 you hold the shift button as well, the resize will be proportional.
361
362 *Syntax*:
363 --------------------------------
364 floating_modifier <Modifiers>
365 --------------------------------
366
367 *Example*:
368 --------------------------------
369 floating_modifier Mod1
370 --------------------------------
371
372 === Orientation for new workspaces
373
374 New workspaces get a reasonable default orientation: Wide-screen monitors
375 (anything wider than high) get horizontal orientation, rotated monitors
376 (anything higher than wide) get vertical orientation.
377
378 With the +default_orientation+ configuration directive, you can override that
379 behaviour.
380
381 *Syntax*:
382 ----------------------------------------------
383 default_orientation <horizontal|vertical|auto>
384 ----------------------------------------------
385
386 *Example*:
387 ----------------------------
388 default_orientation vertical
389 ----------------------------
390
391 === Layout mode for new containers
392
393 This option determines in which mode new containers on workspace level will
394 start.
395 ///////////////////////////////
396 See also <<stack-limit>>.
397 //////////////////////////////
398
399 *Syntax*:
400 ---------------------------------------------
401 workspace_layout <default|stacking|tabbed>
402 ---------------------------------------------
403 /////////////////////////////////////////////
404 new_container stack-limit <cols|rows> <value>
405 /////////////////////////////////////////////
406
407 *Example*:
408 ---------------------
409 workspace_layout tabbed
410 ---------------------
411
412 === Border style for new windows
413
414 This option determines which border style new windows will have.
415
416 *Syntax*:
417 ---------------------------------------------
418 new_window <normal|1pixel|none>
419 ---------------------------------------------
420
421 *Example*:
422 ---------------------
423 new_window 1pixel
424 ---------------------
425
426 === Arbitrary commands for specific windows (for_window)
427
428 With the +for_window+ command, you can let i3 execute any command when it
429 encounters a specific window. This can be used to set windows to floating or to
430 change their border style, for example.
431
432 *Syntax*:
433 -----------------------------
434 for_window [criteria] command
435 -----------------------------
436
437 *Examples*:
438 ------------------------------------------------
439 # enable floating mode for all XTerm windows
440 for_window [class="XTerm"] floating enable
441
442 # Make all urxvts use a 1-pixel border:
443 for_window [class="urxvt"] border 1pixel
444
445 # A less useful, but rather funny example:
446 # makes the window floating as soon as I change
447 # directory to ~/work
448 for_window [title="x200: ~/work"] floating enable
449 ------------------------------------------------
450
451 The valid criteria are the same as those for commands, see <<command_criteria>>.
452
453 === Variables
454
455 As you learned in the section about keyboard bindings, you will have
456 to configure lots of bindings containing modifier keys. If you want to save
457 yourself some typing and be able to change the modifier you use later,
458 variables can be handy.
459
460 *Syntax*:
461 --------------
462 set $name value
463 --------------
464
465 *Example*:
466 ------------------------
467 set $m Mod1
468 bindsym $m+Shift+r restart
469 ------------------------
470
471 Variables are directly replaced in the file when parsing. There is no fancy
472 handling and there are absolutely no plans to change this. If you need a more
473 dynamic configuration you should create a little script which generates a
474 configuration file and run it before starting i3 (for example in your
475 +~/.xsession+ file).
476
477 === Automatically putting clients on specific workspaces
478
479 [[assign_workspace]]
480
481 Specific windows can be matched by window class and/or window title. It is
482 recommended that you match on window classes instead of window titles whenever
483 possible because some applications first create their window, and then worry
484 about setting the correct title. Firefox with Vimperator comes to mind. The
485 window starts up being named Firefox, and only when Vimperator is loaded does
486 the title change. As i3 will get the title as soon as the application maps the
487 window (mapping means actually displaying it on the screen), you’d need to have
488 to match on 'Firefox' in this case.
489
490 You can prefix or suffix workspaces with a `~` to specify that matching clients
491 should be put into floating mode. If you specify only a `~`, the client will
492 not be put onto any workspace, but will be set floating on the current one.
493
494 *Syntax*:
495 ------------------------------------------------------------
496 assign ["]window class[/window title]["] [→] [workspace]
497 ------------------------------------------------------------
498
499 *Examples*:
500 ----------------------
501 assign urxvt 2
502 assign urxvt → 2
503 assign urxvt → work
504 assign "urxvt" → 2
505 assign "urxvt/VIM" → 3
506 assign "gecko" → 4
507 ----------------------
508
509 Note that the arrow is not required, it just looks good :-). If you decide to
510 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
511
512 === Automatically starting applications on i3 startup
513
514 By using the +exec+ keyword outside a keybinding, you can configure
515 which commands will be performed by i3 on initial startup. +exec+
516 commands will not run when restarting i3, if you need a command to run
517 also when restarting i3 you should use the +exec_always+
518 keyword. These commands will be run in order.
519
520 *Syntax*:
521 -------------------
522 exec command
523 exec_always command
524 -------------------
525
526 *Examples*:
527 --------------------------------
528 exec i3status | i3bar -d
529 exec_always ~/my_script.sh
530 --------------------------------
531
532 [[workspace_screen]]
533
534 === Automatically putting workspaces on specific screens
535
536 If you assign clients to workspaces, it might be handy to put the
537 workspaces on specific screens. Also, the assignment of workspaces to screens
538 will determine which workspace i3 uses for a new screen when adding screens
539 or when starting (e.g., by default it will use 1 for the first screen, 2 for
540 the second screen and so on).
541
542 *Syntax*:
543 ----------------------------------
544 workspace <number> output <output>
545 ----------------------------------
546
547 The 'output' is the name of the RandR output you attach your screen to. On a
548 laptop, you might have VGA1 and LVDS1 as output names. You can see the
549 available outputs by running +xrandr --current+.
550
551 *Examples*:
552 ---------------------------
553 workspace 1 output LVDS1
554 workspace 5 output VGA1
555 ---------------------------
556
557 === Changing colors
558
559 You can change all colors which i3 uses to draw the window decorations.
560
561 *Syntax*:
562 --------------------------------------------
563 colorclass border background text
564 --------------------------------------------
565
566 Where colorclass can be one of:
567
568 client.focused::
569         A client which currently has the focus.
570 client.focused_inactive::
571         A client which is the focused one of its container, but it does not have
572         the focus at the moment.
573 client.unfocused::
574         A client which is not the focused one of its container.
575 client.urgent::
576         A client which has its urgency hint activated.
577
578 You can also specify the color to be used to paint the background of the client
579 windows. This color will be used to paint the window on top of which the client
580 will be rendered.
581
582 *Syntax*:
583 -----------------------
584 client.background color
585 -----------------------
586
587 Only clients that do not cover the whole area of this window expose the color
588 used to paint it. If you use a color other than black for your terminals, you
589 most likely want to set the client background color to the same color as your
590 terminal program's background color to avoid black gaps between the rendered
591 area of the termianal and the i3 border.
592
593 Colors are in HTML hex format (#rrggbb), see the following example:
594
595 *Examples (default colors)*:
596 -----------------------------------------------
597 # class                 border  backgr. text
598 client.focused          #4c7899 #285577 #ffffff
599 client.focused_inactive #333333 #5f676a #ffffff
600 client.unfocused        #333333 #222222 #888888
601 client.urgent           #2f343a #900000 #ffffff
602 -----------------------------------------------
603
604 Note that for the window decorations, the color around the child window is the
605 background color, and the border color is only the two thin lines at the top of
606 the window.
607
608 === Interprocess communication
609
610 i3 uses unix sockets to provide an IPC interface. This allows third-party
611 programs to get information from i3, such as the current workspaces
612 (to display a workspace bar), and to control i3.
613
614 The IPC socket is enabled by default and will be created in
615 +/tmp/i3-%u/ipc-socket.%p+ where +%u+ is your UNIX username and +%p+ is the PID
616 of i3.
617
618 You can override the default path through the environment-variable +I3SOCK+ or
619 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
620 does the right thing by default.
621
622 *Examples*:
623 ----------------------------
624 ipc-socket /tmp/i3-ipc.sock
625 ----------------------------
626
627 You can then use the +i3-msg+ application to perform any command listed in
628 the next section.
629
630 === Focus follows mouse
631
632 If you have a setup where your mouse usually is in your way (like a touchpad
633 on your laptop which you do not want to disable completely), you might want
634 to disable 'focus follows mouse' and control focus only by using your keyboard.
635 The mouse will still be useful inside the currently active window (for example
636 to click on links in your browser window).
637
638 *Syntax*:
639 ----------------------------
640 focus_follows_mouse <yes|no>
641 ----------------------------
642
643 *Example*:
644 ----------------------
645 focus_follows_mouse no
646 ----------------------
647
648 === Popups during fullscreen mode
649
650 When you are in fullscreen mode, some applications still open popup windows
651 (take Xpdf for example). This is because these applications may not be aware
652 that they are in fullscreen mode (they do not check the corresponding hint).
653 There are two things which are possible to do in this situation:
654
655 1. Just ignore the popup (don’t map it). This won’t interrupt you while you are
656    in fullscreen. However, some apps might react badly to this (deadlock until
657    you go out of fullscreen).
658 2. Leave fullscreen mode. This is the default.
659
660 *Syntax*:
661 -------------------------------------------------
662 popup_during_fullscreen <ignore|leave_fullscreen>
663 -------------------------------------------------
664
665 *Example*:
666 ------------------------------
667 popup_during_fullscreen ignore
668 ------------------------------
669
670 === Focus wrapping
671
672 When being in a tabbed or stacked container, the first container will be
673 focused when you use +focus down+ on the last container -- the focus wraps. If
674 however there is another stacked/tabbed container in that direction, focus will
675 be set on that container. This is the default behaviour so you can navigate to
676 all your windows without having to use +focus parent+.
677
678 If you want the focus to *always* wrap and you are aware of using +focus
679 parent+ to switch to different containers, you can use the
680 +force_focus_wrapping+ configuration directive. After enabling it, the focus
681 will always wrap.
682
683 *Syntax*:
684 -----------------------------
685 force_focus_wrapping <yes|no>
686 -----------------------------
687
688 *Example*:
689 ------------------------
690 force_focus_wrapping yes
691 ------------------------
692
693 == List of commands
694
695 Commands are what you bind to specific keypresses. You can also issue commands
696 at runtime without pressing a key by using the IPC interface. An easy way to
697 do this is to use the +i3-msg+ utility:
698
699 *Example*:
700 --------------------------
701 # execute this on your shell to make the current container borderless
702 i3-msg border none
703 --------------------------
704
705 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
706 specific workspace and immediately switch to that workspace, you can configure
707 the following keybinding:
708
709 *Example*:
710 -------------------------------------------
711 bindsym mod+x move workspace 3; workspace 3
712 -------------------------------------------
713
714 [[command_criteria]]
715
716 Furthermore, you can change the scope of a command, that is, which containers
717 should be affected by that command, by using various criteria. These are
718 prefixed in square brackets to every command. If you want to kill all windows
719 which have the class Firefox, use:
720
721 *Example*:
722 ------------------------------------
723 bindsym mod+x [class="Firefox"] kill
724
725 # same thing, but case-insensitive
726 bindsym mod+x [class="(?i)firefox"] kill
727 ------------------------------------
728
729 The criteria which are currently implemented are:
730
731 class::
732         Compares the window class (the second part of WM_CLASS)
733 instance::
734         Compares the window instance (the first part of WM_CLASS)
735 id::
736         Compares the X11 window ID, which you can get via +xwininfo+ for example.
737 title::
738         Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
739 mark::
740         Compares the mark set for this container, see <<vim_like_marks>>.
741 con_id::
742         Compares the i3-internal container ID, which you can get via the IPC
743         interface. Handy for scripting.
744
745 The criteria +class+, +instance+, +title+ and +mark+ are actually regular
746 expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for information on
747 how to use them.
748
749 === Splitting containers
750
751 The split command makes the current window a split container. Split containers
752 can contain multiple windows. Every split container has an orientation, it is
753 either split horizontally (a new window gets placed to the right of the current
754 one) or vertically (a new window gets placed below the current one).
755
756 If you apply this command to a split container with the same orientation,
757 nothing will happen. If you use a different orientation, the split container’s
758 orientation will be changed (if it does not have more than one window).
759
760 *Syntax*:
761 ---------------------------
762 split <vertical|horizontal>
763 ---------------------------
764
765 *Example*:
766 ------------------------------
767 bindsym mod+v split vertical
768 bindsym mod+h split horizontal
769 ------------------------------
770
771 === Manipulating layout
772
773 Use +layout default+, +layout stacking+ or +layout tabbed+ to change the
774 current container layout to default, stacking or tabbed layout, respectively.
775
776 To make the current window (!) fullscreen, use +fullscreen+, to make
777 it floating (or tiling again) use +floating enable+ respectively +floating disable+
778 (or +floating toggle+):
779
780 *Examples*:
781 --------------
782 bindsym mod+s layout stacking
783 bindsym mod+l layout default
784 bindsym mod+w layout tabbed
785
786 # Toggle fullscreen
787 bindsym mod+f fullscreen
788
789 # Toggle floating/tiling
790 bindsym mod+t floating toggle
791 --------------
792
793 === Focusing/Moving containers
794
795 To change the focus, use the focus command: +focus left+, +focus right+, +focus down+ and +focus up+.
796
797 There are a few special parameters you can use for the focus command:
798
799 parent::
800         Sets focus to the +Parent Container+ of the current +Container+.
801 child::
802         The opposite of +focus parent+, sets the focus to the last focused
803         child container.
804 floating::
805         Sets focus to the last focused floating container.
806 tiling::
807         Sets focus to the last focused tiling container.
808 mode_toggle::
809         Toggles between floating/tiling containers.
810
811 For moving, use +move left+, +move right+, +move down+ and +move up+.
812
813 *Examples*:
814 ----------------------
815 # Focus clients on the left, bottom, top, right:
816 bindsym mod+j focus left
817 bindsym mod+k focus down
818 bindsym mod+l focus up
819 bindsym mod+semicolon focus right
820
821 # Focus parent container
822 bindsym mod+u focus parent
823
824 # Focus last floating/tiling container
825 bindsym mod+g focus mode_toggle
826
827 # Move client to the left, bottom, top, right:
828 bindsym mod+j move left
829 bindsym mod+k move down
830 bindsym mod+l move up
831 bindsym mod+semicolon move right
832 ----------------------
833
834 === Changing (named) workspaces/moving to workspaces
835
836 To change to a specific workspace, use the +workspace+ command, followed by the
837 number or name of the workspace. To move containers to specific workspaces, use
838 +move workspace+.
839
840 You can also switch to the next and previous workspace with the commands
841 +workspace next+ and +workspace prev+, which is handy, for example, if you have
842 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
843 combination.
844
845 To move a container to another xrandr output such as +LVDS1+ or +VGA1+, you can
846 use the +move output+ command followed by the name of the target output. You
847 may also use +left+, +right+, +up+, +down+ instead of the xrandr output name to
848 move to the the next output in the specified direction.
849
850 *Examples*:
851 -------------------------
852 bindsym mod+1 workspace 1
853 bindsym mod+2 workspace 2
854 ...
855
856 bindsym mod+Shift+1 move workspace 1
857 bindsym mod+Shift+2 move workspace 2
858 ...
859 -------------------------
860
861 ==== Named workspaces
862
863 Workspaces are identified by their name. So, instead of using numbers in the
864 workspace command, you can use an arbitrary name:
865
866 *Example*:
867 -------------------------
868 bindsym mod+1 workspace mail
869 ...
870 -------------------------
871
872 If you want the workspace to have a number *and* a name, just prefix the
873 number, like this:
874
875 *Example*:
876 -------------------------
877 bindsym mod+1 workspace 1: mail
878 bindsym mod+2 workspace 2: www
879 ...
880 -------------------------
881
882 Note that the workspace will really be named "1: mail". i3 treats workspace
883 names beginning with a number in a slightly special way. Normally, named
884 workspaces are ordered the way they appeared. When they start with a number, i3
885 will order them numerically.
886
887 [[resizingconfig]]
888
889 === Resizing containers/windows
890
891 If you want to resize containers/windows using your keyboard, you can use the
892 +resize+ command:
893
894 *Syntax*:
895 ---------------------------------------------------------
896 resize <grow|shrink> <direction> [<px> px] [or <ppt> ppt]
897 ---------------------------------------------------------
898
899 Direction can be one of +up+, +down+, +left+ or +right+. The optional pixel
900 argument specifies by how many pixels a *floating container* should be grown or
901 shrinked (the default is 10 pixels). The ppt argument means percentage points
902 and specifies by how many percentage points a *tiling container* should be
903 grown or shrinked (the default is 10 percentage points).
904
905 I recommend using the resize command inside a so called +mode+:
906
907 .Example: Configuration file, defining a mode for resizing
908 ----------------------------------------------------------------------
909 mode "resize" {
910         # These bindings trigger as soon as you enter the resize mode
911
912         # They resize the border in the direction you pressed, e.g.
913         # when pressing left, the window is resized so that it has
914         # more space on its left
915
916         bindsym j resize shrink left
917         bindsym Shift+j resize grow left
918
919         bindsym k resize grow down
920         bindsym Shift+k resize shrink down
921
922         bindsym l resize shrink up
923         bindsym Shift+l resize grow up
924
925         bindsym semicolon resize grow right
926         bindsym Shift+semicolon resize shrink right
927
928         # back to normal: Enter or Escape
929         bindsym Return mode "default"
930         bindsym Escape mode "default"
931 }
932
933 # Enter resize mode
934 bindsym mod+r mode "resize"
935 ----------------------------------------------------------------------
936
937 === Jumping to specific windows
938
939 Often when in a multi-monitor environment, you want to quickly jump to a
940 specific window. For example, while working on workspace 3 you may want to
941 jump to your mail client to email your boss that you’ve achieved some
942 important goal. Instead of figuring out how to navigate to your mailclient,
943 it would be more convenient to have a shortcut. You can use the +focus+ command
944 with criteria for that.
945
946 *Syntax*:
947 ----------------------------------------------------
948 [class="class"] focus
949 [title="title"] focus
950 ----------------------------------------------------
951
952 *Examples*:
953 ------------------------------------------------
954 # Get me to the next open VIM instance
955 bindsym mod+a [class="urxvt" title="VIM"] focus
956 ------------------------------------------------
957
958 === VIM-like marks (mark/goto)
959
960 [[vim_like_marks]]
961
962 This feature is like the jump feature: It allows you to directly jump to a
963 specific window (this means switching to the appropriate workspace and setting
964 focus to the windows). However, you can directly mark a specific window with
965 an arbitrary label and use it afterwards.  You do not need to ensure that your
966 windows have unique classes or titles, and you do not need to change your
967 configuration file.
968
969 As the command needs to include the label with which you want to mark the
970 window, you cannot simply bind it to a key.  +i3-input+ is a tool created
971 for this purpose: It lets you input a command and sends the command to i3. It
972 can also prefix this command and display a custom prompt for the input dialog.
973
974 *Syntax*:
975 ------------------------------
976 mark identifier
977 [con_mark="identifier"] focus
978 ------------------------------
979
980 *Example (in a terminal)*:
981 ------------------------------
982 $ i3-msg mark irssi
983 $ i3-msg '[con_mark="irssi"] focus'
984 ------------------------------
985
986 ///////////////////////////////////////////////////////////////////
987 TODO: make i3-input replace %s
988 *Examples*:
989 ---------------------------------------
990 # Read 1 character and mark the current window with this character
991 bindsym mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
992
993 # Read 1 character and go to the window with the character
994 bindsym mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
995 ---------------------------------------
996
997 Alternatively, if you do not want to mess with +i3-input+, you could create
998 seperate bindings for a specific set of labels and then only use those labels.
999 ///////////////////////////////////////////////////////////////////
1000
1001 === Changing border style
1002
1003 To change the border of the current client, you can use +border normal+ to use the normal
1004 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
1005 and +border none+ to make the client borderless.
1006
1007 There is also +border toggle+ which will toggle the different border styles.
1008
1009 *Examples*:
1010 ----------------------------
1011 bindsym mod+t border normal
1012 bindsym mod+y border 1pixel
1013 bindsym mod+u border none
1014 ----------------------------
1015
1016 [[stack-limit]]
1017
1018 ///////////////////////////////////////////////////////////////////////////////
1019 TODO: not yet implemented
1020 === Changing the stack-limit of a container
1021
1022 If you have a single container with a lot of windows inside it (say, more than
1023 10), the default layout of a stacking container can get a little unhandy.
1024 Depending on your screen’s size, you might end up with only half of the title
1025 lines being actually used, wasting a lot of screen space.
1026
1027 Using the +stack-limit+ command, you can limit the number of rows or columns
1028 in a stacking container. i3 will create columns or rows (depending on what
1029 you limited) automatically as needed.
1030
1031 *Syntax*:
1032 --------------------------------
1033 stack-limit <cols|rows> <value>
1034 --------------------------------
1035
1036 *Examples*:
1037 -------------------
1038 # I always want to have two window titles in one line
1039 stack-limit cols 2
1040
1041 # Not more than 5 rows in this stacking container
1042 stack-limit rows 5
1043 -------------------
1044
1045 image:stacklimit.png[Container limited to two columns]
1046 ///////////////////////////////////////////////////////////////////////////////
1047
1048 === Reloading/Restarting/Exiting
1049
1050 You can make i3 reload its configuration file with +reload+. You can also
1051 restart i3 inplace with the +restart+ command to get it out of some weird state
1052 (if that should ever happen) or to perform an upgrade without having to restart
1053 your X session. To exit i3 properly, you can use the +exit+ command,
1054 however you don’t need to (simply killing your X session is fine as well).
1055
1056 *Examples*:
1057 ----------------------------
1058 bindsym mod+Shift+r restart
1059 bindsym mod+Shift+w reload
1060 bindsym mod+Shift+e exit
1061 ----------------------------
1062
1063 [[multi_monitor]]
1064
1065 == Multiple monitors
1066
1067 As you can see in the goal list on the website, i3 was specifically developed
1068 with support for multiple monitors in mind. This section will explain how to
1069 handle multiple monitors.
1070
1071 When you have only one monitor, things are simple. You usually start with
1072 workspace 1 on your monitor and open new ones as you need them.
1073
1074 When you have more than one monitor, each monitor will get an initial
1075 workspace.  The first monitor gets 1, the second gets 2 and a possible third
1076 would get 3. When you switch to a workspace on a different monitor, i3 will
1077 switch to that monitor and then switch to the workspace. This way, you don’t
1078 need shortcuts to switch to a specific monitor, and you don’t need to remember
1079 where you put which workspace. New workspaces will be opened on the currently
1080 active monitor.  It is not possible to have a monitor without a workspace.
1081
1082 The idea of making workspaces global is based on the observation that most
1083 users have a very limited set of workspaces on their additional monitors.
1084 They are often used for a specific task (browser, shell) or for monitoring
1085 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
1086 and "the rest" on the other monitors often makes sense. However, as you can
1087 create an unlimited number of workspaces in i3 and tie them to specific
1088 screens, you can have the "traditional" approach of having X workspaces per
1089 screen by changing your configuration (using modes, for example).
1090
1091 === Configuring your monitors
1092
1093 To help you get going if you have never used multiple monitors before, here is
1094 a short overview of the xrandr options which will probably be of interest to
1095 you. It is always useful to get an overview of the current screen configuration.
1096 Just run "xrandr" and you will get an output like the following:
1097 -------------------------------------------------------------------------------
1098 $ xrandr
1099 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
1100 VGA1 disconnected (normal left inverted right x axis y axis)
1101 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
1102    1280x800       60.0*+   50.0
1103    1024x768       85.0     75.0     70.1     60.0
1104    832x624        74.6
1105    800x600        85.1     72.2     75.0     60.3     56.2
1106    640x480        85.0     72.8     75.0     59.9
1107    720x400        85.0
1108    640x400        85.1
1109    640x350        85.1
1110 --------------------------------------------------------------------------------------
1111
1112 Several things are important here: You can see that +LVDS1+ is connected (of
1113 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
1114 connected to one of the ports but xrandr still says "disconnected", you should
1115 check your cable, monitor or graphics driver.
1116
1117 The maximum resolution you can see at the end of the first line is the maximum
1118 combined resolution of your monitors. By default, it is usually too low and has
1119 to be increased by editing +/etc/X11/xorg.conf+.
1120
1121 So, say you connected VGA1 and want to use it as an additional screen:
1122 -------------------------------------------
1123 xrandr --output VGA1 --auto --left-of LVDS1
1124 -------------------------------------------
1125 This command makes xrandr try to find the native resolution of the device
1126 connected to +VGA1+ and configures it to the left of your internal flat panel.
1127 When running "xrandr" again, the output looks like this:
1128 -------------------------------------------------------------------------------
1129 $ xrandr
1130 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
1131 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
1132    1280x1024      60.0*+   75.0
1133    1280x960       60.0
1134    1152x864       75.0
1135    1024x768       75.1     70.1     60.0
1136    832x624        74.6
1137    800x600        72.2     75.0     60.3     56.2
1138    640x480        72.8     75.0     66.7     60.0
1139    720x400        70.1
1140 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
1141    1280x800       60.0*+   50.0
1142    1024x768       85.0     75.0     70.1     60.0
1143    832x624        74.6
1144    800x600        85.1     72.2     75.0     60.3     56.2
1145    640x480        85.0     72.8     75.0     59.9
1146    720x400        85.0
1147    640x400        85.1
1148    640x350        85.1
1149 -------------------------------------------------------------------------------
1150 Please note that i3 uses exactly the same API as xrandr does, so it will see
1151 only what you can see in xrandr.
1152
1153 See also <<presentations>> for more examples of multi-monitor setups.
1154
1155 === Interesting configuration for multi-monitor environments
1156
1157 There are several things to configure in i3 which may be interesting if you
1158 have more than one monitor:
1159
1160 1. You can specify which workspace should be put on which screen. This
1161    allows you to have a different set of workspaces when starting than just
1162    1 for the first monitor, 2 for the second and so on. See
1163    <<workspace_screen>>.
1164 2. If you want some applications to generally open on the bigger screen
1165    (MPlayer, Firefox, …), you can assign them to a specific workspace, see
1166    <<assign_workspace>>.
1167 3. If you have many workspaces on many monitors, it might get hard to keep
1168    track of which window you put where. Thus, you can use vim-like marks to
1169    quickly switch between windows. See <<vim_like_marks>>.
1170
1171 == i3 and the rest of your software world
1172
1173 === Displaying a status line
1174
1175 A very common thing amongst users of exotic window managers is a status line at
1176 some corner of the screen. It is an often superior replacement to the widget
1177 approach you have in the task bar of a traditional desktop environment.
1178
1179 If you don’t already have your favorite way of generating such a status line
1180 (self-written scripts, conky, …), then i3status is the recommended tool for
1181 this task. It was written in C with the goal of using as few syscalls as
1182 possible to reduce the time your CPU is woken up from sleep states. Because
1183 i3status only spits out text, you need to combine it with some other tool, like
1184 i3bar. Use a pipe to connect them: +i3status | i3bar -d+.
1185
1186 Regardless of which application you use to display the status line, you
1187 want to make sure that it registers as a dock window using EWMH hints. i3 will
1188 position the window either at the top or at the bottom of the screen, depending
1189 on which hint the application sets. With i3bar, you can use +-d+ or +-dbottom+
1190 for positioning it at the bottom and +-dtop+ to position it at the top of the
1191 screen.
1192
1193 === Giving presentations (multi-monitor)
1194
1195 When giving a presentation, you typically want the audience to see what you see
1196 on your screen and then go through a series of slides (if the presentation is
1197 simple). For more complex presentations, you might want to have some notes
1198 which only you can see on your screen, while the audience can only see the
1199 slides.
1200
1201 [[presentations]]
1202 ==== Case 1: everybody gets the same output
1203 This is the simple case. You connect your computer to the video projector,
1204 turn on both (computer and video projector) and configure your X server to
1205 clone the internal flat panel of your computer to the video output:
1206 -----------------------------------------------------
1207 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
1208 -----------------------------------------------------
1209 i3 will then use the lowest common subset of screen resolutions, the rest of
1210 your screen will be left untouched (it will show the X background). So, in
1211 our example, this would be 1024x768 (my notebook has 1280x800).
1212
1213 ==== Case 2: you can see more than your audience
1214 This case is a bit harder. First of all, you should configure the VGA output
1215 somewhere near your internal flat panel, say right of it:
1216 -----------------------------------------------------
1217 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
1218 -----------------------------------------------------
1219 Now, i3 will put a new workspace (depending on your settings) on the new screen
1220 and you are in multi-monitor mode (see <<multi_monitor>>).
1221
1222 Because i3 is not a compositing window manager, there is no ability to
1223 display a window on two screens at the same time. Instead, your presentation
1224 software needs to do this job (that is, open a window on each screen).