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