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 *rc.lua* 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 Documentation for the Lua API can be found in the luadoc directory.
  28
  29 COLORS FORMAT
  30 -------------
  31 Colors format in *awesome* are either standard X color names
  32 (blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb
  33 or #rrggbbaa).
  34 By using hexadecimal format, you can also specifies 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.
  37
  38 TEXT FORMAT
  39 -----------
  40 You can use and mix Pango markup and awesome markup in text string.
  41 This allows to format the text rendered in widgets.
  42 Pango markup documentation can be found in the Pango documentation at
  43 http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html.
  44
  45 List of *awesome* markup elements and their attributes:
  46
  47 * bg
  48   - color: background color
  49   - image: path to a background image
  50   - align: background image alignment
  51   - resize: resize background image to text size
  52 * border
  53   - color: border color
  54   - width: border width
  55 * margin
  56   - left: left margin in pixel
  57   - right: right margin in pixel
  58   - top: top margin in pixel
  59 * text
  60   - align: text alignment
  61   - shadow: shadow color
  62   - shadow_offset: shadow color offset in pixel
  63
  64
  65 A Pango markup example: <span weight="bold" foreground="#336699">...</span>.
  66
  67 An *awesome* markup example: <text align="right"/>.
  68
  69 SEE ALSO
  70 --------
  71 awesome(1) awesome-client(1)
  72
  73 AUTHORS
  74 -------
  75 Written by Julien Danjou <julien@danjou.info>.
  76
  77 WWW
  78 ---
  79 http://awesome.naquadah.org