git.sur5r.net Git - i3/i3/blob - docs/userguide

   1 i3 User’s Guide
   2 ===============
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 May 2009
   5
   6 This document contains all information you need to configuring and using the i3
   7 window manager. If it does not, please contact me on IRC, Jabber or E-Mail and
   8 I’ll help you out.
   9
  10 == Configuring i3
  11
  12 TODO: document the other options, implement variables before
  13
  14 terminal::
  15         Specifies the terminal emulator program you prefer. It will be started
  16         by default when you press Mod1+Enter, but you can overwrite this. Refer
  17         to it as +$terminal+ to keep things modular.
  18 font::
  19         Specifies the default font you want i3 to use. Use an X core font
  20         descriptor here, like
  21         +-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1+. You can
  22         use +xfontsel(1)+ to pick one.
  23
  24 === Keyboard bindings
  25
  26 TODO
  27
  28 *Syntax*:
  29 --------------------------------
  30 bind [Modifiers+]keycode command
  31 --------------------------------
  32
  33 *Examples*:
  34 --------------------------------
  35 # Fullscreen
  36 bind Mod1+41 f
  37
  38 # Restart
  39 bind Mod1+Shift+27 restart
  40 --------------------------------
  41
  42 Available Modifiers:
  43
  44 Mod1-Mod5, Shift, Control::
  45 Standard modifiers, see +xmodmap(1)+
  46
  47 Mode_switch::
  48 Unlike other window managers, i3 can use Mode_switch as a modifier. This allows
  49 you to remap capslock (for example) to Mode_switch and use it for both: typing
  50 umlauts or special characters 'and' having some comfortably reachable key
  51 bindings. For example, when typing, capslock+1 or capslock+2 for switching
  52 workspaces is totally convenient. Try it :-).
  53
  54 === Automatically putting clients on specific workspaces
  55
  56 It is recommended that you match on window classes whereever possible because
  57 some applications first create their window and then care about setting the
  58 correct title. Firefox with Vimperator comes to mind, as the window starts up
  59 being named Firefox and only when Vimperator is loaded, the title changes. As
  60 i3 will get the title as soon as the application maps the window (mapping means
  61 actually displaying it on the screen), you’d need to have to match on Firefox
  62 in this case.
  63
  64 *Syntax*:
  65 ----------------------------------------------------
  66 assign ["]window class[/window title]["] [→] workspace
  67 ----------------------------------------------------
  68
  69 *Examples*:
  70 ----------------------
  71 assign urxvt 2
  72 assign urxvt → 2
  73 assign "urxvt" → 2
  74 assign "urxvt/VIM" → 3
  75 ----------------------