with_dbus documented

2 files changed, 16 insertions, 11 deletions

diff --git a/readme.md b/readme.md
index 35b28b5..e210920 100644
--- a/readme.md
+++ b/readme.md
@@ -100,6 +100,10 @@ Extensions need additional libraries (listed below) that will be
 automatically downloaded and installed if you're using cabal install.
 Otherwise, you'll need to install them yourself.
 
+`with_dbus`
+:    Enables support for DBUS by making xmobar to publish a service on
+     the session bus.  Requires the [dbus] package.
+
 `with_threaded`
 :    Uses GHC's threaded runtime.  Use this option if xmobar enters a
      high-CPU regime right after starting.
@@ -300,13 +304,14 @@ xmobar --help):
 
 ## The DBus Interface
 
-xmobar can be controlled over dbus. All signals defined in
-[src/Signal.hs] as `data SignalType` can now be sent over dbus to
-xmobar.  Due to current limitations of the implementation only one
-process of xmobar can aquire the dbus. This is handled on a
-first-come-first-seved basis, meaning that the first process will get
-the dbus interface. Other processes will run without further problems,
-yet have no dbus interface.
+When compiled with the optional `with_dbus` flag, xmobar can be
+controlled over dbus. All signals defined in [src/Signal.hs] as `data
+SignalType` can now be sent over dbus to xmobar.  Due to current
+limitations of the implementation only one process of xmobar can
+aquire the dbus. This is handled on a first-come-first-seved basis,
+meaning that the first process will get the dbus interface. Other
+processes will run without further problems, yet have no dbus
+interface.
 
 [src/Signal.hs]: https://github.com/jaor/xmobar/raw/master/src/Signal.hs
 
diff --git a/xmobar.cabal b/xmobar.cabal
index 54f932e..a0012c7 100644
--- a/xmobar.cabal
+++ b/xmobar.cabal
@@ -58,19 +58,19 @@ flag with_alsa
   default: False
 
 flag with_datezone
-  description: Enables localized date support
+  description: Enables localized date support.
   default: False
 
 flag with_mpris
-  description: MPRIS v1, v2 support
+  description: MPRIS v1, v2 support.
   default: False
 
 flag with_dbus
-  description: Publish a Service on the Session Bus for controlling xmobar
+  description: Publish a service on the session bus for controlling xmobar.
   default: False
 
 flag with_threaded
-  description: Use threaded runtime
+  description: Use threaded runtime.
   default: False
 
 executable xmobar