Implement ALSA volume support

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 18cfb196bb84a69c41ae18a16562d8a3cf1b88ce..0274cca353d3385ea35a43fa3bb658fd6741ce34 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -220,6 +220,25 @@ details on the format string.
 
 *Example format*: +%{%a, %b %d%}, %Y%N - %H+
 
+=== Volume
+
+Outputs the volume of the specified mixer on the specified device. Works only
+on Linux because it uses ALSA.
+
+*Example order*: +volume master+
+
+*Example format*: +♪: %volume+
+
+*Example configuration*:
+-------------------------------------------------------------
+volume master {
+       format = "♪: %volume"
+       device = "default"
+       mixer = "Master"
+       mixer_idx = 0
+}
+-------------------------------------------------------------
+
 == Using i3status with dzen2
 
 After installing dzen2, you can directly use it with i3status: