centralized/externalized configuration to config.h
[dwm.git] / README
1 dwm - dynamic window manager
2 ----------------------------
3 dwm is an extremely fast, small, and dynamic X11 window manager.
4
5
6 Requirements
7 ------------
8 In order to build dwm you need the Xlib header files.
9
10
11 Installation
12 ------------
13 Edit config.mk to match your local setup (dwm is installed into
14 the /usr/local namespace by default).
15
16 Afterwards enter the following command to build and install dwm (if
17 necessary as root):
18
19     make clean install
20
21 If you want to use a customized config.h, you can use the following
22 command for installing dwm:
23
24     make CONFIG=<your-config>.h clean install
25
26
27 Running dwm
28 -----------
29 Add the following line to your .xinitrc to start dwm using startx:
30
31     exec dwm
32
33 In order to connect dwm to a specific display, make sure that
34 the DISPLAY environment variable is set correctly, e.g.:
35
36     DISPLAY=foo.bar:1 exec dwm
37
38 This will start dwm on display :1 of the host foo.bar.
39
40
41 Displaying status info
42 ----------------------
43 In order to display status info in the bar, you can do something
44 like this in your .xinitrc:
45
46     while true
47     do
48         echo `date` `uptime | sed 's/.*://; s/,//g'`
49         sleep 1
50     done | dwm
51
52
53 Configuration
54 -------------
55 The configuration of dwm is done by editing config.h.