twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-08-01 12:41:52 -07:00
Code Issues Packages Projects Releases Wiki Activity

X.H.DynamicLog: Minor doc tweaks

Browse Source
This commit is contained in:
Tomas Janousek
2020-12-19 18:27:19 +00:00
parent cff344811f
commit 555cd7c596
1 changed files with 16 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
XMonad/Hooks/DynamicLog.hs
View File

@@ -125,8 +125,8 @@ import XMonad.Hooks.ManageDocks
-- > myConfig = def { ... } -- > myConfig = def { ... }
-- --
-- You then have to tell your status bar to read from the @_XMONAD_LOG@ property -- You then have to tell your status bar to read from the @_XMONAD_LOG@ property
-- of the root window. In the case of xmobar, this is simply achieved by adding -- of the root window. In the case of xmobar, this is simply achieved by using
-- the @XMonadLog@ plugin to your @.xmobarrc@: -- the @XMonadLog@ plugin instead of @StdinReader@ in your @.xmobarrc@:
-- --
-- > Config { ... -- > Config { ...
-- > , commands = [ Run XMonadLog, ... ] -- > , commands = [ Run XMonadLog, ... ]
@@ -137,21 +137,22 @@ import XMonad.Hooks.ManageDocks
-- part of the default xmobar configuration and you status bar will not show -- part of the default xmobar configuration and you status bar will not show
-- otherwise! -- otherwise!
-- --
-- Because 'statusBarProp' lets you defined your own executable, you can also -- Because 'statusBarProp' lets you define your own executable, you can also
-- give it a different status bar entirely; you only need to make sure that the -- give it a different status bar entirely; you only need to make sure that the
-- status bar supports reading a property string from the root window. -- status bar supports reading a property string from the root window, or use
-- some kind of wrapper that reads the property and pipes it into the bar.
-- --
-- If you don't want to read from the default property, you can specify your own -- If you don't want to read from the default property, you can specify your own
-- with the 'statusBarPropTo' function. -- with the 'statusBarPropTo' function.
-- --
-- If your status bar does not support property-based logging, you may try -- If your status bar does not support property-based logging, you may also try
-- 'statusBar' and 'statusBar'', as well as the `xmobar` function, instead. -- 'statusBar' and 'statusBar'', as well as the `xmobar` function, instead.
-- They can be used in the same way as the 'statusBarProp' and 'xmobarProp' -- They can be used in the same way as the 'statusBarProp' and 'xmobarProp'
-- functions above (for xmobar, you will now have to add the @StdinReader@ -- functions above (for xmobar, you will now use the @StdinReader@
-- plugin to you @.xmobarrc@). Instead of writing to a property, these -- plugin in your @.xmobarrc@). Instead of writing to a property, these
-- functions open a pipe and make the given status bar read from that pipe. -- functions open a pipe and make the given status bar read from that pipe.
-- Please be aware that this kind of setup is very bug-prone and hence is -- Please be aware that this kind of setup is very bug-prone and hence is
-- discouraged. -- discouraged: if anything goes wrong with the bar, xmonad will freeze.
-- --
-- If you do not want to use any of the "batteries included" functions above, -- If you do not want to use any of the "batteries included" functions above,
-- you can also add all of the necessary plumbing yourself (the definition of -- you can also add all of the necessary plumbing yourself (the definition of
@@ -199,9 +200,7 @@ import XMonad.Hooks.ManageDocks
-- --
-- The above has the problem that xmobar will not get restarted whenever you -- The above has the problem that xmobar will not get restarted whenever you
-- restart xmonad ('XMonad.Util.SpawnOnce.spawnOnce' will simply prevent your -- restart xmonad ('XMonad.Util.SpawnOnce.spawnOnce' will simply prevent your
-- chosen status bar from spawning again). On the other hand, 'statusBarProp' -- chosen status bar from spawning again).
-- handles this case correctly, so think carefully if you really need this extra
-- flexibility.
-- --
-- Even if you don't use a statusbar, you can still use 'dynamicLogString' to -- Even if you don't use a statusbar, you can still use 'dynamicLogString' to
-- show on-screen notifications in response to some events. For example, to show -- show on-screen notifications in response to some events. For example, to show
@@ -252,8 +251,6 @@ import XMonad.Hooks.ManageDocks
-- $todo -- $todo
-- --
-- * incorporate dynamicLogXinerama into the PP framework somehow -- * incorporate dynamicLogXinerama into the PP framework somehow
--
-- * add an xmobarEscape function
------------------------------------------------------------------------ ------------------------------------------------------------------------
@@ -304,7 +301,9 @@ dzen conf = dzenWithFlags flags conf
-- > myConfig = def { ... } -- > myConfig = def { ... }
-- --
-- The intent is that the above config file should provide a nice -- The intent is that the above config file should provide a nice
-- status bar with minimal effort. -- status bar with minimal effort. Note that you still need to configure
-- xmobar to use the @XMonadLog@ plugin instead of the default @StdinReader@,
-- see above.
-- --
-- If you wish to customize the status bar format at all, you'll have to -- If you wish to customize the status bar format at all, you'll have to
-- use the 'statusBarProp' function instead. -- use the 'statusBarProp' function instead.
@@ -326,8 +325,8 @@ xmobar :: LayoutClass l Window
xmobar conf = statusBar "xmobar" xmobarPP toggleStrutsKey conf xmobar conf = statusBar "xmobar" xmobarPP toggleStrutsKey conf
-- | Modifies the given base configuration to launch the given status bar, write -- | Modifies the given base configuration to launch the given status bar, write
-- status information to a property for the bar to read, and allocate space on -- status information to the @_XMONAD_LOG@ property for the bar to read, and
-- the screen edges for the bar. -- allocate space on the screen edges for the bar.
statusBarProp :: LayoutClass l Window statusBarProp :: LayoutClass l Window
=> String -- ^ The command line to launch the status bar => String -- ^ The command line to launch the status bar
-> PP -- ^ The pretty printing options -> PP -- ^ The pretty printing options
@@ -338,8 +337,7 @@ statusBarProp :: LayoutClass l Window
statusBarProp = statusBarPropTo "_XMONAD_LOG" statusBarProp = statusBarPropTo "_XMONAD_LOG"
-- | Like 'statusBarProp', but one is able to specify the property to be written -- | Like 'statusBarProp', but one is able to specify the property to be written
-- to. This property is of type @UTF8_STRING@. The string must have been -- to.
-- processed by 'encodeString' ('dynamicLogString' does this).
statusBarPropTo :: LayoutClass l Window statusBarPropTo :: LayoutClass l Window
=> String -- ^ Property to write the string to => String -- ^ Property to write the string to
-> String -- ^ The command line to launch the status bar -> String -- ^ The command line to launch the status bar
@@ -639,8 +637,6 @@ xmobarRaw :: String -> String
xmobarRaw "" = "" xmobarRaw "" = ""
xmobarRaw s = concat ["<raw=", show $ length s, ":", s, "/>"] xmobarRaw s = concat ["<raw=", show $ length s, ":", s, "/>"]
-- ??? add an xmobarEscape function?
-- | Strip xmobar markup, specifically the <fc>, <icon> and <action> tags and -- | Strip xmobar markup, specifically the <fc>, <icon> and <action> tags and
-- the matching tags like </fc>. -- the matching tags like </fc>.
xmobarStrip :: String -> String xmobarStrip :: String -> String