]> git.sur5r.net Git - i3/i3/blob - docs/userguide
userguide: document 'fullscreen global'
[i3/i3] / docs / userguide
1 i3 User’s Guide
2 ===============
3 Michael Stapelberg <michael+i3@stapelberg.de>
4 January 2012
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 (the command is +fullscreen global+).
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 themselves. 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 fullscreen
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 (the aspect
361 ratio will be preserved).
362
363 *Syntax*:
364 --------------------------------
365 floating_modifier <Modifiers>
366 --------------------------------
367
368 *Example*:
369 --------------------------------
370 floating_modifier Mod1
371 --------------------------------
372
373 === Orientation for new workspaces
374
375 New workspaces get a reasonable default orientation: Wide-screen monitors
376 (anything wider than high) get horizontal orientation, rotated monitors
377 (anything higher than wide) get vertical orientation.
378
379 With the +default_orientation+ configuration directive, you can override that
380 behaviour.
381
382 *Syntax*:
383 ----------------------------------------------
384 default_orientation <horizontal|vertical|auto>
385 ----------------------------------------------
386
387 *Example*:
388 ----------------------------
389 default_orientation vertical
390 ----------------------------
391
392 === Layout mode for new containers
393
394 This option determines in which mode new containers on workspace level will
395 start.
396 ///////////////////////////////
397 See also <<stack-limit>>.
398 //////////////////////////////
399
400 *Syntax*:
401 ---------------------------------------------
402 workspace_layout <default|stacking|tabbed>
403 ---------------------------------------------
404 /////////////////////////////////////////////
405 new_container stack-limit <cols|rows> <value>
406 /////////////////////////////////////////////
407
408 *Example*:
409 ---------------------
410 workspace_layout tabbed
411 ---------------------
412
413 === Border style for new windows
414
415 This option determines which border style new windows will have.
416
417 *Syntax*:
418 ---------------------------------------------
419 new_window <normal|1pixel|none>
420 ---------------------------------------------
421
422 *Example*:
423 ---------------------
424 new_window 1pixel
425 ---------------------
426
427 === Arbitrary commands for specific windows (for_window)
428
429 With the +for_window+ command, you can let i3 execute any command when it
430 encounters a specific window. This can be used to set windows to floating or to
431 change their border style, for example.
432
433 *Syntax*:
434 -----------------------------
435 for_window <criteria> command
436 -----------------------------
437
438 *Examples*:
439 ------------------------------------------------
440 # enable floating mode for all XTerm windows
441 for_window [class="XTerm"] floating enable
442
443 # Make all urxvts use a 1-pixel border:
444 for_window [class="urxvt"] border 1pixel
445
446 # A less useful, but rather funny example:
447 # makes the window floating as soon as I change
448 # directory to ~/work
449 for_window [title="x200: ~/work"] floating enable
450 ------------------------------------------------
451
452 The valid criteria are the same as those for commands, see <<command_criteria>>.
453
454 === Variables
455
456 As you learned in the section about keyboard bindings, you will have
457 to configure lots of bindings containing modifier keys. If you want to save
458 yourself some typing and be able to change the modifier you use later,
459 variables can be handy.
460
461 *Syntax*:
462 --------------
463 set $name value
464 --------------
465
466 *Example*:
467 ------------------------
468 set $m Mod1
469 bindsym $m+Shift+r restart
470 ------------------------
471
472 Variables are directly replaced in the file when parsing. There is no fancy
473 handling and there are absolutely no plans to change this. If you need a more
474 dynamic configuration you should create a little script which generates a
475 configuration file and run it before starting i3 (for example in your
476 +~/.xsession+ file).
477
478 === Automatically putting clients on specific workspaces
479
480 [[assign_workspace]]
481
482 To automatically make a specific window show up on a specific workspace, you
483 can use an *assignment*. You can match windows by using any criteria,
484 see <<command_criteria>>. It is recommended that you match on window classes
485 (and instances, when appropriate) instead of window titles whenever possible
486 because some applications first create their window, and then worry about
487 setting the correct title. Firefox with Vimperator comes to mind. The window
488 starts up being named Firefox, and only when Vimperator is loaded does the
489 title change. As i3 will get the title as soon as the application maps the
490 window (mapping means actually displaying it on the screen), you’d need to have
491 to match on 'Firefox' in this case.
492
493 *Syntax*:
494 ------------------------------------------------------------
495 assign <criteria> [→] workspace
496 ------------------------------------------------------------
497
498 *Examples*:
499 ----------------------
500 # Assign URxvt terminals to workspace 2
501 assign [class="URxvt"] 2
502
503 # Same thing, but more precise (exact match instead of substring)
504 assign [class="^URxvt$"] 2
505
506 # Same thing, but with a beautiful arrow :)
507 assign [class="^URxvt$"] → 2
508
509 # Assignment to a named workspace
510 assign [class="^URxvt$"] → work
511
512 # Start urxvt -name irssi
513 assign [class="^URxvt$" instance="^irssi$"] → 3
514 ----------------------
515
516 Note that the arrow is not required, it just looks good :-). If you decide to
517 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
518
519 To get the class and instance, you can use +xprop+. After clicking on the
520 window, you will see the following output:
521
522 *xprop*:
523 -----------------------------------
524 WM_CLASS(STRING) = "irssi", "URxvt"
525 -----------------------------------
526
527 The first part of the WM_CLASS is the instance ("irssi" in this example), the
528 second part is the class ("URxvt" in this example).
529
530 Should you have any problems with assignments, make sure to check the i3
531 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
532 details about the matching process and the window’s actual class, instance and
533 title when starting up.
534
535 === Automatically starting applications on i3 startup
536
537 By using the +exec+ keyword outside a keybinding, you can configure
538 which commands will be performed by i3 on initial startup. +exec+
539 commands will not run when restarting i3, if you need a command to run
540 also when restarting i3 you should use the +exec_always+
541 keyword. These commands will be run in order.
542
543 *Syntax*:
544 -------------------
545 exec [--no-startup-id] command
546 exec_always [--no-startup-id] command
547 -------------------
548
549 *Examples*:
550 --------------------------------
551 exec chromium
552 exec_always ~/my_script.sh
553
554 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
555 exec --no-startup-id urxvt
556 --------------------------------
557
558 The flag --no-startup-id is explained in <<exec>>.
559
560 [[workspace_screen]]
561
562 === Automatically putting workspaces on specific screens
563
564 If you assign clients to workspaces, it might be handy to put the
565 workspaces on specific screens. Also, the assignment of workspaces to screens
566 will determine which workspace i3 uses for a new screen when adding screens
567 or when starting (e.g., by default it will use 1 for the first screen, 2 for
568 the second screen and so on).
569
570 *Syntax*:
571 ----------------------------------
572 workspace <workspace> output <output>
573 ----------------------------------
574
575 The 'output' is the name of the RandR output you attach your screen to. On a
576 laptop, you might have VGA1 and LVDS1 as output names. You can see the
577 available outputs by running +xrandr --current+.
578
579 If you use named workspaces, they must be quoted:
580
581 *Examples*:
582 ---------------------------
583 workspace 1 output LVDS1
584 workspace 5 output VGA1
585 workspace "2: vim" output VGA1
586 ---------------------------
587
588 === Changing colors
589
590 You can change all colors which i3 uses to draw the window decorations.
591
592 *Syntax*:
593 --------------------------------------------
594 colorclass border background text indicator
595 --------------------------------------------
596
597 Where colorclass can be one of:
598
599 client.focused::
600         A client which currently has the focus.
601 client.focused_inactive::
602         A client which is the focused one of its container, but it does not have
603         the focus at the moment.
604 client.unfocused::
605         A client which is not the focused one of its container.
606 client.urgent::
607         A client which has its urgency hint activated.
608
609 You can also specify the color to be used to paint the background of the client
610 windows. This color will be used to paint the window on top of which the client
611 will be rendered.
612
613 *Syntax*:
614 -----------------------
615 client.background color
616 -----------------------
617
618 Only clients that do not cover the whole area of this window expose the color
619 used to paint it. If you use a color other than black for your terminals, you
620 most likely want to set the client background color to the same color as your
621 terminal program's background color to avoid black gaps between the rendered
622 area of the terminal and the i3 border.
623
624 Colors are in HTML hex format (#rrggbb), see the following example:
625
626 *Examples (default colors)*:
627 ---------------------------------------------------------
628 # class                 border  backgr. text    indicator
629 client.focused          #4c7899 #285577 #ffffff #2e9ef4
630 client.focused_inactive #333333 #5f676a #ffffff #484e50
631 client.unfocused        #333333 #222222 #888888 #292d2e
632 client.urgent           #2f343a #900000 #ffffff #900000
633 ---------------------------------------------------------
634
635 Note that for the window decorations, the color around the child window is the
636 background color, and the border color is only the two thin lines at the top of
637 the window.
638
639 The indicator color is used for indicating where a new window will be opened.
640 For horizontal split containers, the right border will be painted in indicator
641 color, for vertical split containers, the bottom border. This only applies to
642 single windows within a split container, which are otherwise indistinguishable
643 from single windows outside of a split container.
644
645 === Interprocess communication
646
647 i3 uses unix sockets to provide an IPC interface. This allows third-party
648 programs to get information from i3, such as the current workspaces
649 (to display a workspace bar), and to control i3.
650
651 The IPC socket is enabled by default and will be created in
652 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
653 the PID of i3 and XXXXXX is a string of random characters from the portable
654 filename character set (see mkdtemp(3)).
655
656 You can override the default path through the environment-variable +I3SOCK+ or
657 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
658 does the right thing by default. If you decide to change it, it is strongly
659 recommended to set this to a location in your home directory so that no other
660 user can create that directory.
661
662 *Examples*:
663 ----------------------------
664 ipc-socket ~/.i3/i3-ipc.sock
665 ----------------------------
666
667 You can then use the +i3-msg+ application to perform any command listed in
668 the next section.
669
670 === Focus follows mouse
671
672 If you have a setup where your mouse usually is in your way (like a touchpad
673 on your laptop which you do not want to disable completely), you might want
674 to disable 'focus follows mouse' and control focus only by using your keyboard.
675 The mouse will still be useful inside the currently active window (for example
676 to click on links in your browser window).
677
678 *Syntax*:
679 ----------------------------
680 focus_follows_mouse <yes|no>
681 ----------------------------
682
683 *Example*:
684 ----------------------
685 focus_follows_mouse no
686 ----------------------
687
688 === Popups during fullscreen mode
689
690 When you are in fullscreen mode, some applications still open popup windows
691 (take Xpdf for example). This is because these applications may not be aware
692 that they are in fullscreen mode (they do not check the corresponding hint).
693 There are two things which are possible to do in this situation:
694
695 1. Just ignore the popup (don’t map it). This won’t interrupt you while you are
696    in fullscreen. However, some apps might react badly to this (deadlock until
697    you go out of fullscreen).
698 2. Leave fullscreen mode. This is the default.
699
700 *Syntax*:
701 -------------------------------------------------
702 popup_during_fullscreen <ignore|leave_fullscreen>
703 -------------------------------------------------
704
705 *Example*:
706 ------------------------------
707 popup_during_fullscreen ignore
708 ------------------------------
709
710 === Focus wrapping
711
712 When being in a tabbed or stacked container, the first container will be
713 focused when you use +focus down+ on the last container -- the focus wraps. If
714 however there is another stacked/tabbed container in that direction, focus will
715 be set on that container. This is the default behaviour so you can navigate to
716 all your windows without having to use +focus parent+.
717
718 If you want the focus to *always* wrap and you are aware of using +focus
719 parent+ to switch to different containers, you can use the
720 +force_focus_wrapping+ configuration directive. After enabling it, the focus
721 will always wrap.
722
723 *Syntax*:
724 -----------------------------
725 force_focus_wrapping <yes|no>
726 -----------------------------
727
728 *Example*:
729 ------------------------
730 force_focus_wrapping yes
731 ------------------------
732
733 === Forcing Xinerama
734
735 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
736 video drivers (especially the nVidia binary driver) only provide support for
737 Xinerama instead of RandR. In such a situation, i3 must be told to use the
738 inferior Xinerama API explicitly and therefore don’t provide support for
739 reconfiguring your screens on the fly (they are read only once on startup and
740 that’s it).
741
742 For people who do cannot modify their +~/.xsession+ to add the
743 +--force-xinerama+ commandline parameter, a configuration option is provided:
744
745 *Syntax*:
746 -----------------------
747 force_xinerama <yes|no>
748 -----------------------
749
750 *Example*:
751 ------------------
752 force_xinerama yes
753 ------------------
754
755 Also note that your output names are not descriptive (like +HDMI1+) when using
756 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
757
758 === Automatic back-and-forth when switching to the current workspace
759
760 This configuration directive enables automatic +workspace back_and_forth+ (see
761 <<back_and_forth>>) when switching to the workspace that is currently focused.
762
763 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
764 mod+2 because somebody sent you a message. You don’t need to remember where you
765 came from now, you can just press mod+2 again to switch back to "1: www".
766
767 *Syntax*:
768 --------------------------------------
769 workspace_auto_back_and_forth <yes|no>
770 --------------------------------------
771
772 *Example*:
773 ---------------------------------
774 workspace_auto_back_and_forth yes
775 ---------------------------------
776
777 == Configuring i3bar
778
779 The bar at the bottom of your monitor is drawn by a separate process called
780 i3bar. Having this part of "the i3 user interface" in a separate process has
781 several advantages:
782
783 1. It is a modular approach. If you don’t need a workspace bar at all, or if
784    you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
785    just remove the i3bar configuration and start your favorite bar instead.
786 2. It follows the UNIX philosophy of "Make each program do one thing well".
787    While i3 manages your windows well, i3bar is good at displaying a bar on
788    each monitor (unless you configure it otherwise).
789 3. It leads to two separate, clean codebases. If you want to understand i3, you
790    don’t need to bother with the details of i3bar and vice versa.
791
792 That said, i3bar is configured in the same configuration file as i3. This is
793 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
794 are useful for people using other window managers). Therefore, it makes no
795 sense to use a different configuration place when we already have a good
796 configuration infrastructure in place.
797
798 Configuring your workspace bar starts with opening a +bar+ block. You can have
799 multiple bar blocks to use different settings for different outputs (monitors):
800
801 *Example*:
802 ---------------------------
803 bar {
804     status_command i3status
805 }
806 ---------------------------
807
808 === i3bar command
809
810 By default i3 will just pass +i3bar+ and let your shell handle the execution,
811 searching your +$PATH+ for a correct version.
812 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
813 tell i3 what to execute.
814
815 The specified command will be passed to +sh -c+, so you can use globbing and
816 have to have correct quoting etc.
817
818 *Syntax*:
819 ----------------------
820 i3bar_command command
821 ----------------------
822
823 *Example*:
824 -------------------------------------------------
825 bar {
826     i3bar_command /home/user/bin/i3bar
827 }
828 -------------------------------------------------
829
830 [[status_command]]
831 === Statusline command
832
833 i3bar can run a program and display every line of its +stdout+ output on the
834 right hand side of the bar. This is useful to display system information like
835 your current IP address, battery status or date/time.
836
837 The specified command will be passed to +sh -c+, so you can use globbing and
838 have to have correct quoting etc.
839
840 *Syntax*:
841 ----------------------
842 status_command command
843 ----------------------
844
845 *Example*:
846 -------------------------------------------------
847 bar {
848     status_command i3status --config ~/.i3status.conf
849 }
850 -------------------------------------------------
851
852 === Display mode
853
854 You can have i3bar either be visible permanently at one edge of the screen
855 (+dock+ mode) or make it show up when you press your modifier key (+hide+
856 mode). The modifier key can be configured using the +modifier+ option.
857
858 The hide mode maximizes screen space that can be used for actual windows. Also,
859 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
860 save battery power.
861
862 The default is dock mode; in hide mode, the default modifier is Mod4 (usually
863 the windows key).
864
865 *Syntax*:
866 ----------------
867 mode <dock|hide>
868 modifier <Modifier>
869 ----------------
870
871 *Example*:
872 ----------------
873 bar {
874     mode hide
875     modifier Mod1
876 }
877 ----------------
878
879 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
880
881 [[i3bar_position]]
882 === Position
883
884 This option determines in which edge of the screen i3bar should show up.
885
886 The default is bottom.
887
888 *Syntax*:
889 ---------------------
890 position <top|bottom>
891 ---------------------
892
893 *Example*:
894 ---------------------
895 bar {
896     position top
897 }
898 ---------------------
899
900 === Output(s)
901
902 You can restrict i3bar to one or more outputs (monitors). The default is to
903 handle all outputs. Restricting the outputs is useful for using different
904 options for different outputs by using multiple 'bar' blocks.
905
906 To make a particular i3bar instance handle multiple outputs, specify the output
907 directive multiple times.
908
909 *Syntax*:
910 ---------------
911 output <output>
912 ---------------
913
914 *Example*:
915 -------------------------------
916 # big monitor: everything
917 bar {
918     # The display is connected either via HDMI or via DisplayPort
919     output HDMI2
920     output DP2
921     status_command i3status
922 }
923
924 # laptop monitor: bright colors and i3status with less modules.
925 bar {
926     output LVDS1
927     status_command i3status --config ~/.i3status-small.conf
928     colors {
929         background #000000
930         statusline #ffffff
931     }
932 }
933 -------------------------------
934
935 === Tray output
936
937 i3bar by default provides a system tray area where programs such as
938 NetworkManager, VLC, Pidgin, etc. can place little icons.
939
940 You can configure on which output (monitor) the icons should be displayed or
941 you can turn off the functionality entirely.
942
943 *Syntax*:
944 -------------------------
945 tray_output <none|output>
946 -------------------------
947
948 *Example*:
949 -------------------------
950 # disable system tray
951 bar {
952     tray_output none
953 }
954
955 # show tray icons on the big monitor
956 bar {
957     tray_output HDMI2
958 }
959 -------------------------
960
961 === Font
962
963 Specifies the font (again, X core font, not Xft, just like in i3) to be used in
964 the bar.
965
966 *Syntax*:
967 ---------------------
968 font <font>
969 ---------------------
970
971 *Example*:
972 --------------------------------------------------------------
973 bar {
974     font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
975 }
976 --------------------------------------------------------------
977
978 === Workspace buttons
979
980 Specifies whether workspace buttons should be shown or not. This is useful if
981 you want to display a statusline-only bar containing additional information.
982
983 The default is to show workspace buttons.
984
985 *Syntax*:
986 --------------------------
987 workspace_buttons <yes|no>
988 --------------------------
989
990 *Example*:
991 --------------------
992 bar {
993     workspace_buttons no
994 }
995 --------------------
996
997 === Colors
998
999 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1000 be configured at the moment:
1001
1002 background::
1003         Background color of the bar.
1004 statusline::
1005         Text color to be used for the statusline.
1006 focused_workspace::
1007         Border, background and text color for a workspace button when the workspace
1008         has focus.
1009 active_workspace::
1010         Border, background and text color for a workspace button when the workspace
1011         is active (visible) on some output, but the focus is on another one.
1012         You can only tell this apart from the focused workspace when you are
1013         using multiple monitors.
1014 inactive_workspace::
1015         Border, background and text color for a workspace button when the workspace
1016         does not have focus and is not active (visible) on any output. This
1017         will be the case for most workspaces.
1018 urgent_workspace::
1019         Border, background and text color for a workspace button when the workspace
1020         window with the urgency hint set.
1021
1022 *Syntax*:
1023 ----------------------------------------
1024 colors {
1025     background <color>
1026     statusline <color>
1027
1028     colorclass <border> <background> <text>
1029 }
1030 ----------------------------------------
1031
1032 *Example (default colors)*:
1033 --------------------------------------
1034 bar {
1035     colors {
1036         background #000000
1037         statusline #ffffff
1038
1039         focused_workspace  #4c7899 #285577 #ffffff
1040         active_workspace   #333333 #5f676a #ffffff
1041         inactive_workspace #333333 #222222 #888888
1042         urgent_workspace   #2f343a #900000 #ffffff
1043     }
1044 }
1045 --------------------------------------
1046
1047 == List of commands
1048
1049 Commands are what you bind to specific keypresses. You can also issue commands
1050 at runtime without pressing a key by using the IPC interface. An easy way to
1051 do this is to use the +i3-msg+ utility:
1052
1053 *Example*:
1054 --------------------------
1055 # execute this on your shell to make the current container borderless
1056 i3-msg border none
1057 --------------------------
1058
1059 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1060 specific workspace and immediately switch to that workspace, you can configure
1061 the following keybinding:
1062
1063 *Example*:
1064 --------------------------------------------------------
1065 bindsym mod+x move container to workspace 3; workspace 3
1066 --------------------------------------------------------
1067
1068 [[command_criteria]]
1069
1070 Furthermore, you can change the scope of a command, that is, which containers
1071 should be affected by that command, by using various criteria. These are
1072 prefixed in square brackets to every command. If you want to kill all windows
1073 which have the class Firefox, use:
1074
1075 *Example*:
1076 ------------------------------------
1077 bindsym mod+x [class="Firefox"] kill
1078
1079 # same thing, but case-insensitive
1080 bindsym mod+x [class="(?i)firefox"] kill
1081 ------------------------------------
1082
1083 The criteria which are currently implemented are:
1084
1085 class::
1086         Compares the window class (the second part of WM_CLASS)
1087 instance::
1088         Compares the window instance (the first part of WM_CLASS)
1089 window_role::
1090         Compares the window role (WM_WINDOW_ROLE).
1091 id::
1092         Compares the X11 window ID, which you can get via +xwininfo+ for example.
1093 title::
1094         Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
1095 con_mark::
1096         Compares the mark set for this container, see <<vim_like_marks>>.
1097 con_id::
1098         Compares the i3-internal container ID, which you can get via the IPC
1099         interface. Handy for scripting.
1100
1101 The criteria +class+, +instance+, +role+, +title+ and +mark+ are actually
1102 regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1103 information on how to use them.
1104
1105 [[exec]]
1106
1107 === Executing applications (exec)
1108
1109 What good is a window manager if you can’t actually start any applications?
1110 The exec command starts an application by passing the command you specify to a
1111 shell. This implies that you can use globbing (wildcards) and programs will be
1112 searched in your $PATH.
1113
1114 *Syntax*:
1115 ------------------------------
1116 exec [--no-startup-id] command
1117 ------------------------------
1118
1119 *Example*:
1120 ------------------------------
1121 # Start the GIMP
1122 bindsym mod+g exec gimp
1123
1124 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1125 bindsym mod+Return exec --no-startup-id urxvt
1126 ------------------------------
1127
1128 The +--no-startup-id+ parameter disables startup-notification support for this
1129 particular exec command. With startup-notification, i3 can make sure that a
1130 window appears on the workspace on which you used the exec command. Also, it
1131 will change the X11 cursor to +watch+ (a clock) while the application is
1132 launching. So, if an application is not startup-notification aware (most GTK
1133 and Qt using applications seem to be, though), you will end up with a watch
1134 cursor for 60 seconds.
1135
1136 === Splitting containers
1137
1138 The split command makes the current window a split container. Split containers
1139 can contain multiple windows. Every split container has an orientation, it is
1140 either split horizontally (a new window gets placed to the right of the current
1141 one) or vertically (a new window gets placed below the current one).
1142
1143 If you apply this command to a split container with the same orientation,
1144 nothing will happen. If you use a different orientation, the split container’s
1145 orientation will be changed (if it does not have more than one window).
1146
1147 *Syntax*:
1148 ---------------------------
1149 split <vertical|horizontal>
1150 ---------------------------
1151
1152 *Example*:
1153 ------------------------------
1154 bindsym mod+v split vertical
1155 bindsym mod+h split horizontal
1156 ------------------------------
1157
1158 === Manipulating layout
1159
1160 Use +layout default+, +layout stacking+ or +layout tabbed+ to change the
1161 current container layout to default, stacking or tabbed layout, respectively.
1162
1163 To make the current window (!) fullscreen, use +fullscreen+, to make
1164 it floating (or tiling again) use +floating enable+ respectively +floating disable+
1165 (or +floating toggle+):
1166
1167 *Examples*:
1168 --------------
1169 bindsym mod+s layout stacking
1170 bindsym mod+l layout default
1171 bindsym mod+w layout tabbed
1172
1173 # Toggle fullscreen
1174 bindsym mod+f fullscreen
1175
1176 # Toggle floating/tiling
1177 bindsym mod+t floating toggle
1178 --------------
1179
1180 === Focusing/Moving containers
1181
1182 To change the focus, use the focus command: +focus left+, +focus right+, +focus
1183 down+ and +focus up+.
1184
1185 There are a few special parameters you can use for the focus command:
1186
1187 parent::
1188         Sets focus to the +Parent Container+ of the current +Container+.
1189 child::
1190         The opposite of +focus parent+, sets the focus to the last focused
1191         child container.
1192 floating::
1193         Sets focus to the last focused floating container.
1194 tiling::
1195         Sets focus to the last focused tiling container.
1196 mode_toggle::
1197         Toggles between floating/tiling containers.
1198 output::
1199         Followed by a direction or an output name, this will focus the
1200         corresponding output.
1201
1202 For moving, use +move left+, +move right+, +move down+ and +move up+.
1203
1204 *Syntax*:
1205 -----------------------------------
1206 focus <left|right|down|up>
1207 focus <parent|child|floating|tiling|mode_toggle>
1208 focus output <<left|right|down|up>|output>
1209 move <left|right|down|up> [<px> px]
1210 -----------------------------------
1211
1212 Note that the amount of pixels you can specify for the +move+ command is only
1213 relevant for floating containers. The default amount is 10 pixels.
1214
1215 *Examples*:
1216 ----------------------
1217 # Focus container on the left, bottom, top, right:
1218 bindsym mod+j focus left
1219 bindsym mod+k focus down
1220 bindsym mod+l focus up
1221 bindsym mod+semicolon focus right
1222
1223 # Focus parent container
1224 bindsym mod+u focus parent
1225
1226 # Focus last floating/tiling container
1227 bindsym mod+g focus mode_toggle
1228
1229 # Focus the output right to the current one
1230 bindsym mod+x focus output right
1231
1232 # Focus the big output
1233 bindsym mod+x focus output HDMI-2
1234
1235 # Move container to the left, bottom, top, right:
1236 bindsym mod+j move left
1237 bindsym mod+k move down
1238 bindsym mod+l move up
1239 bindsym mod+semicolon move right
1240
1241 # Move container, but make floating containers
1242 # move more than the default
1243 bindsym mod+j move left 20 px
1244 ----------------------
1245
1246 === Changing (named) workspaces/moving to workspaces
1247
1248 To change to a specific workspace, use the +workspace+ command, followed by the
1249 number or name of the workspace. To move containers to specific workspaces, use
1250 +move container to workspace+.
1251
1252 You can also switch to the next and previous workspace with the commands
1253 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1254 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1255 combination. To restrict those to the current output, use +workspace
1256 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1257 container to workspace next+ and +move container to workspace prev+ to move a
1258 container to the next/previous workspace.
1259
1260 [[back_and_forth]]
1261 To switch back to the previously focused workspace, use +workspace
1262 back_and_forth+.
1263
1264 To move a container to another xrandr output such as +LVDS1+ or +VGA1+, you can
1265 use the +move container to output+ command followed by the name of the target
1266 output. You may also use +left+, +right+, +up+, +down+ instead of the xrandr
1267 output name to move to the next output in the specified direction.
1268
1269 To move a whole workspace to another xrandr output such as +LVDS1+ or +VGA1+,
1270 you can use the +move workspace to output+ command followed by the name of the
1271 target output. You may also use +left+, +right+, +up+, +down+ instead of the
1272 xrandr output name to move to the next output in the specified direction.
1273
1274 *Examples*:
1275 -------------------------
1276 bindsym mod+1 workspace 1
1277 bindsym mod+2 workspace 2
1278 ...
1279
1280 bindsym mod+Shift+1 move container to workspace 1
1281 bindsym mod+Shift+2 move container to workspace 2
1282 ...
1283
1284 # switch between the current and the previously focused one
1285 bindsym mod+b workspace back_and_forth
1286
1287 # move the whole workspace to the next output
1288 bindsym mod+x move workspace to output right
1289 -------------------------
1290
1291 ==== Named workspaces
1292
1293 Workspaces are identified by their name. So, instead of using numbers in the
1294 workspace command, you can use an arbitrary name:
1295
1296 *Example*:
1297 -------------------------
1298 bindsym mod+1 workspace mail
1299 ...
1300 -------------------------
1301
1302 If you want the workspace to have a number *and* a name, just prefix the
1303 number, like this:
1304
1305 *Example*:
1306 -------------------------
1307 bindsym mod+1 workspace 1: mail
1308 bindsym mod+2 workspace 2: www
1309 ...
1310 -------------------------
1311
1312 Note that the workspace will really be named "1: mail". i3 treats workspace
1313 names beginning with a number in a slightly special way. Normally, named
1314 workspaces are ordered the way they appeared. When they start with a number, i3
1315 will order them numerically.
1316
1317 [[resizingconfig]]
1318
1319 === Resizing containers/windows
1320
1321 If you want to resize containers/windows using your keyboard, you can use the
1322 +resize+ command:
1323
1324 *Syntax*:
1325 ---------------------------------------------------------
1326 resize <grow|shrink> <direction> [<px> px] [or <ppt> ppt]
1327 ---------------------------------------------------------
1328
1329 Direction can be one of +up+, +down+, +left+ or +right+. The optional pixel
1330 argument specifies by how many pixels a *floating container* should be grown or
1331 shrunk (the default is 10 pixels). The ppt argument means percentage points
1332 and specifies by how many percentage points a *tiling container* should be
1333 grown or shrunk (the default is 10 percentage points).
1334
1335 I recommend using the resize command inside a so called +mode+:
1336
1337 .Example: Configuration file, defining a mode for resizing
1338 ----------------------------------------------------------------------
1339 mode "resize" {
1340         # These bindings trigger as soon as you enter the resize mode
1341
1342         # They resize the border in the direction you pressed, e.g.
1343         # when pressing left, the window is resized so that it has
1344         # more space on its left
1345
1346         bindsym j resize shrink left
1347         bindsym Shift+j resize grow left
1348
1349         bindsym k resize grow down
1350         bindsym Shift+k resize shrink down
1351
1352         bindsym l resize shrink up
1353         bindsym Shift+l resize grow up
1354
1355         bindsym semicolon resize grow right
1356         bindsym Shift+semicolon resize shrink right
1357
1358         # back to normal: Enter or Escape
1359         bindsym Return mode "default"
1360         bindsym Escape mode "default"
1361 }
1362
1363 # Enter resize mode
1364 bindsym mod+r mode "resize"
1365 ----------------------------------------------------------------------
1366
1367 === Jumping to specific windows
1368
1369 Often when in a multi-monitor environment, you want to quickly jump to a
1370 specific window. For example, while working on workspace 3 you may want to
1371 jump to your mail client to email your boss that you’ve achieved some
1372 important goal. Instead of figuring out how to navigate to your mailclient,
1373 it would be more convenient to have a shortcut. You can use the +focus+ command
1374 with criteria for that.
1375
1376 *Syntax*:
1377 ----------------------------------------------------
1378 [class="class"] focus
1379 [title="title"] focus
1380 ----------------------------------------------------
1381
1382 *Examples*:
1383 ------------------------------------------------
1384 # Get me to the next open VIM instance
1385 bindsym mod+a [class="urxvt" title="VIM"] focus
1386 ------------------------------------------------
1387
1388 === VIM-like marks (mark/goto)
1389
1390 [[vim_like_marks]]
1391
1392 This feature is like the jump feature: It allows you to directly jump to a
1393 specific window (this means switching to the appropriate workspace and setting
1394 focus to the windows). However, you can directly mark a specific window with
1395 an arbitrary label and use it afterwards.  You do not need to ensure that your
1396 windows have unique classes or titles, and you do not need to change your
1397 configuration file.
1398
1399 As the command needs to include the label with which you want to mark the
1400 window, you cannot simply bind it to a key.  +i3-input+ is a tool created
1401 for this purpose: It lets you input a command and sends the command to i3. It
1402 can also prefix this command and display a custom prompt for the input dialog.
1403
1404 *Syntax*:
1405 ------------------------------
1406 mark identifier
1407 [con_mark="identifier"] focus
1408 ------------------------------
1409
1410 *Example (in a terminal)*:
1411 ------------------------------
1412 $ i3-msg mark irssi
1413 $ i3-msg '[con_mark="irssi"] focus'
1414 ------------------------------
1415
1416 ///////////////////////////////////////////////////////////////////
1417 TODO: make i3-input replace %s
1418 *Examples*:
1419 ---------------------------------------
1420 # Read 1 character and mark the current window with this character
1421 bindsym mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
1422
1423 # Read 1 character and go to the window with the character
1424 bindsym mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
1425 ---------------------------------------
1426
1427 Alternatively, if you do not want to mess with +i3-input+, you could create
1428 seperate bindings for a specific set of labels and then only use those labels.
1429 ///////////////////////////////////////////////////////////////////
1430
1431 === Changing border style
1432
1433 To change the border of the current client, you can use +border normal+ to use the normal
1434 border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
1435 and +border none+ to make the client borderless.
1436
1437 There is also +border toggle+ which will toggle the different border styles.
1438
1439 *Examples*:
1440 ----------------------------
1441 bindsym mod+t border normal
1442 bindsym mod+y border 1pixel
1443 bindsym mod+u border none
1444 ----------------------------
1445
1446 [[stack-limit]]
1447
1448 ///////////////////////////////////////////////////////////////////////////////
1449 TODO: not yet implemented
1450 === Changing the stack-limit of a container
1451
1452 If you have a single container with a lot of windows inside it (say, more than
1453 10), the default layout of a stacking container can get a little unhandy.
1454 Depending on your screen’s size, you might end up with only half of the title
1455 lines being actually used, wasting a lot of screen space.
1456
1457 Using the +stack-limit+ command, you can limit the number of rows or columns
1458 in a stacking container. i3 will create columns or rows (depending on what
1459 you limited) automatically as needed.
1460
1461 *Syntax*:
1462 --------------------------------
1463 stack-limit <cols|rows> <value>
1464 --------------------------------
1465
1466 *Examples*:
1467 -------------------
1468 # I always want to have two window titles in one line
1469 stack-limit cols 2
1470
1471 # Not more than 5 rows in this stacking container
1472 stack-limit rows 5
1473 -------------------
1474
1475 image:stacklimit.png[Container limited to two columns]
1476 ///////////////////////////////////////////////////////////////////////////////
1477
1478 === Reloading/Restarting/Exiting
1479
1480 You can make i3 reload its configuration file with +reload+. You can also
1481 restart i3 inplace with the +restart+ command to get it out of some weird state
1482 (if that should ever happen) or to perform an upgrade without having to restart
1483 your X session. To exit i3 properly, you can use the +exit+ command,
1484 however you don’t need to (simply killing your X session is fine as well).
1485
1486 *Examples*:
1487 ----------------------------
1488 bindsym mod+Shift+r restart
1489 bindsym mod+Shift+w reload
1490 bindsym mod+Shift+e exit
1491 ----------------------------
1492
1493 === Scratchpad
1494
1495 There are two commands to use any existing window as scratchpad window. +move
1496 scratchpad+ will move a window to the scratchpad workspace. This will make it
1497 invisible until you show it again. There is no way to open that workspace.
1498 Instead, when using +scratchpad show+, the window will be shown again, as a
1499 floating window, centered on your current workspace (using +scratchpad show+ on
1500 a visible scratchpad window will make it hidden again, so you can have a
1501 keybinding to toggle).
1502
1503 As the name indicates, this is useful for having a window with your favorite
1504 editor always at hand. However, you can also use this for other permanently
1505 running applications which you don’t want to see all the time: Your music
1506 player, alsamixer, maybe even your mail client…?
1507
1508 *Syntax*:
1509 ---------------
1510 move scratchpad
1511
1512 scratchpad show
1513 ---------------
1514
1515 *Examples*:
1516 ------------------------------------------------
1517 # Make the currently focused window a scratchpad
1518 bindsym mod+Shift+minus move scratchpad
1519
1520 # Show the first scratchpad window
1521 bindsym mod+minus scratchpad show
1522
1523 # Show the sup-mail scratchpad window, if any.
1524 bindsym mod4+s [title="^Sup ::"] scratchpad show
1525 ------------------------------------------------
1526
1527 [[multi_monitor]]
1528
1529 == Multiple monitors
1530
1531 As you can see in the goal list on the website, i3 was specifically developed
1532 with support for multiple monitors in mind. This section will explain how to
1533 handle multiple monitors.
1534
1535 When you have only one monitor, things are simple. You usually start with
1536 workspace 1 on your monitor and open new ones as you need them.
1537
1538 When you have more than one monitor, each monitor will get an initial
1539 workspace.  The first monitor gets 1, the second gets 2 and a possible third
1540 would get 3. When you switch to a workspace on a different monitor, i3 will
1541 switch to that monitor and then switch to the workspace. This way, you don’t
1542 need shortcuts to switch to a specific monitor, and you don’t need to remember
1543 where you put which workspace. New workspaces will be opened on the currently
1544 active monitor.  It is not possible to have a monitor without a workspace.
1545
1546 The idea of making workspaces global is based on the observation that most
1547 users have a very limited set of workspaces on their additional monitors.
1548 They are often used for a specific task (browser, shell) or for monitoring
1549 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
1550 and "the rest" on the other monitors often makes sense. However, as you can
1551 create an unlimited number of workspaces in i3 and tie them to specific
1552 screens, you can have the "traditional" approach of having X workspaces per
1553 screen by changing your configuration (using modes, for example).
1554
1555 === Configuring your monitors
1556
1557 To help you get going if you have never used multiple monitors before, here is
1558 a short overview of the xrandr options which will probably be of interest to
1559 you. It is always useful to get an overview of the current screen configuration.
1560 Just run "xrandr" and you will get an output like the following:
1561 -------------------------------------------------------------------------------
1562 $ xrandr
1563 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
1564 VGA1 disconnected (normal left inverted right x axis y axis)
1565 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
1566    1280x800       60.0*+   50.0
1567    1024x768       85.0     75.0     70.1     60.0
1568    832x624        74.6
1569    800x600        85.1     72.2     75.0     60.3     56.2
1570    640x480        85.0     72.8     75.0     59.9
1571    720x400        85.0
1572    640x400        85.1
1573    640x350        85.1
1574 --------------------------------------------------------------------------------------
1575
1576 Several things are important here: You can see that +LVDS1+ is connected (of
1577 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
1578 connected to one of the ports but xrandr still says "disconnected", you should
1579 check your cable, monitor or graphics driver.
1580
1581 The maximum resolution you can see at the end of the first line is the maximum
1582 combined resolution of your monitors. By default, it is usually too low and has
1583 to be increased by editing +/etc/X11/xorg.conf+.
1584
1585 So, say you connected VGA1 and want to use it as an additional screen:
1586 -------------------------------------------
1587 xrandr --output VGA1 --auto --left-of LVDS1
1588 -------------------------------------------
1589 This command makes xrandr try to find the native resolution of the device
1590 connected to +VGA1+ and configures it to the left of your internal flat panel.
1591 When running "xrandr" again, the output looks like this:
1592 -------------------------------------------------------------------------------
1593 $ xrandr
1594 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
1595 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
1596    1280x1024      60.0*+   75.0
1597    1280x960       60.0
1598    1152x864       75.0
1599    1024x768       75.1     70.1     60.0
1600    832x624        74.6
1601    800x600        72.2     75.0     60.3     56.2
1602    640x480        72.8     75.0     66.7     60.0
1603    720x400        70.1
1604 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
1605    1280x800       60.0*+   50.0
1606    1024x768       85.0     75.0     70.1     60.0
1607    832x624        74.6
1608    800x600        85.1     72.2     75.0     60.3     56.2
1609    640x480        85.0     72.8     75.0     59.9
1610    720x400        85.0
1611    640x400        85.1
1612    640x350        85.1
1613 -------------------------------------------------------------------------------
1614 Please note that i3 uses exactly the same API as xrandr does, so it will see
1615 only what you can see in xrandr.
1616
1617 See also <<presentations>> for more examples of multi-monitor setups.
1618
1619 === Interesting configuration for multi-monitor environments
1620
1621 There are several things to configure in i3 which may be interesting if you
1622 have more than one monitor:
1623
1624 1. You can specify which workspace should be put on which screen. This
1625    allows you to have a different set of workspaces when starting than just
1626    1 for the first monitor, 2 for the second and so on. See
1627    <<workspace_screen>>.
1628 2. If you want some applications to generally open on the bigger screen
1629    (MPlayer, Firefox, …), you can assign them to a specific workspace, see
1630    <<assign_workspace>>.
1631 3. If you have many workspaces on many monitors, it might get hard to keep
1632    track of which window you put where. Thus, you can use vim-like marks to
1633    quickly switch between windows. See <<vim_like_marks>>.
1634
1635 == i3 and the rest of your software world
1636
1637 === Displaying a status line
1638
1639 A very common thing amongst users of exotic window managers is a status line at
1640 some corner of the screen. It is an often superior replacement to the widget
1641 approach you have in the task bar of a traditional desktop environment.
1642
1643 If you don’t already have your favorite way of generating such a status line
1644 (self-written scripts, conky, …), then i3status is the recommended tool for
1645 this task. It was written in C with the goal of using as few syscalls as
1646 possible to reduce the time your CPU is woken up from sleep states. Because
1647 i3status only spits out text, you need to combine it with some other tool, like
1648 i3bar. See <<status_command>> for how to display i3status in i3bar.
1649
1650 Regardless of which application you use to display the status line, you
1651 want to make sure that it registers as a dock window using EWMH hints. i3 will
1652 position the window either at the top or at the bottom of the screen, depending
1653 on which hint the application sets. With i3bar, you can configure its position,
1654 see <<i3bar_position>>.
1655
1656 === Giving presentations (multi-monitor)
1657
1658 When giving a presentation, you typically want the audience to see what you see
1659 on your screen and then go through a series of slides (if the presentation is
1660 simple). For more complex presentations, you might want to have some notes
1661 which only you can see on your screen, while the audience can only see the
1662 slides.
1663
1664 [[presentations]]
1665 ==== Case 1: everybody gets the same output
1666 This is the simple case. You connect your computer to the video projector,
1667 turn on both (computer and video projector) and configure your X server to
1668 clone the internal flat panel of your computer to the video output:
1669 -----------------------------------------------------
1670 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
1671 -----------------------------------------------------
1672 i3 will then use the lowest common subset of screen resolutions, the rest of
1673 your screen will be left untouched (it will show the X background). So, in
1674 our example, this would be 1024x768 (my notebook has 1280x800).
1675
1676 ==== Case 2: you can see more than your audience
1677 This case is a bit harder. First of all, you should configure the VGA output
1678 somewhere near your internal flat panel, say right of it:
1679 -----------------------------------------------------
1680 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
1681 -----------------------------------------------------
1682 Now, i3 will put a new workspace (depending on your settings) on the new screen
1683 and you are in multi-monitor mode (see <<multi_monitor>>).
1684
1685 Because i3 is not a compositing window manager, there is no ability to
1686 display a window on two screens at the same time. Instead, your presentation
1687 software needs to do this job (that is, open a window on each screen).