Merge for pull request #53

1 files changed, 67 insertions, 5 deletions

diff --git a/readme.md b/readme.md
index 98d3b7b..36c2173 100644
--- a/readme.md
+++ b/readme.md
@@ -221,6 +221,11 @@ Other configuration options:
 
 :         position = Top
 
+`persistent`
+:     When True the window status is fixed i.e. hiding or revealing is not
+      possible. This option can be toggled at runtime.
+
+
 `border`
 :     TopB, TopBM, BottomB, BottomBM, FullB, FullBM or NoBorder (default).
 
@@ -293,6 +298,34 @@ xmobar --help):
 
     Mail bug reports and suggestions to <xmobar@projects.haskell.org>
 
+## 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 in a FCFS manor, 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
+
+- Bus Name: `org.Xmobar.Control`
+- Object Path: `/org/Xmobar/Control`
+- Member Name: Any of SignalType, e.g. `string:Reveal`
+- Interface Name: `org.Xmobar.Control`
+
+An example using the `dbus-send` command line utility:
+
+        dbus-send \
+            --session \
+            --dest=org.Xmobar.Control \
+            --type=method_call \
+            --print-reply \
+            '/org/Xmobar/Control' \
+            org.Xmobar.Control.SendSignal \
+            "string:Toggle"
+
+
 ## The Output Template
 
 The output template must contain at least one command. xmobar will
@@ -919,6 +952,35 @@ can be used in the output template as `%mydate%`
 
 - Reads its displayed output from the given pipe.
 
+`BufferedPipeReader  Alias [ (Timeout, Bool, "/path/to/pipe1")
+                           , (Timeout, Bool, "/path/to/pipe2")
+                           , ..
+                           ]`
+
+- Display data from multiple pipes.
+- Timeout (in tenth of seconds) is the value after which the previous content is
+  restored i.e. if there was already something from a previous pipe it will be
+  put on display again, overwriting the current status.
+- A pipe with Timout of 0 will be displayed permanently, just like `PipeReader`
+- The boolean option indicates whether new data for this pipe should make xmobar
+  appear (unhide, reveal). In this case, the Timeout additionally specifies when
+  the window should be hidden again. The output is restored in any case.
+- Use it for OSD like status bars e.g. for setting the volume or brightness:
+
+        Run BufferedPipeReader "bpr"
+            [ (  0, False, "/tmp/xmobar_window"  )
+            , ( 15,  True, "/tmp/xmobar_status"  )
+            ]
+
+  Have your window manager send window titles to `"/tmp/xmobar_window"`. They will
+  always be shown and not reveal your xmobar.
+  Sending some status information to `"/tmp/xmobar_status"` will reveal xmonad
+  for 1.5 seconds and temporarily overwrite the window titles.
+- Take a look at [samples/status.sh]
+
+[samples/status.sh]: http://github.com/jaor/xmobar/raw/master/samples/status.sh
+
+
 `XMonadLog`
 
 - Aliases to XMonadLog
@@ -1064,11 +1126,11 @@ the greater Haskell community.
 
 In particular, xmobar [incorporates patches] by Ben Boeckel, Roman
 Cheplyaka, John Goerzen, Juraj Hercek, Tomas Janousek, Spencer
-Janssen, Lennart Kolmodin, Krzysztof Kosciuszkiewicz, Dmitry
-Kurochkin, Svein Ove, Martin Perner, Jens Petersen, Petr Rockai,
-Andrew Sackville-West, Alexander Solovyov, Artem Tarasov, Sergei
-Trofimovich, Thomas Tuegel, Jan Vornberger, Daniel Wagner and Norbert
-Zeh.
+Janssen, Jochen Keil, Lennart Kolmodin, Krzysztof Kosciuszkiewicz,
+Dmitry Kurochkin, Svein Ove, Martin Perner, Jens Petersen, Petr
+Rockai, Andrew Sackville-West, Alexander Solovyov, Artem Tarasov,
+Sergei Trofimovich, Thomas Tuegel, Jan Vornberger, Daniel Wagner and
+Norbert Zeh.
 
 [incorporates patches]: http://www.ohloh.net/p/xmobar/contributors