awesome/awesomerc.5.txt

50 lines
1.3 KiB
Plaintext

awesomerc(5)
===========
NAME
----
awesomerc - Configuration file for the awesome window manager
SYNOPSIS
--------
None.
DESCRIPTION
-----------
The *awesomerc* file contains configuration informations for *awesome*. It can
be used to configure the behaviour 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
---------------
Each function available in awesome Lua implementation is listed below.
Function named package.function are relative to the package and must be called
as is.
Function named object_type:function are objects methods and must be applied on
object with type "object_type".
include::apidocgen.txt[]
COLORS FORMAT
-------------
Colors format in *awesome* are either standard X color names
(blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb).
By using hexadecimal format, you can also specifies 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.
SEE ALSO
--------
awesome(1) awesome-client(1)
AUTHORS
-------
This man page was written by Julien Danjou <julien@danjou.info>.
WWW
---
http://awesome.naquadah.org