Copyright	(c) 2011 2012 2013 2014 2015 2017 2018 Jose Antonio Ortega Ruiz (c) 2007 Andrea Rossato
License	BSD-style (see LICENSE)
Maintainer	Jose A. Ortega Ruiz <jao@gnu.org>
Stability	unstable
Portability	unportable
Safe Haskell	None
Language	Haskell98

Xmobar

Contents

Configuration

Description

Public interface of the xmobar library

Synopsis

xmobar :: Config -> IO ()
xmobarMain :: IO ()
defaultConfig :: Config
configFromArgs :: Config -> IO Config
data Runnable = (Exec r, Read r, Show r) => Run r
class Show e => Exec e where
data Command
- = Com Program Args Alias Rate
- | ComX Program Args String Alias Rate
data Config = Config {
- font :: String
- additionalFonts :: [String]
- wmClass :: String
- wmName :: String
- bgColor :: String
- fgColor :: String
- position :: XPosition
- textOffset :: Int
- textOffsets :: [Int]
- iconOffset :: Int
- border :: Border
- borderColor :: String
- borderWidth :: Int
- alpha :: Int
- hideOnStart :: Bool
- allDesktops :: Bool
- overrideRedirect :: Bool
- pickBroadest :: Bool
- lowerOnStart :: Bool
- persistent :: Bool
- iconRoot :: FilePath
- commands :: [Runnable]
- sepChar :: String
- alignSep :: String
- template :: String
- verbose :: Bool
}
data XPosition
- = Top
- | TopW Align Int
- | TopSize Align Int Int
- | TopP Int Int
- | Bottom
- | BottomP Int Int
- | BottomW Align Int
- | BottomSize Align Int Int
- | Static {
  - xpos, ypos, width, height :: Int
  }
- | OnScreen Int XPosition
data Align
- = L
- | R
- | C
data Border
- = NoBorder
- | TopB
- | BottomB
- | FullB
- | TopBM Int
- | BottomBM Int
- | FullBM Int
readConfig :: Config -> FilePath -> IO (Either ParseError (Config, [String]))
parseConfig :: Config -> String -> Either ParseError (Config, [String])
data BufferedPipeReader = BufferedPipeReader String [(Int, Bool, String)]
data CommandReader = CommandReader String String
data Date = Date String String Int
data EWMH
- = EWMH
- | EWMHFMT Component
newtype Kbd = Kbd [(String, String)]
data Locks = Locks
module Xmobar.Plugins.Mail
module Xmobar.Plugins.MBox
data Monitors
- = Network Interface Args Rate
- | DynNetwork Args Rate
- | BatteryP Args Args Rate
- | BatteryN Args Args Rate Alias
- | Battery Args Rate
- | DiskU DiskSpec Args Rate
- | DiskIO DiskSpec Args Rate
- | Thermal Zone Args Rate
- | ThermalZone ZoneNo Args Rate
- | Memory Args Rate
- | Swap Args Rate
- | Cpu Args Rate
- | MultiCpu Args Rate
- | Brightness Args Rate
- | CpuFreq Args Rate
- | CoreTemp Args Rate
- | TopProc Args Rate
- | TopMem Args Rate
- | Uptime Args Rate
- | CatInt Int FilePath Args Rate
- | Weather Station Args Rate
- | Wireless Interface Args Rate
- | Mpris1 String Args Rate
- | Mpris2 String Args Rate
type Args = [String]
type Program = String
type Alias = String
type Station = String
type Zone = String
type ZoneNo = Int
type Interface = String
type Rate = Int
type DiskSpec = [(String, String)]
data PipeReader = PipeReader String String
data StdinReader
- = StdinReader
- | UnsafeStdinReader
data XMonadLog
- = XMonadLog
- | UnsafeXMonadLog
- | XPropertyLog String
- | UnsafeXPropertyLog String
- | NamedXPropertyLog String String
- | UnsafeNamedXPropertyLog String String

Documentation

xmobar :: Config -> IO () #

xmobarMain :: IO () #

defaultConfig :: Config #

The default configuration values

configFromArgs :: Config -> IO Config #

