]> git.sur5r.net Git - i3/i3/blob - docs/userguide
Merge pull request #1994 from Airblader/bug-1992
[i3/i3] / docs / userguide
1 i3 User’s Guide
2 ===============
3 Michael Stapelberg <michael@i3wm.org>
4 March 2013
5
6 This document contains all the information you need to configure and use the i3
7 window manager. If it does not, please check http://faq.i3wm.org/ first, then
8 contact us on IRC (preferred) or post your question(s) on the mailing list.
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 Note that when starting i3 without a config file, i3-config-wizard will offer
27 you to create a config file in which the key positions (!) match what you see
28 in the image above, regardless of the keyboard layout you are using. If you
29 prefer to use a config file where the key letters match what you are seeing
30 above, just decline i3-config-wizard’s offer and base your config on
31 +/etc/i3/config+.
32
33 == Using i3
34
35 Throughout this guide, the keyword +$mod+ will be used to refer to the
36 configured modifier. This is the Alt key (Mod1) by default, with the Windows
37 key (Mod4) being a popular alternative.
38
39 === Opening terminals and moving around
40
41 One very basic operation is opening a new terminal. By default, the keybinding
42 for this is $mod+Enter, that is Alt+Enter in the default configuration. By
43 pressing $mod+Enter, a new terminal will be opened.  It will fill the whole
44 space available on your screen.
45
46 image:single_terminal.png[Single terminal]
47
48 If you now open another terminal, i3 will place it next to the current one,
49 splitting the screen size in half. Depending on your monitor, i3 will put the
50 created window beside the existing window (on wide displays) or below the
51 existing window (rotated displays).
52
53 image:two_terminals.png[Two terminals]
54
55 To move the focus between the two terminals, you can use the direction keys
56 which you may know from the editor +vi+. However, in i3, your homerow is used
57 for these keys (in +vi+, the keys are shifted to the left by one for
58 compatibility with most keyboard layouts). Therefore, +$mod+J+ is left, +$mod+K+
59 is down, +$mod+L+ is up and `$mod+;` is right. So, to switch between the
60 terminals, use +$mod+K+ or +$mod+L+. Of course, you can also use the arrow keys.
61
62 At the moment, your workspace is split (it contains two terminals) in a
63 specific direction (horizontal by default). Every window can be split
64 horizontally or vertically again, just like the workspace. The terminology is
65 "window" for a container that actually contains an X11 window (like a terminal
66 or browser) and "split container" for containers that consist of one or more
67 windows.
68
69 TODO: picture of the tree
70
71 To split a window vertically, press +$mod+v+ before you create the new window.
72 To split it horizontally, press +$mod+h+.
73
74 === Changing the container layout
75
76 A split container can have one of the following layouts:
77
78 splith/splitv::
79 Windows are sized so that every window gets an equal amount of space in the
80 container. splith distributes the windows horizontally (windows are right next
81 to each other), splitv distributes them vertically (windows are on top of each
82 other).
83 stacking::
84 Only the focused window in the container is displayed. You get a list of
85 windows at the top of the container.
86 tabbed::
87 The same principle as +stacking+, but the list of windows at the top is only
88 a single line which is vertically split.
89
90 To switch modes, press +$mod+e+ for splith/splitv (it toggles), +$mod+s+ for
91 stacking and +$mod+w+ for tabbed.
92
93 image:modes.png[Container modes]
94
95 === Toggling fullscreen mode for a window
96
97 To display a window in fullscreen mode or to go out of fullscreen mode again,
98 press +$mod+f+.
99
100 There is also a global fullscreen mode in i3 in which the client will span all
101 available outputs (the command is +fullscreen toggle global+).
102
103 === Opening other applications
104
105 Aside from opening applications from a terminal, you can also use the handy
106 +dmenu+ which is opened by pressing +$mod+d+ by default. Just type the name
107 (or a part of it) of the application which you want to open. The corresponding
108 application has to be in your +$PATH+ for this to work.
109
110 Additionally, if you have applications you open very frequently, you can
111 create a keybinding for starting the application directly. See the section
112 <<configuring>> for details.
113
114 === Closing windows
115
116 If an application does not provide a mechanism for closing (most applications
117 provide a menu, the escape key or a shortcut like +Control+W+ to close), you
118 can press +$mod+Shift+q+ to kill a window. For applications which support
119 the WM_DELETE protocol, this will correctly close the application (saving
120 any modifications or doing other cleanup). If the application doesn’t support
121 the WM_DELETE protocol your X server will kill the window and the behaviour
122 depends on the application.
123
124 === Using workspaces
125
126 Workspaces are an easy way to group a set of windows. By default, you are on
127 the first workspace, as the bar on the bottom left indicates. To switch to
128 another workspace, press +$mod+num+ where +num+ is the number of the workspace
129 you want to use. If the workspace does not exist yet, it will be created.
130
131 A common paradigm is to put the web browser on one workspace, communication
132 applications (+mutt+, +irssi+, ...) on another one, and the ones with which you
133 work, on the third one. Of course, there is no need to follow this approach.
134
135 If you have multiple screens, a workspace will be created on each screen at
136 startup. If you open a new workspace, it will be bound to the screen you
137 created it on.  When you switch to a workspace on another screen, i3 will set
138 focus to that screen.
139
140 === Moving windows to workspaces
141
142 To move a window to another workspace, simply press +$mod+Shift+num+ where
143 +num+ is (like when switching workspaces) the number of the target workspace.
144 Similarly to switching workspaces, the target workspace will be created if
145 it does not yet exist.
146
147 === Resizing
148
149 The easiest way to resize a container is by using the mouse: Grab the border
150 and move it to the wanted size.
151
152 See <<resizingconfig>> for how to configure i3 to be able to resize
153 columns/rows with your keyboard.
154
155 === Restarting i3 inplace
156
157 To restart i3 in place (and thus get into a clean state if there is a bug, or
158 to upgrade to a newer version of i3) you can use +$mod+Shift+r+.
159
160 === Exiting i3
161
162 To cleanly exit i3 without killing your X server, you can use +$mod+Shift+e+.
163 By default, a dialog will ask you to confirm if you really want to quit.
164
165 === Floating
166
167 Floating mode is the opposite of tiling mode. The position and size of
168 a window are not managed automatically by i3, but manually by
169 you. Using this mode violates the tiling paradigm but can be useful
170 for some corner cases like "Save as" dialog windows, or toolbar
171 windows (GIMP or similar). Those windows usually set the appropriate
172 hint and are opened in floating mode by default.
173
174 You can toggle floating mode for a window by pressing +$mod+Shift+Space+. By
175 dragging the window’s titlebar with your mouse you can move the window
176 around. By grabbing the borders and moving them you can resize the window. You
177 can also do that by using the <<floating_modifier>>. Another way to resize
178 floating windows using the mouse is to right-click on the titlebar and drag.
179
180 For resizing floating windows with your keyboard, see <<resizingconfig>>.
181
182 Floating windows are always on top of tiling windows.
183
184 == Tree
185
186 i3 stores all information about the X11 outputs, workspaces and layout of the
187 windows on them in a tree. The root node is the X11 root window, followed by
188 the X11 outputs, then dock areas and a content container, then workspaces and
189 finally the windows themselves. In previous versions of i3 we had multiple lists
190 (of outputs, workspaces) and a table for each workspace. That approach turned
191 out to be complicated to use (snapping), understand and implement.
192
193 === The tree consists of Containers
194
195 The building blocks of our tree are so called +Containers+. A +Container+ can
196 host a window (meaning an X11 window, one that you can actually see and use,
197 like a browser). Alternatively, it could contain one or more +Containers+. A
198 simple example is the workspace: When you start i3 with a single monitor, a
199 single workspace and you open two terminal windows, you will end up with a tree
200 like this:
201
202 image::tree-layout2.png["layout2",float="right"]
203 image::tree-shot4.png["shot4",title="Two terminals on standard workspace"]
204
205 === Orientation and Split Containers
206
207 [[OrientationSplit]]
208
209 It is only natural to use so-called +Split Containers+ in order to build a
210 layout when using a tree as data structure. In i3, every +Container+ has an
211 orientation (horizontal, vertical or unspecified) and the orientation depends
212 on the layout the container is in (vertical for splitv and stacking, horizontal
213 for splith and tabbed). So, in our example with the workspace, the default
214 layout of the workspace +Container+ is splith (most monitors are widescreen
215 nowadays). If you change the layout to splitv (+$mod+v+ in the default config)
216 and *then* open two terminals, i3 will configure your windows like this:
217
218 image::tree-shot2.png["shot2",title="Vertical Workspace Orientation"]
219
220 An interesting new feature of i3 since version 4 is the ability to split anything:
221 Let’s assume you have two terminals on a workspace (with splith layout, that is
222 horizontal orientation), focus is on the right terminal. Now you want to open
223 another terminal window below the current one. If you would just open a new
224 terminal window, it would show up to the right due to the splith layout.
225 Instead, press +$mod+v+ to split the container with the splitv layout (to
226 open a +Horizontal Split Container+, use +$mod+h+). Now you can open a new
227 terminal and it will open below the current one:
228
229 image::tree-layout1.png["Layout",float="right"]
230 image::tree-shot1.png["shot",title="Vertical Split Container"]
231
232 unfloat::[]
233
234 You probably guessed it already: There is no limit on how deep your hierarchy
235 of splits can be.
236
237 === Focus parent
238
239 Let’s stay with our example from above. We have a terminal on the left and two
240 vertically split terminals on the right, focus is on the bottom right one. When
241 you open a new terminal, it will open below the current one.
242
243 So, how can you open a new terminal window to the *right* of the current one?
244 The solution is to use +focus parent+, which will focus the +Parent Container+ of
245 the current +Container+. In this case, you would focus the +Vertical Split
246 Container+ which is *inside* the horizontally oriented workspace. Thus, now new
247 windows will be opened to the right of the +Vertical Split Container+:
248
249 image::tree-shot3.png["shot3",title="Focus parent, then open new terminal"]
250
251 === Implicit containers
252
253 In some cases, i3 needs to implicitly create a container to fulfill your
254 command.
255
256 One example is the following scenario: You start i3 with a single monitor and a
257 single workspace on which you open three terminal windows. All these terminal
258 windows are directly attached to one node inside i3’s layout tree, the
259 workspace node. By default, the workspace node’s orientation is +horizontal+.
260
261 Now you move one of these terminals down (+$mod+Shift+k+ by default). The
262 workspace node’s orientation will be changed to +vertical+. The terminal window
263 you moved down is directly attached to the workspace and appears on the bottom
264 of the screen. A new (horizontal) container was created to accommodate the
265 other two terminal windows. You will notice this when switching to tabbed mode
266 (for example). You would end up having one tab with a representation of the split
267 container (e.g., "H[urxvt firefox]") and the other one being the terminal window
268 you moved down.
269
270 [[configuring]]
271 == Configuring i3
272
273 This is where the real fun begins ;-). Most things are very dependent on your
274 ideal working environment so we can’t make reasonable defaults for them.
275
276 While not using a programming language for the configuration, i3 stays
277 quite flexible in regards to the things you usually want your window manager
278 to do.
279
280 For example, you can configure bindings to jump to specific windows,
281 you can set specific applications to start on specific workspaces, you can
282 automatically start applications, you can change the colors of i3, and you
283 can bind your keys to do useful things.
284
285 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
286 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
287 with a text editor.
288
289 On first start (and on all following starts, unless you have a configuration
290 file), i3 will offer you to create a configuration file. You can tell the
291 wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config
292 file. Also, the created config file will use the key symbols of your current
293 keyboard layout. To start the wizard, use the command +i3-config-wizard+.
294 Please note that you must not have +~/.i3/config+, otherwise the wizard will
295 exit.
296
297 === Comments
298
299 It is possible and recommended to use comments in your configuration file to
300 properly document your setup for later reference. Comments are started with
301 a # and can only be used at the beginning of a line:
302
303 *Examples*:
304 -------------------
305 # This is a comment
306 -------------------
307
308 [[fonts]]
309
310 === Fonts
311
312 i3 has support for both X core fonts and FreeType fonts (through Pango) to
313 render window titles.
314
315 To generate an X core font description, you can use +xfontsel(1)+. To see
316 special characters (Unicode), you need to use a font which supports the
317 ISO-10646 encoding.
318
319 A FreeType font description is composed by a font family, a style, a weight,
320 a variant, a stretch and a size.
321 FreeType fonts support right-to-left rendering and contain often more
322 Unicode glyphs than X core fonts.
323
324 If i3 cannot open the configured font, it will output an error in the logfile
325 and fall back to a working font.
326
327 *Syntax*:
328 ------------------------------
329 font <X core font description>
330 font pango:<family list> [<style options>] <size>
331 ------------------------------
332
333 *Examples*:
334 --------------------------------------------------------------
335 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
336 font pango:DejaVu Sans Mono 10
337 font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
338 font pango:Terminus 11px
339 --------------------------------------------------------------
340
341 [[keybindings]]
342
343 === Keyboard bindings
344
345 A keyboard binding makes i3 execute a command (see below) upon pressing a
346 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
347 also mix your bindings, though i3 will not protect you from overlapping ones).
348
349 * A keysym (key symbol) is a description for a specific symbol, like "a"
350   or "b", but also more strange ones like "underscore" instead of "_". These
351   are the ones you use in Xmodmap to remap your keys. To get the current
352   mapping of your keys, use +xmodmap -pke+. To interactively enter a key and
353   see what keysym it is configured to, use +xev+.
354
355 * Keycodes do not need to have a symbol assigned (handy for custom vendor
356   hotkeys on some notebooks) and they will not change their meaning as you
357   switch to a different keyboard layout (when using +xmodmap+).
358
359 My recommendation is: If you often switch keyboard layouts but you want to keep
360 your bindings in the same physical location on the keyboard, use keycodes.
361 If you don’t switch layouts, and want a clean and simple config file, use
362 keysyms.
363
364 Some tools (such as +import+ or +xdotool+) might be unable to run upon a
365 KeyPress event, because the keyboard/pointer is still grabbed. For these
366 situations, the +--release+ flag can be used, which will execute the command
367 after the keys have been released.
368
369 *Syntax*:
370 ----------------------------------
371 bindsym [--release] [<Group>+][<Modifiers>+]<keysym> command
372 bindcode [--release] [<Group>+][<Modifiers>+]<keycode> command
373 ----------------------------------
374
375 *Examples*:
376 --------------------------------
377 # Fullscreen
378 bindsym $mod+f fullscreen toggle
379
380 # Restart
381 bindsym $mod+Shift+r restart
382
383 # Notebook-specific hotkeys
384 bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh
385
386 # Simulate ctrl+v upon pressing $mod+x
387 bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v
388
389 # Take a screenshot upon pressing $mod+x (select an area)
390 bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png
391 --------------------------------
392
393 Available Modifiers:
394
395 Mod1-Mod5, Shift, Control::
396 Standard modifiers, see +xmodmap(1)+
397
398 Group1, Group2, Group3, Group4::
399 When using multiple keyboard layouts (e.g. with `setxkbmap -layout us,ru`), you
400 can specify in which XKB group (also called “layout”) a keybinding should be
401 active. By default, keybindings are translated in Group1 and are active in all
402 groups. If you want to override keybindings in one of your layouts, specify the
403 corresponding group. For backwards compatibility, the group “Mode_switch” is an
404 alias for Group2.
405
406 [[mousebindings]]
407
408 === Mouse bindings
409
410 A mouse binding makes i3 execute a command upon pressing a specific mouse
411 button in the scope of the clicked container (see <<command_criteria>>). You
412 can configure mouse bindings in a similar way to key bindings.
413
414 *Syntax*:
415 -------------------------------------------------------------------------------
416 bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
417 -------------------------------------------------------------------------------
418
419 By default, the binding will only run when you click on the titlebar of the
420 window. If the +--release+ flag is given, it will run when the mouse button
421 is released.
422
423 If the +--whole-window+ flag is given, the binding will also run when any part
424 of the window is clicked, with the exception of the border. To have a bind run
425 when the border is clicked, specify the +--border+ flag.
426
427 *Examples*:
428 --------------------------------
429 # The middle button over a titlebar kills the window
430 bindsym --release button2 kill
431
432 # The middle button and a modifer over any part of the window kills the window
433 bindsym --whole-window $mod+button2 kill
434
435 # The right button toggles floating
436 bindsym button3 floating toggle
437 bindsym $mod+button3 floating toggle
438
439 # The side buttons move the window around
440 bindsym button9 move left
441 bindsym button8 move right
442 --------------------------------
443
444 [[floating_modifier]]
445
446 === The floating modifier
447
448 To move floating windows with your mouse, you can either grab their titlebar
449 or configure the so called floating modifier which you can then press and
450 click anywhere in the window itself to move it. The most common setup is to
451 use the same key you use for managing windows (Mod1 for example). Then
452 you can press Mod1, click into a window using your left mouse button, and drag
453 it to the position you want.
454
455 When holding the floating modifier, you can resize a floating window by
456 pressing the right mouse button on it and moving around while holding it. If
457 you hold the shift button as well, the resize will be proportional (the aspect
458 ratio will be preserved).
459
460 *Syntax*:
461 --------------------------------
462 floating_modifier <Modifier>
463 --------------------------------
464
465 *Example*:
466 --------------------------------
467 floating_modifier Mod1
468 --------------------------------
469
470 === Constraining floating window size
471
472 The maximum and minimum dimensions of floating windows can be specified. If
473 either dimension of +floating_maximum_size+ is specified as -1, that dimension
474 will be unconstrained with respect to its maximum value. If either dimension of
475 +floating_maximum_size+ is undefined, or specified as 0, i3 will use a default
476 value to constrain the maximum size. +floating_minimum_size+ is treated in a
477 manner analogous to +floating_maximum_size+.
478
479 *Syntax*:
480 ----------------------------------------
481 floating_minimum_size <width> x <height>
482 floating_maximum_size <width> x <height>
483 ----------------------------------------
484
485 *Example*:
486 --------------------------------------
487 floating_minimum_size 75 x 50
488 floating_maximum_size -1 x -1
489 --------------------------------------
490
491 === Orientation for new workspaces
492
493 New workspaces get a reasonable default orientation: Wide-screen monitors
494 (anything wider than high) get horizontal orientation, rotated monitors
495 (anything higher than wide) get vertical orientation.
496
497 With the +default_orientation+ configuration directive, you can override that
498 behavior.
499
500 *Syntax*:
501 --------------------------------------------
502 default_orientation horizontal|vertical|auto
503 --------------------------------------------
504
505 *Example*:
506 ----------------------------
507 default_orientation vertical
508 ----------------------------
509
510 === Layout mode for new containers
511
512 This option determines in which mode new containers on workspace level will
513 start.
514
515 *Syntax*:
516 ---------------------------------------------
517 workspace_layout default|stacking|tabbed
518 ---------------------------------------------
519
520 *Example*:
521 ---------------------
522 workspace_layout tabbed
523 ---------------------
524
525 === Border style for new windows
526
527 This option determines which border style new windows will have. The default is
528 +normal+. Note that new_float applies only to windows which are starting out as
529 floating windows, e.g., dialog windows, but not windows that are floated later on.
530
531 *Syntax*:
532 ---------------------------------------------
533 new_window normal|none|pixel
534 new_window normal|pixel <px>
535 new_float normal|none|pixel
536 new_float normal|pixel <px>
537 ---------------------------------------------
538
539 *Example*:
540 ---------------------
541 new_window pixel
542 ---------------------
543
544 The "normal" and "pixel" border styles support an optional border width in
545 pixels:
546
547 *Example*:
548 ---------------------
549 # The same as new_window none
550 new_window pixel 0
551
552 # A 3 px border
553 new_window pixel 3
554 ---------------------
555
556
557 === Hiding vertical borders
558
559 You can hide vertical borders adjacent to the screen edges using
560 +hide_edge_borders+. This is useful if you are using scrollbars, or do not want
561 to waste even two pixels in displayspace. Default is none.
562
563 *Syntax*:
564 -----------------------------------------------
565 hide_edge_borders none|vertical|horizontal|both
566 -----------------------------------------------
567
568 *Example*:
569 ----------------------
570 hide_edge_borders vertical
571 ----------------------
572
573 === Arbitrary commands for specific windows (for_window)
574
575 [[for_window]]
576
577 With the +for_window+ command, you can let i3 execute any command when it
578 encounters a specific window. This can be used to set windows to floating or to
579 change their border style, for example.
580
581 *Syntax*:
582 -------------------------------
583 for_window <criteria> <command>
584 -------------------------------
585
586 *Examples*:
587 ------------------------------------------------
588 # enable floating mode for all XTerm windows
589 for_window [class="XTerm"] floating enable
590
591 # Make all urxvts use a 1-pixel border:
592 for_window [class="urxvt"] border pixel 1
593
594 # A less useful, but rather funny example:
595 # makes the window floating as soon as I change
596 # directory to ~/work
597 for_window [title="x200: ~/work"] floating enable
598 ------------------------------------------------
599
600 The valid criteria are the same as those for commands, see <<command_criteria>>.
601
602 === Don't focus window upon opening
603
604 [[no_focus]]
605
606 When a new window appears, it will be focused. The +no_focus+ directive allows preventing
607 this from happening and must be used in combination with <<command_criteria>>.
608
609 Note that this does not apply to all cases, e.g., when feeding data into a running application
610 causing it to request being focused. To configure the behavior in such cases, refer to
611 <<focus_on_window_activation>>.
612
613 +no_focus+ will also be ignored for the first window on a workspace as there shouldn't be
614 a reason to not focus the window in this case. This allows for better usability in
615 combination with +workspace_layout+.
616
617 *Syntax*:
618 -------------------
619 no_focus <criteria>
620 -------------------
621
622 *Example*:
623 -------------------------------
624 no_focus [window_role="pop-up"]
625 -------------------------------
626
627 === Variables
628
629 As you learned in the section about keyboard bindings, you will have
630 to configure lots of bindings containing modifier keys. If you want to save
631 yourself some typing and be able to change the modifier you use later,
632 variables can be handy.
633
634 *Syntax*:
635 -------------------
636 set $<name> <value>
637 -------------------
638
639 *Example*:
640 ------------------------
641 set $m Mod1
642 bindsym $m+Shift+r restart
643 ------------------------
644
645 Variables are directly replaced in the file when parsing. Variables expansion
646 is not recursive so it is not possible to define a variable with a value
647 containing another variable. There is no fancy handling and there are
648 absolutely no plans to change this. If you need a more dynamic configuration
649 you should create a little script which generates a configuration file and run
650 it before starting i3 (for example in your +~/.xsession+ file).
651
652 === Automatically putting clients on specific workspaces
653
654 [[assign_workspace]]
655
656 To automatically make a specific window show up on a specific workspace, you
657 can use an *assignment*. You can match windows by using any criteria,
658 see <<command_criteria>>. It is recommended that you match on window classes
659 (and instances, when appropriate) instead of window titles whenever possible
660 because some applications first create their window, and then worry about
661 setting the correct title. Firefox with Vimperator comes to mind. The window
662 starts up being named Firefox, and only when Vimperator is loaded does the
663 title change. As i3 will get the title as soon as the application maps the
664 window (mapping means actually displaying it on the screen), you’d need to have
665 to match on 'Firefox' in this case.
666
667 Assignments are processed by i3 in the order in which they appear in the config
668 file. The first one which matches the window wins and later assignments are not
669 considered.
670
671 *Syntax*:
672 ------------------------------------------------------------
673 assign <criteria> [→] [workspace] <workspace>
674 ------------------------------------------------------------
675
676 *Examples*:
677 ----------------------
678 # Assign URxvt terminals to workspace 2
679 assign [class="URxvt"] 2
680
681 # Same thing, but more precise (exact match instead of substring)
682 assign [class="^URxvt$"] 2
683
684 # Same thing, but with a beautiful arrow :)
685 assign [class="^URxvt$"] → 2
686
687 # Assignment to a named workspace
688 assign [class="^URxvt$"] → work
689
690 # Start urxvt -name irssi
691 assign [class="^URxvt$" instance="^irssi$"] → 3
692 ----------------------
693
694 Note that the arrow is not required, it just looks good :-). If you decide to
695 use it, it has to be a UTF-8 encoded arrow, not `->` or something like that.
696
697 To get the class and instance, you can use +xprop+. After clicking on the
698 window, you will see the following output:
699
700 *xprop*:
701 -----------------------------------
702 WM_CLASS(STRING) = "irssi", "URxvt"
703 -----------------------------------
704
705 The first part of the WM_CLASS is the instance ("irssi" in this example), the
706 second part is the class ("URxvt" in this example).
707
708 Should you have any problems with assignments, make sure to check the i3
709 logfile first (see http://i3wm.org/docs/debugging.html). It includes more
710 details about the matching process and the window’s actual class, instance and
711 title when starting up.
712
713 Note that if you want to start an application just once on a specific
714 workspace, but you don’t want to assign all instances of it permanently, you
715 can make use of i3’s startup-notification support (see <<exec>>) in your config
716 file in the following way:
717
718 *Start iceweasel on workspace 3 (once)*:
719 -------------------------------------------------------------------------------
720 # Start iceweasel on workspace 3, then switch back to workspace 1
721 # (Being a command-line utility, i3-msg does not support startup notifications,
722 #  hence the exec --no-startup-id.)
723 # (Starting iceweasel with i3’s exec command is important in order to make i3
724 #  create a startup notification context, without which the iceweasel window(s)
725 #  cannot be matched onto the workspace on which the command was started.)
726 exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
727 -------------------------------------------------------------------------------
728
729 === Automatically starting applications on i3 startup
730
731 By using the +exec+ keyword outside a keybinding, you can configure
732 which commands will be performed by i3 on initial startup. +exec+
733 commands will not run when restarting i3, if you need a command to run
734 also when restarting i3 you should use the +exec_always+
735 keyword. These commands will be run in order.
736
737 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
738 and +,+ (comma): they chain commands together in i3, so you need to use quoted
739 strings if they appear in your command.
740
741 *Syntax*:
742 ---------------------------------------
743 exec [--no-startup-id] <command>
744 exec_always [--no-startup-id] <command>
745 ---------------------------------------
746
747 *Examples*:
748 --------------------------------
749 exec chromium
750 exec_always ~/my_script.sh
751
752 # Execute the terminal emulator urxvt, which is not yet startup-notification aware.
753 exec --no-startup-id urxvt
754 --------------------------------
755
756 The flag --no-startup-id is explained in <<exec>>.
757
758 [[workspace_screen]]
759
760 === Automatically putting workspaces on specific screens
761
762 If you assign clients to workspaces, it might be handy to put the
763 workspaces on specific screens. Also, the assignment of workspaces to screens
764 will determine which workspace i3 uses for a new screen when adding screens
765 or when starting (e.g., by default it will use 1 for the first screen, 2 for
766 the second screen and so on).
767
768 *Syntax*:
769 -------------------------------------
770 workspace <workspace> output <output>
771 -------------------------------------
772
773 The 'output' is the name of the RandR output you attach your screen to. On a
774 laptop, you might have VGA1 and LVDS1 as output names. You can see the
775 available outputs by running +xrandr --current+.
776
777 If you use named workspaces, they must be quoted:
778
779 *Examples*:
780 ---------------------------
781 workspace 1 output LVDS1
782 workspace 5 output VGA1
783 workspace "2: vim" output VGA1
784 ---------------------------
785
786 === Changing colors
787
788 You can change all colors which i3 uses to draw the window decorations.
789
790 *Syntax*:
791 ------------------------------------------------------
792 <colorclass> <border> <background> <text> <indicator>
793 ------------------------------------------------------
794
795 Where colorclass can be one of:
796
797 client.focused::
798         A client which currently has the focus.
799 client.focused_inactive::
800         A client which is the focused one of its container, but it does not have
801         the focus at the moment.
802 client.unfocused::
803         A client which is not the focused one of its container.
804 client.urgent::
805         A client which has its urgency hint activated.
806 client.placeholder::
807         Background and text color are used to draw placeholder window contents
808         (when restoring layouts). Border and indicator are ignored.
809 client.background::
810         Background color which will be used to paint the background of the
811         client window on top of which the client will be rendered. Only clients
812         which do not cover the whole area of this window expose the color. Note
813         that this colorclass only takes a single color.
814
815 Colors are in HTML hex format (#rrggbb), see the following example:
816
817 *Examples (default colors)*:
818 ---------------------------------------------------------
819 # class                 border  backgr. text    indicator
820 client.focused          #4c7899 #285577 #ffffff #2e9ef4
821 client.focused_inactive #333333 #5f676a #ffffff #484e50
822 client.unfocused        #333333 #222222 #888888 #292d2e
823 client.urgent           #2f343a #900000 #ffffff #900000
824 client.placeholder      #000000 #0c0c0c #ffffff #000000
825
826 client.background       #ffffff
827 ---------------------------------------------------------
828
829 Note that for the window decorations, the color around the child window is the
830 background color, and the border color is only the two thin lines at the top of
831 the window.
832
833 The indicator color is used for indicating where a new window will be opened.
834 For horizontal split containers, the right border will be painted in indicator
835 color, for vertical split containers, the bottom border. This only applies to
836 single windows within a split container, which are otherwise indistinguishable
837 from single windows outside of a split container.
838
839 === Interprocess communication
840
841 i3 uses Unix sockets to provide an IPC interface. This allows third-party
842 programs to get information from i3, such as the current workspaces
843 (to display a workspace bar), and to control i3.
844
845 The IPC socket is enabled by default and will be created in
846 +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
847 the PID of i3 and XXXXXX is a string of random characters from the portable
848 filename character set (see mkdtemp(3)).
849
850 You can override the default path through the environment-variable +I3SOCK+ or
851 by specifying the +ipc-socket+ directive. This is discouraged, though, since i3
852 does the right thing by default. If you decide to change it, it is strongly
853 recommended to set this to a location in your home directory so that no other
854 user can create that directory.
855
856 *Examples*:
857 ----------------------------
858 ipc-socket ~/.i3/i3-ipc.sock
859 ----------------------------
860
861 You can then use the +i3-msg+ application to perform any command listed in
862 the next section.
863
864 === Focus follows mouse
865
866 By default, window focus follows your mouse movements. However, if you have a
867 setup where your mouse usually is in your way (like a touchpad on your laptop
868 which you do not want to disable completely), you might want to disable 'focus
869 follows mouse' and control focus only by using your keyboard.  The mouse will
870 still be useful inside the currently active window (for example to click on
871 links in your browser window).
872
873 *Syntax*:
874 --------------------------
875 focus_follows_mouse yes|no
876 --------------------------
877
878 *Example*:
879 ----------------------
880 focus_follows_mouse no
881 ----------------------
882
883 === Mouse warping
884
885 By default, when switching focus to a window on a different output (e.g.
886 focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on
887 LVDS-1), the mouse cursor is warped to the center of that window.
888
889 With the +mouse_warping+ option, you can control when the mouse cursor should
890 be warped. +none+ disables warping entirely, whereas +output+ is the default
891 behavior described above.
892
893 *Syntax*:
894 -------------------------
895 mouse_warping output|none
896 -------------------------
897
898 *Example*:
899 ------------------
900 mouse_warping none
901 ------------------
902
903 === Popups during fullscreen mode
904
905 When you are in fullscreen mode, some applications still open popup windows
906 (take Xpdf for example). This is because these applications may not be aware
907 that they are in fullscreen mode (they do not check the corresponding hint).
908 There are three things which are possible to do in this situation:
909
910 1. Display the popup if it belongs to the fullscreen application only. This is
911    the default and should be reasonable behavior for most users.
912 2. Just ignore the popup (don’t map it). This won’t interrupt you while you are
913    in fullscreen. However, some apps might react badly to this (deadlock until
914    you go out of fullscreen).
915 3. Leave fullscreen mode.
916
917 *Syntax*:
918 -----------------------------------------------------
919 popup_during_fullscreen smart|ignore|leave_fullscreen
920 -----------------------------------------------------
921
922 *Example*:
923 ------------------------------
924 popup_during_fullscreen smart
925 ------------------------------
926
927 === Focus wrapping
928
929 When being in a tabbed or stacked container, the first container will be
930 focused when you use +focus down+ on the last container -- the focus wraps. If
931 however there is another stacked/tabbed container in that direction, focus will
932 be set on that container. This is the default behavior so you can navigate to
933 all your windows without having to use +focus parent+.
934
935 If you want the focus to *always* wrap and you are aware of using +focus
936 parent+ to switch to different containers, you can use the
937 +force_focus_wrapping+ configuration directive. After enabling it, the focus
938 will always wrap.
939
940 *Syntax*:
941 ---------------------------
942 force_focus_wrapping yes|no
943 ---------------------------
944
945 *Example*:
946 ------------------------
947 force_focus_wrapping yes
948 ------------------------
949
950 === Forcing Xinerama
951
952 As explained in-depth in <http://i3wm.org/docs/multi-monitor.html>, some X11
953 video drivers (especially the nVidia binary driver) only provide support for
954 Xinerama instead of RandR. In such a situation, i3 must be told to use the
955 inferior Xinerama API explicitly and therefore don’t provide support for
956 reconfiguring your screens on the fly (they are read only once on startup and
957 that’s it).
958
959 For people who cannot modify their +~/.xsession+ to add the
960 +--force-xinerama+ commandline parameter, a configuration option is provided:
961
962 *Syntax*:
963 ---------------------
964 force_xinerama yes|no
965 ---------------------
966
967 *Example*:
968 ------------------
969 force_xinerama yes
970 ------------------
971
972 Also note that your output names are not descriptive (like +HDMI1+) when using
973 Xinerama, instead they are counted up, starting at 0: +xinerama-0+, +xinerama-1+, …
974
975 === Automatic back-and-forth when switching to the current workspace
976
977 This configuration directive enables automatic +workspace back_and_forth+ (see
978 <<back_and_forth>>) when switching to the workspace that is currently focused.
979
980 For instance: Assume you are on workspace "1: www" and switch to "2: IM" using
981 mod+2 because somebody sent you a message. You don’t need to remember where you
982 came from now, you can just press $mod+2 again to switch back to "1: www".
983
984 *Syntax*:
985 ------------------------------------
986 workspace_auto_back_and_forth yes|no
987 ------------------------------------
988
989 *Example*:
990 ---------------------------------
991 workspace_auto_back_and_forth yes
992 ---------------------------------
993
994 === Delaying urgency hint reset on workspace change
995
996 If an application on another workspace sets an urgency hint, switching to this
997 workspace may lead to immediate focus of the application, which also means the
998 window decoration color would be immediately reset to +client.focused+. This
999 may make it unnecessarily hard to tell which window originally raised the
1000 event.
1001
1002 In order to prevent this, you can tell i3 to delay resetting the urgency state
1003 by a certain time using the +force_display_urgency_hint+ directive. Setting the
1004 value to 0 disables this feature.
1005
1006 The default is 500ms.
1007
1008 *Syntax*:
1009 ---------------------------------------
1010 force_display_urgency_hint <timeout> ms
1011 ---------------------------------------
1012
1013 *Example*:
1014 ---------------------------------
1015 force_display_urgency_hint 500 ms
1016 ---------------------------------
1017
1018 === Focus on window activation
1019
1020 [[focus_on_window_activation]]
1021
1022 If a window is activated, e.g., via +google-chrome www.google.com+, it may request
1023 to take focus. Since this may not preferable, different reactions can be configured.
1024
1025 Note that this may not affect windows that are being opened. To prevent new windows
1026 from being focused, see <<no_focus>>.
1027
1028 *Syntax*:
1029 --------------------------------------------------
1030 focus_on_window_activation smart|urgent|focus|none
1031 --------------------------------------------------
1032
1033 The different modes will act as follows:
1034
1035 smart::
1036     This is the default behavior. If the window requesting focus is on an active
1037     workspace, it will receive the focus. Otherwise, the urgency hint will be set.
1038 urgent::
1039     The window will always be marked urgent, but the focus will not be stolen.
1040 focus::
1041     The window will always be focused and not be marked urgent.
1042 none::
1043     The window will neither be focused, nor be marked urgent.
1044
1045 === Drawing marks on window decoration
1046
1047 If activated, marks on windows are drawn in their window decoration. However,
1048 any mark starting with an underscore in its name (+_+) will not be drawn even if
1049 this option is activated.
1050
1051 The default for this option is +yes+.
1052
1053 *Syntax*:
1054 -----------------
1055 show_marks yes|no
1056 -----------------
1057
1058 *Example*:
1059 --------------
1060 show_marks yes
1061 --------------
1062
1063 [[line_continuation]]
1064
1065 === Line continuation
1066
1067 Config files support line continuation, meaning when you end a line in a
1068 backslash character (`\`), the line-break will be ignored by the parser. This
1069 feature can be used to create more readable configuration files.
1070
1071 *Examples*:
1072 -------------------
1073 bindsym Mod1+f \
1074 fullscreen toggle
1075 -------------------
1076
1077 == Configuring i3bar
1078
1079 The bar at the bottom of your monitor is drawn by a separate process called
1080 i3bar. Having this part of "the i3 user interface" in a separate process has
1081 several advantages:
1082
1083 1. It is a modular approach. If you don’t need a workspace bar at all, or if
1084    you prefer a different one (dzen2, xmobar, maybe even gnome-panel?), you can
1085    just remove the i3bar configuration and start your favorite bar instead.
1086 2. It follows the UNIX philosophy of "Make each program do one thing well".
1087    While i3 manages your windows well, i3bar is good at displaying a bar on
1088    each monitor (unless you configure it otherwise).
1089 3. It leads to two separate, clean codebases. If you want to understand i3, you
1090    don’t need to bother with the details of i3bar and vice versa.
1091
1092 That said, i3bar is configured in the same configuration file as i3. This is
1093 because it is tightly coupled with i3 (in contrary to i3lock or i3status which
1094 are useful for people using other window managers). Therefore, it makes no
1095 sense to use a different configuration place when we already have a good
1096 configuration infrastructure in place.
1097
1098 Configuring your workspace bar starts with opening a +bar+ block. You can have
1099 multiple bar blocks to use different settings for different outputs (monitors):
1100
1101 *Example*:
1102 ---------------------------
1103 bar {
1104     status_command i3status
1105 }
1106 ---------------------------
1107
1108 === i3bar command
1109
1110 By default i3 will just pass +i3bar+ and let your shell handle the execution,
1111 searching your +$PATH+ for a correct version.
1112 If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
1113 tell i3 what to execute.
1114
1115 The specified command will be passed to +sh -c+, so you can use globbing and
1116 have to have correct quoting etc.
1117
1118 *Syntax*:
1119 -----------------------
1120 i3bar_command <command>
1121 -----------------------
1122
1123 *Example*:
1124 -------------------------------------------------
1125 bar {
1126     i3bar_command /home/user/bin/i3bar
1127 }
1128 -------------------------------------------------
1129
1130 [[status_command]]
1131 === Statusline command
1132
1133 i3bar can run a program and display every line of its +stdout+ output on the
1134 right hand side of the bar. This is useful to display system information like
1135 your current IP address, battery status or date/time.
1136
1137 The specified command will be passed to +sh -c+, so you can use globbing and
1138 have to have correct quoting etc. Note that for signal handling, depending on
1139 your shell (users of dash(1) are known to be affected), you have to use the
1140 shell’s exec command so that signals are passed to your program, not to the
1141 shell.
1142
1143 *Syntax*:
1144 ------------------------
1145 status_command <command>
1146 ------------------------
1147
1148 *Example*:
1149 -------------------------------------------------
1150 bar {
1151     status_command i3status --config ~/.i3status.conf
1152
1153     # For dash(1) users who want signal handling to work:
1154     status_command exec ~/.bin/my_status_command
1155 }
1156 -------------------------------------------------
1157
1158 === Display mode
1159
1160 You can either have i3bar be visible permanently at one edge of the screen
1161 (+dock+ mode) or make it show up when you press your modifier key (+hide+ mode).
1162 It is also possible to force i3bar to always stay hidden (+invisible+
1163 mode). The modifier key can be configured using the +modifier+ option.
1164
1165 The mode option can be changed during runtime through the +bar mode+ command.
1166 On reload the mode will be reverted to its configured value.
1167
1168 The hide mode maximizes screen space that can be used for actual windows. Also,
1169 i3bar sends the +SIGSTOP+ and +SIGCONT+ signals to the statusline process to
1170 save battery power.
1171
1172 Invisible mode allows to permanently maximize screen space, as the bar is never
1173 shown. Thus, you can configure i3bar to not disturb you by popping up because
1174 of an urgency hint or because the modifier key is pressed.
1175
1176 In order to control whether i3bar is hidden or shown in hide mode, there exists
1177 the hidden_state option, which has no effect in dock mode or invisible mode. It
1178 indicates the current hidden_state of the bar: (1) The bar acts like in normal
1179 hide mode, it is hidden and is only unhidden in case of urgency hints or by
1180 pressing the modifier key (+hide+ state), or (2) it is drawn on top of the
1181 currently visible workspace (+show+ state).
1182
1183 Like the mode, the hidden_state can also be controlled through i3, this can be
1184 done by using the +bar hidden_state+ command.
1185
1186 The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually
1187 the windows key). The default value for the hidden_state is hide.
1188
1189 *Syntax*:
1190 -------------------------
1191 mode dock|hide|invisible
1192 hidden_state hide|show
1193 modifier <Modifier>
1194 ------------------------
1195
1196 *Example*:
1197 ----------------
1198 bar {
1199     mode hide
1200     hidden_state hide
1201     modifier Mod1
1202 }
1203 ----------------
1204
1205 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
1206
1207 === Mouse button commands
1208
1209 Specifies a command to run when a button was pressed on i3bar to override the
1210 default behavior. This is useful, e.g., for disabling the scroll wheel action
1211 or running scripts that implement custom behavior for these buttons.
1212
1213 A button is always named +button<n>+, where 1 to 5 are default buttons as follows and higher
1214 numbers can be special buttons on devices offering more buttons:
1215
1216 button1::
1217     Left mouse button.
1218 button2::
1219     Middle mouse button.
1220 button3::
1221     Right mouse button.
1222 button4::
1223     Scroll wheel up.
1224 button5::
1225     Scroll wheel down.
1226
1227 Please note that the old +wheel_up_cmd+ and +wheel_down_cmd+ commands are deprecated
1228 and will be removed in a future release. We strongly recommend using the more general
1229 +bindsym+ with +button4+ and +button5+ instead.
1230
1231 *Syntax*:
1232 ----------------------------
1233 bindsym button<n> <command>
1234 ----------------------------
1235
1236 *Example*:
1237 ---------------------------------------------------------
1238 bar {
1239     # disable clicking on workspace buttons
1240     bindsym button1 nop
1241     # execute custom script when scrolling downwards
1242     bindsym button5 exec ~/.i3/scripts/custom_wheel_down
1243 }
1244 ---------------------------------------------------------
1245
1246 === Bar ID
1247
1248 Specifies the bar ID for the configured bar instance. If this option is missing,
1249 the ID is set to 'bar-x', where x corresponds to the position of the embedding
1250 bar block in the config file ('bar-0', 'bar-1', ...).
1251
1252 *Syntax*:
1253 ---------------------
1254 id <bar_id>
1255 ---------------------
1256
1257 *Example*:
1258 ---------------------
1259 bar {
1260     id bar-1
1261 }
1262 ---------------------
1263
1264 [[i3bar_position]]
1265 === Position
1266
1267 This option determines in which edge of the screen i3bar should show up.
1268
1269 The default is bottom.
1270
1271 *Syntax*:
1272 -------------------
1273 position top|bottom
1274 -------------------
1275
1276 *Example*:
1277 ---------------------
1278 bar {
1279     position top
1280 }
1281 ---------------------
1282
1283 === Output(s)
1284
1285 You can restrict i3bar to one or more outputs (monitors). The default is to
1286 handle all outputs. Restricting the outputs is useful for using different
1287 options for different outputs by using multiple 'bar' blocks.
1288
1289 To make a particular i3bar instance handle multiple outputs, specify the output
1290 directive multiple times.
1291
1292 *Syntax*:
1293 ---------------
1294 output <output>
1295 ---------------
1296
1297 *Example*:
1298 -------------------------------
1299 # big monitor: everything
1300 bar {
1301     # The display is connected either via HDMI or via DisplayPort
1302     output HDMI2
1303     output DP2
1304     status_command i3status
1305 }
1306
1307 # laptop monitor: bright colors and i3status with less modules.
1308 bar {
1309     output LVDS1
1310     status_command i3status --config ~/.i3status-small.conf
1311     colors {
1312         background #000000
1313         statusline #ffffff
1314     }
1315 }
1316 -------------------------------
1317
1318 === Tray output
1319
1320 i3bar by default provides a system tray area where programs such as
1321 NetworkManager, VLC, Pidgin, etc. can place little icons.
1322
1323 You can configure on which output (monitor) the icons should be displayed or
1324 you can turn off the functionality entirely.
1325
1326 *Syntax*:
1327 ---------------------------------
1328 tray_output none|primary|<output>
1329 ---------------------------------
1330
1331 *Example*:
1332 -------------------------
1333 # disable system tray
1334 bar {
1335     tray_output none
1336 }
1337
1338 # show tray icons on the primary monitor
1339 bar {
1340     tray_output primary
1341 }
1342
1343 # show tray icons on the big monitor
1344 bar {
1345     tray_output HDMI2
1346 }
1347 -------------------------
1348
1349 Note that you might not have a primary output configured yet. To do so, run:
1350 -------------------------
1351 xrandr --output <output> --primary
1352 -------------------------
1353
1354 Note that when you use multiple bar configuration blocks, either specify
1355 `tray_output primary` in all of them or explicitly specify `tray_output none`
1356 in bars which should not display the tray, otherwise the different instances
1357 might race each other in trying to display tray icons.
1358
1359 === Tray padding
1360
1361 The tray is shown on the right-hand side of the bar. By default, a padding of 2
1362 pixels is used for the upper, lower and right-hand side of the tray area and
1363 between the individual icons.
1364
1365 *Syntax*:
1366 -------------------------
1367 tray_padding <px> [px]
1368 -------------------------
1369
1370 *Example*:
1371 -------------------------
1372 # Obey Fitts's law
1373 tray_padding 0
1374 -------------------------
1375
1376 === Font
1377
1378 Specifies the font to be used in the bar. See <<fonts>>.
1379
1380 *Syntax*:
1381 ---------------------
1382 font <font>
1383 ---------------------
1384
1385 *Example*:
1386 --------------------------------------------------------------
1387 bar {
1388     font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
1389     font pango:DejaVu Sans Mono 10
1390 }
1391 --------------------------------------------------------------
1392
1393 === Custom separator symbol
1394
1395 Specifies a custom symbol to be used for the separator as opposed to the vertical,
1396 one pixel thick separator.
1397
1398 *Syntax*:
1399 -------------------------
1400 separator_symbol <symbol>
1401 -------------------------
1402
1403 *Example*:
1404 ------------------------
1405 bar {
1406     separator_symbol ":|:"
1407 }
1408 ------------------------
1409
1410 === Workspace buttons
1411
1412 Specifies whether workspace buttons should be shown or not. This is useful if
1413 you want to display a statusline-only bar containing additional information.
1414
1415 The default is to show workspace buttons.
1416
1417 *Syntax*:
1418 ------------------------
1419 workspace_buttons yes|no
1420 ------------------------
1421
1422 *Example*:
1423 ------------------------
1424 bar {
1425     workspace_buttons no
1426 }
1427 ------------------------
1428
1429 === Strip workspace numbers
1430
1431 Specifies whether workspace numbers should be displayed within the workspace
1432 buttons. This is useful if you want to have a named workspace that stays in
1433 order on the bar according to its number without displaying the number prefix.
1434
1435 When +strip_workspace_numbers+ is set to +yes+, any workspace that has a name of
1436 the form "[n]:[NAME]" will display only the name. You could use this, for
1437 instance, to display Roman numerals rather than digits by naming your
1438 workspaces to "1:I", "2:II", "3:III", "4:IV", ...
1439
1440 The default is to display the full name within the workspace button.
1441
1442 *Syntax*:
1443 ------------------------------
1444 strip_workspace_numbers yes|no
1445 ------------------------------
1446
1447 *Example*:
1448 ----------------------------
1449 bar {
1450     strip_workspace_numbers yes
1451 }
1452 ----------------------------
1453
1454 === Binding Mode indicator
1455
1456 Specifies whether the current binding mode indicator should be shown or not.
1457 This is useful if you want to hide the workspace buttons but still be able
1458 to see the current binding mode indicator.
1459 For an example of a +mode+ definition, see <<resizingconfig>>.
1460
1461 The default is to show the mode indicator.
1462
1463 *Syntax*:
1464 -----------------------------
1465 binding_mode_indicator yes|no
1466 -----------------------------
1467
1468 *Example*:
1469 -----------------------------
1470 bar {
1471     binding_mode_indicator no
1472 }
1473 -----------------------------
1474
1475 === Colors
1476
1477 As with i3, colors are in HTML hex format (#rrggbb). The following colors can
1478 be configured at the moment:
1479
1480 background::
1481         Background color of the bar.
1482 statusline::
1483         Text color to be used for the statusline.
1484 separator::
1485         Text color to be used for the separator.
1486 focused_workspace::
1487         Border, background and text color for a workspace button when the workspace
1488         has focus.
1489 active_workspace::
1490         Border, background and text color for a workspace button when the workspace
1491         is active (visible) on some output, but the focus is on another one.
1492         You can only tell this apart from the focused workspace when you are
1493         using multiple monitors.
1494 inactive_workspace::
1495         Border, background and text color for a workspace button when the workspace
1496         does not have focus and is not active (visible) on any output. This
1497         will be the case for most workspaces.
1498 urgent_workspace::
1499         Border, background and text color for a workspace button when the workspace
1500         contains a window with the urgency hint set.
1501 binding_mode::
1502         Border, background and text color for the binding mode indicator. If not used,
1503         the colors will be taken from +urgent_workspace+.
1504
1505 *Syntax*:
1506 ----------------------------------------
1507 colors {
1508     background <color>
1509     statusline <color>
1510     separator <color>
1511
1512     <colorclass> <border> <background> <text>
1513 }
1514 ----------------------------------------
1515
1516 *Example (default colors)*:
1517 --------------------------------------
1518 bar {
1519     colors {
1520         background #000000
1521         statusline #ffffff
1522         separator #666666
1523
1524         focused_workspace  #4c7899 #285577 #ffffff
1525         active_workspace   #333333 #5f676a #ffffff
1526         inactive_workspace #333333 #222222 #888888
1527         urgent_workspace   #2f343a #900000 #ffffff
1528         binding_mode       #2f343a #900000 #ffffff
1529     }
1530 }
1531 --------------------------------------
1532
1533 == List of commands
1534
1535 Commands are what you bind to specific keypresses. You can also issue commands
1536 at runtime without pressing a key by using the IPC interface. An easy way to
1537 do this is to use the +i3-msg+ utility:
1538
1539 *Example*:
1540 --------------------------
1541 # execute this on your shell to make the current container borderless
1542 i3-msg border none
1543 --------------------------
1544
1545 [[command_chaining]]
1546
1547 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
1548 specific workspace and immediately switch to that workspace, you can configure
1549 the following keybinding:
1550
1551 *Example*:
1552 --------------------------------------------------------
1553 bindsym $mod+x move container to workspace 3; workspace 3
1554 --------------------------------------------------------
1555
1556 [[command_criteria]]
1557
1558 Furthermore, you can change the scope of a command - that is, which containers
1559 should be affected by that command, by using various criteria. The criteria
1560 are specified before any command in a pair of square brackets and are separated
1561 by space.
1562
1563 When using multiple commands, separate them by using a +,+ (a comma) instead of
1564 a semicolon. Criteria apply only until the next semicolon, so if you use a
1565 semicolon to separate commands, only the first one will be executed for the
1566 matched window(s).
1567
1568 *Example*:
1569 ------------------------------------
1570 # if you want to kill all windows which have the class Firefox, use:
1571 bindsym $mod+x [class="Firefox"] kill
1572
1573 # same thing, but case-insensitive
1574 bindsym $mod+x [class="(?i)firefox"] kill
1575
1576 # kill only the About dialog from Firefox
1577 bindsym $mod+x [class="Firefox" window_role="About"] kill
1578
1579 # enable floating mode and move container to workspace 4
1580 for_window [class="^evil-app$"] floating enable, move container to workspace 4
1581 ------------------------------------
1582
1583 The criteria which are currently implemented are:
1584
1585 class::
1586         Compares the window class (the second part of WM_CLASS). Use the
1587         special value +__focused__+ to match all windows having the same window
1588         class as the currently focused window.
1589 instance::
1590         Compares the window instance (the first part of WM_CLASS). Use the
1591         special value +__focused__+ to match all windows having the same window
1592         instance as the currently focused window.
1593 window_role::
1594         Compares the window role (WM_WINDOW_ROLE). Use the special value
1595         +__focused__+ to match all windows having the same window role as the
1596         currently focused window.
1597 window_type::
1598         Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
1599         +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+,
1600         +popup_menu+ and +tooltip+.
1601 id::
1602         Compares the X11 window ID, which you can get via +xwininfo+ for example.
1603 title::
1604         Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).
1605         Use the special value +__focused__+ to match all windows having the
1606         same window title as the currently focused window.
1607 urgent::
1608         Compares the urgent state of the window. Can be "latest" or "oldest".
1609         Matches the latest or oldest urgent window, respectively.
1610         (The following aliases are also available: newest, last, recent, first)
1611 workspace::
1612         Compares the workspace name of the workspace the window belongs to. Use
1613         the special value +__focused__+ to match all windows in the currently
1614         focused workspace.
1615 con_mark::
1616         Compares the mark set for this container, see <<vim_like_marks>>.
1617 con_id::
1618         Compares the i3-internal container ID, which you can get via the IPC
1619         interface. Handy for scripting.
1620
1621 The criteria +class+, +instance+, +role+, +title+, +workspace+ and +mark+ are
1622 actually regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
1623 information on how to use them.
1624
1625 [[exec]]
1626
1627 === Executing applications (exec)
1628
1629 What good is a window manager if you can’t actually start any applications?
1630 The exec command starts an application by passing the command you specify to a
1631 shell. This implies that you can use globbing (wildcards) and programs will be
1632 searched in your +$PATH+.
1633
1634 See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
1635 and +,+ (comma): they chain commands together in i3, so you need to use quoted
1636 strings if they appear in your command.
1637
1638 *Syntax*:
1639 --------------------------------
1640 exec [--no-startup-id] <command>
1641 --------------------------------
1642
1643 *Example*:
1644 ------------------------------
1645 # Start the GIMP
1646 bindsym $mod+g exec gimp
1647
1648 # Start the terminal emulator urxvt which is not yet startup-notification-aware
1649 bindsym $mod+Return exec --no-startup-id urxvt
1650 ------------------------------
1651
1652 The +--no-startup-id+ parameter disables startup-notification support for this
1653 particular exec command. With startup-notification, i3 can make sure that a
1654 window appears on the workspace on which you used the exec command. Also, it
1655 will change the X11 cursor to +watch+ (a clock) while the application is
1656 launching. So, if an application is not startup-notification aware (most GTK
1657 and Qt using applications seem to be, though), you will end up with a watch
1658 cursor for 60 seconds.
1659
1660 === Splitting containers
1661
1662 The split command makes the current window a split container. Split containers
1663 can contain multiple windows. Depending on the layout of the split container,
1664 new windows get placed to the right of the current one (splith) or new windows
1665 get placed below the current one (splitv).
1666
1667 If you apply this command to a split container with the same orientation,
1668 nothing will happen. If you use a different orientation, the split container’s
1669 orientation will be changed (if it does not have more than one window). Use
1670 +layout toggle split+ to change the layout of any split container from splitv
1671 to splith or vice-versa.
1672
1673 *Syntax*:
1674 -------------------------
1675 split vertical|horizontal
1676 -------------------------
1677
1678 *Example*:
1679 ------------------------------
1680 bindsym $mod+v split vertical
1681 bindsym $mod+h split horizontal
1682 ------------------------------
1683
1684 === Manipulating layout
1685
1686 Use +layout toggle split+, +layout stacking+, +layout tabbed+, +layout splitv+
1687 or +layout splith+ to change the current container layout to splith/splitv,
1688 stacking, tabbed layout, splitv or splith, respectively.
1689
1690 To make the current window (!) fullscreen, use +fullscreen enable+ (or
1691 +fullscreen enable global+ for the global mode), to leave either fullscreen
1692 mode use +fullscreen disable+, and to toggle between these two states use
1693 +fullscreen toggle+ (or +fullscreen toggle global+).
1694
1695 Likewise, to make the current window floating (or tiling again) use +floating
1696 enable+ respectively +floating disable+ (or +floating toggle+):
1697
1698 *Syntax*:
1699 --------------------------------------------
1700 layout default|tabbed|stacking|splitv|splith
1701 layout toggle [split|all]
1702 --------------------------------------------
1703
1704 *Examples*:
1705 --------------
1706 bindsym $mod+s layout stacking
1707 bindsym $mod+l layout toggle split
1708 bindsym $mod+w layout tabbed
1709
1710 # Toggle between stacking/tabbed/split:
1711 bindsym $mod+x layout toggle
1712
1713 # Toggle between stacking/tabbed/splith/splitv:
1714 bindsym $mod+x layout toggle all
1715
1716 # Toggle fullscreen
1717 bindsym $mod+f fullscreen toggle
1718
1719 # Toggle floating/tiling
1720 bindsym $mod+t floating toggle
1721 --------------
1722
1723 [[_focusing_moving_containers]]
1724
1725 === Focusing containers
1726
1727 To change focus, you can use the +focus+ command. The following options are
1728 available:
1729
1730 left|right|up|down::
1731         Sets focus to the nearest container in the given direction.
1732 parent::
1733         Sets focus to the parent container of the current container.
1734 child::
1735         The opposite of +focus parent+, sets the focus to the last focused
1736         child container.
1737 floating::
1738         Sets focus to the last focused floating container.
1739 tiling::
1740         Sets focus to the last focused tiling container.
1741 mode_toggle::
1742         Toggles between floating/tiling containers.
1743 output::
1744         Followed by a direction or an output name, this will focus the
1745         corresponding output.
1746
1747 *Syntax*:
1748 ----------------------------------------------
1749 focus left|right|down|up
1750 focus parent|child|floating|tiling|mode_toggle
1751 focus output left|right|up|down|<output>
1752 ----------------------------------------------
1753
1754 *Examples*:
1755 -------------------------------------------------
1756 # Focus container on the left, bottom, top, right
1757 bindsym $mod+j focus left
1758 bindsym $mod+k focus down
1759 bindsym $mod+l focus up
1760 bindsym $mod+semicolon focus right
1761
1762 # Focus parent container
1763 bindsym $mod+u focus parent
1764
1765 # Focus last floating/tiling container
1766 bindsym $mod+g focus mode_toggle
1767
1768 # Focus the output right to the current one
1769 bindsym $mod+x focus output right
1770
1771 # Focus the big output
1772 bindsym $mod+x focus output HDMI-2
1773 -------------------------------------------------
1774
1775 === Moving containers
1776
1777 Use the +move+ command to move a container.
1778
1779 *Syntax*:
1780 -----------------------------------------------------
1781 # Moves the container into the given direction.
1782 # The optional pixel argument specifies how far the
1783 # container should be moved if it is floating and
1784 # defaults to 10 pixels.
1785 move <left|right|down|up> [<px> px]
1786
1787 # Moves the container either to a specific location
1788 # or to the center of the screen. If 'absolute' is
1789 # used, it is moved to the center of all outputs.
1790 move [absolute] position [[<px> px] [<px> px]|center]
1791
1792 # Moves the container to the current position of the
1793 # mouse cursor. Only affects floating containers.
1794 move position mouse
1795 -----------------------------------------------------
1796
1797 *Examples*:
1798 -------------------------------------------------------
1799 # Move container to the left, bottom, top, right
1800 bindsym $mod+j move left
1801 bindsym $mod+k move down
1802 bindsym $mod+l move up
1803 bindsym $mod+semicolon move right
1804
1805 # Move container, but make floating containers
1806 # move more than the default
1807 bindsym $mod+j move left 20 px
1808
1809 # Move floating container to the center of all outputs
1810 bindsym $mod+c move absolute position center
1811
1812 # Move container to the current position of the cursor
1813 bindsym $mod+m move position mouse
1814 -------------------------------------------------------
1815
1816 === Sticky floating windows
1817
1818 If you want a window to stick to the glass, i.e., have it stay on screen even
1819 if you switch to another workspace, you can use the +sticky+ command. For
1820 example, this can be useful for notepads, a media player or a video chat
1821 window.
1822
1823 Note that while any window can be made sticky through this command, it will
1824 only take effect if the window is floating.
1825
1826 *Syntax*:
1827 ----------------------------
1828 sticky enable|disable|toggle
1829 ----------------------------
1830
1831 *Examples*:
1832 ------------------------------------------------------
1833 # make a terminal sticky that was started as a notepad
1834 for_window [instance=notepad] sticky enable
1835 ------------------------------------------------------
1836
1837 === Changing (named) workspaces/moving to workspaces
1838
1839 To change to a specific workspace, use the +workspace+ command, followed by the
1840 number or name of the workspace. To move containers to specific workspaces, use
1841 +move container to workspace+.
1842
1843 You can also switch to the next and previous workspace with the commands
1844 +workspace next+ and +workspace prev+, which is handy, for example, if you have
1845 workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
1846 combination. To restrict those to the current output, use +workspace
1847 next_on_output+ and +workspace prev_on_output+. Similarly, you can use +move
1848 container to workspace next+, +move container to workspace prev+ to move a
1849 container to the next/previous workspace and +move container to workspace current+
1850 (the last one makes sense only when used with criteria).
1851
1852 See <<move_to_outputs>> for how to move a container/workspace to a different
1853 RandR output.
1854
1855 Workspace names are parsed as
1856 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
1857 by i3bar.
1858
1859 [[back_and_forth]]
1860 To switch back to the previously focused workspace, use +workspace
1861 back_and_forth+; likewise, you can move containers to the previously focused
1862 workspace using +move container to workspace back_and_forth+.
1863
1864 *Syntax*:
1865 -----------------------------------
1866 workspace next|prev|next_on_output|prev_on_output
1867 workspace back_and_forth
1868 workspace <name>
1869 workspace number <name>
1870
1871 move [window|container] [to] workspace <name>
1872 move [window|container] [to] workspace number <name>
1873 move [window|container] [to] workspace prev|next|current
1874 -----------------------------------
1875
1876 *Examples*:
1877 -------------------------
1878 bindsym $mod+1 workspace 1
1879 bindsym $mod+2 workspace 2
1880 bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
1881 ...
1882
1883 bindsym $mod+Shift+1 move container to workspace 1
1884 bindsym $mod+Shift+2 move container to workspace 2
1885 ...
1886
1887 # switch between the current and the previously focused one
1888 bindsym $mod+b workspace back_and_forth
1889 bindsym $mod+Shift+b move container to workspace back_and_forth
1890
1891 # move the whole workspace to the next output
1892 bindsym $mod+x move workspace to output right
1893
1894 # move firefox to current workspace
1895 bindsym $mod+F1 [class="Firefox"] move workspace current
1896 -------------------------
1897
1898 ==== Named workspaces
1899
1900 Workspaces are identified by their name. So, instead of using numbers in the
1901 workspace command, you can use an arbitrary name:
1902
1903 *Example*:
1904 -------------------------
1905 bindsym $mod+1 workspace mail
1906 ...
1907 -------------------------
1908
1909 If you want the workspace to have a number *and* a name, just prefix the
1910 number, like this:
1911
1912 *Example*:
1913 -------------------------
1914 bindsym $mod+1 workspace 1: mail
1915 bindsym $mod+2 workspace 2: www
1916 ...
1917 -------------------------
1918
1919 Note that the workspace will really be named "1: mail". i3 treats workspace
1920 names beginning with a number in a slightly special way. Normally, named
1921 workspaces are ordered the way they appeared. When they start with a number, i3
1922 will order them numerically. Also, you will be able to use +workspace number 1+
1923 to switch to the workspace which begins with number 1, regardless of which name
1924 it has. This is useful in case you are changing the workspace’s name
1925 dynamically. To combine both commands you can use +workspace number 1: mail+ to
1926 specify a default name if there's currently no workspace starting with a "1".
1927
1928 ==== Renaming workspaces
1929
1930 You can rename workspaces. This might be useful to start with the default
1931 numbered workspaces, do your work, and rename the workspaces afterwards to
1932 reflect what’s actually on them. You can also omit the old name to rename
1933 the currently focused workspace. This is handy if you want to use the
1934 rename command with +i3-input+.
1935
1936 *Syntax*:
1937 ----------------------------------------------------
1938 rename workspace <old_name> to <new_name>
1939 rename workspace to <new_name>
1940 ----------------------------------------------------
1941
1942 *Examples*:
1943 --------------------------------------------------------------------------
1944 i3-msg 'rename workspace 5 to 6'
1945 i3-msg 'rename workspace 1 to "1: www"'
1946 i3-msg 'rename workspace "1: www" to "10: www"'
1947 i3-msg 'rename workspace to "2: mail"'
1948 bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
1949 --------------------------------------------------------------------------
1950
1951 === Moving workspaces to a different screen
1952
1953 See <<move_to_outputs>> for how to move a container/workspace to a different
1954 RandR output.
1955
1956 === Moving containers/workspaces to RandR outputs
1957
1958 [[move_to_outputs]]
1959
1960 To move a container to another RandR output (addressed by names like +LVDS1+ or
1961 +VGA1+) or to a RandR output identified by a specific direction (like +left+,
1962 +right+, +up+ or +down+), there are two commands:
1963
1964 *Syntax*:
1965 ----------------------------------------------------
1966 move container to output left|right|down|up|<output>
1967 move workspace to output left|right|down|up|<output>
1968 ----------------------------------------------------
1969
1970 *Examples*:
1971 --------------------------------------------------------
1972 # Move the current workspace to the next output
1973 # (effectively toggles when you only have two outputs)
1974 bindsym $mod+x move workspace to output right
1975
1976 # Put this window on the presentation output.
1977 bindsym $mod+x move container to output VGA1
1978 --------------------------------------------------------
1979
1980 === Moving containers/workspaces to marks
1981
1982 To move a container to another container with a specific mark (see <<vim_like_marks>>),
1983 you can use the following command.
1984
1985 The window will be moved right after the marked container in the tree, i.e., it ends up
1986 in the same position as if you had opened a new window when the marked container was
1987 focused. If the mark is on a split container, the window will appear as a new child
1988 after the currently focused child within that container.
1989
1990 *Syntax*:
1991 ------------------------------------
1992 move window|container to mark <mark>
1993 ------------------------------------
1994
1995 *Example*:
1996 --------------------------------------------------------
1997 for_window [instance="tabme"] move window to mark target
1998 --------------------------------------------------------
1999
2000 [[resizingconfig]]
2001
2002 === Resizing containers/windows
2003
2004 If you want to resize containers/windows using your keyboard, you can use the
2005 +resize+ command:
2006
2007 *Syntax*:
2008 -------------------------------------------------------
2009 resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
2010 resize set <width> [px] <height> [px]
2011 -------------------------------------------------------
2012
2013 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
2014 less specific and use +width+ or +height+, in which case i3 will take/give
2015 space from all the other containers. The optional pixel argument specifies by
2016 how many pixels a *floating container* should be grown or shrunk (the default
2017 is 10 pixels). The ppt argument means percentage points and specifies by how
2018 many percentage points a *tiling container* should be grown or shrunk (the
2019 default is 10 percentage points). Note that +resize set+ will only work for
2020 floating containers.
2021
2022 I recommend using the resize command inside a so called +mode+:
2023
2024 .Example: Configuration file, defining a mode for resizing
2025 ----------------------------------------------------------------------
2026 mode "resize" {
2027         # These bindings trigger as soon as you enter the resize mode
2028
2029         # Pressing left will shrink the window’s width.
2030         # Pressing right will grow the window’s width.
2031         # Pressing up will shrink the window’s height.
2032         # Pressing down will grow the window’s height.
2033         bindsym j           resize shrink width 10 px or 10 ppt
2034         bindsym k           resize grow height 10 px or 10 ppt
2035         bindsym l           resize shrink height 10 px or 10 ppt
2036         bindsym semicolon   resize grow width 10 px or 10 ppt
2037
2038         # same bindings, but for the arrow keys
2039         bindsym Left        resize shrink width 10 px or 10 ppt
2040         bindsym Down        resize grow height 10 px or 10 ppt
2041         bindsym Up          resize shrink height 10 px or 10 ppt
2042         bindsym Right       resize grow width 10 px or 10 ppt
2043
2044         # back to normal: Enter or Escape
2045         bindsym Return mode "default"
2046         bindsym Escape mode "default"
2047 }
2048
2049 # Enter resize mode
2050 bindsym $mod+r mode "resize"
2051 ----------------------------------------------------------------------
2052
2053 *Example 2 - setting urxvt size to 640x480:*
2054 ------------------------------------------------
2055 for_window [class="urxvt"] resize set 640 480
2056 ------------------------------------------------
2057
2058 === Jumping to specific windows
2059
2060 Often when in a multi-monitor environment, you want to quickly jump to a
2061 specific window. For example, while working on workspace 3 you may want to
2062 jump to your mail client to email your boss that you’ve achieved some
2063 important goal. Instead of figuring out how to navigate to your mail client,
2064 it would be more convenient to have a shortcut. You can use the +focus+ command
2065 with criteria for that.
2066
2067 *Syntax*:
2068 ----------------------------------------------------
2069 [class="class"] focus
2070 [title="title"] focus
2071 ----------------------------------------------------
2072
2073 *Examples*:
2074 ------------------------------------------------
2075 # Get me to the next open VIM instance
2076 bindsym $mod+a [class="urxvt" title="VIM"] focus
2077 ------------------------------------------------
2078
2079 === VIM-like marks (mark/goto)
2080
2081 [[vim_like_marks]]
2082
2083 This feature is like the jump feature: It allows you to directly jump to a
2084 specific window (this means switching to the appropriate workspace and setting
2085 focus to the windows). However, you can directly mark a specific window with
2086 an arbitrary label and use it afterwards. You can unmark the label in the same
2087 way, using the unmark command. If you don't specify a label, unmark removes all
2088 marks. You do not need to ensure that your windows have unique classes or
2089 titles, and you do not need to change your configuration file.
2090
2091 As the command needs to include the label with which you want to mark the
2092 window, you cannot simply bind it to a key.  +i3-input+ is a tool created
2093 for this purpose: It lets you input a command and sends the command to i3. It
2094 can also prefix this command and display a custom prompt for the input dialog.
2095
2096 The additional +--toggle+ option will remove the mark if the window already has
2097 this mark, add it if the window has none or replace the current mark if it has
2098 another mark.
2099
2100 Refer to +show_marks+ if you don't want marks to be shown in the window decoration.
2101
2102 *Syntax*:
2103 ------------------------------
2104 mark [--toggle] <identifier>
2105 [con_mark="identifier"] focus
2106 unmark <identifier>
2107 ------------------------------
2108
2109 *Example (in a terminal)*:
2110 ------------------------------
2111 $ i3-msg mark irssi
2112 $ i3-msg '[con_mark="irssi"] focus'
2113 $ i3-msg unmark irssi
2114 ------------------------------
2115
2116 ///////////////////////////////////////////////////////////////////
2117 TODO: make i3-input replace %s
2118 *Examples*:
2119 ---------------------------------------
2120 # Read 1 character and mark the current window with this character
2121 bindsym $mod+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
2122
2123 # Read 1 character and go to the window with the character
2124 bindsym $mod+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
2125 ---------------------------------------
2126
2127 Alternatively, if you do not want to mess with +i3-input+, you could create
2128 seperate bindings for a specific set of labels and then only use those labels.
2129 ///////////////////////////////////////////////////////////////////
2130
2131 === Window title format
2132
2133 By default, i3 will simply print the X11 window title. Using +title_format+,
2134 this can be customized by setting the format to the desired output. This
2135 directive supports
2136 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
2137 and the following placeholders which will be replaced:
2138
2139 +%title+::
2140     The X11 window title (_NET_WM_NAME or WM_NAME as fallback).
2141 +%class+::
2142     The X11 window class (second part of WM_CLASS). This corresponds to the
2143     +class+ criterion, see <<command_criteria>>.
2144 +%instance+::
2145     The X11 window instance (first part of WM_CLASS). This corresponds to the
2146     +instance+ criterion, see <<command_criteria>>.
2147
2148 Using the <<for_window>> directive, you can set the title format for any window
2149 based on <<command_criteria>>.
2150
2151 *Syntax*:
2152 ---------------------
2153 title_format <format>
2154 ---------------------
2155
2156 *Examples*:
2157 -------------------------------------------------------------------------------------
2158 # give the focused window a prefix
2159 bindsym $mod+p title_format "Important | %title"
2160
2161 # print all window titles bold
2162 for_window [class=".*"] title_format "<b>%title</b>"
2163
2164 # print window titles of firefox windows red
2165 for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"
2166 -------------------------------------------------------------------------------------
2167
2168 === Changing border style
2169
2170 To change the border of the current client, you can use +border normal+ to use the normal
2171 border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
2172 and +border none+ to make the client borderless.
2173
2174 There is also +border toggle+ which will toggle the different border styles.
2175
2176 *Syntax*:
2177 -----------------------------------------------
2178 border normal|pixel [<n>]
2179 border none|toggle
2180
2181 # legacy syntax, equivalent to "border pixel 1"
2182 border 1pixel
2183 -----------------------------------------------
2184
2185 *Examples*:
2186 ----------------------------------------------
2187 # use window title, but no border
2188 bindsym $mod+t border normal 0
2189 # use no window title and a thick border
2190 bindsym $mod+y border pixel 3
2191 # use neither window title nor border
2192 bindsym $mod+u border none
2193 ----------------------------------------------
2194
2195 [[shmlog]]
2196
2197 === Enabling shared memory logging
2198
2199 As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared
2200 memory buffer, which you can dump using +i3-dump-log+. The +shmlog+ command
2201 allows you to enable or disable the shared memory logging at runtime.
2202
2203 Note that when using +shmlog <size_in_bytes>+, the current log will be
2204 discarded and a new one will be started.
2205
2206 *Syntax*:
2207 ------------------------------
2208 shmlog <size_in_bytes>
2209 shmlog on|off|toggle
2210 ------------------------------
2211
2212 *Examples*:
2213 ---------------
2214 # Enable/disable logging
2215 bindsym $mod+x shmlog toggle
2216
2217 # or, from a terminal:
2218 # increase the shared memory log buffer to 50 MiB
2219 i3-msg shmlog $((50*1024*1024))
2220 ---------------
2221
2222 === Enabling debug logging
2223
2224 The +debuglog+ command allows you to enable or disable debug logging at
2225 runtime. Debug logging is much more verbose than non-debug logging. This
2226 command does not activate shared memory logging (shmlog), and as such is most
2227 likely useful in combination with the above-described <<shmlog>> command.
2228
2229 *Syntax*:
2230 ----------------------
2231 debuglog on|off|toggle
2232 ----------------------
2233
2234 *Examples*:
2235 ------------------------
2236 # Enable/disable logging
2237 bindsym $mod+x debuglog toggle
2238 ------------------------
2239
2240 === Reloading/Restarting/Exiting
2241
2242 You can make i3 reload its configuration file with +reload+. You can also
2243 restart i3 inplace with the +restart+ command to get it out of some weird state
2244 (if that should ever happen) or to perform an upgrade without having to restart
2245 your X session. To exit i3 properly, you can use the +exit+ command,
2246 however you don’t need to (simply killing your X session is fine as well).
2247
2248 *Examples*:
2249 ----------------------------
2250 bindsym $mod+Shift+r restart
2251 bindsym $mod+Shift+w reload
2252 bindsym $mod+Shift+e exit
2253 ----------------------------
2254
2255 === Scratchpad
2256
2257 There are two commands to use any existing window as scratchpad window. +move
2258 scratchpad+ will move a window to the scratchpad workspace. This will make it
2259 invisible until you show it again. There is no way to open that workspace.
2260 Instead, when using +scratchpad show+, the window will be shown again, as a
2261 floating window, centered on your current workspace (using +scratchpad show+ on
2262 a visible scratchpad window will make it hidden again, so you can have a
2263 keybinding to toggle). Note that this is just a normal floating window, so if
2264 you want to "remove it from scratchpad", you can simple make it tiling again
2265 (+floating toggle+).
2266
2267 As the name indicates, this is useful for having a window with your favorite
2268 editor always at hand. However, you can also use this for other permanently
2269 running applications which you don’t want to see all the time: Your music
2270 player, alsamixer, maybe even your mail client…?
2271
2272 *Syntax*:
2273 ---------------
2274 move scratchpad
2275
2276 scratchpad show
2277 ---------------
2278
2279 *Examples*:
2280 ------------------------------------------------
2281 # Make the currently focused window a scratchpad
2282 bindsym $mod+Shift+minus move scratchpad
2283
2284 # Show the first scratchpad window
2285 bindsym $mod+minus scratchpad show
2286
2287 # Show the sup-mail scratchpad window, if any.
2288 bindsym mod4+s [title="^Sup ::"] scratchpad show
2289 ------------------------------------------------
2290
2291 === Nop
2292
2293 There is a no operation command +nop+ which allows you to override default
2294 behavior. This can be useful for, e.g., disabling a focus change on clicks with
2295 the middle mouse button.
2296
2297 The optional +comment+ argument is ignored, but will be printed to the log file
2298 for debugging purposes.
2299
2300 *Syntax*:
2301 ---------------
2302 nop [<comment>]
2303 ---------------
2304
2305 *Example*:
2306 ----------------------------------------------
2307 # Disable focus change for clicks on titlebars
2308 # with the middle mouse button
2309 bindsym button2 nop
2310 ----------------------------------------------
2311
2312 === i3bar control
2313
2314 There are two options in the configuration of each i3bar instance that can be
2315 changed during runtime by invoking a command through i3. The commands +bar
2316 hidden_state+ and +bar mode+ allow setting the current hidden_state
2317 respectively mode option of each bar. It is also possible to toggle between
2318 hide state and show state as well as between dock mode and hide mode. Each
2319 i3bar instance can be controlled individually by specifying a bar_id, if none
2320 is given, the command is executed for all bar instances.
2321
2322 *Syntax*:
2323 ---------------
2324 bar hidden_state hide|show|toggle [<bar_id>]
2325
2326 bar mode dock|hide|invisible|toggle [<bar_id>]
2327 ---------------
2328
2329 *Examples*:
2330 ------------------------------------------------
2331 # Toggle between hide state and show state
2332 bindsym $mod+m bar hidden_state toggle
2333
2334 # Toggle between dock mode and hide mode
2335 bindsym $mod+n bar mode toggle
2336
2337 # Set the bar instance with id 'bar-1' to switch to hide mode
2338 bindsym $mod+b bar mode hide bar-1
2339
2340 # Set the bar instance with id 'bar-1' to always stay hidden
2341 bindsym $mod+Shift+b bar mode invisible bar-1
2342 ------------------------------------------------
2343
2344 [[multi_monitor]]
2345
2346 == Multiple monitors
2347
2348 As you can see in the goal list on the website, i3 was specifically developed
2349 with support for multiple monitors in mind. This section will explain how to
2350 handle multiple monitors.
2351
2352 When you have only one monitor, things are simple. You usually start with
2353 workspace 1 on your monitor and open new ones as you need them.
2354
2355 When you have more than one monitor, each monitor will get an initial
2356 workspace.  The first monitor gets 1, the second gets 2 and a possible third
2357 would get 3. When you switch to a workspace on a different monitor, i3 will
2358 switch to that monitor and then switch to the workspace. This way, you don’t
2359 need shortcuts to switch to a specific monitor, and you don’t need to remember
2360 where you put which workspace. New workspaces will be opened on the currently
2361 active monitor.  It is not possible to have a monitor without a workspace.
2362
2363 The idea of making workspaces global is based on the observation that most
2364 users have a very limited set of workspaces on their additional monitors.
2365 They are often used for a specific task (browser, shell) or for monitoring
2366 several things (mail, IRC, syslog, …). Thus, using one workspace on one monitor
2367 and "the rest" on the other monitors often makes sense. However, as you can
2368 create an unlimited number of workspaces in i3 and tie them to specific
2369 screens, you can have the "traditional" approach of having X workspaces per
2370 screen by changing your configuration (using modes, for example).
2371
2372 === Configuring your monitors
2373
2374 To help you get going if you have never used multiple monitors before, here is
2375 a short overview of the xrandr options which will probably be of interest to
2376 you. It is always useful to get an overview of the current screen configuration.
2377 Just run "xrandr" and you will get an output like the following:
2378 -------------------------------------------------------------------------------
2379 $ xrandr
2380 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
2381 VGA1 disconnected (normal left inverted right x axis y axis)
2382 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
2383    1280x800       60.0*+   50.0
2384    1024x768       85.0     75.0     70.1     60.0
2385    832x624        74.6
2386    800x600        85.1     72.2     75.0     60.3     56.2
2387    640x480        85.0     72.8     75.0     59.9
2388    720x400        85.0
2389    640x400        85.1
2390    640x350        85.1
2391 --------------------------------------------------------------------------------------
2392
2393 Several things are important here: You can see that +LVDS1+ is connected (of
2394 course, it is the internal flat panel) but +VGA1+ is not. If you have a monitor
2395 connected to one of the ports but xrandr still says "disconnected", you should
2396 check your cable, monitor or graphics driver.
2397
2398 The maximum resolution you can see at the end of the first line is the maximum
2399 combined resolution of your monitors. By default, it is usually too low and has
2400 to be increased by editing +/etc/X11/xorg.conf+.
2401
2402 So, say you connected VGA1 and want to use it as an additional screen:
2403 -------------------------------------------
2404 xrandr --output VGA1 --auto --left-of LVDS1
2405 -------------------------------------------
2406 This command makes xrandr try to find the native resolution of the device
2407 connected to +VGA1+ and configures it to the left of your internal flat panel.
2408 When running "xrandr" again, the output looks like this:
2409 -------------------------------------------------------------------------------
2410 $ xrandr
2411 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
2412 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
2413    1280x1024      60.0*+   75.0
2414    1280x960       60.0
2415    1152x864       75.0
2416    1024x768       75.1     70.1     60.0
2417    832x624        74.6
2418    800x600        72.2     75.0     60.3     56.2
2419    640x480        72.8     75.0     66.7     60.0
2420    720x400        70.1
2421 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
2422    1280x800       60.0*+   50.0
2423    1024x768       85.0     75.0     70.1     60.0
2424    832x624        74.6
2425    800x600        85.1     72.2     75.0     60.3     56.2
2426    640x480        85.0     72.8     75.0     59.9
2427    720x400        85.0
2428    640x400        85.1
2429    640x350        85.1
2430 -------------------------------------------------------------------------------
2431 Please note that i3 uses exactly the same API as xrandr does, so it will see
2432 only what you can see in xrandr.
2433
2434 See also <<presentations>> for more examples of multi-monitor setups.
2435
2436 === Interesting configuration for multi-monitor environments
2437
2438 There are several things to configure in i3 which may be interesting if you
2439 have more than one monitor:
2440
2441 1. You can specify which workspace should be put on which screen. This
2442    allows you to have a different set of workspaces when starting than just
2443    1 for the first monitor, 2 for the second and so on. See
2444    <<workspace_screen>>.
2445 2. If you want some applications to generally open on the bigger screen
2446    (MPlayer, Firefox, …), you can assign them to a specific workspace, see
2447    <<assign_workspace>>.
2448 3. If you have many workspaces on many monitors, it might get hard to keep
2449    track of which window you put where. Thus, you can use vim-like marks to
2450    quickly switch between windows. See <<vim_like_marks>>.
2451 4. For information on how to move existing workspaces between monitors,
2452    see <<_moving_containers_workspaces_to_randr_outputs>>.
2453
2454 == i3 and the rest of your software world
2455
2456 === Displaying a status line
2457
2458 A very common thing amongst users of exotic window managers is a status line at
2459 some corner of the screen. It is an often superior replacement to the widget
2460 approach you have in the task bar of a traditional desktop environment.
2461
2462 If you don’t already have your favorite way of generating such a status line
2463 (self-written scripts, conky, …), then i3status is the recommended tool for
2464 this task. It was written in C with the goal of using as few syscalls as
2465 possible to reduce the time your CPU is woken up from sleep states. Because
2466 i3status only spits out text, you need to combine it with some other tool, like
2467 i3bar. See <<status_command>> for how to display i3status in i3bar.
2468
2469 Regardless of which application you use to display the status line, you
2470 want to make sure that it registers as a dock window using EWMH hints. i3 will
2471 position the window either at the top or at the bottom of the screen, depending
2472 on which hint the application sets. With i3bar, you can configure its position,
2473 see <<i3bar_position>>.
2474
2475 === Giving presentations (multi-monitor)
2476
2477 When giving a presentation, you typically want the audience to see what you see
2478 on your screen and then go through a series of slides (if the presentation is
2479 simple). For more complex presentations, you might want to have some notes
2480 which only you can see on your screen, while the audience can only see the
2481 slides.
2482
2483 [[presentations]]
2484 ==== Case 1: everybody gets the same output
2485 This is the simple case. You connect your computer to the video projector,
2486 turn on both (computer and video projector) and configure your X server to
2487 clone the internal flat panel of your computer to the video output:
2488 -----------------------------------------------------
2489 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
2490 -----------------------------------------------------
2491 i3 will then use the lowest common subset of screen resolutions, the rest of
2492 your screen will be left untouched (it will show the X background). So, in
2493 our example, this would be 1024x768 (my notebook has 1280x800).
2494
2495 ==== Case 2: you can see more than your audience
2496 This case is a bit harder. First of all, you should configure the VGA output
2497 somewhere near your internal flat panel, say right of it:
2498 -----------------------------------------------------
2499 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
2500 -----------------------------------------------------
2501 Now, i3 will put a new workspace (depending on your settings) on the new screen
2502 and you are in multi-monitor mode (see <<multi_monitor>>).
2503
2504 Because i3 is not a compositing window manager, there is no ability to
2505 display a window on two screens at the same time. Instead, your presentation
2506 software needs to do this job (that is, open a window on each screen).