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