]> 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 alsa (markdown)
[etc/awesome.git] / alsa.md
diff --git a/alsa.md b/alsa.md
index f978bce54e6dd86c7c977ff8afd7d64f149fc986..2029e8c9bf170aa28ff311705d113a145681a305 100644 (file)
--- a/alsa.md
+++ b/alsa.md
@@ -1,41 +1,42 @@
-Shows and controls alsa volume.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-       myvolume = lain.widgets.alsa()
+Shows and controls alsa volume with a textbox.
 
-* Left click: Launch `alsamixer` in your `terminal`.
-* Right click: Mute/unmute.
-* Scroll wheel: Increase/decrase volume.
+       myvolume = lain.widgets.alsa()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 5
 `channel` | Mixer channel | string | "Master" 
-`step` | Step at which volume is increased/decreased | string | "1%"
-`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"
+`settings` | User settings | function | empty function
+
+`settings` can be fed with the following variables:
+
+Variable | Meaning | Type | Values
+--- | --- | --- | ---
+volume.level | Self explained | int | 0-100
+volume.status | Device status | string | "on", "off"
 
-and outputs the following table:
+### output table
 
 Variable | Meaning | Type
 --- | --- | --- 
 `widget` | The widget | `wibox.widget.textbox`
-`channel` | Alsa channel | string
-`step` | Increase/decrease step | string
-`notify` | Update `widget` | function
+`notify` | Force update `widget` | 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",
     function ()
-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
+        awful.util.spawn("amixer sset Master 1%+")
         volume.notify()
     end),
     awful.key({ altkey }, "Down",
     function ()
-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-")
+        awful.util.spawn("amixer sset Master 1%-")
         volume.notify()
     end),
     awful.key({ altkey }, "m",