PolytreeDE/polybar: A fast and easy-to-use status bar

mirror of https://github.com/polybar/polybar.git synced 2024-11-03 04:33:30 -05:00

A fast and easy-to-use status bar

bar bspwm cpp hacktoberfest i3wm linux polybar window-manager x11

Find a file

patrick96 63819d62f0 cmake: Use set_target_properties for include dirs target_include_directories for INTERFACE IMPORTED targets is only supported since cmake 3.11 Fixes #2387 Ref: https://gitlab.kitware.com/cmake/cmake/-/issues/15689		2021-03-01 00:05:44 +01:00
.github	CI: apt update before installing doc dependencies	2021-01-24 16:05:31 +01:00
cmake	cmake: Use set_target_properties for include dirs	2021-03-01 00:05:44 +01:00
common	refactor(cmake): Allow targets to be enabled individually	2020-12-24 02:20:38 +01:00
config	Add config option for visiblity (#2320 cont'd) (#2342 )	2021-01-03 02:43:50 +01:00
contrib	Remove polybar spec file	2021-01-15 16:17:28 +01:00
doc	Add initial support for an escape character (#2361 )	2021-01-26 19:16:29 +01:00
include	feat: Rounded bar border (#2359 )	2021-02-16 23:17:16 +01:00
lib	Add cmake files for configuring individual targets	2020-12-24 02:20:38 +01:00
src	feat: Rounded bar border (#2359 )	2021-02-16 23:17:16 +01:00
tests	Add more dispatch tests	2021-02-12 20:01:22 +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	codecov: Disable pull request annotations	2020-12-16 00:06:10 +01:00
.editorconfig	Add trim_trailing_whitespace to .editorconfig	2017-09-24 08:31:42 +02:00
.gitignore	cmake: Add option to enable/disable sample config	2020-12-24 02:20:38 +01:00
.gitmodules	migration: Update submodule URLs	2019-05-08 12:20:33 +02: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
banner.png	Add polybar banner	2018-05-27 09:37:56 +02:00
build.sh	Cleanup	2020-12-24 02:20:38 +01:00
CHANGELOG.md	feat: Rounded bar border (#2359 )	2021-02-16 23:17:16 +01:00
CMakeLists.txt	Cleanup	2020-12-24 02:20:38 +01:00
CONTRIBUTING.md	Add links to polybar collective (#2318 )	2020-12-21 16:27:04 +01:00
LICENSE	init(git): Base commit	2016-05-19 20:23:45 +02:00
README.md	Cleanup Getting Started Section (#2339 )	2020-12-31 12:51:56 +01:00
SUPPORT.md	Add debugging guide to SUPPORT.md	2020-11-26 21:00:40 +01:00
version.txt	Release 3.5.4	2021-01-07 13:44:30 +01:00

README.md

A fast and easy-to-use tool for creating status bars.

Documentation | Installation | Support | Donate

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:

You can find polybar configs for these example images (and other configs) here.

Introduction
Getting Help
Contributing
Getting started
Community
Contributors
Donations
- Sponsors
- Backers
License

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

Installation

Polybar is already available in the package manager for many repositories. We list some of the more prominent ones here. Also click the image on the right to see a more complete list of available polybar packages.

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 Ubuntu 20.10 (Groovy Gorilla) or later, you can install polybar using sudo apt install polybar.

If you are using Arch Linux, you can install the AUR package polybar to get the latest version, or polybar-git for the most up-to-date (unstable) changes.

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 Tumbleweed, polybar is available from the official repositories and can be installed via zypper install polybar.

If you are using openSUSE Leap, polybar is available from OBS. The package is available for openSUSE Leap 15.1 and above.

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.

If you can't find your distro here, you will have to build from source.

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:

WARNING: This will overwrite your current configuration file!

$ 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)

Note: This example file is meant to showcase available modules and configuration options. Running it as-is will work but many modules will likely not start because they require machine-specific configuration and many of the font icons will not show up because they require a very specific font configuration. We encourage you to use it as a reference when building your own configuration.