About Awesome

Awesome is a highly configurable, next generation framework window manager for X.

Building and installation

After extracting the dist tarball, run:


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:


Installing current git master as a package receipts

Arch Linux AUR

 sudo pacman -S --needed base-devel git
 git clone
 cd awesome-git
 makepkg -fsri


 sudo apt build-dep awesome
 git clone
 cd awesome
 make package
 sudo apt install *.deb

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.: exec awesome

(This will start Awesome on display :1 of the host


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.


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

Asking questions


You can join us in the #awesome channel on the OFTC IRC network.

IRC Webchat

Stack Overflow

You can ask questions on Stack Overflow.


We also have a awesome subreddit where you can share your work and ask questions.

Reporting issues

Please report any issues you may find on our bugtracker.

Contributing code

You can submit pull requests on the github repository. Please read the contributing guide for any coding, documentation or patch guidelines.


Build Status


Online documentation is available here.


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

generated by LDoc 1.4.6 Last updated 2022-09-28 18:14:15