add uicb_setncols(), clean config, really use config in tile.c
[awesome.git] / README
blob8cfb7c0aad0586feec6e6803abcac3ee2876aeb2
1 awesome
2 =======
3 awesome is an extremely fast, small, and dynamic window manager for X.
4 It's based on dwm.
6 Requirements
7 ------------
8 In order to build awesome you need the Xlib header files and libconfig.
10 Installation
11 ------------
12 Edit config.mk to match your local setup (awesome is installed into
13 the /usr/local namespace by default).
15 Afterwards enter the following command to build and install awesome (if
16 necessary as root):
18     make install
20 Running awesome
21 -----------
22 Add the following line to your .xinitrc to start awesome using startx
23 or to .xsession to start awesome using gdm/kdm/xdm...:
25     exec awesome
27 In order to connect awesome to a specific display, make sure that
28 the DISPLAY environment variable is set correctly, e.g.:
30     DISPLAY=foo.bar:1 exec awesome
32 (This will start awesome on display :1 of the host foo.bar.)
34 In order to display status info in the bar, you can do something
35 like this in your .xinitrc:
37     while true
38     do
39         echo `date` `uptime | sed 's/.*,//'`
40         sleep 1
41     done | awesome
44 Configuration
45 -------------
46 The configuration of awesome is done by creating a ~/.awesomerc file.
47 An example is provided in the sources.