data Runnable #

Constructors

(Exec r, Read r, Show r) => Run r

Instances

Read Runnable #
Instance details Defined in Xmobar.Run.Runnable Methods readsPrec :: Int -> ReadS Runnable # readList :: ReadS [Runnable] # readPrec :: ReadPrec Runnable # readListPrec :: ReadPrec [Runnable] #
Show Runnable #
Instance details Defined in Xmobar.Run.Runnable Methods showsPrec :: Int -> Runnable -> ShowS # show :: Runnable -> String # showList :: [Runnable] -> ShowS #
Exec Runnable #
Instance details Defined in Xmobar.Run.Runnable Methods alias :: Runnable -> String # rate :: Runnable -> Int # run :: Runnable -> IO String # start :: Runnable -> (String -> IO ()) -> IO () # trigger :: Runnable -> (Maybe SignalType -> IO ()) -> IO () #

class Show e => Exec e where #

Methods

alias :: e -> String #

rate :: e -> Int #

run :: e -> IO String #

start :: e -> (String -> IO ()) -> IO () #

trigger :: e -> (Maybe SignalType -> IO ()) -> IO () #

Instances

Exec Runnable #
Instance details Defined in Xmobar.Run.Runnable Methods alias :: Runnable -> String # rate :: Runnable -> Int # run :: Runnable -> IO String # start :: Runnable -> (String -> IO ()) -> IO () # trigger :: Runnable -> (Maybe SignalType -> IO ()) -> IO () #
Exec Date #
Instance details Defined in Xmobar.Plugins.Date Methods alias :: Date -> String # rate :: Date -> Int # run :: Date -> IO String # start :: Date -> (String -> IO ()) -> IO () # trigger :: Date -> (Maybe SignalType -> IO ()) -> IO () #
Exec Monitors #
Instance details Defined in Xmobar.Plugins.Monitors Methods alias :: Monitors -> String # rate :: Monitors -> Int # run :: Monitors -> IO String # start :: Monitors -> (String -> IO ()) -> IO () # trigger :: Monitors -> (Maybe SignalType -> IO ()) -> IO () #
Exec Command #
Instance details Defined in Xmobar.Run.Command Methods alias :: Command -> String # rate :: Command -> Int # run :: Command -> IO String # start :: Command -> (String -> IO ()) -> IO () # trigger :: Command -> (Maybe SignalType -> IO ()) -> IO () #
Exec PipeReader #
Instance details Defined in Xmobar.Plugins.PipeReader Methods alias :: PipeReader -> String # rate :: PipeReader -> Int # run :: PipeReader -> IO String # start :: PipeReader -> (String -> IO ()) -> IO () # trigger :: PipeReader -> (Maybe SignalType -> IO ()) -> IO () #
Exec Mail #
Instance details Defined in Xmobar.Plugins.Mail Methods alias :: Mail -> String # rate :: Mail -> Int # run :: Mail -> IO String # start :: Mail -> (String -> IO ()) -> IO () # trigger :: Mail -> (Maybe SignalType -> IO ()) -> IO () #
Exec MBox #
Instance details Defined in Xmobar.Plugins.MBox Methods alias :: MBox -> String # rate :: MBox -> Int # run :: MBox -> IO String # start :: MBox -> (String -> IO ()) -> IO () # trigger :: MBox -> (Maybe SignalType -> IO ()) -> IO () #
Exec CommandReader #
Instance details Defined in Xmobar.Plugins.CommandReader Methods alias :: CommandReader -> String # rate :: CommandReader -> Int # run :: CommandReader -> IO String # start :: CommandReader -> (String -> IO ()) -> IO () # trigger :: CommandReader -> (Maybe SignalType -> IO ()) -> IO () #
Exec BufferedPipeReader #
Instance details Defined in Xmobar.Plugins.BufferedPipeReader Methods alias :: BufferedPipeReader -> String # rate :: BufferedPipeReader -> Int # run :: BufferedPipeReader -> IO String # start :: BufferedPipeReader -> (String -> IO ()) -> IO () # trigger :: BufferedPipeReader -> (Maybe SignalType -> IO ()) -> IO () #
Exec StdinReader #
Instance details Defined in Xmobar.Plugins.StdinReader Methods alias :: StdinReader -> String # rate :: StdinReader -> Int # run :: StdinReader -> IO String # start :: StdinReader -> (String -> IO ()) -> IO () # trigger :: StdinReader -> (Maybe SignalType -> IO ()) -> IO () #
Exec XMonadLog #
Instance details Defined in Xmobar.Plugins.XMonadLog Methods alias :: XMonadLog -> String # rate :: XMonadLog -> Int # run :: XMonadLog -> IO String # start :: XMonadLog -> (String -> IO ()) -> IO () # trigger :: XMonadLog -> (Maybe SignalType -> IO ()) -> IO () #
Exec Locks #
Instance details Defined in Xmobar.Plugins.Locks Methods alias :: Locks -> String # rate :: Locks -> Int # run :: Locks -> IO String # start :: Locks -> (String -> IO ()) -> IO () # trigger :: Locks -> (Maybe SignalType -> IO ()) -> IO () #
Exec Kbd #
Instance details Defined in Xmobar.Plugins.Kbd Methods alias :: Kbd -> String # rate :: Kbd -> Int # run :: Kbd -> IO String # start :: Kbd -> (String -> IO ()) -> IO () # trigger :: Kbd -> (Maybe SignalType -> IO ()) -> IO () #
Exec EWMH #
Instance details Defined in Xmobar.Plugins.EWMH Methods alias :: EWMH -> String # rate :: EWMH -> Int # run :: EWMH -> IO String # start :: EWMH -> (String -> IO ()) -> IO () # trigger :: EWMH -> (Maybe SignalType -> IO ()) -> IO () #

