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 client.
 117
 118 Mod1+Shift+r::
 119 Restarts i3 in place (without losing any windows, but the layout).
 120
 121 Mod1+Shift+e::
 122 Exits i3.
 123
 124 == FILES
 125
 126 === ~/.i3/config
 127
 128 When starting, i3 looks for ~/.i3/config and loads the configuration. If ~/.i3/config is not found,
 129 i3 tries /etc/i3/config. You can specify a custom path using the -c option.
 130
 131 At the moment, you can specify only the path to your favorite terminal emulator, the font and keybindings.
 132
 133 At the moment, you have to bind to keycodes (find them out via xev(1)).
 134
 135 .Sample configuration
 136 -------------------------------------------------------------
 137 terminal /usr/bin/urxvt
 138 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 139
 140 # Start terminal (Mod1+Enter)
 141 bind Mod1+36 exec /usr/bin/urxvt
 142
 143 # Start dmenu (Mod1+v)
 144 bind Mod1+55 exec /usr/bin/dmenu_run
 145
 146 # Kill current client (Mod1+Shift+q)
 147 bind Mod1+Shift+24 kill
 148
 149 # Beamer on/off
 150 bind Mod1+73 exec /home/michael/toggle_beamer.sh
 151
 152 # Screen locking
 153 bind Mod1+68 exec /usr/bin/i3lock
 154
 155 # Restart i3 inplace (Mod1+Shift+r)
 156 bind Mod1+Shift+27 restart
 157
 158 # Exit i3 (Mod1+Shift+e)
 159 bind Mod1+Shift+26 exit
 160
 161 # Brightness
 162 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 163 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 164
 165 # Fullscreen (Mod1+f)
 166 bind Mod1+41 f
 167
 168 # Stacking (Mod1+h)
 169 bind Mod1+43 s
 170
 171 # Default (Mod1+e)
 172 bind Mod1+26 d
 173
 174 # Toggle tiling/floating of the current window (Mod1+Shift+Space)
 175 bind Mod1+Shift+65 t
 176
 177 # Go into the tiling layer / floating layer, depending on whether
 178 # the current window is tiling / floating (Mod1+t)
 179 bind Mod1+28 focus ft
 180
 181 # Focus (Mod1+j/k/l/;)
 182 bind Mod1+44 h
 183 bind Mod1+45 j
 184 bind Mod1+46 k
 185 bind Mod1+47 l
 186
 187 # Focus Container (Mod3+j/k/l/;)
 188 bind Mod3+44 wch
 189 bind Mod3+45 wcj
 190 bind Mod3+46 wck
 191 bind Mod3+47 wcl
 192
 193 # Snap (Mod1+Control+j/k/l/;)
 194 bind Mod1+Control+44 sh
 195 bind Mod1+Control+45 sj
 196 bind Mod1+Control+46 sk
 197 bind Mod1+Control+47 sl
 198
 199 # Move (Mod1+Shift+j/k/l/;)
 200 bind Mod1+Shift+44 mh
 201 bind Mod1+Shift+45 mj
 202 bind Mod1+Shift+46 mk
 203 bind Mod1+Shift+47 ml
 204
 205 # Move Container (Mod3+Shift+j/k/l/;)
 206 bind Mod3+Shift+44 wcmh
 207 bind Mod3+Shift+45 wcmj
 208 bind Mod3+Shift+46 wcmk
 209 bind Mod3+Shift+47 wcml
 210
 211 # Workspaces
 212 bind Mod1+10 1
 213 bind Mod1+11 2
 214 ...
 215
 216 # Move to Workspace
 217 bind Mod1+Shift+10 1
 218 bind Mod1+Shift+11 2
 219 ...
 220 -------------------------------------------------------------
 221
 222 === ~/.xsession
 223
 224 This file is where you should configure your locales and start i3. It is run by
 225 your login manager (xdm, slim, gdm, …) as soon as you login.
 226
 227 .Sample xsession
 228 -------------------------------------------------------------
 229 # Disable DPMS turning off the screen
 230 xset dpms force on
 231 xset s off
 232 # Disable bell
 233 xset -b
 234
 235 # Enforce correct locales from the beginning
 236 unset LC_COLLATE
 237 export LC_CTYPE=de_DE.UTF-8
 238 export LC_TIME=de_DE.UTF-8
 239 export LC_NUMERIC=de_DE.UTF-8
 240 export LC_MONETARY=de_DE.UTF-8
 241 export LC_MESSAGES=C
 242 export LC_PAPER=de_DE.UTF-8
 243 export LC_NAME=de_DE.UTF-8
 244 export LC_ADDRESS=de_DE.UTF-8
 245 export LC_TELEPHONE=de_DE.UTF-8
 246 export LC_MEASUREMENT=de_DE.UTF-8
 247 export LC_IDENTIFICATION=de_DE.UTF-8
 248
 249 # Enable core dumps in case something goes wrong
 250 ulimit -c unlimited
 251
 252 # Start i3 and log to ~/.i3/logfile
 253 echo "Starting at $(date)" >> ~/.i3/logfile
 254 exec /usr/bin/i3 >> ~/.i3/logfile
 255 -------------------------------------------------------------
 256
 257 == TODO
 258
 259 There is still lot of work to do. Please check our bugtracker for up-to-date information
 260 about tasks which are still not finished.
 261
 262 == AUTHOR
 263
 264 Michael Stapelberg and contributors