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).
44 *statusbar_set_position* top, bottom, left, right::
45 Set the position of the statusbar.
47 Execute an external program.
49 Replace awesome with another window manager (or itself; i.e. reload config).
50 *widget_tell* widget-identifier data::
51 Feed information to your widgets.
56 Closes the focused client.
57 *client_moveresize* x y width height::
58 Dynamically move and resize floating windows.
59 Coordinates can be relative or absolute. Relative values must begin with + or -.
60 E.g: to move a window 10 pixels up: "+0 \+10 +0 +0" To move a window
61 in the upper left corner and increase its width by 10px: "0 0 \+0 +10"
62 *client_settrans* float::
63 Set client transparency, number can be a relative or absolute floating number in percentage.
65 Swap window placement with the next displayed window.
67 Swap window placement with the previous displayed window.
71 Focus previous window.
73 Set window fullscreen. Calling this function another time will reset the window to its previous state.
74 *client_togglehorizontalmax*::
75 Set window's horizontal size to display width. Calling another time will reset the window to its previous state.
76 *client_toggleverticalmax*::
77 Set window's vertical size to display height. Calling another time will reset the window to its previous state.
78 *client_togglefloating*::
79 Set window floating or tiled.
81 Set window as master window.
82 *client_movetoscreen* relative or absolute integer::
83 Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number is set, move to the next screen.
84 *client_tag* tag number::
85 Tag focused window with this tag.
87 Add or remove tag to focused window.
89 Move client window with mouse.
90 *client_resizemouse*::
91 Resize client window with mouse.
95 *tag_setlayout* relative or absolute integer::
96 Set layout number; or just switch to the next layout for current tag.
97 *tag_toggleview* tag::
98 Add windows tagged with tag number to current display.
99 *tag_view* tag number::
100 View windows tagged with tag number.
102 Show windows tagged with next tag in list.
104 Show windows tagged with previous tag in list.
105 *tag_viewprev_selected*::
106 Switch back to the previously displayed set of tags.
107 *tag_setmwfact* relative or absolute float::
108 Set master width factor.
109 *tag_setncol* relative or absolute integer::
110 Set number of columns for non-master windows.
111 *tag_setnmaster* relative or absolute integer::
112 Set number of master windows.
114 Create a new tag with that name.
118 *screen_focus* relative or absolute integer::
119 Select Screen and focus first window and move mouse.
123 Statusbars can be customized by modifying widgets names, order and options.
127 This widget shows the tag list.
132 Horizontal offset (auto-alignment if not set).
134 Vertical offset (auto-alignment if not set).
138 This widget shows a icon for the selected layout.
143 Horizontal offset (auto-alignment if not set).
145 Vertical offset (auto-alignment if not set).
149 This widget shows a icon for the focused window using NET_WM_ICON or icon file set in rule.
154 Horizontal offset (auto-alignment if not set).
156 Vertical offset (auto-alignment if not set).
160 This widget shows the title of the focused window.
173 Horizontal offset (auto-alignment if not set).
175 Vertical offset (auto-alignment if not set).
179 This widget shows a list of running windows.
190 Background color for focused window.
192 Foreground color for focused window.
196 Show applications icons.
198 Show all windows from all tags.
200 Horizontal offset (auto-alignment if not set).
202 Vertical offset (auto-alignment if not set).
206 This widget shows a text.
223 Horizontal offset (auto-alignment if not set).
225 Vertical offset (auto-alignment if not set).
229 This widget shows an icon.
236 Resize icon to fit into statusbar.
238 Horizontal offset (auto-alignment if not set).
240 Vertical offset (auto-alignment if not set).
244 This widget shows one or more progress-bars.
251 Set height (i.e. 0.9 = 90%)
253 Empty space on the left.
255 Draws a bar; Options: fg, bg, bordercolor.
263 Horizontal offset (auto-alignment if not set).
265 Vertical offset (auto-alignment if not set).
269 This widget shows a graph.
272 Re-scales when input > max (see below).
274 This value prints a full graph.
280 Set height (i.e. 0.9 = 90%)
282 Empty space on the left.
290 Horizontal offset (auto-alignment if not set).
292 Vertical offset (auto-alignment if not set).
297 Configuration options and possible values.
299 ..............................................
300 Note: when there is no whitespace, quotes are optional.
302 <boolean> -> "true" or "false"
303 <color> -> #ff9933 (hexadecimal color notation: #red green blue)
304 <float> -> 0.3, 0,8 (often values between 0 and 1 are useful)
305 <font> -> Xft font: mono-10, fixed-12, sans-8, ...
306 <identifier> -> foobar (choose a name/string)
307 <image> -> "/home/awesome/pics/icon.png" (path to image)
308 <integer> -> 1, 10, -3 (positive numbers are required mostly)
309 <key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
310 <mod> -> "Mod1", "Mod4", "Control" (modifiers)
311 <regex> -> regular expression
312 <string> -> "foo bar"
313 <uicb-arg> -> prog, 3... (argument to a uicb function, where required)
314 <uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
315 <{.., ...}> -> list of available options
317 [MULTI] means, you can use an item multiple times.
321 screen <integer> [MULTI]
325 allow_lower_floats = <boolean>
327 focus_move_pointer = <boolean>
329 new_become_master = <boolean>
330 new_get_focus = <boolean>
331 opacity_unfocused = <integer>
332 resize_hints = <boolean>
333 sloppy_focus = <boolean>
338 tag <identifier> [MULTI]
340 layout = <{dwindle,floating,max,
341 spiral,tile,tileleft}>
348 layout <{dwindle,floating,max,
349 spiral,tile,tileleft}> { image = <image> } [MULTI]
356 normal_border = <color>
359 focus_border = <color>
370 statusbar <identifier> [MULTI]
372 position = <{top,bottom,left,right}>
376 taglist <identifier> [MULTI]
378 x = <integer> y = <integer>
381 button = <integer> modkey = {<mod>, ...}
382 command = <uicb-cmd> arg = <uicb-arg>
385 layoutinfo <identifier>
387 x = <integer> y = <integer>
390 button = <integer> modkey = {<mod>, ...}
391 command = <uicb-cmd> arg = <uicb-arg>
394 netwmicon <identifier>
396 x = <integer> y = <integer>
399 button = <integer> modkey = {<mod>, ...}
400 command = <uicb-cmd> arg = <uicb-arg>
403 focustitle <identifier>
408 align = <{center,left,right}>
409 x = <integer> y = <integer>
412 button = <integer> modkey = {<mod>, ...}
413 command = <uicb-cmd> arg = <uicb-arg>
416 tasklist <identifier>
423 show_icons = <boolean>
425 align = <{center,left,right}>
426 x = <integer> y = <integer>
429 command = <uicb-cmd> arg = <uicb-arg>
430 button = <integer> modkey = {<mod>, ...}
433 textbox <identifier> [MULTI]
440 align = <{center,left,right}>
441 x = <integer> y = <integer>
444 button = <integer> modkey = {<mod>, ...}
445 command = <uicb-cmd> arg = <uicb-arg>
448 iconbox <identifier> [MULTI]
452 x = <integer> y = <integer>
455 button = <integer> modkey = {<mod>, ...}
456 command = <uicb-cmd> arg = <uicb-arg>
459 progressbar <identifier> [MULTI]
461 bar { fg = <color> bg = <color> bordercolor = <color> } [MULTI]
465 padding_left = <integer>
466 x = <integer> y = <integer>
469 button = <integer> modkey = {<mod>, ...}
470 command = <uicb-cmd> arg = <uicb-arg>
473 graph <identifier> [MULTI]
479 padding_left = <integer>
482 bordercolor = <color>
483 x = <integer> y = <integer>
486 button = <integer> modkey = {<mod>, ...}
487 command = <uicb-cmd> arg = <uicb-arg>
497 xproperty_name = <string>
498 xproperty_value = <regex>
499 float = <{auto,true,false}>
503 not_master = <boolean>
510 key = <key> modkey = {<mod>, ...}
511 command = <uicb-cmd> arg = <uicb-arg>
515 keylist = {<key>, ...}
516 modkey = {<mod>, ...}
518 arglist = {<uicb-arg>, ...}
525 button = <integer> modkey = {<mod>, ...}
526 command = <uicb-cmd> arg = <uicb-arg>
530 button = <integer> modkey = {<mod>, ...}
531 command = <uicb-cmd> arg = <uicb-arg>
534 ..............................................
539 Check awesome's wiki: http://awesome.naquadah.org/wiki/
544 awesome(1) awesome-client(1)
549 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
553 http://awesome.naquadah.org