data Command #

Constructors

Com Program Args Alias Rate
ComX Program Args String Alias Rate

Instances

Eq Command #
Instance details Defined in Xmobar.Run.Command Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Read Command #
Instance details Defined in Xmobar.Run.Command Methods readsPrec :: Int -> ReadS Command # readList :: ReadS [Command] # readPrec :: ReadPrec Command # readListPrec :: ReadPrec [Command] #
Show Command #
Instance details Defined in Xmobar.Run.Command Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Exec Command #
Instance details Defined in Xmobar.Run.Command Methods alias :: Command -> String # rate :: Command -> Int # run :: Command -> IO String # start :: Command -> (String -> IO ()) -> IO () # trigger :: Command -> (Maybe SignalType -> IO ()) -> IO () #

Configuration

Configuration data type

data Config #

The configuration data type

Constructors

Config

Fields

font :: String
Font
additionalFonts :: [String]
List of alternative fonts
wmClass :: String
X11 WM_CLASS property value
wmName :: String
X11 WM_NAME property value
bgColor :: String
Backgroud color
fgColor :: String
Default font color
position :: XPosition
Top Bottom or Static
textOffset :: Int
Offset from top of window for text
textOffsets :: [Int]
List of offsets for additionalFonts
iconOffset :: Int
Offset from top of window for icons
border :: Border
NoBorder TopB BottomB or FullB
borderColor :: String
Border color
borderWidth :: Int
Border width
alpha :: Int
Transparency from 0 (transparent) to 255 (opaque)
hideOnStart :: Bool
Hide (Unmap) the window on initialization
allDesktops :: Bool
Tell the WM to map to all desktops
overrideRedirect :: Bool
Needed for dock behaviour in some non-tiling WMs
pickBroadest :: Bool
Use the broadest display instead of the first one by default
lowerOnStart :: Bool
lower to the bottom of the window stack on initialization
persistent :: Bool
Whether automatic hiding should be enabled or disabled
iconRoot :: FilePath
Root folder for icons
commands :: [Runnable]
For setting the command, the command arguments and refresh rate for the programs to run (optional)
sepChar :: String
The character to be used for indicating commands in the output template (default %)
alignSep :: String
Separators for left, center and right text alignment
template :: String
The output template
verbose :: Bool
Emit additional debug messages

Instances

