polybar/README.md

160 lines
7.3 KiB
Markdown
Raw Normal View History

2018-11-11 14:18:36 +00:00
<p align="center">
<img src="banner.png" alt="Polybar">
2018-11-11 14:18:36 +00:00
</p>
2018-11-11 14:18:36 +00:00
<p align="center">
2016-10-12 03:35:33 +00:00
A fast and easy-to-use tool for creating status bars.
2018-11-11 14:18:36 +00:00
</p>
<p align="center">
<a href="https://github.com/polybar/polybar/releases"><img src="https://img.shields.io/github/release/polybar/polybar.svg"></a>
<a href="https://travis-ci.com/polybar/polybar"><img src="https://travis-ci.com/polybar/polybar.svg?branch=master"></a>
2019-04-08 21:40:44 +00:00
<a href="https://polybar.readthedocs.io"><img src="https://readthedocs.org/projects/polybar/badge/?version=latest"></a>
<a href="https://gitter.im/polybar/polybar"><img src="https://badges.gitter.im/polybar/polybar.svg"></a>
<a href="https://codecov.io/gh/polybar/polybar/branch/master"><img src="https://codecov.io/gh/polybar/polybar/branch/master/graph/badge.svg"></a>
<a href="https://github.com/polybar/polybar/blob/master/LICENSE"><img src="https://img.shields.io/github/license/polybar/polybar.svg"></a>
<a href="https://www.codetriage.com/polybar/polybar"><img src="https://www.codetriage.com/polybar/polybar/badges/users.svg"></a>
2018-11-11 14:18:36 +00:00
</p>
2016-05-19 14:41:06 +00:00
2016-11-19 05:22:44 +00:00
**Polybar** aims to help users build beautiful and highly customizable status bars
2016-06-29 02:44:55 +00:00
for their desktop environment, without the need of having a black belt in shell scripting.
2017-01-20 07:15:55 +00:00
Here are a few screenshots showing you what it can look like:
2016-06-29 02:44:55 +00:00
2020-02-21 14:39:39 +00:00
[![sample screenshot](https://i.imgur.com/xvlw9iHt.png)](https://i.imgur.com/xvlw9iH.png)
[![sample screenshot](https://i.imgur.com/cYQOuRrt.png)](https://i.imgur.com/cYQOuRr.png)
[![sample screenshot](https://i.imgur.com/A6spiZZt.png)](https://i.imgur.com/A6spiZZ.png)
[![sample screenshot](https://i.imgur.com/TY5a5r9t.png)](https://i.imgur.com/TY5a5r9.png)
2016-06-29 02:44:55 +00:00
You can find polybar configs for these example images (and other configs) [here](https://github.com/jaagr/dots/tree/master/.local/etc/themer/themes).
2016-06-29 02:44:55 +00:00
## Table of Contents
* [Introduction](#introduction)
* [Getting Help](#getting-help)
2020-11-26 19:16:13 +00:00
* [Contributing](#contributing)
2016-06-29 02:44:55 +00:00
* [Getting started](#getting-started)
* [Installation](#installation)
* [Configuration](#configuration)
* [Running](#running)
* [Community](#community)
2018-05-27 09:11:50 +00:00
* [Contributors](#contributors)
2016-06-29 02:44:55 +00:00
* [License](#license)
## Introduction
2016-11-19 05:22:44 +00:00
The main purpose of **Polybar** is to help users create awesome status bars.
2017-01-20 07:15:55 +00:00
It has built-in functionality to display information about the most commonly used services.
2017-05-12 07:43:36 +00:00
Some of the services included so far:
2016-06-29 02:44:55 +00:00
2016-12-15 17:22:50 +00:00
- Systray icons
- Window title
2016-06-29 02:44:55 +00:00
- Playback controls and status display for [MPD](https://www.musicpd.org/) using [libmpdclient](https://www.musicpd.org/libs/libmpdclient/)
2020-11-26 19:16:13 +00:00
- [ALSA](https://www.alsa-project.org/main/index.php/Main_Page) and [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) volume controls
2016-06-29 02:44:55 +00:00
- Workspace and desktop panel for [bspwm](https://github.com/baskerville/bspwm) and [i3](https://github.com/i3/i3)
2016-12-15 17:22:50 +00:00
- Workspace module for [EWMH compliant](https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html#idm140130320786080) window managers
- Keyboard layout and indicator status
2016-06-29 02:44:55 +00:00
- 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
2016-11-18 17:56:15 +00:00
- Inter-process messaging
2016-06-29 02:44:55 +00:00
- And more...
[See the wiki for more details](https://github.com/polybar/polybar/wiki).
2016-11-18 17:56:15 +00:00
## Getting Help
If you find yourself stuck, have a look at our [Support](SUPPORT.md) page for resources where you can find help.
2016-06-29 02:44:55 +00:00
2020-11-26 19:16:13 +00:00
## Contributing
Read our [contributing guidelines](CONTRIBUTING.md) for how to get started with contributing to polybar.
2016-06-29 02:44:55 +00:00
## Getting started
2017-07-04 15:34:00 +00:00
<a href="https://repology.org/metapackage/polybar">
<img src="https://repology.org/badge/vertical-allrepos/polybar.svg" alt="Packaging status" align="right">
</a>
Polybar was already packaged for the distros listed below.
If you can't find your distro here, you will have to [build from source](https://github.com/polybar/polybar/wiki/Compiling).
If you are using **Debian** (unstable or testing), you can install [polybar](https://tracker.debian.org/pkg/polybar) using `sudo apt install polybar`.
If you are using **Debian** (buster/stable), you need to enable [backports](https://wiki.debian.org/Backports) and then install using `sudo apt -t buster-backports install polybar`.
2016-11-19 05:22:44 +00:00
If you are using **Arch Linux**, you can install the AUR package [polybar-git](https://aur.archlinux.org/packages/polybar-git/) to get the latest version, or
[polybar](https://aur.archlinux.org/packages/polybar/) for the latest stable release.
2016-06-23 23:14:43 +00:00
If you are using **Void Linux**, you can install [polybar](https://github.com/void-linux/void-packages/blob/master/srcpkgs/polybar/template) using `xbps-install -S polybar`.
2017-01-09 19:50:52 +00:00
2017-07-04 15:34:00 +00:00
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](https://slackbuilds.org/repository/14.2/desktop/polybar/) repository.
2018-02-02 13:15:29 +00:00
If you are using **Source Mage GNU/Linux**, polybar spell is available in test grimoire and can be installed via `cast polybar`.
2016-06-23 23:14:43 +00:00
2020-10-29 21:43:06 +00:00
If you are using **openSUSE**, polybar is available from [OBS](https://build.opensuse.org/package/show/X11:Utilities/polybar/) repository. Package is available for openSUSE Leap 15.1, openSUSE Leap 15.2 and Tumbleweed.
2018-04-18 11:27:30 +00:00
If you are using **FreeBSD**, [polybar](https://svnweb.freebsd.org/ports/head/x11/polybar/) can be installed using `pkg install polybar`. Make sure you are using the `latest` package branch.
2018-04-18 11:27:30 +00:00
If you are using **Gentoo**, both release and git-master versions are available in the [main](https://packages.gentoo.org/packages/x11-misc/polybar) repository.
2018-05-05 02:40:05 +00:00
If you are using **Fedora**, you can install [polybar](https://src.fedoraproject.org/rpms/polybar) using `sudo dnf install polybar`.
### Installation
The [compiling page](https://github.com/polybar/polybar/wiki/Compiling) on the
wiki describes all steps necessary to build and install polybar.
2016-11-12 12:54:27 +00:00
### Configuration
Details on how to setup and configure the bar and each module have been moved to [the wiki](https://github.com/polybar/polybar/wiki/Configuration).
2017-01-14 12:16:20 +00:00
#### Install the example configuration
Run the following inside the build directory:
~~~ sh
$ 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)
2017-01-14 12:16:20 +00:00
#### Launch the example bar
~~~ sh
2016-11-19 05:22:44 +00:00
$ polybar example
~~~
### Running
[See the wiki for details on how to run polybar](https://github.com/polybar/polybar/wiki).
2016-06-29 02:44:55 +00:00
## Community
Want to get in touch?
* Join our Gitter room at [gitter.im/polybar/polybar](https://gitter.im/polybar/polybar)
* We have our own subreddit at [r/polybar](https://www.reddit.com/r/polybar).
* Chat with us in the `#polybar` IRC channel on the `chat.freenode.net` server.
2018-05-27 09:11:50 +00:00
## Contributors
### Owner
2020-02-21 14:39:39 +00:00
* Michael Carlberg [**@jaagr**](https://github.com/jaagr/)
2018-05-27 09:11:50 +00:00
### Maintainers
* [**@NBonaparte**](https://github.com/NBonaparte)
* Chase Geigle [**@skystrife**](https://github.com/skystrife)
* Patrick Ziegler [**@patrick96**](https://github.com/patrick96)
### Logo Design by
* [**@Tobaloidee**](https://github.com/Tobaloidee)
### [All Contributors](https://github.com/polybar/polybar/graphs/contributors)
2016-06-29 02:44:55 +00:00
## License
Polybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/polybar/polybar/blob/master/LICENSE).