awesomerc.5.txt

   1 awesomerc(5)
   2 ===========
   3
   4 NAME
   5 ----
   6
   7 awesomerc - Configuration file for the awesome window manager
   8
   9 SYNOPSIS
  10 --------
  11 *awesome* looks for this configuration file in this order:
  12
  13 * $XDG_CONFIG_HOME/awesome/rc.lua
  14 * $HOME/.config/awesome/rc.lua
  15 * XDG_CONFIG_DIRS/awesome/rc.lua
  16
  17 DESCRIPTION
  18 -----------
  19 The *awesomerc* file contains configuration informations for *awesome*. It can
  20 be used to configure the behaviour 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.
  24
  25 AWESOME LUA API
  26 ---------------
  27
  28 Documentation for the Lua API can be found in the luadoc directory.
  29
  30 COLORS FORMAT
  31 -------------
  32 Colors format in *awesome* are either standard X color names
  33 (blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb
  34 or #rrggbbaa).
  35 By using hexadecimal format, you can also specifies an alpha channel:
  36 that means that #00ff00 will draw pure green, but #00ff00aa will set the
  37 alpha channel to `aa' and will blend the green with the color under it.
  38
  39 TEXT FORMAT
  40 -----------
  41 You can use and mix Pango markup and awesome markup in text string.
  42 This allows to format the text rendered in widgets.
  43 Pango markup documentation can be found in the Pango documentation at
  44 http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html.
  45
  46 List of awesome markup elements and their attributes:
  47
  48 * bg
  49   - color: background color
  50   - image: background image
  51   - align: background image alignment
  52   - resize: resize background image to text size
  53 * border
  54   - color: border color
  55   - width: border width
  56 * margin
  57   - left: left margin in pixel
  58   - right: right margin in pixel
  59   - top: top margin in pixel
  60 * text
  61   - align: text alignment
  62   - shadow: shadow color
  63   - shadow_offset: shadow color offset in pixel
  64
  65
  66 A Pango markup example: <span weight="bold" foreground="#336699">...</span>.
  67
  68 An awesome markup example: <text align="right"/>.
  69
  70 SEE ALSO
  71 --------
  72 awesome(1) awesome-client(1)
  73
  74 AUTHORS
  75 -------
  76 Written by Julien Danjou <julien@danjou.info>.
  77
  78 WWW
  79 ---
  80 http://awesome.naquadah.org