Polybar

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. Heres a few screenshots showing you what it can look like:

Please report any issues or bugs you may find by creating an issue ticket here on GitHub. Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named #polybar.

Introduction
Getting started
License

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 commoly used services. Some of the batteries included so far:

Systray icons
Window title
Playback controls and status display for MPD using libmpdclient
ALSA 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 started

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 create a package for any other distribution, please consider contributing the template.

If you are using Void Linux, there's a xbps template available that you could use to build the project. A pull-request has been submitted but it is still not merged into the official repositories so I wouldn't hold my breath.

Dependencies

A compiler with C++14 support (clang-3.4+, gcc-5.1+).

cmake
libXft
python2
xcb-proto
xcb-util-image
xcb-util-wm
xcb-util-xrm

Optional dependencies for extended module support:

alsa-lib (required by internal/volume)
jsoncpp (required by internal/i3)
libmpdclient (required by internal/mpd)
libcurl (required by internal/github)
wireless_tools (required by internal/network)

Find a more complete list on the dedicated wiki page.

Building from source

Please report any problems you run into when building the project.

$ git clone --branch 2.5.2 --recursive https://github.com/jaagr/polybar
$ mkdir polybar/build
$ cd polybar/build
$ cmake ..
$ sudo make install

There's also a helper script available in the root folder:

$ ./build.sh

Configuration

Details on how to setup and configure the bar and each module have been moved to the wiki.

Install the example configuration

$ make userconfig

Launch the example bar

$ polybar example

NOTE: If the bar output looks odd, it's probably because you're missing the fonts defined in the config. Update the config or install the missing fonts.

Running

See the wiki for details on how to run polybar.

License

Polybar is licensed under the MIT license. See LICENSE for more information.

4.9 KiB Raw Blame History