]> code.delx.au - spectrwm/blob - README.md
add html man 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 [xmonad](http://xmonad.org xmonad) and
11 [dwm](http://dwm.suckless.org). 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 [dwm](http://dwm.suckless.org) was a phenomenal resource and many good ideas
15 and code was borrowed from it. On the other hand [xmonad](http://xmonad.org)
16 has great defaults, key bindings and xinerama support but is crippled by not
17 being 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 [OpenBSD](http://www.openbsd.org) fashion (put up, or hack up) a
24 brand new window manager was whooped up to serve no other purpose than to obey
25 its masters. It is released under the ISC license. Patches can be accepted
26 provided they are ISC licensed as well.
27
28 You can and come chat with us on IRC. We use [OFTC](https://www.oftc.net)
29 channel #spectrwm.
30
31 ## Major features
32 * Dynamic RandR support (multi-head)
33 * Navigation anywhere on all screens with either the keyboard or mouse
34 * Customizable status bar
35 * Human readable configuration file
36 * Restartable without losing state
37 * Quick launch menu
38 * Many screen layouts possible with a few simple key strokes
39 * Windows can be added or removed from master area
40 * Windows can be moved to any workspace or within a region
41 * Resizable master area
42 * Move/resize floating windows
43 * Drag-to-float
44 * Extended Window Manager Hints (EWMH) Support
45 * Configureable tiling
46 * Adjustable tile gap allows for a true one pixel border.
47 * Customizable colors and border width.
48 * User definable regions
49 * User definable modkey & key bindings
50 * User definable quirk bindings
51 * User definable key bindings to launch applications
52 * Multi OS support (*BSD, Linux, OSX, Windows/cygwin)
53 * Reparenting window manager
54
55 ## License
56
57 spectrwm is ISC licensed unless otherwise specified in individual files.
58
59 ## Screenshots
60 ![Vertical stack]
61 (https://github.com/conformal/spectrwm/wiki/Scrotwm1.png)
62
63 ![Horizontal stack]
64 (https://github.com/conformal/spectrwm/wiki/Scrotwm2.png)
65
66 ![Horizontal stack]
67 (https://github.com/conformal/spectrwm/wiki/Scrotwm3.png)
68
69 ![Vertical stack with floater and extra window in master area]
70 (https://github.com/conformal/spectrwm/wiki/Scrotwm4.png)
71
72 ![mplayer, resized and moved]
73 (https://github.com/conformal/spectrwm/wiki/Scrotwm1.png)
74