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 <section> [title]
  13 {
  14     <option> = <value>
  15
  16     <section> [title]
  17     {
  18         <option> = <value>
  19          ...
  20     }
  21     ...
  22 }
  23
  24 <option> = <value>
  25
  26 include(file.conf)
  27 ..........................
  28
  29 DESCRIPTION
  30 -----------
  31
  32 The *awesomerc* file contains configuration informations for *awesome*. It can
  33 be used to configure the behaviour and look of awesome in a variety of ways.
  34
  35 It is read at startup.
  36
  37 OPTIONS
  38 --------
  39 *awesomerc* contains 5 global sections: *screen*, *rules*, *keys*, *mouse* and *menu* which
  40 are described here.
  41
  42 All this sections contain options which may be string, integer, float, or even sections again.
  43
  44 include::optsdocgen.txt[]
  45
  46 UICB FUNCTIONS
  47 --------------
  48
  49 In awesome, a lot of *functions* are available. These functions are called
  50 uicb (User Interface Call Backs). Each function can be bound to a key shortcut
  51 or a mouse button.
  52
  53 include::uicbdocgen.txt[]
  54
  55 EXAMPLES
  56 --------
  57
  58 More examples are available on awesome's wiki:
  59 http://awesome.naquadah.org/wiki/
  60
  61 Simple textbox example
  62 ~~~~~~~~~~~~~~~~~~~~~~
  63 ..............................................
  64 1. Add an include directive into ~/.awesomerc
  65
  66     screen 0 { include(~/.awesome/bottom-status-bar) }
  67
  68 2. Create ~/.awesome/bottom-status-bar
  69
  70     statusbar "bottom"
  71     {
  72         position = "bottom"
  73         textbox "clock" { }
  74     }
  75
  76 3. Check the configuration file for errors
  77
  78     $ awesome -k
  79     Configuration file OK.
  80
  81     Note: If you see anything other than "Configuration file OK." you have a
  82     typo somewhere.
  83
  84 4. Create ~/bin/awesome-clock
  85
  86     #!/bin/sh
  87     while true
  88     do
  89       echo "0 widget_tell clock text `date`"
  90       echo "" # an empty line flushes data inside awesome
  91       sleep 1
  92     done | awesome-client
  93
  94     Note: What we're saying is "awesome-client, tell widget 'clock' to set
  95     it's 'text' property to date's output".
  96
  97 5. Make your ~/bin/awesome-clock executable
  98
  99    $ chmod a+x ~/bin/awesome-clock
 100
 101 6. Modify ~/.xinitrc
 102
 103     ~/bin/awesome-clock &
 104     exec awesome
 105
 106 7. Restart awesome
 107
 108 8. If your didn't get what you were expecting, take a look at
 109    ~/.xsession-errors or the terminal where X got started.
 110 ..............................................
 111
 112 Simple progressbar example
 113 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 114 ..............................................
 115
 116 1. Add an include directive into ~/.awesomerc
 117
 118     screen 0 { include(~/.awesome/bottom-status-bar) }
 119
 120 2. Create ~/.awesome/bottom-status-bar
 121
 122     progressbar diskusage
 123     {
 124         data "disk"
 125         {
 126             bordercolor = "#006e96"
 127             bg          = "#000000"
 128             fg          = "#ff0000"
 129             fg_center   = "#daaf0a"
 130             fg_end      = "#00ff00"
 131         }
 132         width = 100
 133         align = "left"
 134     }
 135
 136 3. Check the configuration file for errors
 137
 138     $ awesome -k
 139     Configuration file OK.
 140
 141     Note: If you see anything other than "Configuration file OK," you have a
 142     typo somewhere.
 143
 144 4. Create ~/bin/awesome-diskusage
 145
 146     #!/bin/sh
 147     while true; do
 148         usage = `df /dev/sda5 | awk '/\/dev\/sda5/ { print 100-$5 }'`
 149         echo "0 widget_tell diskusage data disk ${usage}"
 150         echo "" # an empty line flushes data inside awesome
 151         sleep 600;
 152     done | awesome-client
 153
 154
 155     Note: What we're saying is "awesome-client, tell widget 'diskusage' to
 156     set it's 'data' property named 'disk' to ${usage}."
 157
 158 5. Make ~/bin/awesome-diskusage executable
 159
 160 $ chmod a+x ~/bin/awesome-diskusage
 161
 162 6. Modify ~/.xinitrc
 163
 164     ~/bin/awesome-diskusage &
 165     exec awesome
 166
 167 7. Restart awesome
 168
 169 8. If your didn't get what you were expecting, take a look at
 170    ~/.xsession-errors or the terminal where X got started.
 171 ..............................................
 172
 173
 174 SEE ALSO
 175 --------
 176 awesome(1) awesome-client(1) awesome-menu(1) awesome-message(1)
 177
 178
 179 AUTHORS
 180 -------
 181 This man page was written by Julien Danjou <julien@danjou.info>, Marco Candrian <mac@calmar.ws>
 182 and Chris Ciulla <chris.ciulla@gmail.com> (Simple Examples).
 183
 184 WWW
 185 ---
 186 http://awesome.naquadah.org