summaryrefslogtreecommitdiffhomepage
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md140
1 files changed, 68 insertions, 72 deletions
diff --git a/readme.md b/readme.md
index 0740303..598eb8d 100644
--- a/readme.md
+++ b/readme.md
@@ -7,81 +7,81 @@
- [About](#about)
- [Bug reports](#bug-reports)
- [Installation](#installation)
- - [Using cabal-install](#using-cabal-install)
- - [From source](#from-source)
- - [Optional features](#optional-features)
+ - [Using cabal-install](#using-cabal-install)
+ - [From source](#from-source)
+ - [Optional features](#optional-features)
- [Running xmobar](#running-xmobar)
- - [Signal Handling](#signal-handling)
+ - [Signal Handling](#signal-handling)
- [Configuration](#configuration)
- - [Quick Start](#quick-start)
- - [Running xmobar with i3status](#running-xmobar-with-i3status)
- - [Dynamically sizing xmobar](#dynamically-sizing-xmobar)
- - [Command Line Options](#command-line-options)
- - [The DBus Interface](#the-dbus-interface)
- - [Example for using the DBus IPC interface with XMonad](#example-for-using-the-dbus-ipc-interface-with-xmonad)
- - [The Output Template](#the-output-template)
- - [The `commands` Configuration Option](#the-commands-configuration-option)
+ - [Quick Start](#quick-start)
+ - [Running xmobar with i3status](#running-xmobar-with-i3status)
+ - [Dynamically sizing xmobar](#dynamically-sizing-xmobar)
+ - [Command Line Options](#command-line-options)
+ - [The DBus Interface](#the-dbus-interface)
+ - [Example for using the DBus IPC interface with XMonad](#example-for-using-the-dbus-ipc-interface-with-xmonad)
+ - [The Output Template](#the-output-template)
+ - [The `commands` Configuration Option](#the-commands-configuration-option)
- [System Monitor Plugins](#system-monitor-plugins)
- - [Icon patterns](#icon-patterns)
- - [Default Monitor Arguments](#default-monitor-arguments)
- - [`Uptime Args RefreshRate`](#uptime-args-refreshrate)
- - [`Weather StationID Args RefreshRate`](#weather-stationid-args-refreshrate)
- - [`WeatherX StationID SkyConditions Args RefreshRate`](#weatherx-stationid-skyconditions-args-refreshrate)
- - [`Network Interface Args RefreshRate`](#network-interface-args-refreshrate)
- - [`DynNetwork Args RefreshRate`](#dynnetwork-args-refreshrate)
- - [`Wireless Interface Args RefreshRate`](#wireless-interface-args-refreshrate)
- - [`Memory Args RefreshRate`](#memory-args-refreshrate)
- - [`Swap Args RefreshRate`](#swap-args-refreshrate)
- - [`Cpu Args RefreshRate`](#cpu-args-refreshrate)
- - [`MultiCpu Args RefreshRate`](#multicpu-args-refreshrate)
- - [`Battery Args RefreshRate`](#battery-args-refreshrate)
- - [`BatteryP Dirs Args RefreshRate`](#batteryp-dirs-args-refreshrate)
- - [`BatteryN Dirs Args RefreshRate Alias`](#batteryn-dirs-args-refreshrate-alias)
- - [`TopProc Args RefreshRate`](#topproc-args-refreshrate)
- - [`TopMem Args RefreshRate`](#topmem-args-refreshrate)
- - [`DiskU Disks Args RefreshRate`](#disku-disks-args-refreshrate)
- - [`DiskIO Disks Args RefreshRate`](#diskio-disks-args-refreshrate)
- - [`ThermalZone Number Args RefreshRate`](#thermalzone-number-args-refreshrate)
- - [`Thermal Zone Args RefreshRate`](#thermal-zone-args-refreshrate)
- - [`CpuFreq Args RefreshRate`](#cpufreq-args-refreshrate)
- - [`CoreTemp Args RefreshRate`](#coretemp-args-refreshrate)
- - [`MultiCoreTemp Args RefreshRate`](#multicoretemp-args-refreshrate)
- - [`Volume Mixer Element Args RefreshRate`](#volume-mixer-element-args-refreshrate)
- - [`Alsa Mixer Element Args`](#alsa-mixer-element-args)
- - [`MPD Args RefreshRate`](#mpd-args-refreshrate)
- - [`Mpris1 PlayerName Args RefreshRate`](#mpris1-playername-args-refreshrate)
- - [`Mpris2 PlayerName Args RefreshRate`](#mpris2-playername-args-refreshrate)
- - [`Mail Args Alias`](#mail-args-alias)
- - [`MailX Args Opts Alias`](#mailx-args-opts-alias)
- - [`MBox Mboxes Opts Alias`](#mbox-mboxes-opts-alias)
- - [`XPropertyLog PropName`](#xpropertylog-propname)
- - [`UnsafeXPropertyLog PropName`](#unsafexpropertylog-propname)
- - [`NamedXPropertyLog PropName Alias`](#namedxpropertylog-propname-alias)
- - [`UnsafeNamedXPropertyLog PropName Alias`](#unsafenamedxpropertylog-propname-alias-1)
- - [`Brightness Args RefreshRate`](#brightness-args-refreshrate)
- - [`Kbd Opts`](#kbd-opts)
- - [`Locks`](#locks)
- - [`CatInt n filename`](#catint-n-filename)
- - [`UVMeter`](#uvmeter)
+ - [Icon patterns](#icon-patterns)
+ - [Default Monitor Arguments](#default-monitor-arguments)
+ - [`Uptime Args RefreshRate`](#uptime-args-refreshrate)
+ - [`Weather StationID Args RefreshRate`](#weather-stationid-args-refreshrate)
+ - [`WeatherX StationID SkyConditions Args RefreshRate`](#weatherx-stationid-skyconditions-args-refreshrate)
+ - [`Network Interface Args RefreshRate`](#network-interface-args-refreshrate)
+ - [`DynNetwork Args RefreshRate`](#dynnetwork-args-refreshrate)
+ - [`Wireless Interface Args RefreshRate`](#wireless-interface-args-refreshrate)
+ - [`Memory Args RefreshRate`](#memory-args-refreshrate)
+ - [`Swap Args RefreshRate`](#swap-args-refreshrate)
+ - [`Cpu Args RefreshRate`](#cpu-args-refreshrate)
+ - [`MultiCpu Args RefreshRate`](#multicpu-args-refreshrate)
+ - [`Battery Args RefreshRate`](#battery-args-refreshrate)
+ - [`BatteryP Dirs Args RefreshRate`](#batteryp-dirs-args-refreshrate)
+ - [`BatteryN Dirs Args RefreshRate Alias`](#batteryn-dirs-args-refreshrate-alias)
+ - [`TopProc Args RefreshRate`](#topproc-args-refreshrate)
+ - [`TopMem Args RefreshRate`](#topmem-args-refreshrate)
+ - [`DiskU Disks Args RefreshRate`](#disku-disks-args-refreshrate)
+ - [`DiskIO Disks Args RefreshRate`](#diskio-disks-args-refreshrate)
+ - [`ThermalZone Number Args RefreshRate`](#thermalzone-number-args-refreshrate)
+ - [`Thermal Zone Args RefreshRate`](#thermal-zone-args-refreshrate)
+ - [`CpuFreq Args RefreshRate`](#cpufreq-args-refreshrate)
+ - [`CoreTemp Args RefreshRate`](#coretemp-args-refreshrate)
+ - [`MultiCoreTemp Args RefreshRate`](#multicoretemp-args-refreshrate)
+ - [`Volume Mixer Element Args RefreshRate`](#volume-mixer-element-args-refreshrate)
+ - [`Alsa Mixer Element Args`](#alsa-mixer-element-args)
+ - [`MPD Args RefreshRate`](#mpd-args-refreshrate)
+ - [`Mpris1 PlayerName Args RefreshRate`](#mpris1-playername-args-refreshrate)
+ - [`Mpris2 PlayerName Args RefreshRate`](#mpris2-playername-args-refreshrate)
+ - [`Mail Args Alias`](#mail-args-alias)
+ - [`MailX Args Opts Alias`](#mailx-args-opts-alias)
+ - [`MBox Mboxes Opts Alias`](#mbox-mboxes-opts-alias)
+ - [`XPropertyLog PropName`](#xpropertylog-propname)
+ - [`UnsafeXPropertyLog PropName`](#unsafexpropertylog-propname)
+ - [`NamedXPropertyLog PropName Alias`](#namedxpropertylog-propname-alias)
+ - [`UnsafeNamedXPropertyLog PropName Alias`](#unsafenamedxpropertylog-propname-alias)
+ - [`Brightness Args RefreshRate`](#brightness-args-refreshrate)
+ - [`Kbd Opts`](#kbd-opts)
+ - [`Locks`](#locks)
+ - [`CatInt n filename`](#catint-n-filename)
+ - [`UVMeter`](#uvmeter)
- [Executing External Commands](#executing-external-commands)
- [Other Plugins](#other-plugins)
- - [`StdinReader`](#stdinreader)
- - [`UnsafeStdinReader`](#unsafestdinreader)
- - [`Date Format Alias RefreshRate`](#date-format-alias-refreshrate)
- - [`DateZone Format Locale Zone Alias RefreshRate`](#datezone-format-locale-zone-alias-refreshrate)
- - [`CommandReader "/path/to/program" Alias`](#commandreader-pathtoprogram-alias)
- - [`PipeReader "default text:/path/to/pipe" Alias`](#pipereader-default-textpathtopipe-alias)
- - [`MarqueePipeReader "default text:/path/to/pipe" (length, rate, sep) Alias`](#marqueepipereader-default-textpathtopipe-length-rate-sep-alias)
- - [`BufferedPipeReader Alias [(Timeout, Bool, "/path/to/pipe1"), ..]`](#bufferedpipereader-alias-timeout-bool-pathtopipe1-)
- - [`XMonadLog`](#xmonadlog)
- - [`UnsafeXMonadLog`](#unsafexmonadlog)
- - [`HandleReader Handle Alias`](#handlereader-handle-alias)
+ - [`StdinReader`](#stdinreader)
+ - [`UnsafeStdinReader`](#unsafestdinreader)
+ - [`Date Format Alias RefreshRate`](#date-format-alias-refreshrate)
+ - [`DateZone Format Locale Zone Alias RefreshRate`](#datezone-format-locale-zone-alias-refreshrate)
+ - [`CommandReader "/path/to/program" Alias`](#commandreader-pathtoprogram-alias)
+ - [`PipeReader "default text:/path/to/pipe" Alias`](#pipereader-default-textpathtopipe-alias)
+ - [`MarqueePipeReader "default text:/path/to/pipe" (length, rate, sep) Alias`](#marqueepipereader-default-textpathtopipe-length-rate-sep-alias)
+ - [`BufferedPipeReader Alias [(Timeout, Bool, "/path/to/pipe1"), ..]`](#bufferedpipereader-alias-timeout-bool-pathtopipe1-)
+ - [`XMonadLog`](#xmonadlog)
+ - [`UnsafeXMonadLog`](#unsafexmonadlog)
+ - [`HandleReader Handle Alias`](#handlereader-handle-alias)
- [User plugins](#user-plugins)
- - [Writing a Plugin](#writing-a-plugin)
- - [Using a Plugin](#using-a-plugin)
- - [Configurations written in pure Haskell](#configurations-written-in-pure-haskell)
+ - [Writing a Plugin](#writing-a-plugin)
+ - [Using a Plugin](#using-a-plugin)
+ - [Configurations written in pure Haskell](#configurations-written-in-pure-haskell)
- [Authors and credits](#authors-and-credits)
- - [Thanks](#thanks)
+ - [Thanks](#thanks)
- [Related](#related)
- [License](#license)
@@ -276,10 +276,6 @@ For the output template:
- `<fn=1>string</fn>` will print `string` with the first font from
`additionalFonts`. The index `0` corresponds to the standard font.
-- `<box=BBBottom C 0 1 red>string</box>` will underline `string` in red and `<box=BBFull>string</box>` will draw a white box around `string`.
- <br>Usage: `<box=Position Align Offset Width Color>`. Only `Position` is required, everything else has a default value.
- <br>Positions: `BBTop, BBBottom, BBVBoth, BBLeft, BBRight, BBHBoth, BBFull`
-
- `<icon=/path/to/icon.xbm/>` will insert the given bitmap. XPM image
format is also supported when compiled with `--flags="with_xpm"`.