Go to file
Julien Danjou ec5ef67404 Remove PREFIX, use CMAKE_INSTALL_PREFIX
Signed-off-by: Julien Danjou <julien@danjou.info>
2012-06-11 14:47:13 +02:00
build-tests use CMake check_function_exists() for execinfo 2010-10-11 22:52:20 +02:00
build-utils Stop using gperf 2010-09-02 19:24:39 +02:00
common Add platform support for DragonflyBSD. 2012-05-20 22:46:34 +02:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib Fix naughty notifications again 2012-06-05 17:44:30 +02:00
luadoc Switch from oocairo to lgi.cairo 2012-05-27 19:20:34 +02:00
manpages Update french manpages 2012-02-21 12:52:52 +01:00
objects Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
themes menubar: Introduce menubar extension 2012-03-09 13:43:26 +01:00
utils awsetbg: xli is reported as ok 2011-12-09 10:44:43 +01:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
AUTHORS update Arnaud commit years 2009-08-24 11:13:59 +02:00
BUGS BUG's page 2008-04-18 19:33:58 +02:00
CMakeLists.txt Add italian translation 2011-12-01 11:21:12 +01:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile build: allow to specify cmake args 2009-05-08 19:54:38 +02:00
PATCHES PATCHES: add more rules 2009-09-02 10:36:13 +02:00
README Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
STYLE STYLE: add prefix rule 2009-08-21 15:30:48 +02:00
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.c Use ARGB visuals by default again (FS#837) 2012-04-11 20:17:52 +02:00
awesome.desktop Desktop file fixes. 2012-06-05 15:23:10 +02:00
awesome.doxygen.in awesome.doxygen: doxygen configuration fixes. 2009-09-04 18:18:03 +02:00
awesome.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomeConfig.cmake Remove PREFIX, use CMAKE_INSTALL_PREFIX 2012-06-11 14:47:13 +02:00
awesomerc.lua.in menubar: Introduce menubar extension 2012-03-09 13:43:26 +01:00
banning.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
banning.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
color.c C color code: Ignore alpha component (FS#966) 2012-04-07 22:03:38 +02:00
color.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
config.h.in test for __builtin_clz() and fallback to an inline implementation. 2010-10-11 20:42:03 +02:00
dbus.c Minor readability fixes, STREQ()-like macros added 2011-11-18 17:56:21 +01:00
dbus.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
draw.c Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
draw.h Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
event.c event: Properly ignore the "send event" flag 2012-05-19 20:20:46 +02:00
event.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
ewmh.c Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
ewmh.h Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
globalconf.h Add a wallpaper_changed signal 2012-04-07 21:52:24 +02:00
keygrabber.c Get keygrabber running state 2012-06-06 17:28:58 +02:00
keygrabber.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
keyresolv.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
keyresolv.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
luaa.c Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
luaa.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
mouse.c Minor readability fixes, STREQ()-like macros added 2011-11-18 17:56:21 +01:00
mouse.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
mousegrabber.c Get mousegrabber running state 2012-06-06 10:42:14 +02:00
mousegrabber.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
property.c Don't pass cairo surfaces around on the lua stack 2012-05-28 09:29:47 +02:00
property.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
root.c Switch from oocairo to lgi.cairo 2012-05-27 19:20:34 +02:00
screen.c Revert "screen: Add screen.by_coords()" 2012-01-15 16:51:52 +01:00
screen.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
selection.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
selection.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
spawn.c Minor readability fixes, STREQ()-like macros added 2011-11-18 17:56:21 +01:00
spawn.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
stack.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
stack.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
strut.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
strut.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
xwindow.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
xwindow.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00

README

awesome
=======
awesome is a highly configurable, next generation framework window manager for X.

Building and installation
-------------------------
After extracting the dist tarball, run:

  make

This will create a build directory, run cmake in it and build awesome.

After building is finished, you can install:

  make install # you might need root permissions

Running awesome
---------------
You can directly select awesome from your display manager. If not, you can
add the following line to your .xinitrc to start awesome using startx
or to .xsession to start awesome using your display manager:

    exec awesome

In order to connect awesome to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:

    DISPLAY=foo.bar:1 exec awesome

(This will start awesome on display :1 of the host foo.bar.)

Configuration
-------------
The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
An example configuration named "awesomerc.lua.in" is provided in the source.

Troubleshooting
---------------
In most systems any message printed by awesome (including warnings and errors)
are written to $HOME/.xsession-errors.

If awesome does not start or the configuration file is not producing the desired
results the user should examine this file to gain insight into the problem.