Go to file
Uli Schlachter 418f3d0b37 Minor cleanup
Or'ing into a bool feels dirty and the struct members should all be documented.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2010-07-22 09:28:16 +02:00
build-utils Fix gperf usage (FS#740) 2010-03-15 09:58:37 +01:00
common ewmh: remove _NET_WORKAREA support (FS#732) 2010-02-18 10:04:47 +01:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib Naughty: Catch invalid markup in notifications 2010-07-16 19:40:08 +02:00
luadoc Update API docs for recent change to spawn 2010-05-03 10:15:02 +02:00
manpages German translation of manpages 2010-05-03 11:14:57 +02:00
themes theme/default: change default background 2010-03-23 10:58:05 +01:00
utils awsetbg was missing break 2010-05-17 15:57:30 +02:00
widgets textbox: Throw a lua error on invalid markup 2010-07-16 19:40:04 +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 Do not install txt manpages files 2010-05-20 19:57:54 +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 Don't manually unban all windows on exit 2010-07-14 21:40:27 +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 2010-07-14 08:30:09 +02:00
awesomerc.lua.in awful.menu: Change menu:show() args set 2010-04-14 09:38:52 +02:00
banning.c Re-add lazy banning 2009-09-28 14:04:59 +02:00
banning.h Re-add lazy banning 2009-09-28 14:04:59 +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 structs: rename to globalconf 2009-09-07 17:23:01 +02:00
client.c Ignore size hints on fullscreen windows 2010-07-21 17:51:47 +02:00
client.h client: _really_ honor size hints 2010-03-03 09:18:17 +01: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 compiling error 2010-06-06 14:32:47 +02:00
dbus.h dbus: allow usage of the system bus 2009-04-18 16:07:31 +02:00
draw.c Do not check if we have enough space to draw (FS#731) 2010-03-25 10:31:31 +01:00
draw.h Clear a draw_text_context_t during wipe() 2010-07-16 19:54:01 +02:00
event.c Fix mouse::leave signal emit on widgets (FS#774) 2010-06-09 16:08:48 +02:00
event.h Register systray only if systray widgets are attached. (FS#503) 2010-07-22 09:28:01 +02:00
ewmh.c Handle _NET_WM_DESKTOP more intelligently 2010-06-14 20:04:33 +02:00
ewmh.h ewmh: remove _NET_WORKAREA support (FS#732) 2010-02-18 10:04:47 +01: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 font: split out of draw 2009-09-07 17:51:40 +02:00
hooks.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
image.c image: load with image 2009-12-14 10:27:15 +01:00
image.h image: port to new class system 2009-08-21 15:30:47 +02:00
key.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
key.h key: move grabbing code to window 2009-08-31 13:54:36 +02:00
keygrabber.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
keygrabber.h keygrabber: add stop() method 2008-11-10 17:31:18 +01:00
luaa.c Handle errors in the config better 2010-07-15 19:22:28 +02:00
luaa.h Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
mouse.c mouse: coords() get silent parameter 2009-11-06 11:06:02 +01: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 Fix possible memory corruption (FS#734) 2010-03-22 14:19:30 +01:00
property.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
root.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
screen.c screen: only untag if client had a screen 2009-09-22 15:51:55 +02:00
screen.h Minor cleanup 2010-07-22 09:28:16 +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 Update API docs for recent change to spawn 2010-05-03 10:15:02 +02:00
spawn.h structs: rename to globalconf 2009-09-07 17:23:01 +02:00
stack.c stack: fix bad rename 2009-08-24 15:07:58 +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 Minor cleanup 2010-07-22 09:28:16 +02:00
systray.h Register systray only if systray widgets are attached. (FS#503) 2010-07-22 09:28:01 +02:00
tag.c ewmh: remove _NET_WORKAREA support (FS#732) 2010-02-18 10:04:47 +01:00
tag.h screen: fix tag removal/add 2009-09-21 12:12:59 +02:00
timer.c structs: rename to globalconf 2009-09-07 17:23:01 +02:00
timer.h timer: import 2009-08-17 17:49:06 +02:00
titlebar.c Add some missing class type checks 2009-09-04 13:58:31 +02:00
titlebar.h Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
wibox.c Register systray only if systray widgets are attached. (FS#503) 2010-07-22 09:28:01 +02:00
wibox.h Register systray only if systray widgets are attached. (FS#503) 2010-07-22 09:28:01 +02:00
widget.c Store widgets references as wibox items 2010-05-25 15:43:18 +02:00
widget.h Store widgets references as wibox items 2010-05-25 15:43:18 +02:00
window.c Use WM_STATE_NORMAL as default 2010-03-29 17:47:45 +02:00
window.h font: split out of draw 2009-09-07 17:51:40 +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.