aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrent Yorgey <byorgey@gmail.com>2007-12-15 15:37:27 +0100
committerBrent Yorgey <byorgey@gmail.com>2007-12-15 15:37:27 +0100
commitad44e015e0a0e2cc1be033376430d071ccd61fae (patch)
tree23662ce35a1e879c017dc1e5a86ee0afb4a95b77
parente953f7a8249603089423c08dadb66e6049c43a5d (diff)
downloadXMonadContrib-ad44e015e0a0e2cc1be033376430d071ccd61fae.tar.gz
XMonadContrib-ad44e015e0a0e2cc1be033376430d071ccd61fae.tar.xz
XMonadContrib-ad44e015e0a0e2cc1be033376430d071ccd61fae.zip
DynamicLog.hs: some documentation updates.
darcs-hash:20071215143727-bd4d7-1bacdb513aa2e5d760c89ca52c95f40ecbff520c.gz
-rw-r--r--XMonad/Hooks/DynamicLog.hs17
1 files changed, 9 insertions, 8 deletions
diff --git a/XMonad/Hooks/DynamicLog.hs b/XMonad/Hooks/DynamicLog.hs
index a95cc29..a4a492f 100644
--- a/XMonad/Hooks/DynamicLog.hs
+++ b/XMonad/Hooks/DynamicLog.hs
@@ -10,17 +10,18 @@
--
-- DynamicLog
--
--- Log events in:
+-- By default, log events in:
--
-- > 1 2 [3] 4 8
--
--- format. Suitable to pipe into dzen.
+-- format, although the format is highly customizable.
+-- Suitable to pipe into dzen or xmobar.
--
-----------------------------------------------------------------------------
module XMonad.Hooks.DynamicLog (
-- * Usage
- -- $usage
+ -- $usage
dynamicLog,
dynamicLogDzen,
dynamicLogXmobar,
@@ -37,7 +38,7 @@ module XMonad.Hooks.DynamicLog (
makeSimpleDzenConfig
) where
---
+--
-- Useful imports
--
import XMonad
@@ -51,7 +52,7 @@ import XMonad.Util.NamedWindows
import XMonad.Util.Run
import XMonad.Hooks.UrgencyHook
--- $usage
+-- $usage
-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad
@@ -68,9 +69,9 @@ makeSimpleDzenConfig = do
, logHook = dynamicLogWithPP dzenPP
{ ppOutput = hPutStrLn h } }
--- |
+-- |
--
--- Run xmonad with a dzen status bar set to some nice defaults. Output
+-- Run xmonad with a dzen status bar set to some nice defaults. Output
-- is taken from the dynamicLogWithPP hook.
--
-- > main = dzen xmonad
@@ -253,7 +254,7 @@ sjanssenPP = defaultPP { ppCurrent = xmobarColor "white" "#ff000000"
-- | These are good defaults to be used with the xmobar status bar
dynamicLogXmobar :: X ()
-dynamicLogXmobar =
+dynamicLogXmobar =
dynamicLogWithPP defaultPP { ppCurrent = xmobarColor "yellow" "" . wrap "[" "]"
, ppTitle = xmobarColor "green" "" . shorten 40
, ppVisible = wrap "(" ")"