Go to file
Emmanuel Lepage Vallee f26fa5e099 wibox: Add more constructor arguments
Fixes #916
2016-05-19 01:27:05 -04:00
build-tests Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
build-utils Travis: redirect/filter stderr for git-clone/git-push/curl (#911) 2016-05-16 18:54:19 +02:00
common xutil.h: Add defines for valid coordinates and sizes 2016-04-17 13:48:24 +02:00
docs wibox: Move the documentation to a shared file 2016-05-15 17:17:12 -04:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib wibox: Add more constructor arguments 2016-05-19 01:27:05 -04:00
manpages Document "--replace" better 2015-10-11 15:00:08 +02:00
objects doc: `for s, screen do` -> `for s in screen do` 2016-05-15 23:44:09 -04:00
spec tests: Test gears.object optional features 2016-05-18 01:24:59 -04:00
tests Merge pull request #913 from Elv13/gear_obj_props 2016-05-18 15:20:43 -04:00
themes xresources theme: Use a RecordingSurface for wallpaper 2016-04-30 09:36:50 +02:00
utils Add vim modelines to all shell scripts 2015-12-12 17:36:35 +01:00
.editorconfig Add an EditorConfig file 2015-12-12 17:48:42 +01:00
.gitignore gitignore: remove awesome-client 2009-04-11 16:10:42 +02:00
.luacheckrc Add& use Luacheck support 2016-02-16 19:45:10 +01:00
.luacov Run shape-example-generation under LuaCov 2016-03-17 10:22:42 +01:00
.travis.yml Travis: Build Lua 5.3 with -DLUA_USE_APICHECK (#907) 2016-05-16 03:10:58 +02:00
CMakeLists.txt "make check": Support out-of-tree builds 2016-05-08 18:52:18 +02:00
LICENSE chance license to GPLv2 2007-09-12 14:29:51 +02:00
Makefile Makefile: add "tags" to .PHONY targets 2015-07-11 22:50:11 +02:00
Packaging.cmake Packaging: Print some information about supported packages 2016-04-17 16:12:08 +02:00
README.md Add README.md symlink 2015-02-28 23:14:13 +01:00
awesome-version-internal.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
awesome.c Clean up static variables in event_handle 2016-04-09 15:44:54 +02:00
awesome.desktop Remove NoDisplay from desktop file 2013-02-25 11:50:00 +01:00
awesome.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
awesomeConfig.cmake doc: Add a system to share ldoc content across multiple files 2016-05-09 01:37:47 -04:00
awesomerc.lua awful.wibox: Rename to awful.wibar 2016-05-15 17:17:12 -04:00
banning.c doc: fix warnings from doxygen 2015-02-14 20:17:13 +01:00
banning.h Clean up header includes 2014-03-30 20:07:48 +02:00
color.c Clean up header includes 2014-03-30 20:07:48 +02:00
color.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
config.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
dbus.c dbus.c: Check string return values properly 2016-03-06 11:16:49 +01:00
dbus.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
draw.c awesome.load_image(): Return errors instead of "throwing" them 2016-01-15 18:38:51 +01:00
draw.h awesome.load_image(): Return errors instead of "throwing" them 2016-01-15 18:38:51 +01:00
event.c Fix mouse clicks on titlebars (#901) 2016-05-14 16:16:24 +02:00
event.h Stop restarting on RandR changes 2016-05-01 10:09:26 +02:00
ewmh.c Fix fallback for the window type 2016-05-14 14:10:27 +02:00
ewmh.h add an option to set the preferred client icon size 2015-12-07 22:59:32 +01:00
globalconf.h Stop restarting on RandR changes 2016-05-01 10:09:26 +02:00
keygrabber.c keygrabber: ignore modifiers for name of control keys 2015-08-10 23:05:16 +02:00
keygrabber.h Clean up header includes 2014-03-30 20:07:48 +02:00
luaa.c Add range-checking to lots of arguments in the C code 2016-04-18 04:20:22 -04:00
luaa.h Fix integer overflow in overflow checking functions (#851) 2016-04-26 00:51:51 +02:00
mouse.c doc: Add proper mouse documentation 2016-04-30 04:27:34 -04:00
mouse.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
mousegrabber.c doc: Add a missing '@' sign in mousegrabber documentation 2016-04-24 21:44:04 -04:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
property.c Fix fallback for the window type 2016-05-14 14:10:27 +02:00
property.h Clean up header includes 2014-03-30 20:07:48 +02:00
root.c geometry: Use the relevant rounding functions instead of integers 2016-04-18 04:20:22 -04:00
selection.c Set WM_CLASS and WM_NAME on all our windows (#551) 2015-11-19 22:23:25 +01:00
selection.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
spawn.c Replace many pushnumber calls with pushinteger 2016-02-06 13:46:46 +01:00
spawn.h Clean up header includes 2014-03-30 20:07:48 +02:00
stack.c doc: fix warnings from doxygen 2015-02-14 20:17:13 +01:00
stack.h Clean up header includes 2014-03-30 20:07:48 +02:00
strut.c geometry: Use the relevant rounding functions instead of integers 2016-04-18 04:20:22 -04:00
strut.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
systray.c geometry: Use the relevant rounding functions instead of integers 2016-04-18 04:20:22 -04:00
systray.h remove encoding=utf-8 from modelines 2011-09-11 17:34:09 +02:00
xkb.c Make client key bindings for e.g. xeyes work again 2016-02-28 13:29:25 +01:00
xkb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xrdb.c Make xrdb_get_value() behave as documented 2016-02-29 11:13:58 +01:00
xrdb.h Add a vim modeline to all C source 2015-12-12 17:42:16 +01:00
xwindow.c Fix obvious typo in xwindow_translate_for_gravity() 2015-10-10 17:38:51 +02:00
xwindow.h Set WM_CLASS and WM_NAME on all our windows (#551) 2015-11-19 22:23:25 +01:00

README.md

Readme

About 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 either install via make install:

make install  # you might need root permissions

or by auto-generating a .deb or .rpm package, for easy removal later on:

make package

sudo dpkg -i awesome-x.y.z.deb
# or
sudo rpm -Uvh awesome-x.y.z.rpm

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, typically ~/.config/awesome/rc.lua.

An example configuration named awesomerc.lua.in is provided in the source.

Troubleshooting

On most systems any message printed by awesome (including warnings and errors) is written to ~/.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.

Debugging tips

You can call awesome with gdb like this:

DISPLAY=:2 gdb awesome

Then in gdb set any args and run it:

(gdb) set arg --replace
(gdb) run

Inside gdb you can use the following to print the current Lua stack traceback:

(gdb) print luaL_dostring(globalconf.L.real_L_dont_use_directly, "print(debug.traceback())")

Reporting issues

Please report any issues you may find on our bugtracker. You can submit pull requests on the github repository. Please read the contributing guide for any coding, documentation or patch guidelines.

Status

Build Status

Documentation

Online documentation is available at http://awesome.naquadah.org/doc/ for the stable branch and at http://awesomewm.github.io/apidoc/ for the master branch. It can be built using make ldoc.

License

The project is licensed under GNU General Publice License v2 or later. You can read it online at (v2 or v3).