Updated alsabar (markdown)

[etc/awesome.git] / alsabar.md

diff --git a/alsabar.md b/alsabar.md
index 7763fe4224b02ef3320d0bf233c737dda258296d..31a7b231da1af4f56efc780314cf85b6a95b5254 100644 (file)
--- a/alsabar.md
+++ b/alsabar.md
@@ -1,8 +1,8 @@
 [<- 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()
+       volume = lain.widgets.alsabar()
 
 * Left click: Launch `alsamixer` in your `terminal`.
 * Right click: Mute/unmute.
@@ -12,6 +12,8 @@ The function takes a table as optional argument, which can contain:
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 4
+`settings` | User settings | function | empty function
 `width` | Bar width | int | 63
 `height` | Bar height | int | 1
 `ticks` | Set bar ticks on | boolean | true
@@ -39,40 +41,45 @@ Variable | Meaning | Type | Default
 `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.
 
+`settings` can use the following variables:
+
+Variable | Meaning | Type | Values
+--- | --- | --- | ---
+`volume_now.level` | Self explained | int | 0-100
+`volume_now.status` | Device status | string | "on", "off"
 ### 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
 
 You can control the widget with key bindings like these:
 
-    -- Volume control
+    -- ALSA volume control
     awful.key({ altkey }, "Up",
-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+")
-        volume.notify()
-    end),
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "+")
+            volume.notify()
+        end),
     awful.key({ altkey }, "Down",
-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-")
-        volume.notify()
-    end),
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "-")
+            volume.notify()
+        end),
     awful.key({ altkey }, "m",
-    function ()
-        awful.util.spawn("amixer set Master playback toggle")
-        volume.notify()
-    end),
-    awful.key({ altkey, "Control" }, "m", 
-    function ()
-        awful.util.spawn("amixer set Master playback 100%", false )
-        volume.notify()
-    end),
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback toggle")
+            volume.notify()
+        end),
+    awful.key({ altkey, "Control" }, "m",
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback 100%")
+            volume.notify()
+        end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file