]> code.delx.au - spectrwm/blob - README.md
start reworking wiki/front page
[spectrwm] / README.md
1 spectrwm
2 ========
3
4 spectrwm is a small dynamic tiling and reparenting window manager for X11. It
5 tries to stay out of the way so that valuable screen real estate can be used
6 for much more important stuff. It has sane defaults and does not require one to
7 learn a language to do any configuration. It is written by hackers for hackers
8 and it strives to be small, compact and fast.
9
10 It was largely inspired by [http://xmonad.org xmonad] and
11 [http://dwm.suckless.org dwm]. Both are fine products but suffer from things
12 like: crazy-unportable-language-syndrome, silly defaults, asymmetrical window
13 layout, "how hard can it be?" and good old NIH. Nevertheless
14 [http://dwm.suckless.org dwm] was a phenomenal resource and many good ideas and
15 code was borrowed from it. On the other hand [http://xmonad.org xmonad] has
16 great defaults, key bindings and xinerama support but is crippled by not being
17 written in C.
18
19 spectrwm is a beautiful pearl! For it too, was created by grinding irritation.
20 Nothing is a bigger waste of time than moving windows around until they are the
21 right size-ish or having just about any relevant key combination being eaten
22 for some task one never needs. The path of agony is too long to quote and in
23 classical [http://www.openbsd.org OpenBSD] fashion (put up, or hack up) a brand
24 new window manager was whooped up to serve no other purpose than to obey its
25 masters. It is released under the ISC license. Patches can be accepted provided
26 they are ISC licensed as well.
27
28 You can and come chat with us on IRC. We use https://www.oftc.net/ channel #spectrwm.
29
30 ## Major features
31 * Dynamic RandR support (multi-head)
32 * Navigation anywhere on all screens with either the keyboard or mouse
33 * Customizable status bar
34 * Human readable configuration file
35 * Restartable without losing state
36 * Quick launch menu
37 * Many screen layouts possible with a few simple key strokes
38 * Windows can be added or removed from master area
39 * Windows can be moved to any workspace or within a region
40 * Resizable master area
41 * Move/resize floating windows
42 * Drag-to-float
43 * Extended Window Manager Hints (EWMH) Support
44 * Configureable tiling
45 * Adjustable tile gap allows for a true one pixel border.
46 * Customizable colors and border width.
47 * User definable regions
48 * User definable modkey & key bindings
49 * User definable quirk bindings
50 * User definable key bindings to launch applications
51 * Multi OS support (*BSD, Linux, OSX, Windows/cygwin)
52 * Reparenting window manager
53
54 [https://github.com/conformal/spectrwm/wiki/Screenshots Mandatory screenshots can be found here.]
55
56 ## License
57
58 spectrwm is ISC licensed unless otherwise specified in individual files.