README: update awesome usage examples for v3.5

Signed-off-by: Adrian C. (anrxc) <anrxc@sysphere.org>
This commit is contained in:
Uli Schlachter 2013-11-02 18:34:55 +01:00 committed by Adrian C. (anrxc)
parent 563cb6f5e8
commit c795642c2f
2 changed files with 19 additions and 17 deletions

31
README
View File

@ -387,7 +387,7 @@ file with their GPG key. Trough the GPG Passphrase Agent they could
then decrypt the file transparently while their session is active. then decrypt the file transparently while their session is active.
Usage examples (for awesome v3.4) Usage examples
--------------------------------- ---------------------------------
Start with a simple widget, like date. Then build your setup from Start with a simple widget, like date. Then build your setup from
there, one widget at a time. Also remember that besides creating and there, one widget at a time. Also remember that besides creating and
@ -395,14 +395,14 @@ registering widgets you have to add them to a wibox (statusbar) in
order to actually display them. order to actually display them.
Date widget Date widget
datewidget = widget({ type = "textbox" }) datewidget = wibox.widget.textbox()
vicious.register(datewidget, vicious.widgets.date, "%b %d, %R") vicious.register(datewidget, vicious.widgets.date, "%b %d, %R")
- updated every 2 seconds (the default interval), uses standard - updated every 2 seconds (the default interval), uses standard
date sequences as the format string date sequences as the format string
Memory widget Memory widget
memwidget = widget({ type = "textbox" }) memwidget = wibox.widget.textbox()
vicious.cache(vicious.widgets.mem) vicious.cache(vicious.widgets.mem)
vicious.register(memwidget, vicious.widgets.mem, "$1 ($2MB/$3MB)", 13) vicious.register(memwidget, vicious.widgets.mem, "$1 ($2MB/$3MB)", 13)
@ -410,7 +410,7 @@ Memory widget
values and enables caching of this widget type values and enables caching of this widget type
HDD temperature widget HDD temperature widget
hddtempwidget = widget({ type = "textbox" }) hddtempwidget = wibox.widget.textbox()
vicious.register(hddtempwidget, vicious.widgets.hddtemp, "${/dev/sda} °C", 19) vicious.register(hddtempwidget, vicious.widgets.hddtemp, "${/dev/sda} °C", 19)
- updated every 19 seconds, requests the temperature level of the - updated every 19 seconds, requests the temperature level of the
@ -418,7 +418,7 @@ HDD temperature widget
not provide the port argument so default port is used not provide the port argument so default port is used
Mbox widget Mbox widget
mboxwidget = widget({ type = "textbox" }) mboxwidget = wibox.widget.textbox()
vicious.register(mboxwidget, vicious.widgets.mbox, "$1", 5, "/home/user/mail/Inbox") vicious.register(mboxwidget, vicious.widgets.mbox, "$1", 5, "/home/user/mail/Inbox")
- updated every 5 seconds, provides full path to the mbox as an - updated every 5 seconds, provides full path to the mbox as an
@ -431,8 +431,8 @@ Battery widget
batwidget:set_vertical(true) batwidget:set_vertical(true)
batwidget:set_background_color("#494B4F") batwidget:set_background_color("#494B4F")
batwidget:set_border_color(nil) batwidget:set_border_color(nil)
batwidget:set_color("#AECF96") batwidget:set_color({ type = "linear", from = { 0, 0 }, to = { 0, 10 },
batwidget:set_gradient_colors({ "#AECF96", "#88A175", "#FF5656" }) stops = { { 0, "#AECF96" }, { 0.5, "#88A175" }, { 1, "#FF5656" }})
vicious.register(batwidget, vicious.widgets.bat, "$2", 61, "BAT0") vicious.register(batwidget, vicious.widgets.bat, "$2", 61, "BAT0")
- updated every 61 seconds, requests the current battery charge - updated every 61 seconds, requests the current battery charge
@ -443,8 +443,8 @@ CPU usage widget
cpuwidget = awful.widget.graph() cpuwidget = awful.widget.graph()
cpuwidget:set_width(50) cpuwidget:set_width(50)
cpuwidget:set_background_color("#494B4F") cpuwidget:set_background_color("#494B4F")
cpuwidget:set_color("#FF5656") cpuwidget:set_color({ type = "linear", from = { 0, 0 }, to = { 50, 0 },
cpuwidget:set_gradient_colors({ "#FF5656", "#88A175", "#AECF96" }) stops = { { 0, "#FF5656" }, { 0.5, "#88A175" }, { 1, "#AECF96" }})
vicious.register(cpuwidget, vicious.widgets.cpu, "$1", 3) vicious.register(cpuwidget, vicious.widgets.cpu, "$1", 3)
- updated every 3 seconds, feeds the graph with total usage - updated every 3 seconds, feeds the graph with total usage
@ -468,7 +468,7 @@ second argument, and will return the text/data to be used for the
widget. widget.
Example Example
mpdwidget = widget({ type = "textbox" }) mpdwidget = wibox.widget.textbox()
vicious.register(mpdwidget, vicious.widgets.mpd, vicious.register(mpdwidget, vicious.widgets.mpd,
function (widget, args) function (widget, args)
if args["{state}"] == "Stop" then return "" if args["{state}"] == "Stop" then return ""
@ -481,7 +481,7 @@ Example
seconds (the default interval) seconds (the default interval)
Example Example
uptimewidget = widget({ type = "textbox" }) uptimewidget = wibox.widget.textbox()
vicious.register(uptimewidget, vicious.widgets.uptime, vicious.register(uptimewidget, vicious.widgets.uptime,
function (widget, args) function (widget, args)
return string.format("Uptime: %2dd %02d:%02d ", args[1], args[2], args[3]) return string.format("Uptime: %2dd %02d:%02d ", args[1], args[2], args[3])
@ -496,9 +496,10 @@ textbox widgets by changing their .width field (by default width is
automatically adapted to text width). automatically adapted to text width).
Example Example
uptimewidget = widget({ type = "textbox" }) uptimewidget = wibox.widget.textbox()
uptimewidget.width, uptimewidget.align = 50, "right" uptimewidget:set_align("right")
vicious.register(uptimewidget, vicious.widgets.uptime, "$1 $2:$3", 61) vicious.register(uptimewidget, vicious.widgets.uptime, "$1 $2:$3", 61)
uptimewidget = wibox.layout.constraint(uptimewidget, "exact", 50, nil)
- forces a fixed width of 50px to the uptime widget, and aligns its - forces a fixed width of 50px to the uptime widget, and aligns its
text to the right text to the right
@ -509,7 +510,7 @@ color index arguments elegantly. But they are not unusable, far from
it. it.
Example Example
ctext = widget({ type = "textbox"}) ctext = wibox.widget.textbox()
cgraph = awful.widget.graph() cgraph = awful.widget.graph()
cgraph:set_width(100):set_height(20) cgraph:set_width(100):set_height(20)
cgraph:set_stack(true):set_max_value(100) cgraph:set_stack(true):set_max_value(100)
@ -530,7 +531,7 @@ A lot of users are not happy with default symbols used in volume,
battery, cpufreq and other widget types. You can use your own symbols battery, cpufreq and other widget types. You can use your own symbols
without any need to modify modules. without any need to modify modules.
volumewidget = widget({ type = "textbox"}) volumewidget = wibox.widget.textbox()
vicious.register(volumewidget, vicious.widgets.volume, vicious.register(volumewidget, vicious.widgets.volume,
function(widget, args) function(widget, args)
local label = { ["♫"] = "O", ["♩"] = "M" } local label = { ["♫"] = "O", ["♩"] = "M" }

View File

@ -107,9 +107,10 @@ vicious.contrib.buildbot
- it depends on lua json parser (e.g. liblua5.1-json on Ubuntu 12.04) - it depends on lua json parser (e.g. liblua5.1-json on Ubuntu 12.04)
Usage examples (for awesome v3.4) Usage examples
--------------------------------- ---------------------------------
Pulse Audio widget Pulse Audio widget
vol = wibox.widget.textbox()
vicious.register(vol, vicious.contrib.pulse, " $1%", 2, "alsa_output.pci-0000_00_1b.0.analog-stereo") vicious.register(vol, vicious.contrib.pulse, " $1%", 2, "alsa_output.pci-0000_00_1b.0.analog-stereo")
vol:buttons(awful.util.table.join( vol:buttons(awful.util.table.join(
awful.button({ }, 1, function () awful.util.spawn("pavucontrol") end), awful.button({ }, 1, function () awful.util.spawn("pavucontrol") end),
@ -118,7 +119,7 @@ Pulse Audio widget
)) ))
Buildbot widget Buildbot widget
local buildbotwidget = widget({ type = "textbox" }) buildbotwidget = wibox.widget.textbox()
local buildbotwidget_warg = { local buildbotwidget_warg = {
{builder="coverage", url="http://buildbot.buildbot.net"}, {builder="coverage", url="http://buildbot.buildbot.net"},
{builder="tarball-slave", url="http://buildbot.buildbot.net"} {builder="tarball-slave", url="http://buildbot.buildbot.net"}