Main Page
English • Français • РуÑÑкий • 䏿–‡
Contents
The goal of this wiki is to provide a community-made documentation and especially help new users with the configuration of awesome. We cover developer information too, including information about how-to build awesome (several related distributions), how-to debug, and so on.
Note: Due to spammers, you must create an account in order to edit pages. While having to create an account to edit is annoying, so is spam.
Feel free to register as a user and contribute to our documentation effort.
Current awesome releases:
Documentation
Configuration and control of awesome have changed between major versions and may continue to evolve in future ones. Some of the following documents may try to describe all the existing versions. Please fix them if a missing version needs special explanations. Other documents may be bound to only one version of awesome. Please fix them if version indication is missing.
Installation & Basics For Users
Development Basics
Reviews & News
You might also want to join our IRC channel #awesome on OFTC.
Customization
Statusbars and widgets
Theming awesome
User configuration files
Examples of other users' configuration files.
Other tips
Lua extensions
Lua is a fast, light-weight, embeddable scripting language. Lua combines simple procedural syntax with powerful data description constructs based on associative arrays and extensible semantics. Lua is dynamically typed, runs by interpreting bytecode for a register-based virtual machine, and has automatic memory management with incremental garbage collection, making it ideal for configuration, scripting, and rapid prototyping.
Common uses of Lua are:
To get introduced into Lua, please read the briefest introduction to Lua. For deeper knowledge please read this tutorial for the newcomers to the language. As a suggestion, please consider to get this Lua Short Reference. The Awesome framework is built with Lua as the extension language. Some of all extensions can be seen below:
More
Most people these days are used to having a more complete desktop. This section includes links to various apps that are lightweight and useful from within awesome to fill the gaps between just a window manager and a full-blown desktop environment like KDE or GNOME.






