7 awesomerc - Configuration file for the 'awesome window manager'
16 <item> [<argument>] { <option> = <value>, ... }
26 The awesomerc file contains configuration informations for *awesome*. It can
27 be used to configure the behaviour and look of awesome in a variety of ways.
29 It is read at startup.
34 In awesome, a lot of *functions* are available. These functions are called
35 uicb (User Interface Call Backs). Each function can be bound to a key shortcut
41 This function quits awesome.
42 *statusbar_toggle* statusbar-identifier::
43 Hide or show statusbar (with no argument, toggle all).
45 Execute an external program.
47 Replace awesome with another window manager (or itself; i.e. reload config).
48 *widget_tell* widget-identifier data::
49 Feed information to your widgets.
54 Closes the focused client.
55 *client_moveresize* x y width height::
56 Dynamically move and resize floating windows.
57 Coordinates can be relative or absolute. Relative values must begin with + or -.
58 E.g: to move a window 10 pixels up: "+0 \+10 +0 +0" To move a window
59 in the upper left corner and increase its width by 10px: "0 0 \+0 +10"
60 *client_settrans* float::
61 Set client transparency, number can be a relative or absolute floating number in percentage.
63 Swap window placement with the next displayed window.
65 Swap window placement with the previous displayed window.
69 Focus previous window.
71 Set window fullscreen. Calling this function another time will reset the window to its previous state.
72 *client_togglehorizontalmax*::
73 Set window's horizontal size to display width. Calling another time will reset the window to its previous state.
74 *client_toggleverticalmax*::
75 Set window's vertical size to display height. Calling another time will reset the window to its previous state.
76 *client_togglefloating*::
77 Set window floating or tiled.
79 Set window as master window.
80 *client_movetoscreen* relative or absolute integer::
81 Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number is set, move to the next screen.
82 *client_tag* tag number::
83 Tag focused window with this tag.
85 Add or remove tag to focused window.
87 Move client window with mouse.
88 *client_resizemouse*::
89 Resize client window with mouse.
91 Set or unset client as being the scratch window.
92 *client_togglescratch*::
93 Toggle scratch window.
97 *tag_setlayout* relative or absolute integer::
98 Set layout number; or just switch to the next layout for current tag.
99 *tag_toggleview* tag::
100 Add windows tagged with tag number to current display.
101 *tag_view* tag number::
102 View windows tagged with tag number.
104 Show windows tagged with next tag in list.
106 Show windows tagged with previous tag in list.
107 *tag_prev_selected*::
108 Switch back to the previously displayed set of tags.
109 *tag_setmwfact* relative or absolute float::
110 Set master width factor.
111 *tag_setncol* relative or absolute integer::
112 Set number of columns for non-master windows.
113 *tag_setnmaster* relative or absolute integer::
114 Set number of master windows.
116 Create a new tag with that name.
120 *focus_client_byname* string::
121 Give client focus by its name.
122 *focus_history* negative number::
123 Focus the client that had focused nth focus switch earlier.
127 *screen_focus* relative or absolute integer::
128 Select Screen and focus first window and move mouse.
132 Statusbars can be customized by modifying widgets names, order and options.
136 This widget shows the tag list.
141 Horizontal offset (auto-alignment if not set).
143 Vertical offset (auto-alignment if not set).
149 This widget shows a icon for the selected layout.
154 Horizontal offset (auto-alignment if not set).
156 Vertical offset (auto-alignment if not set).
162 This widget shows a icon for the focused window using NET_WM_ICON or icon file set in rule.
167 Horizontal offset (auto-alignment if not set).
169 Vertical offset (auto-alignment if not set).
175 This widget shows a list of running windows.
186 Background color for focused window.
188 Foreground color for focused window.
192 Show applications icons.
194 Show all windows from all tags, tags clients only or focused client.
196 Horizontal offset (auto-alignment if not set).
198 Vertical offset (auto-alignment if not set).
202 This widget shows a text.
219 Horizontal offset (auto-alignment if not set).
221 Vertical offset (auto-alignment if not set).
227 This widget shows an icon.
234 Resize icon to fit into statusbar.
236 Horizontal offset (auto-alignment if not set).
238 Vertical offset (auto-alignment if not set).
244 This widget shows one or more progress-bars.
247 Draws a bar; Options: fg, bg, bordercolor.
251 Foreground color in the center of the bar (as gradient).
253 Foreground color at the end of a bar (as gradient).
263 Set height (i.e. 0.9 = 90%)
265 Empty space on both sides.
267 Horizontal offset (auto-alignment if not set).
269 Vertical offset (auto-alignment if not set).
275 This widget shows a graph.
278 Defines a data-stream section; Options: max, scale, fg and style.
280 This value prints a full graph (default = 100)
282 Re-scales when input > max (see below).
286 Foreground color in the center of the bar (as gradient).
288 Foreground color at the end of a bar (as gradient).
290 bottom (fills to bottom with fg), top, or line.
296 Set height (i.e. 0.9 = 90%)
298 Empty space on the left.
304 Horizontal offset (auto-alignment if not set).
306 Vertical offset (auto-alignment if not set).
313 Configuration options and possible values.
315 ..............................................
316 Note: when there is no whitespace, quotes are optional.
318 <boolean> -> "true" or "false"
319 <color> -> #ff9933 (hexadecimal color notation: #red green blue)
320 <float> -> 0.3, 0,8 (often values between 0 and 1 are useful)
321 <font> -> Xft font: mono-10, fixed-12, sans-8, ...
322 <identifier> -> foobar (choose a name/string)
323 <image> -> "/home/awesome/pics/icon.png" (path to image)
324 <integer> -> 1, 10, -3 (positive numbers are required mostly)
325 <key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
326 or a keycode beginning with #
327 <mod> -> "Mod1", "Mod4", "Control" (modifiers)
328 <regex> -> regular expression
329 <string> -> "foo bar"
330 <uicb-arg> -> prog, 3... (argument to a uicb function, where required)
331 <uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
332 <{.., ...}> -> list of available options
334 [MULTI] means, you can use an item multiple times.
338 screen <integer> [MULTI]
344 new_become_master = <boolean>
345 new_get_focus = <boolean>
346 opacity_unfocused = <integer>
347 resize_hints = <boolean>
348 sloppy_focus = <boolean>
349 sloppy_focus_raise = <boolean>
351 floating_placement = <{smart,under_mouse}>
355 tag <identifier> [MULTI]
357 layout = <{dwindle,floating,max,
358 spiral,tile,tileleft,tilebottom,tiletop}>
365 layout <{dwindle,floating,max,
366 spiral,tile,tileleft,
367 tilebottom,tiletop}> { image = <image> } [MULTI]
374 normal_border = <color>
377 focus_border = <color>
388 statusbar <identifier> [MULTI]
390 position = <{top,bottom,left,right}>
394 taglist <identifier> [MULTI]
396 x = <integer> y = <integer>
397 align = <{auto,right,left}>
400 button = <integer> modkey = {<mod>, ...}
401 command = <uicb-cmd> arg = <uicb-arg>
404 layoutinfo <identifier>
406 x = <integer> y = <integer>
407 align = <{auto,right,left}>
410 button = <integer> modkey = {<mod>, ...}
411 command = <uicb-cmd> arg = <uicb-arg>
414 focusicon <identifier>
416 x = <integer> y = <integer>
417 align = <{auto,right,left}>
420 button = <integer> modkey = {<mod>, ...}
421 command = <uicb-cmd> arg = <uicb-arg>
424 tasklist <identifier>
431 show_icons = <boolean>
432 show = <{all,tags,focus}>
433 text_align = <{center,left,right}>
434 x = <integer> y = <integer>
437 command = <uicb-cmd> arg = <uicb-arg>
438 button = <integer> modkey = {<mod>, ...}
441 textbox <identifier> [MULTI]
448 text_align = <{center,left,right}>
449 x = <integer> y = <integer>
450 align = <{auto,right,left}>
453 button = <integer> modkey = {<mod>, ...}
454 command = <uicb-cmd> arg = <uicb-arg>
457 iconbox <identifier> [MULTI]
461 x = <integer> y = <integer>
462 align = <{auto,right,left}>
465 button = <integer> modkey = {<mod>, ...}
466 command = <uicb-cmd> arg = <uicb-arg>
469 progressbar <identifier> [MULTI]
473 fg = <color> fg_center = <color> fg_end = <color>
474 bg = <color> bordercolor = <color>
480 x = <integer> y = <integer>
481 align = <{auto,right,left}>
484 button = <integer> modkey = {<mod>, ...}
485 command = <uicb-cmd> arg = <uicb-arg>
488 graph <identifier> [MULTI]
492 scale = <boolean> max = <float> style = <{bottom, top, line}>
493 fg = <color> fg_center = <color> fg_end = <color>
497 padding_left = <integer>
499 bordercolor = <color>
500 x = <integer> y = <integer>
501 align = <{auto,right,left}>
504 button = <integer> modkey = {<mod>, ...}
505 command = <uicb-cmd> arg = <uicb-arg>
515 xproperty_name = <string>
516 xproperty_value = <regex>
517 float = <{auto,true,false}>
518 master = <{auto,true,false}>
529 key = <key> modkey = {<mod>, ...}
530 command = <uicb-cmd> arg = <uicb-arg>
534 keylist = {<key>, ...}
535 modkey = {<mod>, ...}
537 arglist = {<uicb-arg>, ...}
544 button = <integer> modkey = {<mod>, ...}
545 command = <uicb-cmd> arg = <uicb-arg>
549 button = <integer> modkey = {<mod>, ...}
550 command = <uicb-cmd> arg = <uicb-arg>
553 ..............................................
558 Check awesome's wiki: http://awesome.naquadah.org/wiki/
563 awesome(1) awesome-client(1)
568 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
572 http://awesome.naquadah.org