Merge wiki

[etc/awesome.git] / alsabar.md

diff --git a/alsabar.md b/alsabar.md
index 76e120570f70815b4bac243396e82bacefc20020..6138f2c83240f4aceb94c7447bc3e648a7eaa27c 100644 (file)
--- a/alsabar.md
+++ b/alsabar.md
@@ -1,12 +1,8 @@
-Shows and controls alsa volume with a progressbar.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-Dependencies:
+Shows and controls alsa volume with a progressbar; provides tooltips, notifications, and color changes at mute/unmute switch.
 
-- alsa-utils (of course)
-
-Plus 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.
@@ -16,9 +12,11 @@ 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
+`ticks` | Set bar ticks on | boolean | false
 `ticks_size` | Ticks size | int | 7
 `vertical` | Set the bar vertical | boolean | false
 `channel` | Mixer channel | string | "Master" 
@@ -40,41 +38,47 @@ Variable | Meaning | Type | Default
 --- | --- | --- | ---
 `font` | Notifications font | string | The one defined in `beautiful.font`
 `font_size` | Notifications font size | string | "11"
+`color` | Notifications color | string | `beautiful.fg_normal`
 `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.
 
-`lain.widgets.alsabar` outputs the following table:
+`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 | Type
---- | ---
-`widget` | `awful.widget.progressbar`
-`channel` | string
-`step` | string
-`notify` | function
+Variable | Meaning | Type
+--- | --- | ---
+`bar` | The widget | `awful.widget.progressbar`
+`channel` | Alsa channel | string
+`step` | Increase/decrease step | string
+`notify` | The notification | function
 
-Finally, you can control the widget with the following key bindings:
+You can control the widget with key bindings like these:
 
-        -- Volume control
-        awful.key({ altkey }, "Up",
+    -- ALSA volume control
+    awful.key({ altkey }, "Up",
         function ()
-            awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
+            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 sset " .. volume.channel .. " " .. volume.step .. "-")
+            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 Master playback toggle")
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback toggle")
             volume.notify()
         end),
-        awful.key({ altkey, "Control" }, "m", 
+    awful.key({ altkey, "Control" }, "m",
         function ()
-            awful.util.spawn("amixer set Master playback 100%", false )
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback 100%")
             volume.notify()
         end),