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 Each function available in awesome Lua implementation is listed below.
  24 Function named package.function are relative to the package and must be called
  25 as is.
  26 Function named object_type:function are objects methods and must be applied on
  27 object with type "object_type".
  28
  29 include::apidocgen.txt[]
  30
  31 COLORS FORMAT
  32 -------------
  33 Colors format in *awesome* are either standard X color names
  34 (blue, darkblue, lightred, etc) or hexadecimal formatted colors (#rrggbb).
  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/mix pango-markup and awesome-markup on text properties.
  42 A pango-markup example: "<span weight=\'bold\' foreground=\'#336699\'>...</span>".
  43 An awesome-markup example: "<text align=\'right\'>...</text>".
  44
  45 WIDGETS
  46 -------
  47 The current list of available widget is:
  48
  49 - iconbox
  50 - graph
  51 - progressbar
  52 - taglist
  53 - tasklist
  54 - textbox
  55 - systray
  56
  57 Each widget as its own set of properties, described below, that can bet modified with the set()
  58 method.
  59
  60 ICONBOX
  61 ~~~~~~~
  62 *image*::
  63     The image path.
  64
  65 *resize*::
  66     True if you want the image to be auto-resized.
  67
  68 PROGRESSBAR
  69 ~~~~~~~~~~~
  70 A progressbar widget can contain several bars, so some properties need a data section,
  71 that means a title for the bar. For example, if you want to feed data to the `memory' bar
  72 you want to do mywidget:set("data", "memory 100"), where memory will be the data section.
  73 Using a new data section name will automatically create a new bar.
  74
  75
  76 The following properties require a data section before the value:
  77
  78 *data*::
  79     Feed with data.
  80
  81 *fg*::
  82     Foreground color.
  83
  84 *fg_off*::
  85     Color of unfilled area of bar.
  86
  87 *bg*::
  88     Background color (between ticks; border_padding space).
  89
  90 *bordercolor*::
  91     Border color.
  92
  93 *fg_center*::
  94     Foreground center color.
  95
  96 *fg_end*::
  97     Foreground end color.
  98
  99 *min_value*::
 100     Minimum value. This or lower values, draw a 0% bar.
 101
 102 *max_value*::
 103     Maximum value. This or higher values, draw a 100% bar.
 104
 105 *reverse*::
 106     True to draw reverse.
 107
 108
 109 The following properties do not require a data section before the value and applies to all bars inside
 110 the widget:
 111
 112 *gap*::
 113     Gap between borders.
 114
 115 *ticks_count*::
 116     The number of ticks.
 117
 118 *ticks_gap*::
 119     The gap between ticks.
 120
 121 *border_padding*::
 122     The padding inside the border.
 123
 124 *border_width*::
 125     The border width.
 126
 127 *width*::
 128     The widget width.
 129
 130 *height*::
 131     The widget height.
 132
 133 *vertical*::
 134     If \'true\', bars are vertically aligned. If \'false\', horizontally.
 135
 136 GRAPH
 137 ~~~~~
 138 A graph widget can display several data-graphs inside its widget-border. Some
 139 properties need a data section, that means a title for the incoming data. For
 140 example, if you want to feed \'mymemory\' data, you want to do
 141 mywidget:set("data", "mymemory 100").
 142
 143
 144 The following properties require a data section before the value:
 145
 146 *data*::
 147     Feed with data.
 148
 149 *fg*::
 150     Foreground color.
 151
 152 *fg_center*::
 153     Foreground center color.
 154
 155 *fg_end*::
 156     Foreground end color.
 157
 158 *vertical_gradient*::
 159     If \'true\', colorgradient shall be applied vertically.
 160
 161 *max_value*::
 162     Maximum value. Bigger values gets truncated, unless \'scale\' is true.
 163
 164 *scale*::
 165     Scales the graph acccording to incoming values bigger than \'max_value\'.
 166
 167 *draw_style*::
 168     \'bottom\', \'top\' or \'line\'.
 169
 170
 171 The following properties do not require a data section before the value:
 172
 173 *width*::
 174     The widget width.
 175
 176 *height*::
 177     The widget height.
 178
 179 *bg*::
 180     Background color.
 181
 182 *bordercolor*::
 183     Border color.
 184
 185 *grow*::
 186    \'left\' or \'right\'. E.g. \'right\' means new values get added on the right of the widget.
 187
 188 TAGLIST
 189 ~~~~~~~
 190 A taglist widget displays available tags and their state.
 191
 192 *text_normal*::
 193     Text to display on normal clients. \'<title/>\' substitutes the tag's title.
 194
 195 *text_focus*::
 196     Text to display on the focused client. \'<title/>\' gets substituted by the tag's title.
 197
 198 *text_urgent*::
 199     Text to display on urgent clients. \'<title/>\' gets substituted by the tag's title.
 200
 201 *show_empty*::
 202     \'true\' or \'false\'. If \'false\', empty tags won't get displayed. Selected tags are always displayed so.
 203
 204 TASKLIST
 205 ~~~~~~~~
 206 A tasklist widget displays the titles of clients according to the \'show\' setting.
 207
 208 *show*::
 209     \'tags\', \'focus\' or \'all\'. E.g. \'tags\' shows only clients of currently selected tags.
 210
 211 *text_normal*::
 212     Text to display on normal clients. \'<title/>\' gets substituted by the client's title.
 213
 214 *text_focus*::
 215     Text to display on the focused client. \'<title/>\' gets substituted by the client's title.
 216
 217 *text_urgent*::
 218     Text to display on urgent clients. \'<title/>\' gets substituted by the client's title.
 219
 220 *show_icons*::
 221     \'true\' or \'false\'. Set to \'true\' if client's icon (if one is avaiable) shall be displayed.
 222
 223
 224 TEXTBOX
 225 ~~~~~~~
 226 A textbox displays text.
 227
 228 *width*::
 229     Width of the widget.
 230
 231 *text*::
 232     Text to display.
 233
 234 SEE ALSO
 235 --------
 236 awesome(1) awesome-client(1)
 237
 238 AUTHORS
 239 -------
 240 This man page was written by Julien Danjou <julien@danjou.info>.
 241
 242 WWW
 243 ---
 244 http://awesome.naquadah.org