| Copyright | (c) 2011 2012 2013 2014 2015 2017 2018 2019 2022 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 | Haskell2010 |
Xmobar
Contents
Description
Public interface of the xmobar library
Synopsis
- xmobar :: Config -> IO ()
- xmobarMain :: IO ()
- defaultConfig :: Config
- configFromArgs :: Config -> IO Config
- tenthSeconds :: Int -> IO ()
- data Runnable = forall r.(Exec r, Read r, Show r) => Run r
- class Show e => Exec e where
- data Command
- data SignalType
- data Config = Config {
- font :: String
- additionalFonts :: [String]
- wmClass :: String
- wmName :: String
- bgColor :: String
- fgColor :: String
- position :: XPosition
- textOutput :: Bool
- textOutputFormat :: TextOutputFormat
- 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
- signal :: SignalChan
- dpi :: Double
- data XPosition
- data Align
- data Border
- data TextOutputFormat
- type Segment = (Widget, TextRenderInfo, FontIndex, Maybe [Action])
- type FontIndex = Int
- data Box = Box {}
- data BoxBorder
- data BoxOffset = BoxOffset Align Int32
- data BoxMargins = BoxMargins Int32 Int32 Int32 Int32
- data TextRenderInfo = TextRenderInfo {
- tColorsString :: String
- tBgTopOffset :: Int32
- tBgBottomOffset :: Int32
- tBoxes :: [Box]
- data Widget
- newtype SignalChan = SignalChan {
- unSignalChan :: Maybe (TMVar SignalType)
- data Action = Spawn [Button] String
- type Button = Word32
- readConfig :: Config -> FilePath -> IO (Either ParseError (Config, [String]))
- parseConfig :: Config -> String -> Either ParseError (Config, [String])
- indexedFont :: Config -> FontIndex -> String
- indexedOffset :: Config -> FontIndex -> Int
- colorComponents :: Config -> String -> (String, String)
- data BufferedPipeReader = BufferedPipeReader String [(Int, Bool, String)]
- data CommandReader = CommandReader String String
- data Date = Date String String Int
- date :: IORef TimeZone -> String -> IO String
- data DateZone = DateZone String String String String Int
- data EWMH
- data HandleReader = HandleReader Handle String
- data QueueReader a = QueueReader {}
- newtype Kbd = Kbd [(String, String)]
- data Locks = Locks
- data Mail = Mail [(String, FilePath)] String
- data MailX = MailX [(String, FilePath, String)] [String] String
- data MBox = MBox [(String, FilePath, String)] [String] String
- data MailItem = MailItem {}
- data NotmuchMail = NotmuchMail {}
- 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
- | Load 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
- | MultiCoreTemp Args Rate
- | K10Temp Slot Args Rate
- | TopProc Args Rate
- | TopMem Args Rate
- | Uptime Args Rate
- | CatInt Int FilePath Args Rate
- | Weather Station Args Rate
- | WeatherX Station SkyConditions Args Rate
- | Wireless Interface Args Rate
- | MPD Args Rate
- | MPDX Args Rate Alias
- | AutoMPD Args
- | Volume String String Args Rate
- | Alsa String String Args
- | Mpris1 String Args Rate
- | Mpris2 String Args Rate
- type Args = [String]
- type Program = String
- type Alias = String
- type Station = String
- type SkyConditions = [(String, String)]
- type Zone = String
- type ZoneNo = Int
- type Interface = String
- type Rate = Int
- type DiskSpec = [(String, String)]
- type Slot = String
- data PipeReader = PipeReader String String
- data MarqueePipeReader = MarqueePipeReader String (Length, Rate, Separator) String
- data StdinReader
- data XMonadLog
Documentation
xmobarMain :: IO () Source #
defaultConfig :: Config Source #
The default configuration values
tenthSeconds :: Int -> IO () Source #
Sleep for a given amount of tenths of a second.
(Work around the Int max bound: since threadDelay takes an Int, it is not possible to set a thread delay grater than about 45 minutes. With a little recursion we solve the problem.)
class Show e => Exec e where Source #
Minimal complete definition
Nothing
Methods
run :: e -> IO String Source #
start :: e -> (String -> IO ()) -> IO () Source #
trigger :: e -> (Maybe SignalType -> IO ()) -> IO () Source #
Instances
| Exec Runnable Source # | |
| Exec StdinReader Source # | |
Defined in Xmobar.Plugins.StdinReader | |
| Exec PipeReader Source # | |
Defined in Xmobar.Plugins.PipeReader | |
| Exec NotmuchMail Source # | How to execute this plugin. |
Defined in Xmobar.Plugins.NotmuchMail | |
| Exec MarqueePipeReader Source # | |
Defined in Xmobar.Plugins.MarqueePipeReader | |
| Exec HandleReader Source # | Asynchronously read from the |
Defined in Xmobar.Plugins.HandleReader | |
| Exec DateZone Source # | |
| Exec Date Source # | |
| Exec CommandReader Source # | |
Defined in Xmobar.Plugins.CommandReader | |
| Exec Command Source # | |
| Exec BufferedPipeReader Source # | |
Defined in Xmobar.Plugins.BufferedPipeReader | |
| Exec Monitors Source # | |
| Exec MailX Source # | |
| Exec Mail Source # | |
| Exec MBox Source # | |
| Exec XMonadLog Source # | |
| Exec Locks Source # | |
| Exec Kbd Source # | |
| Exec EWMH Source # | |
| Exec (QueueReader a) Source # | Async queue/channel reading. |
Defined in Xmobar.Plugins.QueueReader | |
data SignalType Source #
Constructors
| Wakeup | |
| Reposition | |
| ChangeScreen | |
| Hide Int | |
| Reveal Int | |
| Toggle Int | |
| SetAlpha Int | |
| TogglePersistent | |
| Action Button Position |
Instances
| Read SignalType Source # | |
Defined in Xmobar.System.Signal Methods readsPrec :: Int -> ReadS SignalType # readList :: ReadS [SignalType] # readPrec :: ReadPrec SignalType # readListPrec :: ReadPrec [SignalType] # | |
| Show SignalType Source # | |
Defined in Xmobar.System.Signal Methods showsPrec :: Int -> SignalType -> ShowS # show :: SignalType -> String # showList :: [SignalType] -> ShowS # | |
| IsVariant SignalType Source # | |
Defined in Xmobar.System.Signal Methods toVariant :: SignalType -> Variant Source # fromVariant :: Variant -> Maybe SignalType Source # | |
The configuration data type
Constructors
| Config | |
Fields
| |
The position datatype
Constructors
| Top | Top of the screen, full width, auto height |
| TopH | Top of the screen, full width with specific height |
Fields
| |
| TopHM | Top of the screen, full width with specific height and margins |
| TopW | Top of the screen with specific width (as screen percentage) and alignment |
| TopSize | Top of the screen with specific width (as screen percentage), height and alignment |
| TopP | Top of the screen with specific left/right margins |
| Bottom | Bottom of the screen, full width, auto height |
| BottomH | Bottom of the screen, full width, with specific height |
Fields
| |
| BottomHM | Bottom of the screen with specific height and margins |
| BottomP | Bottom of the screen with specific left/right margins |
| BottomW | Bottom of the screen with specific width (as screen percentage) and alignment and alignment |
| BottomSize | Bottom of the screen with specific width (as screen percentage), height and alignment |
| Static | Static position and specific size |
| OnScreen | Along with the position characteristics specify the screen to display the bar |
data TextOutputFormat Source #
Instances
| Eq TextOutputFormat Source # | |
Defined in Xmobar.Config.Types Methods (==) :: TextOutputFormat -> TextOutputFormat -> Bool # (/=) :: TextOutputFormat -> TextOutputFormat -> Bool # | |
| Read TextOutputFormat Source # | |
Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS TextOutputFormat # readList :: ReadS [TextOutputFormat] # | |
| Show TextOutputFormat Source # | |
Defined in Xmobar.Config.Types Methods showsPrec :: Int -> TextOutputFormat -> ShowS # show :: TextOutputFormat -> String # showList :: [TextOutputFormat] -> ShowS # | |
Constructors
| Box | |
data BoxMargins Source #
Constructors
| BoxMargins Int32 Int32 Int32 Int32 |
Instances
| Eq BoxMargins Source # | |
Defined in Xmobar.Config.Types | |
| Show BoxMargins Source # | |
Defined in Xmobar.Config.Types Methods showsPrec :: Int -> BoxMargins -> ShowS # show :: BoxMargins -> String # showList :: [BoxMargins] -> ShowS # | |
data TextRenderInfo Source #
Constructors
| TextRenderInfo | |
Fields
| |
Instances
| Show TextRenderInfo Source # | |
Defined in Xmobar.Config.Types Methods showsPrec :: Int -> TextRenderInfo -> ShowS # show :: TextRenderInfo -> String # showList :: [TextRenderInfo] -> ShowS # | |
newtype SignalChan Source #
Constructors
| SignalChan | |
Fields
| |
Instances
| Read SignalChan Source # | |
Defined in Xmobar.Config.Types Methods readsPrec :: Int -> ReadS SignalChan # readList :: ReadS [SignalChan] # readPrec :: ReadPrec SignalChan # readListPrec :: ReadPrec [SignalChan] # | |
| Show SignalChan Source # | |
Defined in Xmobar.Config.Types Methods showsPrec :: Int -> SignalChan -> ShowS # show :: SignalChan -> String # showList :: [SignalChan] -> ShowS # | |
readConfig :: Config -> FilePath -> IO (Either ParseError (Config, [String])) Source #
Reads the configuration from a file or an error if it cannot be parsed.
parseConfig :: Config -> String -> Either ParseError (Config, [String]) Source #
Parse the config, logging a list of fields that were missing and replaced by the default definition.
indexedFont :: Config -> FontIndex -> String Source #
Extracts from a configuration the additional font at the corresponding index. Returns the default font if not present.
indexedOffset :: Config -> FontIndex -> Int Source #
Extracts from a configuration the offset at the corresponding index. Returns the default offset if not present.
colorComponents :: Config -> String -> (String, String) Source #
Splits a colors string into its two components
data BufferedPipeReader Source #
Constructors
| BufferedPipeReader String [(Int, Bool, String)] |
Instances
| Read BufferedPipeReader Source # | |
Defined in Xmobar.Plugins.BufferedPipeReader Methods readsPrec :: Int -> ReadS BufferedPipeReader # readList :: ReadS [BufferedPipeReader] # | |
| Show BufferedPipeReader Source # | |
Defined in Xmobar.Plugins.BufferedPipeReader Methods showsPrec :: Int -> BufferedPipeReader -> ShowS # show :: BufferedPipeReader -> String # showList :: [BufferedPipeReader] -> ShowS # | |
| Exec BufferedPipeReader Source # | |
Defined in Xmobar.Plugins.BufferedPipeReader | |
data CommandReader Source #
Constructors
| CommandReader String String |
Instances
| Read CommandReader Source # | |
Defined in Xmobar.Plugins.CommandReader Methods readsPrec :: Int -> ReadS CommandReader # readList :: ReadS [CommandReader] # | |
| Show CommandReader Source # | |
Defined in Xmobar.Plugins.CommandReader Methods showsPrec :: Int -> CommandReader -> ShowS # show :: CommandReader -> String # showList :: [CommandReader] -> ShowS # | |
| Exec CommandReader Source # | |
Defined in Xmobar.Plugins.CommandReader | |
data HandleReader Source #
A HandleReader displays any text received from a Handle.
This is only useful if you are running xmobar from other Haskell code.
You can create a pair of (read, write) Handles using
createPipe. Pass the read Handle to HandleReader
and write your desired output to the write Handle.
(readHandle, writeHandle) <-createPipexmobarProcess <-forkProcess$xmobarmyConfig { commands =Run(HandleReaderreadHandle "handle") :commandsmyConfig }hPutStrwriteHandle "Hello World"
Constructors
| HandleReader | |
Instances
| Read HandleReader Source # | WARNING: This Read instance will throw an exception if used! It is
only implemented because it is required to use HandleReader with
|
Defined in Xmobar.Plugins.HandleReader Methods readsPrec :: Int -> ReadS HandleReader # readList :: ReadS [HandleReader] # | |
| Show HandleReader Source # | |
Defined in Xmobar.Plugins.HandleReader Methods showsPrec :: Int -> HandleReader -> ShowS # show :: HandleReader -> String # showList :: [HandleReader] -> ShowS # | |
| Exec HandleReader Source # | Asynchronously read from the |
Defined in Xmobar.Plugins.HandleReader | |
data QueueReader a Source #
A QueueReader displays data from an 'TQueue a' where
the data items a are rendered by a user supplied function.
Like the HandleReader plugin this is only useful if you are
running xmobar from other Haskell code. You should create a
new TQueue a and pass it to this plugin.
main :: IO
main = do
q <- STM.newQueueIO @String
bar <- forkIO $ xmobar conf
{ commands = Run (QueueReader q id Queue) : commands conf }
STM.atomically $ STM.writeTQueue q "Some Message"
Instances
| Read (QueueReader a) Source # | WARNING: This read instance will throw an exception if used! It is
only implemented, because it is required by |
Defined in Xmobar.Plugins.QueueReader Methods readsPrec :: Int -> ReadS (QueueReader a) # readList :: ReadS [QueueReader a] # readPrec :: ReadPrec (QueueReader a) # readListPrec :: ReadPrec [QueueReader a] # | |
| Show (QueueReader a) Source # | This cannot be read back. |
Defined in Xmobar.Plugins.QueueReader Methods showsPrec :: Int -> QueueReader a -> ShowS # show :: QueueReader a -> String # showList :: [QueueReader a] -> ShowS # | |
| Exec (QueueReader a) Source # | Async queue/channel reading. |
Defined in Xmobar.Plugins.QueueReader | |
A list of mail box names and paths to maildirs.
A list of mail box names, paths to maildirs and display colors.
A list of display names, paths to mbox files and display colours, followed by a list of options.
Types
A MailItem is a name, an address, and a query to give to notmuch.
Constructors
| MailItem | |
data NotmuchMail Source #
A full mail configuration.
Constructors
| NotmuchMail | |
Instances
| Read NotmuchMail Source # | |
Defined in Xmobar.Plugins.NotmuchMail Methods readsPrec :: Int -> ReadS NotmuchMail # readList :: ReadS [NotmuchMail] # readPrec :: ReadPrec NotmuchMail # readListPrec :: ReadPrec [NotmuchMail] # | |
| Show NotmuchMail Source # | |
Defined in Xmobar.Plugins.NotmuchMail Methods showsPrec :: Int -> NotmuchMail -> ShowS # show :: NotmuchMail -> String # showList :: [NotmuchMail] -> ShowS # | |
| Exec NotmuchMail Source # | How to execute this plugin. |
Defined in Xmobar.Plugins.NotmuchMail | |
Constructors
type SkyConditions = [(String, String)] Source #
data PipeReader Source #
Constructors
| PipeReader String String |
Instances
| Read PipeReader Source # | |
Defined in Xmobar.Plugins.PipeReader Methods readsPrec :: Int -> ReadS PipeReader # readList :: ReadS [PipeReader] # readPrec :: ReadPrec PipeReader # readListPrec :: ReadPrec [PipeReader] # | |
| Show PipeReader Source # | |
Defined in Xmobar.Plugins.PipeReader Methods showsPrec :: Int -> PipeReader -> ShowS # show :: PipeReader -> String # showList :: [PipeReader] -> ShowS # | |
| Exec PipeReader Source # | |
Defined in Xmobar.Plugins.PipeReader | |
data MarqueePipeReader Source #
Constructors
| MarqueePipeReader String (Length, Rate, Separator) String |
Instances
| Read MarqueePipeReader Source # | |
Defined in Xmobar.Plugins.MarqueePipeReader Methods readsPrec :: Int -> ReadS MarqueePipeReader # readList :: ReadS [MarqueePipeReader] # | |
| Show MarqueePipeReader Source # | |
Defined in Xmobar.Plugins.MarqueePipeReader Methods showsPrec :: Int -> MarqueePipeReader -> ShowS # show :: MarqueePipeReader -> String # showList :: [MarqueePipeReader] -> ShowS # | |
| Exec MarqueePipeReader Source # | |
Defined in Xmobar.Plugins.MarqueePipeReader | |
data StdinReader Source #
Constructors
| StdinReader | |
| UnsafeStdinReader |
Instances
| Read StdinReader Source # | |
Defined in Xmobar.Plugins.StdinReader Methods readsPrec :: Int -> ReadS StdinReader # readList :: ReadS [StdinReader] # readPrec :: ReadPrec StdinReader # readListPrec :: ReadPrec [StdinReader] # | |
| Show StdinReader Source # | |
Defined in Xmobar.Plugins.StdinReader Methods showsPrec :: Int -> StdinReader -> ShowS # show :: StdinReader -> String # showList :: [StdinReader] -> ShowS # | |
| Exec StdinReader Source # | |
Defined in Xmobar.Plugins.StdinReader | |