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