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