summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorjao <jao@gnu.org>2022-01-29 06:41:09 +0000
committerjao <jao@gnu.org>2022-01-29 06:41:09 +0000
commit1e2c4f20d095c7dbaf0c8d2cf9a8b095388a10d4 (patch)
treebd70b16b936b20a8d55e09032f61b16087d09ddd
parente0d175bd1c3bf264cfd7764b7b3eede2615e0757 (diff)
downloadxmobar-1e2c4f20d095c7dbaf0c8d2cf9a8b095388a10d4.tar.gz
xmobar-1e2c4f20d095c7dbaf0c8d2cf9a8b095388a10d4.tar.bz2
documentation nits
-rw-r--r--doc/quick-start.org9
-rw-r--r--readme.org149
2 files changed, 79 insertions, 79 deletions
diff --git a/doc/quick-start.org b/doc/quick-start.org
index 880c1bd..c51be3e 100644
--- a/doc/quick-start.org
+++ b/doc/quick-start.org
@@ -377,3 +377,12 @@ This is the list of command line options (the output of =xmobar --help=):
Mail bug reports and suggestions to <mail@jao.io>
#+end_src
+
+* Signal Handling
+
+xmobar reacts to ~SIGUSR1~ and ~SIGUSR2~:
+
+- After receiving ~SIGUSR1~ xmobar moves its position to the next screen.
+
+- After receiving ~SIGUSR2~ xmobar repositions itself on the current
+ screen.
diff --git a/readme.org b/readme.org
index d6e23a1..fb4845f 100644
--- a/readme.org
+++ b/readme.org
@@ -2,15 +2,15 @@
* About
-Xmobar is a minimalistic status bar. It was originally designed and
-implemented by Andrea Rossato to work with [[http://xmonad.org][xmonad]], but it is actually
-usable with any window manager.
+ Xmobar is a minimalistic status bar. It was originally designed and
+ implemented by Andrea Rossato to work with [[http://xmonad.org][xmonad]], but it is
+ actually usable with any window manager.
-Xmobar was inspired by the [[http://tuomov.iki.fi/software/][Ion3]] status bar, and supports similar
-features, like dynamic color management, icons, output templates, and
-extensibility through plugins.
+ Xmobar was inspired by the [[http://tuomov.iki.fi/software/][Ion3]] status bar, and supports similar
+ features, like dynamic color management, icons, output templates,
+ and extensibility through plugins.
-These are some xmobar [[file:doc/screenshots][screenshots]] using the author's configuration:
+ These are some xmobar [[file:doc/screenshots][screenshots]] using the author's configuration:
[[file:doc/screenshots/xmobar-top.png]]
@@ -18,14 +18,14 @@ These are some xmobar [[file:doc/screenshots][screenshots]] using the author's c
[[file:doc/screenshots/xmobar-exwm.png]]
-This is the [[./changelog.md][changelog]] for recent releases.
+ Check the [[./changelog.md][the change log]] for our release history.
* Installation
-** From your Systems Package Manager
+** 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.
+ 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
@@ -58,96 +58,87 @@ don't have to.
** Using cabal-install
-Xmobar is available from [[http://hackage.haskell.org/package/xmobar/][Hackage]], and you can install it using
-=cabal-install=:
+ Xmobar is available from [[http://hackage.haskell.org/package/xmobar/][Hackage]], and you can install it using
+ =cabal-install=:
-#+begin_src shell
- cabal install xmobar
-#+end_src
+ #+begin_src shell
+ cabal install xmobar
+ #+end_src
-Starting with version 0.35.1, xmobar now requires at least GHC version
-8.4.x. to build. See [[https://github.com/jaor/xmobar/issues/461][this issue]] for more information.
+ Starting with version 0.35.1, xmobar now requires at least GHC
+ version 8.4.x. to build. See [[https://github.com/jaor/xmobar/issues/461][this issue]] for more information.
-See [[file:doc/compiling.org][compiling]] 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:
+ See [[file:doc/compiling.org][compiling]] 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:
-#+begin_src shell
- cabal install xmobar --flags="all_extensions"
-#+end_src
+ #+begin_src shell
+ cabal install xmobar --flags="all_extensions"
+ #+end_src
** From source
-See [[file:doc/compiling.org][compiling]].
+ See [[file:doc/compiling.org][compiling]].
* Running xmobar
-You can run xmobar with:
-
-#+begin_src shell
- xmobar /path/to/config &
-#+end_src
-
-or
-
-#+begin_src shell
- xmobar &
-#+end_src
-
-if you have the default configuration file saved as
-=$XDG\_CONFIG\_HOME/xmobar/xmobarrc= (defaulting to
-=~/.config/xmobar/xmobarrc=), or =~/.xmobarrc=.
+ You can run xmobar with:
-** Signal Handling
+ #+begin_src shell
+ xmobar /path/to/config &
+ #+end_src
-xmobar reacts to SIGUSR1 and SIGUSR2:
+ or
-- After receiving SIGUSR1 xmobar moves its position to the next screen.
+ #+begin_src shell
+ xmobar &
+ #+end_src
-- After receiving SIGUSR2 xmobar repositions itself on the current
- screen.
+ if you have the default configuration file saved as
+ =$XDG_CONFIG_HOME/xmobar/xmobarrc= (defaulting to
+ =~/.config/xmobar/xmobarrc=), or =~/.xmobarrc=.
-* Configuration and Further Links
+* Configuration and further Links
-- If you want to jump straight into configuring xmobar, head over to the
- [[./doc/quick-start.org][quick-start]] guide.
+ - If you want to jump straight into configuring xmobar, head over to the
+ [[./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]] file.
+ - If you want to get a detailed overview of all available plugins and
+ monitors, visit the [[./doc/plugins.org][plugins index]].
-- If you want to know how to contribute to the xmobar project, check out
- [[contributing.org][contributing]].
+ - If you want to know how to contribute to the xmobar project, check out
+ [[contributing.org][contributing]].
-- If you want to write your own plugins, see [[./doc/write-your-own-plugin.org][write-your-own-plugin]].
+ - If you want to write your own plugins, see [[./doc/write-your-own-plugin.org][Write your own plugin]].
-- To understand the internal mysteries of xmobar you may try reading
- [[https://wiki.haskell.org/X_window_programming_in_Haskell][this tutorial]] on X Window Programming in Haskell.
+ - To understand the internal mysteries of xmobar you may try reading
+ [[https://wiki.haskell.org/X_window_programming_in_Haskell][this tutorial]] on X Window Programming in Haskell.
* 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,
-Reto Hablützel, Juraj Hercek, Tomáš Janoušek, Ada Joule, Spencer
-Janssen, Roman Joost, 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
-Michal Zielonka.
+ 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, Reto Hablützel, Juraj Hercek, Tomáš Janoušek, Ada
+ Joule, Spencer Janssen, Roman Joost, 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 Michal Zielonka.
** Thanks