Read Config #
Instance details Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS Config # readList :: ReadS [Config] # readPrec :: ReadPrec Config # readListPrec :: ReadPrec [Config] #

data XPosition #

Constructors

Top
TopW Align Int
TopSize Align Int Int
TopP Int Int
Bottom
BottomP Int Int
BottomW Align Int
BottomSize Align Int Int
Static
Fields xpos, ypos, width, height :: Int
OnScreen Int XPosition

Instances

Eq XPosition #
Instance details Defined in Xmobar.Config.Types Methods (==) :: XPosition -> XPosition -> Bool # (/=) :: XPosition -> XPosition -> Bool #
Read XPosition #
Instance details Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS XPosition # readList :: ReadS [XPosition] # readPrec :: ReadPrec XPosition # readListPrec :: ReadPrec [XPosition] #

data Align #

Constructors

L
R
C

Instances

Eq Align #
Instance details Defined in Xmobar.Config.Types Methods (==) :: Align -> Align -> Bool # (/=) :: Align -> Align -> Bool #
Read Align #
Instance details Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS Align # readList :: ReadS [Align] # readPrec :: ReadPrec Align # readListPrec :: ReadPrec [Align] #

data Border #

Constructors

NoBorder
TopB
BottomB
FullB
TopBM Int
BottomBM Int
FullBM Int

Instances

Eq Border #
Instance details Defined in Xmobar.Config.Types Methods (==) :: Border -> Border -> Bool # (/=) :: Border -> Border -> Bool #
Read Border #
Instance details Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS Border # readList :: ReadS [Border] # readPrec :: ReadPrec Border # readListPrec :: ReadPrec [Border] #

readConfig :: Config -> FilePath -> IO (Either ParseError (Config, [String])) #

Reads the configuration from a file or an error if it cannot be parsed.

parseConfig :: Config -> String -> Either ParseError (Config, [String]) #

Parse the config, logging a list of fields that were missing and replaced by the default definition.

data BufferedPipeReader #

Constructors

BufferedPipeReader String [(Int, Bool, String)]

Instances

Read BufferedPipeReader #
Instance details Defined in Xmobar.Plugins.BufferedPipeReader Methods readsPrec :: Int -> ReadS BufferedPipeReader # readList :: ReadS [BufferedPipeReader] # readPrec :: ReadPrec BufferedPipeReader # readListPrec :: ReadPrec [BufferedPipeReader] #
Show BufferedPipeReader #
Instance details Defined in Xmobar.Plugins.BufferedPipeReader Methods showsPrec :: Int -> BufferedPipeReader -> ShowS # show :: BufferedPipeReader -> String # showList :: [BufferedPipeReader] -> ShowS #
Exec BufferedPipeReader #
Instance details Defined in Xmobar.Plugins.BufferedPipeReader Methods alias :: BufferedPipeReader -> String # rate :: BufferedPipeReader -> Int # run :: BufferedPipeReader -> IO String # start :: BufferedPipeReader -> (String -> IO ()) -> IO () # trigger :: BufferedPipeReader -> (Maybe SignalType -> IO ()) -> IO () #

data CommandReader #

Constructors

CommandReader String String

Instances

Read CommandReader #
Instance details Defined in Xmobar.Plugins.CommandReader Methods readsPrec :: Int -> ReadS CommandReader # readList :: ReadS [CommandReader] # readPrec :: ReadPrec CommandReader # readListPrec :: ReadPrec [CommandReader] #
Show CommandReader #
Instance details Defined in Xmobar.Plugins.CommandReader Methods showsPrec :: Int -> CommandReader -> ShowS # show :: CommandReader -> String # showList :: [CommandReader] -> ShowS #
Exec CommandReader #
Instance details Defined in Xmobar.Plugins.CommandReader Methods alias :: CommandReader -> String # rate :: CommandReader -> Int # run :: CommandReader -> IO String # start :: CommandReader -> (String -> IO ()) -> IO () # trigger :: CommandReader -> (Maybe SignalType -> IO ()) -> IO () #

data Date #

Constructors

Date String String Int

Instances

