Go to file
Brian Gianforcaro 3145e3145e Grammar/spelling corrections in comments and docs.
Signed-off-by: Brian Gianforcaro <b.gianfo@gmail.com>
Signed-off-by: Julien Danjou <julien@danjou.info>
2009-08-31 10:39:36 +02:00
build-utils readd proper C API documentation 2009-08-21 15:30:48 +02:00
common Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
icons themes: move theme icons to themes/ 2008-11-10 12:02:08 +01:00
lib magnifier: fix then no tiled client 2009-08-31 10:32:53 +02:00
luadoc Fix spelling errors in luadoc 2009-08-31 10:39:09 +02:00
manpages Grammar and spelling fixes in man pages 2009-08-31 10:39:25 +02:00
themes default theme: update examples to reflect the switch to lua 2009-08-31 10:36:18 +02:00
utils Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
widgets 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 zenburn theme: Initial import and integration 2009-08-31 10:27:11 +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 update STYLE, add PATCHES 2008-08-30 13:09:15 +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 Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
awesome.desktop desktop: change description 2008-10-02 17:19:28 +02:00
awesome.doxygen.in Fix doxygen generation warnings. 2009-07-27 11:18:43 +02:00
awesome.h factorize quit/exec elements, and reparent systray 2008-09-02 17:12:10 +02:00
awesomeConfig.cmake property: use xcb_get_wm_protocols_from_reply 2009-08-24 11:13:00 +02:00
awesomerc.lua.in awesomerc: fix layout for promptbox 2009-08-27 17:07:36 +02:00
banning.c client: active BMA when moving windows 2009-08-03 15:57:10 +02:00
banning.h layout: rename to banning 2009-06-10 11:42:43 +02:00
button.c luaclass: add handling of {new,}index of missing properties (FS#584) 2009-08-21 15:30:48 +02:00
button.h luaclass: optimize type handling 2009-08-21 15:30:47 +02:00
client.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
client.h client: merge lower code 2009-08-28 17:53:48 +02:00
color.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +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: check for signal uniqness 2009-08-21 15:30:48 +02:00
dbus.h dbus: allow usage of the system bus 2009-04-18 16:07:31 +02:00
draw.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
draw.h draw: stop requesting extents 2009-08-27 15:38:17 +02:00
event.c event: emit mouse::{enter,leave} on client 2009-08-21 15:30:48 +02:00
event.h layout: rename to banning 2009-06-10 11:42:43 +02:00
ewmh.c Fix doxygen generation warnings 2009-08-26 09:15:57 +02:00
ewmh.h ewmh: change ewmh_update_client_strut() to ewmh_update_strut() 2009-08-21 15:30:47 +02:00
hooks.c add missing vim modelines 2009-08-21 16:44:30 +02:00
image.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
image.h image: port to new class system 2009-08-21 15:30:47 +02:00
key.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
key.h add missing vim modelines 2009-08-21 16:44:30 +02:00
keygrabber.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
luaa.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
luaa.h Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
mouse.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
mouse.h mouse: split button out 2009-04-26 10:46:09 +02:00
mousegrabber.c add missing vim modelines 2009-08-21 16:44:30 +02:00
mousegrabber.h mousegrabber: import 2008-12-12 16:51:41 +01:00
property.c Fix doxygen generation warnings 2009-08-26 09:15:57 +02:00
property.h property: split _NET_WM_{ICON_,}NAME from WM_{ICON_,}NAME 2009-08-25 16:39:10 +02:00
root.c image: port to new class system 2009-08-21 15:30:47 +02:00
screen.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
screen.h Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +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 spawn: add spawn_system() which works like system() 2009-08-27 12:07:50 +02:00
stack.c stack: fix bad rename 2009-08-24 15:07:58 +02:00
stack.h stack: fix bad rename 2009-08-24 15:07:58 +02:00
structs.h image: port to new class system 2009-08-21 15:30:47 +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 Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
systray.h systray: add some cleanup code 2008-09-03 18:03:50 +02:00
tag.c Fix doxygen generation warnings 2009-08-26 09:15:57 +02:00
tag.h tag: make struct tag private 2009-08-21 15:30:47 +02:00
timer.c luaclass: add handling of {new,}index of missing properties (FS#584) 2009-08-21 15:30:48 +02:00
timer.h timer: import 2009-08-17 17:49:06 +02:00
titlebar.c titlebar: emit signal when detaching titlebar 2009-08-28 17:04:59 +02:00
titlebar.h Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
wibox.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
wibox.h wibox: add struts 2009-08-21 15:30:48 +02:00
widget.c Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
widget.h widget: widget_geometries() is static 2009-08-27 16:44:05 +02:00
window.c button: use new object system 2009-08-21 15:30:46 +02:00
window.h Revert "button, key: grab all keys by default, and check for match." 2009-08-14 17:52:49 +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.