/polybar

A fast and easy-to-use status bar
  1. C++ 94.9%
  2. CMake 3.1%
  3. Shell 1.3%
  4. Other 0.7%
C++ CMake Shell Other
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 7c41719 Jan 8, 2018 @NBonaparte NBonaparte committed with patrick96 contrib: Remove void package
Permalink
Failed to load latest commit information.
.hooks feat(git): Update old tag refs in README.md using pre-commit hook May 24, 2016
cmake fix: make xcb-cursor optional for now Sep 16, 2017
common fix(bump.sh): remove references to .SRCINFO (#884) Dec 3, 2017
contrib contrib: Remove void package Jan 8, 2018
doc feat(i3): Add workspace separator (#938) Jan 7, 2018
include feat(i3): Add workspace separator (#938) Jan 7, 2018
lib fix(build): Update deprecated jsoncpp Reader Dec 3, 2017
man build: Bump version to 3.0.2 Jan 26, 2017
src feat(i3): Add workspace separator (#938) Jan 7, 2018
tests fix(config): Perform tilde expansion on `include-file` #603 Jun 2, 2017
.clang-format clang-format: Increase column limit Nov 12, 2016
.clang-tidy wip(refactor): Improve parsing and font glyph caching Dec 15, 2016
.editorconfig Add trim_trailing_whitespace to .editorconfig Sep 24, 2017
.exrc fix: project rename Nov 19, 2016
.gitignore feat(build): Development tasks Jan 27, 2017
.gitmodules git: Update submodule versions Aug 30, 2017
.travis.yml fix(travis): Install xcb-util-cursor Sep 16, 2017
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection Dec 31, 2016
.ycm_extra_conf.py wip(refactor): Cairo drawing Jan 24, 2017
CMakeLists.txt bash completion May 19, 2017
LICENSE init(git): Base commit May 19, 2016
Makefile feat(build): help target to list all targets (#870) Nov 30, 2017
README.md docs: Add xcb cursor dependency to README (#895) Dec 17, 2017
SUPPORT.md Add SUPPORT.md (#803) Oct 28, 2017
build.sh feat(ipc): Add polybar-msg to facilitate ipc messaging Jan 10, 2017

README.md

Polybar

Build Status MIT License

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

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

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, 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 Debian, polybar is available from the GetDeb repository.

If you are using Slackware, polybar is available from the SlackBuilds repository.

Dependencies

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

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

Optional dependencies:

  • xcb-util-cursor required for the cursor-click and cursor-scroll settings

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

Running

See the wiki for details on how to run polybar.

License

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