]> git.madduck.net Git - etc/awesome.git/blobdiff - alsa.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 bat (markdown)
[etc/awesome.git] / alsa.md
diff --git a/alsa.md b/alsa.md
index 5a3497b1edbcd8d8412e2b1c5c68f619ead69f53..2ca1746c9a21eff3e5882a1cf187957e6d673adb 100644 (file)
--- a/alsa.md
+++ b/alsa.md
@@ -1,3 +1,5 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
 Shows and controls alsa volume with a textbox.
 
        myvolume = lain.widgets.alsa()
 Shows and controls alsa volume with a textbox.
 
        myvolume = lain.widgets.alsa()
@@ -15,38 +17,41 @@ Variable | Meaning | Type | Default
 `header` | Text to show before value | string | " Vol "
 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
 `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
 `header` | Text to show before value | string | " Vol "
 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
 `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
+`footer` | Text to append after value | string | " "
+
+*Note*: `footer` can be markup text.
 
 
-and outputs the following table:
+`lain.widgets.alsa` outputs the following table:
 
 
-Variable | Type
---- | ---
-`widget` | `awful.widget.textbox`
-`channel` | string
-`step` | string
-`notify` | function
+Variable | Meaning | Type
+--- | --- | --- 
+`widget` | The widget | `wibox.widget.textbox`
+`channel` | Alsa channel | string
+`step` | Increase/decrease step | string
+`notify` | Update `widget` | function
 
 Finally, you can control the widget with key bindings like these:
 
 
 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),
+    -- 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),
 
 where `altkey = "Mod1"`.
\ No newline at end of file
 
 where `altkey = "Mod1"`.
\ No newline at end of file