git.sur5r.net Git - i3/i3/blob - website/index.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
   4 <head>
   5 <title>i3 - an improved dynamic tiling window manager</title>
   6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   7 <meta name="description" content="i3 is a dynamic tiling window manager with clean, readable and documented code, featuring extended Xinerama support, usage of libxcb instead of xlib and several improvements over wmii" />
   8 <meta name="keywords" content="i3, window, manager, tiling, keyboard, wmii, x11, xcb, xinerama, utf8" />
   9 <meta name="author" content="i3 developers" />
  10 <style type="text/css">
  11 body {
  12         text-align: justify;
  13         max-width: 800px;
  14 }
  15
  16 li {
  17         margin-bottom: 10px;
  18 }
  19 #menu {
  20         overflow: hidden;
  21         list-style-type: none;
  22 }
  23 #menu li {
  24         margin-left: 30px;
  25         margin-right: 30px;
  26         float: left;
  27 }
  28
  29 </style>
  30 </head>
  31 <body>
  32
  33 <h1>i3 - an improved dynamic tiling window manager</h1>
  34
  35 <ul id="menu">
  36   <li>
  37     <a href="/">Goals</a>
  38   </li>
  39   <li>
  40     <a href="/docs/">Documentation</a>
  41   </li>
  42   <li>
  43     <a href="/downloads/">Downloads</a>
  44   </li>
  45   <li>
  46     <a href="/screenshots/">Screenshots</a>
  47   </li>
  48   <li>
  49     <a href="/bugs">Bugtracker</a>
  50   </li>
  51   <li>
  52     <a href="/contact/">Contact</a>
  53   </li>
  54   <li>
  55     <a href="/impress.html">Impressum/Imprint</a>
  56   </li>
  57 </ul>
  58
  59 <p>
  60   i3 was created because wmii, our favorite window manager at the time, didn’t
  61   provide some features we wanted (Xinerama done right, for example), had some
  62   bugs, didn’t progress since quite some time and wasn’t easy to hack at all
  63   (source code comments/documentation completely lacking). Still, we think the
  64   wmii developers and contributors did a great job. Thank you for inspiring us
  65   to create i3.
  66 </p>
  67
  68 <p>
  69   Please be aware that i3 is primarily targeted at advanced users and developers.
  70 </p>
  71
  72 <h2>Goals</h2>
  73
  74 <p>
  75   Based upon the experiences we made when wanting to hack/fix wmii, we agreed
  76   upon the following goals for i3:
  77 </p>
  78
  79 <ol>
  80   <li>
  81     Write well readable, well <strong>documented</strong> code. Create additional
  82     documentation on how to extend i3 by explaining its internal workings.
  83     <br />
  84     This includes being modifyable by people who do know how to program but who are
  85     not necessarily familiar with all of X11’s internals. That is, document why
  86     things happen and when they happen so that the user gets a picture of the whole
  87     process a Window Manager is responsible of by just reading the source code.
  88   </li>
  89   <li>
  90     Use xcb as far as possible (it does not provide functions for some features
  91     yet, like XKB) instead of Xlib. xcb has a much cleaner API and should be faster
  92     in quite a lot of situations.
  93   </li>
  94   <li>
  95     Implement Xinerama correctly, that is by assigning each workspace to a
  96     virtual screen. Especially make sure that attaching and detaching new monitors
  97     like video projectors works during operation and does the right thing.
  98   </li>
  99   <li>
 100     Use the metaphor of a table for abstraction. You can create horizontal and
 101     vertical columns (in wmii, you can only create vertical columns). See the documentation
 102     for more information on how this works, it really is an important principle in i3.
 103     (TODO: documentation :-))
 104   </li>
 105   <li>
 106     Implement a command mode, like in vim. You can easily combine multiple
 107     actions (like focusing, moving, snapping) by using the command mode.
 108   </li>
 109   <li>
 110     Implement XRandR support for flipping monitors.
 111   </li>
 112   <li>
 113     Do <strong>not</strong> use programs such as autoconf/automake for configuration and
 114     creating unreadable/broken makefiles. Instead, use a clean makefile which automatically
 115     enables/disables features for specific platforms. Also, document the dependencies
 116     properly, so that package maintainers have an easy job packaging i3.
 117   </li>
 118   <li>
 119     Provide hooks/callbacks for other programs to integrate. Using this mechanism, one
 120     can easily extend i3 in whatever language, without ever touching the C code. Also,
 121     to communicate with a running i3 instance, messages can be sent.
 122     <br />
 123     This approach should be more lightweight than wmii’s usage of the 9P filesystem.
 124     Furthermore, core functionality does not depend on a separate program, so that i3
 125     runs faster, especially when your system is under load.
 126   </li>
 127   <li>
 128     Be UTF-8 clean.
 129   </li>
 130   <li>
 131     The usual elitism amongst minimal window managers: Don’t be bloated, don’t be fancy
 132     (simple borders are the most decoration we want to have), don’t add support for Xft
 133     and blurred fonts.
 134     <br />
 135     However, we do not enforce unnecessary limits such as a maximum amount of source lines
 136     of code. If it needs to be a bit bigger, it will be.
 137   </li>
 138 </ol>
 139
 140 <h3>Special Features</h3>
 141
 142 <ul>
 143   <li>
 144     We can bind on Mode_switch (Alt Gr). Other window managers fail to do that because
 145     of an X11-bug, which causes the modifier state to not be correctly set in KeyPress-
 146     events. We use XKB for making sure to get the correct state.
 147   </li>
 148 </ul>
 149
 150 <h2>Development</h2>
 151
 152 <p>
 153   i3 is currently developed at <a href="http://code.stapelberg.de/git/i3" title="cgit">
 154   http://code.stapelberg.de/git/i3</a>. Checkouts of the master branch are intended to
 155   be stable and working all the time. Integration of new features happens in a separate branch.
 156 </p>
 157
 158 <h2>License</h2>
 159
 160 <pre>
 161 Copyright © 2009, Michael Stapelberg
 162 All rights reserved.
 163
 164 Redistribution and use in source and binary forms, with or without
 165 modification, are permitted provided that the following conditions are met:
 166
 167     * Redistributions of source code must retain the above copyright
 168       notice, this list of conditions and the following disclaimer.
 169
 170     * Redistributions in binary form must reproduce the above copyright
 171       notice, this list of conditions and the following disclaimer in the
 172       documentation and/or other materials provided with the distribution.
 173
 174     * Neither the name of Michael Stapelberg nor the
 175       names of contributors may be used to endorse or promote products
 176       derived from this software without specific prior written permission.
 177
 178 THIS SOFTWARE IS PROVIDED BY Michael Stapelberg ''AS IS'' AND ANY
 179 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 180 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 181 DISCLAIMED. IN NO EVENT SHALL Michael Stapelberg BE LIABLE FOR ANY
 182 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 183 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 184 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 185 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 186 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 187 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 188 </pre>
 189
 190 </body>
 191 </html>