]> git.madduck.net Git - etc/awesome.git/blobdiff - alsabar.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated borderbox (markdown)
[etc/awesome.git] / alsabar.md
index 53c49b432562a4304c57a1ca88af463a27fd2825..f694c69d8b75438a214ed51d746456a8f5164022 100644 (file)
@@ -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.
 
 * Left click: Launch `alsamixer` in your `terminal`.
 * Right click: Mute/unmute.
@@ -16,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
@@ -40,41 +37,41 @@ Variable | Meaning | Type | Default
 --- | --- | --- | ---
 `font` | Notifications font | string | The one defined in `beautiful.font`
 `font_size` | Notifications font size | string | "11"
 --- | --- | --- | ---
 `font` | Notifications font | string | The one defined in `beautiful.font`
 `font_size` | Notifications font size | string | "11"
+`color` | Notifications color | string | `beautiful.fg_focus`
 `bar_size` | Wibox height | int | 18
 
 `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:
+### 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 key bindings like these:
+You can control the widget with key bindings like these:
 
 
-        -- Volume control
-        awful.key({ altkey }, "Up",
+    -- ALSA volume control
+    awful.key({ altkey }, "Up",
         function ()
         function ()
-            awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "+")
             volume.notify()
         end),
             volume.notify()
         end),
-        awful.key({ altkey }, "Down",
+    awful.key({ altkey }, "Down",
         function ()
         function ()
-            awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-")
+            awful.util.spawn("amixer -q set " .. volume.channel .. " " .. volume.step .. "-")
             volume.notify()
         end),
             volume.notify()
         end),
-        awful.key({ altkey }, "m",
+    awful.key({ altkey }, "m",
         function ()
         function ()
-            awful.util.spawn("amixer set Master playback toggle")
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback toggle")
             volume.notify()
         end),
             volume.notify()
         end),
-        awful.key({ altkey, "Control" }, "m", 
+    awful.key({ altkey, "Control" }, "m",
         function ()
         function ()
-            awful.util.spawn("amixer set Master playback 100%", false )
+            awful.util.spawn("amixer -q set " .. volume.channel .. " playback 100%")
             volume.notify()
         end),
 
             volume.notify()
         end),