diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 83 |
1 files changed, 67 insertions, 16 deletions
@@ -46,7 +46,7 @@ bells and whistles, use: If you don't have `cabal-install` installed, you can get xmobar's source code in a variety of ways: - - From [Hackage]. Just download [xmobar-0.12.tar.gz] from xmobar's + - From [Hackage]. Just download [xmobar-0.13.tar.gz] from xmobar's hackage page. - From [Github]. You can also obtain a tarball in [Github's downloads page]. You'll find there links to each tagged release. @@ -55,13 +55,13 @@ source code in a variety of ways: git: git clone git://github.com/jaor/xmobar -[xmobar-0.12.tar.gz]: http://hackage.haskell.org/packages/archive/xmobar/0.12/xmobar-0.12.tar.gz +[xmobar-0.13.tar.gz]: http://hackage.haskell.org/packages/archive/xmobar/0.13/xmobar-0.13.tar.gz [Github's downloads page]: https://github.com/jaor/xmobar/downloads To install simply run (if needed): - tar xvfz xmobar-0.12 - cd xmobar-0.12 + tar xvfz xmobar-0.13 + cd xmobar-0.13 If you have cabal installed, you can now use it from within xmobar's source tree. Otherwise, run the configure script: @@ -124,6 +124,10 @@ Otherwise, you'll need to install them yourself. : Support for ALSA sound cards. Enables the Volume plugin. Requires the [alsa-mixer] package. +`with_datezone` +: Support for localized times. Enables the DateZone plugin. Requires + [timezone-olson] and [timezone-series] package. + `all_extensions` : Enables all the extensions above. @@ -317,9 +321,9 @@ standard input reader, an Unix named pipe reader, and a configurable date plugin. These plugins install the following internal commands: `Weather`, `Network`, `Wireless` (optional), `Memory`, `Swap`, `Cpu`, `MultiCpu`, `Battery`, `TopProc`, `TopMem`, `DiskU`, `DiskIO`, -`Thermal`, `CpuFreq`, `CoreTemp`, `Volume` (optional), `MPD` -(optional), `Mail` (optional), `MBox` (optional), `Date`, `Uptime`, -`StdinReader`, `CommandReader`, and `PipeReader`. +`Thermal`, `ThermalZone`, `CpuFreq`, `CoreTemp`, `Volume` (optional), +`MPD` (optional), `Mail` (optional), `MBox` (optional), `Date`, +`Uptime`, `StdinReader`, `CommandReader`, and `PipeReader`. To remove them see below Installing/Removing a Plugin @@ -515,9 +519,28 @@ Monitors have default aliases. Disks [("/", "<read> <write>"), ("sdb1", "<total>")] [] 10 +`ThermalZone Number Args RefreshRate` + +- Aliases to "thermaln": so `ThermalZone 0 []` can be used in template + as `%thermal0%` +- Args: default monitor arguments (see below) +- Variables that can be used with the `-t`/`--template` argument: + `temp` +- Default template: `<temp>C` +- This plugin works only on sytems with devices having thermal zone. + Check directories in `/sys/class/thermal` for possible values of the + zone number (e.g., 0 corresponds to `thermal_zone0` in that + directory). +- Example: + + Run ThermalZone 0 ["-t","<id>: <temp>C"] 30 + `Thermal Zone Args RefreshRate` -- Aliases to the Zone: so `Zone "THRM" []` can be used in template as `%THRM%` +- **This plugin is deprecated. Use `ThermalZone` instead.** + +- Aliases to the Zone: so `Thermal "THRM" []` can be used in template + as `%THRM%` - Args: default monitor arguments (see below) - Variables that can be used with the `-t`/`--template` argument: `temp` @@ -526,7 +549,7 @@ Monitors have default aliases. Check directories in /proc/acpi/thermal_zone for possible values. - Example: - Run Thermal "THRM" ["-t","iwl4965-temp: <temp>C"] + Run Thermal "THRM" ["-t","iwl4965-temp: <temp>C"] 50 `CpuFreq Args RefreshRate` @@ -592,9 +615,9 @@ Monitors have default aliases. - Aliases to `mpd` - Args: default monitor arguments (see below). In addition you can provide `-P`, `-S` and `-Z`, with an string argument, to represent the - playing, stopped and paused states in the `statei` template field, - and `-h`, `-p` and `-x` for the host, port and password (default - host is "localhost", port 6600 and empty password). + playing, stopped and paused states in the `statei` template field. + The environment variables `MPD_HOST` and `MPD_PORT` are used to configure the + mpd server to communicate with. - Variables that can be used with the `-t`/`--template` argument: `bar`, `state`, `statei`, `volume`, `length` `lapsed`, `remaining`, @@ -658,6 +681,24 @@ Monitors have default aliases. distribution can be used to set the given property from the output of any other program or script. +`Brightness Args RefreshRate` + +- Aliases to `bright` +- Args: default monitor arguments (see below), plus the following specif ones: + - `-D`: directory in `/sys/class/backlight/` with files in it + (default: "acpi_video0") + - `-C`: file with the current brightness (default: + actual_brightness) + - `-M`: file with the maximum brightness (default: + max_brigtness) +- Variables that can be used with the `-t`/`--template` argument: + `hbar`, `percent`, `bar` +- Default template: `<percent>` +- Example: + + Run Brightness ["-t", "<bar>"] 60 + + [samples/xmonadpropwrite.hs script]: https://github.com/jaor/xmobar/raw/master/samples/xmonadpropwrite.hs ## Monitor Plugins Commands Arguments @@ -809,6 +850,16 @@ can be used in the output template as `%mydate%` `strftime` function (or Haskell's `formatCalendarTime`). - Sample usage: `Run Date "%a %b %_d %Y <fc=#ee9a00>%H:%M:%S</fc>" "date" 10` +`Date Format Alias Zone RefreshRate` + +- Format is a time format string, as accepted by the standard ISO C + `strftime` function (or Haskell's `formatCalendarTime`). +- Zone is the name of the TimeZone. Assumes that the tz database is stored in + /usr/share/zoneinfo/ +- Sample usage: + `Run DateZone "<fc=#ee9a00>%H:%M:%S</fc>" "viennaDate" "Europa/Vienna" 10` + + `CommandReader "/path/to/program" Alias` - Runs the given program, and displays its standard output. @@ -965,10 +1016,10 @@ Credits xmobar [incorporates patches] by Ben Boeckel, Roman Cheplyaka, John Goerzen, Juraj Hercek, Tomas Janousek, Spencer Janssen, Lennart -Kolmodin, Krzysztof Kosciuszkiewicz, Dmitry Kurochkin, Svein Ove, Jens -Petersen, Petr Rockai, Andrew Sackville-West, Alexander Solovyov, -Sergei Trofimovich, Thomas Tuegel, Jan Vornberger, Daniel Wagner and -Norbert Zeh. +Kolmodin, Krzysztof Kosciuszkiewicz, Dmitry Kurochkin, Svein Ove, +Martin Perner, Jens Petersen, Petr Rockai, Andrew Sackville-West, +Alexander Solovyov, Sergei Trofimovich, Thomas Tuegel, Jan Vornberger, +Daniel Wagner and Norbert Zeh. [incorporates patches]: http://www.ohloh.net/p/xmobar/contributors |