README 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. Yambar is a lightweight and configurable status panel (bar, for short)
  2. for X11 and Wayland, that goes to great lengths to be both CPU and
  3. battery efficient - polling is only done when absolutely necessary.
  4. It has a number of modules that provide information in the form of tags.
  5. For example, the clock module has a date tag that contains the
  6. current date.
  7. The modules do not know how to present the information though.
  8. This is instead done by particles. And the user, you, decides
  9. which particles (and thus how to present the data) to use.
  10. Furthermore, each particle can have a decoration - a background color or
  11. a graphical underline, for example.
  12. There is no support for images or icons. use an icon font
  13. (e.g. Font Awesome, or Material Icons) if you want a
  14. graphical representation.
  15. There are a number of modules and particles builtin. More can be added
  16. as plugins. You can even write your own!
  17. To summarize: a bar displays information provided by modules, using
  18. particles and decorations. How is configured by you.
  19. Yambar is configured using YAML, in ~/.config/yambar/config.yml
  20. For details, see the man pages yambar(5) is a good start.i
  21. Available modules:
  22. •alsa
  23. •backlight
  24. •battery
  25. •clock
  26. •i3 (and Sway)
  27. •label
  28. •mpd
  29. •network
  30. •removables
  31. •river
  32. •script
  33. •sway-xkb
  34. •xkb (XCB backend only)
  35. •xwindow (XCB backend only)
  36. If you need to rebuild the package delete /tmp/SBo/yambar directory.