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+q::
 110 Kills the current client.
 111
 112 Mod1+Shift+r::
 113 Restarts i3 in place (without losing any windows, but the layout).
 114
 115 Mod1+Shift+e::
 116 Exits i3.
 117
 118 == FILES
 119
 120 === ~/.i3/config
 121
 122 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
 123 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
 124
 125 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
 126
 127 At the moment, you have to bind to keycodes (find them out via xev(1)).
 128
 129 .Sample configuration
 130 -------------------------------------------------------------
 131 terminal /usr/bin/urxvt
 132 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 133
 134 # Start terminal (Mod1+Enter)
 135 bind Mod1+36 exec /usr/bin/urxvt
 136
 137 # Start dmenu (Mod1+v)
 138 bind Mod1+55 exec /usr/bin/dmenu_run
 139
 140 # Kill current client (Mod1+Shift+q)
 141 bind Mod1+Shift+24 kill
 142
 143 # Beamer on/off
 144 bind Mod1+73 exec /home/michael/toggle_beamer.sh
 145
 146 # Screen locking
 147 bind Mod1+68 exec /usr/bin/i3lock
 148
 149 # Restart i3 inplace (Mod1+Shift+r)
 150 bind Mod1+Shift+27 restart
 151
 152 # Exit i3 (Mod1+Shift+e)
 153 bind Mod1+Shift+26 exit
 154
 155 # Brightness
 156 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 157 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 158
 159 # Fullscreen (Mod1+f)
 160 bind Mod1+41 f
 161
 162 # Stacking (Mod1+h)
 163 bind Mod1+43 s
 164
 165 # Default (Mod1+e)
 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.UTF-8
 226 export LC_NUMERIC=de_DE.UTF-8
 227 export LC_MONETARY=de_DE.UTF-8
 228 export LC_MESSAGES=C
 229 export LC_PAPER=de_DE.UTF-8
 230 export LC_NAME=de_DE.UTF-8
 231 export LC_ADDRESS=de_DE.UTF-8
 232 export LC_TELEPHONE=de_DE.UTF-8
 233 export LC_MEASUREMENT=de_DE.UTF-8
 234 export LC_IDENTIFICATION=de_DE.UTF-8
 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 still lot of work to do. Please check our bugtracker for up-to-date information
 247 about tasks which are still not finished.
 248
 249 == AUTHOR
 250
 251 Michael Stapelberg and contributors