From efa9e4c541695e725d39da001592c9613acc4cae Mon Sep 17 00:00:00 2001
From: Tomas Janousek <tomi@nomi.cz>
Date: Sun, 20 Feb 2022 19:56:21 +0000
Subject: Documentation: Note the need for threaded RTS with QueueReader &
 xmonad

Related: https://github.com/jaor/xmobar/issues/571
---
 doc/window-managers.org | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'doc')

diff --git a/doc/window-managers.org b/doc/window-managers.org
index 5c5b083..e45784c 100644
--- a/doc/window-managers.org
+++ b/doc/window-managers.org
@@ -210,6 +210,15 @@ choice.
           logWorkspacesToQueue q =
             dynamicLogWithPP def { ppOutput = STM.atomically . STM.writeTQueue q }
         #+end_src
+
+        Note that xmonad uses blocking Xlib calls in its event loop and isn't
+        normally compiled with
+        [[https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/using-concurrent.html][the threaded RTS]]
+        so an xmobar thread running inside xmonad will suffer from delayed
+        updates. It is thus necessary to enable =-threaded= when compiling
+        xmonad configuration (=xmonad.hs=), e.g. by using a custom
+        =~/.xmonad/build= script.
+
 *** Example for using the DBus IPC interface with XMonad
 
     Bind the key which should {,un}map xmobar to a dummy value. This is
-- 
cgit v1.2.3