git.sur5r.net Git - i3/i3/blob - man/i3.man

   1 i3(1)
   2 =====
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v3.beta, May 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 on your "j" key).
  78
  79 Mod1+<direction>::
  80 Focus window in <direction>.
  81
  82 Mod3+<direction>::
  83 Focus container in <direction>.
  84
  85 Mod1+Shift+<direction>::
  86 Move window to <direction>.
  87
  88 Mod3+Shift+<direction>::
  89 Move container to <direction>.
  90
  91 Mod1+Control+<direction>::
  92 Snap container to <direction>.
  93
  94 Mod1+<number>::
  95 Switch to workspace <number>.
  96
  97 Mod1+Shift+<number>::
  98 Move window to workspace <number>.
  99
 100 Mod1+f::
 101 Toggle fullscreen mode.
 102
 103 Mod1+h::
 104 Enable stacking layout for the current container.
 105
 106 Mod1+e::
 107 Enable default layout for the current container.
 108
 109 Mod1+Shift+Space::
 110 Toggle tiling/floating for the current window.
 111
 112 Mod1+t::
 113 Select the first tiling window if the current window is floating and vice-versa.
 114
 115 Mod1+Shift+q::
 116 Kills the current window. This is equivalent to "clicking on the close button", meaning a polite
 117 request to the application to close this window. For example, Firefox will save its session
 118 upon such a request. If the application does not support that, the window will be killed and
 119 it depends on the application what happens.
 120
 121 Mod1+Shift+r::
 122 Restarts i3 in place (without losing any windows, but the layout).
 123
 124 Mod1+Shift+e::
 125 Exits i3.
 126
 127 == FILES
 128
 129 === ~/.i3/config
 130
 131 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
 132 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
 133
 134 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
 135
 136 At the moment, you have to bind to keycodes (find them out via xev(1)).
 137
 138 .Sample configuration
 139 -------------------------------------------------------------
 140 terminal /usr/bin/urxvt
 141 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 142
 143 # Start terminal (Mod1+Enter)
 144 bind Mod1+36 exec /usr/bin/urxvt
 145
 146 # Start dmenu (Mod1+v)
 147 bind Mod1+55 exec /usr/bin/dmenu_run
 148
 149 # Kill current client (Mod1+Shift+q)
 150 bind Mod1+Shift+24 kill
 151
 152 # Beamer on/off
 153 bind Mod1+73 exec /home/michael/toggle_beamer.sh
 154
 155 # Screen locking
 156 bind Mod1+68 exec /usr/bin/i3lock
 157
 158 # Restart i3 inplace (Mod1+Shift+r)
 159 bind Mod1+Shift+27 restart
 160
 161 # Exit i3 (Mod1+Shift+e)
 162 bind Mod1+Shift+26 exit
 163
 164 # Brightness
 165 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 166 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 167
 168 # Fullscreen (Mod1+f)
 169 bind Mod1+41 f
 170
 171 # Stacking (Mod1+h)
 172 bind Mod1+43 s
 173
 174 # Default (Mod1+e)
 175 bind Mod1+26 d
 176
 177 # Toggle tiling/floating of the current window (Mod1+Shift+Space)
 178 bind Mod1+Shift+65 t
 179
 180 # Go into the tiling layer / floating layer, depending on whether
 181 # the current window is tiling / floating (Mod1+t)
 182 bind Mod1+28 focus ft
 183
 184 # Focus (Mod1+j/k/l/;)
 185 bind Mod1+44 h
 186 bind Mod1+45 j
 187 bind Mod1+46 k
 188 bind Mod1+47 l
 189
 190 # Focus Container (Mod3+j/k/l/;)
 191 bind Mod3+44 wch
 192 bind Mod3+45 wcj
 193 bind Mod3+46 wck
 194 bind Mod3+47 wcl
 195
 196 # Snap (Mod1+Control+j/k/l/;)
 197 bind Mod1+Control+44 sh
 198 bind Mod1+Control+45 sj
 199 bind Mod1+Control+46 sk
 200 bind Mod1+Control+47 sl
 201
 202 # Move (Mod1+Shift+j/k/l/;)
 203 bind Mod1+Shift+44 mh
 204 bind Mod1+Shift+45 mj
 205 bind Mod1+Shift+46 mk
 206 bind Mod1+Shift+47 ml
 207
 208 # Move Container (Mod3+Shift+j/k/l/;)
 209 bind Mod3+Shift+44 wcmh
 210 bind Mod3+Shift+45 wcmj
 211 bind Mod3+Shift+46 wcmk
 212 bind Mod3+Shift+47 wcml
 213
 214 # Workspaces
 215 bind Mod1+10 1
 216 bind Mod1+11 2
 217 ...
 218
 219 # Move to Workspace
 220 bind Mod1+Shift+10 1
 221 bind Mod1+Shift+11 2
 222 ...
 223 -------------------------------------------------------------
 224
 225 === ~/.xsession
 226
 227 This file is where you should configure your locales and start i3. It is run by
 228 your login manager (xdm, slim, gdm, …) as soon as you login.
 229
 230 .Sample xsession
 231 -------------------------------------------------------------
 232 # Disable DPMS turning off the screen
 233 xset dpms force on
 234 xset s off
 235 # Disable bell
 236 xset -b
 237
 238 # Enforce correct locales from the beginning
 239 unset LC_COLLATE
 240 export LC_CTYPE=de_DE.UTF-8
 241 export LC_TIME=de_DE.UTF-8
 242 export LC_NUMERIC=de_DE.UTF-8
 243 export LC_MONETARY=de_DE.UTF-8
 244 export LC_MESSAGES=C
 245 export LC_PAPER=de_DE.UTF-8
 246 export LC_NAME=de_DE.UTF-8
 247 export LC_ADDRESS=de_DE.UTF-8
 248 export LC_TELEPHONE=de_DE.UTF-8
 249 export LC_MEASUREMENT=de_DE.UTF-8
 250 export LC_IDENTIFICATION=de_DE.UTF-8
 251
 252 # Set background color
 253 xsetroot -solid "#333333"
 254
 255 # Enable core dumps in case something goes wrong
 256 ulimit -c unlimited
 257
 258 # Start i3 and log to ~/.i3/logfile
 259 echo "Starting at $(date)" >> ~/.i3/logfile
 260 exec /usr/bin/i3 >> ~/.i3/logfile
 261 -------------------------------------------------------------
 262
 263 == TODO
 264
 265 There is still lot of work to do. Please check our bugtracker for up-to-date information
 266 about tasks which are still not finished.
 267
 268 == SEE ALSO
 269
 270 You should have a copy of the userguide (featuring nice screenshots/graphics which is why this
 271 is not integrated into this manpage), the debugging guide and the "how to hack" guide. If you
 272 are building from source, run +make -C docs+.
 273
 274 You can also access these documents online at http://i3.zekjur.net/
 275
 276 == AUTHOR
 277
 278 Michael Stapelberg and contributors