AWESOMERC(5)AWESOMERC(5)NAME
awesomerc - Configuration file for the awesome window manager
SYNOPSIS
awesome looks for a configuration file in this order:
o $XDG_CONFIG_HOME/awesome/rc.lua
o $HOME/.config/awesome/rc.lua
o XDG_CONFIG_DIRS/awesome/rc.lua
DESCRIPTION
The rc.lua file contains configuration information for awesome. It can be used to configure the behavior and look of awesome in a variety
of ways. It can be assimilated as a Lua program/script run at startup by awesome. Therefore, it should use the awesome Lua API described in
the API section. This file is read at startup.
AWESOME LUA API
Documentation for the Lua API can be found in the luadoc directory.
COLORS FORMAT
The color format in awesome is either a standard X color name (blue, darkblue, lightred, etc) or a hexadecimal formatted color (#rrggbb or
#rrggbbaa). By using the hexadecimal format, you can also specify an alpha channel: that means that #00ff00 will draw pure green, but
#00ff00aa will set the alpha channel to 'aa' and will blend the green with the color under it.
TEXT FORMAT
You can use Pango markup in a text string. This allows formating the text rendered inside widgets. Pango markup documentation can be found
in the Pango documentation at http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html.
A Pango markup example: <span weight="bold" foreground="#336699">...</span>.
SEE ALSO awesome(1)awesome-client(1)AUTHORS
Written by Julien Danjou <julien@danjou.info[1]>.
WWW
http://awesome.naquadah.org
NOTES
1. julien@danjou.info
mailto:julien@danjou.info
07/16/2012 AWESOMERC(5)
Check Out this Related Man Page
flaw(7) Miscellaneous Information Manual flaw(7)NAME
flaw - a Lua OO management framework for awesome WM widgets
DESCRIPTION
flaw stands for Fully Loaded AWesome. It is a LUA object oriented library providing a thin abstraction layer above awesome widgets. It is
aimed at being simple and resources efficient.
To achieve these goals, flaw provides the following concepts.
gadgets
To add functionality to awesome widgets, flaw defines gadget objects, which are a wrapper around a widget. All gadgets have proper-
ties, events, a refresh mechanism and a data provider (see below). Gadgets can wrap all awesome widget type, namely text boxes,
image boxes, graphs or progress bars. flaw provides many gadgets for common system information (like CPU or memory activity).
provider
flaw tries to minimise system access and data refresh. Since all information do not have the same expiration rate, all gadgets
refresh independently. And since some gadgets can share information, all data is provided by providers which can be shared among
gadgets. Providers maintain status data from the system and refreshes only when necessary (ie. when the gadget with the shortest
refresh rate demands it).
events Events are a way for the user to modify the gadget behaviour or properties when some conditions are met. An event is composed of a
trigger, which computes the condition, and an action. Event triggers are tested by the providers only when data changes. Both the
condition and the action are provided by the user.
USAGE
flaw depends on the lua-filesystem package which can be found http://luaforge.net/projects/luafilesystem. Once installed, the following
statement must be inserted in awesome configuration before any flaw gadget or mechanism is used.
require('flaw')
Using flaw consists in creating gadgets, passing them parameters to customize their display and events to add some behaviour to them, and
then adding them in a wibox like any other awesome widget. flaw and awful gadgets can live together. The complete flaw documentation is
available in Luadoc format. Enter the following command to generate it.
LUA_PATH="path_toflaw/doclet/html/?;;" luadoc -d html --nofiles *.lua
DIAGNOSTICS
flaw tries to recover upon bad invocations. When something wrong occurs, it outputs warning or error messages to stderr (for example, if
awesome was started with xsession, output will be found in ~/.xsession-errors ).
BUGS
Certainly a lot.
AUTHOR
David Soulayrol <david.soulayrol at gmail dot net>
SEE ALSO awesome(1), awesome-client(1), awesomerc(5)
FEBRUARY 2009 flaw(7)