Read Date #
Instance details Defined in Xmobar.Plugins.Date Methods readsPrec :: Int -> ReadS Date # readList :: ReadS [Date] # readPrec :: ReadPrec Date # readListPrec :: ReadPrec [Date] #
Show Date #
Instance details Defined in Xmobar.Plugins.Date Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
Exec Date #
Instance details Defined in Xmobar.Plugins.Date Methods alias :: Date -> String # rate :: Date -> Int # run :: Date -> IO String # start :: Date -> (String -> IO ()) -> IO () # trigger :: Date -> (Maybe SignalType -> IO ()) -> IO () #

data EWMH #

Constructors

EWMH
EWMHFMT Component

Instances

Read EWMH #
Instance details Defined in Xmobar.Plugins.EWMH Methods readsPrec :: Int -> ReadS EWMH # readList :: ReadS [EWMH] # readPrec :: ReadPrec EWMH # readListPrec :: ReadPrec [EWMH] #
Show EWMH #
Instance details Defined in Xmobar.Plugins.EWMH Methods showsPrec :: Int -> EWMH -> ShowS # show :: EWMH -> String # showList :: [EWMH] -> ShowS #
Exec EWMH #
Instance details Defined in Xmobar.Plugins.EWMH Methods alias :: EWMH -> String # rate :: EWMH -> Int # run :: EWMH -> IO String # start :: EWMH -> (String -> IO ()) -> IO () # trigger :: EWMH -> (Maybe SignalType -> IO ()) -> IO () #

newtype Kbd #

Constructors

Kbd [(String, String)]

Instances

Read Kbd #
Instance details Defined in Xmobar.Plugins.Kbd Methods readsPrec :: Int -> ReadS Kbd # readList :: ReadS [Kbd] # readPrec :: ReadPrec Kbd # readListPrec :: ReadPrec [Kbd] #
Show Kbd #
Instance details Defined in Xmobar.Plugins.Kbd Methods showsPrec :: Int -> Kbd -> ShowS # show :: Kbd -> String # showList :: [Kbd] -> ShowS #
Exec Kbd #
Instance details Defined in Xmobar.Plugins.Kbd Methods alias :: Kbd -> String # rate :: Kbd -> Int # run :: Kbd -> IO String # start :: Kbd -> (String -> IO ()) -> IO () # trigger :: Kbd -> (Maybe SignalType -> IO ()) -> IO () #

data Locks #

Constructors

Locks

Instances

Read Locks #
Instance details Defined in Xmobar.Plugins.Locks Methods readsPrec :: Int -> ReadS Locks # readList :: ReadS [Locks] # readPrec :: ReadPrec Locks # readListPrec :: ReadPrec [Locks] #
Show Locks #
Instance details Defined in Xmobar.Plugins.Locks Methods showsPrec :: Int -> Locks -> ShowS # show :: Locks -> String # showList :: [Locks] -> ShowS #
Exec Locks #
Instance details Defined in Xmobar.Plugins.Locks Methods alias :: Locks -> String # rate :: Locks -> Int # run :: Locks -> IO String # start :: Locks -> (String -> IO ()) -> IO () # trigger :: Locks -> (Maybe SignalType -> IO ()) -> IO () #

module Xmobar.Plugins.Mail

module Xmobar.Plugins.MBox

data Monitors #

Instances

Eq Monitors #
Instance details Defined in Xmobar.Plugins.Monitors Methods (==) :: Monitors -> Monitors -> Bool # (/=) :: Monitors -> Monitors -> Bool #
Read Monitors #
Instance details Defined in Xmobar.Plugins.Monitors Methods readsPrec :: Int -> ReadS Monitors # readList :: ReadS [Monitors] # readPrec :: ReadPrec Monitors # readListPrec :: ReadPrec [Monitors] #
Show Monitors #
Instance details Defined in Xmobar.Plugins.Monitors Methods showsPrec :: Int -> Monitors -> ShowS # show :: Monitors -> String # showList :: [Monitors] -> ShowS #
Exec Monitors #
Instance details Defined in Xmobar.Plugins.Monitors Methods alias :: Monitors -> String # rate :: Monitors -> Int # run :: Monitors -> IO String # start :: Monitors -> (String -> IO ()) -> IO () # trigger :: Monitors -> (Maybe SignalType -> IO ()) -> IO () #

