PolytreeDE
/
polybar
mirror of https://github.com/polybar/polybar.git
1
0
Fork 0
Code Releases Activity
A fast and easy-to-use status bar
1,180 Commits 7 Branches 108 Tags 18 MiB
C++ 94.7%
CMake 4%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
Go to file
patrick96 ad4baf87cf
Add trim_trailing_whitespace to .editorconfig 		2017-09-24 08:31:42 +02:00
.hooks feat(git): Update old tag refs in README.md using pre-commit hook 2016-05-24 17:02:33 +02:00
cmake fix: make xcb-cursor optional for now 2017-09-16 15:31:24 -07:00
common fix(version): Follow APP_VERSION in POLYBAR_NS 2017-01-29 15:16:00 +01:00
contrib fix(aur): Add xcb-util-cursor as dep 2017-09-16 15:31:49 -07:00
doc fix(docs): Add cursor options to example 2017-09-17 13:17:04 -07:00
include Merge pull request #727 from NBonaparte/change-cursor 2017-09-17 22:33:32 +02:00
lib git: Update submodule versions 2017-08-30 17:33:38 +02:00
man build: Bump version to 3.0.2 2017-01-26 21:57:01 +01:00
src Merge pull request #727 from NBonaparte/change-cursor 2017-09-17 22:33:32 +02:00
tests fix(config): Perform tilde expansion on `include-file` #603 2017-06-02 18:34:49 +02:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy wip(refactor): Improve parsing and font glyph caching 2016-12-15 17:28:58 +01:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02:00
.exrc fix: project rename 2016-11-19 06:26:07 +01:00
.gitignore feat(build): Development tasks 2017-01-27 04:15:14 +01:00
.gitmodules git: Update submodule versions 2017-08-30 17:33:38 +02:00
.travis.yml fix(travis): Install xcb-util-cursor 2017-09-16 15:31:24 -07:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py wip(refactor): Cairo drawing 2017-01-24 07:11:14 +01:00
CMakeLists.txt bash completion 2017-05-19 17:02:47 +02:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
Makefile fix(build): POSIX compliant command usage 2017-02-23 13:26:18 +01:00
README.md Add more information on packages 2017-07-11 14:41:33 +02:00
build.sh feat(ipc): Add polybar-msg to facilitate ipc messaging 2017-01-10 02:09:33 +01:00

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

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