annotate README @ 17:aaf520f53110

updated README
author Anselm R. Garbe <garbeam@wmii.de>
date Tue, 11 Jul 2006 18:59:09 +0200
parents d567f430a81d
children 1efa34c6e1b6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
1 gridwm
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
2 ------
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
3
17
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
4 gridwm is an extremly fast, small, and automatic X11 window manager. It
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
5 arranges all windows in a grid.
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
6
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
7
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
8 Configuration
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
9 -------------
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
10 You have to edit the source code for configuration, this WM is intended to
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
11 provide sane defaults, if something doesn't fits your needs, edit config.h and
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
12 maybe key.c. To change the status output edit that status variable definition
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
13 in wm.c.
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
14
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
15
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
16 Requirements
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
17 ------------
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
18 In order to build gridwm you need the Xlib header files.
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
19
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
20
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
21 Installation
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
22 ------------
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
23 Edit config.mk to match your local setup. gridwm is installed into
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
24 the /usr/local namespace by default.
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
25
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
26 Afterwards enter the following command to build and install gridwm (if
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
27 necessary as root):
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
28
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
29 make clean install
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
30
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
31
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
32 Running gridwm
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
33 --------------
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
34 Add the following line to your .xinitrc to start gridwm using startx:
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
35
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
36 exec gridwm
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
37
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
38 In order to connect gridwm to a specific display, make sure that
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
39 the DISPLAY environment variable is set correctly, e.g.:
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
40
17
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
41 DISPLAY=foo.bar:1 exec gridwm
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
42
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
43 This will start gridwm on display :1 of the host foo.bar.
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
44
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
45
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
46 Configuration
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
47 -------------
17
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
48 The configuration of gridwm is done by customizing the config.h source file. To
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
49 customize the key bindings edit key.c. To change the status output, edit the
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
50 status command definition in wm.c.
aaf520f53110 updated README
Anselm R. Garbe <garbeam@wmii.de>
parents: 9
diff changeset
51