type Args = [String] #

type Program = String #

type Alias = String #

type Station = String #

type Zone = String #

type ZoneNo = Int #

type Interface = String #

type Rate = Int #

type DiskSpec = [(String, String)] #

data PipeReader #

Constructors

PipeReader String String

Instances

Read PipeReader #
Instance details Defined in Xmobar.Plugins.PipeReader Methods readsPrec :: Int -> ReadS PipeReader # readList :: ReadS [PipeReader] # readPrec :: ReadPrec PipeReader # readListPrec :: ReadPrec [PipeReader] #
Show PipeReader #
Instance details Defined in Xmobar.Plugins.PipeReader Methods showsPrec :: Int -> PipeReader -> ShowS # show :: PipeReader -> String # showList :: [PipeReader] -> ShowS #
Exec PipeReader #
Instance details Defined in Xmobar.Plugins.PipeReader Methods alias :: PipeReader -> String # rate :: PipeReader -> Int # run :: PipeReader -> IO String # start :: PipeReader -> (String -> IO ()) -> IO () # trigger :: PipeReader -> (Maybe SignalType -> IO ()) -> IO () #

data StdinReader #

Constructors

StdinReader
UnsafeStdinReader

Instances

Read StdinReader #
Instance details Defined in Xmobar.Plugins.StdinReader Methods readsPrec :: Int -> ReadS StdinReader # readList :: ReadS [StdinReader] # readPrec :: ReadPrec StdinReader # readListPrec :: ReadPrec [StdinReader] #
Show StdinReader #
Instance details Defined in Xmobar.Plugins.StdinReader Methods showsPrec :: Int -> StdinReader -> ShowS # show :: StdinReader -> String # showList :: [StdinReader] -> ShowS #
Exec StdinReader #
Instance details Defined in Xmobar.Plugins.StdinReader Methods alias :: StdinReader -> String # rate :: StdinReader -> Int # run :: StdinReader -> IO String # start :: StdinReader -> (String -> IO ()) -> IO () # trigger :: StdinReader -> (Maybe SignalType -> IO ()) -> IO () #

data XMonadLog #

Constructors

XMonadLog
UnsafeXMonadLog
XPropertyLog String
UnsafeXPropertyLog String
NamedXPropertyLog String String
UnsafeNamedXPropertyLog String String

Instances

Read XMonadLog #
Instance details Defined in Xmobar.Plugins.XMonadLog Methods readsPrec :: Int -> ReadS XMonadLog # readList :: ReadS [XMonadLog] # readPrec :: ReadPrec XMonadLog # readListPrec :: ReadPrec [XMonadLog] #
Show XMonadLog #
Instance details Defined in Xmobar.Plugins.XMonadLog Methods showsPrec :: Int -> XMonadLog -> ShowS # show :: XMonadLog -> String # showList :: [XMonadLog] -> ShowS #
Exec XMonadLog #
Instance details Defined in Xmobar.Plugins.XMonadLog Methods alias :: XMonadLog -> String # rate :: XMonadLog -> Int # run :: XMonadLog -> IO String # start :: XMonadLog -> (String -> IO ()) -> IO () # trigger :: XMonadLog -> (Maybe SignalType -> IO ()) -> IO () #

Network Interface Args Rate
DynNetwork Args Rate
BatteryP Args Args Rate
BatteryN Args Args Rate Alias
Battery Args Rate
DiskU DiskSpec Args Rate
DiskIO DiskSpec Args Rate
Thermal Zone Args Rate
ThermalZone ZoneNo Args Rate
Memory Args Rate
Swap Args Rate
Cpu Args Rate
MultiCpu Args Rate
Brightness Args Rate
CpuFreq Args Rate
CoreTemp Args Rate
TopProc Args Rate
TopMem Args Rate
Uptime Args Rate
CatInt Int FilePath Args Rate
Weather Station Args Rate
Wireless Interface Args Rate
Mpris1 String Args Rate
Mpris2 String Args Rate