Go to file
Uli Schlachter b6a3ae43fb gears.object.properties: Use the new .data table
Previously, gears.object.properties used a weak table for adding
additional information to a C object. However, weak tables can easily
cause leaks when the value references the key.

This commit makes the code instead use the new .data property that is
available on all C objects. This means we have no more magic with a weak
table and instead only use "regular" tables instead.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2016-09-30 11:11:55 +02:00
build-utils travis-apidoc.sh: remove misleading comment 2016-08-15 17:37:54 +02:00
common C: Add a .data table to all C objects 2016-09-30 11:07:55 +02:00
docs doc: Document cursors 2016-09-26 00:40:20 -04:00
icons icons: remove invaders 2009-09-08 13:29:25 +02:00
lib gears.object.properties: Use the new .data table 2016-09-30 11:11:55 +02:00
manpages Add an option to add a path to $LUA_PATH 2016-08-20 16:04:11 +02:00
objects Speed up client_ignore_enterleave_events() 2016-09-30 09:37:55 +02:00
spec gears.object: Implement read-only properties 2016-06-08 20:28:30 +02:00
tests shims: Add support the new .data property 2016-09-30 11:11:55 +02:00
themes fix(themes: xresources: assets): recolor for minimize_focus 2016-07-17 15:27:45 +02:00
utils awesome-client: Handle errors when running arguments 2016-08-31 17:44:43 +02: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 tests: Fix a luacheck issue. 2016-09-30 09:32:14 +02:00
.luacov Run shape-example-generation under LuaCov 2016-03-17 10:22:42 +01:00
.travis.yml Travis: fix codecov (#1105) 2016-09-20 19:53:10 +02:00
CMakeLists.txt doc: Document rc.lua 2016-09-26 00:40:20 -04:00
ISSUE_TEMPLATE.md Add an ISSUE_TEMPLATE.md file (#997) 2016-07-09 19:18:02 +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 Do not allow multiple --config arguments 2016-08-31 13:31:16 +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 awesomeConfig.cmake: Stop forcing CMAKE_BUILD_TYPE 2016-09-30 09:36:36 +02:00
awesomerc.lua doc: Document rc.lua 2016-09-26 00:40:20 -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 Stop checking for __builtin_clz (#985) 2016-07-05 22:12:26 +02:00
dbus.c Return success/failure for dbus.connect_signal 2016-09-09 07:43:56 -05: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 Speed up client_ignore_enterleave_events() 2016-09-30 09:37:55 +02:00
event.h Only export a single refresh function for clients 2016-09-15 18:31:29 +02:00
ewmh.c Merge branch 'dev_fix_desktop' of https://github.com/schmellow/awesome 2016-06-04 16:01:17 +02:00
ewmh.h Attempt at better handling of NET_CURRENT_DESKTOP property. 2016-06-04 16:42:54 +03:00
globalconf.h Speed up client_ignore_enterleave_events() 2016-09-30 09:37:55 +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 doc: Port the Awesome (global API) to the ldoc 2016-09-26 00:40:20 -04:00
luaa.h Add an option to add a path to $LUA_PATH 2016-08-20 16:04:11 +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: Document cursors 2016-09-26 00:40:20 -04:00
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) 2013-03-29 16:07:13 +01:00
property.c C: Remove unneeded calls to signal_add() 2016-06-04 17:57:08 +02:00
property.h Clean up header includes 2014-03-30 20:07:48 +02:00
root.c doc: Document cursors 2016-09-26 00:40:20 -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 spawn: Fix crash when called with an empty table. 2016-08-09 18:32:31 -04: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 Properly support the XEMBED_MAPPED bit 2016-05-31 08:55:42 +02:00
systray.h Remove unused argument to systray_request_handle() 2016-05-29 14:33:23 +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

Build dependencies

Awesome has the following dependencies (besides a more-or-less standard POSIX environment):

Additionally, the following optional dependencies exist:

  • DBus for DBus integration and the awesome-client utility
  • asciidoc and xmlto for generating man pages
  • gzip for compressing man pages
  • ldoc for generating the documentation
  • busted for running unit tests
  • luacheck for static code analysis
  • LuaCov for collecting code coverage information
  • libexecinfo on systems where libc does not provide backtrace_symbols() to generate slightly better backtraces on crashes
  • Xephyr or Xvfb for running integration tests

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).