Skip to content

Latest commit

 

History

History
186 lines (141 loc) · 6.9 KB

readme.org

File metadata and controls

186 lines (141 loc) · 6.9 KB
Raw

xmobar, a minimalistic status bar

Xmobar is a minimalistic status bar. It was originally designed and implemented to work with xmonad, but it is actually usable with any window manager in X11 and also (via its text output mode) Wayland.

Xmobar was inspired by the Ion3 status bar, and supports similar features, like dynamic color management, icons, output templates, and extensibility through plugins. It is also able to write to standard output, in a variety of formats.

doc/screenshots/xmobar-top.png

doc/screenshots/xmobar-bottom.png

doc/screenshots/xmobar-exwm.png

Check the change log for our release history. We also have an IRC channel, #xmobar, at Libera.

Installation

From your system’s package manager

Xmobar is probably available from your distributions package manager! Most distributions compile xmobar with the all_extensions flag, so you don’t have to.

  • Arch Linux 
    pacman -S xmobar
  • Debian/Ubuntu based 
    apt install xmobar
  • OpenSUSE 
    zypper install xmobar
  • Void Linux 
    xbps-install xmobar
  • Gentoo 
    emerge --ask xmobar

Using cabal-install

Xmobar is available from Hackage, and you can install it using cabal-install:

cabal install xmobar

Starting with version 0.35.1, xmobar now requires at least GHC version 8.4.x. to build. See this issue for more information.

See here for a list of optional compilation flags that will enable some optional plugins. For instance, to install xmobar with all the bells and whistles (this is probably what you want), use:

cabal install xmobar --flags="all_extensions"

From source

See compiling.

Running xmobar

Running xmobar with a configuration file

You can run xmobar with:

xmobar /path/to/config &

or

xmobar &

if you have the default configuration file saved as $XDG_CONFIG_HOME/xmobar/xmobarrc (defaulting to ~/.config/xmobar/xmobarrc), or ~/.xmobarrc.

All the available command line switches and configuration parameters are described in the quick start guide and the plugins index.

Writing your own xmobar in Haskell

As shown above, one can use xmobar as a regular program, via its configuration file, without having to write any code. It also is possible to install xmobar as a library and use it to write your own xmobar using Haskell instead of using a configuration file. (This is very similar to how xmonad works.) That gives you the ability of using Haskell and its libraries to extend xmobar to your heart’s content. If you are a programmer, take a look here to learn more.

Running xmobar in text mode

By default, xmobar will run as an X11 application, in a docked window, but it is possible to redirect xmobar’s output to the standard output, optionally with color escape sequences. In this mode, xmobar can be run inside a terminal o console, or its output piped to other applications, and there is no need for an X11 display. See Running xmobar in text mode for details. Using this mode, you could pipe xmobar’s output to, say, swaybar, and use it in wayland.

Configuration and further documentation

  • If you want to jump straight into running xmobar, head over to the quick start guide.
  • If you want to get a detailed overview of all available plugins and monitors, visit the plugins index.
  • For more information on how to use xmobar as a Haskell library see the using Haskell docs.
  • If you want to know how to contribute to the xmobar project, check out contributing.

Authors and credits

Andrea Rossato originally designed and implemented xmobar up to version 0.11.1. Since then, it is maintained and developed by jao, with the help of the greater xmobar and Haskell communities.

In particular, xmobar incorporates patches by Mohammed Alshiekh, Alex Ameen, Axel Angel, Dhananjay Balan, Claudio Bley, Dragos Boca, Ben Boeckel, Ivan Brennan, Duncan Burke, Roman Cheplyaka, Patrick Chilton, Antoine Eiche, Nathaniel Wesley Filardo, Guy Gastineau, John Goerzen, Patrick Günther, Reto Hablützel, Juraj Hercek, Tomáš Janoušek, Ada Joule, Spencer Janssen, Roman Joost, Pavel Kalugin, Jochen Keil, Sam Kirby, Lennart Kolmodin, Krzysztof Kosciuszkiewicz, Dmitry Kurochkin, Todd Lunter, Vanessa McHale, Robert J. Macomber, Dmitry Malikov, David McLean, Joan MIlev, Marcin Mikołajczyk, Dino Morelli, Tony Morris, Eric Mrak, Thiago Negri, Edward O’Callaghan, Svein Ove, Martin Perner, Jens Petersen, Alexander Polakov, Sibi Prabakaran, Pavan Rikhi, Petr Rockai, Andrew Emmanuel Rosa, Sackville-West, Amir Saeid, Markus Scherer, Daniel Schüssler, Olivier Schneider, Alexander Shabalin, Valentin Shirokov, Peter Simons, Alexander Solovyov, Will Song, John Soo, John Soros, Felix Springer, Travis Staton, Artem Tarasov, Samuli Thomasson, Edward Tjörnhammar, Sergei Trofimovich, Thomas Tuegel, John Tyree, Jan Vornberger, Anton Vorontsov, Daniel Wagner, Zev Weiss, Phil Xiaojun Hu, Nikolay Yakimov, Edward Z. Yang, Leo Zhang, Norbert Zeh, and Michał Zielonka.

Andrea wants to thank Robert Manea and Spencer Janssen for their help in understanding how X works. They gave him suggestions on how to solve many problems with xmobar. He also thanks Claus Reinke for making him understand existential types (or at least for letting him think he grasps existential types…;-).

License

This software is released under a BSD-style license. See license for more details.

Copyright © 2010-2022 Jose Antonio Ortega Ruiz

Copyright © 2007-2010 Andrea Rossato