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