Find a file
Anurag Priyam 765db33757 gears.color: expose documentation for create_(linear|radial)_pattern functions
The documentation for these functions were hidden (intentionally?) from luadoc
because of misspelt @class and @name tags. Fixed the spelling, so luadoc can do
its job.

Signed-off-by: Anurag Priyam <anurag08priyam@gmail.com>
Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-01-13 20:07:52 +01: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 luaA_object_emit_signal: Fix a crash on non-objects 2012-01-04 17:09:52 +01:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib gears.color: expose documentation for create_(linear|radial)_pattern functions 2012-01-13 20:07:52 +01:00
luadoc Fix mousegrabber run documentation 2011-12-22 10:23:42 +01:00
manpages Add italian translation 2011-12-01 11:21:12 +01:00
objects drawin: Remove bg_color property 2011-12-23 16:54:55 +01:00
themes Original sky theme dwindle and spiral icons 2011-12-30 17:51:37 +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
awesome-version-internal.h.in cmake: consolidate version strings 2008-06-22 22:13:06 +02:00
awesome.c Signal config errors via a naughty popup 2011-10-23 17:36:19 +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 remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomeConfig.cmake remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomerc.lua.in Signal runtime errors via a naughty popup 2011-10-23 17:36:56 +02: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
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
color.c Refine RGB_ macros, use RGB_16TO8() in luaA_push_color() 2011-11-23 17:39:11 +01: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 Minor readability fixes, STREQ()-like macros added 2011-11-18 17:56:21 +01:00
draw.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
event.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
event.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
ewmh.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
ewmh.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
globalconf.h Signal config errors via a naughty popup 2011-10-23 17:36:19 +02:00
keygrabber.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +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
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
luaa.c Re-add missing debug::deprecation signal 2011-12-05 20:43:14 +01:00
luaa.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
Makefile build: allow to specify cmake args 2009-05-08 19:54:38 +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 remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
mousegrabber.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
PATCHES PATCHES: add more rules 2009-09-02 10:36:13 +02:00
property.c remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
property.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
README Grammar/spelling corrections in comments and docs. 2009-08-31 10:39:36 +02:00
root.c Allow usage of strings as key names for root.fake_input 2011-12-08 18:47:53 +01:00
screen.c Minor readability fixes, STREQ()-like macros added 2011-11-18 17:56:21 +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
STYLE STYLE: add prefix rule 2009-08-21 15:30:48 +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

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.