A fast and easy-to-use status bar
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE github: Custom issue templates (#1388) Aug 17, 2018
.hooks feat(git): Update old tag refs in README.md using pre-commit hook May 24, 2016
cmake fix(xcb): check for composite extension (#1430) Dec 2, 2018
common fix(travis): Fail tests if build fails Jul 22, 2018
contrib Revert "feat(cpu): Add ramp-coreload-spacing (#1472)" Oct 15, 2018
doc feat(background_manager): option to disable pseudo-transparency Oct 4, 2018
include fix(xcb): check for composite extension (#1430) Dec 2, 2018
lib CMake refactor (#1510) Nov 21, 2018
man fix(man): Add correct date and version to manpage Nov 30, 2018
src feat(cpu): Add percentage-sum token (#1517) Dec 3, 2018
tests CMake refactor (#1510) Nov 21, 2018
.clang-format clang-format: Increase column limit Nov 12, 2016
.clang-tidy refactor(clang-tidy): Clean up .clang-tidy May 20, 2018
.codecov.yml coverage: Allow small drops in coverage Nov 30, 2018
.editorconfig Add trim_trailing_whitespace to .editorconfig Sep 24, 2017
.gitignore fix(git): Don't ignore build.sh (#1545) Dec 12, 2018
.gitmodules git: Update submodule versions Aug 30, 2017
.travis.yml fix(xcb): check for composite extension (#1430) Dec 2, 2018
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection Dec 31, 2016
.ycm_extra_conf.py ycm: Remove -Werror from ycm flags Jul 30, 2018
CMakeLists.txt CMake refactor (#1510) Nov 21, 2018
LICENSE init(git): Base commit May 19, 2016
Makefile feat(build): help target to list all targets (#870) Nov 30, 2017
README.md Center logo and badges (#1420) Nov 11, 2018
SUPPORT.md Add SUPPORT.md (#803) Oct 28, 2017
banner.png Add polybar banner May 27, 2018
build.sh Accept a locally existing build-directory (#1476) Oct 16, 2018

README.md

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

sample screenshot sample screenshot sample screenshot sample screenshot

You can find polybar configs for these example images (and other configs) here.

If you need help, check out the Support page.

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.

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 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

Packaging status

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

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 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.

Dependencies

A compiler with C++14 support (clang-3.4+, gcc-5.1+), cmake 3.1+, git

  • cairo
  • libxcb
  • python2
  • xcb-proto
  • xcb-util-image
  • xcb-util-wm

Optional dependencies:

  • xcb-util-cursor required for the cursor-click and cursor-scroll settings
  • xcb-util-xrm required for accessing X resources with ${xrdb:...}

Optional dependencies for extended module support:

  • xcb-xkb required by internal/xkeyboard
  • alsa-lib required by internal/alsa
  • libpulse required by internal/pulseaudio
  • i3-wm required by internal/i3
  • jsoncpp required by internal/i3
  • libmpdclient required by internal/mpd
  • libcurl required by internal/github
  • libnl-genl or 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 3.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

For more info, have a look at the Compiling wiki page.

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

Launch the example bar

$ polybar example

Running

See the wiki for details on how to run polybar.

Contributors

Owner

Maintainers

Logo Design by

All Contributors

License

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