polybar/README.md at c24a6999a4700a436c66fb5a89f3df1c708e486a

PolytreeDE/polybar

Fork 0

mirror of https://github.com/polybar/polybar.git synced 2024-11-11 13:50:56 -05:00

Patrick Ziegler 9d52408cad

Add links to polybar collective (#2318 )

2020-12-21 16:27:04 +01:00

19 KiB

Raw Blame History

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:

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

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)