]> 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 imap (markdown)
[etc/awesome.git] / alsabar.md
index 53c49b432562a4304c57a1ca88af463a27fd2825..7763fe4224b02ef3320d0bf233c737dda258296d 100644 (file)
@@ -1,10 +1,6 @@
-Shows and controls alsa volume with a progressbar.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-Dependencies:
-
-- alsa-utils (of course)
-
-Plus tooltips, notifications, and color changes at mute/unmute switch.
+Shows and controls alsa volume with a progressbar and provides tooltips, notifications, and color changes at mute/unmute switch.
 
        myvolumebar = lain.widgets.alsabar()
 
@@ -40,42 +36,43 @@ 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_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). 
 
-`lain.widgets.alsabar` outputs the following table:
-
-Variable | Type
---- | ---
-`widget` | `awful.widget.progressbar`
-`channel` | string
-`step` | string
-`notify` | function
-
-Finally, you can control the widget with key bindings like these:
-
-        -- Volume control
-        awful.key({ altkey }, "Up",
-        function ()
-            awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
-            volume.notify()
-        end),
-        awful.key({ altkey }, "Down",
-        function ()
-            awful.util.spawn("amixer sset " .. 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),
+### output table
+
+Variable | Meaning | Type
+--- | --- | ---
+`widget` | 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
+    awful.key({ altkey }, "Up",
+    function ()
+        awful.util.spawn("amixer 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),
+    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),
 
 where `altkey = "Mod1"`.
\ No newline at end of file