awesomerc.5.txt

   1 awesomerc(5)
   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 include(file.conf)
  23
  24 DESCRIPTION
  25 -----------
  26
  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.
  29
  30 It is read at startup.
  31
  32 OPTIONS
  33 --------
  34 awesomerc contains 4 global sections: *screen*, *rules*, *keys* and *mouse* which
  35 are described here.
  36
  37 screen
  38 ~~~~~~
  39 This is the global section for a physical screen. It must have a title with screen number,
  40 starting at 0. It contains several subsections, which are *general*, *tags*, *layouts*, *styles*,
  41 *padding* and *statusbar*.
  42
  43 general
  44 ^^^^^^^
  45 General is a section containing some general options for this screen.
  46
  47 titlebar::
  48     This section defines the parameters of the windows titlebar.
  49 border::
  50     This defines the window borders size in pixel.
  51 new_become_master::
  52     If this is set to true, new windows will become the master window.
  53 new_get_focus::
  54     If this is set to true, new windows will get focus.
  55 opacity_unfocused::
  56     If this is set to a float value between 0 and 100, non-focused windows will have this opacity.
  57     This requires an external XComposite manager.
  58 opacity_focused::
  59     If this is set to a float value between 0 and 100, focused windows will have this opacity.
  60     This requires an external XComposite manager.
  61 resize_hints::
  62     If this is set to true, resize hints given by the window will be respected.
  63     If this is set to false, window size will be forced.
  64     If you dislike gaps between windows, you should try to set it to false.
  65 sloppy_focus::
  66     If this is set to true, focus will be set to the window under the mouse. If not,
  67     you will have to click on a window to set it focused.
  68 sloppy_focus_raise::
  69     If this is set to true with sloppy_focus, when a window is focused with the mouse
  70     it will be raised on top of the windows stack.
  71 snap::
  72     Snap windows to the screen border when it is this pixel away only from the border.
  73 floating_placement::
  74     Select the floating placement algorithm to use when placing window.
  75
  76 tags
  77 ^^^^
  78 Tags is a section containing one or more tag sections, which defines a tag.
  79
  80 tag
  81 +++
  82 Tag is a section which contains several options defining a tag.
  83
  84 layout::
  85     Layout is a name of an available layout which will be set by default on this tag.
  86 mwfact::
  87     Set the default master width factor for this tag.
  88 ncol::
  89     Set the default number of columns for non-master windows for this tag.
  90 nmaster::
  91     Set the default number of windows which will be treated as master for this tag.
  92
  93 layouts
  94 ^^^^^^^
  95 Layouts is a section containing a layout list, where each layout is a layout section.
  96
  97 layout
  98 ++++++
  99 Layout is a section which define a layout. It has a title which is the algorithm to use.
 100
 101 image::
 102     Set the image path used to describe this layouts, useful in layoutinfo widget.
 103
 104 styles
 105 ^^^^^^
 106 Styles is a section containing the style parameters which is composed of a normal, focus and urgent
 107 subsection each ones containing:
 108
 109 font::
 110     The font to use.
 111 fg::
 112     Set the foreground color.
 113 bg::
 114     Set the background color.
 115 border::
 116     Set the window's border color.
 117 shadow::
 118     Set the shadow color.
 119 shadow_offset::
 120     Set the shadow offset in pixel.
 121
 122 padding
 123 ^^^^^^^
 124 Padding is a section containing screen padding parameters.
 125
 126 top::
 127     Set the top padding in pixel.
 128 bottom::
 129     Set the bottom padding in pixel.
 130 left::
 131     Set the left padding in pixel.
 132 right::
 133     Set the right padding in pixel.
 134
 135 statusbar
 136 ^^^^^^^^^
 137 Statusbar are sections containing statusbars parameters. Each statusbar section
 138 must have a title which is the statusbar name. Each statusbar can have none or
 139 several widgets (see WIDGETS section for more details) each one identified by its
 140 name.
 141
 142 position::
 143     Default statusbar position.
 144 height::
 145     Statusbar height. By default, is auto computed with font size.
 146 width::
 147     Statusbar width. By default, it will be whole screen.
 148
 149 rules
 150 ~~~~~
 151 Rules is a section containing a rule list to automatically configure windows.
 152
 153 rule
 154 ^^^^
 155 Rule are sections containing the auto-configuration options for one window.
 156
 157 name::
 158     Set the window name for name matching as a regular expression.
 159 xproperty_name::
 160     Set the name of the XProperty for XProperty matching.
 161 xproperty_value::
 162     Set the regular expression to match against the named XProperty's value.
 163 float::
 164     Set the window to be floating. One of auto, true or false. Defaults to auto.
 165 master::
 166     Set the window to be the master. One of auto, true or false. Defaults to
 167     auto.
 168 tags::
 169     Set the tags to be assigned to the window as a regular expression.
 170 screen::
 171     Set the screen the window should show up on.
 172 icon::
 173     Set the window's icon.
 174 opacity::
 175     Set the window's opacity.
 176
 177 keys
 178 ~~~~
 179 Keys is the section to define your keybindings in. It may consist of multiple
 180 key and keylist entries.
 181
 182 key
 183 ^^^
 184 In a key section you define a single keybinding.
 185
 186 key::
 187     The keysym you want to bind.
 188 mod::
 189     Modifiers that need to be pressed for this binding.
 190 command::
 191     The *uicb function* to call.
 192 arg::
 193     The argument to the *uicb function*, if needed.
 194
 195 keylist
 196 ^^^^^^^
 197 In a keylist you can define multiple very similar keybindings at once. For
 198 example you can define <Mod1>-{1..9} to switch the view to tag 1..9
 199 respectively.
 200
 201 keylist::
 202     The list of keysyms to bind.
 203 modkey::
 204     Modifiers that need to be pressed for these bindings.
 205 command::
 206     The *uicb function* to call.
 207 arglist::
 208     The list of arguments to the *uicb function*, if needed. *Must* match the
 209     length of *keylist*.
 210
 211 mouse
 212 ~~~~~
 213 In the mouse section you may define mouse button bindings for the root and
 214 client windows.
 215
 216 client
 217 ^^^^^^
 218 Defines a mouse button binding for events on clients.
 219
 220 button::
 221     The mouse button you want to bind.
 222 modkey::
 223     Modifiers that need to be pressed for this binding.
 224 command::
 225     The *uicb function* to call.
 226 arg::
 227     The argument to the *uicb function*, if needed.
 228
 229 root
 230 ^^^^
 231 Defines a mouse button binding for events on the root window.
 232
 233 button::
 234     The mouse button you want to bind.
 235 modkey::
 236     Modifiers that need to be pressed for this binding.
 237 command::
 238     The *uicb function* to call.
 239 arg::
 240     The argument to the *uicb function*, if needed.
 241
 242 UICB FUNCTIONS
 243 --------------
 244
 245 In awesome, a lot of *functions* are available. These functions are called
 246 uicb (User Interface Call Backs). Each function can be bound to a key shortcut
 247 or a mouse button.
 248
 249 General
 250 ~~~~~~~
 251 *quit*::
 252     This function quits awesome.
 253 *statusbar_toggle* statusbar-identifier::
 254     Hide or show statusbar (with no argument, toggle all).
 255 *spawn* client::
 256     Execute an external program.
 257 *exec* program::
 258     Replace awesome with another window manager.
 259 *restart*::
 260     Restart awesome.
 261 *widget_tell* widget-identifier data::
 262     Feed information to your widgets.
 263
 264 Client
 265 ~~~~~~
 266 *client_kill*::
 267     Closes the focused client.
 268 *client_moveresize* x y width height::
 269     Dynamically move and resize floating windows.
 270     Coordinates can be relative or absolute. Relative values must begin with + or -.
 271     E.g: to move a window 10 pixels up: "+0 \+10 +0 +0" To move a window
 272     in the upper left corner and increase its width by 10px: "0 0 \+0 +10"
 273 *client_settrans* float::
 274     Set client transparency, number can be a relative or absolute floating number in percentage.
 275 *client_swapnext*::
 276     Swap window placement with the next displayed window.
 277 *client_swapprev*::
 278     Swap window placement with the previous displayed window.
 279 *client_focusnext*::
 280     Focus next window.
 281 *client_focusprev*::
 282     Focus previous window.
 283 *client_togglemax*::
 284     Set window fullscreen. Calling this function another time will reset the window to its previous state.
 285 *client_togglehorizontalmax*::
 286     Set window's horizontal size to display width. Calling another time will reset the window to its previous state.
 287 *client_toggleverticalmax*::
 288     Set window's vertical size to display height. Calling another time will reset the window to its previous state.
 289 *client_togglefloating*::
 290     Set window floating or tiled.
 291 *client_zoom*::
 292     Set window as master window.
 293 *client_movetoscreen* relative or absolute integer::
 294     Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number is set, move to the next screen.
 295 *client_tag* tag number::
 296     Tag focused window with this tag.
 297 *client_toggletag*::
 298     Add or remove tag to focused window.
 299 *client_movemouse*::
 300     Move client window with mouse.
 301 *client_resizemouse*::
 302     Resize client window with mouse.
 303 *client_setscratch*::
 304     Set or unset client as being the scratch window.
 305 *client_togglescratch*::
 306     Toggle scratch window.
 307 *client_toggletitlebar*::
 308     Toggle window titlebar.
 309
 310 Tag
 311 ~~~
 312 *tag_setlayout* relative or absolute integer::
 313     Set layout number; or just switch to the next layout for current tag.
 314 *tag_toggleview* tag::
 315     Add windows tagged with tag number to current display.
 316 *tag_view* tag number::
 317     View windows tagged with tag number.
 318 *tag_viewnext*::
 319     Show windows tagged with next tag in list.
 320 *tag_viewprev*::
 321     Show windows tagged with previous tag in list.
 322 *tag_prev_selected*::
 323     Switch back to the previously displayed set of tags.
 324 *tag_setmwfact* relative or absolute float::
 325     Set master width factor.
 326 *tag_setncol* relative or absolute integer::
 327     Set number of columns for non-master windows.
 328 *tag_setnmaster* relative or absolute integer::
 329     Set number of master windows.
 330 *tag_create* name::
 331     Create a new tag with that name.
 332
 333 Focus
 334 ~~~~~
 335 *focus_client_byname* string::
 336     Give client focus by its name.
 337 *focus_history* negative number::
 338     Focus the client that had focused nth focus switch earlier.
 339
 340 Screen
 341 ~~~~~~
 342 *screen_focus* relative or absolute integer::
 343     Select Screen and focus first window and move mouse.
 344
 345 WIDGETS
 346 -------
 347 Statusbars can be customized by modifying widgets names, order and options.
 348
 349 taglist
 350 ~~~~~~~
 351 This widget shows the tag list.
 352
 353 *mouse*::
 354     Set mouse bindings.
 355 *x*::
 356     Horizontal offset (auto-alignment if not set).
 357 *y*::
 358     Vertical offset (auto-alignment if not set).
 359 *align*::
 360     Widget alignment.
 361
 362 layoutinfo
 363 ~~~~~~~~~~
 364 This widget shows a icon for the selected layout.
 365
 366 *mouse*::
 367     Set mouse bindings.
 368 *x*::
 369     Horizontal offset (auto-alignment if not set).
 370 *y*::
 371     Vertical offset (auto-alignment if not set).
 372 *align*::
 373     Widget alignment.
 374
 375 focusicon
 376 ~~~~~~~~~
 377 This widget shows a icon for the focused window  using NET_WM_ICON or icon file set in rule.
 378
 379 *mouse*::
 380     Set mouse bindings.
 381 *x*::
 382     Horizontal offset (auto-alignment if not set).
 383 *y*::
 384     Vertical offset (auto-alignment if not set).
 385 *align*::
 386     Widget alignment.
 387
 388 tasklist
 389 ~~~~~~~~
 390 This widget shows a list of running windows.
 391
 392 *mouse*::
 393     Set mouse bindings.
 394 *styles*::
 395     Style section with normal, focus and urgent subsections.
 396 *text_align*::
 397     Text alignement.
 398 *show_icons*::
 399     Show applications icons.
 400 *show*::
 401     Show all windows from all tags, tags clients only or focused client.
 402 *x*::
 403     Horizontal offset (auto-alignment if not set).
 404 *y*::
 405     Vertical offset (auto-alignment if not set).
 406
 407 textbox
 408 ~~~~~~~
 409 This widget shows a text.
 410
 411 *mouse*::
 412     Set mouse bindings.
 413 *width*::
 414     Set width.
 415 *style*::
 416     Style section with <style section>
 417 *text*::
 418     Text to change.
 419 *text_align*::
 420     Text alignement.
 421 *x*::
 422     Horizontal offset (auto-alignment if not set).
 423 *y*::
 424     Vertical offset (auto-alignment if not set).
 425 *align*::
 426     Widget alignment.
 427
 428 iconbox
 429 ~~~~~~~
 430 This widget shows an icon.
 431
 432 *mouse*::
 433     Set mouse bindings.
 434 *image*::
 435     Image file.
 436 *resize*::
 437     Resize icon to fit into statusbar.
 438 *x*::
 439     Horizontal offset (auto-alignment if not set).
 440 *y*::
 441     Vertical offset (auto-alignment if not set).
 442 *align*::
 443     Widget alignment.
 444
 445 progressbar
 446 ~~~~~~~~~~~
 447 This widget shows one or more progress-bars.
 448
 449 *data*::
 450     Draws a bar for each data section;
 451     Options: reverse, fg, fg_center, fg_end, bg, bordercolor.
 452 *reverse*::
 453     Reverse/mirror the bar.
 454 *fg*::
 455     Foreground color.
 456 *fg_center*::
 457     Foreground color in the center of the bar (as gradient).
 458 *fg_end*::
 459     Foreground color at the end of a bar (as gradient).
 460 *bg*::
 461     Background color.
 462 *bordercolor*::
 463     Border color.
 464 *mouse*::
 465     Set mouse bindings.
 466 *width*::
 467     Set width.
 468 *height*::
 469     Set height (i.e. 0.9 = 90%)
 470 *padding*::
 471     Empty space on both sides.
 472 *vertical*::
 473     Draw the bar(s) vertically/standing up.
 474 *x*::
 475     Horizontal offset (auto-alignment if not set).
 476 *y*::
 477     Vertical offset (auto-alignment if not set).
 478 *align*::
 479     Widget alignment.
 480
 481 graph
 482 ~~~~~
 483 This widget shows a graph.
 484
 485 *data*::
 486     Defines a data-stream section;
 487     Options: max, scale, fg, fg_center, fg_end and draw_style.
 488 *max*::
 489     This value prints a full graph (default = 100).
 490 *scale*::
 491     Re-scales when input > max (see below).
 492 *fg*::
 493     Foreground color.
 494 *fg_center*::
 495     Foreground color in the center of the bar (as gradient).
 496 *fg_end*::
 497     Foreground color at the end of a bar (as gradient).
 498 *vertical_gradient*
 499     If true, create a gradient from 0 > full instead of new > old values
 500 *draw_style*::
 501     bottom (fills from bottom to top), top, or line.
 502 *mouse*::
 503     Set mouse bindings.
 504 *width*::
 505     Set width.
 506 *height*::
 507     Set height (i.e. 0.9 = 90%).
 508 *padding_left*::
 509     Empty space on the left.
 510 *grow*::
 511     Put new values onto the 'left' or 'right'.
 512 *bg*::
 513     Background color.
 514 *bordercolor*::
 515     Border color.
 516 *x*::
 517     Horizontal offset (auto-alignment if not set).
 518 *y*::
 519     Vertical offset (auto-alignment if not set).
 520 *align*::
 521     Widget alignment.
 522
 523 FORMAT
 524 ------
 525 Here is the global configuration file format, with a list of options
 526 and possible values.
 527
 528 ..............................................
 529 Note: when there is no whitespace, quotes are optional.
 530
 531 <boolean>       -> "true" or "false"
 532 <color>         -> #ff9933 (hexadecimal color notation: #red green blue)
 533 <float>         -> 0.3, 0,8 (often values between 0 and 1 are useful)
 534 <font>          -> Pango font: sans 10, sans italic 10, fixed 12, ...
 535 <identifier>    -> foobar (choose a name/string)
 536 <image>         -> "/home/awesome/pics/icon.png" (path to image)
 537 <integer>       -> 1, 10, -3 (positive numbers are required mostly)
 538 <key>           -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
 539                    or a keycode beginning with #
 540 <mod>           -> "Mod1", "Mod4", "Control" (modifiers)
 541 <regex>         -> regular expression
 542 <string>        -> "foo bar"
 543 <uicb-arg>      -> prog, 3... (argument to a uicb function, where required)
 544 <uicb-cmd>      -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
 545 <position>      -> list of position: off, top, right, left, bottom, auto
 546 <{.., ...}>     -> list of available options
 547 <style section> -> a section with font, fg, bg, border, shadow and shadow_offset options.
 548                    { font = <font> fg = <color> bg = <color> border = <color>
 549                      shadow = <color> shadow_offset = <integer> }
 550 <titlebar>      -> a section with position and icon position.
 551                    { position = <position> icon = <position> text_align = <{center,right,left}> }
 552
 553 [MULTI] means, you can use an item multiple times.
 554
 555
 556 screen <integer> [MULTI]
 557 {
 558     general
 559     {
 560         border = <integer>
 561         new_become_master = <boolean>
 562         new_get_focus = <boolean>
 563         opacity_unfocused = <integer>
 564         opacity_focused = <integer>
 565         resize_hints = <boolean>
 566         sloppy_focus = <boolean>
 567         sloppy_focus_raise = <boolean>
 568         snap = <integer>
 569         floating_placement = <{smart,under_mouse}>
 570         mwfact_lower_limit = <float>
 571         mwfact_upper_limit = <float>
 572     }
 573     titlebar
 574     {
 575         <titlebar>
 576     }
 577     tags
 578     {
 579         tag <identifier> [MULTI]
 580         {
 581             layout = <{dwindle,floating,max,
 582                      spiral,tile,tileleft,tilebottom,tiletop}>
 583             mwfact = <float>
 584             nmaster = <integer>
 585             ncol = <integer>
 586         }
 587     }
 588     layouts
 589     {
 590         layout <{dwindle,floating,max,
 591                  spiral,tile,tileleft,
 592                  tilebottom,tiletop}> { image = <image> } [MULTI]
 593     }
 594     styles
 595     {
 596         normal { <style section> }
 597         focus { <style section> }
 598         urgent { <style section> }
 599     }
 600     padding
 601     {
 602         top = <integer>
 603         bottom = <integer>
 604         left = <integer>
 605         right = <integer>
 606     }
 607     statusbar <identifier> [MULTI]
 608     {
 609         position = <{top,bottom,left,right,off}>
 610         height = <integer>
 611         width = <integer>
 612
 613         taglist <identifier> [MULTI]
 614         {
 615             x = <integer> y = <integer>
 616             align = <{auto,right,left}>
 617             mouse [MULTI]
 618             {
 619                 button = <integer> modkey = {<mod>, ...}
 620                 command = <uicb-cmd> arg = <uicb-arg>
 621             }
 622         }
 623         layoutinfo <identifier>
 624         {
 625             x = <integer> y = <integer>
 626             align = <{auto,right,left}>
 627             mouse [MULTI]
 628             {
 629                 button = <integer> modkey = {<mod>, ...}
 630                 command = <uicb-cmd> arg = <uicb-arg>
 631             }
 632         }
 633         focusicon <identifier>
 634         {
 635             x = <integer> y = <integer>
 636             align = <{auto,right,left}>
 637             mouse [MULTI]
 638             {
 639                 button = <integer> modkey = {<mod>, ...}
 640                 command = <uicb-cmd> arg = <uicb-arg>
 641             }
 642         }
 643         tasklist <identifier>
 644         {
 645             styles
 646             {
 647                 normal { <style section> }
 648                 focus { <style section> }
 649             }
 650             show_icons = <boolean>
 651             show = <{all,tags,focus}>
 652             text_align = <{center,left,right}>
 653             x = <integer> y = <integer>
 654             mouse [MULTI]
 655             {
 656                 command = <uicb-cmd> arg = <uicb-arg>
 657                 button = <integer> modkey = {<mod>, ...}
 658             }
 659         }
 660         textbox <identifier> [MULTI]
 661         {
 662             style { <style section> }
 663             text = <string>
 664             width = <integer>
 665             text_align = <{center,left,right}>
 666             x = <integer> y = <integer>
 667             align = <{auto,right,left}>
 668             mouse [MULTI]
 669             {
 670                 button = <integer> modkey = {<mod>, ...}
 671                 command = <uicb-cmd> arg = <uicb-arg>
 672             }
 673         }
 674         iconbox <identifier> [MULTI]
 675         {
 676             image = <image>
 677             resize = <boolean>
 678             x = <integer> y = <integer>
 679             align = <{auto,right,left}>
 680             mouse [MULTI]
 681             {
 682                 button = <integer> modkey = {<mod>, ...}
 683                 command = <uicb-cmd> arg = <uicb-arg>
 684             }
 685         }
 686         progressbar <identifier> [MULTI]
 687         {
 688             data [MULTI]
 689             {
 690                 reverse = <boolean> bg = <color> bordercolor = <color>
 691                 fg = <color> fg_center = <color> fg_end = <color>
 692             }
 693             gap = <integer>
 694             width = <integer>
 695             height = <float>
 696             padding = <integer>
 697             vertical = <boolean>
 698             x = <integer> y = <integer>
 699             align = <{auto,right,left}>
 700             mouse [MULTI]
 701             {
 702                 button = <integer> modkey = {<mod>, ...}
 703                 command = <uicb-cmd> arg = <uicb-arg>
 704             }
 705         }
 706         graph <identifier> [MULTI]
 707         {
 708             data [MULTI]
 709             {
 710                 scale = <boolean> max = <float> draw_style = <{bottom, top, line}>
 711                 fg = <color> fg_center = <color> fg_end = <color>
 712                 vertical_gradient = <boolean>
 713             }
 714             width = <integer>
 715             height = <float>
 716             padding_left = <integer>
 717             grow = <{left, right}>
 718             bg = <color>
 719             bordercolor = <color>
 720             x = <integer> y = <integer>
 721             align = <{auto,right,left}>
 722             mouse [MULTI]
 723             {
 724                 button = <integer> modkey = {<mod>, ...}
 725                 command = <uicb-cmd> arg = <uicb-arg>
 726             }
 727         }
 728     }
 729 }
 730 rules
 731 {
 732     rule [MULTI]
 733     {
 734         name = <regex>
 735         xproperty_name = <string>
 736         xproperty_value = <regex>
 737         float = <{auto,true,false}>
 738         master = <{auto,true,false}>
 739         tags = <regex>
 740         screen = <integer>
 741         icon = <image>
 742         opacity = <float>
 743         titlebar
 744         {
 745             <titlebar>
 746         }
 747     }
 748 }
 749 keys
 750 {
 751     key [MULTI]
 752     {
 753         key = <key> modkey = {<mod>, ...}
 754         command = <uicb-cmd> arg = <uicb-arg>
 755     }
 756     keylist [MULTI]
 757     {
 758         keylist = {<key>, ...}
 759         modkey = {<mod>, ...}
 760         command = <uicb-cmd>
 761         arglist = {<uicb-arg>, ...}
 762     }
 763 }
 764 mouse
 765 {
 766     client [MULTI]
 767     {
 768         button = <integer> modkey = {<mod>, ...}
 769         command = <uicb-cmd> arg = <uicb-arg>
 770     }
 771     root [MULTI]
 772     {
 773         button = <integer> modkey = {<mod>, ...}
 774         command = <uicb-cmd> arg = <uicb-arg>
 775     }
 776 }
 777 ..............................................
 778
 779 EXAMPLES
 780 --------
 781
 782 Check awesome's wiki: http://awesome.naquadah.org/wiki/
 783
 784 Simple textbox example
 785 ~~~~~~~~~~~~~~~~~~~~~~
 786 ..............................................
 787 1. Add an include directive into ~/.awesomerc
 788
 789     screen 0 {
 790         include(~/.awesome/bottom-status-bar)
 791
 792 2. Create ~/.awesome/bottom-status-bar
 793
 794     statusbar "bottom"
 795     {
 796         position = "bottom"
 797         textbox "clock" { }
 798     }
 799
 800 3. Check the configuration file for errors
 801
 802     $ awesome -k
 803     Configuration file OK.
 804
 805     Note: If you see anything other than "Configuration file OK." you have a
 806     typo somewhere.
 807
 808 4. Create ~/bin/awesome-clock
 809
 810     #!/bin/sh
 811     while true
 812     do
 813       echo "0 widget_tell clock text `date`"
 814       echo "" # an empty line flushes data inside awesome
 815       sleep 1
 816     done | awesome-client
 817
 818     Note: What we're saying is "awesome-client, tell widget 'clock' to set
 819     it's 'text' property to date's output".
 820
 821 5. Make your ~/bin/awesome-clock executable
 822
 823    $ chmod a+x ~/bin/awesome-clock
 824
 825 6. Modify ~/.xinitrc
 826
 827     ~/bin/awesome-clock &
 828     exec awesome
 829
 830 7. Restart awesome
 831
 832 8. If your didn't get what you were expecting, take a look at
 833    ~/.xsession-errors or the terminal where X got started.
 834 ..............................................
 835
 836 Simple progressbar example
 837 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 838 ..............................................
 839
 840 1. Add an include directive into ~/.awesomerc
 841
 842     screen 0
 843     {
 844         include(~/.awesome/bottom-status-bar)
 845     }
 846
 847 2. Create ~/.awesome/bottom-status-bar
 848
 849     progressbar diskusage
 850     {
 851         data "disk"
 852         {
 853             bordercolor = "#006e96"
 854             bg          = "#000000"
 855             fg          = "#ff0000"
 856             fg_center   = "#daaf0a"
 857             fg_end      = "#00ff00"
 858         }
 859         width = 100
 860         align = "left"
 861     }
 862
 863 3. Check the configuration file for errors
 864
 865     $ awesome -k
 866     Configuration file OK.
 867
 868     Note: If you see anything other than "Configuration file OK," you have a
 869     typo somewhere.
 870
 871 4. Create ~/bin/awesome-diskusage
 872
 873     #!/bin/sh
 874     while true; do
 875         usage = `df /dev/sda5 | awk '/\/dev\/sda5/ { print 100-$5 }'`
 876         echo "0 widget_tell diskusage data disk ${usage}"
 877         echo "" # an empty line flushes data inside awesome
 878         sleep 600;
 879     done | awesome-client
 880
 881
 882     Note: What we're saying is "awesome-client, tell widget 'diskusage' to
 883     set it's 'data' property named 'disk' to ${usage}."
 884
 885 5. Make ~/bin/awesome-diskusage executable
 886
 887 $ chmod a+x ~/bin/awesome-diskusage
 888
 889 6. Modify ~/.xinitrc
 890
 891     ~/bin/awesome-diskusage &
 892     exec awesome
 893
 894 7. Restart awesome
 895
 896 8. If your didn't get what you were expecting, take a look at
 897    ~/.xsession-errors or the terminal where X got started.
 898 ..............................................
 899
 900
 901 SEE ALSO
 902 --------
 903 awesome(1) awesome-client(1)
 904
 905
 906 AUTHORS
 907 -------
 908 This man page was written by Julien Danjou <julien@danjou.info>, Marco Candrian <mac@calmar.ws>
 909 and Chris Ciulla <chris.ciulla@gmail.com> (Simple Examples).
 910
 911 WWW
 912 ---
 913 http://awesome.naquadah.org