Rooba
/
polybar
mirror of https://github.com/polybar/polybar.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A fast and easy-to-use status bar
1,743 Commits 7 Branches 109 Tags 18 MiB
C++ 94.6%
CMake 4.1%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
Go to file
patrick96 cf739ed295 ci: Use github actions 2020-12-12 01:43:12 +01:00
.github ci: Use github actions 2020-12-12 01:43:12 +01:00
cmake doc: Allow custom SPHINX_BUILD 2020-02-21 16:17:12 +01:00
common ci: Use github actions 2020-12-12 01:43:12 +01:00
contrib aur: Use Release mode in cmake 2020-10-31 10:53:32 +01:00
doc doc(actions): Point user to doc when using legacy actions 2020-11-26 20:53:53 +01:00
include fix(logger): Wrong conversion function called 2020-12-12 01:43:12 +01:00
lib xpp: Update submodule (#2125) 2020-06-10 21:00:18 +02:00
src fix(logger): Wrong conversion function called 2020-12-12 01:43:12 +01:00
tests fix(builder): Properly apply alpha for fg and bg 2020-12-01 14:53:41 +01:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy Disable modernize-use-trailing-return-type warning 2020-08-12 11:01:44 +02:00
.codecov.yml coverage: Allow small drops in coverage 2018-11-30 11:55:31 -08:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02:00
.gitignore Add script to create release archives 2020-11-22 23:32:41 +01:00
.gitmodules migration: Update submodule URLs 2019-05-08 12:20:33 +02:00
.travis.yml ci: Use github actions 2020-12-12 01:43:12 +01:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py ycm: Remove -Werror from ycm flags 2018-07-30 14:12:22 +02:00
CMakeLists.txt cmake: Use GNUInstallDirs (#1818) 2019-06-24 18:08:59 +02:00
CONTRIBUTING.md Add contributing guidelines 2020-11-26 21:00:40 +01:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
README.md ci: Use github actions 2020-12-12 01:43:12 +01:00
SUPPORT.md Add debugging guide to SUPPORT.md 2020-11-26 21:00:40 +01:00
banner.png Add polybar banner 2018-05-27 09:37:56 +02:00
build.sh build: Add -j to build.sh (#1961) 2020-01-07 16:35:48 +01:00
config.cmake config: Remove bspwm variable references 2019-06-02 15:36:26 +02:00
version.txt Release 3.5.0 2020-12-01 14:53:41 +01:00

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.

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 and PulseAudio 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 Help

If you find yourself stuck, have a look at our Support page for resources where you can find help.

Contributing

Read our contributing guidelines for how to get started with contributing to polybar.

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 are using Debian (unstable or testing), you can install polybar using sudo apt install polybar. If you are using Debian (buster/stable), you need to enable backports and then install using sudo apt -t buster-backports install polybar.

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.1, openSUSE Leap 15.2 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.

If you are using Fedora, you can install polybar using sudo dnf install polybar.

Installation

The compiling page on the wiki describes all steps necessary to build and install polybar.

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

Or you can copy the example config from /usr/share/doc/polybar/config or /usr/local/share/doc/polybar/config (depending on your install parameters)

Launch the example bar

$ polybar example

Running

See the wiki for details on how to run polybar.

Community

Want to get in touch?

Contributors

Owner

Maintainers

Logo Design by

All Contributors

License

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