]> git.sur5r.net Git - i3/i3.github.io/blob - index.html
82438d063dd20156c3a00d6e8abeb0bf0b34bd4d
[i3/i3.github.io] / index.html
1 ---
2 layout: default
3 title: Your New Jekyll Site
4 ---
5
6 <div id="info" class="clearfix">
7
8     <div id="screens">
9         <a href="/screenshots/" title="view more screenshots of i3">
10         <img id="screenshot" src="/screenshots/i3-9.bigthumb.png" width="375" height="234" alt="i3 screenshot"
11          srcset="/screenshots/i3-12.bigthumb.jpg 2x">
12         </a>
13     </div>
14
15     <h2>Do What I Mean. Good Docs. Clean Code. Sounds good?</h2>
16     <p>
17     Then you will love i3. Watch the <a href="/screenshots/">screencast</a>,<br>
18     read the <a href="/docs/userguide.html">User’s Guide</a> and <a
19     href="/downloads/">install i3</a>!
20     </p>
21     <div id="download">
22         <a href="/downloads">
23         <span style="font-weight: bold; color: #3A8ECD; margin-right: .5em">➡</span>
24         Download the latest version
25         <span style="margin-left: 2em; color: #c0c0c0">4.10.4</span>
26         </a>
27     </div>
28 </div>
29
30 <div id="content">
31 <p>
32 i3 is a <a href="http://en.wikipedia.org/wiki/Tiling_window_manager">tiling
33 window manager</a>, completely written from scratch. The target platforms are
34 GNU/Linux and BSD operating systems, our code is Free and Open Source Software
35 (FOSS) under the BSD license. i3 is primarily targeted at advanced users and
36 developers. Based upon the experiences we made when wanting to hack/fix wmii,
37 we agreed upon the following goals for i3:
38 </p> 
39  
40 <ol> 
41   <li> 
42     Write well readable, well <strong>documented</strong> code. Create additional
43     documentation on how to extend i3 by explaining its internal workings.
44     <br /> 
45     This includes being modifiable by people who do know how to program but who are
46     not necessarily familiar with all of X11’s internals. That is, document why
47     things happen and when they happen so that the user gets a picture of the whole
48     process a Window Manager is responsible of by just reading the source code.
49   </li> 
50   <li> 
51     Use xcb as far as possible (it does not provide functions for some features
52     yet, like XKB) instead of Xlib. xcb has a much cleaner API and should be faster
53     in quite a lot of situations.
54   </li> 
55   <li> 
56     Implement multi-monitor correctly, that is by assigning each workspace to a
57     virtual screen. Especially make sure that attaching and detaching new monitors
58     like video projectors works during operation and does the right thing. Also
59     provide support for rotated monitors.
60   </li> 
61   <li> 
62     Use a tree as data structure. This allows for more flexible layouts than
63     the column-based approach used by other window managers.
64   </li> 
65   <li> 
66     Implement different modes, like in vim. You can use different keybindings
67     when in the 'resize' mode than when you are in the default mode, for
68     example.
69   </li> 
70   <li> 
71     Do <strong>not</strong> use programs such as autoconf/automake for configuration and
72     creating unreadable/broken makefiles. Instead, use a clean makefile which automatically
73     enables/disables features for specific platforms. Also, document the dependencies
74     properly, so that package maintainers have an easy job packaging i3.
75   </li> 
76   <li> 
77     Implement an IPC interface for other programs. Provide subscription to
78     certain events and accept commands.
79     <br /> 
80     This approach should be more lightweight than wmii’s usage of the 9P filesystem.
81     Furthermore, core functionality does not depend on a separate program, so that i3
82     runs faster, especially when your system is under load.
83   </li> 
84   <li> 
85     Be UTF-8 clean.
86   </li> 
87   <li> 
88     The usual elitism amongst minimal window managers: Don’t be bloated, don’t be fancy
89     (simple borders are the most decoration we want to have).
90     <br /> 
91     However, we do not enforce unnecessary limits such as a maximum amount of source lines
92     of code. If it needs to be a bit bigger, it will be.
93   </li> 
94 </ol> 
95  
96 </div>