awesomerc.1.txt

   1 awesomerc(1)
   2 ===========
   3
   4 NAME
   5 ----
   6
   7 awesomerc - Configuration file for the 'awesome window manager'
   8
   9 SYNOPSIS
  10 --------
  11
  12 <item> [<argument>]
  13 {
  14     <option> = <value>
  15
  16     <item> [<argument>] { <option> = <value>, ... }
  17     ....
  18 }
  19
  20 <option> = <value>
  21
  22
  23 DESCRIPTION
  24 -----------
  25
  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.
  28
  29 It is read at startup.
  30
  31 UICB FUNCTIONS
  32 --------------
  33
  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
  36 or a mouse button.
  37
  38 General
  39 ~~~~~~~
  40 *quit*::
  41     This function quits awesome.
  42 *statusbar_toggle* statusbar-identifier::
  43     Hide or show statusbar (with no argument, toggle all).
  44 *spawn* client::
  45     Execute an external program.
  46 *exec* 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.
  50
  51 Client
  52 ~~~~~~
  53 *client_kill*::
  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.
  62 *client_swapnext*::
  63     Swap window placement with the next displayed window.
  64 *client_swapprev*::
  65     Swap window placement with the previous displayed window.
  66 *client_focusnext*::
  67     Focus next window.
  68 *client_focusprev*::
  69     Focus previous window.
  70 *client_togglemax*::
  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.
  78 *client_zoom*::
  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.
  84 *client_toggletag*::
  85     Add or remove tag to focused window.
  86 *client_movemouse*::
  87     Move client window with mouse.
  88 *client_resizemouse*::
  89     Resize client window with mouse.
  90
  91 Tag
  92 ~~~
  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.
  99 *tag_viewnext*::
 100     Show windows tagged with next tag in list.
 101 *tag_viewprev*::
 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.
 111 *tag_create* name::
 112     Create a new tag with that name.
 113
 114 Focus
 115 ~~~~~
 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.
 120
 121 Screen
 122 ~~~~~~
 123 *screen_focus* relative or absolute integer::
 124     Select Screen and focus first window and move mouse.
 125
 126 WIDGETS
 127 -------
 128 Statusbars can be customized by modifying widgets names, order and options.
 129
 130 taglist
 131 ~~~~~~~
 132 This widget shows the tag list.
 133
 134 *mouse*::
 135     Set mouse bindings.
 136 *x*::
 137     Horizontal offset (auto-alignment if not set).
 138 *y*::
 139     Vertical offset (auto-alignment if not set).
 140
 141 layoutinfo
 142 ~~~~~~~~~~
 143 This widget shows a icon for the selected layout.
 144
 145 *mouse*::
 146     Set mouse bindings.
 147 *x*::
 148     Horizontal offset (auto-alignment if not set).
 149 *y*::
 150     Vertical offset (auto-alignment if not set).
 151
 152 netwmicon
 153 ~~~~~~~~~
 154 This widget shows a icon for the focused window  using NET_WM_ICON or icon file set in rule.
 155
 156 *mouse*::
 157     Set mouse bindings.
 158 *x*::
 159     Horizontal offset (auto-alignment if not set).
 160 *y*::
 161     Vertical offset (auto-alignment if not set).
 162
 163 focustitle
 164 ~~~~~~~~~~
 165 This widget shows the title of the focused window.
 166
 167 *mouse*::
 168     Set mouse bindings.
 169 *font*::
 170     Font to use.
 171 *bg*::
 172     Background color.
 173 *fg*::
 174     Foreground color.
 175 *align*::
 176     Text alignement.
 177 *x*::
 178     Horizontal offset (auto-alignment if not set).
 179 *y*::
 180     Vertical offset (auto-alignment if not set).
 181
 182 tasklist
 183 ~~~~~~~~
 184 This widget shows a list of running windows.
 185
 186 *mouse*::
 187     Set mouse bindings.
 188 *font*::
 189     Font to use.
 190 *bg*::
 191     Background color.
 192 *fg*::
 193     Foreground color.
 194 *focus_bg*::
 195     Background color for focused window.
 196 *focus_fg*::
 197     Foreground color for focused window.
 198 *align*::
 199     Text alignement.
 200 *show_icons*::
 201     Show applications icons.
 202 *show_all*::
 203     Show all windows from all tags.
 204 *x*::
 205     Horizontal offset (auto-alignment if not set).
 206 *y*::
 207     Vertical offset (auto-alignment if not set).
 208
 209 textbox
 210 ~~~~~~~
 211 This widget shows a text.
 212
 213 *mouse*::
 214     Set mouse bindings.
 215 *font*::
 216     Font to use.
 217 *bg*::
 218     Background color.
 219 *fg*::
 220     Foreground color.
 221 *width*::
 222     Set width.
 223 *text*::
 224     Text to change.
 225 *align*::
 226     Text alignement.
 227 *x*::
 228     Horizontal offset (auto-alignment if not set).
 229 *y*::
 230     Vertical offset (auto-alignment if not set).
 231
 232 iconbox
 233 ~~~~~~~
 234 This widget shows an icon.
 235
 236 *mouse*::
 237     Set mouse bindings.
 238 *image*::
 239     Image file.
 240 *resize*::
 241     Resize icon to fit into statusbar.
 242 *x*::
 243     Horizontal offset (auto-alignment if not set).
 244 *y*::
 245     Vertical offset (auto-alignment if not set).
 246
 247 progressbar
 248 ~~~~~~~~~~~
 249 This widget shows one or more progress-bars.
 250
 251 *bar*::
 252     Draws a bar; Options: fg, bg, bordercolor.
 253 *fg*::
 254     Foreground color.
 255 *bg*::
 256     Background color.
 257 *bordercolor*::
 258     Border color.
 259 *mouse*::
 260     Set mouse bindings.
 261 *width*::
 262     Set width.
 263 *height*::
 264     Set height (i.e. 0.9 = 90%)
 265 *padding_left*::
 266     Empty space on the left.
 267 *x*::
 268     Horizontal offset (auto-alignment if not set).
 269 *y*::
 270     Vertical offset (auto-alignment if not set).
 271
 272 graph
 273 ~~~~~
 274 This widget shows a graph.
 275
 276 *data*::
 277     Defines a data-stream section; Options: max, scale, fg and style.
 278 *max*::
 279     This value prints a full graph (default = 100)
 280 *scale*::
 281     Re-scales when input > max (see below).
 282 *fg*::
 283     Foreground color.
 284 *style*::
 285     bottom (fills to bottom with fg), top, or line.
 286 *mouse*::
 287     Set mouse bindings.
 288 *width*::
 289     Set width.
 290 *height*::
 291     Set height (i.e. 0.9 = 90%)
 292 *padding_left*::
 293     Empty space on the left.
 294 *bg*::
 295     Background color.
 296 *bordercolor*::
 297     Border color.
 298 *x*::
 299     Horizontal offset (auto-alignment if not set).
 300 *y*::
 301     Vertical offset (auto-alignment if not set).
 302
 303 OPTIONS
 304 --------
 305
 306 Configuration options and possible values.
 307
 308 ..............................................
 309 Note: when there is no whitespace, quotes are optional.
 310
 311 <boolean>       -> "true" or "false"
 312 <color>         -> #ff9933 (hexadecimal color notation: #red green blue)
 313 <float>         -> 0.3, 0,8 (often values between 0 and 1 are useful)
 314 <font>          -> Xft font: mono-10, fixed-12, sans-8, ...
 315 <identifier>    -> foobar (choose a name/string)
 316 <image>         -> "/home/awesome/pics/icon.png" (path to image)
 317 <integer>       -> 1, 10, -3 (positive numbers are required mostly)
 318 <key>           -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
 319                    or a keycode beginning with #
 320 <mod>           -> "Mod1", "Mod4", "Control" (modifiers)
 321 <regex>         -> regular expression
 322 <string>        -> "foo bar"
 323 <uicb-arg>      -> prog, 3... (argument to a uicb function, where required)
 324 <uicb-cmd>      -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
 325 <{.., ...}>     -> list of available options
 326
 327 [MULTI] means, you can use an item multiple times.
 328
 329
 330
 331 screen <integer> [MULTI]
 332 {
 333     general
 334     {
 335         border = <integer>
 336         font = <font>
 337         new_become_master = <boolean>
 338         new_get_focus = <boolean>
 339         resize_hints = <boolean>
 340         sloppy_focus = <boolean>
 341         sloppy_focus_raise = <boolean>
 342         snap = <integer>
 343     }
 344     tags
 345     {
 346         tag <identifier> [MULTI]
 347         {
 348             layout = <{dwindle,floating,max,
 349                      spiral,tile,tileleft,tilebottom,tiletop}>
 350             mwfact = <float>
 351             nmaster = <integer>
 352         }
 353     }
 354     layouts
 355     {
 356         layout <{dwindle,floating,max,
 357                  spiral,tile,tileleft,
 358                  tilebottom,tiletop}> { image = <image> } [MULTI]
 359     }
 360     colors
 361     {
 362         tab_border = <color>
 363         normal_fg = <color>
 364         normal_bg = <color>
 365         normal_border = <color>
 366         focus_fg = <color>
 367         focus_bg = <color>
 368         focus_border = <color>
 369         urgent_fg = <color>
 370         urgent_bg = <color>
 371     }
 372     padding
 373     {
 374         top = <integer>
 375         bottom = <integer>
 376         left = <integer>
 377         right = <integer>
 378     }
 379     statusbar <identifier> [MULTI]
 380     {
 381         position = <{top,bottom,left,right}>
 382         height = <integer>
 383         width = <integer>
 384
 385         taglist <identifier> [MULTI]
 386         {
 387             x = <integer> y = <integer>
 388             mouse [MULTI]
 389             {
 390                 button = <integer> modkey = {<mod>, ...}
 391                 command = <uicb-cmd> arg = <uicb-arg>
 392             }
 393         }
 394         layoutinfo <identifier>
 395         {
 396             x = <integer> y = <integer>
 397             mouse [MULTI]
 398             {
 399                 button = <integer> modkey = {<mod>, ...}
 400                 command = <uicb-cmd> arg = <uicb-arg>
 401             }
 402         }
 403         netwmicon <identifier>
 404         {
 405             x = <integer> y = <integer>
 406             mouse [MULTI]
 407             {
 408                 button = <integer> modkey = {<mod>, ...}
 409                 command = <uicb-cmd> arg = <uicb-arg>
 410             }
 411         }
 412         focustitle <identifier>
 413         {
 414             fg = <color>
 415             bg = <color>
 416             font = <font>
 417             align = <{center,left,right}>
 418             x = <integer> y = <integer>
 419             mouse [MULTI]
 420             {
 421                 button = <integer> modkey = {<mod>, ...}
 422                 command = <uicb-cmd> arg = <uicb-arg>
 423             }
 424         }
 425         tasklist <identifier>
 426         {
 427             fg = <color>
 428             bg = <color>
 429             focus_fg = <color>
 430             focus_bg = <color>
 431             font = <font>
 432             show_icons = <boolean>
 433             show_all = <boolean>
 434             align = <{center,left,right}>
 435             x = <integer> y = <integer>
 436             mouse [MULTI]
 437             {
 438                 command = <uicb-cmd> arg = <uicb-arg>
 439                 button = <integer> modkey = {<mod>, ...}
 440             }
 441         }
 442         textbox <identifier> [MULTI]
 443         {
 444             text = <string>
 445             bg = <color>
 446             fg = <color>
 447             font = <font>
 448             width = <integer>
 449             align = <{center,left,right}>
 450             x = <integer> y = <integer>
 451             mouse [MULTI]
 452             {
 453                 button = <integer> modkey = {<mod>, ...}
 454                 command = <uicb-cmd> arg = <uicb-arg>
 455             }
 456         }
 457         iconbox <identifier> [MULTI]
 458         {
 459             image = <image>
 460             resize = <boolean>
 461             x = <integer> y = <integer>
 462             mouse [MULTI]
 463             {
 464                 button = <integer> modkey = {<mod>, ...}
 465                 command = <uicb-cmd> arg = <uicb-arg>
 466             }
 467         }
 468         progressbar <identifier> [MULTI]
 469         {
 470             bar { fg = <color> bg = <color> bordercolor = <color> } [MULTI]
 471             gap = <integer>
 472             width = <integer>
 473             height = <float>
 474             padding_left = <integer>
 475             x = <integer> y = <integer>
 476             mouse [MULTI]
 477             {
 478                 button = <integer> modkey = {<mod>, ...}
 479                 command = <uicb-cmd> arg = <uicb-arg>
 480             }
 481         }
 482         graph <identifier> [MULTI]
 483         {
 484             data [MULTI]
 485             {
 486                 scale = <boolean> max = <float> fg = <color>
 487                 style = <{bottom, top, line}>
 488             }
 489             width = <integer>
 490             height = <float>
 491             padding_left = <integer>
 492             bg = <color>
 493             bordercolor = <color>
 494             x = <integer> y = <integer>
 495             mouse [MULTI]
 496             {
 497                 button = <integer> modkey = {<mod>, ...}
 498                 command = <uicb-cmd> arg = <uicb-arg>
 499             }
 500         }
 501     }
 502 }
 503 rules
 504 {
 505     rule [MULTI]
 506     {
 507         name = <regex>
 508         xproperty_name = <string>
 509         xproperty_value = <regex>
 510         float = <{auto,true,false}>
 511         tags = <regex>
 512         screen = <integer>
 513         icon = <image>
 514         not_master = <boolean>
 515         opacity = <float>
 516     }
 517 }
 518 keys
 519 {
 520     key [MULTI]
 521     {
 522         key = <key> modkey = {<mod>, ...}
 523         command = <uicb-cmd> arg = <uicb-arg>
 524     }
 525     keylist [MULTI]
 526     {
 527         keylist = {<key>, ...}
 528         modkey = {<mod>, ...}
 529         command = <uicb-cmd>
 530         arglist = {<uicb-arg>, ...}
 531     }
 532 }
 533 mouse
 534 {
 535     client [MULTI]
 536     {
 537         button = <integer> modkey = {<mod>, ...}
 538         command = <uicb-cmd> arg = <uicb-arg>
 539     }
 540     root [MULTI]
 541     {
 542         button = <integer> modkey = {<mod>, ...}
 543         command = <uicb-cmd> arg = <uicb-arg>
 544     }
 545 }
 546 ..............................................
 547
 548 EXAMPLES
 549 --------
 550
 551 Check awesome's wiki: http://awesome.naquadah.org/wiki/
 552
 553
 554 SEE ALSO
 555 --------
 556 awesome(1) awesome-client(1)
 557
 558
 559 AUTHORS
 560 -------
 561 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
 562
 563 WWW
 564 ---
 565 http://awesome.naquadah.org