fd556525a8
* refactor(color): Use enum class for color type * Add testcases for tag parser * Make tag parser a pull-style parser Being able to parse single elements at a time gives us more fine-grained error messages, we can also parse as much as possible and only stop after an exception. * fix(color): Parser did not check for invalid chars * tag parser: First full implementation * tag parser: Fix remaining failing tests * tag parser: Replace old parser * tag parser: Treat alignment as formatting tag Makes the structure less complex and the alignment tags really are formatting tags, they are structurally no different from the %{R} tag. * tag parser: Cleanup type definitions All type definitions for tags now live in tags/types.hpp, the parser.hpp only contains the definitions necessary for actually calling the parser, this shouldn't be included in many places (only places that actually do parsing). But many places need the definitions for the tags themselves. * Rename components/parser to tags/dispatch * tag parser: Cleanup * Add changelog |
||
---|---|---|
.github | ||
cmake | ||
common | ||
contrib | ||
doc | ||
include | ||
lib | ||
src | ||
tests | ||
.clang-format | ||
.clang-tidy | ||
.codecov.yml | ||
.editorconfig | ||
.gitignore | ||
.gitmodules | ||
.valgrind-suppressions | ||
.ycm_extra_conf.py | ||
banner.png | ||
build.sh | ||
CHANGELOG.md | ||
CMakeLists.txt | ||
config.cmake | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
SUPPORT.md | ||
version.txt |
A fast and easy-to-use tool for creating status bars.
Polybar aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting. Here are a few screenshots showing you what it can look like:
You can find polybar configs for these example images (and other configs) here.
Table of Contents
Introduction
The main purpose of Polybar is to help users create awesome status bars. It has built-in functionality to display information about the most commonly used services. Some of the services included so far:
- Systray icons
- Window title
- Playback controls and status display for MPD using libmpdclient
- ALSA and PulseAudio volume controls
- Workspace and desktop panel for bspwm and i3
- Workspace module for EWMH compliant window managers
- Keyboard layout and indicator status
- CPU and memory load indicator
- Battery display
- Network connection details
- Backlight level
- Date and time label
- Time-based shell script execution
- Command output tailing
- User-defined menu tree
- Inter-process messaging
- And more...
See the wiki for more details.
Getting Help
If you find yourself stuck, have a look at our Support page for resources where you can find help.
Contributing
Read our contributing guidelines for how to get started with contributing to polybar.
Getting started
Polybar was already packaged for the distros listed below. If you can't find your distro here, you will have to build from source.
If you are using Debian (unstable or testing), you can install polybar using sudo apt install polybar
.
If you are using Debian (buster/stable), you need to enable backports and then install using sudo apt -t buster-backports install polybar
.
If you are using Arch Linux, you can install the AUR package polybar-git to get the latest version, or polybar for the latest stable release.
If you are using Void Linux, you can install polybar using xbps-install -S polybar
.
If you are using NixOS, polybar is available in both the stable and unstable channels and can be installed with the command nix-env -iA nixos.polybar
.
If you are using Slackware, polybar is available from the SlackBuilds repository.
If you are using Source Mage GNU/Linux, polybar spell is available in test grimoire and can be installed via cast polybar
.
If you are using openSUSE, polybar is available from OBS repository. Package is available for openSUSE Leap 15.1, openSUSE Leap 15.2 and Tumbleweed.
If you are using FreeBSD, polybar can be installed using pkg install polybar
. Make sure you are using the latest
package branch.
If you are using Gentoo, both release and git-master versions are available in the main repository.
If you are using Fedora, you can install polybar using sudo dnf install polybar
.
Installation
The compiling page on the wiki describes all steps necessary to build and install polybar.
Configuration
Details on how to setup and configure the bar and each module have been moved to the wiki.
Install the example configuration
Run the following inside the build directory:
$ make userconfig
Or you can copy the example config from /usr/share/doc/polybar/config
or /usr/local/share/doc/polybar/config
(depending on your install parameters)
Launch the example bar
$ polybar example
Running
See the wiki for details on how to run polybar.
Community
Want to get in touch?
- Join our Gitter room at gitter.im/polybar/polybar
- We have our own subreddit at r/polybar.
- Chat with us in the
#polybar
IRC channel on thechat.freenode.net
server.
Contributors
Owner
- Michael Carlberg @jaagr
Maintainers
- @NBonaparte
- Chase Geigle @skystrife
- Patrick Ziegler @patrick96
Logo Design by
All Contributors
License
Polybar is licensed under the MIT license. See LICENSE for more information.