polybar/README.md

131 lines
4.7 KiB
Markdown
Raw Normal View History

2016-11-19 05:22:44 +00:00
# Polybar
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)
[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000?style=plastic)](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)
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)
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.
2016-12-15 17:22:50 +00:00
Some of the batteries 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
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-01-09 19:50:52 +00:00
If you are using **Void Linux**, there's a [xbps template available](https://github.com/jaagr/void-packages/blob/polybar/srcpkgs/polybar/template) that you could use to build the project.
A [pull-request has been submitted](https://github.com/voidlinux/void-packages/pull/5192) but it is still not merged into the official repositories so I wouldn't hold my breath.
2016-06-23 23:14:43 +00:00
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
2016-12-15 17:22:50 +00:00
Optional dependencies for extended module support:
2017-01-24 07:49:27 +00:00
- alsa-lib *required by `internal/volume`*
- 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
2017-02-05 13:09:43 +00:00
$ git clone --branch 3.0.4 --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
## 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).