From cfb26dc6ba83406fe965420be7843fd7e1c714ea Mon Sep 17 00:00:00 2001
From: Michael Carlberg <c@rlberg.se>
Date: Fri, 14 Oct 2016 18:28:59 +0200
Subject: [PATCH] Created Module: volume (markdown)

---
 Module:-volume.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 Module:-volume.md

diff --git a/Module:-volume.md b/Module:-volume.md
new file mode 100644
index 0000000..3927540
--- /dev/null
+++ b/Module:-volume.md
@@ -0,0 +1,54 @@
+This module shows information about the current volume.
+
+### Basic settings
+  ~~~ ini
+  [module/volume]
+  type = internal/volume
+  ;master-mixer = Master
+
+  ; Use the following command to list available mixer controls:
+  ; $ amixer scontrols | sed -nr "s/.*'([[:alnum:]]+)'.*/\1/p"
+  speaker-mixer = Speaker
+  headphone-mixer = Headphone
+
+  ; NOTE: This is required if headphone_mixer is defined
+  ; Use the following command to list available device controls
+  ; $ amixer controls | sed -r "/CARD/\!d; s/.*=([0-9]+).*name='([^']+)'.*/printf '%3.0f: %s\n' '\1' '\2'/e" | sort
+  headphone-id = 9
+  ~~~
+
+### Additional formatting
+  ~~~ ini
+  ; Available tags:
+  ;   <label-volume> (default)
+  ;   <ramp-volume>
+  ;   <bar-volume>
+  format-volume = <ramp-volume> <label-volume>
+
+  ; Available tags:
+  ;   <label-muted> (default)
+  ;   <ramp-volume>
+  ;   <bar-volume>
+  ;format-muted = <label-muted>
+
+  ; Available tokens:
+  ;   %percentage% (default)
+  ;label-volume = %percentage%
+
+  ; Available tokens:
+  ;   %percentage% (default)
+  label-muted = 🔇 muted
+  label-muted-foreground = #66
+
+  ; Only applies if <ramp-volume> is used
+  ramp-volume-0 = 🔈
+  ramp-volume-1 = 🔉
+  ramp-volume-2 = 🔊
+
+  ; If defined, it will replace <ramp-volume> when
+  ; headphones are plugged in to `headphone_control_numid`
+  ; If undefined, <ramp-volume> will be used for both
+  ; Only applies if <ramp-volume> is used
+  ramp-headphones-0 = 
+  ramp-headphones-1 = 
+  ~~~
\ No newline at end of file