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

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