Main Page

The goal of this wiki is to provide a community-made documentation and especially help new users with the configuration of awesome.

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.

Current awesome releases:

• Stable: awesome-2.3.4 (codename: Morning Trouble)
• Development: Development versions of awesome can be downloaded as tarballs using git snapshots.
• Artwork done by Branko Vukelic.
• Future: awesome 3.0, roadmap for changes in awesome beyond 2.3.

Configuration and control of awesome have changed between major versions and may as well 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.

[edit] Users

• FAQ - Check here first if you're having problems!
• Building awesome - Instructions for building awesome
• awesomerc - A basic awesomerc for awesome 2.3
• awesome-menu - How to use the menu program that comes in awesome 2.3
• Command Reference (2.0)
• awesome 3 configuration - Get help understanding awesome 3 configuration and API basics.

[edit] Developers

• Debugging

[edit] Translations

Parts of this documentation were translated into different languages. Translated documents can contain additional information related to the native language or countries.

[edit] Statusbars and widgets

• Widgets in awesome - You probably already know what widgets are - this is a brief guide on the implementation of widgets within awesome.
• Amazing - Amazing is a ruby-based engine to populate widgets within awesome.
• Status Bar with Amazing - step-by-step HOWTO (development versions of awesome and amazing)
• awesome-status - a simple C-program that populates widgets with awesome2-like configuration file (libconfuse).
• Awesomer - A ruby library for interacting with awesome.
• Widgets - a list of widgets for all versions of awesome.

[edit] Theming awesome

• Colors in awesome - How to change the colors in awesome
• Customizing Fonts - How to add fonts
• Nice Icons - Where to find nice icons to use in your widgets
• User Contributed Themes - User themes / screenshots

[edit] User configuration files

• http://git.glacicle.com/other/configs.git/.config/awesome/rc_30.lua
• http://www.calmar.ws/dotfiles/dotfiledir/dot_awesomerc.lua
• http://tux-atome.fr/rhaamo_config-files.git?a=tree;f=configs/awesome3/dot_config/awesome
• http://github.com/wolgri/wolgri.config/tree/master/.config/awesome/rc.lua
• http://oxmoz.no-ip.org/awesome/rc.lua

[edit] Other tips

• irssi tips - See here for some awesome irssi tips.

• Wicked - a dynamic widget library in lua, for the latest development versions of awesome.
• Eminent - a lua helper library for dynamic tagging in awesome
• Beautiful - a theming library for awesome
• awful - the default awesome lua lib

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.

• Customizing GTK Apps - How to use themes without gnome-settings-daemon
• Terminals - Replacements for desktop environment terminals
• File Managers - Lightweight stand-alone File Managers
• System Tray - If you just can't live without your tray
• Automounting - A replacement for "gnome-volume-manager", "thunar-volman", etc