polybar/README.md

171 lines
6.5 KiB
Markdown
Raw Normal View History

2018-05-27 07:37:56 +00:00
![Polybar](banner.png)
2016-05-19 14:41:06 +00:00
2016-11-19 05:22:44 +00:00
[![Build Status](https://travis-ci.org/jaagr/polybar.svg?branch=master)](https://travis-ci.org/jaagr/polybar)
[![Coverage Status](https://codecov.io/gh/jaagr/polybar/branch/master/graph/badge.svg)](https://codecov.io/gh/jaagr/polybar/branch/master)
2018-05-09 12:19:23 +00:00
[![MIT License](https://img.shields.io/github/license/jaagr/polybar.svg)](https://github.com/jaagr/polybar/blob/master/LICENSE)
2016-10-12 03:35:33 +00:00
A fast and easy-to-use tool for creating status bars.
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
[![sample screenshot](http://i.imgur.com/xvlw9iHt.png)](http://i.imgur.com/xvlw9iH.png)
[![sample screenshot](http://i.imgur.com/cYQOuRrt.png)](http://i.imgur.com/cYQOuRr.png)
[![sample screenshot](http://i.imgur.com/A6spiZZt.png)](http://i.imgur.com/A6spiZZ.png)
[![sample screenshot](http://i.imgur.com/TY5a5r9t.png)](http://i.imgur.com/TY5a5r9.png)
If you need help, check out the [Support](SUPPORT.md) page.
2017-01-14 12:16:20 +00:00
Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new) here on GitHub.
Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`.
2016-06-29 02:44:55 +00:00
## Table of Contents
* [Introduction](#introduction)
* [Getting started](#getting-started)
* [Dependencies](#dependencies)
* [Building from source](#building-from-source)
* [Configuration](#configuration)
* [Running](#running)
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/)
- [ALSA](http://www.alsa-project.org/main/index.php/Main_Page) volume controls
- 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...
2016-11-19 05:22:44 +00:00
[See the wiki for more details](https://github.com/jaagr/polybar/wiki).
2016-11-18 17:56:15 +00:00
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>
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. If you create a package for any other distribution, please consider contributing the template.
2016-06-23 23:14:43 +00:00
2017-04-26 16:41:41 +00:00
If you are using **Void Linux**, you can install [polybar](https://github.com/voidlinux/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 **Ubuntu**, polybar is available from the [GetDeb](http://www.getdeb.net/app/Polybar) repository.
2017-07-04 15:34:00 +00:00
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
If you are using **openSUSE**, polybar is available from [OBS](https://build.opensuse.org/package/show/home:sysek/polybar) repository. For now package is only for Tumbleweed.
2018-04-18 11:27:30 +00:00
If you are using **FreeBSD**, polybar can be installed using `pkg install polybar`. Make sure you are using the `latest` package branch.
2018-05-05 02:40:05 +00:00
If you are using **Gentoo**, both release and git-master versions are available in the main repository.
2016-06-29 02:44:55 +00:00
### Dependencies
A compiler with C++14 support ([clang-3.4+](http://llvm.org/releases/download.html), [gcc-5.1+](https://gcc.gnu.org/releases.html)).
2017-01-24 07:49:27 +00:00
- cairo
- libxcb
- python2
2016-12-15 17:22:50 +00:00
- xcb-proto
2017-01-20 01:54:06 +00:00
- xcb-util-image
2016-12-15 17:22:50 +00:00
- xcb-util-wm
2017-01-20 01:33:41 +00:00
- xcb-util-xrm
2016-06-23 23:14:43 +00:00
**Optional dependencies:**
- xcb-util-cursor *required for the `cursor-click` and `cursor-scroll` settings*
**Optional dependencies for extended module support:**
- alsa-lib *required by `internal/alsa`*
- libpulse *required by `internal/pulseaudio`*
- i3-wm *required by `internal/i3`*
2017-01-24 07:49:27 +00:00
- jsoncpp *required by `internal/i3`*
- libmpdclient *required by `internal/mpd`*
- libcurl *required by `internal/github`*
- wireless_tools *required by `internal/network`*
2016-06-23 23:14:43 +00:00
2017-01-14 12:16:20 +00:00
Find a more complete list on the [dedicated wiki page](https://github.com/jaagr/polybar/wiki/Compiling).
2016-06-29 02:44:55 +00:00
### Building from source
2016-05-24 02:06:29 +00:00
2016-11-19 05:22:44 +00:00
Please [report any problems](https://github.com/jaagr/polybar/issues/new) you run into when building the project.
2016-06-29 02:44:55 +00:00
~~~ sh
Release 3.1.0 (#863) Breaking Changes: * Date module no longer supports non-padded specifiers (i.e. `%-d`) and potentially other specifiers, see #792 - Check http://en.cppreference.com/w/cpp/io/manip/put_time to see supported specifiers * Setting background color to `background-0` with gradients (refer to https://github.com/jaagr/polybar/wiki/Known-Issues) Changelog: Features: * Feat(mpd): State-specific formats (`format-playing`, `format-paused`, `format-stopped`) (#567), see #524 * Feat(ipc): Visibility commands (show, hide, toggle, restart, quit) (b6c5563) * Feat(shell): Bash completion (#588) * Feat(menu): `expand-right` option (#658), see #655 * Feat(temperature): hwmon sysfs support (#688), see #404 * Feat(cursor): Change cursors over clickable/scrollable areas (#727), see #721 * Feat(temperature): Fahrenheit and Celsius tokens (#804) * Feat(mpd): Use mpd name tag or URI as fallback for title-less tracks (#823), see #815 Fixes: * Fix(i3): Clicking workspaces without index (#521), see #520 * Fix(parser): Prefix options overriding format options (#729), see #544 * Fix(parser): Overline tags (eebf105) * Fix(process_util): Prefix shell environment variable (`$POLYBAR_SHELL`) (86ff947), see #566 * Fix(parser): `%{R}` tag (reverse colors) (0bd8f1f), see #585 * Fix(renderer): Center block position with tray (389bae2 & #673), see #551 & #672 * Fix(xworkpaces): Active workspace with XMonad (#587), see #411 & #535 * Fix(config): Expand tilde, environment variable (d3b0670 & #724), see #603 & #719 * Fix(build): Remove curlbuild.h (#648), see #647 * Fix(renderer): Off by one error for actions (#663), see #661 * Fix(gcc): GCC 7.1 ([jaagr/xpp/#6](https://github.com/jaagr/xpp/pull/6)) * Fix(fs): Use `bytes_available` for `percentage_used` (138f5fa), see #710 * Fix(fs): Use `f_frsize` for calculations (a682d2a) * Fix(date): Remove date string length limitation (#745), see #754 * Fix(renderer): Nested actions (#772), see #760 and #758 * Fix(i3): Check and warn if current workspace not found (#826), see #824 * Fix(github): Prevent module disappearing with no connection (#811), see #810 * Fix(renderer): Module gradients (#831), see #759 * Fix(build): Update deprecated jsoncpp Reader
2017-12-03 17:03:49 +00:00
$ git clone --branch 3.1.0 --recursive https://github.com/jaagr/polybar
2016-11-19 05:22:44 +00:00
$ mkdir polybar/build
$ cd polybar/build
2017-01-14 12:16:20 +00:00
$ cmake ..
2016-06-29 02:44:55 +00:00
$ sudo make install
~~~
2016-05-24 02:06:29 +00:00
2016-11-12 12:54:27 +00:00
There's also a helper script available in the root folder:
2016-05-24 02:06:29 +00:00
2016-11-12 12:54:27 +00:00
~~~ sh
$ ./build.sh
~~~
2016-11-12 12:54:27 +00:00
### Configuration
2016-11-19 05:22:44 +00:00
Details on how to setup and configure the bar and each module have been moved to [the wiki](https://github.com/jaagr/polybar/wiki/Configuration).
2017-01-14 12:16:20 +00:00
#### Install the example configuration
2016-11-12 12:54:27 +00:00
~~~ sh
$ make userconfig
2017-01-14 12:16:20 +00:00
~~~
#### Launch the example bar
~~~ sh
2016-11-19 05:22:44 +00:00
$ polybar example
~~~
### Running
2016-11-25 06:32:57 +00:00
[See the wiki for details on how to run polybar](https://github.com/jaagr/polybar/wiki).
2016-06-29 02:44:55 +00:00
2018-05-27 09:11:50 +00:00
## Contributors
### Owner
* Michael Carlberg [**@jaagr**](http://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/jaagr/polybar/graphs/contributors)
2016-06-29 02:44:55 +00:00
## License
2016-11-19 05:22:44 +00:00
Polybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/jaagr/polybar/blob/master/LICENSE).