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 None.
  12
  13 DESCRIPTION
  14 -----------
  15 The *awesomerc* file contains configuration informations for *awesome*. It can
  16 be used to configure the behaviour and look of awesome in a variety of ways.
  17 It can be assimilated as a Lua program/script run at startup by awesome.
  18 Therefore, it should use the awesome Lua API described in the API section.
  19 This file is read at startup.
  20
  21 AWESOME LUA API
  22 ---------------
  23
  24 Documentation for the Lua API can be found in the luadoc directory.
  25
  26 COLORS FORMAT
  27 -------------
  28 Colors format in *awesome* are either standard X color names
  29 (blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb).
  30 By using hexadecimal format, you can also specifies an alpha channel:
  31 that means that #00ff00 will draw pure green, but #00ff00aa will set the
  32 alpha channel to `aa' and will blend the green with the color under it.
  33
  34 TEXT FORMAT
  35 -----------
  36 You can use and mix pango-markup and awesome-markup in text string.
  37 Pango markup documentation can be found in the pango documentation at
  38 http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html.
  39
  40 List of awesome markup and their attribute:
  41
  42 * bg
  43   - color: background color
  44   - image: background image
  45   - align: background image alignment
  46   - resize: resize background image to text size
  47 * border
  48   - color: border color
  49   - width: border width
  50 * margin
  51   - left: left margin in pixel
  52   - right: right margin in pixel
  53 * text
  54   - align: text alignment
  55   - shadow: shadow color
  56   - shadow_offset: shadow color offset in pixel
  57
  58
  59 A pango-markup example: <span weight="bold" foreground="#336699">...</span>.
  60 An awesome-markup example: <text align="right"/>.
  61
  62 WIDGETS
  63 -------
  64 The current list of available widget is:
  65
  66 - graph
  67 - progressbar
  68 - taglist
  69 - tasklist
  70 - textbox
  71 - systray
  72
  73 Each widget as its own set of properties, described below, that can bet modified with the set()
  74 method.
  75
  76 SEE ALSO
  77 --------
  78 awesome(1) awesome-client(1)
  79
  80 AUTHORS
  81 -------
  82 This man page was written by Julien Danjou <julien@danjou.info>.
  83
  84 WWW
  85 ---
  86 http://awesome.naquadah.org