From 1971c97301bd56767a282ae654e6743fb7aa6e38 Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Sat, 15 Jan 2011 00:18:46 +0100 Subject: Volume documentation: credits and minor changes --- README | 61 +++++++++++++++++++++++++++++++------------------------------ 1 file changed, 31 insertions(+), 30 deletions(-) (limited to 'README') diff --git a/README b/README index 2174334..6a4bcd7 100644 --- a/README +++ b/README @@ -555,6 +555,34 @@ Monitors have default aliases. "-L", "40", "-H", "60", "-l", "lightblue", "-n", "gray90", "-h", "red"] 50 +`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). 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: + `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 + compilation. + `MPD Args RefreshRate` - This monitor will only be compiled if you ask for it using the @@ -620,34 +648,6 @@ 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). 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: - `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 - compilation. - `XPropertyLog PropName` - Aliases to `PropName` @@ -962,7 +962,8 @@ xmobar [incorporates patches] from Ben Boeckel, Roman Cheplyaka, John Goerzen, Juraj Hercek, Tomas Janousek, Spencer Janssen, Krzysztof Kosciuszkiewicz, Lennart Kolmodin, Dmitry Kurochkin, Svein Ove, Jens Petersen, Petr Rockai, Andrew Sackville-West, Alexander Solovyov, -Sergei Trofimovich, Jan Vornberger, Daniel Wagner and Norbert Zeh. +Thomas Tuegel, Sergei Trofimovich, Jan Vornberger, Daniel Wagner and +Norbert Zeh. [incorporates patches]: http://www.ohloh.net/p/xmobar/contributors @@ -1015,7 +1016,7 @@ more details. Copyright © 2007-2010 Andrea Rossato -Copyright © 2010 Jose Antonio Ortega Ruiz +Copyright © 2010-2011 Jose Antonio Ortega Ruiz [Github]: http://github.com/jaor/xmobar/ [Github page]: http://github.com/jaor/xmobar -- cgit v1.2.3