diff options
Diffstat (limited to 'readme.org')
| -rw-r--r-- | readme.org | 110 |
1 files changed, 66 insertions, 44 deletions
@@ -26,9 +26,27 @@ output, in a variety of formats. [[file:doc/screenshots/xmobar-exwm.png]] -Check [[./changelog.md][the change log]] for our release history. We also have an IRC +Check [[https://codeberg.org/xmobar/xmobar/src/branch/master/changelog.md][the change log]] for our release history. We also have an IRC channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. +* Breaking news + + - Starting with version 0.47.1, we are excluding MPD from the extensions + included with ~all_extensions~ when GHC version is 9.4 or greater, because + that seems to break cabal compilation. However, it's been reported that + in some installations compilation with ~libmpd~ works fine: just add + explicitly the ~with_mpd~ flag to include MPD and check for yourself. + Compilation with stack has also been reported to work. Please see the + comments in issue #679 for details. + - Starting with version 0.45, we use cairo/pango as our drawing engine + (instead of plain X11/Xft). From a user's point of view, that change + should be mostly transparent, except for the facts that it's allowed + fixing quite a few bugs and that your /font names/ in your configuration, if + you used ~xft~ ones, might need to be adapted to Pango's syntax: please see + [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/quick-start.org#fonts][this section of the documentation]] for all the details. If you're + compiling your own xmobar, there's a new dependency on libpango (see + [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/compiling.org#c-libraries][C library dependencies]]). + * Installation :PROPERTIES: :CUSTOM_ID: installation @@ -64,10 +82,15 @@ channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. emerge --ask xmobar #+end_src + - FreeBSD + #+begin_src shell + pkg install hs-xmobar + #+end_src + ** Using cabal or stack Xmobar is available from [[http://hackage.haskell.org/package/xmobar/][Hackage]], and you can compile and install it using - =cabal-install=, making sure the [[doc/compiling.org#c-libraries][required C libraries]] are in place. For a + =cabal-install=, making sure the [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/compiling.org#c-libraries][required C libraries]] are in place. For a full build with all available extensions: #+begin_src shell @@ -82,10 +105,10 @@ channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. Starting with version 0.35.1, xmobar requires at least GHC version 8.4.x. to build. See [[https://codeberg.org/xmobar/xmobar/issues/461][this issue]] for more information. - See [[file:doc/compiling.org#optional-features][here]] for a list of optional compilation flags that will enable some + See [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/compiling.org#optional-features][here]] for a list of optional compilation flags that will enable some optional plugins. - See [[file:doc/compiling.org][compiling]] for full compilation instructions starting from source. + See [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/compiling.org][compiling]] for full compilation instructions starting from source. * Running xmobar ** Running xmobar with a configuration file @@ -106,7 +129,7 @@ channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. or =~/.xmobarrc=. All the available command line switches and configuration parameters are - described in [[file:quick-start.org][the quick start guide]] and [[file:doc/plugins.org][the plugins index]]. + described in [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/quick-start.org][the quick start guide]] and [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/plugins.org][the plugins index]]. ** Writing your own xmobar in Haskell @@ -116,7 +139,7 @@ channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. Haskell instead of using a configuration file. (This is very similar to how [[http://xmonad.org][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 [[file:doc/using-haskell.org][here]] to learn more. + programmer, take a look [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/using-haskell.org][here]] to learn more. ** Running xmobar in text mode @@ -124,63 +147,62 @@ channel, ~#xmobar~, at [[ircs://irc.libera.chat][Libera]]. 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 [[./doc/quick-start.org#text-mode][Running xmobar in text mode]] for - details. Using this mode, you could [[file:doc/quick-start.org#wayland][pipe xmobar's output to, say, swaybar]], - and use it in wayland, or, with the [[./etc/xmobar.el][xmobar.el]] package, show it in Emacs's + there is no need for an X11 display. See [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/quick-start.org#text-mode][Running xmobar in text mode]] for + details. Using this mode, you could [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/quick-start.org#wayland][pipe xmobar's output to, say, swaybar]], + and use it in wayland, or, with the [[https://codeberg.org/xmobar/xmobar/src/branch/master/etc/xmobar.el][xmobar.el]] package, show it in Emacs's tab bar. * Configuration and further documentation - If you want to jump straight into running xmobar, head over to the - [[./doc/quick-start.org][quick start guide]]. + [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/quick-start.org][quick start guide]]. - If you want to get a detailed overview of all available plugins and - monitors, visit the [[./doc/plugins.org][plugins index]]. + monitors, visit the [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/plugins.org][plugins index]]. - For more information on how to use xmobar as a Haskell library see the - [[file:doc/using-haskell.org][using Haskell guide]]. + [[https://codeberg.org/xmobar/xmobar/src/branch/master/doc/using-haskell.org][using Haskell guide]]. - If you want to know how to contribute to the xmobar project, check out - [[contributing.org][contributing]]. + [[https://codeberg.org/xmobar/xmobar/src/branch/master/contributing.org][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 [[https://jao.io][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...;-). + Andrea Rossato originally designed and implemented xmobar up to version + 0.11.1. Since then, it is maintained and developed by [[https://jao.io][jao]], with the help of + the greater xmobar and Haskell communities. + + In particular, xmobar incorporates patches by Kostas Agnantis, Mohammed + Alshiekh, Alex Ameen, Axel Angel, Enrico Maria De Angelis, 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, Jonathan Grochowski, Patrick Günther, Reto + Hablützel, Corey Halpin, Juraj Hercek, Jaroslaw Jantura, 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, Ulrik de + Muelenaere, 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 [[https://codeberg.org/xmobar/xmobar/src/branch/master/license][license]] for more details. - Copyright © 2010-2022 Jose Antonio Ortega Ruiz + Copyright © 2010-2024 Jose Antonio Ortega Ruiz Copyright © 2007-2010 Andrea Rossato |