From 09a8ea406d58d972d318a8884d0a4ef292f44744 Mon Sep 17 00:00:00 2001 From: Thomas Tuegel Date: Thu, 13 Jan 2011 10:50:20 -0600 Subject: Documented volume monitor in README. --- README | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README') diff --git a/README b/README index b83a7f0..1e300bb 100644 --- a/README +++ b/README @@ -120,6 +120,10 @@ Otherwise, you'll need to install them yourself. headers in your system (e.g., install `libiw-dev` in Debian-based systems). +`with_alsa` +: Support for ALSA sound cards. Enables the Volume plugin. Requires the + [alsa-mixer] package. + `all_extensions` : Enables all the extensions above. @@ -616,6 +620,18 @@ Monitors have default aliases. Run MBox [("I ", "inbox", "red"), ("O ", "~/foo/mbox", "")] ["-d", "/var/mail/", "-p", " "] "mbox" +`Volume Mixer Element Args RefreshRate` + +- Aliases to the mixer name and element name separated by a colon. Thus, + `Volume "default" "Master" [] 10` can be used as `%default:Master`. +- Args: default monitor arguments (see below) +- Variables that can be used with the `-t`/`--template` argument: + `vol`, `db`, `on`, `off` +- Default template: `Vol: % ` +- Requires the package [alsa-mixer] installed in your system. In addition, + to activate this plugin you must pass `--flags="with_alsa"` during + compilation. + `XPropertyLog PropName` - Aliases to `PropName` @@ -998,3 +1014,4 @@ Copyright © 2010 Jose Antonio Ortega Ruiz [libmpd]: http://hackage.haskell.org/package/libmpd/ [sawfish]: http://sawfish.wikia.com/ [utf8-string]: http://hackage.haskell.org/package/utf8-string/ +[alsa-mixer]: http://hackage.haskell.org/package/alsa-mixer -- cgit v1.2.3 From 0d9c121385d428d0b9ba82aa956ca5123e395f09 Mon Sep 17 00:00:00 2001 From: Thomas Tuegel Date: Thu, 13 Jan 2011 13:16:55 -0600 Subject: Updated README for improved volume monitor. --- README | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 1e300bb..9b608a1 100644 --- a/README +++ b/README @@ -623,10 +623,26 @@ Monitors have default aliases. `Volume Mixer Element Args RefreshRate` - Aliases to the mixer name and element name separated by a colon. Thus, - `Volume "default" "Master" [] 10` can be used as `%default:Master`. -- Args: default monitor arguments (see below) + `Volume "default" "Master" [] 10` can be used as `%default:Master%`. +- Args: default monitor arguments (see below). Also accepts: + - `-O` _string_ On string + - The string used in place of `` when the mixer element + is on. + - Long option: `--on` + - `-o` _string_ Off string + - The string used in place of `` when the mixer element + is off. + - Long option: `--off` + - `-C` _color_ On color + - The color to be used for `` when the mixer element is on. + - Long option: `--onc` + - `-c` _color_ Off color + - The color to be used for `` when the mixer element is off. + - Long option: `--offc` + - `--highd` _number_ High threshold for dB + - `--lowd` _number_ Low threshold for dB - Variables that can be used with the `-t`/`--template` argument: - `vol`, `db`, `on`, `off` + `vol`, `dB`, `status` - Default template: `Vol: % ` - Requires the package [alsa-mixer] installed in your system. In addition, to activate this plugin you must pass `--flags="with_alsa"` during -- cgit v1.2.3 From 6591f7e59909dee011abe1ce9df16d03a797de97 Mon Sep 17 00:00:00 2001 From: Thomas Tuegel Date: Thu, 13 Jan 2011 19:11:59 -0600 Subject: Corrected spelling error in README. --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 9b608a1..2174334 100644 --- a/README +++ b/README @@ -642,7 +642,7 @@ Monitors have default aliases. - `--highd` _number_ High threshold for dB - `--lowd` _number_ Low threshold for dB - Variables that can be used with the `-t`/`--template` argument: - `vol`, `dB`, `status` + `volume`, `dB`, `status` - Default template: `Vol: % ` - Requires the package [alsa-mixer] installed in your system. In addition, to activate this plugin you must pass `--flags="with_alsa"` during -- cgit v1.2.3