From 082ef98c1c265ad927b728402d8803a86bbbaeef Mon Sep 17 00:00:00 2001
From: jao <jao@gnu.org>
Date: Mon, 18 Apr 2022 15:59:51 +0100
Subject: New dbus signal: SetAlpha (fixes #499)

---
 doc/quick-start.org     | 20 +++++++++++---------
 doc/window-managers.org | 10 +++++-----
 2 files changed, 16 insertions(+), 14 deletions(-)

(limited to 'doc')

diff --git a/doc/quick-start.org b/doc/quick-start.org
index 831f97c..929deb6 100644
--- a/doc/quick-start.org
+++ b/doc/quick-start.org
@@ -428,12 +428,13 @@ available [[http://github.com/jaor/xmobar/raw/master/examples/xmobar.config][her
 
   When compiled with the optional =with_dbus= flag, xmobar can be
   controlled over dbus. All signals defined in [[https://github.com/jaor/xmobar/blob/master/src/Xmobar/System/Signal.hs][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
-  acquire the dbus. This is handled on a first-come-first-served
-  basis, meaning that the first process will get the dbus
-  interface. Other processes will run without further problems, yet
-  have no dbus interface.
+  SignalType= can now be sent over dbus to xmobar.
+
+  Due to current limitations of the implementation only one process of
+  xmobar can acquire the dbus. This is handled on a
+  first-come-first-served basis, meaning that the first process will
+  get the dbus interface. Other processes will run without further
+  problems, yet have no dbus interface.
 
   - Bus Name: =org.Xmobar.Control=
   - Object Path: =/org/Xmobar/Control=
@@ -450,7 +451,7 @@ available [[http://github.com/jaor/xmobar/raw/master/examples/xmobar.config][her
       --print-reply \
       '/org/Xmobar/Control' \
       org.Xmobar.Control.SendSignal \
-      "string:Toggle 0"
+      "string:SetAlpha 192"
   #+end_src
 
   It is also possible to send multiple signals at once:
@@ -463,7 +464,8 @@ available [[http://github.com/jaor/xmobar/raw/master/examples/xmobar.config][her
 
   The =Toggle=, =Reveal=, and =Hide= signals take an additional integer
   argument that denotes an initial delay, in tenths of a second,
-  before the command takes effect.
+  before the command takes effect, while =SetAlpha= takes a new alpha
+  value (also an integer, between 0 and 255) as argument.
 
-  See [[window-managers.org::*Example of using][Interfacing with window managers]] for an example of how to use
+  See [[./window-managers.org::*Example of using][Interfacing with window managers]] for an example of how to use
   the DBus interface from xmonad.
diff --git a/doc/window-managers.org b/doc/window-managers.org
index e45784c..f60ee37 100644
--- a/doc/window-managers.org
+++ b/doc/window-managers.org
@@ -219,7 +219,7 @@ choice.
         xmonad configuration (=xmonad.hs=), e.g. by using a custom
         =~/.xmonad/build= script.
 
-*** Example for using the DBus IPC interface with XMonad
+*** Example of using the DBus IPC interface with XMonad
 
     Bind the key which should {,un}map xmobar to a dummy value. This is
     necessary for {,un}grabKey in xmonad.
@@ -245,10 +245,10 @@ choice.
 
       toggleDocksHook :: Int -> KeySym -> Event -> X All
       toggleDocksHook to ks ( KeyEvent { ev_event_display = d
-                                      , ev_event_type    = et
-                                      , ev_keycode       = ekc
-                                      , ev_time          = etime
-                                      } ) =
+                                       , ev_event_type    = et
+                                       , ev_keycode       = ekc
+                                       , ev_time          = etime
+                                       } ) =
               io (keysymToKeycode d ks) >>= toggleDocks >> return (All True)
           where
           toggleDocks kc
-- 
cgit v1.2.3