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

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