xmonad-contrib-0.5: Third party extensions for xmonadContentsIndex
XMonad.Hooks.DynamicLog
Portabilityunportable
Stabilityunstable
MaintainerDon Stewart <dons@cse.unsw.edu.au>
Contents
Usage
Description

DynamicLog

Log events in: 

     1 2 [3] 4 8

format. Suitable to pipe into dzen.

Synopsis
dynamicLog :: X ()
dynamicLogDzen :: X ()
dynamicLogXmobar :: X ()
dynamicLogWithPP :: PP -> X ()
dynamicLogXinerama :: X ()
dzen :: (XConfig (Choose Tall (Choose (Mirror Tall) Full)) -> IO ()) -> IO ()
pprWindowSet :: [String] -> PP -> WindowSet -> String
pprWindowSetXinerama :: WindowSet -> String
data PP = PP {
ppCurrent, ppVisible, ppHidden, ppHiddenNoWindows :: (WorkspaceId -> String)
ppSep, ppWsSep :: String
ppTitle :: (String -> String)
ppLayout :: (String -> String)
ppOrder :: ([String] -> [String])
ppOutput :: (String -> IO ())
}
defaultPP :: PP
dzenPP :: PP
sjanssenPP :: PP
wrap :: String -> String -> String -> String
pad :: String -> String
shorten :: Int -> String -> String
xmobarColor :: String -> String -> String -> String
dzenColor :: String -> String -> String -> String
dzenEscape :: String -> String
makeSimpleDzenConfig :: IO (XConfig (Choose Tall (Choose (Mirror Tall) Full)))
Usage

You can use this module with the following in your ~/.xmonad/xmonad.hs: 

    import XMonad
    import XMonad.Hooks.DynamicLog
    main = xmonad defaultConfig { logHook = dynamicLog }
dynamicLog :: X ()

An example log hook, print a status bar output to stdout, in the form: 

 1 2 [3] 4 7 : full : title

That is, the currently populated workspaces, the current workspace layout, and the title of the focused window.

dynamicLogDzen :: X ()
An example log hook that emulates dwm's status bar, using colour codes printed to dzen Requires dzen. Workspaces, xinerama, layouts and the window title are handled.
dynamicLogXmobar :: X ()
These are good defaults to be used with the xmobar status bar
dynamicLogWithPP :: PP -> X ()
A log function that uses the PP hooks to customize output.
dynamicLogXinerama :: X ()

Workspace logger with a format designed for Xinerama: 

 [1 9 3] 2 7

where 1, 9, and 3 are the workspaces on screens 1, 2 and 3, respectively, and 2 and 7 are non-visible, non-empty workspaces

dzen :: (XConfig (Choose Tall (Choose (Mirror Tall) Full)) -> IO ()) -> IO ()

Run xmonad with a dzen status bar set to some nice defaults. Output is taken from the dynamicLogWithPP hook. 

 main = dzen xmonad

The intent is that the above config file should provide a nice status bar with minimal effort.

pprWindowSet :: [String] -> PP -> WindowSet -> String
pprWindowSetXinerama :: WindowSet -> String
data PP
The PP type allows the user to customize various behaviors of dynamicLogPP
Constructors
PP
ppCurrent, ppVisible, ppHidden, ppHiddenNoWindows :: (WorkspaceId -> String)
ppSep, ppWsSep :: String
ppTitle :: (String -> String)
ppLayout :: (String -> String)
ppOrder :: ([String] -> [String])
ppOutput :: (String -> IO ())
defaultPP :: PP
The default pretty printing options, as seen in dynamicLog
dzenPP :: PP
Settings to emulate dwm's statusbar, dzen only
sjanssenPP :: PP
The options that sjanssen likes to use, as an example. Note the use of xmobarColor and the record update on defaultPP
wrap :: String -> String -> String -> String
pad :: String -> String
shorten :: Int -> String -> String
xmobarColor :: String -> String -> String -> String
dzenColor :: String -> String -> String -> String
dzenEscape :: String -> String
Escape any dzen metacharacters.
makeSimpleDzenConfig :: IO (XConfig (Choose Tall (Choose (Mirror Tall) Full)))
An example xmonad config that spawns a new dzen toolbar and uses the default dynamic log output
Produced by Haddock version 0.8