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

   1 i3(1)
   2 =====
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v3.alpha, March 2009
   5
   6 == NAME
   7
   8 i3 - an improved dynamic, tiling window manager
   9
  10 == SYNOPSIS
  11
  12 i3 [-c configfile]
  13
  14 == DESCRIPTION
  15
  16 === INTRODUCTION
  17
  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
  23 create i3.
  24
  25 Please be aware that i3 is primarily targeted at advanced users and developers.
  26
  27 === ABOUT THIS RELEASE
  28
  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.
  33
  34 Please, use i3 and report all the bugs/problems you encounter by sending an
  35 email to <michael+i3 at stapelberg.de>
  36
  37 === TERMINOLOGY
  38
  39 Client::
  40 A client is X11-speak for a window.
  41
  42 Table::
  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.
  45 +
  46 By "snapping" a client in a specific direction, you increase its colspan/rowspan.
  47
  48 Container::
  49 A container contains a variable number of clients. Each cell of the table is a container.
  50 +
  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.
  53
  54 Workspace::
  55 A workspace is a set of clients (technically speaking, it’s just a table). Other window
  56 managers call this "Virtual Desktops".
  57 +
  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
  61 on.
  62
  63 Virtual Screen::
  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).
  66 +
  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 video projector) 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
  72 two virtual screens.
  73
  74 == KEYBINDINGS
  75
  76 Here is a short overview of the default keybindings:
  77
  78 j/k/l/;::
  79 Direction keys (left, down, up, right). They are on your homerow (see the mark on your "j" key).
  80
  81 Mod1+<direction>::
  82 Focus window in <direction>.
  83
  84 Mod3+<direction>::
  85 Focus container in <direction>.
  86
  87 Mod1+Shift+<direction>::
  88 Move window to <direction>.
  89
  90 Mod3+Shift+<direction>::
  91 Move container to <direction>.
  92
  93 Mod1+Control+<direction>::
  94 Snap container to <direction>.
  95
  96 Mod1+<number>::
  97 Switch to workspace <number>.
  98
  99 Mod1+Shift+<number>::
 100 Move window to workspace <number>.
 101
 102 Mod1+f::
 103 Toggle fullscreen mode.
 104
 105 Mod1+s::
 106 Enable stacking layout for the current container.
 107
 108 Mod1+d::
 109 Enable default layout for the current container.
 110
 111 Mod1+Shift+q::
 112 Kills the current client.
 113
 114 Mod1+Shift+r::
 115 Restarts i3 in place (without losing any windows, but the layout).
 116
 117 Mod1+Shift+e::
 118 Exits i3.
 119
 120 == FILES
 121
 122 === ~/.i3/config
 123
 124 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
 125 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
 126
 127 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
 128
 129 At the moment, you have to bind to keycodes (find them out via xev(1)).
 130
 131 .Sample configuration
 132 -------------------------------------------------------------
 133 terminal /usr/bin/urxvt
 134 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 135
 136 # Start terminal (Mod1+Enter)
 137 bind Mod1+36 exec /usr/bin/urxvt
 138
 139 # Start dmenu (Mod1+v)
 140 bind Mod1+55 exec /usr/bin/dmenu_run
 141
 142 # Kill current client (Mod1+Shift+q)
 143 bind Mod1+Shift+24 kill
 144
 145 # Beamer on/off
 146 bind Mod1+73 exec /home/michael/toggle_beamer.sh
 147
 148 # Screen locking
 149 bind Mod1+68 exec /usr/bin/i3lock
 150
 151 # Restart i3 inplace (Mod1+Shift+r)
 152 bind Mod1+Shift+27 restart
 153
 154 # Exit i3 (Mod1+Shift+e)
 155 bind Mod1+Shift+26 exit
 156
 157 # Brightness
 158 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 159 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 160
 161 # Fullscreen
 162 bind Mod1+41 f
 163 # Stacking
 164 bind Mod1+43 s
 165 # Default
 166 bind Mod1+26 d
 167
 168 # Focus (Mod1+j/k/l/;)
 169 bind Mod1+44 h
 170 bind Mod1+45 j
 171 bind Mod1+46 k
 172 bind Mod1+47 l
 173
 174 # Focus Container (Mod3+j/k/l/;)
 175 bind Mod3+44 wch
 176 bind Mod3+45 wcj
 177 bind Mod3+46 wck
 178 bind Mod3+47 wcl
 179
 180 # Snap (Mod1+Control+j/k/l/;)
 181 bind Mod1+Control+44 sh
 182 bind Mod1+Control+45 sj
 183 bind Mod1+Control+46 sk
 184 bind Mod1+Control+47 sl
 185
 186 # Move (Mod1+Shift+j/k/l/;)
 187 bind Mod1+Shift+44 mh
 188 bind Mod1+Shift+45 mj
 189 bind Mod1+Shift+46 mk
 190 bind Mod1+Shift+47 ml
 191
 192 # Move Container (Mod3+Shift+j/k/l/;)
 193 bind Mod3+Shift+44 wcmh
 194 bind Mod3+Shift+45 wcmj
 195 bind Mod3+Shift+46 wcmk
 196 bind Mod3+Shift+47 wcml
 197
 198 # Workspaces
 199 bind Mod1+10 1
 200 bind Mod1+11 2
 201 ...
 202
 203 # Move to Workspace
 204 bind Mod1+Shift+10 1
 205 bind Mod1+Shift+11 2
 206 ...
 207 -------------------------------------------------------------
 208
 209 === ~/.xsession
 210
 211 This file is where you should configure your locales and start i3. It is run by
 212 your login manager (xdm, slim, gdm, …) as soon as you login.
 213
 214 .Sample xsession
 215 -------------------------------------------------------------
 216 # Disable DPMS turning off the screen
 217 xset dpms force on
 218 xset s off
 219 # Disable bell
 220 xset -b
 221
 222 # Enforce correct locales from the beginning
 223 unset LC_COLLATE
 224 export LC_CTYPE=de_DE.UTF-8
 225 export LC_TIME=de_DE.ISO8859-15
 226 export LC_NUMERIC=de_DE.ISO8859-15
 227 export LC_MONETARY=de_DE.ISO8859-15
 228 export LC_MESSAGES=C
 229 export LC_PAPER=de_DE.ISO8859-15
 230 export LC_NAME=de_DE.ISO8859-15
 231 export LC_ADDRESS=de_DE.ISO8859-15
 232 export LC_TELEPHONE=de_DE.ISO8859-15
 233 export LC_MEASUREMENT=de_DE.ISO8859-15
 234 export LC_IDENTIFICATION=de_DE.ISO8859-15
 235
 236 # Enable core dumps in case something goes wrong
 237 ulimit -c unlimited
 238
 239 # Start i3 and log to ~/.i3/logfile
 240 echo "Starting at $(date)" >> ~/.i3/logfile
 241 exec /usr/bin/i3 >> ~/.i3/logfile
 242 -------------------------------------------------------------
 243
 244 == TODO
 245
 246 There is lots of stuff left to do. This release is to be considered as a technology preview.
 247 Here is an overwiew of the most important points:
 248
 249  * IPC
 250  * floating
 251  * do something about applications which don’t use _NET_WM_STATE_FULLSCREEN (like xpdf)
 252
 253 == AUTHOR
 254
 255 Michael Stapelberg and contributors