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

   1 i3(1)
   2 =====
   3 Michael Stapelberg <michael@i3wm.org>
   4 v4.2, August 2012
   5
   6 == NAME
   7
   8 i3 - an improved dynamic, tiling window manager
   9
  10 == SYNOPSIS
  11
  12 i3 [-a] [-c configfile] [-C] [-d all] [-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 all::
  26 Enables debug logging.
  27 The 'all' parameter is present for historical reasons.
  28
  29 -v::
  30 Display version number (and date of the last commit).
  31
  32 -V::
  33 Be verbose.
  34
  35 == DESCRIPTION
  36
  37 === INTRODUCTION
  38
  39 i3 was created because wmii, our favorite window manager at the time, didn’t
  40 provide some features we wanted (multi-monitor done right, for example), had
  41 some bugs, didn’t progress since quite some time and wasn’t easy to hack at all
  42 (source code comments/documentation completely lacking). Still, we think the
  43 wmii developers and contributors did a great job. Thank you for inspiring us to
  44 create i3.
  45
  46 Please be aware that i3 is primarily targeted at advanced users and developers.
  47
  48 === IMPORTANT NOTE TO nVidia BINARY DRIVER USERS
  49
  50 If you are using the nVidia binary graphics driver (also known as 'blob')
  51 before version 302.17, you need to use the +--force-xinerama+ flag (in your
  52 ~/.xsession) when starting i3, like so:
  53
  54 ----------------------------------------------
  55 exec i3 --force-xinerama -V >>~/.i3/i3log 2>&1
  56 ----------------------------------------------
  57
  58 See also docs/multi-monitor for the full explanation.
  59
  60 === TERMINOLOGY
  61
  62 Tree::
  63 i3 keeps your layout in a tree data structure.
  64
  65 Window::
  66 An X11 window, like the Firefox browser window or a terminal emulator.
  67
  68 Split container::
  69 A split container contains multiple other split containers or windows.
  70 +
  71 Containers can be used in various layouts. The default mode is called "default"
  72 and just resizes each client equally so that it fits.
  73
  74 Workspace::
  75 A workspace is a set of containers. Other window managers call this "Virtual
  76 Desktops".
  77 +
  78 In i3, each workspace is assigned to a specific virtual screen. By default,
  79 screen 1 has workspace 1, screen 2 has workspace 2 and so on… However, when you
  80 create a new workspace (by simply switching to it), it’ll be assigned the
  81 screen you are currently on.
  82
  83 Output::
  84 Using XRandR, you can have an X11 screen spanning multiple real monitors.
  85 Furthermore, you can set them up in cloning mode or with positions (monitor 1
  86 is left of monitor 2).
  87 +
  88 i3 uses the RandR API to query which outputs are available and which screens
  89 are connected to these outputs.
  90
  91 == KEYBINDINGS
  92
  93 Here is a short overview of the default keybindings:
  94
  95 Mod1+Enter::
  96 Open a new terminal emulator window.
  97
  98 Mod1+d::
  99 Open dmenu for starting any application by typing (part of) its name.
 100
 101 j/k/l/;::
 102 Direction keys (left, down, up, right). They are on your homerow (see the mark
 103 on your "j" key). Alternatively, you can use the cursor keys.
 104
 105 Mod1+<direction>::
 106 Focus window in <direction>.
 107
 108 Mod1+Shift+<direction>::
 109 Move window to <direction>.
 110
 111 Mod1+<number>::
 112 Switch to workspace <number>.
 113
 114 Mod1+Shift+<number>::
 115 Move window to workspace <number>.
 116
 117 Mod1+f::
 118 Toggle fullscreen mode.
 119
 120 Mod1+s::
 121 Enable stacking layout for the current container.
 122
 123 Mod1+e::
 124 Enable default layout for the current container.
 125
 126 Mod1+w::
 127 Enable tabbed layout for the current container.
 128
 129 Mod1+Shift+Space::
 130 Toggle tiling/floating for the current container.
 131
 132 Mod1+Space::
 133 Select the first tiling container if the current container is floating and
 134 vice-versa.
 135
 136 Mod1+Shift+q::
 137 Kills the current window. This is equivalent to "clicking on the close button",
 138 meaning a polite request to the application to close this window. For example,
 139 Firefox will save its session upon such a request. If the application does not
 140 support that, the window will be killed and it depends on the application what
 141 happens.
 142
 143 Mod1+Shift+r::
 144 Restarts i3 in place. Your layout will be preserved.
 145
 146 Mod1+Shift+e::
 147 Exits i3.
 148
 149 == FILES
 150
 151 === \~/.i3/config (or ~/.config/i3/config)
 152
 153 When starting, i3 looks for configuration files in the following order:
 154
 155 1. ~/.config/i3/config (or $XDG_CONFIG_HOME/i3/config if set)
 156 2. /etc/xdg/i3/config (or $XDG_CONFIG_DIRS/i3/config if set)
 157 3. ~/.i3/config
 158 4. /etc/i3/config
 159
 160 You can specify a custom path using the -c option.
 161
 162 .Sample configuration
 163 -------------------------------------------------------------
 164 # i3 config file (v4)
 165
 166 # font for window titles. ISO 10646 = Unicode
 167 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 168
 169 # use Mouse+Mod1 to drag floating windows to their wanted position
 170 floating_modifier Mod1
 171
 172 # start a terminal
 173 bindsym Mod1+Return exec /usr/bin/urxvt
 174
 175 # kill focused window
 176 bindsym Mod1+Shift+q kill
 177
 178 # start dmenu (a program launcher)
 179 bindsym Mod1+d exec /usr/bin/dmenu_run
 180
 181 # change focus
 182 bindsym Mod1+j focus left
 183 bindsym Mod1+k focus down
 184 bindsym Mod1+l focus up
 185 bindsym Mod1+semicolon focus right
 186
 187 # alternatively, you can use the cursor keys:
 188 bindsym Mod1+Left focus left
 189 bindsym Mod1+Down focus down
 190 bindsym Mod1+Up focus up
 191 bindsym Mod1+Right focus right
 192
 193 # move focused window
 194 bindsym Mod1+Shift+j move left
 195 bindsym Mod1+Shift+k move down
 196 bindsym Mod1+Shift+l move up
 197 bindsym Mod1+Shift+semicolon move right
 198
 199 # alternatively, you can use the cursor keys:
 200 bindsym Mod1+Shift+Left move left
 201 bindsym Mod1+Shift+Down move down
 202 bindsym Mod1+Shift+Up move up
 203 bindsym Mod1+Shift+Right move right
 204
 205 # split in horizontal orientation
 206 bindsym Mod1+h split h
 207
 208 # split in vertical orientation
 209 bindsym Mod1+v split v
 210
 211 # enter fullscreen mode for the focused container
 212 bindsym Mod1+f fullscreen
 213
 214 # change container layout (stacked, tabbed, default)
 215 bindsym Mod1+s layout stacking
 216 bindsym Mod1+w layout tabbed
 217 bindsym Mod1+e layout default
 218
 219 # toggle tiling / floating
 220 bindsym Mod1+Shift+space floating toggle
 221
 222 # change focus between tiling / floating windows
 223 bindsym Mod1+space focus mode_toggle
 224
 225 # focus the parent container
 226 bindsym Mod1+a focus parent
 227
 228 # focus the child container
 229 #bindsym Mod1+d focus child
 230
 231 # switch to workspace
 232 bindsym Mod1+1 workspace 1
 233 bindsym Mod1+2 workspace 2
 234 # ..
 235
 236 # move focused container to workspace
 237 bindsym Mod1+Shift+1 move workspace 1
 238 bindsym Mod1+Shift+2 move workspace 2
 239 # ...
 240
 241 # reload the configuration file
 242 bindsym Mod1+Shift+c reload
 243 # restart i3 inplace (preserves your layout/session, can be used to upgrade i3)
 244 bindsym Mod1+Shift+r restart
 245 # exit i3 (logs you out of your X session)
 246 bindsym Mod1+Shift+e exit
 247
 248 # display workspace buttons plus a statusline generated by i3status
 249 bar {
 250     status_command i3status
 251 }
 252 -------------------------------------------------------------
 253
 254 === ~/.xsession
 255
 256 This file is where you should configure your locales and start i3. It is run by
 257 your login manager (xdm, slim, gdm, …) as soon as you login.
 258
 259 .Sample xsession
 260 -------------------------------------------------------------
 261 # Disable DPMS turning off the screen
 262 xset -dpms
 263 xset s off
 264
 265 # Disable bell
 266 xset -b
 267
 268 # Enable zapping (C-A-<Bksp> kills X)
 269 setxkbmap -option terminate:ctrl_alt_bksp
 270
 271 # Enforce correct locales from the beginning:
 272 # LC_ALL is unset since it overwrites everything
 273 # LANG=de_DE.UTF-8 is used, except for:
 274 # LC_MESSAGES=C never translates program output
 275 # LC_TIME=en_DK leads to yyyy-mm-dd hh:mm date/time output
 276 unset LC_ALL
 277 export LANG=de_DE.UTF-8
 278 export LC_MESSAGES=C
 279 export LC_TIME=en_DK.UTF-8
 280
 281 # Use XToolkit in java applications
 282 export AWT_TOOLKIT=XToolkit
 283
 284 # Set background color
 285 xsetroot -solid "#333333"
 286
 287 # Enable core dumps in case something goes wrong
 288 ulimit -c unlimited
 289
 290 # Start i3 and log to ~/.i3/logfile
 291 echo "Starting at $(date)" >> ~/.i3/logfile
 292 exec /usr/bin/i3 -V -d all >> ~/.i3/logfile
 293 -------------------------------------------------------------
 294
 295 == ENVIRONMENT
 296
 297 === I3SOCK
 298
 299 This variable overwrites the IPC socket path (placed in
 300 /tmp/i3-%u.XXXXXX/ipc-socket.%p by default, where %u is replaced with your UNIX
 301 username, %p is replaced with i3’s PID and XXXXXX is a string of random
 302 characters from the portable filename character set (see mkdtemp(3))). The IPC
 303 socket is used by external programs like i3-msg(1) or i3bar(1).
 304
 305 == TODO
 306
 307 There is still lot of work to do. Please check our bugtracker for up-to-date
 308 information about tasks which are still not finished.
 309
 310 == SEE ALSO
 311
 312 You should have a copy of the userguide (featuring nice screenshots/graphics
 313 which is why this is not integrated into this manpage), the debugging guide,
 314 and the "how to hack" guide. If you are building from source, run:
 315  +make -C docs+
 316
 317 You can also access these documents online at http://i3wm.org/
 318
 319 i3-input(1), i3-msg(1), i3-wsbar(1), i3-nagbar(1), i3-config-wizard(1),
 320 i3-migrate-config-to-v4(1)
 321
 322 == AUTHOR
 323
 324 Michael Stapelberg and contributors