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 (according to the XDG specification)
 147 2. ~/.i3/config
 148 3. /etc/i3/config
 149
 150 You can specify a custom path using the -c option.
 151
 152 .Sample configuration
 153 -------------------------------------------------------------
 154 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 155
 156 # Start terminal (Mod1+Enter)
 157 bind Mod1+36 exec /usr/bin/urxvt
 158
 159 # Start dmenu (Mod1+v)
 160 bind Mod1+55 exec /usr/bin/dmenu_run
 161
 162 # Kill current client (Mod1+Shift+q)
 163 bind Mod1+Shift+24 kill
 164
 165 # Beamer on/off
 166 bind Mod1+73 exec /home/michael/toggle_beamer.sh
 167
 168 # Screen locking
 169 bind Mod1+68 exec /usr/bin/i3lock
 170
 171 # Restart i3 inplace (Mod1+Shift+r)
 172 bind Mod1+Shift+27 restart
 173
 174 # Exit i3 (Mod1+Shift+e)
 175 bind Mod1+Shift+26 exit
 176
 177 # Brightness
 178 bind Mod1+97 exec sudo sh -c "echo up > /proc/acpi/ibm/brightness"
 179 bind Mod1+103 exec sudo sh -c "echo down > /proc/acpi/ibm/brightness"
 180
 181 # Fullscreen (Mod1+f)
 182 bind Mod1+41 f
 183
 184 # Stacking (Mod1+h)
 185 bind Mod1+43 s
 186
 187 # Default (Mod1+e)
 188 bind Mod1+26 d
 189
 190 # Toggle tiling/floating of the current window (Mod1+Shift+Space)
 191 bind Mod1+Shift+65 t
 192
 193 # Go into the tiling layer / floating layer, depending on whether
 194 # the current window is tiling / floating (Mod1+t)
 195 bind Mod1+28 focus ft
 196
 197 # Focus (Mod1+j/k/l/;)
 198 bind Mod1+44 h
 199 bind Mod1+45 j
 200 bind Mod1+46 k
 201 bind Mod1+47 l
 202
 203 # Focus Container (Mod3+j/k/l/;)
 204 bind Mod3+44 wch
 205 bind Mod3+45 wcj
 206 bind Mod3+46 wck
 207 bind Mod3+47 wcl
 208
 209 # Snap (Mod1+Control+j/k/l/;)
 210 bind Mod1+Control+44 sh
 211 bind Mod1+Control+45 sj
 212 bind Mod1+Control+46 sk
 213 bind Mod1+Control+47 sl
 214
 215 # Move (Mod1+Shift+j/k/l/;)
 216 bind Mod1+Shift+44 mh
 217 bind Mod1+Shift+45 mj
 218 bind Mod1+Shift+46 mk
 219 bind Mod1+Shift+47 ml
 220
 221 # Move Container (Mod3+Shift+j/k/l/;)
 222 bind Mod3+Shift+44 wcmh
 223 bind Mod3+Shift+45 wcmj
 224 bind Mod3+Shift+46 wcmk
 225 bind Mod3+Shift+47 wcml
 226
 227 # Workspaces
 228 bind Mod1+10 1
 229 bind Mod1+11 2
 230 ...
 231
 232 # Move to Workspace
 233 bind Mod1+Shift+10 1
 234 bind Mod1+Shift+11 2
 235 ...
 236 -------------------------------------------------------------
 237
 238 === ~/.xsession
 239
 240 This file is where you should configure your locales and start i3. It is run by
 241 your login manager (xdm, slim, gdm, …) as soon as you login.
 242
 243 .Sample xsession
 244 -------------------------------------------------------------
 245 # Disable DPMS turning off the screen
 246 xset dpms force on
 247 xset s off
 248
 249 # Disable bell
 250 xset -b
 251
 252 # Enable zapping (C-A-<Bksp> kills X)
 253 setxkbmap -option terminate:ctrl_alt_bksp
 254
 255 # Enforce correct locales from the beginning
 256 unset LC_COLLATE
 257 export LC_CTYPE=de_DE.UTF-8
 258 export LC_TIME=de_DE.UTF-8
 259 export LC_NUMERIC=de_DE.UTF-8
 260 export LC_MONETARY=de_DE.UTF-8
 261 export LC_MESSAGES=C
 262 export LC_PAPER=de_DE.UTF-8
 263 export LC_NAME=de_DE.UTF-8
 264 export LC_ADDRESS=de_DE.UTF-8
 265 export LC_TELEPHONE=de_DE.UTF-8
 266 export LC_MEASUREMENT=de_DE.UTF-8
 267 export LC_IDENTIFICATION=de_DE.UTF-8
 268
 269 # Use XToolkit in java applications
 270 export AWT_TOOLKIT=XToolkit
 271
 272 # Set background color
 273 xsetroot -solid "#333333"
 274
 275 # Enable core dumps in case something goes wrong
 276 ulimit -c unlimited
 277
 278 # Start i3 and log to ~/.i3/logfile
 279 echo "Starting at $(date)" >> ~/.i3/logfile
 280 exec /usr/bin/i3 >> ~/.i3/logfile
 281 -------------------------------------------------------------
 282
 283 == TODO
 284
 285 There is still lot of work to do. Please check our bugtracker for up-to-date information
 286 about tasks which are still not finished.
 287
 288 == SEE ALSO
 289
 290 You should have a copy of the userguide (featuring nice screenshots/graphics which is why this
 291 is not integrated into this manpage), the debugging guide and the "how to hack" guide. If you
 292 are building from source, run +make -C docs+.
 293
 294 You can also access these documents online at http://i3.zekjur.net/
 295
 296 i3-input(1), i3-msg(1)
 297
 298 == AUTHOR
 299
 300 Michael Stapelberg and contributors