A fast and easy-to-use status bar
Go to file
Vincent Bernat 151a263654
fix(monitor): do not include outputs when monitors are supported (#2485)
* fix(monitor): do not include outputs when monitors are supported

Previously, when splitting an output into two monitors, `polybar -m`
would report both the splitted monitors and the output. This was not
caught by the the clone detection as the detection works by removing
monitors contained into another monitors (and monitors were excluded
from that logic) and we want the other way around: outputs covered by
monitors should be ignored.

Instead of trying to detect covered outputs, the solution is quite
simple: when monitors are supported, do not consider outputs, unless
we request all outputs. A monitor can be set primary (and RandR
reports primary outputs as primary monitors). The only information we
would miss from monitors are things like refresh rate and EDID. We
don't need that, so we are fine.

As monitors are only created for connected output (and they are in
this case "active") or disconnected output if they are mapped (and
they are in this case "inactive"), I am a bit unsure if we have
exactly the same behaviour as previously when `connected_only` is set
to `false`.

As some modules require an output, we keep the output in the
`monitor_t` structure and we ensure it is correctly set when using
monitors. A monitor can have 0 or several outputs. We only handle the
0 and 1 cases. When a monitor has more outputs, only the first one is
used. AFAIK, only the xbacklight module needs that and I think we are
fine waiting for a user needing this module and merging monitors.

The C++ binding fail to expose the `outputs()` method to iterate over
the outputs of a monitor. This seems to be a bug in XPP. The field is
correctly defined in the RandR XML file and it works with the Python
binding.

```xml
	<struct name="MonitorInfo">
		<field type="ATOM" name="name" />
		<field type="BOOL" name="primary" />
		<field type="BOOL" name="automatic" />
		<field type="CARD16" name="nOutput" />
		<field type="INT16" name="x" />
		<field type="INT16" name="y" />
		<field type="CARD16" name="width" /> <!-- pixels -->
		<field type="CARD16" name="height" /> <!-- pixels -->
		<field type="CARD32" name="width_in_millimeters" />
		<field type="CARD32" name="height_in_millimeters" />
		<list type="OUTPUT" name="outputs">
		    <fieldref>nOutput</fieldref>
		</list>
	</struct>
```

Falling back to C only to access the list of outputs is not enough
because the list is appended to the structure and not visible through
the public API. When copied, the structure loses the list of monitors.

Also, change the mention "XRandR monitor" to "no output" when there is
no output attached. People using monitors know what it means and it is
useful to catch a future regression where we don't have an output at
all (which would break the brightness plugin).

Fix #2481

* Update CHANGELOG.md

Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com>
2021-09-02 18:07:21 +02:00
.github CI: apt update before installing doc dependencies 2021-01-24 16:05:31 +01:00
cmake Use CMAKE_EXE_LINKER_FLAGS 2021-07-11 14:47:26 +02:00
common cmake: Stop using CMAKE_* variables for flags 2021-07-11 14:47:26 +02:00
config Add wm-restack=generic option that lowers polybar to the bottom of the stack (#2404) 2021-04-02 00:48:48 +02:00
contrib Update PKGBUILD for 3.5.6 2021-05-24 01:23:57 +02:00
doc feat(ipc): allow receiving arbitrary text on IPC socket (#2463) 2021-07-11 20:42:28 +02:00
include feat(ipc): allow receiving arbitrary text on IPC socket (#2463) 2021-07-11 20:42:28 +02:00
lib Fix i3 module assertion failure 2021-05-24 00:57:57 +02:00
src fix(monitor): do not include outputs when monitors are supported (#2485) 2021-09-02 18:07:21 +02:00
tests Use master branch for googletest (#2451) 2021-06-16 17:46:53 +02:00
.clang-format clang-format: Increase column limit 2016-11-12 13:07:05 +01:00
.clang-tidy Disable modernize-use-trailing-return-type warning 2020-08-12 11:01:44 +02:00
.codecov.yml codecov: Disable pull request annotations 2020-12-16 00:06:10 +01:00
.editorconfig Add trim_trailing_whitespace to .editorconfig 2017-09-24 08:31:42 +02:00
.gitignore cmake: Add option to enable/disable sample config 2020-12-24 02:20:38 +01:00
.gitmodules migration: Update submodule URLs 2019-05-08 12:20:33 +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
CHANGELOG.md fix(monitor): do not include outputs when monitors are supported (#2485) 2021-09-02 18:07:21 +02:00
CMakeLists.txt Cleanup 2020-12-24 02:20:38 +01:00
CONTRIBUTING.md Add links to polybar collective (#2318) 2020-12-21 16:27:04 +01:00
LICENSE init(git): Base commit 2016-05-19 20:23:45 +02:00
README.md Change over all IRC mentions to libera (#2450) 2021-06-16 17:02:58 +02:00
SUPPORT.md Change over all IRC mentions to libera (#2450) 2021-06-16 17:02:58 +02:00
banner.png Add polybar banner 2018-05-27 09:37:56 +02:00
build.sh Cleanup 2020-12-24 02:20:38 +01:00
version.txt Release 3.5.6 2021-05-24 01:00:50 +02:00

README.md

Polybar

A fast and easy-to-use tool for creating status bars.

GitHub All Releases

Documentation | Installation | Support | Donate

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.

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

Contributing

Read our contributing guidelines for how to get started with contributing to polybar.

Getting started

Installation

Packaging status

Polybar is already available in the package manager for many repositories. We list some of the more prominent ones here. Also click the image on the right to see a more complete list of available polybar packages.

If you are using Debian (unstable or testing), you can install polybar using sudo apt install polybar. If you are using Debian (buster/stable), you need to enable backports and then install using sudo apt -t buster-backports install polybar.

If you are using Ubuntu 20.10 (Groovy Gorilla) or later, you can install polybar using sudo apt install polybar.

If you are using Arch Linux, you can install the AUR package polybar to get the latest version, or polybar-git for the most up-to-date (unstable) changes.

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 Tumbleweed, polybar is available from the official repositories and can be installed via zypper install polybar.

If you are using openSUSE Leap, polybar is available from OBS. The package is available for openSUSE Leap 15.1 and above.

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.

If you are using Fedora, you can install polybar using sudo dnf install polybar.

If you can't find your distro here, you will have to build from source.

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:

WARNING: This will overwrite your current configuration file!

$ 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)

Note: This example file is meant to showcase available modules and configuration options. Running it as-is will work but many modules will likely not start because they require machine-specific configuration and many of the font icons will not show up because they require a very specific font configuration. We encourage you to use it as a reference when building your own configuration.

Launch the example bar

$ polybar example

Running

See the wiki for details on how to run polybar.

Community

Want to get in touch?

Contributors

Owner

Maintainers

Logo Design by

All Contributors

Donations

Polybar accepts donations through open collective.

Become a backer and support polybar!

Sponsors

Backers

License

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