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