XMobar - a status bar for the XMonad Window Manager ABOUT ===== Xmobar is a minimalistic, text based, status bar, designed for the XMonad Window Manager. It was inspired by the Ion3 status bar, and supports similar features. See xmobar.config-sample for a sample configuration. Try it with: xmobar xmobar.config-sample INSTALLATION ============ tar xvfz xmobar-0.5 runhaskell Setup.lhs configure --prefix=/usr/local runhaskell Setup.lhs build runhaskell Setup.lhs haddock (optional for building the code documentation) runhaskell Setup.lhs install (possibly to be run as root) Run with: xmobar /path/to/config & CONFIGURATION ============= Quick Start ----------- See xmobar.config-sample for an example. For the output template: - %command% will execute command and print the output. The output may contain markups to change the characters' color. - string will print "string" with #FF0000 color (red). Other configuration options: font: Name of the font to be used bgColor: Backgroud color fgColor: Default font color xPos: x position (origin in the upper left corner) of the XMobar window yPos: y position width: width of the XMobar window height: height align: text alignment refresh: Refresh rate in tenth of seconds commands: For setting the options of the programs to run (optional) sepChar: The character to be used for indicating commands in the output template (default '%') template: The output template The Output Template ------------------- The output template must contain at least one command. XMobar will parse the template and will search for the command to be executed in the "commands" configuration option. First an "alias" will be search (internal commands such as Weather or Network have default aliasing, see below). After that the command name will be tried. If a command is found, the arguments specified in the "commands" list will be used. If no command is found in the "commands" list, XMobar will try to execute a program with the name found in the template. If the execution is not successful an error will be reported. The "commands" Configuration Option ----------------------------------- The "commands" configuration option is a list of commands'information and arguments to be used by XMobar when parsing the output template. Each member of the list consists in a tuple formed by a template command (with arguments) and a number (the refresh rate in tenth of second). Available template commands are: Weather, Network, Memory, Swap, Cpu, Battery, and Exec. This last one is used to execute external programs. This is an example of a command in the "commands" list: (Memory ["-t","Mem: %"], 10) Internal Commands and Aliases ----------------------------- Each command in the "commands" configuration option list has an alias to be used in the template. Internal commands have default aliases: Weather StationID Args - aliases to the Station ID: so Weather "LIPB" [] can be used in template as %LIBP% - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "station", "stationState", "year", "month", "day", "hour", "wind", "visibility", "skyCondition", "tempC", "tempF", "dewPoint", "rh", "pressure" - Default template: ": C, rh % ()" Network Interface ARGS - aliases to the interface name: so Network "eth0" [] can be used as %eth0% - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "dev", "rx", "tx" - Default template: ": |" Memory Args - aliases to "memory" - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "total", "free", "buffer", "cache", "rest", "used", "usedratio" - Default template: "Mem: % (M)" Swap Args - aliases to "swap" - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "total", "used", "free", "usedratio" - Default template: "Swap: %" Cpu Args - aliases to "cpu" - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "total", "user", "nice", "system", "idle" - Default template: "Cpu: " Battery Args - aliases to "battery" - Args: the argument list (see below) - Variables that can be used with the "-t"/"--template" argument: "left" - Default template: "Batt: " Internal Commands Arguments --------------------------- These are the arguments that can be used for internal commands in the "commands" configuration option: -H number --High=number The high threshold -L number --Low=number The low threshold --high=color number Color for the high threshold: es "#FF0000" --normal=color number Color for the normal threshold: es "#00FF00" --low=color number Color for the low threshold: es "#0000FF" -t output template --template=output template Output template of the command. Commands must be set as a list. Es: (Weather "EGPF" ["-t",": C"], 36000) Executing External Commands --------------------------- In order to execute an external command you can either write the command name in the template, in this case it will be executed without arguments, or you can configure it in the "commands" configuration option list with the Exec template command: Exec ProgarmName Args Alias - ProgramName: the name of the program - Args: the arguments to be passed to the program at execution time - Alias: a name to be used in the template. If the alias is en empty string the program name can be used in the template. Es: (Exec "uname" ["-s","-r"] "", 36000) can be used in the output template as %uname% (Exec "date" ["+\"%a %b %_d %H:%M\""] "mydate", 600) can be used in the output template as %mydate% AUTHOR ====== Andrea Rossato CREDITS ======= XMobar incorporates patches from: Krzysztof Kosciuszkiewicz LINKS ===== The XMobar home page: http://gorgias.mine.nu/repos/xmobar/ XMobars darcs repository: http://gorgias.mine.nu/repos/xmobar/ The XMonad Window Manager http://xmonad.org