PolytreeDE/polybar
1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-11-18 13:55:11 -05:00
Code Releases Activity
A fast and easy-to-use status bar
1299 commits 7 branches 109 tags 14 MiB
C++ 94.6%
CMake 4.1%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
Find a file
patrick96 cacd161ed7 travis: Send data to coveralls.io after tests 
The PYTHONPATH env variable needed to be removed because it was messing
with pip and cpp-coveralls

Unfortunately adding the '-e build' to coveralls doesn't work to exclude
source files in the build directory, as it won't collect any data then.
If at some point, we have source files that are used by the tests
somewhere inside the build folder that isn't covered by the exclusion
rules, we'll need to add it here
2018-04-10 00:56:51 +02:00
.hooks
cmake fix(FreeBSD): Use libraries from LOCALBASE (#1111) 2018-03-22 00:03:47 +01:00
common travis: Separate compiling and testing 2018-04-10 00:56:51 +02:00
contrib aur: Add i3-wm dependency 2018-03-20 17:59:54 -07:00
doc refactor(temp): Mark %temperature% token as deprecated 2018-02-15 18:50:59 -08:00
include fix(ycm): Fix ycm error 2018-04-08 02:30:04 +02:00
lib refactor(lib): Remove jsoncpp tarball 2018-02-26 10:58:12 -08:00
man build: Bump version to 3.0.2 2017-01-26 21:57:01 +01:00
src Revert "fix(pulseaudio): add mutex for queue" 2018-04-07 13:52:48 -07:00
tests fix(tests): Compile gtest at configure time 2018-04-10 00:56:51 +02:00
.clang-format
.clang-tidy
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02: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 travis: Send data to coveralls.io after tests 2018-04-10 00:56:51 +02:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py fix(ycm): Use compilation db for all possible files 2018-04-08 02:30:04 +02:00
build.sh Fix #960 (#962) 2018-02-08 18:23:51 -08:00
CMakeLists.txt refactor(tests): Migrate to googletest 2018-04-10 00:56:51 +02:00
LICENSE
Makefile feat(build): help target to list all targets (#870) 2017-11-30 21:42:11 +01:00
README.md aur: Add i3-wm dependency 2018-03-20 17:59:54 -07:00
SUPPORT.md Add SUPPORT.md (#803) 2017-10-28 23:17:46 +02: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

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

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. For now package is only for Tumbleweed.

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