PolytreeDE/polybar
1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-11-11 13:50:56 -05:00
Code Releases Activity
A fast and easy-to-use status bar
879 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
Michael Carlberg 796cdb52cc refactor: Rename restack function
2017-01-01 15:45:18 +01: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(cmake): Use new config path 2016-12-26 17:07:02 +01:00
common fix(ci): Use default build type 2016-12-23 17:15:13 +01:00
contrib build: Bump version to 2.4.5 2016-12-31 15:43:01 +01:00
doc feat(zsh): Add completion script 2016-12-31 06:06:36 +01:00
include refactor: Rename restack function 2017-01-01 15:45:18 +01:00
lib git(i3ipcpp): Update submodule ref 2016-12-23 13:34:02 +01:00
man refactor(cmake): Install components 2016-12-23 18:10:19 +01:00
src refactor: Rename restack function 2017-01-01 15:45:18 +01:00
tests refactor(tests): Use new factory methods 2016-12-15 19:05:26 +01: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
.exrc fix: project rename 2016-11-19 06:26:07 +01:00
.gitignore git: Untrack generated config 2016-12-23 20:41:18 +01:00
.gitmodules git(i3ipcpp): Update submodule ref 2016-12-23 13:34:02 +01:00
.travis.yml fix(ci): Use default build type 2016-12-23 17:15:13 +01:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py refactor: Remove last usage of boost::optional 2016-12-15 17:13:16 +01:00
build.sh fix(build.sh): Prompt for libcurl support 2016-12-20 05:33:07 +01:00
bump.sh fix(bump.sh): Read previous tag 2016-12-22 00:23:00 +01:00
CMakeLists.txt refactor(cmake): Install components 2016-12-23 18:10:19 +01:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
README.md build: Bump version to 2.4.5 2016-12-31 15:43:01 +01:00
version.sh fix: Custom version by argument 2016-06-28 15:24:23 +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. Heres a few screenshots showing you what it can look like:

sample screenshot sample screenshot sample screenshot sample screenshot

Please note that the project still is in early development, so please report any problems by creating an issue ticket.

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

Dependencies

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

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

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)
# required
$ apt-get install cmake cmake-data libfontconfig1-dev libfreetype6-dev libghc-x11-xft-dev libx11-xcb-dev libxcb1-dev libxcb-ewmh-dev libxcb-icccm4-dev libxcb-image0-dev libxcb-randr0-dev libxcb-util0-dev libxcb-xkb-dev pkg-config python-xcbgen xcb-proto
# optional
$ apt-get install i3-wm libasound2-dev libmpdclient-dev libiw-dev

Building from source

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

$ git clone --branch 2.4.5 --recursive https://github.com/jaagr/polybar
$ mkdir polybar/build
$ cd polybar/build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ 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.