]> git.sur5r.net Git - i3/i3/blob - docs/userguide
Fix spelling errors/strange sentences in the user’s guide
[i3/i3] / docs / userguide
1 i3 User’s Guide
2 ===============
3 Michael Stapelberg <michael+i3@stapelberg.de>
4 March 2010
5
6 This document contains all information you need for configuring and using the i3
7 window manager. If it does not, please contact me on IRC, Jabber or E-Mail and
8 I’ll help you out.
9
10 == Default keybindings
11
12 For the "too long; didn’t read" people, here comes an overview of the default
13 keybindings (click to see the full size image):
14
15 *Keys to use with Mod1 (alt):*
16
17 image:keyboard-layer1.png["Keys to use with Mod1 (alt)",width=600,link="keyboard-layer1.png"]
18
19 *Keys to use with Shift+Mod1:*
20
21 image:keyboard-layer2.png["Keys to use with Shift+Mod1",width=600,link="keyboard-layer2.png"]
22
23 As i3 uses keycodes in the default configuration, it does not matter which
24 layout you actually use. The key positions are what matters (of course you can
25 also use keysymbols, see below).
26
27 The red keys are the modifiers you need to press (by default), the blue keys
28 are your homerow.
29
30 == Using i3
31
32 === Opening terminals and moving around
33
34 A very basic operation is to open a new terminal. By default, the keybinding
35 for that is Mod1+Enter, that is Alt+Enter in the default configuration. By
36 pressing Mod1+Enter, a new terminal will be opened and it will fill the whole
37 space which is available on your screen.
38
39 image:single_terminal.png[Single terminal]
40
41 It is important to keep in mind that i3 uses a table to manage your windows. At
42 the moment, you have exactly one column and one row which leaves you with one
43 cell. In this cell, there is a container in which your newly opened terminal is.
44
45 If you now open another terminal, you still have only one cell. However, the
46 container has both of your terminals. So, a container is just a group of clients
47 with a specific layout. You can resize containers as they directly resemble
48 columns/rows of the layout table.
49
50 image:two_terminals.png[Two terminals]
51
52 To move the focus between the two terminals, you use the direction keys which
53 you may know from the editor +vi+. However, in i3, your homerow is used for
54 these keys (in +vi+, the keys are shifted to the left by one for compatibility
55 with most keyboard layouts). Therefore, +Mod1+J+ is left, +Mod1+K+ is down, +Mod1+L+
56 is up and `Mod1+;` is right. So, to switch between the terminals, use +Mod1+K+ or
57 +Mod1+L+.
58
59 To create a new row/column, you can simply move a terminal (or any other window)
60 to the direction you want to expand your table. So, let’s expand the table to
61 the right by pressing `Mod1+Shift+;`.
62
63 image:two_columns.png[Two columns]
64
65 === Changing mode of containers
66
67 A container can be in the following modes:
68
69 default::
70 Windows are sized so that every window gets an equal amount of space of the
71 container.
72 stacking::
73 Only the focused client of the container is displayed and you get a list of
74 windows at the top of the container.
75 tabbed::
76 The same principle as +stacking+, but the list of windows at the top is only
77 a single line which will be vertically split.
78
79 To switch the mode, press +Mod1+e+ for default, +Mod1+h+ for stacking and
80 +Mod1+w+ for tabbed.
81
82 image:modes.png[Container modes]
83
84 === Toggling fullscreen mode for a window
85
86 To display a window fullscreen or to go out of fullscreen mode again, press
87 +Mod1+f+.
88
89 There also is a global fullscreen mode in i3 in which the client will use all
90 available outputs. To use it, or to get out of it again, press +Mod1+Shift+f+.
91
92 === Opening other applications
93
94 Aside from opening applicatios from a terminal, you can also use the handy
95 +dmenu+ which is opened by pressing +Mod1+v+ by default. Just type the name
96 (or a part of it) of the application which you want to open. It has to be in
97 your +$PATH+ for that to work.
98
99 Furthermore, if you have applications you open very frequently, you can also
100 create a keybinding for starting the application directly. See the section
101 "Configuring i3" for details.
102
103 === Closing windows
104
105 If an application does not provide a mechanism to close (most applications
106 provide a menu, the escape key or a shortcut like +Control+W+ to close), you
107 can press +Mod1+Shift+q+ to kill a window. For applications which support
108 the WM_DELETE protocol, this will correctly close the application (saving
109 any modifications or doing other cleanup). If the application doesn’t support
110 it, your X server will kill the window and the behaviour depends on the
111 application.
112
113 === Using workspaces
114
115 Workspaces are an easy way to group a set of windows. By default, you are on
116 the first workspace, as the bar on the bottom left indicates. To switch to
117 another workspace, press +Mod1+num+ where +num+ is the number of the workspace
118 you want to use. If the workspace does not exist yet, it will be created.
119
120 A common paradigm is to put the web browser on one workspace, communication
121 applications (+mutt+, +irssi+, ...) on another one and the ones with which you
122 work on the third one. Of course, there is no need to follow this approach.
123
124 If you have multiple screens, a workspace will be created on each screen. If
125 you open a new workspace, it will be bound to the screen you created it on.
126 When you switch to a workspace on another screen, i3 will set focus to this
127 screen.
128
129 === Moving windows to workspaces
130
131 To move a window to another workspace, simply press +Mod1+Shift+num+ where
132 +num+ is (like when switching workspaces) the number of the target workspace.
133 Similarly to switching workspaces, the target workspace will be created if
134 it does not yet exist.
135
136 === Resizing columns/rows
137
138 To resize columns or rows just grab the border between the two columns/rows
139 and move it to the wanted size. Please keep in mind that each cell of the table
140 holds a +container+ and thus you cannot horizontally resize single windows.
141
142 See <<resizingconfig>> for how to configure i3 to be able to resize
143 columns/rows with your keyboard.
144
145 === Restarting i3 inplace
146
147 To restart i3 inplace (and thus get it into a clean state if it has a bug or
148 to upgrade to a newer version of i3) you can use +Mod1+Shift+r+. Be aware,
149 though, that this kills your current layout and all the windows you have opened
150 will be put in a default container in only one cell. Saving the layout will be
151 implemented in a later version.
152
153 === Exiting i3
154
155 To cleanly exit i3 without killing your X server, you can use +Mod1+Shift+e+.
156
157 === Snapping
158
159 Snapping is a mechanism to increase/decrease the colspan/rowspan of a container.
160 Colspan/rowspan is the amount of columns/rows a specific cell of the table
161 consumes. This is easier explained by giving an example, so take the following
162 layout:
163
164 image:snapping.png[Snapping example]
165
166 To use the full size of your screen, you can now snap container 3 downwards
167 by pressing +Mod1+Control+k+ (or snap container 2 rightwards).
168
169 === Floating
170
171 Floating mode is the opposite of tiling mode. The position and size of a window
172 are then not managed by i3, but by you. Using this mode violates the tiling
173 paradigm but can be useful for some corner cases like "Save as" dialog
174 windows or toolbar windows (GIMP or similar).
175
176 You can enable floating mode for a window by pressing +Mod1+Shift+Space+. By
177 dragging the window’s titlebar with your mouse, you can move the window
178 around. By grabbing the borders and moving them you can resize the window.
179
180 Bindings for doing this with your keyboard will follow.
181
182 Floating clients are always on top of tiling clients.
183
184 == Configuring i3
185
186 This is where the real fun begins ;-). Most things are very dependant on your
187 ideal working environment, so we can’t make reasonable defaults for them.
188
189 While not using a programming language for the configuration, i3 stays
190 quite flexible regarding to the things you usually want your window manager
191 to do.
192
193 For example, you can configure bindings to jump to specific windows,
194 you can set specific applications to start on a specific workspace, you can
195 automatically start applications, you can change the colors of i3 or bind
196 your keys to do useful stuff.
197
198 To change the configuration of i3, copy +/etc/i3/config+ to +\~/.i3/config+
199 (or +~/.config/i3/config+ if you like the XDG directory scheme) and edit it
200 with a text editor.
201
202 === Comments
203
204 It is possible and recommended to use comments in your configuration file to
205 properly document your setup for later reference. Comments are started with
206 a # and can only be used at the beginning of a line, like this:
207
208 *Examples*:
209 -------------------
210 # This is a comment
211 -------------------
212
213 === Fonts
214
215 i3 uses X core fonts (not Xft) for rendering window titles and the internal
216 workspace bar. You can use +xfontsel(1)+ to generate such a font description.
217 To see special characters (Unicode), you need to use a font which supports
218 the ISO-10646 encoding.
219
220 *Syntax*:
221 ------------------------------
222 font <X core font description>
223 ------------------------------
224
225 *Examples*:
226 --------------------------------------------------------------
227 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
228 --------------------------------------------------------------
229
230 === Keyboard bindings
231
232 A keyboard binding makes i3 execute a command (see below) upon pressing a
233 specific key. i3 allows you to bind either on keycodes or on keysyms (you can
234 also mix your bindings, though i3 will not protect you from overlapping ones).
235
236 * A keysym (key symbol) is a description for a specific symbol, like "a" or "b",
237   but also more strange ones like "underscore" instead of "_". These are the ones
238   you also use in Xmodmap to remap your keys. To get the current mapping of your
239   keys, use +xmodmap -pke+.
240
241 * Keycodes however do not need to have a symbol assigned (handy for some hotkeys
242   on some notebooks) and they will not change their meaning as you switch to a
243   different keyboard layout (when using +xmodmap+).
244
245 My recommendation is: If you often switch keyboard layouts because you try to
246 learn a different one, but you want to keep your bindings at the same place,
247 use keycodes. If you don’t switch layouts and like a clean and simple config
248 file, use keysyms.
249
250 *Syntax*:
251 ----------------------------------
252 bindsym [Modifiers+]keysym command
253 bind [Modifiers+]keycode command
254 ----------------------------------
255
256 *Examples*:
257 --------------------------------
258 # Fullscreen
259 bindsym Mod1+f f
260
261 # Restart
262 bindsym Mod1+Shift+r restart
263
264 # Notebook-specific hotkeys
265 bind 214 exec /home/michael/toggle_beamer.sh
266 --------------------------------
267
268 Available Modifiers:
269
270 Mod1-Mod5, Shift, Control::
271 Standard modifiers, see +xmodmap(1)+
272
273 Mode_switch::
274 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
275 you to remap capslock (for example) to Mode_switch and use it for both: typing
276 umlauts or special characters 'and' having some comfortably reachable key
277 bindings. For example, when typing, capslock+1 or capslock+2 for switching
278 workspaces is totally convenient. Try it :-).
279
280 === The floating modifier
281
282 To move floating windows with your mouse, you can either grab their titlebar
283 or configure the so called floating modifier which you can then press and
284 click anywhere in the window itself. The most common setup is to configure
285 it as the same one you use for managing windows (Mod1 for example). Afterwards,
286 you can press Mod1, click into a window using your left mouse button and drag
287 it to the position you want it at.
288
289 When holding the floating modifier, you can resize a floating window by pressing
290 the right mouse button on it and moving around holding it. If you hold the shift
291 button aswell, the resize will be proportional.
292
293 *Syntax*:
294 --------------------------------
295 floating_modifier <Modifiers>
296 --------------------------------
297
298 *Examples*:
299 --------------------------------
300 floating_modifier Mod1
301 --------------------------------
302
303 === Layout mode for new containers
304
305 This option determines in which mode new containers will start. See also
306 <<stack-limit>>.
307
308 *Syntax*:
309 ---------------------------------------------
310 new_container <default|stacking|tabbed>
311 new_container stack-limit <cols|rows> <value>
312 ---------------------------------------------
313
314 *Examples*:
315 ---------------------
316 new_container tabbed
317 ---------------------
318
319 === Border style for new windows
320
321 This option determines which border style new windows will have.
322
323 *Syntax*:
324 ---------------------------------------------
325 new_window <bp|bn|bb>
326 ---------------------------------------------
327
328 *Examples*:
329 ---------------------
330 new_window bp
331 ---------------------
332
333 === Variables
334
335 As you learned in the previous section about keyboard bindings, you will have
336 to configure lots of bindings containing modifier keys. If you want to save
337 yourself some typing and have the possibility to change the modifier you want
338 to use later, variables can be handy.
339
340 *Syntax*:
341 --------------
342 set name value
343 --------------
344
345 *Examples*:
346 ------------------------
347 set $m Mod1
348 bindsym $m+Shift+r restart
349 ------------------------
350
351 Variables are directly replaced in the file when parsing, there is no fancy
352 handling and there are absolutely no plans to change this. If you need a more
353 dynamic configuration, you should create a little script which generates a
354 configuration file and run it before starting i3 (for example in your
355 +.xsession+ file).
356
357 === Automatically putting clients on specific workspaces
358
359 [[assign_workspace]]
360
361 It is recommended that you match on window classes whereever possible because
362 some applications first create their window and then care about setting the
363 correct title. Firefox with Vimperator comes to mind, as the window starts up
364 being named Firefox and only when Vimperator is loaded, the title changes. As
365 i3 will get the title as soon as the application maps the window (mapping means
366 actually displaying it on the screen), you’d need to have to match on Firefox
367 in this case.
368
369 You can prefix or suffix workspaces with a `~` to specify that matching clients
370 should be put into floating mode. If you specify only a `~`, the client will
371 not be put onto any workspace, but will be set floating on the current one.
372
373 *Syntax*:
374 ------------------------------------------------------------
375 assign ["]window class[/window title]["] [→] [~ | workspace]
376 ------------------------------------------------------------
377
378 *Examples*:
379 ----------------------
380 assign urxvt 2
381 assign urxvt → 2
382 assign "urxvt" → 2
383 assign "urxvt/VIM" → 3
384 assign "gecko" → ~4
385 assign "xv/MPlayer" → ~
386 ----------------------
387
388 Note that the arrow is not required, it just looks good :-). If you decide to
389 use it, it has to be a UTF-8 encoded arrow, not "->" or something like that.
390
391 === Automatically starting applications on startup
392
393 By using the +exec+ keyword outside a keybinding, you can configure which
394 commands will be performed by i3 on the first start (not when restarting inplace
395 however). The commands will be run in order.
396
397 *Syntax*:
398 ------------
399 exec command
400 ------------
401
402 *Examples*:
403 --------------------------------
404 exec sudo i3status | dzen2 -dock
405 --------------------------------
406
407 === Automatically putting workspaces on specific screens
408
409 [[workspace_screen]]
410
411 If you use assignments of clients to workspaces, it might be handy to put the
412 workspaces on specific screens. Also, the assignment of workspaces to screens
413 will determine the workspace which i3 uses for a new screen when adding screens
414 or when starting (e.g., by default it will use 1 for the first screen, 2 for
415 the second screen and so on).
416
417 *Syntax*:
418 ----------------------------------
419 workspace <number> output <output>
420 ----------------------------------
421
422 The output is the name of the RandR output you attach your screen to. On a
423 laptop, you might have VGA1 and LVDS1 as output names. You can see the
424 available outputs by running +xrandr --current+.
425
426 *Examples*:
427 ---------------------------
428 workspace 1 output LVDS1
429 workspace 5 output VGA1
430 ---------------------------
431
432 === Named workspaces
433
434 If you always have a certain arrangement of workspaces, you might want to give
435 them names (of course UTF-8 is supported):
436
437 *Syntax*:
438 ---------------------------------------
439 workspace <number> <name>
440 workspace <number> output <output> name
441 ---------------------------------------
442
443 For more details about the output-part of this command, see above.
444
445 *Examples*:
446 --------------------------
447 workspace 1 www
448 workspace 2 work
449 workspace 3 i ♥ workspaces
450 --------------------------
451
452 === Changing colors
453
454 You can change all colors which i3 uses to draw the window decorations and the
455 bottom bar.
456
457 *Syntax*:
458 --------------------------------------------
459 colorclass border background text
460 --------------------------------------------
461
462 Where colorclass can be one of:
463
464 client.focused::
465         A client which currently has the focus.
466 client.focused_inactive::
467         A client which is the focused one of its container, but it does not have
468         the focus at the moment.
469 client.unfocused::
470         A client which is not the focused one of its container.
471 client.urgent::
472         A client which has its urgency hint activated.
473 bar.focused::
474         The current workspace in the bottom bar.
475 bar.unfocused::
476         All other workspaces in the bottom bar.
477 bar.urgent::
478         A workspace which has at least one client with an activated urgency hint.
479
480 Colors are in HTML hex format (#rrggbb), see the following example:
481
482 *Examples*:
483 --------------------------------------
484 # class        border  backgr. text
485 client.focused #2F343A #900000 #FFFFFF
486 --------------------------------------
487
488 Note that for the window decorations the color around the child window is the
489 background color and the border color is only the two thin lines at the top of
490 the window.
491
492 === Interprocess communication
493
494 i3 uses unix sockets to provide an IPC interface. This allows third-party
495 programs to get information like the current workspaces to display a workspace
496 bar and to control i3.
497
498 To enable it, you have to configure a path where the unix socket will be
499 stored. The default path is +/tmp/i3-ipc.sock+.
500
501 *Examples*:
502 ----------------------------
503 ipc-socket /tmp/i3-ipc.sock
504 ----------------------------
505
506 You can then use the +i3-msg+ command to perform any command listed in the next
507 section.
508
509 === Disable focus follows mouse
510
511 If you have a setup where your mouse usually is in your way (like a touchpad
512 on your laptop which you do not want to disable completely), you might want
513 to disable focus follows mouse and control focus only by using your keyboard.
514 The mouse will still be useful inside the currently active window (for example
515 to click on links in your browser window).
516
517 *Syntax*:
518 ----------------------------
519 focus_follows_mouse <yes|no>
520 ----------------------------
521
522 *Examples*:
523 ----------------------
524 focus_follows_mouse no
525 ----------------------
526
527 == List of commands
528
529 === Manipulating layout
530
531 To change the layout of the current container to stacking, use +s+, for default
532 use +d+ and for tabbed, use +T+. To make the current client (!) fullscreen,
533 use +f+, to make it span all outputs, use +fg+, to make it floating (or
534 tiling again) use +t+:
535
536 *Examples*:
537 --------------
538 bindsym Mod1+s s
539 bindsym Mod1+l d
540 bindsym Mod1+w T
541
542 # Toggle fullscreen
543 bindsym Mod1+f f
544
545 # Toggle global fullscreen
546 bindsym Mod1+Shift+f fg
547
548 # Toggle floating/tiling
549 bindsym Mod1+t t
550 --------------
551
552 === Focussing/Moving/Snapping clients/containers/screens
553
554 To change the focus, use one of the +h+, +j+, +k+ and +l+ commands, meaning
555 left, down, up, right (respectively). To focus a container, prefix it with +wc+,
556 to focus a screen, prefix it with +ws+.
557
558 The same principle applies for moving and snapping, just prefix the command
559 with +m+ when moving and with +s+ when snapping:
560
561 *Examples*:
562 ----------------------
563 # Focus clients on the left, bottom, top, right:
564 bindsym Mod1+j h
565 bindsym Mod1+k j
566 bindsym Mod1+j k
567 bindsym Mod1+semicolon l
568
569 # Move client to the left, bottom, top, right:
570 bindsym Mod1+j mh
571 bindsym Mod1+k mj
572 bindsym Mod1+j mk
573 bindsym Mod1+semicolon ml
574
575 # Snap client to the left, bottom, top, right:
576 bindsym Mod1+j sh
577 bindsym Mod1+k sj
578 bindsym Mod1+j sk
579 bindsym Mod1+semicolon sl
580
581 # Focus container on the left, bottom, top, right:
582 bindsym Mod3+j wch
583
584 ----------------------
585
586 === Changing workspaces/moving clients to workspaces
587
588 To change to a specific workspace, the command is just the number of the
589 workspace, e.g. +1+ or +3+. To move the current client to a specific workspace,
590 prefix the number with an +m+.
591
592 Furthermore, you can switch to the next and previous workspace with the
593 commands +nw+ and +pw+, which is handy for example if you have workspace
594 1, 3, 4 and 9 and you want to cycle through them with a single key combination.
595
596 *Examples*:
597 -------------------------
598 bindsym Mod1+1 1
599 bindsym Mod1+2 2
600 ...
601
602 bindsym Mod1+Shift+1 m1
603 bindsym Mod1+Shift+2 m2
604 ...
605
606 bindsym Mod1+o nw
607 bindsym Mod1+p pw
608 -------------------------
609
610 [[resizingconfig]]
611
612 === Resizing columns/rows
613
614 If you want to resize columns/rows using your keyboard, you can use the
615 +resize+ command, I recommend using it inside a so called +mode+:
616
617 .Example: Configuration file, defining a mode for resizing
618 ----------------------------------------------------------------------
619 mode "resize" {
620         # These bindings trigger as soon as you enter the resize mode
621
622         # They resize the border in the direction you pressed, e.g.
623         # when pressing left, the window is resized so that it has
624         # more space on its left
625
626         bindsym n resize left -10
627         bindsym Shift+n resize left +10
628
629         bindsym r resize bottom +10
630         bindsym Shift+r resize bottom -10
631
632         bindsym t resize top -10
633         bindsym Shift+t resize top +10
634
635         bindsym d resize right +10
636         bindsym Shift+d resize right -10
637
638         bind 36 mode default
639 }
640
641 # Enter resize mode
642 bindsym Mod1+r mode resize
643 ----------------------------------------------------------------------
644
645 === Jumping to specific windows
646
647 Especially when in a multi-monitor environment, you want to quickly jump to a specific
648 window, for example while currently working on workspace 3 you may want to jump to
649 your mailclient to mail your boss that you’ve achieved some important goal. Instead
650 of figuring out how to navigate to your mailclient, it would be more convenient to
651 have a shortcut.
652
653 *Syntax*:
654 ----------------------------------------------------
655 jump ["]window class[/window title]["]
656 jump workspace [ column row ]
657 ----------------------------------------------------
658
659 You can either use the same matching algorithm as in the +assign+ command (see above)
660 or you can specify the position of the client if you always use the same layout.
661
662 *Examples*:
663 --------------------------------------
664 # Get me to the next open VIM instance
665 bindsym Mod1+a jump "urxvt/VIM"
666 --------------------------------------
667
668 === VIM-like marks (mark/goto)
669
670 [[vim_like_marks]]
671
672 This feature is like the jump feature: It allows you to directly jump to a
673 specific window (this means switching to the appropriate workspace and setting
674 focus to the windows). However, you can directly mark a specific window with
675 an arbitrary label and use it afterwards, that is, you do not need to ensure
676 that your windows have unique classes or titles and you do not need to change
677 your configuration file.
678
679 As the command needs to include the label with which you want to mark the
680 window, you cannot simply bind it to a key (or, you could bind it to a key and
681 only use the set of labels for which you created bindings). +i3-input+ is a
682 tool created for this purpose: It lets you input a command and sends the
683 command to i3. It can also prefix this command and display a custom prompt for
684 the input dialog.
685
686 *Syntax*:
687 -----------------
688 mark <identifier>
689 goto <identifier>
690 -----------------
691
692 *Examples*:
693 ---------------------------------------
694 # Read 1 character and mark the current window with this character
695 bindsym Mod1+m exec i3-input -p 'mark ' -l 1 -P 'Mark: '
696
697 # Read 1 character and go to the window with the character
698 bindsym Mod1+g exec i3-input -p 'goto ' -l 1 -P 'Goto: '
699 ---------------------------------------
700
701 === Traveling the focus stack
702
703 This mechanism can be thought of as the opposite of the +jump+ command. It travels
704 the focus stack and jumps to the window you focused before.
705
706 *Syntax*:
707 --------------
708 focus [number] | floating | tiling | ft
709 --------------
710
711 Where +number+ by default is 1 meaning that the next client in the focus stack will
712 be selected.
713
714 The special values have the following meaning:
715
716 floating::
717         The next floating window is selected.
718 tiling::
719         The next tiling window is selected.
720 ft::
721         If the current window is floating, the next tiling window will be selected
722         and vice-versa.
723
724 === Changing border style
725
726 To change the border of the current client, you can use +bn+ to use the normal
727 border (including window title), +bp+ to use a 1-pixel border (no window title)
728 and +bb+ to make the client borderless. There also is +bt+ which will toggle
729 the different border styles.
730
731 *Examples*:
732 ------------------
733 bindsym Mod1+t bn
734 bindsym Mod1+y bp
735 bindsym Mod1+u bb
736 ------------------
737
738 [[stack-limit]]
739
740 === Changing the stack-limit of a container
741
742 If you have a single container with a lot of windows inside (say, more than
743 10), the default layout of a stacking container can get a little unhandy.
744 Depending on your screen’s size, you might end up only using half of the
745 titlebars of each window in the container.
746
747 Using the +stack-limit+ command, you can limit the amount of rows or columns
748 in a stacking container. i3 will create columns or rows (depending on what
749 you limited) automatically as needed.
750
751 *Syntax*:
752 --------------------------------
753 stack-limit <cols|rows> <value>
754 --------------------------------
755
756 *Examples*:
757 -------------------
758 # I always want to have two window titles in one line
759 stack-limit cols 2
760
761 # Not more than 5 rows in this stacking container
762 stack-limit rows 5
763 -------------------
764
765 image:stacklimit.png[Container limited to two columns]
766
767 === Reloading/Restarting/Exiting
768
769 You can make i3 reload its configuration file with +reload+. You can also
770 restart i3 inplace with the +restart+ command to get it out of some weird state
771 (if that should ever happen) or to perform an upgrade without having to restart
772 your X session. However, your layout is not preserved at the moment, meaning
773 that all open windows will be in a single container in default layout. To exit
774 i3 properly, you can use the +exit+ command, however you don’t need to (e.g.,
775 simply killing your X session is fine aswell).
776
777 *Examples*:
778 ----------------------------
779 bindsym Mod1+Shift+r restart
780 bindsym Mod1+Shift+w reload
781 bindsym Mod1+Shift+e exit
782 ----------------------------
783
784 == Multiple monitors
785
786 [[multi_monitor]]
787
788 As you can read in the goal list on its website, i3 was specifically developed
789 with support for multiple monitors in mind. This section will explain how to
790 handle multiple monitors.
791
792 When you have only one monitor, things are simple. You usually start with
793 workspace 1 on your monitor and open new ones as you need them.
794
795 When you have more than one monitor, each monitor will get an initial
796 workspace, say the first gets 1, the second gets 2 and a possible third would
797 get 3. When you switch to a workspace on a different screen, i3 will switch
798 to that screen and then switch to the workspace. This way, you don’t need
799 shortcuts to switch to a specific screen and remember where you put which
800 workspace. New workspaces will be opened on the screen you currently are on.
801 There is no possiblity to have a screen without workspaces.
802
803 The idea to make workspaces global is due to the observation that most users
804 have a very limited set of workspaces on their additional monitors, often
805 using them for a specific task (browser, shell) or for monitoring several
806 things (mail, IRC, syslog, …). Thus, using one workspace on one monitor and
807 "the rest" on the other monitors often makes sense. However, as you can
808 create unlimited workspaces in i3 and tie them to specific screens, you can
809 have the "traditional" approach of having X workspaces per screen by
810 changing your configuration (using modes, for example).
811
812 === Configuring your monitors
813
814 To help you get going if you never used multiple monitors before, here comes a
815 short overview of the xrandr options which are probably of interest for you.
816 It is always useful to get an overview of the current screen configuration, so
817 just run "xrandr" and you will get an output like the following:
818 --------------------------------------------------------------------------------------
819 $ xrandr
820 Screen 0: minimum 320 x 200, current 1280 x 800, maximum 8192 x 8192
821 VGA1 disconnected (normal left inverted right x axis y axis)
822 LVDS1 connected 1280x800+0+0 (normal left inverted right x axis y axis) 261mm x 163mm
823    1280x800       60.0*+   50.0
824    1024x768       85.0     75.0     70.1     60.0
825    832x624        74.6
826    800x600        85.1     72.2     75.0     60.3     56.2
827    640x480        85.0     72.8     75.0     59.9
828    720x400        85.0
829    640x400        85.1
830    640x350        85.1
831 --------------------------------------------------------------------------------------
832
833 Several things are important here: You can see that +LVDS1+ is connected (of
834 course, it is the internal flat panel) but +VGA1+ is not. If you have connected
835 a monitor to one of the ports but xrandr still says "disconnected", you should
836 check your cable, monitor or graphics driver.
837
838 Furthermore, the maximum resolution you can see at the end of the first line
839 is the maximum combined resolution of your monitors. By default, it is usually
840 too low and has to be increased by editing +/etc/X11/xorg.conf+.
841
842 So, say you connected VGA1 and want to use it as an additional screen:
843 -------------------------------------------
844 xrandr --output VGA1 --auto --left-of LVDS1
845 -------------------------------------------
846 This command makes xrandr try to find out the native resolution of the device
847 connected to +VGA1+ and configures it to the left of your internal flat panel.
848 When running "xrandr" again, the output looks like this:
849 -----------------------------------------------------------------------------------------
850 $ xrandr
851 Screen 0: minimum 320 x 200, current 2560 x 1024, maximum 8192 x 8192
852 VGA1 connected 1280x1024+0+0 (normal left inverted right x axis y axis) 338mm x 270mm
853    1280x1024      60.0*+   75.0
854    1280x960       60.0
855    1152x864       75.0
856    1024x768       75.1     70.1     60.0
857    832x624        74.6
858    800x600        72.2     75.0     60.3     56.2
859    640x480        72.8     75.0     66.7     60.0
860    720x400        70.1
861 LVDS1 connected 1280x800+1280+0 (normal left inverted right x axis y axis) 261mm x 163mm
862    1280x800       60.0*+   50.0
863    1024x768       85.0     75.0     70.1     60.0
864    832x624        74.6
865    800x600        85.1     72.2     75.0     60.3     56.2
866    640x480        85.0     72.8     75.0     59.9
867    720x400        85.0
868    640x400        85.1
869    640x350        85.1
870 -----------------------------------------------------------------------------------------
871 Please note that i3 uses exactly the same API as xrandr does, so it will see
872 only what you can see in xrandr.
873
874 See also <<presentations>> for more examples of multi-monitor setups.
875
876 === Interesting configuration for multi-monitor environments
877
878 There are several things to configure in i3 which may be interesting if you
879 have more than one monitor:
880
881 1. You can specify which workspace should be put on which screen. This will
882    allow you to have a different set of workspaces when starting than just
883    1 for the first monitor, 2 for the second and so on. See
884    <<workspace_screen>>.
885 2. If you want some applications to generally open on the bigger screen
886    (MPlayer, Firefox, …), you can assign them to a specific workspace, see
887    <<assign_workspace>>.
888 3. If you have many workspaces on many monitors, it might get hard to keep
889    track of which window you put where. Thus, you can use vim-like marks to
890    quickly switch between windows. See <<vim_like_marks>>.
891
892 == i3 and the rest of your software world
893
894 === Displaying a status line
895
896 A very common thing amongst users of exotic window managers is a status line at
897 some corner of the screen. It is an often superior replacement of the widget
898 approach you have in the task bar of a traditional desktop environment.
899
900 If you don’t already have your favorite way of generating such a status line
901 (self-written scripts, conky, …), then i3status is the recommended tool for
902 this task. It was written in C with the goal to use as little syscalls as
903 possible to reduce the time your CPU is waken up from sleep states.
904
905 Regardless of which application you use to generate the status line, you
906 want to make sure that the application does one of the following things:
907
908 1. Register as a dock window using EWMH hints. This will make i3 position the
909    window above the workspace bar but below every other client. This is the
910    recommended way, but for example in case of dzen2 you need to check out
911    the source of dzen2 from subversion, because the -dock option is not present
912    in the released versions.
913 2. Overlay the internal workspace bar. This method will not waste any space
914    in the workspace bar. However, it is a rather hackish way. Just configure
915    the output window to be over your workspace bar (say -x 200 and -y 780 if
916    your screen is 800 px height).
917
918 The planned solution for this problem is to make the workspace bar optional
919 and switch to dzen2 (for example) completely (it will contain the workspaces
920 then).
921
922 === Giving presentations (multi-monitor)
923
924 When giving a presentation, you typically want the audience to see what you see
925 on your screen and then go through a series of slides (if the presentation is
926 simple). For more complex presentations, you might want to have some notes
927 which only you can see on your screen, while the audience can only see the
928 slides.
929
930 [[presentations]]
931 ==== Case 1: everybody gets the same output
932 This is the rather easy case. You connect your computer to the video projector,
933 turn on both (computer and video projector) and configure your X server to
934 clone the internal flat panel of your computer to the video output:
935 -----------------------------------------------------
936 xrandr --output VGA1 --mode 1024x768 --same-as LVDS1
937 -----------------------------------------------------
938 i3 will then use the lowest common subset of screen resolutions, the rest of
939 your screen will be left untouched (so it will show the X background). So, in
940 our example, this would be 1024x768 (my notebook has 1280x800).
941
942 ==== Case 2: you can see more than your audience
943 This case is a bit harder. First of all, you should configure the VGA output
944 somewhere near your internal flat panel, say right of it:
945 -----------------------------------------------------
946 xrandr --output VGA1 --mode 1024x768 --right-of LVDS1
947 -----------------------------------------------------
948 Now, i3 will put a new workspace (depending on your settings) on the new screen
949 and you are in multi-monitor mode (see <<multi_monitor>>).
950
951 Because i3 is not a compositing window manager, there is no possibility to
952 display a window on two screens at the same time. Instead, you presentation
953 software needs to do this job (that is, open a window on each screen).