Use relative paths for the titlebar icons (FS#809)
[awesome.git] / README
blob40243594e6c73f09212b2f90bd8c08960c62a22d
1 awesome
2 =======
3 awesome is a highly configurable, next generation framework window manager for X.
5 Building and installation
6 -------------------------
7 After extracting the dist tarball, run:
9   make
11 This will create a build directory, run cmake in it and build awesome.
13 After building is finished, you can install:
15   make install # you might need root permissions
17 Running awesome
18 ---------------
19 You can directly select awesome from your display manager. If not, you can
20 add the following line to your .xinitrc to start awesome using startx
21 or to .xsession to start awesome using your display manager:
23     exec awesome
25 In order to connect awesome to a specific display, make sure that
26 the DISPLAY environment variable is set correctly, e.g.:
28     DISPLAY=foo.bar:1 exec awesome
30 (This will start awesome on display :1 of the host foo.bar.)
32 Configuration
33 -------------
34 The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
35 An example configuration named "awesomerc.lua.in" is provided in the source.
37 Troubleshooting
38 ---------------
39 In most systems any message printed by awesome (including warnings and errors)
40 are written to $HOME/.xsession-errors.
42 If awesome does not start or the configuration file is not producing the desired
43 results the user should examine this file to gain insight into the problem.