1[[http://hackage.haskell.org/package/xmobar][https://img.shields.io/hackage/v/xmobar.svg]]
2
3* About
4
5Xmobar is a minimalistic status bar. It was originally designed and
6implemented by Andrea Rossato to work with [[http://xmonad.org][xmonad]], but it is actually
7usable with any window manager.
8
9Xmobar was inspired by the [[http://tuomov.iki.fi/software/][Ion3]] status bar, and supports similar
10features, like dynamic color management, icons, output templates, and
11extensibility through plugins.
12
13These are some xmobar [[file:doc/screenshots][screenshots]] using the author's configuration:
14
15[[file:doc/screenshots/xmobar-top.png]]
16
17[[file:doc/screenshots/xmobar-bottom.png]]
18
19[[file:doc/screenshots/xmobar-exwm.png]]
20
21This is the [[https://xmobar.org/changelog.html][changelog]] for recent releases.
22
23* Installation
24** From your Systems Package Manager
25
26Xmobar is probably available from your distributions package manager!
27Most distributions compile xmobar with the =all_extensions= flag, so you
28don't have to.
29
30*** Arch Linux
31
32#+begin_src shell
33 pacman -S xmobar
34#+end_src
35
36*** Debian/Ubuntu based
37
38#+begin_src shell
39 apt install xmobar
40#+end_src
41
42*** OpenSUSE
43
44#+begin_src shell
45 zypper install xmobar
46#+end_src
47
48*** Void Linux
49
50#+begin_src shell
51 xbps-install xmobar
52#+end_src
53
54*** Gentoo
55#+begin_src shell
56 emerge --ask xmobar
57#+end_src
58
59** Using cabal-install
60
61Xmobar is available from [[http://hackage.haskell.org/package/xmobar/][Hackage]], and you can install it using
62=cabal-install=:
63
64#+begin_src shell
65 cabal install xmobar
66#+end_src
67
68Starting with version 0.35.1, xmobar now requires at least GHC version
698.4.x. to build. See [[https://github.com/jaor/xmobar/issues/461][this issue]] for more information.
70
71See [[file:doc/compiling.org][compiling]] for a list of optional compilation flags that will enable
72some optional plugins. For instance, to install xmobar with all the
73bells and whistles (this is probably what you want), use:
74
75#+begin_src shell
76 cabal install xmobar --flags="all_extensions"
77#+end_src
78
79** From source
80
81See [[file:doc/compiling.org][compiling]].
82
83* Running xmobar
84
85You can run xmobar with:
86
87#+begin_src shell
88 xmobar /path/to/config &
89#+end_src
90
91or
92
93#+begin_src shell
94 xmobar &
95#+end_src
96
97if you have the default configuration file saved as
98=$XDG\_CONFIG\_HOME/xmobar/xmobarrc= (defaulting to
99=~/.config/xmobar/xmobarrc=), or =~/.xmobarrc=.
100
101** Signal Handling
102
103Since 0.14 xmobar reacts to SIGUSR1 and SIGUSR2:
104
105- After receiving SIGUSR1 xmobar moves its position to the next screen.
106
107- After receiving SIGUSR2 xmobar repositions itself on the current
108 screen.
109
110* Configuration and Further Links
111
112- If you want to jump straight into configuring xmobar, head over to the
113 [[./doc/quick-start.org][quick-start]] guide.
114
115- If you want to get a detailed overview of all available plugins and
116 monitors, visit the [[./doc/plugins.org][plugins]] file.
117
118- If you want to know how to contribute to the xmobar project, check out
119 [[contributing.org][contributing]].
120
121- If you want to write your own plugins, see [[./doc/write-your-own-plugin.org][write-your-own-plugin]].
122
123* Authors and credits
124
125Andrea Rossato originally designed and implemented xmobar up to version
1260.11.1. Since then, it is maintained and developed by [[https://jao.io][jao]], with the help
127of the greater xmobar and Haskell communities.
128
129In particular, xmobar incorporates patches by Mohammed Alshiekh, Alex
130Ameen, Axel Angel, Dhananjay Balan, Claudio Bley, Dragos Boca, Ben
131Boeckel, Ivan Brennan, Duncan Burke, Roman Cheplyaka, Patrick Chilton,
132Antoine Eiche, Nathaniel Wesley Filardo, John Goerzen, Reto Hablützel,
133Juraj Hercek, Tomáš Janoušek, Ada Joule, Spencer Janssen, Roman Joost,
134Jochen Keil, Sam Kirby, Lennart Kolmodin, Krzysztof Kosciuszkiewicz,
135Dmitry Kurochkin, Todd Lunter, Vanessa McHale, Robert J. Macomber,
136Dmitry Malikov, David McLean, Joan MIlev, Marcin Mikołajczyk, Dino
137Morelli, Tony Morris, Eric Mrak, Thiago Negri, Edward O'Callaghan,
138Svein Ove, Martin Perner, Jens Petersen, Alexander Polakov, Sibi
139Prabakaran, Pavan Rikhi, Petr Rockai, Andrew Emmanuel Rosa,
140Sackville-West, Amir Saeid, Markus Scherer, Daniel Schüssler, Olivier
141Schneider, Alexander Shabalin, Valentin Shirokov, Peter Simons,
142Alexander Solovyov, Will Song, John Soros, Felix Springer, Travis
143Staton, Artem Tarasov, Samuli Thomasson, Edward Tjörnhammar, Sergei
144Trofimovich, Thomas Tuegel, John Tyree, Jan Vornberger, Anton
145Vorontsov, Daniel Wagner, Zev Weiss, Phil Xiaojun Hu, Nikolay Yakimov,
146aEdward Z. Yang, Leo Zhang, and Norbert Zeh.
147
148** Thanks
149
150*Andrea Rossato*:
151
152Thanks to Robert Manea and Spencer Janssen for their help in
153understanding how X works. They gave me suggestions on how to solve many
154problems with xmobar.
155
156Thanks to Claus Reinke for make me understand existential types (or at
157least for letting me think I grasp existential types...;-).
158
159*jao*:
160
161Thanks to Andrea for creating xmobar in the first place, and for giving
162me the chance to contribute.
163
164* Related
165
166- To understand the internal mysteries of xmobar you may try reading
167 [[https://wiki.haskell.org/X_window_programming_in_Haskell][this tutorial]] on X Window Programming in Haskell.
168
169* License
170
171This software is released under a BSD-style license. See [[https://github.com/jaor/xmobar/raw/master/license][license]] for
172more details.
173
174Copyright © 2010-2020 Jose Antonio Ortega Ruiz
175
176Copyright © 2007-2010 Andrea Rossato
177
