pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A polybar with dwm
1,558 Commits 1 Branch 0 Tags 9.9 MiB
C++ 94.7%
CMake 4%
Shell 1.1%
Python 0.1%
Vim Script 0.1%
928cd92a4f
Go to file
patrick96 928cd92a4f refactor(builder): Don't track raw tags 
When adding a string to the builder directly, it would parse the string
for formatting tags, delete them and readd them with the methods in the
builder that keep track of open tags so that we can properly close them
when flushing.

This parser has a bug, it parses multiple formatting tags in a single
block as a single tag, e.g.

  %{F#000000 u#FFFFFF +u}

would be parsed as an `F` tag with value `#000000 u#FFFFFF +u` which is
of course wrong.

Removing the parsing step fixes this problem in the simplest way
possible. This has two benefits:
* Building of modules is sped up because we don't have to do the parsing
step in the builder and many modules use this function to add strings
from a progressbar (which already has properly closed tags).
* We don't have parser logic in two places. Until now both `parser.cpp`
and `builder.cpp` actually parsed formatting tags. This leads to a lot
of code duplication and, as we've seen, bugs.

All of the modules that use this function to add text already make sure
that they properly close formatting tags (mostly by using the builder to
generate the strings)

NOTE: This change slightly changes polybar's behavior. Raw tags (tags
added by the user through the config) can now have their effects reach
neighboring modules because the builder doesn't track and thus doesn't
close them on each flush. This can (and will) be resolved by resetting
all tags at module borders.

Fixes #1555
2019-08-06 21:36:20 +02:00
.github/ISSUE_TEMPLATE Clearly separate issue and bug reports 2019-03-13 21:03:28 +01:00
cmake build: Remove pulseaudio binary dependency check 2019-07-31 00:37:05 +02:00
common build: Remove -Werror 2019-05-08 12:23:48 +02:00
contrib build: Remove pulseaudio binary dependency check 2019-07-31 00:37:05 +02:00
doc cmake: Use GNUInstallDirs (#1818) 2019-06-24 18:08:59 +02:00
include builder: Simplify open tag tracking 2019-08-06 21:36:20 +02:00
lib build: remove xdamage extension 2019-06-03 00:46:12 +02:00
src refactor(builder): Don't track raw tags 2019-08-06 21:36:20 +02:00
tests config_parser: Introduce stricter syntax conventions (#1377) 2019-08-06 19:41:31 +02:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy refactor(clang-tidy): Clean up .clang-tidy 2018-05-20 16:37:18 -07:00
.codecov.yml coverage: Allow small drops in coverage 2018-11-30 11:55:31 -08:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02:00
.gitignore build: create config even when docs are disabled 2019-04-24 08:11:27 +02:00
.gitmodules migration: Update submodule URLs 2019-05-08 12:20:33 +02:00
.travis.yml travis: create an irc one-liner (#1846) 2019-08-04 17:39:05 +02:00
.valgrind-suppressions refactor(x11): Merge xlib/xutils with connection 2016-12-31 10:02:32 +01:00
.ycm_extra_conf.py ycm: Remove -Werror from ycm flags 2018-07-30 14:12:22 +02:00
banner.png Add polybar banner 2018-05-27 09:37:56 +02:00
build.sh build: Remove C compiler 2019-04-08 09:01:48 +02:00
CMakeLists.txt cmake: Use GNUInstallDirs (#1818) 2019-06-24 18:08:59 +02:00
config.cmake config: Remove bspwm variable references 2019-06-02 15:36:26 +02:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
README.md migration: Update URLs 2019-05-08 12:20:33 +02:00
SUPPORT.md migration: Update URLs 2019-05-08 12:20:33 +02:00
version.txt Release 3.4.0 2019-07-24 15:42:04 +02:00

README.md

Polybar

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:

sample screenshot sample screenshot sample screenshot sample screenshot

You can find polybar configs for these example images (and other configs) here.

If you need help, check out the Support page.

Please report any bugs you find by creating an issue ticket here on GitHub. Make sure you include steps on how to reproduce it.

Table of Contents

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 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.

Getting started

Packaging status

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 create a package for any other distribution, please consider contributing the template.

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 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.

Dependencies

A compiler with C++14 support (clang-3.4+, gcc-5.1+), cmake 3.1+, git

  • cairo
  • libxcb
  • python2
  • xcb-proto
  • xcb-util-image
  • xcb-util-wm

Optional dependencies:

  • 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
  • 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

Find a more complete list on the dedicated wiki page.

Building from source

Please report any problems you run into when building the project.

Download the polybar-<version>.tar for the version you want to build from the release page, extract it with tar xvf polybar-<version>.tar and go into the extracted folder. There, run the following commands:

$ mkdir build
$ cd build
$ cmake ..
$ make -j$(nproc)
$ sudo make install

There's also a helper script available in the root folder:

$ ./build.sh

For more info, have a look at the Compiling wiki page.

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)

Launch the example bar

$ polybar example

Running

See the wiki for details on how to run polybar.

Community

Want to get in touch?

  • We have our own subreddit at r/polybar.
  • Chat with us in the #polybar IRC channel on the chat.freenode.net server.

Contributors

Owner

Maintainers

Logo Design by

All Contributors

License

Polybar is licensed under the MIT license. See LICENSE for more information.