]> git.sur5r.net Git - i3/i3/blob - man/i3.man
Use doxygen compatible comments
[i3/i3] / man / i3.man
1 i3(1)
2 =====
3 Michael Stapelberg <michael+i3@stapelberg.de>
4 v3.delta, November 2009
5
6 == NAME
7
8 i3 - an improved dynamic, tiling window manager
9
10 == SYNOPSIS
11
12 i3 [-c configfile] [-a]
13
14 == OPTIONS
15
16 -c::
17 Specifies an alternate configuration file path
18
19 -a::
20 Disables autostart.
21
22 == DESCRIPTION
23
24 === INTRODUCTION
25
26 i3 was created because wmii, our favorite window manager at the time, didn’t
27 provide some features we wanted (Xinerama done right, for example), had some
28 bugs, didn’t progress since quite some time and wasn’t easy to hack at all
29 (source code comments/documentation completely lacking). Still, we think the
30 wmii developers and contributors did a great job. Thank you for inspiring us to
31 create i3.
32
33 Please be aware that i3 is primarily targeted at advanced users and developers.
34
35 === TERMINOLOGY
36
37 Client::
38 A client is X11-speak for a window.
39
40 Table::
41 Your workspace is managed using a table. You can move windows around and create new columns
42 (move a client to the right) or rows (move it to the bottom) implicitly.
43 +
44 By "snapping" a client in a specific direction, you increase its colspan/rowspan.
45
46 Container::
47 A container contains a variable number of clients. Each cell of the table is a container.
48 +
49 Containers can be used in various modes. The default mode is called "default" and just
50 resizes each client equally so that it fits.
51
52 Workspace::
53 A workspace is a set of clients (technically speaking, it’s just a table). Other window
54 managers call this "Virtual Desktops".
55 +
56 In i3, each workspace is assigned to a specific virtual screen. By default, screen 1
57 has workspace 1, screen 2 has workspace 2 and so on… However, when you create a new
58 workspace (by simply switching to it), it’ll be assigned the screen you are currently
59 on.
60
61 Virtual Screen::
62 Using Xinerama, you can have an X11 screen spanning multiple real monitors. Furthermore,
63 you can set them up in cloning mode or with positions (monitor 1 is left of monitor 2).
64 +
65 A virtual screen is the result of your Xinerama setup. For example, if you have attached
66 two real monitors (let’s say your laptop screen and a video projector) and enabled cloning, i3
67 will use one virtual screen with the size of the smallest screen you have attached (so
68 that you can see all your windows on each screen all the time).
69 If you have two monitors attached, one configured to be left of the other, i3 will use
70 two virtual screens.
71
72 == KEYBINDINGS
73
74 Here is a short overview of the default keybindings:
75
76 j/k/l/;::
77 Direction keys (left, down, up, right). They are on your homerow (see the mark
78 on your "j" key). Alternatively, you can use the cursor keys.
79
80 Mod1+<direction>::
81 Focus window in <direction>.
82
83 Mod3+<direction>::
84 Focus container in <direction>.
85
86 Mod1+Shift+<direction>::
87 Move window to <direction>.
88
89 Mod3+Shift+<direction>::
90 Move container to <direction>.
91
92 Mod1+Control+<direction>::
93 Snap container to <direction>.
94
95 Mod1+<number>::
96 Switch to workspace <number>.
97
98 Mod1+Shift+<number>::
99 Move window to workspace <number>.
100
101 Mod1+f::
102 Toggle fullscreen mode.
103
104 Mod1+h::
105 Enable stacking layout for the current container.
106
107 Mod1+e::
108 Enable default layout for the current container.
109
110 Mod1+Shift+Space::
111 Toggle tiling/floating for the current window.
112
113 Mod1+t::
114 Select the first tiling window if the current window is floating and vice-versa.
115
116 Mod1+Shift+q::
117 Kills the current window. This is equivalent to "clicking on the close button", meaning a polite
118 request to the application to close this window. For example, Firefox will save its session
119 upon such a request. If the application does not support that, the window will be killed and
120 it depends on the application what happens.
121
122 Mod1+Shift+r::
123 Restarts i3 in place (without losing any windows, but the layout).
124
125 Mod1+Shift+e::
126 Exits i3.
127
128 == FILES
129
130 === ~/.i3/config
131
132 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
133 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
134
135 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
136
137 At the moment, you have to bind to keycodes (find them out via xev(1)).
138
139 .Sample configuration
140 -------------------------------------------------------------
141 terminal /usr/bin/urxvt
142 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
143
144 # Start terminal (Mod1+Enter)
145 bind Mod1+36 exec /usr/bin/urxvt
146
147 # Start dmenu (Mod1+v)
148 bind Mod1+55 exec /usr/bin/dmenu_run
149
150 # Kill current client (Mod1+Shift+q)
151 bind Mod1+Shift+24 kill
152
153 # Beamer on/off
154 bind Mod1+73 exec /home/michael/toggle_beamer.sh
155
156 # Screen locking
157 bind Mod1+68 exec /usr/bin/i3lock
158
159 # Restart i3 inplace (Mod1+Shift+r)
160 bind Mod1+Shift+27 restart
161
162 # Exit i3 (Mod1+Shift+e)
163 bind Mod1+Shift+26 exit
164
165 # Brightness
166 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
167 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
168
169 # Fullscreen (Mod1+f)
170 bind Mod1+41 f
171
172 # Stacking (Mod1+h)
173 bind Mod1+43 s
174
175 # Default (Mod1+e)
176 bind Mod1+26 d
177
178 # Toggle tiling/floating of the current window (Mod1+Shift+Space)
179 bind Mod1+Shift+65 t
180
181 # Go into the tiling layer / floating layer, depending on whether
182 # the current window is tiling / floating (Mod1+t)
183 bind Mod1+28 focus ft
184
185 # Focus (Mod1+j/k/l/;)
186 bind Mod1+44 h
187 bind Mod1+45 j
188 bind Mod1+46 k
189 bind Mod1+47 l
190
191 # Focus Container (Mod3+j/k/l/;)
192 bind Mod3+44 wch
193 bind Mod3+45 wcj
194 bind Mod3+46 wck
195 bind Mod3+47 wcl
196
197 # Snap (Mod1+Control+j/k/l/;)
198 bind Mod1+Control+44 sh
199 bind Mod1+Control+45 sj
200 bind Mod1+Control+46 sk
201 bind Mod1+Control+47 sl
202
203 # Move (Mod1+Shift+j/k/l/;)
204 bind Mod1+Shift+44 mh
205 bind Mod1+Shift+45 mj
206 bind Mod1+Shift+46 mk
207 bind Mod1+Shift+47 ml
208
209 # Move Container (Mod3+Shift+j/k/l/;)
210 bind Mod3+Shift+44 wcmh
211 bind Mod3+Shift+45 wcmj
212 bind Mod3+Shift+46 wcmk
213 bind Mod3+Shift+47 wcml
214
215 # Workspaces
216 bind Mod1+10 1
217 bind Mod1+11 2
218 ...
219
220 # Move to Workspace
221 bind Mod1+Shift+10 1
222 bind Mod1+Shift+11 2
223 ...
224 -------------------------------------------------------------
225
226 === ~/.xsession
227
228 This file is where you should configure your locales and start i3. It is run by
229 your login manager (xdm, slim, gdm, …) as soon as you login.
230
231 .Sample xsession
232 -------------------------------------------------------------
233 # Disable DPMS turning off the screen
234 xset dpms force on
235 xset s off
236
237 # Disable bell
238 xset -b
239
240 # Enable zapping (C-A-<Bksp> kills X)
241 setxkbmap -option terminate:ctrl_alt_bksp
242
243 # Enforce correct locales from the beginning
244 unset LC_COLLATE
245 export LC_CTYPE=de_DE.UTF-8
246 export LC_TIME=de_DE.UTF-8
247 export LC_NUMERIC=de_DE.UTF-8
248 export LC_MONETARY=de_DE.UTF-8
249 export LC_MESSAGES=C
250 export LC_PAPER=de_DE.UTF-8
251 export LC_NAME=de_DE.UTF-8
252 export LC_ADDRESS=de_DE.UTF-8
253 export LC_TELEPHONE=de_DE.UTF-8
254 export LC_MEASUREMENT=de_DE.UTF-8
255 export LC_IDENTIFICATION=de_DE.UTF-8
256
257 # Use XToolkit in java applications
258 export AWT_TOOLKIT=XToolkit
259
260 # Set background color
261 xsetroot -solid "#333333"
262
263 # Enable core dumps in case something goes wrong
264 ulimit -c unlimited
265
266 # Start i3 and log to ~/.i3/logfile
267 echo "Starting at $(date)" >> ~/.i3/logfile
268 exec /usr/bin/i3 >> ~/.i3/logfile
269 -------------------------------------------------------------
270
271 == TODO
272
273 There is still lot of work to do. Please check our bugtracker for up-to-date information
274 about tasks which are still not finished.
275
276 == SEE ALSO
277
278 You should have a copy of the userguide (featuring nice screenshots/graphics which is why this
279 is not integrated into this manpage), the debugging guide and the "how to hack" guide. If you
280 are building from source, run +make -C docs+.
281
282 You can also access these documents online at http://i3.zekjur.net/
283
284 == AUTHOR
285
286 Michael Stapelberg and contributors