2018-11-11 09:18:36 -05:00
< p align = "center" >
2019-11-25 12:39:36 -05:00
< img src = "banner.png" alt = "Polybar" >
2018-11-11 09:18:36 -05:00
< / p >
2016-06-11 06:37:14 -04:00
2018-11-11 09:18:36 -05:00
< p align = "center" >
2016-10-11 23:35:33 -04:00
A fast and easy-to-use tool for creating status bars.
2018-11-11 09:18:36 -05:00
< / p >
< p align = "center" >
2019-05-06 07:51:49 -04:00
< a href = "https://github.com/polybar/polybar/releases" > < img src = "https://img.shields.io/github/release/polybar/polybar.svg" > < / a >
2020-12-19 17:24:23 -05:00
< a href = "https://github.com/polybar/polybar/releases" > < img alt = "GitHub All Releases" src = "https://img.shields.io/github/downloads/polybar/polybar/total" / > < / a >
2020-12-11 20:03:30 -05:00
< a href = "https://github.com/polybar/polybar/actions?query=workflow%3ACI" > < img src = "https://github.com/polybar/polybar/workflows/CI/badge.svg" > < / a >
2020-12-06 12:16:17 -05:00
< a href = "https://github.com/polybar/polybar/actions?query=workflow%3A%22Release+Workflow%22" > < img src = "https://github.com/polybar/polybar/workflows/Release%20Workflow/badge.svg?branch=master" > < / a >
2019-04-08 17:40:44 -04:00
< a href = "https://polybar.readthedocs.io" > < img src = "https://readthedocs.org/projects/polybar/badge/?version=latest" > < / a >
2019-11-25 12:39:36 -05:00
< a href = "https://gitter.im/polybar/polybar" > < img src = "https://badges.gitter.im/polybar/polybar.svg" > < / a >
2019-05-06 07:51:49 -04:00
< a href = "https://codecov.io/gh/polybar/polybar/branch/master" > < img src = "https://codecov.io/gh/polybar/polybar/branch/master/graph/badge.svg" > < / a >
< a href = "https://github.com/polybar/polybar/blob/master/LICENSE" > < img src = "https://img.shields.io/github/license/polybar/polybar.svg" > < / a >
2019-09-05 11:20:11 -04:00
< a href = "https://www.codetriage.com/polybar/polybar" > < img src = "https://www.codetriage.com/polybar/polybar/badges/users.svg" > < / a >
2020-12-21 10:27:04 -05:00
< a href = "https://opencollective.com/polybar" > < img src = "https://opencollective.com/polybar/tiers/badge.svg" > < / a >
2018-11-11 09:18:36 -05:00
< / p >
2016-05-19 10:41:06 -04:00
2020-12-31 06:51:56 -05:00
**[Documentation](https://github.com/polybar/polybar/wiki/) | [Installation ](#installation ) | [Support ](SUPPORT.md ) | [Donate ](#donations )**
2016-11-19 00:22:44 -05:00
**Polybar** aims to help users build beautiful and highly customizable status bars
2016-06-28 22:44:55 -04:00
for their desktop environment, without the need of having a black belt in shell scripting.
2022-03-02 08:36:54 -05:00
2018-08-29 14:19:00 -04:00
2016-06-28 22:44:55 -04:00
## Table of Contents
* [Introduction ](#introduction )
2018-10-27 08:56:48 -04:00
* [Getting Help ](#getting-help )
2020-11-26 14:16:13 -05:00
* [Contributing ](#contributing )
2016-06-28 22:44:55 -04:00
* [Getting started ](#getting-started )
2020-11-26 14:14:57 -05:00
* [Installation ](#installation )
2022-03-02 08:36:54 -05:00
* [First Steps ](#first-steps )
2018-10-27 08:59:46 -04:00
* [Community ](#community )
2018-05-27 05:11:50 -04:00
* [Contributors ](#contributors )
2020-12-21 10:27:04 -05:00
* [Donations ](#donations )
* [Sponsors ](#sponsors )
* [Backers ](#backers )
2016-06-28 22:44:55 -04:00
* [License ](#license )
## Introduction
2016-11-19 00:22:44 -05:00
The main purpose of **Polybar** is to help users create awesome status bars.
2017-01-20 02:15:55 -05:00
It has built-in functionality to display information about the most commonly used services.
2017-05-12 03:43:36 -04:00
Some of the services included so far:
2016-06-28 22:44:55 -04:00
2016-12-15 12:22:50 -05:00
- Systray icons
2016-11-18 22:03:18 -05:00
- Window title
2016-06-28 22:44:55 -04:00
- Playback controls and status display for [MPD ](https://www.musicpd.org/ ) using [libmpdclient ](https://www.musicpd.org/libs/libmpdclient/ )
2020-11-26 14:16:13 -05:00
- [ALSA ](https://www.alsa-project.org/main/index.php/Main_Page ) and [PulseAudio ](https://www.freedesktop.org/wiki/Software/PulseAudio/ ) volume controls
2016-06-28 22:44:55 -04:00
- Workspace and desktop panel for [bspwm ](https://github.com/baskerville/bspwm ) and [i3 ](https://github.com/i3/i3 )
2016-12-15 12:22:50 -05:00
- Workspace module for [EWMH compliant ](https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html#idm140130320786080 ) window managers
- Keyboard layout and indicator status
2016-06-28 22:44:55 -04:00
- 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
2016-11-18 12:56:15 -05:00
- Inter-process messaging
2016-06-28 22:44:55 -04:00
- And more...
2019-05-06 07:51:49 -04:00
[See the wiki for more details ](https://github.com/polybar/polybar/wiki ).
2016-11-18 12:56:15 -05:00
2018-10-27 08:56:48 -04:00
## Getting Help
If you find yourself stuck, have a look at our [Support ](SUPPORT.md ) page for resources where you can find help.
2016-06-28 22:44:55 -04:00
2020-11-26 14:16:13 -05:00
## Contributing
Read our [contributing guidelines ](CONTRIBUTING.md ) for how to get started with contributing to polybar.
2016-06-28 22:44:55 -04:00
## Getting started
2020-12-31 06:51:56 -05:00
### Installation
2017-07-04 11:34:00 -04:00
< a href = "https://repology.org/metapackage/polybar" >
< img src = "https://repology.org/badge/vertical-allrepos/polybar.svg" alt = "Packaging status" align = "right" >
< / a >
2020-12-31 06:51:56 -05:00
Polybar is already available in the package manager for many repositories.
We list some of the more prominent ones here.
Also click the [image on the
right](https://repology.org/project/polybar/versions) to see a more complete
list of available polybar packages.
2018-06-18 07:50:42 -04:00
2021-09-11 19:13:51 -04:00
If you are using **Debian** (bullseye/11/stable) or later, you can install [polybar ](https://tracker.debian.org/pkg/polybar )
using `sudo apt install polybar` . Newer releases of polybar are sometimes provided in the [backports ](https://wiki.debian.org/Backports )
repository for stable users, you need to enable [backports ](https://wiki.debian.org/Backports ) and then install using
`sudo apt -t buster-backports install polybar` .
2020-04-24 16:45:56 -04:00
2020-12-31 06:51:56 -05:00
If you are using **Ubuntu** 20.10 (Groovy Gorilla) or later, you can install polybar
using `sudo apt install polybar` .
If you are using **Arch Linux** , you can install the AUR package
[polybar ](https://aur.archlinux.org/packages/polybar/ ) to get the latest
version, or [polybar-git ](https://aur.archlinux.org/packages/polybar-git/ ) for
the most up-to-date (unstable) changes.
2016-06-23 19:14:43 -04:00
2018-06-18 07:49:15 -04:00
If you are using **Void Linux** , you can install [polybar ](https://github.com/void-linux/void-packages/blob/master/srcpkgs/polybar/template ) using `xbps-install -S polybar` .
2017-01-09 14:50:52 -05:00
2017-07-04 11:34:00 -04:00
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 ](https://slackbuilds.org/repository/14.2/desktop/polybar/ ) repository.
2017-02-23 00:36:33 -05:00
2018-02-02 08:15:29 -05:00
If you are using **Source Mage GNU/Linux** , polybar spell is available in test grimoire and can be installed via `cast polybar` .
2016-06-23 19:14:43 -04:00
2020-12-31 06:51:56 -05:00
If you are using **openSUSE Tumbleweed** , polybar is available from the
[official
repositories](https://build.opensuse.org/package/show/openSUSE%3AFactory/polybar)
and can be installed via `zypper install polybar` .
If you are using **openSUSE Leap** , polybar is available from
[OBS ](https://build.opensuse.org/package/show/X11:Utilities/polybar/ ).
The package is available for openSUSE Leap 15.1 and above.
2018-04-18 07:27:30 -04:00
2018-06-18 07:49:15 -04:00
If you are using **FreeBSD** , [polybar ](https://svnweb.freebsd.org/ports/head/x11/polybar/ ) can be installed using `pkg install polybar` . Make sure you are using the `latest` package branch.
2018-04-18 07:27:30 -04:00
2018-06-18 07:49:15 -04:00
If you are using **Gentoo** , both release and git-master versions are available in the [main ](https://packages.gentoo.org/packages/x11-misc/polybar ) repository.
2018-05-04 22:40:05 -04:00
2020-01-20 05:36:28 -05:00
If you are using **Fedora** , you can install [polybar ](https://src.fedoraproject.org/rpms/polybar ) using `sudo dnf install polybar` .
2020-12-31 06:51:56 -05:00
If you can't find your distro here, you will have to [build from source ](https://github.com/polybar/polybar/wiki/Compiling ).
2016-05-19 17:46:50 -04:00
2022-03-02 08:36:54 -05:00
### First Steps
[See the wiki for details on how to run and configure polybar ](https://github.com/polybar/polybar/wiki ).
2016-06-28 22:44:55 -04:00
2018-10-27 08:59:46 -04:00
## Community
Want to get in touch?
2019-11-25 12:39:36 -05:00
* Join our Gitter room at [gitter.im/polybar/polybar ](https://gitter.im/polybar/polybar )
2018-10-27 08:59:46 -04:00
* We have our own subreddit at [r/polybar ](https://www.reddit.com/r/polybar ).
2021-06-16 11:02:58 -04:00
* Chat with us in the `#polybar` IRC channel on the [`irc.libera.chat:6697` ](https://libera.chat/ ) server.
2018-10-27 08:59:46 -04:00
2018-05-27 05:11:50 -04:00
## Contributors
### Owner
2020-02-21 09:39:39 -05:00
* Michael Carlberg [**@jaagr** ](https://github.com/jaagr/ )
2018-05-27 05:11:50 -04:00
### Maintainers
* [**@NBonaparte** ](https://github.com/NBonaparte )
* Chase Geigle [**@skystrife** ](https://github.com/skystrife )
* Patrick Ziegler [**@patrick96** ](https://github.com/patrick96 )
### Logo Design by
* [**@Tobaloidee** ](https://github.com/Tobaloidee )
2019-05-06 07:51:49 -04:00
### [All Contributors](https://github.com/polybar/polybar/graphs/contributors)
2016-06-28 22:44:55 -04:00
2020-12-21 10:27:04 -05:00
## Donations
Polybar accepts donations through [open collective ](https://opencollective.com/polybar ).
[Become a backer ](https://opencollective.com/polybar ) and support polybar!
### Sponsors
< a href = "https://opencollective.com/polybar/sponsor/0/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/0/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/1/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/1/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/2/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/2/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/3/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/3/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/4/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/4/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/5/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/5/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/6/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/6/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/7/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/7/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/8/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/8/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/9/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/9/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/10/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/10/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/11/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/11/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/12/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/12/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/13/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/13/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/14/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/14/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/15/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/15/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/16/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/16/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/17/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/17/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/18/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/18/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/19/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/19/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/20/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/20/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/21/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/21/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/22/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/22/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/23/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/23/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/24/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/24/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/25/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/25/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/26/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/26/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/27/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/27/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/28/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/28/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/sponsor/29/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/sponsor/29/avatar.svg?requireActive=false" > < / a >
### Backers
< a href = "https://opencollective.com/polybar/backer/0/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/0/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/1/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/1/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/2/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/2/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/3/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/3/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/4/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/4/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/5/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/5/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/6/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/6/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/7/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/7/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/8/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/8/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/9/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/9/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/10/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/10/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/11/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/11/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/12/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/12/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/13/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/13/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/14/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/14/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/15/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/15/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/16/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/16/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/17/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/17/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/18/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/18/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/19/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/19/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/20/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/20/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/21/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/21/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/22/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/22/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/23/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/23/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/24/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/24/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/25/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/25/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/26/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/26/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/27/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/27/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/28/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/28/avatar.svg?requireActive=false" > < / a >
< a href = "https://opencollective.com/polybar/backer/29/website?requireActive=false" target = "_blank" > < img src = "https://opencollective.com/polybar/backer/29/avatar.svg?requireActive=false" > < / a >
2016-05-24 17:30:05 -04:00
## License
2019-05-06 07:51:49 -04:00
Polybar is licensed under the MIT license. [See LICENSE for more information ](https://github.com/polybar/polybar/blob/master/LICENSE ).
