3 Michael Stapelberg <michael+i3@stapelberg.de>
8 i3 - an improved dynamic, tiling window manager
18 i3 was created because wmii, our favorite window manager at the time, didn’t
19 provide some features we wanted (Xinerama done right, for example), had some
20 bugs, didn’t progress since quite some time and wasn’t easy to hack at all
21 (source code comments/documentation completely lacking). Still, we think the
22 wmii developers and contributors did a great job. Thank you for inspiring us to
25 Please be aware that i3 is primarily targeted at advanced users and developers.
27 === ABOUT THIS RELEASE
29 What you are using is i3.alpha. That means, it is a preview release, not yet fully
30 stable, may still contain bugs and the implementation of several behaviour is
31 subject to change. However, it should provide you with a pretty good picture of
32 how i3 will look in subsequent releases.
34 Please, use i3 and report all the bugs/problems you encounter by sending an
35 email to <michael+i3 at stapelberg.de>
40 A client is X11-speak for a window.
43 Your workspace is managed using a table. You can move windows around and create new columns
44 (move a client to the right) or rows (move it to the bottom) implicitly.
46 By "snapping" a client in a specific direction, you increase its colspan/rowspan.
49 A container contains a variable number of clients. Each cell of the table is a container.
51 Containers can be used in various modes. The default mode is called "default" and just
52 resizes each client equally so that it fits. The stacking mode is currently not implemented.
55 A workspace is a set of clients (technically speaking, it’s just a table). Other window
56 managers call this "Virtual Desktops".
58 In i3, each workspace is assigned to a specific virtual screen. By default, screen 1
59 has workspace 1, screen 2 has workspace 2 and so on… However, when you create a new
60 workspace (by simply switching to it), it’ll be assigned the screen you are currently
64 Using Xinerama, you can have an X11 screen spanning multiple real monitors. Furthermore,
65 you can set them up in cloning mode or with positions (monitor 1 is left of monitor 2).
67 A virtual screen is the result of your Xinerama setup. For example, if you have attached
68 two real monitors (let’s say your laptop screen and a beamer) and enabled cloning, i3
69 will use one virtual screen with the size of the smallest screen you have attached (so
70 that you can see all your windows on each screen all the time).
71 If you have two monitors attached, one configured to be left of the other, i3 will use
76 Here is a short overview of the default keybindings:
79 Direction keys (left, down, up, right). They are on your homerow (see the mark on your "j" key).
82 Focus window in <direction>.
85 Focus container in <direction>.
87 Mod1+Shift+<direction>::
88 Move window to <direction>.
90 Mod3+Shift+<direction>::
91 Move container to <direction>.
93 Mod1+Control+<direction>::
94 Snap container to <direction>.
97 Switch to workspace <number>.
100 Move window to workspace <number>.
103 Toggle fullscreen mode.
106 Enable stacking layout for the current container.
109 Enable default layout for the current container.
115 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
116 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
118 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
120 At the moment, you have to bind to keycodes (find them out via xev(1)).
122 .Sample configuration
123 -------------------------------------------------------------
124 terminal /usr/bin/urxvt
125 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
127 # Start terminal (Mod1+Enter)
128 bind Mod1+36 exec /usr/bin/urxvt
130 # Start dmenu (Mod1+v)
131 bind Mod1+55 exec /usr/bin/dmenu_run
134 bind Mod1+73 exec /home/michael/toggle_beamer.sh
137 bind Mod1+68 exec /usr/bin/i3lock
140 bind Mod1+Shift+27 restart
143 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
144 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
153 # Focus (Mod1+j/k/l/;)
159 # Focus Container (Mod3+j/k/l/;)
165 # Snap (Mod1+Control+j/k/l/;)
166 bind Mod1+Control+44 sh
167 bind Mod1+Control+45 sj
168 bind Mod1+Control+46 sk
169 bind Mod1+Control+47 sl
171 # Move (Mod1+Shift+j/k/l/;)
172 bind Mod1+Shift+44 mh
173 bind Mod1+Shift+45 mj
174 bind Mod1+Shift+46 mk
175 bind Mod1+Shift+47 ml
177 # Move Container (Mod3+Shift+j/k/l/;)
178 bind Mod3+Shift+44 wcmh
179 bind Mod3+Shift+45 wcmj
180 bind Mod3+Shift+46 wcmk
181 bind Mod3+Shift+47 wcml
192 -------------------------------------------------------------
196 This file is where you should configure your locales and start i3. It is run by
197 your login manager (xdm, slim, gdm, …) as soon as you login.
200 -------------------------------------------------------------
201 # Disable DPMS turning off the screen
207 # Enforce correct locales from the beginning
209 export LC_CTYPE=de_DE.UTF-8
210 export LC_TIME=de_DE.ISO8859-15
211 export LC_NUMERIC=de_DE.ISO8859-15
212 export LC_MONETARY=de_DE.ISO8859-15
214 export LC_PAPER=de_DE.ISO8859-15
215 export LC_NAME=de_DE.ISO8859-15
216 export LC_ADDRESS=de_DE.ISO8859-15
217 export LC_TELEPHONE=de_DE.ISO8859-15
218 export LC_MEASUREMENT=de_DE.ISO8859-15
219 export LC_IDENTIFICATION=de_DE.ISO8859-15
221 # Enable core dumps in case something goes wrong
224 # Start i3 and log to ~/.i3/logfile
225 echo "Starting at $(date)" >> ~/.i3/logfile
226 exec /usr/bin/i3 >> ~/.i3/logfile
227 -------------------------------------------------------------
231 There is lots of stuff left to do. This release is to be considered as a technology preview.
232 Here is an overwiew of the most important points:
236 * do something about applications which don’t use _NET_WM_STATE_FULLSCREEN (like xpdf)
240 Michael Stapelberg and contributors