more documentation for WindowNavigation and UrgencyHook

darcs-hash:20080525050231-78224-669c83df86a8b585883d0fb3ef054e37670261e8.gz

1 files changed, 26 insertions, 0 deletions

diff --git a/XMonad/Hooks/UrgencyHook.hs b/XMonad/Hooks/UrgencyHook.hs
index 10861c9..96c2832 100644
--- a/XMonad/Hooks/UrgencyHook.hs
+++ b/XMonad/Hooks/UrgencyHook.hs
@@ -32,6 +32,9 @@ module XMonad.Hooks.UrgencyHook (
                                  -- ** Note
                                  -- $note
 
+                                 -- * Troubleshooting
+                                 -- $troubleshooting
+
                                  -- * Example: Setting up irssi + rxvt-unicode
                                  -- $example
 
@@ -124,6 +127,29 @@ import Foreign (unsafePerformIO)
 -- urgency hook and restart xmonad, you may need to rejigger your layout by
 -- hitting mod-shift-space.
 
+-- $troubleshooting
+--
+-- There are three steps to get right:
+--
+-- 1. The X client must set the UrgencyHint flag. How to configure this
+--    depends on the application. If you're using a terminal app, this is in
+--    two parts:
+--
+--      * The console app must send a ^G (bell). In bash, a helpful trick is
+--        @sleep 1; echo -e \'\a\'@.
+--
+--      * The terminal must convert the bell into UrgencyHint.
+--
+-- 2. XMonad must be configured to notice UrgencyHints. If you've added
+--    withUrgencyHook, you may need to hit mod-shift-space to reset the layout.
+--
+-- 3. The dzen must run when told. Run @dzen2 -help@ and make sure that it
+--    supports all of the arguments you told DzenUrgencyHook to pass it. Also,
+--    set up a keybinding to the 'dzen' action in "XMonad.Util.Dzen" to test
+--    if that works.
+--
+-- As best you can, try to isolate which one(s) of those is failing.
+
 -- $example
 --
 -- This is a commonly asked example. By default, the window doesn't get flagged