Merge branch 'fix-ldoc-set-spacing' of git://github.com/actionless/awesome
[awesome.git] / manpages / awesomerc.5.txt
blob0a3dff74b1425418524fafbd8dfd13e443fbdd4a
1 awesomerc(5)
2 ===========
4 NAME
5 ----
7 awesomerc - Configuration file for the awesome window manager
9 SYNOPSIS
10 --------
11 *awesome* looks for a configuration file in this order:
13 * $XDG_CONFIG_HOME/awesome/rc.lua
14 * $HOME/.config/awesome/rc.lua
15 * XDG_CONFIG_DIRS/awesome/rc.lua
17 DESCRIPTION
18 -----------
19 The *rc.lua* file contains configuration information for *awesome*. It can
20 be used to configure the behavior and look of awesome in a variety of ways.
21 It can be assimilated as a Lua program/script run at startup by *awesome*.
22 Therefore, it should use the awesome Lua API described in the API section.
23 This file is read at startup.
25 AWESOME LUA API
26 ---------------
27 Documentation for the Lua API can be found in the luadoc directory.
29 COLORS FORMAT
30 -------------
31 The color format in *awesome* is either a standard X color name
32 (blue, darkblue, lightred, etc) or a hexadecimal formatted color (#rrggbb
33 or #rrggbbaa).
34 By using the hexadecimal format, you can also specify an alpha channel:
35 that means that #00ff00 will draw pure green, but #00ff00aa will set the
36 alpha channel to `aa' and will blend the green with the color under it.
38 TEXT FORMAT
39 -----------
40 You can use Pango markup in a text string.
41 This allows formating the text rendered inside widgets.
42 Pango markup documentation can be found in the Pango documentation at
43 http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html.
45 A Pango markup example: <span weight="bold" foreground="#336699">...</span>.
47 SEE ALSO
48 --------
49 awesome(1) awesome-client(1)
51 AUTHORS
52 -------
53 Written by Julien Danjou <julien@danjou.info>.
55 WWW
56 ---
57 http://awesome.naquadah.org