polybar/README.md

187 lines
7.4 KiB
Markdown
Raw Normal View History

2018-11-11 14:18:36 +00:00
<p align="center">
<img src="banner.png" alt="Polybar">
</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/jaagr/polybar/releases"><img src="https://img.shields.io/github/release/jaagr/polybar.svg"></a>
<a href="https://travis-ci.org/jaagr/polybar"><img src="https://travis-ci.org/jaagr/polybar.svg?branch=master"></a>
<a href="https://codecov.io/gh/jaagr/polybar/branch/master"><img src="https://codecov.io/gh/jaagr/polybar/branch/master/graph/badge.svg"></a>
<a href="https://github.com/jaagr/polybar/blob/master/LICENSE"><img src="https://img.shields.io/github/license/jaagr/polybar.svg"></a>
</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
[![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)
You can find polybar configs for these example images (and other configs) [here](https://github.com/jaagr/dots/tree/master/.local/etc/themer/themes).
If you need help, check out the [Support](SUPPORT.md) page.
Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new/choose) here on GitHub.
2017-01-14 12:16:20 +00:00
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>
Polybar was already packaged for the distros listed below.
If you can't find your distro here, you will have to [build from source](#building-from-source).
If you create a package for any other distribution, please consider contributing the template.
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
If you are using **openSUSE**, polybar is available from [OBS](https://build.opensuse.org/package/show/home:sysek/polybar) repository. Package is available for openSUSE Leap 15 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
2016-06-29 02:44:55 +00:00
### Dependencies
2018-06-18 11:48:52 +00:00
A compiler with C++14 support ([clang-3.4+](http://llvm.org/releases/download.html), [gcc-5.1+](https://gcc.gnu.org/releases.html)), [cmake 3.1+](https://cmake.org/download/), [git](https://git-scm.com/downloads)
2018-09-16 19:21:50 +00:00
- `cairo`
- `libxcb`
- `python2`
- `xcb-proto`
- `xcb-util-image`
- `xcb-util-wm`
2016-06-23 23:14:43 +00:00
**Optional dependencies:**
2018-09-16 19:21:50 +00:00
- `xcb-util-cursor` *required for the `cursor-click` and `cursor-scroll` settings*
- `xcb-util-xrm` *required for accessing X resources with `${xrdb:...}`*
**Optional dependencies for extended module support:**
- `xcb-xkb` *required by `internal/xkeyboard`*
2018-09-16 19:21:50 +00:00
- `alsa-lib` *required by `internal/alsa`*
- `libpulse` *required by `internal/pulseaudio`*
- `i3-wm` *required by `internal/i3`*
- `jsoncpp` *required by `internal/i3`*
- `libmpdclient` *required by `internal/mpd`*
- `libcurl` *required by `internal/github`*
- `libnl-genl` or `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
Please [report any problems](https://github.com/jaagr/polybar/issues/new/choose) you run into when building the project.
2016-06-29 02:44:55 +00:00
~~~ sh
Release 3.3.0 (#1543) ### Breaking Changes: None ### Changelog **New Config Options** The following config options were added In the `[settings]` section: * `pseudo-transparency` In `internal/cpu`: * `ramp-coreload-spacing`, spacing between elements in `<ramp-coreload>` elements * `%percentage-sum%` in `label`. Shows sum of all percentages In `custom/script`: * `double-click-left` * `double-click-middle` * `double-click-right` In `internal/pulseaudio`: * `interval`, volume increase and decrease steps in percentage points In `internal/memory`: * `bar-swap-used` * `bar-swap-free` * `ramp-swap-used` * `ramp-swap-free` **Deprecations** * `tray-transparent` in the bar section is no longer used. The tray now always uses pseudo-transparency **Features** * volume: adjustable volume steps (#1364), see #1361 * memory: Add progress bars and ramps for swap (#1325) * render: pseudo-transparency (always used in the tray) (#595) * cpu: * Configurable spacing in between coreloads (#1472), see #1389 * Non-normalized cpu load (#1517), see #1516 * script: Double click actions (#1442) * net: Support for bridge interfaces (#1528), see #1522 * token: zero pad tokens when min-width value starts with a `0` (#1341), see #1332 **Fixes** * config: Use font patterns detected on system in sample config (#1350) * net: Disconnected module when SSID is only an emoji (#1371), see #1367 * tray: Tray overlapping with bar (#1392), see #591 * build: Several build errors (#1395, #1454, #1470, jaagr/xpp#12, #1493), see #1447, #1469, #750, #1492 * mpd: format-online-prefix not working (#1402), see #1399 * font: Crash for some font-patterns (#1451), see #1435 * script: * Only `%counter%` or `%pid%` token usable, never both (#1456) * click actions with colons in them (#1457), see #984 * renderer: Bar locks up when xorg composite extension is disabled (#1430), see #1425
2018-12-23 20:36:30 +00:00
$ git clone --branch 3.3 --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
~~~
For more info, have a look at the [Compiling wiki page](https://github.com/jaagr/polybar/wiki/Compiling).
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
Run the following inside the build directory:
~~~ 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).