Lua C CMake Other
Permalink
Failed to load latest commit information.
build-utils gears.surface: Use GdkPixbuf Jan 18, 2018
common Reduce code duplication with luaA_*_call_handler (#2321) Jul 25, 2018
docs doc: Remove capi.keygrabber from the official doc Aug 6, 2018
icons icons: remove invaders Sep 8, 2009
lib Merge branch 'moue-typo' of https://github.com/psychon/awesome Aug 15, 2018
manpages Merge branch 'more-manpage-updates' of https://github.com/psychon/awe… Feb 10, 2018
objects doc: Add missing C-object documentation and fix some papercuts. Jul 25, 2018
spec tests: Mock capi.keygrabger Jul 29, 2018
tests Merge branch 'example_tests_during_build_again' of https://github.com… Aug 8, 2018
themes feat(themes; beautiful): add partial support for GTK+3 themes (#2129) Jun 26, 2018
utils Add examples and help text for awesome-client (#2162) Jan 21, 2018
.busted tests: busted: add config file, use --verbose by default (#2076) Oct 22, 2017
.editorconfig Add an EditorConfig file Dec 12, 2015
.gitignore luacheck: enable cache (#2004) Aug 20, 2017
.luacheckrc luacheck: enable cache (#2004) Aug 20, 2017
.luacov luacov: include everything Jan 8, 2017
.mergify.yml Mergify: do not use strict mode (#2319) Jul 24, 2018
.travis.yml tests/examples: Run example-tests in build phase, not configure phase Aug 6, 2018
CMakeLists.txt build: man pages: use asciidoctor instead of asciidoc (#2234) Apr 4, 2018
ISSUE_TEMPLATE.md Add an ISSUE_TEMPLATE.md file (#997) Jul 9, 2016
LICENSE chance license to GPLv2 Sep 12, 2007
Makefile Makefile: distclean: do not try to rm `awesome` (#2077) Oct 23, 2017
Packaging.cmake Packaging.cmake: cache CPACK_GENERATOR (#1924) Jul 20, 2017
README.md Add README.md symlink Feb 28, 2015
awesome-version-internal.h Add a vim modeline to all C source Dec 12, 2015
awesome.c Check for xdgInitHandle() failures (#2146) Jan 13, 2018
awesome.desktop Remove deprecated Encoding key from awesome.desktop (#1394) Jan 13, 2017
awesome.h remove encoding=utf-8 from modelines Sep 11, 2011
awesomeConfig.cmake CMake: Use check_symbol_exists instead of check_function_exists Jul 26, 2018
awesomerc.lua rc.lua: Use request::activate instead of client.focus. Jul 29, 2018
banning.c Fix recursive enterleave ignore (#1747) Apr 21, 2017
banning.h Clean up header includes Mar 30, 2014
color.c Merge pull request #2207 from psychon/alpha_borders Apr 22, 2018
color.h Correctly convert colors with alpha to a Lua string Mar 3, 2018
config.h Merge branch 'find-fallback-config' of https://github.com/psychon/awe… Jan 27, 2017
dbus.c Use signal_array_getbyname() where appropriate Jan 24, 2018
dbus.h remove encoding=utf-8 from modelines Sep 11, 2011
draw.c Add awesome.pixbuf_to_surface Jan 18, 2018
draw.h Add awesome.pixbuf_to_surface Jan 18, 2018
event.c 'Fix' codacy complaining about unused value Nov 17, 2017
event.h Asynchronously update the keyboard state Mar 28, 2017
ewmh.c client: Add request::geometry for client maximization May 23, 2017
ewmh.h C code: save all instead of just one client icons Mar 7, 2017
globalconf.h Asynchronously update the keyboard state Mar 28, 2017
keygrabber.c keygrabber: Refactor to be an object instead of a function. Aug 6, 2018
keygrabber.h Clean up header includes Mar 30, 2014
luaa.c awesome.kill: allow negative PIDs (and 0) to support process groups Jul 4, 2018
luaa.h luaA_warn: Balance stack (#2106) Nov 8, 2017
mouse.c Reduce code duplication with luaA_*_call_handler (#2321) Jul 25, 2018
mouse.h Revert "Support more than 5 mouse buttons" (FS#1082) Mar 29, 2013
mousegrabber.c Remove @release @AWESOME_VERSION@ everywhere (#1157) Oct 9, 2016
mousegrabber.h Revert "Support more than 5 mouse buttons" (FS#1082) Mar 29, 2013
property.c Add signal property::size_hints to clients (#1768) May 13, 2017
property.h Add new request::urgent signal Feb 10, 2015
root.c doc: Add fake_inputs examples. Aug 6, 2018
selection.c Remove @release @AWESOME_VERSION@ everywhere (#1157) Oct 9, 2016
selection.h remove encoding=utf-8 from modelines Sep 11, 2011
spawn.c Use signal_array_getbyname() where appropriate Jan 24, 2018
spawn.h Use command line instead of env for passing children Jun 4, 2017
stack.c doc: fix warnings from doxygen Feb 14, 2015
stack.h Clean up header includes Mar 30, 2014
strut.c geometry: Use the relevant rounding functions instead of integers Apr 18, 2016
strut.h remove encoding=utf-8 from modelines Sep 11, 2011
systray.c Make alpha work on window borders Mar 3, 2018
systray.h Remove unused argument to systray_request_handle() May 29, 2016
xkb.c Asynchronously update the keyboard state Mar 28, 2017
xkb.h Asynchronously update the keyboard state Mar 28, 2017
xrdb.c Don't print warnings for non-existing xrdb values May 24, 2017
xrdb.h Add a vim modeline to all C source Dec 12, 2015
xwindow.c Add & use a non-fatal kind of assert() (#1779) May 13, 2017
xwindow.h Set WM_CLASS and WM_NAME on all our windows (#551) Nov 19, 2015

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

NOTE: Awesome uses cmake to build. In case you want to pass arguments to cmake, please use the CMAKE_ARGS environment variable. For instance:

CMAKE_ARGS="-DCMAKE_INSTALL_PREFIX=/opt/awesome" make

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
  • asciidoctor for generating man pages
  • gzip for compressing man pages
  • ldoc >= 1.4.5 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
  • GTK+ >= 3.10 for ./themes/gtk/

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

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 https://awesomewm.org/apidoc/.

License

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