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.
93 *tag_setlayout* relative or absolute integer::
94 Set layout number; or just switch to the next layout for current tag.
95 *tag_toggleview* tag::
96 Add windows tagged with tag number to current display.
97 *tag_view* tag number::
98 View windows tagged with tag number.
100 Show windows tagged with next tag in list.
102 Show windows tagged with previous tag in list.
103 *tag_prev_selected*::
104 Switch back to the previously displayed set of tags.
105 *tag_setmwfact* relative or absolute float::
106 Set master width factor.
107 *tag_setncol* relative or absolute integer::
108 Set number of columns for non-master windows.
109 *tag_setnmaster* relative or absolute integer::
110 Set number of master windows.
112 Create a new tag with that name.
116 *focus_client_byname* string::
117 Give client focus by its name.
118 *focus_history* negative number::
119 Focus the client that had focused nth focus switch earlier.
123 *screen_focus* relative or absolute integer::
124 Select Screen and focus first window and move mouse.
128 Statusbars can be customized by modifying widgets names, order and options.
132 This widget shows the tag list.
137 Horizontal offset (auto-alignment if not set).
139 Vertical offset (auto-alignment if not set).
143 This widget shows a icon for the selected layout.
148 Horizontal offset (auto-alignment if not set).
150 Vertical offset (auto-alignment if not set).
154 This widget shows a icon for the focused window using NET_WM_ICON or icon file set in rule.
159 Horizontal offset (auto-alignment if not set).
161 Vertical offset (auto-alignment if not set).
165 This widget shows the title of the focused window.
178 Horizontal offset (auto-alignment if not set).
180 Vertical offset (auto-alignment if not set).
184 This widget shows a list of running windows.
195 Background color for focused window.
197 Foreground color for focused window.
201 Show applications icons.
203 Show all windows from all tags.
205 Horizontal offset (auto-alignment if not set).
207 Vertical offset (auto-alignment if not set).
211 This widget shows a text.
228 Horizontal offset (auto-alignment if not set).
230 Vertical offset (auto-alignment if not set).
234 This widget shows an icon.
241 Resize icon to fit into statusbar.
243 Horizontal offset (auto-alignment if not set).
245 Vertical offset (auto-alignment if not set).
249 This widget shows one or more progress-bars.
256 Set height (i.e. 0.9 = 90%)
258 Empty space on the left.
260 Draws a bar; Options: fg, bg, bordercolor.
268 Horizontal offset (auto-alignment if not set).
270 Vertical offset (auto-alignment if not set).
274 This widget shows a graph.
277 Re-scales when input > max (see below).
279 This value prints a full graph.
285 Set height (i.e. 0.9 = 90%)
287 Empty space on the left.
295 Horizontal offset (auto-alignment if not set).
297 Vertical offset (auto-alignment if not set).
302 Configuration options and possible values.
304 ..............................................
305 Note: when there is no whitespace, quotes are optional.
307 <boolean> -> "true" or "false"
308 <color> -> #ff9933 (hexadecimal color notation: #red green blue)
309 <float> -> 0.3, 0,8 (often values between 0 and 1 are useful)
310 <font> -> Xft font: mono-10, fixed-12, sans-8, ...
311 <identifier> -> foobar (choose a name/string)
312 <image> -> "/home/awesome/pics/icon.png" (path to image)
313 <integer> -> 1, 10, -3 (positive numbers are required mostly)
314 <key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
315 or a keycode beginning with #
316 <mod> -> "Mod1", "Mod4", "Control" (modifiers)
317 <regex> -> regular expression
318 <string> -> "foo bar"
319 <uicb-arg> -> prog, 3... (argument to a uicb function, where required)
320 <uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
321 <{.., ...}> -> list of available options
323 [MULTI] means, you can use an item multiple times.
327 screen <integer> [MULTI]
331 allow_lower_floats = <boolean>
333 focus_move_pointer = <boolean>
335 new_become_master = <boolean>
336 new_get_focus = <boolean>
337 opacity_unfocused = <integer>
338 resize_hints = <boolean>
339 sloppy_focus = <boolean>
344 tag <identifier> [MULTI]
346 layout = <{dwindle,floating,max,
347 spiral,tile,tileleft,tilebottom,tiletop}>
354 layout <{dwindle,floating,max,
355 spiral,tile,tileleft,
356 tilebottom,tiletop}> { image = <image> } [MULTI]
363 normal_border = <color>
366 focus_border = <color>
377 statusbar <identifier> [MULTI]
379 position = <{top,bottom,left,right}>
383 taglist <identifier> [MULTI]
385 x = <integer> y = <integer>
388 button = <integer> modkey = {<mod>, ...}
389 command = <uicb-cmd> arg = <uicb-arg>
392 layoutinfo <identifier>
394 x = <integer> y = <integer>
397 button = <integer> modkey = {<mod>, ...}
398 command = <uicb-cmd> arg = <uicb-arg>
401 netwmicon <identifier>
403 x = <integer> y = <integer>
406 button = <integer> modkey = {<mod>, ...}
407 command = <uicb-cmd> arg = <uicb-arg>
410 focustitle <identifier>
415 align = <{center,left,right}>
416 x = <integer> y = <integer>
419 button = <integer> modkey = {<mod>, ...}
420 command = <uicb-cmd> arg = <uicb-arg>
423 tasklist <identifier>
430 show_icons = <boolean>
432 align = <{center,left,right}>
433 x = <integer> y = <integer>
436 command = <uicb-cmd> arg = <uicb-arg>
437 button = <integer> modkey = {<mod>, ...}
440 textbox <identifier> [MULTI]
447 align = <{center,left,right}>
448 x = <integer> y = <integer>
451 button = <integer> modkey = {<mod>, ...}
452 command = <uicb-cmd> arg = <uicb-arg>
455 iconbox <identifier> [MULTI]
459 x = <integer> y = <integer>
462 button = <integer> modkey = {<mod>, ...}
463 command = <uicb-cmd> arg = <uicb-arg>
466 progressbar <identifier> [MULTI]
468 bar { fg = <color> bg = <color> bordercolor = <color> } [MULTI]
472 padding_left = <integer>
473 x = <integer> y = <integer>
476 button = <integer> modkey = {<mod>, ...}
477 command = <uicb-cmd> arg = <uicb-arg>
480 graph <identifier> [MULTI]
486 padding_left = <integer>
489 bordercolor = <color>
490 x = <integer> y = <integer>
493 button = <integer> modkey = {<mod>, ...}
494 command = <uicb-cmd> arg = <uicb-arg>
504 xproperty_name = <string>
505 xproperty_value = <regex>
506 float = <{auto,true,false}>
510 not_master = <boolean>
517 key = <key> modkey = {<mod>, ...}
518 command = <uicb-cmd> arg = <uicb-arg>
522 keylist = {<key>, ...}
523 modkey = {<mod>, ...}
525 arglist = {<uicb-arg>, ...}
532 button = <integer> modkey = {<mod>, ...}
533 command = <uicb-cmd> arg = <uicb-arg>
537 button = <integer> modkey = {<mod>, ...}
538 command = <uicb-cmd> arg = <uicb-arg>
541 ..............................................
546 Check awesome's wiki: http://awesome.naquadah.org/wiki/
551 awesome(1) awesome-client(1)
556 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
560 http://awesome.naquadah.org