Updated alsabar (markdown)

[etc/awesome.git] / alsabar.md

diff --git a/alsabar.md b/alsabar.md
index 549b28a849b3378e8f93e3d76acf8d55869a206e..6dea44f44cfe9be36542e3f8493183ad069f1354 100644 (file)
--- a/alsabar.md
+++ b/alsabar.md
@@ -1,6 +1,6 @@
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 

-Shows and controls alsa volume with a progressbar and provides tooltips, notifications, and color changes at mute/unmute switch.
+Shows and controls alsa volume with a progressbar; provides tooltips, notifications, and color changes at mute/unmute switch.

 
        myvolumebar = lain.widgets.alsabar()
 
 
        myvolumebar = lain.widgets.alsabar()
 


@@ -12,6 +12,7 @@ The function takes a table as optional argument, which can contain:
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---

+`timeout` | Refresh timeout seconds | int | 4

 `width` | Bar width | int | 63
 `height` | Bar height | int | 1
 `ticks` | Set bar ticks on | boolean | true
 `width` | Bar width | int | 63
 `height` | Bar height | int | 1
 `ticks` | Set bar ticks on | boolean | true


@@ -39,14 +40,13 @@ Variable | Meaning | Type | Default
 `color` | Notifications color | string | `beautiful.fg_focus`
 `bar_size` | Wibox height | int | 18
 
 `color` | Notifications color | string | `beautiful.fg_focus`
 `bar_size` | Wibox height | int | 18
 

-It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height,
-**if** you have set it different than default (18). 
+It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height.

 
 ### output table
 
 Variable | Meaning | Type
 --- | --- | ---
 
 ### output table
 
 Variable | Meaning | Type
 --- | --- | ---

-`widget` | The widget | `awful.widget.progressbar`
+`bar` | The widget | `awful.widget.progressbar`

 `channel` | Alsa channel | string
 `step` | Increase/decrease step | string
 `notify` | The notification | function
 `channel` | Alsa channel | string
 `step` | Increase/decrease step | string
 `notify` | The notification | function


@@ -56,23 +56,23 @@ You can control the widget with key bindings like these:
     -- Volume control
     awful.key({ altkey }, "Up",
     function ()
     -- Volume control
     awful.key({ altkey }, "Up",
     function ()

-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
-        volume.notify()
+        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+")
+        myvolumebar.notify()

     end),
     awful.key({ altkey }, "Down",
     function ()
     end),
     awful.key({ altkey }, "Down",
     function ()

-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-")
-        volume.notify()
+        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-")
+        myvolumeba.notify()

     end),
     awful.key({ altkey }, "m",
     function ()
     end),
     awful.key({ altkey }, "m",
     function ()

-        awful.util.spawn("amixer set Master playback toggle")
-        volume.notify()
+        awful.util.spawn("amixer set " .. volume.channel .. " playback toggle")
+        myvolumebar.notify()

     end),
     awful.key({ altkey, "Control" }, "m", 
     function ()
     end),
     awful.key({ altkey, "Control" }, "m", 
     function ()

-        awful.util.spawn("amixer set Master playback 100%", false )
-        volume.notify()
+        awful.util.spawn("amixer set " .. volume.channel .. " playback 100%", false )
+        myvolumebar.notify()

     end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file
     end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file