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

   1 i3(1)
   2 =====
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v3.alpha, February 2009
   5
   6 == NAME
   7
   8 i3 - an improved dynamic, tiling window manager
   9
  10 == SYNOPSIS
  11
  12 i3
  13
  14 == DESCRIPTION
  15
  16 === INTRODUCTION
  17
  18 TODO: write an introduction
  19
  20 === TERMINOLOGY
  21
  22 Client::
  23 A client is X11-speak for a window.
  24
  25 Table::
  26 Your workspace is managed using a table. You can move windows around and create new columns
  27 (move a client to the right) or rows (move it to the bottom) implicitly.
  28 +
  29 By "snapping" a client in a specific direction, you increase its colspan/rowspan.
  30
  31 Container::
  32 A container contains a variable number of clients. Each cell of the table is a container.
  33 +
  34 Containers can be used in various modes. The default mode is called "default" and just
  35 resizes each client equally so that it fits. The stacking mode is currently not implemented.
  36
  37 Workspace::
  38 A workspace is a set of clients (technically speaking, it’s just a table). Other window
  39 managers call this "Virtual Desktops".
  40 +
  41 In i3, each workspace is assigned to a specific virtual screen. By default, screen 1
  42 has workspace 1, screen 2 has workspace 2 and so on… However, when you create a new
  43 workspace (by simply switching to it), it’ll be assigned the screen you are currently
  44 on.
  45
  46 Virtual Screen::
  47 Using Xinerama, you can have an X11 screen spanning multiple real monitors. Furthermore,
  48 you can set them up in cloning mode or with positions (monitor 1 is left of monitor 2).
  49 +
  50 A virtual screen is the result of your Xinerama setup. For example, if you have attached
  51 two real monitors (let’s say your laptop screen and a beamer) and enabled cloning, i3
  52 will use one virtual screen with the size of the smallest screen you have attached (so
  53 that you can see all your windows on each screen all the time).
  54 If you have two monitors attached, one configured to be left of the other, i3 will use
  55 two virtual screens.
  56
  57 == KEYBINDINGS
  58
  59 h/j/k/l::
  60 Direction keys (left, down, up, right)
  61
  62 Mod1+<direction>::
  63 Focus window in <direction>.
  64
  65 Mod1+Shift+<direction>::
  66 Move window to <direction>.
  67
  68 Mod1+Ctrl+<direction>::
  69 Snap window to <direction>.
  70
  71 Mod1+<number>::
  72 Switch to workspace <number>.
  73
  74 == TODO
  75
  76 There is lots of stuff left to do. This release is to be considered as a technology preview.
  77 Here is an overwiew of the most important points:
  78
  79  * IPC
  80  * a command for toggling layouts/workspaces
  81  * floating
  82  * do something about applications which don’t use _NET_WM_STATE_FULLSCREEN (like xpdf)
  83
  84 == AUTHOR
  85
  86 Michael Stapelberg and contributors