Go to file
Lukas Hrazky a079ab654d awful.util: change table.clone to do deep copies
Signed-off-by: Lukas Hrazky <lukkash@email.cz>
Signed-off-by: Julien Danjou <julien@danjou.info>
2009-10-26 11:07:41 +01:00
build-utils readd proper C API documentation 2009-08-21 15:30:48 +02:00
common tokenenize: remove useless tokens 2009-10-20 20:42:05 +02:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib awful.util: change table.clone to do deep copies 2009-10-26 11:07:41 +01:00
luadoc titlebar: remove 2009-10-20 20:42:05 +02:00
manpages awesome.1: remove Java stuff (FS#630) 2009-09-21 10:14:16 +02:00
objects window: rename to xwindow 2009-10-20 20:42:05 +02:00
themes themes: added mouse finder and tooltips 2009-09-13 14:38:59 +02:00
utils Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02: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 window: rename to xwindow 2009-10-20 20:42:05 +02: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 window: rename to xwindow 2009-10-20 20:42:05 +02:00
awesome.desktop desktop: change description 2008-10-02 17:19:28 +02:00
awesome.doxygen.in awesome.doxygen: doxygen configuration fixes. 2009-09-04 18:18:03 +02:00
awesome.h factorize quit/exec elements, and reparent systray 2008-09-02 17:12:10 +02:00
awesomeConfig.cmake change codename 2009-10-20 20:41:18 +02:00
awesomerc.lua.in titlebar: remove 2009-10-20 20:42:05 +02:00
banning.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
banning.h Re-add lazy banning 2009-09-28 14:04:59 +02:00
color.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
color.h color: do not take pointer to push 2009-08-17 17:46:35 +02:00
config.h.in build: detect endianness at compile time 2009-04-27 12:06:24 +02:00
dbus.c dbus: fix crash if interface is NULL 2009-10-05 14:42:38 +02:00
dbus.h dbus: allow usage of the system bus 2009-04-18 16:07:31 +02:00
draw.c graph, progressbar: remove 2009-10-20 20:42:04 +02:00
draw.h graph, progressbar: remove 2009-10-20 20:42:04 +02:00
event.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
event.h wibox: move into objects 2009-10-20 20:42:05 +02:00
ewmh.c ewmh: fix toggle on maximized_horizontal 2009-10-21 11:41:20 +02:00
ewmh.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
font.c font: split out of draw 2009-09-07 17:51:40 +02:00
font.h font: split out of draw 2009-09-07 17:51:40 +02:00
globalconf.h key: move into objects 2009-10-20 20:42:05 +02:00
image.c image: load image without cache (FS#651) 2009-10-07 19:54:00 +02:00
image.h image: port to new class system 2009-08-21 15:30:47 +02:00
keygrabber.c key: move into objects 2009-10-20 20:42:05 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
luaa.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
luaa.h hooks: remove 2009-10-20 20:42:04 +02:00
mouse.c wibox: move into objects 2009-10-20 20:42:05 +02:00
mouse.h mouse: split button out 2009-04-26 10:46:09 +02:00
mousegrabber.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
property.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
root.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
screen.c titlebar: remove 2009-10-20 20:42:05 +02:00
screen.h Re-add lazy banning 2009-09-28 14:04:59 +02:00
selection.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
selection.h selection: do not use a useless module 2009-01-06 17:02:08 +01:00
spawn.c spawn: add spawn_system() which works like system() 2009-08-27 12:07:50 +02:00
spawn.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
stack.c client: move into objects 2009-10-20 20:42:05 +02:00
stack.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
strut.c Fix doxygen generation warnings 2009-08-26 09:15:57 +02:00
strut.h strut: import strut_has_value() 2009-08-28 17:45:18 +02:00
systray.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
xwindow.c window: rename to xwindow 2009-10-20 20:42:05 +02:00
xwindow.h window: rename to xwindow 2009-10-20 20:42:05 +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.