Updated alsabar (markdown)

[etc/awesome.git] / alsabar.md

diff --git a/alsabar.md b/alsabar.md
index 6dea44f44cfe9be36542e3f8493183ad069f1354..31a7b231da1af4f56efc780314cf85b6a95b5254 100644 (file)
--- a/alsabar.md
+++ b/alsabar.md
@@ -2,7 +2,7 @@
 
 Shows and controls alsa volume with a progressbar; 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.
 
 * Left click: Launch `alsamixer` in your `terminal`.
 * Right click: Mute/unmute.


@@ -13,6 +13,7 @@ The function takes a table as optional argument, which can contain:
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 `timeout` | Refresh timeout seconds | int | 4
 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
 `width` | Bar width | int | 63
 `height` | Bar height | int | 1
 `ticks` | Set bar ticks on | boolean | true


@@ -42,6 +43,12 @@ Variable | Meaning | Type | Default
 
 It's **crucial** to set `notifications.bar_size` to your `mywibox[s]` height.
 
 
 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
 ### output table
 
 Variable | Meaning | Type


@@ -53,26 +60,26 @@ Variable | Meaning | Type
 
 You can control the widget with key bindings like these:
 
 
 You can control the widget with key bindings like these:
 

-    -- Volume control
+    -- ALSA volume control

     awful.key({ altkey }, "Up",
     awful.key({ altkey }, "Up",

-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "+")
-        myvolumebar.notify()
-    end),
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "+")
+            volume.notify()
+        end),

     awful.key({ altkey }, "Down",
     awful.key({ altkey }, "Down",

-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " " .. volume.step .. "-")
-        myvolumeba.notify()
-    end),
+        function ()
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "-")
+            volume.notify()
+        end),

     awful.key({ altkey }, "m",
     awful.key({ altkey }, "m",

-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " playback toggle")
-        myvolumebar.notify()
-    end),
-    awful.key({ altkey, "Control" }, "m", 
-    function ()
-        awful.util.spawn("amixer set " .. volume.channel .. " playback 100%", false )
-        myvolumebar.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
 
 where `altkey = "Mod1"`.
\ No newline at end of file