JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
updated README
[dwm.git] / README
1 gridwm
2 ------
3
4 gridwm is an extremly fast, small, and automatic X11 window manager.  It
5 arranges all windows in a grid.
6
7
8 Configuration
9 -------------
10 You have to edit the source code for configuration, this WM is intended to
11 provide sane defaults, if something doesn't fits your needs, edit config.h and
12 maybe key.c. To change the status output edit that status variable definition
13 in wm.c.
14
15
16 Requirements
17 ------------
18 In order to build gridwm you need the Xlib header files.
19
20
21 Installation
22 ------------
23 Edit config.mk to match your local setup. gridwm is installed into
24 the /usr/local namespace by default.
25
26 Afterwards enter the following command to build and install gridwm (if
27 necessary as root):
28
29     make clean install
30
31
32 Running gridwm
33 --------------
34 Add the following line to your .xinitrc to start gridwm using startx:
35
36     exec gridwm
37
38 In order to connect gridwm to a specific display, make sure that
39 the DISPLAY environment variable is set correctly, e.g.:
40
41     DISPLAY=foo.bar:1 exec gridwm
42
43 This will start gridwm on display :1 of the host foo.bar.
44
45
46 Configuration
47 -------------
48 The configuration of gridwm is done by customizing the config.h source file. To
49 customize the key bindings edit key.c. To change the status output, edit the
50 status command definition in wm.c.
51