7 awesomerc - Configuration file for the 'awesome window manager'
16 <item> [<argument>] { <option> = <value>, ... }
27 The awesomerc file contains configuration informations for *awesome*. It can
28 be used to configure the behaviour and look of awesome in a variety of ways.
30 It is read at startup.
35 In awesome, a lot of *functions* are available. These functions are called
36 uicb (User Interface Call Backs). Each function can be bound to a key shortcut
42 This function quits awesome.
43 *statusbar_toggle* statusbar-identifier::
44 Hide or show statusbar (with no argument, toggle all).
46 Execute an external program.
48 Replace awesome with another window manager (or itself; i.e. reload config).
49 *widget_tell* widget-identifier data::
50 Feed information to your widgets.
55 Closes the focused client.
56 *client_moveresize* x y width height::
57 Dynamically move and resize floating windows.
58 Coordinates can be relative or absolute. Relative values must begin with + or -.
59 E.g: to move a window 10 pixels up: "+0 \+10 +0 +0" To move a window
60 in the upper left corner and increase its width by 10px: "0 0 \+0 +10"
61 *client_settrans* float::
62 Set client transparency, number can be a relative or absolute floating number in percentage.
64 Swap window placement with the next displayed window.
66 Swap window placement with the previous displayed window.
70 Focus previous window.
72 Set window fullscreen. Calling this function another time will reset the window to its previous state.
73 *client_togglehorizontalmax*::
74 Set window's horizontal size to display width. Calling another time will reset the window to its previous state.
75 *client_toggleverticalmax*::
76 Set window's vertical size to display height. Calling another time will reset the window to its previous state.
77 *client_togglefloating*::
78 Set window floating or tiled.
80 Set window as master window.
81 *client_movetoscreen* relative or absolute integer::
82 Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number is set, move to the next screen.
83 *client_tag* tag number::
84 Tag focused window with this tag.
86 Add or remove tag to focused window.
88 Move client window with mouse.
89 *client_resizemouse*::
90 Resize client window with mouse.
92 Set or unset client as being the scratch window.
93 *client_togglescratch*::
94 Toggle scratch window.
98 *tag_setlayout* relative or absolute integer::
99 Set layout number; or just switch to the next layout for current tag.
100 *tag_toggleview* tag::
101 Add windows tagged with tag number to current display.
102 *tag_view* tag number::
103 View windows tagged with tag number.
105 Show windows tagged with next tag in list.
107 Show windows tagged with previous tag in list.
108 *tag_prev_selected*::
109 Switch back to the previously displayed set of tags.
110 *tag_setmwfact* relative or absolute float::
111 Set master width factor.
112 *tag_setncol* relative or absolute integer::
113 Set number of columns for non-master windows.
114 *tag_setnmaster* relative or absolute integer::
115 Set number of master windows.
117 Create a new tag with that name.
121 *focus_client_byname* string::
122 Give client focus by its name.
123 *focus_history* negative number::
124 Focus the client that had focused nth focus switch earlier.
128 *screen_focus* relative or absolute integer::
129 Select Screen and focus first window and move mouse.
133 Statusbars can be customized by modifying widgets names, order and options.
137 This widget shows the tag list.
142 Horizontal offset (auto-alignment if not set).
144 Vertical offset (auto-alignment if not set).
150 This widget shows a icon for the selected layout.
155 Horizontal offset (auto-alignment if not set).
157 Vertical offset (auto-alignment if not set).
163 This widget shows a icon for the focused window using NET_WM_ICON or icon file set in rule.
168 Horizontal offset (auto-alignment if not set).
170 Vertical offset (auto-alignment if not set).
176 This widget shows a list of running windows.
187 Background color for focused window.
189 Foreground color for focused window.
193 Show applications icons.
195 Show all windows from all tags, tags clients only or focused client.
197 Horizontal offset (auto-alignment if not set).
199 Vertical offset (auto-alignment if not set).
203 This widget shows a text.
220 Horizontal offset (auto-alignment if not set).
222 Vertical offset (auto-alignment if not set).
228 This widget shows an icon.
235 Resize icon to fit into statusbar.
237 Horizontal offset (auto-alignment if not set).
239 Vertical offset (auto-alignment if not set).
245 This widget shows one or more progress-bars.
248 Draws a bar; Options: fg, bg, bordercolor.
252 Foreground color in the center of the bar (as gradient).
254 Foreground color at the end of a bar (as gradient).
264 Set height (i.e. 0.9 = 90%)
266 Empty space on both sides.
268 Horizontal offset (auto-alignment if not set).
270 Vertical offset (auto-alignment if not set).
276 This widget shows a graph.
279 Defines a data-stream section; Options: max, scale, fg and style.
281 This value prints a full graph (default = 100)
283 Re-scales when input > max (see below).
287 Foreground color in the center of the bar (as gradient).
289 Foreground color at the end of a bar (as gradient).
291 bottom (fills to bottom with fg), top, or line.
297 Set height (i.e. 0.9 = 90%)
299 Empty space on the left.
305 Horizontal offset (auto-alignment if not set).
307 Vertical offset (auto-alignment if not set).
314 Configuration options and possible values.
316 ..............................................
317 Note: when there is no whitespace, quotes are optional.
319 <boolean> -> "true" or "false"
320 <color> -> #ff9933 (hexadecimal color notation: #red green blue)
321 <float> -> 0.3, 0,8 (often values between 0 and 1 are useful)
322 <font> -> Xft font: mono-10, fixed-12, sans-8, ...
323 <identifier> -> foobar (choose a name/string)
324 <image> -> "/home/awesome/pics/icon.png" (path to image)
325 <integer> -> 1, 10, -3 (positive numbers are required mostly)
326 <key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
327 or a keycode beginning with #
328 <mod> -> "Mod1", "Mod4", "Control" (modifiers)
329 <regex> -> regular expression
330 <string> -> "foo bar"
331 <uicb-arg> -> prog, 3... (argument to a uicb function, where required)
332 <uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
333 <{.., ...}> -> list of available options
335 [MULTI] means, you can use an item multiple times.
339 screen <integer> [MULTI]
345 new_become_master = <boolean>
346 new_get_focus = <boolean>
347 opacity_unfocused = <integer>
348 resize_hints = <boolean>
349 sloppy_focus = <boolean>
350 sloppy_focus_raise = <boolean>
352 floating_placement = <{smart,under_mouse}>
356 tag <identifier> [MULTI]
358 layout = <{dwindle,floating,max,
359 spiral,tile,tileleft,tilebottom,tiletop}>
366 layout <{dwindle,floating,max,
367 spiral,tile,tileleft,
368 tilebottom,tiletop}> { image = <image> } [MULTI]
375 normal_border = <color>
378 focus_border = <color>
389 statusbar <identifier> [MULTI]
391 position = <{top,bottom,left,right}>
395 taglist <identifier> [MULTI]
397 x = <integer> y = <integer>
398 align = <{auto,right,left}>
401 button = <integer> modkey = {<mod>, ...}
402 command = <uicb-cmd> arg = <uicb-arg>
405 layoutinfo <identifier>
407 x = <integer> y = <integer>
408 align = <{auto,right,left}>
411 button = <integer> modkey = {<mod>, ...}
412 command = <uicb-cmd> arg = <uicb-arg>
415 focusicon <identifier>
417 x = <integer> y = <integer>
418 align = <{auto,right,left}>
421 button = <integer> modkey = {<mod>, ...}
422 command = <uicb-cmd> arg = <uicb-arg>
425 tasklist <identifier>
432 show_icons = <boolean>
433 show = <{all,tags,focus}>
434 text_align = <{center,left,right}>
435 x = <integer> y = <integer>
438 command = <uicb-cmd> arg = <uicb-arg>
439 button = <integer> modkey = {<mod>, ...}
442 textbox <identifier> [MULTI]
449 text_align = <{center,left,right}>
450 x = <integer> y = <integer>
451 align = <{auto,right,left}>
454 button = <integer> modkey = {<mod>, ...}
455 command = <uicb-cmd> arg = <uicb-arg>
458 iconbox <identifier> [MULTI]
462 x = <integer> y = <integer>
463 align = <{auto,right,left}>
466 button = <integer> modkey = {<mod>, ...}
467 command = <uicb-cmd> arg = <uicb-arg>
470 progressbar <identifier> [MULTI]
474 fg = <color> fg_center = <color> fg_end = <color>
475 bg = <color> bordercolor = <color>
481 x = <integer> y = <integer>
482 align = <{auto,right,left}>
485 button = <integer> modkey = {<mod>, ...}
486 command = <uicb-cmd> arg = <uicb-arg>
489 graph <identifier> [MULTI]
493 scale = <boolean> max = <float> style = <{bottom, top, line}>
494 fg = <color> fg_center = <color> fg_end = <color>
498 padding_left = <integer>
500 bordercolor = <color>
501 x = <integer> y = <integer>
502 align = <{auto,right,left}>
505 button = <integer> modkey = {<mod>, ...}
506 command = <uicb-cmd> arg = <uicb-arg>
516 xproperty_name = <string>
517 xproperty_value = <regex>
518 float = <{auto,true,false}>
519 master = <{auto,true,false}>
530 key = <key> modkey = {<mod>, ...}
531 command = <uicb-cmd> arg = <uicb-arg>
535 keylist = {<key>, ...}
536 modkey = {<mod>, ...}
538 arglist = {<uicb-arg>, ...}
545 button = <integer> modkey = {<mod>, ...}
546 command = <uicb-cmd> arg = <uicb-arg>
550 button = <integer> modkey = {<mod>, ...}
551 command = <uicb-cmd> arg = <uicb-arg>
554 ..............................................
559 Check awesome's wiki: http://awesome.naquadah.org/wiki/
564 awesome(1) awesome-client(1)
569 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
573 http://awesome.naquadah.org