update submodules

```

[module/pulseaudio]
type = internal/pulseaudio

; Source to be used, if it exists (find using `pacmd list-sources`, name field)
; If the source does not exist or the field is empty, uses the default Source.
; Can not be combined with sink, you need to instanciate 2 pulseaudio modules for that.
; If no sink or source field are specify, falling back to default sink.
source = alsa_output.pci-0000_12_00.3.analog-stereo

;
; [...]
;

```

.clang-format

@@ -1,13 +1,14 @@
 ---
 Language: Cpp
-Standard: Cpp11
+Standard: c++17
 BasedOnStyle: Google
 ColumnLimit: 120
-NamespaceIndentation: All
+NamespaceIndentation: Inner
 AlignAfterOpenBracket: DontAlign
 AllowShortFunctionsOnASingleLine: Empty
 AllowShortIfStatementsOnASingleLine: false
 BreakConstructorInitializersBeforeComma: true
 DerivePointerAlignment: false
 PointerAlignment: Left
+SpacesBeforeTrailingComments: 1
 ---

.clang-tidy

@@ -15,6 +15,8 @@ Checks: '
         modernize-*,
         -modernize-raw-string-literal,
         -modernize-use-bool-literals,
+        -modernize-use-trailing-return-type,
+        -readability-identifier-length,
         -readability-implicit-bool-cast,
         -readability-else-after-return,
         -readability-named-parameter,
@@ -25,26 +27,21 @@ Checks: '
         -cppcoreguidelines-pro-type-reinterpret-cast,
         -cppcoreguidelines-pro-type-union-access,
         -cppcoreguidelines-pro-type-cstyle-cast,
-        -cppcoreguidelines-pro-bounds-constant-array-index
+        -cppcoreguidelines-pro-bounds-constant-array-index,
+        -cppcoreguidelines-owning-memory,
         '
 
 CheckOptions:
-  - key:             modernize-loop-convert.NamingStyle
+  cppcoreguidelines-avoid-do-while.IgnoreMacros: true
-    value:           lower_case
+  modernize-loop-convert.NamingStyle: lower_case
-  - key:             readability-identifier-naming.GlobalConstantPrefix
+  readability-identifier-naming.ClassCase: lower_case
-    value:           'g_'
+  readability-identifier-naming.ClassConstantCase: UPPER_CASE
-  - key:             readability-identifier-naming.ClassCase
+  readability-identifier-naming.ClassMethodCase: lower_case
-    value:           lower_case
+  readability-identifier-naming.MemberCase: lower_case
-  - key:             readability-identifier-naming.ClassConstantCase
+  readability-identifier-naming.ProtectedMemberPrefix: 'm_'
-    value:           UPPER_CASE
+  readability-identifier-naming.PrivateMemberPrefix: 'm_'
-  - key:             readability-identifier-naming.ClassMethodCase
+  readability-simplify-boolean-expr.SimplifyDeMorgan: false
-    value:           lower_case
+
-  - key:             readability-identifier-naming.MemberCase
-    value:           lower_case
-  - key:             readability-identifier-naming.ProtectedMemberPrefix
-    value:           'm_'
-  - key:             readability-identifier-naming.PrivateMemberPrefix
-    value:           'm_'
 HeaderFilterRegex: ''
 WarningsAsErrors: ''
 AnalyzeTemporaryDtors: false

.codecov.yml

@@ -1,6 +0,0 @@
-ignore:
-  - "tests/*"
-  - "lib/*"
-
-comment:
-  require_changes: true

.editorconfig

@@ -7,6 +7,9 @@ indent_style = space
 indent_size = 2
 charset = utf-8
 
+[*.py]
+indent_size = 4
+
 [Makefile]
 indent_style = tab
 indent_size = 2

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: polybar
+open_collective: polybar

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,39 +0,0 @@
----
-name: Bug or Issue Report
-about: Create a report to help us improve
-
----
-
-## Describe the issue
-*A clear and concise description of what the bug is.*
-
-**Expected behavior:**
-
-*A clear and concise description of what you expected to happen.*
-
-**Actual behavior:**
-
-*What actually happens*
-
-## To Reproduce
-*A minimal but complete config with which the problem occurs:*
-```dosini
-
-```
-*List any other steps needed to reproduce the issue besides starting polybar with the config you posted above.*
-
-## Polybar Log
-*Post everything polybar outputs to the terminal when you run it and the issue occurs below*
-```
-
-```
-
-## Screenshots
-*If applicable, add screenshots to help explain your problem.*
-
-## Environment:
-* WM:
-* Output of `polybar -vvv`:
-
-## Additional context
-*Add any other context that you think is necessary about the problem here.*

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,112 @@
+name: 🐞 Bug Report
+description: Create a report for something that misbehaves
+title: "[Bug]: "
+labels: ["bug", "needs confirmation"]
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: Please carefully go through this checklist and check each option.
+      options:
+        - label: I have read the appropriate section in the [contributing guidelines](https://github.com/polybar/polybar/blob/master/CONTRIBUTING.md)
+          required: true
+        - label: I believe this issue is a problem with polybar itself and not a misconfiguration on my part
+          required: true
+        - label: I have searched for other open and closed [issues](https://github.com/polybar/polybar/issues?q=is%3Aissue) that may have already reported this problem
+          required: true
+        - label: I have checked the [known issues](https://github.com/polybar/polybar/wiki/Known-Issues) page for this problem.
+          required: true
+        - label: I have followed the [debugging guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config) to narrow down the problem to a minimal config.
+          required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Any steps to take and commands to run to reproduce this issue.
+      placeholder: |
+        1. `polybar -c ... bar`
+        2. ...
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Minimal config
+      description: A minimal but **complete** config with which the problem occurs.
+      render: dosini
+      placeholder: |
+        [bar/example]
+        ...
+
+        [module/...]
+        ...
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Polybar log
+      description: Post everything polybar prints to the terminal when you run it and the issue occurs. If possible, run polybar with a higher log level (e.g. `trace` or `info`).
+      render: text
+      placeholder: |
+        notice: Parsing config file: ...
+        ...
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happens
+    validations:
+      required: true
+  - type: input
+    id: wm
+    attributes:
+      label: Window Manager and Version
+      placeholder: ex. i3-gaps 4.19.1
+    validations:
+      required: true
+  - type: input
+    id: distro
+    attributes:
+      label: Linux Distribution
+      placeholder: ex. Ubuntu 21.04
+    validations:
+      required: true
+  - type: textarea
+    id: version
+    attributes:
+      label: Polybar version
+      description: Output of `polybar -vvv`
+      render: text
+      placeholder: |
+        polybar 3.5.7
+
+        Features: +alsa +curl +i3 +mpd +network(libnl) +pulseaudio +xkeyboard
+
+        X extensions: +randr (+monitors) +composite +xkb +xrm +xcursor
+
+        Build type: Release
+        Compiler: /usr/bin/c++
+        Compiler flags: -D_FORTIFY_SOURCE=2 -march=x86-64 -mtune=generic -O2 -pipe -fno-plt -O3 -DNDEBUG -Wall -Wextra -Wpedantic -Wsuggest-override
+        Linker flags: -Wall -Wextra -Wpedantic -Wsuggest-override  -Wall -Wextra -Wpedantic -Wsuggest-override
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context / Screenshots
+      description: If applicable, add screenshots and additional context to explain your problem
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! :heart:

.github/ISSUE_TEMPLATE/build.md

@@ -1,31 +0,0 @@
----
-name: Build Issues
-about: Report issues while building polybar
-
----
-
-## Build Process
-*Describe how you build polybar, list the exact commands you are using:*
-
-
-
-**If you build polybar directly from this repository:**
-
-* Output of `git describe --tags`:
-
-**If you use some other way (like the AUR):**
-
-*List exactly where you are building from and which version you are building.*
-
-
-## Build Log
-*Post everything that is output to the terminal while building polybar below. This HAS to include the output of the `cmake` and `make` commands, if you used them.*
-```
-
-```
-
-## Environment:
-* Distro (with Version):
-
-## Additional context
-*Add any other context that you think is necessary about the problem here.*

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🙋 Ask a question
+    url: https://github.com/polybar/polybar/blob/master/SUPPORT.md
+    about: Have a look at our support resources and channels
+  - name: 💡 Feature request
+    url: https://github.com/polybar/polybar/discussions/categories/ideas
+    about: Suggest your idea over in Discussions
+  - name: 🛠️ Build Issues
+    url: https://github.com/polybar/polybar/discussions/categories/build-support
+    about: Get support when building polybar from source

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-## Is your feature request related to a problem? Please describe.
-*A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]*
-
-## Why does polybar need this feature?
-*Describe why this feature would be useful to a large percentage of users (You need to convince us).*
-
-## Describe the solution you'd like
-*A clear and concise description of how your solution would work. This includes possible config options that should be added.*
-
-## Describe alternatives you've considered
-*A clear and concise description of any alternative solutions or features you've considered, if any.*
-
-## Additional context
-*Add any other context or screenshots about the feature request here.*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!-- Please read our contributing guide before opening a PR: https://github.com/polybar/polybar/blob/master/CONTRIBUTING.md -->
+
+## What type of PR is this? (check all applicable)
+
+* [ ] Refactor
+* [ ] Feature
+* [ ] Bug Fix
+* [ ] Optimization
+* [ ] Documentation Update
+* [ ] Other: *Replace this with a description of the type of this PR*
+
+## Description
+<!--
+  Document user-facing changes in this PR (for example: new config options, changed behavior).
+
+  You can also motivate design decisions here.
+-->
+
+## Related Issues & Documents
+<!-- For example: Fixes #1234, Closes #6789 -->
+
+## Documentation (check all applicable)
+
+* [ ] This PR requires changes to the Wiki documentation (describe the changes)
+* [ ] This PR requires changes to the documentation inside the git repo (please add them to the PR).
+* [ ] Does not require documentation changes

.github/codecov.yml

@@ -0,0 +1,21 @@
+coverage:
+  status:
+    project:
+      default:
+        # Coverage can drop by 0.1% without failing the status
+        threshold: 0.1
+    patch:
+      default:
+        # Patches don't need test coverage
+        # TODO remove once we have proper testing infrastructure and documentation
+        target: 0
+
+ignore:
+  - "tests/**/*"
+  - "lib/**/*"
+
+comment:
+  require_changes: true
+
+github_checks:
+    annotations: false

.github/workflows/ci.yml

@@ -0,0 +1,166 @@
+name: CI
+on:
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: 'ref'
+        required: false
+  push:
+  pull_request:
+
+jobs:
+  docs:
+    runs-on: ubuntu-22.04
+    env:
+      COLOR: "ON"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.ref }}
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3-sphinx
+      - name: Build Documentation
+        run: |
+          mkdir -p build
+          cd build
+          cmake -DDISABLE_ALL=ON -DBUILD_DOC=ON -DSPHINX_FLAGS="-W" ..
+          make doc
+
+  ipc:
+    runs-on: ubuntu-22.04
+    env:
+      COLOR: "ON"
+    steps:
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libxcb-composite0-dev \
+            libxcb-ewmh-dev \
+            libxcb-icccm4-dev \
+            libxcb-image0-dev \
+            libxcb-randr0-dev \
+            libxcb-util0-dev \
+            libxcb1-dev \
+            libcairo2-dev \
+            python3-xcbgen \
+            libuv1-dev \
+            xcb-proto
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          ref: ${{ github.event.inputs.ref }}
+      - name: Build polybar-msg
+        run: |
+          mkdir -p build
+          cd build
+          cmake -DDISABLE_ALL=ON -DBUILD_POLYBAR_MSG=ON ..
+          make polybar-msg
+
+  build:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        cxx: [g++, clang++]
+        polybar_build_type: ["full"]
+        build_type: ["Release"]
+        include:
+          - cxx: g++
+            polybar_build_type: "tests"
+            build_type: "Coverage"
+          - cxx: g++
+            polybar_build_type: "minimal"
+            build_type: "Release"
+    env:
+      CXX: ${{ matrix.cxx }}
+      BUILD_TYPE: ${{ matrix.build_type }}
+      POLYBAR_BUILD_TYPE: ${{ matrix.polybar_build_type }}
+      POLYBAR_DIR: ${{ github.workspace }}
+      BUILD_DIR: "${{ github.workspace}}/build"
+      MAKEFLAGS: "-j4"
+      COLOR: "ON"
+    steps:
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libxcb-composite0-dev \
+            libxcb-ewmh-dev \
+            libxcb-icccm4-dev \
+            libxcb-image0-dev \
+            libxcb-randr0-dev \
+            libxcb-util0-dev \
+            libxcb1-dev \
+            libcairo2-dev \
+            python3-xcbgen \
+            libuv1-dev \
+            xcb-proto
+
+          if [ "$POLYBAR_BUILD_TYPE" != "minimal" ]; then
+            sudo apt-get install -y \
+              libxcb-xkb-dev \
+              libxcb-cursor-dev \
+              libxcb-xrm-dev \
+              i3-wm \
+              libcurl4-openssl-dev \
+              libjsoncpp-dev \
+              libasound2-dev \
+              libpulse-dev \
+              libnl-genl-3-dev \
+              libmpdclient-dev
+          fi
+
+          if [ "$POLYBAR_BUILD_TYPE" = "tests" ]; then
+            sudo apt-get install -y lcov
+          fi
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          ref: ${{ github.event.inputs.ref }}
+      - name: Summary
+        run: ./common/ci/summary.sh
+      - name: Configure
+        run: ./common/ci/configure.sh
+      - name: Build
+        run: |
+          cd "$BUILD_DIR"
+          make
+      - name: Collect initial coverage
+        if: ${{ matrix.polybar_build_type == 'tests' }}
+        run: |
+          lcov --capture --initial --no-external --directory . -o cov_base.info
+      - name: Tests
+        if: ${{ matrix.polybar_build_type == 'tests' }}
+        run: |
+          cd "$BUILD_DIR"
+          make check
+      - name: Collect coverage
+        if: ${{ matrix.polybar_build_type == 'tests' }}
+        run: |
+          lcov --capture --no-external --directory . -o cov_tests.info
+          lcov --add-tracefile cov_base.info --add-tracefile cov_tests.info -o cov_total.info
+          lcov --remove cov_total.info "${PWD}/build/*" "${PWD}/tests/*" "${PWD}/lib/*" -o cov.info
+      - name: Upload Coverage
+        if: ${{ matrix.polybar_build_type == 'tests' }}
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unittests
+          # We provide our own coverage files
+          disable_search: true
+          # Disable all plugins, we handle all preparations ourselves
+          plugins: noop
+          files: ./cov.info
+          fail_ci_if_error: true
+          verbose: true
+      - name: Upload Logs
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: cmake
+          path: |
+            build/CMakeFiles/CMakeError.log
+            build/CMakeFiles/CMakeOutput.log
+          retention-days: 5

.github/workflows/release.yml

@@ -0,0 +1,105 @@
+# Workflow For Releases
+#
+# Automatically creates and uploads a complete release archive for the given
+# release.
+name: Release Workflow
+
+# Is triggered when a new release is published or by hand
+# If triggered by hand, the release tag that this should target has to be
+# specified.
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release Tag'
+        required: true
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get Version
+        if: ${{ github.event.inputs.tag }} != ''
+        run: |
+          if [ ${{  github.event_name }} == 'workflow_dispatch' ]; then
+            echo "Manual Release Triggered"
+            RELEASE_TAG=${{ github.event.inputs.tag }}
+          else
+            echo "Automatic Release Triggered"
+            RELEASE_TAG=${GITHUB_REF#refs/tags/}
+          fi
+          echo "Publishing Version $RELEASE_TAG"
+          {
+            echo "RELEASE_TAG=$RELEASE_TAG"
+            echo "POLYBAR_DIR=polybar-$RELEASE_TAG"
+            echo "POLYBAR_ARCHIVE=polybar-$RELEASE_TAG.tar.gz"
+          } >> "$GITHUB_ENV"
+
+      # Checks out the target tag
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ env.RELEASE_TAG }}
+          submodules: true
+          path: ${{ env.POLYBAR_DIR }}
+
+      - name: Create Release Archive
+        run: |
+          find "$DIR" -type d -name ".git" -exec rm -rf {} \+
+          tar czf "$ARCHIVE" "$DIR"
+          echo "SHA256SUM=$(sha256sum "$ARCHIVE" | cut -d ' ' -f 1)" >> "$GITHUB_ENV"
+        env:
+          DIR: ${{ env.POLYBAR_DIR }}
+          ARCHIVE: ${{ env.POLYBAR_ARCHIVE }}
+
+      - name: Get Upload URL
+        id: get_upload_url
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const tag = '${{ env.RELEASE_TAG }}';
+            console.log(`Getting Upload URL for '${tag}'`);
+            const release = await github.rest.repos.getReleaseByTag({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              tag: tag
+            });
+            core.exportVariable('UPLOAD_URL', release.data.upload_url);
+            core.exportVariable('RELEASE_ID', release.data.id);
+            core.exportVariable('RELEASE_BODY', release.data.body);
+
+      - name: Upload Release Archive
+        id: upload_archive
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ env.UPLOAD_URL }}
+          asset_path: "./${{ env.POLYBAR_ARCHIVE }}"
+          asset_name: ${{ env.POLYBAR_ARCHIVE }}
+          asset_content_type: application/gzip
+
+      # Adds a download section to the beginning of the release body
+      - name: Update Release Body
+        uses: actions/github-script@v7
+        env:
+          # Existing release body, fetched in the get_upload_url step.
+          RELEASE_BODY: ${{ env.RELEASE_BODY }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fname = '${{ env.POLYBAR_ARCHIVE }}'
+            const url = '${{ steps.upload_archive.outputs.browser_download_url }}'
+            const hash = '${{ env.SHA256SUM }}'
+            let body = "## Download\n\n"
+            body += `[${fname}](${url}) (**sha256**: \`${hash}\`)\n\n`
+            body += process.env.RELEASE_BODY;
+
+            const release = await github.rest.repos.updateRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              release_id: '${{ env.RELEASE_ID}}',
+              body: body
+            });

.gitignore

@@ -1,11 +1,17 @@
-/build*
+/build
-/doc/config
-/include/settings.hpp
-/polybar
-/polybar-msg
 /tags
+/compile_commands.json
 *.bak
 *.pyc
 *.swp
 *.tmp
 .tags
+*.user
+
+# clangd
+/.cache
+
+polybar-*.tar
+*.cache
+
+.venv

.gitmodules

@@ -1,8 +1,8 @@
 [submodule "lib/i3ipcpp"]
 	path = lib/i3ipcpp
-	url = https://github.com/jaagr/i3ipcpp
+	url = https://github.com/polybar/i3ipcpp
-	branch = v0.7.0
+	branch = master
 [submodule "lib/xpp"]
 	path = lib/xpp
-	url = https://github.com/jaagr/xpp
+	url = https://github.com/polybar/xpp
-	branch = 1.4.0
+	branch = master

.hooks/pre-commit

@@ -1,27 +0,0 @@
-#!/bin/sh
-
-# Pass if the README.md isn't staged for commit
-test "$(git diff --staged README.md)" || exit 0
-
-# Redirect all output to stderr
-exec 1>&2
-
-# shellcheck disable=SC2016
-tag_prev=$(git tag -l | tail -2 | head -1)
-tag_curr=$(git tag -l | tail -1)
-
-# Pass if tags aren't defined
-[ "$tag_prev" ] || exit 0
-[ "$tag_curr" ] || exit 0
-
-sed -n "/${tag_prev}/q1" README.md
-
-# Pass if the previous tag wasn't found
-[ $? -eq 1 ] || exit 0
-
-echo
-echo "\033[36;1mNOTICE \033[37;1m**\033[0m Updating README.md with latest tag (\033[1m${tag_prev}\033[0m => \033[1m${tag_curr}\033[0m)"
-echo "          The change will be staged for commit..."
-echo
-
-sed -i "s/${tag_prev}/${tag_curr}/g" README.md

.readthedocs.yaml

@@ -0,0 +1,22 @@
+---
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: doc/requirements.txt

.travis.yml

@@ -1,101 +0,0 @@
-sudo: required
-dist: trusty
-language: cpp
-
-env:
-  global:
-    - JOBS=4
-    - MAKEFLAGS="-j ${JOBS}"
-    - POLYBAR_BUILD_TYPE="compile"
-
-# Build configurations can either not specify anything for 'addon' and use this
-# default list of packages. Or they can pick and choose which package groups to
-# install
-addons:
-  apt:
-    sources: &sources
-      - ubuntu-toolchain-r-test
-    packages:
-      - &gcc
-        - g++-5
-        - gcc-5
-      - &clang
-        - libstdc++-5-dev
-      - &base_deps
-        - libxcb-ewmh-dev
-        - libxcb-icccm4-dev
-        - libxcb-image0-dev
-        - libxcb-randr0-dev
-        - libxcb-util0-dev
-        - python-xcbgen
-        - xcb-proto
-      - &optional_deps
-        - libxcb-xkb-dev
-        - libxcb-cursor-dev
-        - libxcb1-dev
-        - xutils-dev
-        - i3-wm
-        - libasound2-dev
-        - libpulse-dev
-        - libcairo2-dev
-        - libiw-dev
-        - libmpdclient-dev
-
-script: source ${TRAVIS_BUILD_DIR}/common/travis/build.sh
-
-matrix:
-  include:
-    - compiler: clang
-      env: BUILD_TYPE=Release
-      addons: {apt: {sources: *sources, packages: [*clang, *base_deps, *optional_deps]}}
-
-    - compiler: gcc
-      env: BUILD_TYPE=Debug POLYBAR_BUILD_TYPE=tests BUILD_TESTS=ON
-      addons: {apt: {sources: *sources, packages: [*gcc, *base_deps, *optional_deps]}}
-      script: ${TRAVIS_BUILD_DIR}/common/travis/tests.sh
-      after_success:
-        - cd ${TRAVIS_BUILD_DIR}
-        - bash <(curl -s https://codecov.io/bash) -F unittests -a "-ap" -Z || echo "Codecov did not collect coverage reports"
-
-    - compiler: gcc
-      env: BUILD_TYPE=Release
-      addons: {apt: {sources: *sources, packages: [*gcc, *base_deps, *optional_deps]}}
-
-      # Minimal build, contains no optional dependencies. This makes sure that
-      # we properly remove files from compilation that depend on libraries that
-      # are not installed
-    - compiler: gcc
-      env: BUILD_TYPE=Release POLYBAR_BUILD_TYPE=minimal
-      addons: {apt: {sources: *sources, packages: [*gcc, *base_deps]}}
-
-cache:
-  ccache: true
-  apt: true
-  directories:
-    - ${TRAVIS_BUILD_DIR}/deps/xcb-util-xrm
-
-install:
-  - DEPS_DIR="${TRAVIS_BUILD_DIR}/deps"
-  - mkdir -p "${DEPS_DIR}" && cd "${DEPS_DIR}"
-  - source ${TRAVIS_BUILD_DIR}/common/travis/environment.sh
-  - source ${TRAVIS_BUILD_DIR}/common/travis/install_xcb_xrm.sh
-
-before_script:
-  - source ${TRAVIS_BUILD_DIR}/common/travis/summary.sh
-  - source ${TRAVIS_BUILD_DIR}/common/travis/configure.sh
-
-# Only fetch the newest 5 commits instead of 50
-git:
-  depth: 5
-
-notifications:
-  email: false
-  irc:
-    channels:
-      - "irc.freenode.org#polybar"
-    template:
-      - "%{author} pushed #%{commit} \"%{commit_subject}\" to %{repository_name}/%{branch}"
-      - "Build #%{build_number} %{result} / %{build_url} (diff: %{compare_url})"
-    use_notice: true
-    on_success: change
-    on_failure: change

.ycm_extra_conf.py

@@ -1,126 +0,0 @@
-import os
-import ycm_core
-
-# Default flags
-flags = [
-    '-std=c++14',
-    '-Wall',
-    '-Wextra',
-
-    # Relative paths are corrected by MakeRelativePathsInFlagsAbsolute
-    '-Isrc',
-    '-Iinclude',
-    '-Ilib/concurrentqueue/include',
-    '-Ilib/i3ipcpp/include',
-    '-Ilib/xpp/include',
-    '-Itests',
-
-    '-I/usr/include',
-    '-I/usr/include/freetype2',
-    ]
-
-# Base directory of the project, parent directory of all source files
-project_dir = os.path.dirname(os.path.abspath(__file__))
-
-# This assumes that everyone coding for this project builds inside the 'build'
-# directory
-compilation_database_folder = project_dir + "/build"
-
-if os.path.exists(compilation_database_folder):
-  database = ycm_core.CompilationDatabase(compilation_database_folder)
-else:
-  database = None
-
-SOURCE_EXTENSIONS = ['.cpp', '.cxx', '.cc', '.c', '.m', '.mm']
-
-# Converts all relative paths in the given flag list to absolute paths with
-# working_directory as the base directory
-def MakeRelativePathsInFlagsAbsolute(flags, working_directory):
-  if not working_directory:
-    return list(flags)
-  new_flags = []
-  make_next_absolute = False
-  path_flags = ['-isystem', '-I', '-iquote', '--sysroot=']
-  for flag in flags:
-    new_flag = flag
-
-    if make_next_absolute:
-      make_next_absolute = False
-      if not flag.startswith('/'):
-        new_flag = os.path.join(working_directory, flag)
-
-    for path_flag in path_flags:
-      if flag == path_flag:
-        make_next_absolute = True
-        break
-
-      if flag.startswith(path_flag):
-        path = flag[len(path_flag):]
-        new_flag = path_flag + os.path.join(working_directory, path)
-        break
-
-    if new_flag:
-      new_flags.append(new_flag)
-  return new_flags
-
-def IsHeaderFile(filename):
-  extension = os.path.splitext(filename)[1]
-  return extension in ['.h', '.hxx', '.hpp', '.hh', ".inl"]
-
-# Tries to query the compilation database for flags
-# For header files it tries to use the flags for a corresponding source file
-def GetCompilationInfoForFile(filename):
-  if not database:
-    return None
-
-  # The compilation_commands.json file generated by CMake does not have entries
-  # for header files. We try to use the compile flags used for the corresponding
-  # source file.
-  #
-  # For this try to replace the file extension with an extension that
-  # corresponds to a source and we also try to replace the 'include' folder in
-  # the path with 'src'
-  if IsHeaderFile(filename) :
-    basename = os.path.splitext(filename)[0]
-
-    # Absolute path of the include and source directories
-    include_dir = project_dir + "/include"
-    src_dir = project_dir + "/src"
-
-    # Absolute path without file extension, with the 'include' folder replaced
-    # with 'src' in the path
-    src_basename = None
-    # If the header file is inside the include dir, try to search in the src dir
-    if basename.startswith(include_dir):
-      # file path relative to include dir
-      rel_path_include = os.path.relpath(basename, include_dir)
-      src_basename = os.path.join(src_dir, rel_path_include)
-
-    for extension in SOURCE_EXTENSIONS:
-      # A list of all possible replacement files to be searched
-      replacement_files = [basename + extension]
-
-      if src_basename:
-        replacement_files.append(src_basename + extension)
-
-      for replacement_file in replacement_files:
-        if os.path.exists(replacement_file):
-          comp_info = database.GetCompilationInfoForFile(replacement_file)
-          if comp_info.compiler_flags_:
-            return comp_info
-  return database.GetCompilationInfoForFile(filename)
-
-def FlagsForFile(filename, **kwargs):
-  compilation_info = GetCompilationInfoForFile(filename)
-  if compilation_info and compilation_info.compiler_flags_:
-    # Bear in mind that compilation_info.compiler_flags_ does NOT return a
-    # python list, but a "list-like" StringVec object
-    final_flags = MakeRelativePathsInFlagsAbsolute(
-        [x for x in compilation_info.compiler_flags_ if x != "-Werror"],
-        compilation_info.compiler_working_dir_)
-  else:
-    # We use default flags if GetCompilationInfoForFile can't find any flags
-    relative_to = project_dir
-    final_flags = MakeRelativePathsInFlagsAbsolute(flags, relative_to)
-
-  return {'flags': final_flags, 'do_cache': True}

CHANGELOG.md

@@ -0,0 +1,285 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+Each release should have the following subsections, if entries exist, in the
+given order: `Breaking`, `Build`, `Deprecated`, `Removed`, `Added`, `Changed`,
+`Fixed`, `Security`.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- An option `unmute-on-scroll` for `internal/pulseaudio` and `internal/alsa` to unmute audio when the user scrolls on the widget.
+
+## [3.7.2] - 2024-08-17
+### Fixed
+- `custom/script`: When a script with `tail = true` received multiple lines quickly, only the first would get displayed ([`#3117`](https://github.com/polybar/polybar/issues/3117), [`#3119`](https://github.com/polybar/polybar/pull/3119)) by [@Isak05](https://github.com/Isak05)
+-  Token min-length calculations would behave differently when non-ASCII characters appear in the token ([`#3074`](https://github.com/polybar/polybar/issues/3074), [`#3087`](https://github.com/polybar/polybar/pull/3087)) by [@nklloyd](https://github.com/nklloyd)
+-  i3: Fix duplicated rendering for non-full-width bars ([`#3091`](https://github.com/polybar/polybar/pull/3091), [`#3060`](https://github.com/polybar/polybar/issues/3060))
+- `internal/backlight`: Module could display the literal `%percentage%` token if the backlight reports a value of 0 at startup ([`#3081`](https://github.com/polybar/polybar/pull/3081)) by [@unclechu](https://github.com/unclechu)
+- `internal/tray`: Fix crash during restarting, when tray icons were not removed proberly ([`#3111`](https://github.com/polybar/polybar/issues/3111), [`#3112`](https://github.com/polybar/polybar/pull/3112))
+- `custom/ipc`: Module would display the literal `%output%` token before the initial hook finished executing ([`#3131`](https://github.com/polybar/polybar/issues/3131), [`#3140`](https://github.com/polybar/polybar/pull/3140))
+- renderer: Pseudo-transparency rendering artifacts when wallpaper does not fill entire screen ([`#3096`](https://github.com/polybar/polybar/pull/3096), [`#3041`](https://github.com/polybar/polybar/issues/3041))
+
+## [3.7.1] - 2023-11-27
+### Build
+- Fixed missing header when using `libc++` in clang 15 and below
+
+### Changed
+- `internal/tray`: The module must use the `<tray>` tag (this is the default) ([`#3037`](https://github.com/polybar/polybar/pull/3037))
+
+### Fixed
+- Modules did not validate that all tags (e.g. `<label>`) used in a format were valid for that format ([`#3043`](https://github.com/polybar/polybar/issues/3043), [`#3045`](https://github.com/polybar/polybar/pull/3045))
+- `internal/tray`: Fixed `module-margin` and `separator` being applied to completely empty tray module ([`#3036`](https://github.com/polybar/polybar/issues/3036), [`#3037`](https://github.com/polybar/polybar/pull/3037))
+
+## [3.7.0] - 2023-11-05
+### Breaking
+- `custom/script`:
+  - No longer hides the module if the `exec` command failed and did not change the output from the previous run ([`#2636`](https://github.com/polybar/polybar/issues/2636)). Somewhat similar original behaviour can be imitated with `format-fail`, if necessary.
+  - If the `exec` command produced no output and exited with a non-zero exit code the module is no longer completely empty, but just has an empty `%output%` token. If you relied on this behavior to hide the module under certain circumstances, make sure the script exits with an exit code of zero. ([`#2857`](https://github.com/polybar/polybar/discussions/2857), [`#2861`](https://github.com/polybar/polybar/pull/2861))
+
+### Build
+- Respect `CMAKE_INSTALL_PREFIX` when installing default config ([`#2770`](https://github.com/polybar/polybar/pull/2770), [`#2917`](https://github.com/polybar/polybar/pull/2917))
+- Change default `CMAKE_INSTALL_PREFIX` to `/usr`. Installations with default flags will now go into `/usr` instead of `/usr/local` ([`#2917`](https://github.com/polybar/polybar/pull/2917))
+- Bump C++ version to C++17 ([`#2847`](https://github.com/polybar/polybar/pull/2847))
+
+### Deprecated
+- `custom/text`: The `content` setting and all its properties are deprecated in favor of `format` with the same functionality. ([`#2676`](https://github.com/polybar/polybar/pull/2676))
+- tray: All tray-related settings in the bar section are deprecated. They are replaced by the new tray module ([`#3002`](https://github.com/polybar/polybar/pull/3002))
+  - `tray-position`, `tray-detached`, `tray-maxsize`, `tray-scale`, `tray-transparent`, `tray-background`, `tray-foreground`, `tray-padding`, `tray-offset-x`, `tray-offset-y`
+
+### Added
+- A tray module with type `internal/tray` for positioning the tray like a module ([`#2689`](https://github.com/polybar/polybar/issues/2689))
+- `internal/temperature`: `%temperature-k%` token displays the temperature in Kelvin ([`#2774`](https://github.com/polybar/polybar/discussions/2774), [`#2784`](https://github.com/polybar/polybar/pull/2784))
+- `internal/pulseaudio`: `reverse-scroll` option ([`#2664`](https://github.com/polybar/polybar/pull/2664))
+- `custom/script`: Repeat interval for script failure (`interval-fail`) and `exec-if` (`interval-if`) ([`#943`](https://github.com/polybar/polybar/issues/943), [`#2606`](https://github.com/polybar/polybar/issues/2606), [`#2630`](https://github.com/polybar/polybar/pull/2630))
+- `custom/ipc`:
+  - Added support for `<label>` in `format` ([`#2841`](https://github.com/polybar/polybar/pull/2841)) by [@madhavpcm](https://github.com/madhavpcm).
+  - Added support for `format-i` for each defined `hook-i` ([`#2775`](https://github.com/polybar/polybar/issues/2775), [`#2810`](https://github.com/polybar/polybar/pull/2810)) by [@madhavpcm](https://github.com/madhavpcm).
+- `custom/text`: Loads the `format` setting, which supports the `<label>` tag, if the deprecated `content` is not defined ([`#1331`](https://github.com/polybar/polybar/issues/1331), [`#2673`](https://github.com/polybar/polybar/pull/2673), [`#2676`](https://github.com/polybar/polybar/pull/2676))
+- `internal/backlight`:
+  - `scroll-interval` option ([`#2696`](https://github.com/polybar/polybar/issues/2696), [`#2700`](https://github.com/polybar/polybar/pull/2700))
+  - `poll-interval` setting controls how often the module is updated (in case it does not happen when the brightness changes) ([`#2835`](https://github.com/polybar/polybar/issues/2835), [`#3028`](https://github.com/polybar/polybar/pull/3028))
+- `internal/temperature`: Added `zone-type` setting ([`#2572`](https://github.com/polybar/polybar/issues/2572), [`#2752`](https://github.com/polybar/polybar/pull/2752)) by [@xphoniex](https://github.com/xphoniex)
+- `internal/xwindow`: `%class%` and `%instance%` tokens, which show the contents of the `WM_CLASS` property of the active window ([`#2830`](https://github.com/polybar/polybar/pull/2830))
+- Added `enable-struts` option in bar section to enable/disable struts ([`#2769`](https://github.com/polybar/polybar/issues/2769), [`#2844`](https://github.com/polybar/polybar/pull/2844)) by [@VanillaViking](https://github.com/VanillaViking).
+- `wm-restack`:
+  - `bottom`: lowers polybar to the bottom of the window stack (same as the previous behavior of `generic`) ([`#2961`](https://github.com/polybar/polybar/pull/2961))
+  - `ewmh`: Tries to use the `_NET_SUPPORTING_WM_CHECK` hint to position the bar ([`#2961`](https://github.com/polybar/polybar/pull/2961))
+- `internal/xworkspaces`: `group-by-monitor` setting to decide whether `_NET_DESKTOP_VIEWPORT` should be used to group workspaces by monitor; ([`#2603`](https://github.com/polybar/polybar/issues/2603), [`#2926`](https://github.com/polybar/polybar/pull/2926)) by [@slotThe](https://github.com/slotThe/).
+
+### Changed
+- `custom/script`:
+  - No longer produces a completely empty module if the `exec` command failed. It only produces an empty module if the script had a zero exit code. ([`#2857`](https://github.com/polybar/polybar/discussions/2857), [`#2861`](https://github.com/polybar/polybar/pull/2861))
+  - Bumped the script polling interval (not related to the `interval` setting) to decrease wakeups. Polybar may take slightly longer to shut down. [`#2879`](https://github.com/polybar/polybar/pull/2879)
+- `internal/fs`: Use `/` as a fallback if no mountpoints are specified ([`#2572`](https://github.com/polybar/polybar/issues/2572), [`#2705`](https://github.com/polybar/polybar/pull/2705))
+- `internal/backlight`:
+  - Detect backlight if none specified ([`#2572`](https://github.com/polybar/polybar/issues/2572), [`#2728`](https://github.com/polybar/polybar/pull/2728))
+  - `use-actual-brightness` now always defaults to `true` (even for `amdgpu` backlights) ([`#2835`](https://github.com/polybar/polybar/issues/2835), [`2839`](https://github.com/polybar/polybar/pull/2839))
+- Providing a negative min-width to a token adds right-padding ([`#2789`](https://github.com/polybar/polybar/issues/2789), [`#2801`](https://github.com/polybar/polybar/pull/2801)) by [@VanillaViking](https://github.com/VanillaViking).
+- Changed fuzzy match option on i3 and bspwm modules to find longest match instead of the first match ([`#2831`](https://github.com/polybar/polybar/pull/2831), [`#2829`](https://github.com/polybar/polybar/issues/2829)) by [@Ron0Studios](https://github.com/ron0studios/).
+- `wm-restack`
+  - `generic`: Is now a best effort combination of other restacking strategies. First tries `ewmh` and then the `bottom` strategy ([`#2961`](https://github.com/polybar/polybar/pull/2961))
+  - `bspwm`: Will restack above the topmost bspwm root window instead of the root window associated with the monitor polybar is on ([`#3019`](https://github.com/polybar/polybar/pull/3019))
+
+### Fixed
+- Waiting for double click interval on modules that don't have a double click action ([`#2663`](https://github.com/polybar/polybar/issues/2663), [`#2695`](https://github.com/polybar/polybar/pull/2695))
+- renderer:
+  - Small gaps when rendering emojis ([`#2785`](https://github.com/polybar/polybar/issues/2785), [`#2802`](https://github.com/polybar/polybar/pull/2802))
+  - Crash when using pseudo-transparency with certain wallpapers ([`#2798`](https://github.com/polybar/polybar/issues/2798), [`#2813`](https://github.com/polybar/polybar/pull/2813))
+  - Crash when invalid UTF-8 text is encountered ([`#2091`](https://github.com/polybar/polybar/issues/2091), [`#2958`](https://github.com/polybar/polybar/pull/2958))
+- config:
+  - Error reporting for deprecated config values ([`#2724`](https://github.com/polybar/polybar/issues/2724))
+  - Also monitor include-files for changes when --reload is set ([`#675`](https://github.com/polybar/polybar/issues/675), [`#2759`](https://github.com/polybar/polybar/pull/2759))
+- `internal/xwindow`: module does not crash when a tag is not provided in format ([`#2826`](https://github.com/polybar/polybar/issues/2826), [`#2833`](https://github.com/polybar/polybar/pull/2833)) by [@VanillaViking](https://github.com/VanillaViking)
+- `internal/i3`: module errors when i3 has negative gaps ([`#2888`](https://github.com/polybar/polybar/issues/2888), [`#2889`](https://github.com/polybar/polybar/pull/2889))
+- `internal/backlight`: Fix module being one step behind every update ([`#2835`](https://github.com/polybar/polybar/issues/2835), [`#3028`](https://github.com/polybar/polybar/pull/3028))
+- `wm-restack = bspwm`: bar may become unclickable if there are overlapping monitors ([`#2873`](https://github.com/polybar/polybar/issues/2873), [`#2961`](https://github.com/polybar/polybar/pull/2961))
+
+## [3.6.3] - 2022-05-04
+### Fixed
+- `custom/script`: Output clearing when `exec-if` fails ([`#2674`](https://github.com/polybar/polybar/issues/2674))
+- `internal/battery`: `poll-interval` not working ([`#2649`](https://github.com/polybar/polybar/issues/2649), [`#2677`](https://github.com/polybar/polybar/pull/2677))
+- ipc: Polybar failing to open IPC channel after another user already ran polybar, if `XDG_RUNTIME_DIR` is not set ([`#2683`](https://github.com/polybar/polybar/issues/2683), [`#2684`](https://github.com/polybar/polybar/pull/2684))
+- No overlines/underlines being drawn when using offsets ([`#2685`](https://github.com/polybar/polybar/pull/2685))
+- Update struts (`_NET_WM_STRUT_PARTIAL`) when hiding the bar ([`#2702`](https://github.com/polybar/polybar/pull/2702))
+- `internal/pulseaudio`: Hanging during startup ([`#2707`](https://github.com/polybar/polybar/issues/2707), [`#2709`](https://github.com/polybar/polybar/pull/2709))
+- `internal/xworkspaces`: Updates of `_NET_DESKTOP_VIEWPORT` being ignored ([`#2693`](https://github.com/polybar/polybar/issues/2693), [`#2698`](https://github.com/polybar/polybar/pull/2698))
+
+## [3.6.2] - 2022-04-03
+### Fixed
+- `format-offset` being ignored ([`#2643`](https://github.com/polybar/polybar/pull/2643))
+- Negative struts (`margin-bottom`, `margin-top`) being ignored ([`#2642`](https://github.com/polybar/polybar/issues/2642), [`#2644`](https://github.com/polybar/polybar/pull/2644))
+- Positioning in awesomeWM ([`#2651`](https://github.com/polybar/polybar/pull/2651))
+- `internal/xworkspaces`: The module sometimes crashed polybar when windows were closed. ([`#2655`](https://github.com/polybar/polybar/pull/2655))
+- Mouseover error when only one cursor is defined ([`#2656`](https://github.com/polybar/polybar/pull/2656))
+- `custom/script`: Timing inconsistencies ([`#2650`](https://github.com/polybar/polybar/issues/2650), first described at [`#2630`](https://github.com/polybar/polybar/pull/2630))
+
+## [3.6.1] - 2022-03-05
+### Build
+- Fixed compiler warning in Clang 13 ([`#2613`](https://github.com/polybar/polybar/pull/2613))
+- Fixed compiler error in GCC 12 ([`#2616`](https://github.com/polybar/polybar/pull/2616), [`#2614`](https://github.com/polybar/polybar/issues/2614))
+- Fixed installation of docs when some are not generated (man, html...) ([`#2612`](https://github.com/polybar/polybar/pull/2612))
+- Fix `LDFLAGS` not being respected ([`#2619`](https://github.com/polybar/polybar/pull/2619))
+
+### Fixed
+- `tray-offset-x`, `tray-offset-y`, `offset-x`, and `offset-y` were mistakenly capped below at 0 ([`#2620`](https://github.com/polybar/polybar/pull/2620))
+- `custom/script`: Polybar shutdown being stalled by hanging script ([`#2621`](https://github.com/polybar/polybar/pull/2621))
+- `polybar-msg`: Wrong hint when using deprecated `hook` ([`#2624`](https://github.com/polybar/polybar/pull/2624))
+
+## [3.6.0] - 2022-03-01
+### Breaking
+- We added the backslash escape character (\\) for configuration values. This means that the literal backslash character now has special meaning in configuration files, therefore if you want to use it in a value as a literal backslash, you need to escape it with the backslash escape character. The parser logs an error if any unescaped backslashes are found in a value. This affects you only if you are using two consecutive backslashes in a config value, which will now be interpreted as a single literal backslash. ([`#2354`](https://github.com/polybar/polybar/issues/2354))
+- We rewrote our formatting tag parser. This shouldn't break anything, if you experience any problems, please let us know. The new parser now gives errors for certain invalid tags where the old parser would just silently ignore them. Adding extra text to the end of a valid tag now produces an error. For example, tags like `%{T-a}`, `%{T2abc}`, `%{rfoo}`, and others will now start producing errors. This does not affect you unless you are producing your own invalid formatting tags (for example in a script).
+- For security reasons, the named pipe at `/tmp/polybar_mqueue.<PID>` had its permission bits changed from `666` to `600` to prevent sending ipc messages to polybar processes running under a different user.
+- Also for security reasons, the `polybar-msg` command will now only send messages to polybar processes running under the same user. See the [IPC documentation](https://polybar.readthedocs.io/user/ipc.html) for what exactly this means.
+
+### Build
+- New dependency: [libuv](https://github.com/libuv/libuv). At least version 1.3 is required.
+- Bump the minimum cmake version to 3.5
+- The `BUILD_IPC_MSG` option has been renamed to `BUILD_POLYBAR_MSG`
+- Building the documentation is now enabled by default and not just when `sphinx-build` is found.
+- Users can control exactly which targets should be available with the following cmake options (together with their default value):
+  - `BUILD_POLYBAR=ON` - Builds the `polybar` executable
+  - `BUILD_POLYBAR_MSG=ON` - Builds the `polybar-msg` executable
+  - `BUILD_TESTS=OFF` - Builds the test suite
+  - `BUILD_DOC=ON` - Builds the documentation
+  - `BUILD_DOC_HTML=BUILD_DOC` - Builds the html documentation (depends on `BUILD_DOC`)
+  - `BUILD_DOC_MAN=BUILD_DOC` - Builds the manpages (depends on `BUILD_DOC`)
+  - `BUILD_CONFIG=ON` - Generates the default config
+  - `BUILD_SHELL=ON` - Generates shell completion files
+  - `DISABLE_ALL=OFF` - Disables all above targets by default. Individual targets can still be enabled explicitly.
+- The documentation can no longer be built by directly configuring the `doc` directory.
+- The `POLYBAR_FLAGS` cmake variable can be used to pass extra C++ compiler flags.
+- The sample config file has been removed.
+- Polybar now ships a default config that is installed to `/etc/polybar/config.ini`, it lives in `doc/config.ini`. It will also be placed in the `examples` directory in the documentation folder. ([`#2405`](https://github.com/polybar/polybar/issues/2405))
+- The `userconfig` target has been removed, you can no longer use `make userconfig`. As an alternative, you can copy the default config from `/etc/polybar/config.ini`.
+- The `DEBUG_SHADED` cmake variable and its associated functionality has been removed.
+
+### Deprecated
+- `[settings]`: `throttle-output` and `throttle-output-for` have been removed. The new event loop already does a similar thing where it coalesces update triggers if they happen directly after one another, leading to only a single bar update.
+- When not specifying the config file with `--config`, naming your config file `config` is deprecated. Rename your config file to `config.ini`.
+- Directly writing ipc messages to `/tmp/polybar_mqueue.<PID>` is deprecated, users should always use `polybar-msg`. As a consequence the message format used for IPC is deprecated as well.
+- `polybar-msg hook` is deprecated in favor of using the hook action. `polybar-msg` will tell you the correct command to use.
+
+### Added
+- Support `px` and `pt` units everyhwere where before only a number of spaces or pixels could be specified. ([`#2578`](https://github.com/polybar/polybar/pull/2578), [`#1651`](https://github.com/polybar/polybar/issues/1651), [`#951`](https://github.com/polybar/polybar/issues/951))
+- `internal/alsa`: Right and middle click settings. ([`#2566`](https://github.com/polybar/polybar/issues/2566), [`#2573`](https://github.com/polybar/polybar/pull/2573))
+- `internal/network`:
+  - New token `%mac%` shows MAC address of selected interface ([`#2568`](https://github.com/polybar/polybar/issues/2568), [`#2569`](https://github.com/polybar/polybar/pull/2569))
+  - New token `%netspeed%` that provides the total speed of the internet (up + down speed) ([`#2590`](https://github.com/polybar/polybar/pull/2590), [`#1083`](https://github.com/polybar/polybar/issues/1083))
+  - `speed-unit = B/s` can be used to customize how network speeds are displayed. ([`#2068`](https://github.com/polybar/polybar/pull/2068))
+  - `interface-type` may be used in place of `interface` to automatically select a network interface ([`#2025`](https://github.com/polybar/polybar/pull/2025), [`#339`](https://github.com/polybar/polybar/issues/339))
+- Polybar can now read config files from stdin: `polybar -c /dev/stdin`. ([`#2545`](https://github.com/polybar/polybar/pull/2545))
+- `custom/script`:
+  - Setting environment variables using `env-*` config option. ([`#2090`](https://github.com/polybar/polybar/issues/2090), [`#2512`](https://github.com/polybar/polybar/pull/2512))
+  - Add formatting for script failure (`format-fail`, `label-fail`) ([`#2588`](https://github.com/polybar/polybar/issues/2588), [`#2596`](https://github.com/polybar/polybar/pull/2596))
+- Support for ramp weights. ([`#1750`](https://github.com/polybar/polybar/issues/1750), [`#2505`](https://github.com/polybar/polybar/pull/2505))
+- `internal/memory`: New tokens `%used%`, `%free%`, `%total%`, `%swap_total%`, `%swap_free%`, and `%swap_used%` that automatically switch between MiB and GiB when below or above 1GiB. ([`#2472`](https://github.com/polybar/polybar/issues/2472), [`#2488`](https://github.com/polybar/polybar/pull/2488))
+- `internal/i3`: `show-urgent` option to always show urgent windows when `pin-workspace` is active ([`#2374`](https://github.com/polybar/polybar/issues/2374), [`#2378`](https://github.com/polybar/polybar/pull/2378))
+- `internal/xworkspaces`:
+  - `reverse-scroll` can be used to reverse the scroll direction when cycling through desktops. ([`#2365`](https://github.com/polybar/polybar/pull/2365))
+  - `%nwin%` can be used to display the number of open windows per workspace ([`#604`](https://github.com/polybar/polybar/issues/604), [`#2329`](https://github.com/polybar/polybar/pull/2329))
+- Initial support for the backslash escape character (\\) in configs. ([`#2354`](https://github.com/polybar/polybar/issues/2354), [`#2361`](https://github.com/polybar/polybar/pull/2361))
+- Warn states for the cpu, memory, fs, and battery modules. ([`#570`](https://github.com/polybar/polybar/issues/570), [`#956`](https://github.com/polybar/polybar/issues/956), [`#1871`](https://github.com/polybar/polybar/issues/1871), [`#2141`](https://github.com/polybar/polybar/issues/2141), [`#2199`](https://github.com/polybar/polybar/pull/2199))
+  - `internal/battery`: `format-low`, `label-low`, `animation-low`, `low-at = 10`.
+  - `internal/cpu`: `format-warn`, `label-warn`, `warn-percentage = 80`
+  - `internal/fs`: `format-warn`, `label-warn`, `warn-percentage = 90`
+  - `internal/memory`: `format-warn`, `label-warn`, `warn-percentage = 90`
+- `radius` now affects the bar border as well ([`#1566`](https://github.com/polybar/polybar/issues/1566), [`#2359`](https://github.com/polybar/polybar/pull/2359))
+- Per-corner radius with `radius-{bottom,top}-{left,right}` ([`#2294`](https://github.com/polybar/polybar/issues/2294), [`#2297`](https://github.com/polybar/polybar/pull/2297))
+- `internal/xkeyboard`:
+  - `%variant%` token to display the keyboard layout variant ([`#316`](https://github.com/polybar/polybar/issues/316), [`#2163`](https://github.com/polybar/polybar/pull/2163))
+  - Allow matching of variants in `layout-icon` ([`#2414`](https://github.com/polybar/polybar/issues/2414), [`#2521`](https://github.com/polybar/polybar/pull/2521))
+- Config option to hide a certain module (`hidden = false`) ([`#2108`](https://github.com/polybar/polybar/issues/2108), [`#2342`](https://github.com/polybar/polybar/pull/2342))
+- Actions to control visibility of modules (`module_toggle`, `module_show`, and `module_hide`) ([`#2108`](https://github.com/polybar/polybar/issues/2108), [`#2426`](https://github.com/polybar/polybar/pull/2426))
+- `internal/backlight`: `use-actual-brightness` option to use the `actual_brightness` file to get the brightness ([`#2380`](https://github.com/polybar/polybar/pull/2380))
+- `wm-restack = generic` option that lowers polybar to the bottom of the window stack. Fixes the issue where the bar is being drawn on top of fullscreen windows in xmonad. ([`#2205`](https://github.com/polybar/polybar/issues/2205), [`#2404`](https://github.com/polybar/polybar/pull/2404))
+- `internal/bspwm`: `occupied-scroll = true` option allows scrolling through occupied desktops only. ([`#2427`](https://github.com/polybar/polybar/issues/2427), [`#2428`](https://github.com/polybar/polybar/pull/2428))
+- `custom/ipc`:
+  - `send` action to send arbitrary strings to be displayed in the module. ([`#2455`](https://github.com/polybar/polybar/issues/2455), [`#2463`](https://github.com/polybar/polybar/pull/2463))
+  - `hook`, `next`, `prev`, `reset` actions to control the module through actions instead of the deprecated hook messages ([`#2464`](https://github.com/polybar/polybar/issues/2464), [`#2528`](https://github.com/polybar/polybar/pull/2528))
+- Added `double-click-interval` setting to the bar section to control the time interval in which a double-click is recognized. Defaults to 400 (ms) ([`#1441`](https://github.com/polybar/polybar/issues/1441), [`#2510`](https://github.com/polybar/polybar/pull/2510))
+- Added a new `tray-foreground` setting to give hints to tray icons about what color they should be. ([`#2235`](https://github.com/polybar/polybar/issues/2235), [`#2552`](https://github.com/polybar/polybar/pull/2552))
+- `polybar-msg`:
+  - For module actions, you can now also specify the module name, action name, and optional data as separate arguments. ([`#2539`](https://github.com/polybar/polybar/pull/2539))
+  - Added man page: `man 1 polybar-msg` ([`#2539`](https://github.com/polybar/polybar/pull/2539))
+
+### Changed
+- Polybar now also reads `config.ini` when searching for config files. ([`#2323`](https://github.com/polybar/polybar/issues/2323), [`#2324`](https://github.com/polybar/polybar/pull/2324))
+- Polybar additionally searches in `XDG_CONFIG_DIRS/polybar/config.ini` (or `/etc/xdg/polybar/config.ini` if it is not set) and `/etc/polybar/config.ini` for config files. ([`#2016`](https://github.com/polybar/polybar/issues/2016), [`#2511`](https://github.com/polybar/polybar/pull/2511))
+- We rewrote polybar's main event loop. This shouldn't change any behavior for the user, but be on the lookout for X events, click events, or ipc messages not arriving and the bar not shutting down/restarting properly and let us know if you find any issues. ([`#2384`](https://github.com/polybar/polybar/pull/2384))
+- Slight changes to the value ranges the different ramp levels are responsible for in the cpu, memory, fs, and battery modules. The first level is used for everything at and below the start of the value range and the last level for everything at and above the end of the value range. The other levels are evenly distributed over the value range as before. The value range is bounded by the new warning thresholds. ([`#2199`](https://github.com/polybar/polybar/pull/2199))
+- `custom/script`: `interval` now defaults to 0 if `tail = true` as per the documentation. ([`#2240`](https://github.com/polybar/polybar/pull/2240))
+- `internal/network`: Increased precision for upload and download speeds: 0 decimal places for KB/s (as before), 1 for MB/s and 2 for GB/s. ([`#2054`](https://github.com/polybar/polybar/pull/2054))
+- Clicks arriving in close succession, no longer get dropped. Before polybar would drop any click that arrived within 5ms of the previous one. ([`#2510`](https://github.com/polybar/polybar/pull/2510))
+- Increased the double click interval from 150ms to 400ms. ([`#2510`](https://github.com/polybar/polybar/pull/2510))
+- Stop ignoring actions if they arrive while the previous one hasn't been processed yet. ([`#2469`](https://github.com/polybar/polybar/issues/2469), [`#2517`](https://github.com/polybar/polybar/pull/2517))
+- Polybar can now be run without passing the bar name as argument given that the configuration file only defines one bar ([`#2525`](https://github.com/polybar/polybar/issues/2525), [`#2526`](https://github.com/polybar/polybar/pull/2526))
+- `include-directory` and `include-file` now support relative paths. The paths are relative to the folder of the file where those directives appear. ([`#2523`](https://github.com/polybar/polybar/issues/2523), [`#2535`](https://github.com/polybar/polybar/issues/2535))
+- `custom/ipc`: Empty output strings are no longer formatted. This prevents extraneous spaces and separators from appearing in the bar when the output of an ipc module is empty. ([`#2549`](https://github.com/polybar/polybar/pull/2549))
+
+### Fixed
+- Broken positioning in Openbox when the bar is hidden and shown again ([`#2021`](https://github.com/polybar/polybar/issues/2021), [`#2600`](https://github.com/polybar/polybar/pull/2600))
+- Handling of action blocks that contain negative offsets ([`#1814`](https://github.com/polybar/polybar/issues/1814), [`#2601`](https://github.com/polybar/polybar/pull/2601))
+- `polybar -m` used to show both physical outputs and RandR monitors, even if the outputs were covered by monitors. ([`#2481`](https://github.com/polybar/polybar/issues/2481), [`#2485`](https://github.com/polybar/polybar/pull/2485))
+- Parser error if click command contained `}` ([`#2040`](https://github.com/polybar/polybar/issues/2040), [`#2303`](https://github.com/polybar/polybar/pull/2303))
+- Some modules stop updating when system time moves backwards. ([`#857`](https://github.com/polybar/polybar/issues/857), [`#1932`](https://github.com/polybar/polybar/issues/1932), [`#2559`](https://github.com/polybar/polybar/pull/2559))
+- `custom/script`: Concurrency issues with fast-updating tailed scripts. ([`#1978`](https://github.com/polybar/polybar/issues/1978), [`#2518`](https://github.com/polybar/polybar/pull/2518))
+- `internal/alsa`: Slight imprecision when calculating percentages. This caused the volume reported to be off by one. ([`#2399`](https://github.com/polybar/polybar/issues/2399), [`#2401`](https://github.com/polybar/polybar/pull/2401))
+- `internal/backlight`: With amdgpu backlights, the brightness indicator was slightly behind. ([`#2367`](https://github.com/polybar/polybar/issues/2367), [`#2380`](https://github.com/polybar/polybar/pull/2380))
+- `internal/bspwm`: Warning message regarding T@ ([`#2371`](https://github.com/polybar/polybar/issues/2371), [`#2439`](https://github.com/polybar/polybar/pull/2439))
+- `internal/xkeyboard`: Trailing space after the layout label when indicators are empty and made sure right amount of spacing is added between the indicator labels ([`#2292`](https://github.com/polybar/polybar/issues/2292), [`#2306`](https://github.com/polybar/polybar/pull/2306))
+- `internal/xworkspaces`:
+  - Broken scroll-wrapping and order of workspaces when scrolling ([`#2491`](https://github.com/polybar/polybar/issues/2491), [`#2492`](https://github.com/polybar/polybar/pull/2492))
+  - Module would error if WM was not full started up. ([`#1915`](https://github.com/polybar/polybar/issues/1915), [`#2429`](https://github.com/polybar/polybar/pull/2429))
+  - Make the urgent hint persistent ([`#1081`](https://github.com/polybar/polybar/issues/1081), [`#2340`](https://github.com/polybar/polybar/pull/2340))
+  - Crash when the WM sets -1 for `_NET_WM_DESKTOP` ([`#2352`](https://github.com/polybar/polybar/issues/2352), [`#2353`](https://github.com/polybar/polybar/issues/2353))
+- `internal/network`: The module now properly supports 'altnames' for interfaces. ([`#2540`](https://github.com/polybar/polybar/pull/2540))
+- `internal/battery`: More accurate battery state ([`#2563`](https://github.com/polybar/polybar/issues/2563), [`#2556`](https://github.com/polybar/polybar/pull/2556))
+- Offset tag does not respect current background color ([`#2578`](https://github.com/polybar/polybar/pull/2578), [`#1700`](https://github.com/polybar/polybar/issues/1700))
+- Crash when negative margin or padding was specified ([`#2578`](https://github.com/polybar/polybar/pull/2578), [`#1265`](https://github.com/polybar/polybar/issues/1265))
+
+## [3.5.7] - 2021-09-21
+### Fixed
+- The tray mistakenly removed tray icons that did not support XEMBED
+  ([`#2479`](https://github.com/polybar/polybar/issues/2479),
+  [`#2442`](https://github.com/polybar/polybar/issues/2442))
+- `custom/ipc`: Only the first appearance of the `%pid%` token was replaced
+  ([`#2500`](https://github.com/polybar/polybar/issues/2500))
+
+## [3.5.6] - 2021-05-24
+### Build
+- Support building documentation on sphinx 4.0 ([`#2424`](https://github.com/polybar/polybar/issues/2424))
+### Fixed
+- Tray icons sometimes appears outside of bar ([`#2430`](https://github.com/polybar/polybar/issues/2430), [`#1679`](https://github.com/polybar/polybar/issues/1679))
+- Crash in the i3 module ([`#2416`](https://github.com/polybar/polybar/issues/2416))
+
+## [3.5.5] - 2021-03-01
+### Build
+- Support older python sphinx versions again ([`#2356`](https://github.com/polybar/polybar/issues/2356))
+
+## [3.5.4] - 2021-01-07
+### Fixed
+- Wrong text displayed if module text ends with `}` ([`#2331`](https://github.com/polybar/polybar/issues/2331))
+
+## [3.5.3] - 2020-12-23
+### Build
+- Don't use `git` when building documentation ([`#2309`](https://github.com/polybar/polybar/issues/2309))
+### Fixed
+- Empty color values are no longer treated as invalid and no longer produce an error.
+
+[Unreleased]: https://github.com/polybar/polybar/compare/3.7.2...HEAD
+[3.7.2]: https://github.com/polybar/polybar/releases/tag/3.7.2
+[3.7.1]: https://github.com/polybar/polybar/releases/tag/3.7.1
+[3.7.0]: https://github.com/polybar/polybar/releases/tag/3.7.0
+[3.6.3]: https://github.com/polybar/polybar/releases/tag/3.6.3
+[3.6.2]: https://github.com/polybar/polybar/releases/tag/3.6.2
+[3.6.1]: https://github.com/polybar/polybar/releases/tag/3.6.1
+[3.6.0]: https://github.com/polybar/polybar/releases/tag/3.6.0
+[3.5.7]: https://github.com/polybar/polybar/releases/tag/3.5.7
+[3.5.6]: https://github.com/polybar/polybar/releases/tag/3.5.6
+[3.5.5]: https://github.com/polybar/polybar/releases/tag/3.5.5
+[3.5.4]: https://github.com/polybar/polybar/releases/tag/3.5.4
+[3.5.3]: https://github.com/polybar/polybar/releases/tag/3.5.3

CMakeLists.txt

@@ -1,51 +1,98 @@
 #
 # Build configuration
 #
-cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.5.0 FATAL_ERROR)
+project(polybar CXX)
 
-# Enable ccache by default and as early as possible because project() performs
+# Extract version information from version.txt. The first line that looks like
-# checks on the compiler
+# a version string is used, so the file supports comments
-option(ENABLE_CCACHE "Enable ccache support" ON)
+file(STRINGS version.txt version_txt REGEX "^[0-9]+\\.[0-9]+\\.[0-9]+.*$" LIMIT_COUNT 1)
-if(ENABLE_CCACHE)
-  message(STATUS "Trying to enable ccache")
-  find_program(BIN_CCACHE ccache)
 
-  string(ASCII 27 esc)
+
-  if(NOT BIN_CCACHE)
+execute_process(COMMAND git rev-parse --show-toplevel
-    message(STATUS "${esc}[33mCouldn't locate ccache, disabling ccache...${esc}[0m")
+  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
-  else()
+  RESULT_VARIABLE git_top_dir_result
-    # Enable only if the binary is found
+  OUTPUT_VARIABLE git_top_dir
-    message(STATUS "${esc}[32mUsing compiler cache ${BIN_CCACHE}${esc}[0m")
+  OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
-    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${BIN_CCACHE})
+
-  endif()
+# Set fallback first, override if more information (from git) is found
+set(APP_VERSION "${version_txt}")
+
+# Prevent formatting errors & resolve symlinks (REALPATH)
+get_filename_component(resolved_project_source_dir ${PROJECT_SOURCE_DIR} REALPATH)
+if(NOT ("${git_top_dir}" STREQUAL ""))
+  get_filename_component(git_top_dir ${git_top_dir} REALPATH)
 endif()
 
-project(polybar C CXX)
+if(git_top_dir_result EQUAL "0" AND git_top_dir STREQUAL resolved_project_source_dir)
+  # If we are in a git repo we can get the version information from git describe
+  execute_process(COMMAND git describe --tags --dirty=-dev
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    RESULT_VARIABLE git_describe_result
+    OUTPUT_VARIABLE git_describe
+    OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
 
-set(CMAKE_MODULE_PATH
+  if(git_describe_result EQUAL "0")
-  ${CMAKE_MODULE_PATH}
+    set(APP_VERSION "${git_describe}")
+  else()
+    message(STATUS "Could not detect version with git, falling back to built-in version information.")
+  endif()
+
+else()
+  message(STATUS "CMake and git directory mismatch, falling back to built-in version information.") # Assuming that if git rev-parse doesn't return 0, git describe won't either
+endif()
+
+
+# Set the default installation prefix to /usr
+# Otherwise the default value is /usr/local which causes the default config
+# file to be installed to /usr/local/etc, with /usr, cmake has special handling
+# for this.
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+  set(CMAKE_INSTALL_PREFIX "/usr" CACHE PATH "Project-default installation prefix" FORCE)
+endif()
+
+list(APPEND CMAKE_MODULE_PATH
   ${PROJECT_SOURCE_DIR}/cmake
   ${PROJECT_SOURCE_DIR}/cmake/common
   ${PROJECT_SOURCE_DIR}/cmake/modules)
 
+include(GNUInstallDirs)
 include(utils)
 include(01-core)
 include(02-opts)
-include(03-libs)
 include(04-targets)
-include(05-summary)
 
-add_subdirectory(doc)
+if(BUILD_DOC)
-add_subdirectory(doc/bash)
+  add_subdirectory(doc)
-add_subdirectory(doc/zsh)
+endif()
-add_subdirectory(include)
+
-add_subdirectory(lib)
+if (BUILD_SHELL)
-add_subdirectory(man)
+  add_subdirectory(contrib/bash)
-add_subdirectory(src bin)
+  add_subdirectory(contrib/zsh)
+endif()
+
+# Setup everything that uses a C++ compiler (polybar, polybar-msg, tests)
+if(HAS_CXX_COMPILATION)
+  include(cxx)
+  if(BUILD_LIBPOLY)
+    include(libpoly)
+    add_subdirectory(lib)
+  endif()
+  add_subdirectory(include)
+  add_subdirectory(src bin)
+endif()
 
 # We need to enable testing in the root folder so that 'ctest' and 'make test'
 # can be run in the build directory
 if(BUILD_TESTS)
   enable_testing()
-  add_subdirectory(tests EXCLUDE_FROM_ALL)
+  add_subdirectory(tests)
 endif()
+
+if(BUILD_CONFIG)
+  install(FILES ${CMAKE_SOURCE_DIR}/doc/config.ini
+    DESTINATION ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME}
+    COMPONENT config)
+endif()
+
+include(05-summary)

CONTRIBUTING.md

@@ -0,0 +1,169 @@
+# Contributing
+
+First of all, thank you very much for considering contributing to polybar. You
+are awesome! :tada:
+
+**Table of Contents:**
+* [Bug Reports](#bug-reports)
+* [Pull Requests](#pull-requests)
+  + [Testing](#testing)
+  + [Changelog](#changelog)
+  + [Documentation](#documentation)
+  + [Style](#style)
+* [Donations](#donations)
+
+## Bug Reports
+
+Bugs should be reported at the polybar issue tracker, using the [bug report
+template](https://github.com/polybar/polybar/issues/new?template=bug_report.yml).
+Make sure you fill out all the required sections.
+
+Before opening a bug report, please search our [issue
+tracker](https://github.com/polybar/polybar/issues?q=is%3Aissue) and [known
+issues page](https://github.com/polybar/polybar/wiki/Known-Issues) for your
+problem to avoid duplicates.
+
+If your issue has already been reported but is already marked as fixed and the
+version of polybar you are using includes this supposed fix, feel free to open a
+new issue.
+
+You should also go through our [debugging
+guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config) to confirm
+what you are experiencing is indeed a polybar bug and not an issue with your
+configuration.
+This will also help you narrow down the issue which, in turn, will help us
+resolve it, if it turns out to be a bug in polybar.
+
+If this bug was not present in a previous version of polybar and you know how
+to, doing a `git bisect` and providing us with the commit ID that introduced the
+issue would be immensely helpful.
+
+## Pull Requests
+
+If you want to start contributing to polybar, a good place to start are issues
+labeled with
+[help wanted](https://github.com/polybar/polybar/labels/help%20wanted)
+or
+[good first issue](https://github.com/polybar/polybar/labels/good%20first%20issue).
+
+Except for small changes, PRs should always address an already open and accepted
+issue.
+Otherwise you run the risk of spending time implementing something and then the
+PR being rejected because the feature you implemented was not actually something
+we want in polybar.
+
+Issues with any of the following labels are generally safe to start working on,
+unless they also have the `needs confirmation` label or someone else has
+already claimed them:
+
+* [bug](https://github.com/polybar/polybar/labels/bug)
+* [confirmed](https://github.com/polybar/polybar/labels/confirmed)
+* [good first issue](https://github.com/polybar/polybar/labels/good%20first%20issue)
+* [help wanted](https://github.com/polybar/polybar/labels/help%20wanted)
+* [hacktoberfest](https://github.com/polybar/polybar/labels/Hacktoberfest) (can also be worked on outside of October :wink:)
+
+For anything else, it's a good idea to first comment under the issue to ask
+whether it is something that can/should be worked on right now.
+This is especially true for issues labeled with `feature` (and none of the
+labels listed above), here a feature may depend on some other things being
+implemented first or it may need to be split into many smaller features, because
+it is too big otherwise.
+In particular, this means that you should not open a feature request and
+immediately start working on that feature, unless you are very sure it will be
+accepted or accept the risk of it being rejected.
+
+Things like documentation changes or refactorings, don't necessarily need an
+issue associated with them.
+These changes are less likely to be rejected since they don't change the
+behavior of polybar.
+Nevertheless, for bigger changes or when in doubt, open an issue and ask whether
+such changes would be desirable.
+
+To claim an issue, comment under it to let others know that you are working on
+it.
+
+Feel free to ask for feedback about your changes at any time.
+Especially when implementing features, this can be very useful because it allows
+us to make sure you are going in the direction we had envisioned for that
+feature and you don't lose time on something that ultimately has to be
+rewritten.
+In that case, a [draft PR](https://github.blog/2019-02-14-introducing-draft-pull-requests/)
+is a useful tool.
+
+When creating a PR, please fill out the PR template.
+
+### Testing
+
+Your PR must pass all existing tests.
+If possible, you should also add tests for the things you write.
+However, this is not always possible, for example when working on modules.
+But at least isolated components should be tested.
+
+See the [testing
+page](https://polybar.readthedocs.io/en/latest/dev/testing.html) in the
+documentation.
+Also don't hesitate to ask for help, testing isn't that mature in polybar yet
+and some things may be harder/impossible to test right now.
+
+### Changelog
+
+We use the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for
+keeping track of changes in a release.
+
+If your PR introduces notable changes to polybar, please add them the correct
+subsection in the `Unreleased` section in the `CHANGELOG.md` file at the root
+of this repository.
+Notable changes are any user-visible changes, like bug fixes, new config
+options, changes to the build, etc., but not, for example, code cleanup that
+doesn't change polybar's behavior or minor documentation changes.
+One thing that also should not be added to the changelog are bugfixes for
+unreleased features.
+
+An entry in the changelog should include a link to the issue(s) that the PR
+addresses, to the PR itself, and to your username:
+
+```
+- A short description of the change
+  ([`#XYZ`](https://github.com/polybar/polybar/issues/XYZ),
+  [`#UVW`](https://github.com/polybar/polybar/pull/UVW))
+  by [@yourname](https://github.com/yourname).
+```
+
+You will first need to open the PR before you can link to it though :wink:.
+
+
+If you are unsure whether something is a notable change, just add it to the
+changelog and we can determine whether it is a notable change when reviewing.
+
+### Documentation
+
+Right now, documentation for polybar lives in two places: The GitHub wiki and
+the git repo itself.
+
+Ultimately, most of the documentation is supposed to live in the repo itself.
+
+For now, if your PR requires documentation changes in the repo, those changes
+need to be in the PR as well.
+
+Changes on the wiki should not be made right away because the wiki should
+reflect the currently released version and not the development version.
+In that case, outline the documentation changes that need to be made (for
+example, which new config options are available).
+If your PR would introduce a lot of new documentation on the wiki, let us know
+and we can decide if we want to put some of the documentation directly into the
+repo.
+
+### Style
+
+Please read our [style
+guide](https://polybar.readthedocs.io/en/latest/dev/style-guide.html).
+
+## Donations
+
+Donations support the sustained development of polybar.
+We accept donations through [our open collective page](
+https://opencollective.com/polybar).
+This can be either a one time or a recurring donation.
+
+Our [blog post](https://polybar.github.io/2020/12/21/Polybar-Funding.html) lays
+out the why and how behind our decision to accept donations.

Makefile

@@ -1,39 +0,0 @@
-#
-# Polybar development tasks
-#
-BUILDDIR  ?= build
-GENERATOR ?= $(shell for c in ninja make; do command -vp $$c; done | xargs basename | sed "s/ninja/Ninja/;s/make/Unix Makefiles/")
-
-all: configure build link
-
-help:
-	@echo "Available targets:"
-	@awk -F':' '/^\w*:/ {print "  "$$1;}' Makefile
-
-configure:
-	@echo "\033[32;1m**\033[0m Configuring..."
-	@mkdir -p $(BUILDDIR)
-	@cd $(BUILDDIR) && cmake -G "$(GENERATOR)" ..
-
-build:
-	@echo "\033[32;1m**\033[0m Building..."
-	@cmake --build $(BUILDDIR)
-
-install:
-	@echo "\033[32;1m**\033[0m Installing..."
-	@cmake --build $(BUILDDIR) --target install
-
-link:
-	@echo "\033[32;1m**\033[0m Linking executable..."
-	@if [ -x $(BUILDDIR)/bin/polybar ]; then ln -sfv $(BUILDDIR)/bin/polybar; fi
-	@if [ -x $(BUILDDIR)/bin/polybar-msg ]; then ln -sfv $(BUILDDIR)/bin/polybar-msg; fi
-
-clean:
-	@echo "\033[32;1m**\033[0m Cleaning up..."
-	@if [ -d $(BUILDDIR) ]; then rm -rf $(BUILDDIR); fi
-	@if [ -L polybar ]; then rm -v polybar; fi
-	@if [ -L polybar-msg ]; then rm -v polybar-msg; fi
-
-.PHONY: configure build link clean help
-
-# vim:ts=2 sw=2 noet nolist

README.md

@@ -1,41 +1,47 @@
-![Polybar](banner.png)
+<p align="center">
-
+  <img src="doc/_static/banner.png#gh-light-mode-only" alt="Polybar">
-[![Release](https://img.shields.io/github/release/jaagr/polybar.svg)](https://github.com/jaagr/polybar/releases)
+  <img src="doc/_static/banner-dark-mode.png#gh-dark-mode-only" alt="Polybar">
-[![Build Status](https://travis-ci.org/jaagr/polybar.svg?branch=master)](https://travis-ci.org/jaagr/polybar)
+</p>
-[![Coverage Status](https://codecov.io/gh/jaagr/polybar/branch/master/graph/badge.svg)](https://codecov.io/gh/jaagr/polybar/branch/master)
-[![MIT License](https://img.shields.io/github/license/jaagr/polybar.svg)](https://github.com/jaagr/polybar/blob/master/LICENSE)
 
+<p align="center">
 A fast and easy-to-use tool for creating status bars.
+</p>
+
+<p align="center">
+<a href="https://github.com/polybar/polybar/releases"><img src="https://img.shields.io/github/release/polybar/polybar.svg"></a>
+<a href="https://github.com/polybar/polybar/releases"><img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/polybar/polybar/total" /></a>
+<a href="https://github.com/polybar/polybar/actions?query=workflow%3ACI"><img src="https://github.com/polybar/polybar/workflows/CI/badge.svg"></a>
+<a href="https://github.com/polybar/polybar/actions?query=workflow%3A%22Release+Workflow%22"><img src="https://github.com/polybar/polybar/workflows/Release%20Workflow/badge.svg"></a>
+<a href="https://polybar.readthedocs.io"><img src="https://readthedocs.org/projects/polybar/badge/?version=latest"></a>
+<a href="https://gitter.im/polybar/polybar"><img src="https://badges.gitter.im/polybar/polybar.svg"></a>
+<a href="https://codecov.io/gh/polybar/polybar/branch/master"><img src="https://codecov.io/gh/polybar/polybar/branch/master/graph/badge.svg"></a>
+<a href="https://github.com/polybar/polybar/blob/master/LICENSE"><img src="https://img.shields.io/github/license/polybar/polybar.svg"></a>
+<a href="https://www.codetriage.com/polybar/polybar"><img src="https://www.codetriage.com/polybar/polybar/badges/users.svg"></a>
+<a href="https://opencollective.com/polybar"><img src="https://opencollective.com/polybar/tiers/badge.svg"></a>
+</p>
+
+**[Documentation](https://github.com/polybar/polybar/wiki/) | [Installation](#installation) | [Support](SUPPORT.md) | [Donate](#donations)**
 
 **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](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.
-Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`.
 
+![default configuration screenshot](doc/_static/default.png)
 
 ## Table of Contents
 
 * [Introduction](#introduction)
+* [Getting Help](#getting-help)
+* [Contributing](#contributing)
 * [Getting started](#getting-started)
-  * [Dependencies](#dependencies)
+  * [Installation](#installation)
-  * [Building from source](#building-from-source)
+  * [First Steps](#first-steps)
-  * [Configuration](#configuration)
+* [Community](#community)
-  * [Running](#running)
 * [Contributors](#contributors)
+* [Donations](#donations)
+  * [Sponsors](#sponsors)
+  * [Backers](#backers)
 * [License](#license)
-
+* [Signatures](#signatures)
 
 ## Introduction
 
@@ -46,7 +52,7 @@ Some of the services included so far:
 - Systray icons
 - Window title
 - 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
+- [ALSA](https://www.alsa-project.org/main/index.php/Main_Page) and [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) volume controls
 - Workspace and desktop panel for [bspwm](https://github.com/baskerville/bspwm) and [i3](https://github.com/i3/i3)
 - Workspace module for [EWMH compliant](https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html#idm140130320786080) window managers
 - Keyboard layout and indicator status
@@ -61,22 +67,46 @@ Some of the services included so far:
 - Inter-process messaging
 - And more...
 
-[See the wiki for more details](https://github.com/jaagr/polybar/wiki).
+[See the wiki for more details](https://github.com/polybar/polybar/wiki).
 
+## Getting Help
+
+If you find yourself stuck, have a look at our [Support](SUPPORT.md) page for resources where you can find help.
+
+## Contributing
+
+Read our [contributing guidelines](CONTRIBUTING.md) for how to get started with contributing to polybar.
 
 ## Getting started
 
+### Installation
+
 <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.
+Polybar is already available in the package manager for many repositories.
-If you can't find your distro here, you will have to [build from source](#building-from-source).
+We list some of the more prominent ones here.
+Also click the [image on the
+right](https://repology.org/project/polybar/versions) to see a more complete
+list of available polybar packages.
 
-If you create a package for any other distribution, please consider contributing the template.
+If you are using **Debian** (bullseye/11/stable) or later, you can install [polybar](https://tracker.debian.org/pkg/polybar)
+using `sudo apt install polybar`. Newer releases of polybar are sometimes provided in the [backports](https://wiki.debian.org/Backports)
+repository for stable users, you need to enable [backports](https://wiki.debian.org/Backports) and then install using
+`sudo apt -t bullseye-backports install polybar`.
 
-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
+If you are using **Ubuntu** 20.10 (Groovy Gorilla) or later, you can install polybar
-[polybar](https://aur.archlinux.org/packages/polybar/) for the latest stable release.
+using `sudo apt install polybar`.
+
+If you are using **Arch Linux**, you can install
+[polybar](https://archlinux.org/packages/extra/x86_64/polybar/) to get the
+latest stable release using `sudo pacman -S polybar`. The latest unstable
+changes are also available in the
+[`polybar-git`](https://aur.archlinux.org/packages/polybar-git) package in the
+AUR.
+
+If you are using **Manjaro**, you can install [polybar](https://software.manjaro.org/package/polybar) to get the latest stable release using `sudo pacman -S polybar`.
 
 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`.
 
@@ -86,95 +116,127 @@ If you are using **Slackware**, polybar is available from the [SlackBuilds](http
 
 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](https://build.opensuse.org/package/show/home:sysek/polybar) repository. Package is available for openSUSE Leap 15 and Tumbleweed.
+If you are using **openSUSE Leap** or **openSUSE Tumbleweed**, polybar is available from the
+[official
+repositories](https://build.opensuse.org/package/show/X11:Utilities/polybar)
+and can be installed via `zypper install polybar`.
+The package is available for openSUSE Leap 15.3 and above.
 
-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.
+If you are using **FreeBSD**, [polybar](https://www.freshports.org/x11/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](https://packages.gentoo.org/packages/x11-misc/polybar) repository.
 
-### Dependencies
+If you are using **Fedora**, you can install [polybar](https://src.fedoraproject.org/rpms/polybar) using `sudo dnf install polybar`.
 
-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)
+If you can't find your distro here, you will have to [build from source](https://github.com/polybar/polybar/wiki/Compiling).
-- `cairo`
-- `libxcb`
-- `python2`
-- `xcb-proto`
-- `xcb-util-image`
-- `xcb-util-wm`
 
-**Optional dependencies:**
+### First Steps
-- `xcb-util-cursor` *required for the `cursor-click` and `cursor-scroll` settings*
+[See the wiki for details on how to run and configure polybar](https://github.com/polybar/polybar/wiki).
-- `xcb-util-xrm` *required for accessing X resources with `${xrdb:...}`*
 
-**Optional dependencies for extended module support:**
+## Community
-- `xcb-xkb` *required by `internal/xkeyboard`*
+Want to get in touch?
-- `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](https://github.com/jaagr/polybar/wiki/Compiling).
+* Visit our [Discussion page](https://github.com/polybar/polybar/discussions)
-
+* Join our Gitter room at [`gitter.im/polybar/polybar`](https://gitter.im/polybar/polybar)
-
+* We have our own subreddit at [`r/polybar`](https://www.reddit.com/r/polybar)
-### Building from source
+* Chat with us in the `#polybar` IRC channel on the [`irc.libera.chat:6697`](https://libera.chat/) server
-
-Please [report any problems](https://github.com/jaagr/polybar/issues/new/choose) you run into when building the project.
-
-  ~~~ sh
-  $ git clone --branch 3.2 --recursive https://github.com/jaagr/polybar
-  $ mkdir polybar/build
-  $ cd polybar/build
-  $ cmake ..
-  $ sudo make install
-  ~~~
-
-There's also a helper script available in the root folder:
-
-  ~~~ sh
-  $ ./build.sh
-  ~~~
-
-For more info, have a look at the [Compiling wiki page](https://github.com/jaagr/polybar/wiki/Compiling).
-
-### Configuration
-
-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).
-
-#### Install the example configuration
-Run the following inside the build directory:
-~~~ sh
-$ make userconfig
-~~~
-
-#### Launch the example bar
-  ~~~ sh
-  $ polybar example
-  ~~~
-
-
-### Running
-
-[See the wiki for details on how to run polybar](https://github.com/jaagr/polybar/wiki).
 
 ## Contributors
 
-### Owner
-* Michael Carlberg [**@jaagr**](http://github.com/jaagr/)
-
 ### Maintainers
+* Patrick Ziegler [**@patrick96**](https://github.com/patrick96)
+
+### Owner
+* Michael Carlberg [**@jaagr**](https://github.com/jaagr/)
+
+### Former Maintainers
+* [**@Lomadriel**](https://github.com/Lomadriel)
 * [**@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)
+### [All Contributors](https://github.com/polybar/polybar/graphs/contributors)
+
+## Donations
+
+Polybar accepts donations through [open collective](https://opencollective.com/polybar).
+
+[Become a backer](https://opencollective.com/polybar) and support polybar!
+### Sponsors
+
+<a href="https://opencollective.com/polybar/sponsor/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/0/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/1/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/2/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/3/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/4/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/5/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/6/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/7/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/8/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/9/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/9/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/10/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/10/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/11/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/11/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/12/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/12/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/13/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/13/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/14/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/14/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/15/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/15/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/16/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/16/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/17/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/17/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/18/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/18/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/19/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/19/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/20/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/20/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/21/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/21/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/22/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/22/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/23/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/23/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/24/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/24/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/25/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/25/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/26/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/26/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/27/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/27/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/28/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/28/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/sponsor/29/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/sponsor/29/avatar.svg?requireActive=false"></a>
+
+### Backers
+
+<a href="https://opencollective.com/polybar/backer/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/0/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/1/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/2/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/3/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/4/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/5/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/6/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/7/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/8/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/9/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/9/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/10/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/10/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/11/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/11/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/12/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/12/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/13/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/13/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/14/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/14/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/15/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/15/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/16/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/16/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/17/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/17/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/18/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/18/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/19/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/19/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/20/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/20/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/21/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/21/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/22/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/22/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/23/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/23/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/24/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/24/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/25/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/25/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/26/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/26/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/27/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/27/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/28/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/28/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/polybar/backer/29/website?requireActive=false" target="_blank"><img src="https://opencollective.com/polybar/backer/29/avatar.svg?requireActive=false"></a>
 
 ## License
 
-Polybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/jaagr/polybar/blob/master/LICENSE).
+Polybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/polybar/polybar/blob/master/LICENSE).
+
+## Signatures
+
+Release archives and tags are signed by a maintainer using GPG. Currently
+everything is signed by [Patrick Ziegler](https://www.patrickziegler.ch/gpg)
+with fingerprint `1D5791352D51A228D4DDDBA4521E5E03AEBCA1A7`

SUPPORT.md

@@ -1,8 +1,34 @@
-Polybar Support
+# Getting Help
-===============
 
-Reading [Polybar Wiki](https://github.com/jaagr/polybar/wiki) should help you with most of the problems you encounter when using polybar. It has a page for each module, describing what it does and what configuration options it provides.
+If you need help or troubleshooting tips or just have a question:
 
-If you can't find the information you are looking for on the wiki, look through the existing [issues](https://github.com/jaagr/polybar/issues?q=is%3Aissue), to see if anyone had the same problem before.
+* If applicable, go through our [debugging guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config).
+* Read the [Known Issues page](https://github.com/polybar/polybar/wiki/Known-Issues), maybe others had the same issue before.
+* Read the [Wiki page](https://github.com/polybar/polybar/wiki) for the thing you have problems with.
+* Ask your question on [GitHub Discussions](https://github.com/polybar/polybar/discussions)
+* Join our Gitter room at [`gitter.im/polybar/polybar`](https://gitter.im/polybar/polybar)
+* Ask in our reddit community at [`r/polybar`](https://www.reddit.com/r/polybar)
+* Join the official IRC channel `#polybar` on the [`irc.libera.chat:6697`](https://libera.chat/) network. This is IRC, you will need to be connected to receive answers.
+* Ask on [Unix & Linux StackExchange](https://unix.stackexchange.com/). Though not all questions may be suited over there, make sure you're [on topic](https://unix.stackexchange.com/help/on-topic).
 
-If you are still not able to resolve your problem, go ahead and open a new issue and also document what you have done up to that point to solve the problem.
+**Do not** use the GitHub issue tracker to ask for help or if you have questions, it is meant for bug reports.
+Issues will be closed and you will be referred to the above resources.
+
+## Asking Quality Questions
+
+Spending some time to precisely frame your question will save a lot of time.
+You will better understand your problem and may be able to solve it yourself
+and other will be able to better understand what you are asking.
+Here are some tips:
+
+* Be explicit and precise:
+  * What are you trying to achieve?
+  * What problems have you encountered while trying to achieve this?
+  * What is stopping you from overcoming these problems?
+* If a problem is difficult to describe, screenshots can help. Do not make
+  screenshots of your config file or error messages, copy-paste them as text.
+* Provide as much context as possible. In most cases this includes at least the following:
+  * Window Manager
+  * Polybar version
+  * Relevant portions of your config file. If you are not sure what is relevant, provide the whole thing.
+  * How you start polybar

build.sh

@@ -40,12 +40,12 @@ usage() {
           equal to -3 -a -p -n -m -c -i
       ${COLORS[GREEN]}-g, --gcc${COLORS[OFF]}
           Use GCC even if Clang is installed; disabled by default.
+      ${COLORS[GREEN]}-j, --jobs${COLORS[OFF]}
+          Use make -j to use make jobs with $(nproc) jobs; disabled by default.
       ${COLORS[GREEN]}-f${COLORS[OFF]}
           Remove existing build dir; disabled by default.
       ${COLORS[GREEN]}-I, --no-install${COLORS[OFF]}
           Do not execute 'sudo make install'; enabled by default.
-      ${COLORS[GREEN]}-C, --install-config${COLORS[OFF]}
-          Install example configuration; disabled by default.
       ${COLORS[GREEN]}-A, --auto${COLORS[OFF]}
           Automatic, non-interactive installation; disabled by default.
           When set, script defaults options not explicitly set.
@@ -68,7 +68,6 @@ install() {
 
   if [[ "$AUTO" == ON ]]; then
     [[ -z "$INSTALL" ]] && INSTALL="ON"
-    [[ -z "$INSTALL_CONF" ]] && INSTALL_CONF="OFF"
   fi
 
   if [[ -z "$INSTALL" ]]; then
@@ -76,19 +75,9 @@ install() {
     [[ "${p^^}" != "N" ]] && INSTALL="ON" || INSTALL="OFF"
   fi
 
-  if [[ -z "$INSTALL_CONF" ]]; then
-    read -r -p "$(msg "Install example configuration? [y/N]: ")" -n 1 p && echo
-    [[ "${p^^}" != "Y" ]] && INSTALL_CONF="OFF" || INSTALL_CONF="ON"
-  fi
-
-
   if [[ "$INSTALL" == ON ]]; then
     sudo make install || msg_err "Failed to install executables..."
   fi
-
-  if [[ "$INSTALL_CONF" == ON ]]; then
-    make userconfig || msg_err "Failed to install user configuration..."
-  fi
 }
 
 set_build_opts() {
@@ -105,6 +94,7 @@ set_build_opts() {
     [[ -z "$ENABLE_MPD" ]] && ENABLE_MPD="OFF"
     [[ -z "$ENABLE_CURL" ]] && ENABLE_CURL="OFF"
     [[ -z "$ENABLE_IPC_MSG" ]] && ENABLE_IPC_MSG="OFF"
+    [[ -z "$JOB_COUNT" ]] && JOB_COUNT=1
   fi
 
   if [[ -z "$USE_GCC" ]]; then
@@ -147,23 +137,24 @@ set_build_opts() {
     [[ "${p^^}" != "Y" ]] && ENABLE_IPC_MSG="OFF" || ENABLE_IPC_MSG="ON"
   fi
 
+  if [[ -z "$JOB_COUNT" ]]; then
+    read -r -p "$(msg "Parallelize the build using make -j$(nproc) --------------------------- [y/N]: ")" -n 1 p && echo
+    [[ "${p^^}" != "Y" ]] && JOB_COUNT=1 || JOB_COUNT=$(nproc)
+  fi
+
 
   CXX="c++"
-  CC="cc"
 
   if [[ "$USE_GCC" == OFF ]]; then
     if command -v clang++ >/dev/null; then
       msg "Using compiler: clang++/clang"
       CXX="clang++"
-      CC="clang"
     elif command -v g++ >/dev/null; then
       msg "Using compiler: g++/gcc"
       CXX="g++"
-      CC="gcc"
     fi
   else
     CXX="g++"
-    CC="gcc"
   fi
 }
 
@@ -178,18 +169,17 @@ main() {
       msg "Removing existing build dir (-f)"
       rm -rf ./build >/dev/null || msg_err "Failed to remove existing build dir"
     else
-      msg_err "A build dir already exists (pass -f to replace)"
+      msg "A build dir already exists (pass -f to replace)"
     fi
   }
 
-  mkdir ./build || msg_err "Failed to create build dir"
+  mkdir -p ./build || msg_err "Failed to create build dir"
   cd ./build || msg_err "Failed to enter build dir"
 
   set_build_opts
 
   msg "Executing cmake command"
   cmake                                       \
-    -DCMAKE_C_COMPILER="${CC}"                \
     -DCMAKE_CXX_COMPILER="${CXX}"             \
     -DENABLE_ALSA:BOOL="${ENABLE_ALSA}"       \
     -DENABLE_PULSEAUDIO:BOOL="${ENABLE_PULSEAUDIO}"\
@@ -197,11 +187,15 @@ main() {
     -DENABLE_MPD:BOOL="${ENABLE_MPD}"         \
     -DENABLE_NETWORK:BOOL="${ENABLE_NETWORK}" \
     -DENABLE_CURL:BOOL="${ENABLE_CURL}"       \
-    -DBUILD_IPC_MSG:BOOL="${ENABLE_IPC_MSG}"   \
+    -DBUILD_POLYBAR_MSG:BOOL="${ENABLE_IPC_MSG}"   \
     .. || msg_err "Failed to generate build... read output to get a hint of what went wrong"
 
   msg "Building project"
-  make || msg_err "Failed to build project"
+  if [ -z ${JOB_COUNT} ]; then
+    make || msg_err "Failed to build project"
+  else
+    make -j$JOB_COUNT || msg_err "Failed to build project"
+  fi
   install
   msg "Build complete!"
 
@@ -240,12 +234,12 @@ while [[ "$1" == -* ]]; do
 
     -g|--gcc)
       USE_GCC=ON; shift ;;
+    -j|--jobs)
+      JOB_COUNT=$(nproc); shift ;;
     -f)
       REMOVE_BUILD_DIR=ON; shift ;;
     -I|--no-install)
       INSTALL=OFF; shift ;;
-    -C|--install-config)
-      INSTALL_CONF=ON; shift ;;
     -A|--auto)
       AUTO=ON; shift ;;
     -h|--help)

cmake/01-core.cmake

@@ -1,111 +1,45 @@
 #
 # Core setup
 #
+option(DISABLE_ALL "Set this to ON disable all targets. Individual targets can be enabled explicitly." OFF)
 
-set(CMAKE_CXX_STANDARD 14)
+# If all targets are disabled, we set the default value for options that are on
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# by default to OFF
-set(CMAKE_CXX_EXTENSIONS OFF)
+if (DISABLE_ALL)
+  set(DEFAULT_ON OFF)
+else()
+  set(DEFAULT_ON ON)
+endif()
 
-set(THREADS_PREFER_PTHREAD_FLAG ON)
+option(BUILD_POLYBAR "Build the main polybar executable" ${DEFAULT_ON})
+option(BUILD_POLYBAR_MSG "Build polybar-msg" ${DEFAULT_ON})
+option(BUILD_TESTS "Build testsuite" OFF)
+option(BUILD_DOC "Build documentation" ${DEFAULT_ON})
+option(BUILD_CONFIG "Generate default configuration" ${DEFAULT_ON})
+option(BUILD_SHELL "Generate shell completion files" ${DEFAULT_ON})
+
+include(CMakeDependentOption)
+CMAKE_DEPENDENT_OPTION(BUILD_DOC_HTML "Build HTML documentation" ON "BUILD_DOC" OFF)
+CMAKE_DEPENDENT_OPTION(BUILD_DOC_MAN "Build manpages" ON "BUILD_DOC" OFF)
+
+if (BUILD_POLYBAR OR BUILD_TESTS OR BUILD_POLYBAR_MSG)
+  set(BUILD_LIBPOLY ON)
+else()
+  set(BUILD_LIBPOLY OFF)
+endif()
+
+if (BUILD_POLYBAR OR BUILD_POLYBAR_MSG OR BUILD_TESTS)
+  set(HAS_CXX_COMPILATION ON)
+else()
+  set(HAS_CXX_COMPILATION OFF)
+endif()
 
 # Export compile commands used for custom targets
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # Set default build type if not specified
 if(NOT CMAKE_BUILD_TYPE)
-  message_colored(STATUS "No build type specified; using RelWithDebInfo" 33)
+  set(CMAKE_BUILD_TYPE "Release")
-  set(CMAKE_BUILD_TYPE "RelWithDebInfo")
+  message_colored(STATUS "No build type specified; using ${CMAKE_BUILD_TYPE}" 33)
 endif()
 string(TOUPPER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_UPPER)
-
-# Compiler flags
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wextra")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror")
-if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
-  # there's no way to modify the code to avoid this warning, so we must
-  # suppress it if we use -Werror
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-noexcept-type")
-endif()
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic")
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic-errors")
-
-if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
-  # Need dprintf() for FreeBSD 11.1 and older
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_WITH_DPRINTF")
-  # libinotify uses c99 extension, so suppress this error
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-c99-extensions")
-  # Ensures that libraries from dependencies in LOCALBASE are used
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -L/usr/local/lib")
-endif()
-
-if(${CMAKE_CXX_COMPILER_ID} STREQUAL Clang)
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-error=parentheses-equality")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-zero-length-array")
-endif()
-
-set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DDEBUG")
-set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0")
-set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g2")
-
-if(${CMAKE_CXX_COMPILER_ID} STREQUAL GNU)
-  set(CMAKE_CXX_FLAGS_MINSIZEREL "${CMAKE_CXX_FLAGS_MINSIZEREL} -fdata-sections -ffunction-sections")
-  set(CMAKE_EXE_LINKER_FLAGS_MINSIZEREL "${CMAKE_EXE_LINKER_FLAGS_MINSIZEREL} -Wl,--gc-sections,--icf=safe")
-endif()
-
-# Check compiler
-if(${CMAKE_CXX_COMPILER_ID} STREQUAL Clang)
-  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "3.4.0")
-    message_colored(FATAL_ERROR "Compiler not supported (Requires clang-3.4+ or gcc-5.1+)" 31)
-  else()
-    message_colored(STATUS "Using supported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}" 32)
-  endif()
-elseif(${CMAKE_CXX_COMPILER_ID} STREQUAL GNU)
-  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5.1.0")
-    message_colored(FATAL_ERROR "Compiler not supported (Requires clang-3.4+ or gcc-5.1+)" 31)
-  else()
-    message_colored(STATUS "Using supported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}" 32)
-  endif()
-else()
-  message_colored(WARNING "Using unsupported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION} !" 31)
-endif()
-
-# Set compiler and linker flags for preferred C++ library
-if(CXXLIB_CLANG)
-  message_colored(STATUS "Linking against libc++" 32)
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++")
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lc++ -lc++abi")
-elseif(CXXLIB_GCC)
-  message_colored(STATUS "Linking against libstdc++" 32)
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lstdc++")
-endif()
-
-# Install paths
-if(NOT DEFINED CMAKE_INSTALL_BINDIR)
-  set(CMAKE_INSTALL_BINDIR bin)
-endif()
-if(NOT DEFINED CMAKE_INSTALL_SBINDIR)
-  set(CMAKE_INSTALL_SBINDIR sbin)
-endif()
-if(NOT DEFINED CMAKE_INSTALL_LIBDIR)
-  set(CMAKE_INSTALL_LIBDIR lib)
-endif()
-if(NOT DEFINED CMAKE_INSTALL_INCLUDEDIR)
-  set(CMAKE_INSTALL_INCLUDEDIR include)
-endif()
-
-# Custom build type ; SANITIZE
-SET(CMAKE_CXX_FLAGS_SANITIZE "-O1 -g -fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls"
-  CACHE STRING "Flags used by the C++ compiler during sanitize builds." FORCE)
-SET(CMAKE_C_FLAGS_SANITIZE ""
-  CACHE STRING "Flags used by the C compiler during sanitize builds." FORCE)
-SET(CMAKE_EXE_LINKER_FLAGS_SANITIZE ""
-  CACHE STRING "Flags used for linking binaries during sanitize builds." FORCE)
-SET(CMAKE_SHARED_LINKER_FLAGS_SANITIZE ""
-  CACHE STRING "Flags used by the shared libraries linker during sanitize builds." FORCE)
-MARK_AS_ADVANCED(
-  CMAKE_CXX_FLAGS_SANITIZE
-  CMAKE_C_FLAGS_SANITIZE
-  CMAKE_EXE_LINKER_FLAGS_SANITIZE
-  CMAKE_SHARED_LINKER_FLAGS_SANITIZE)

cmake/02-opts.cmake

@@ -1,64 +1,3 @@
-#
-# Build options
-#
-
-checklib(ENABLE_ALSA "pkg-config" alsa)
-checklib(ENABLE_CURL "pkg-config" libcurl)
-checklib(ENABLE_I3 "binary" i3)
-checklib(ENABLE_MPD "pkg-config" libmpdclient)
-checklib(WITH_LIBNL "pkg-config" libnl-genl-3.0)
-if(WITH_LIBNL)
-  checklib(ENABLE_NETWORK "pkg-config" libnl-genl-3.0)
-  set(WIRELESS_LIB "libnl")
-else()
-  checklib(ENABLE_NETWORK "cmake" Libiw)
-  set(WIRELESS_LIB "wireless-tools")
-endif()
-checklib(ENABLE_PULSEAUDIO "pkg-config" libpulse)
-checklib(ENABLE_PULSEAUDIO "binary" pulseaudio)
-checklib(WITH_XKB "pkg-config" xcb-xkb)
-checklib(WITH_XRM "pkg-config" xcb-xrm)
-checklib(WITH_XRANDR_MONITORS "pkg-config" "xcb-randr>=1.12")
-checklib(WITH_XCURSOR "pkg-config" "xcb-cursor")
-
-if(NOT DEFINED ENABLE_CCACHE AND CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
-  set(ENABLE_CCACHE ON)
-endif()
-
-option(CXXLIB_CLANG "Link against libc++" OFF)
-option(CXXLIB_GCC "Link against stdlibc++" OFF)
-
-option(BUILD_IPC_MSG "Build ipc messager" ON)
-option(BUILD_TESTS "Build testsuite" OFF)
-
-option(ENABLE_ALSA "Enable alsa support" ON)
-option(ENABLE_CURL "Enable curl support" ON)
-option(ENABLE_I3 "Enable i3 support" ON)
-option(ENABLE_MPD "Enable mpd support" ON)
-option(WITH_LIBNL "Use netlink interface for wireless" ON)
-option(ENABLE_NETWORK "Enable network support" ON)
-option(ENABLE_XKEYBOARD "Enable xkeyboard support" ON)
-option(ENABLE_PULSEAUDIO "Enable PulseAudio support" ON)
-
-option(WITH_XRANDR "xcb-randr support" ON)
-option(WITH_XRANDR_MONITORS "xcb-randr monitor support" ON)
-option(WITH_XRENDER "xcb-render support" OFF)
-option(WITH_XDAMAGE "xcb-damage support" OFF)
-option(WITH_XSYNC "xcb-sync support" OFF)
-option(WITH_XCOMPOSITE "xcb-composite support" OFF)
-option(WITH_XKB "xcb-xkb support" ON)
-option(WITH_XRM "xcb-xrm support" ON)
-option(WITH_XCURSOR "xcb-cursor support" ON)
-
-option(DEBUG_LOGGER "Trace logging" ON)
-
-if(CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
-  option(DEBUG_LOGGER_VERBOSE "Trace logging (verbose)" OFF)
-  option(DEBUG_HINTS "Debug clickable areas" OFF)
-  option(DEBUG_WHITESPACE "Debug whitespace" OFF)
-  option(DEBUG_FONTCONFIG "Debug fontconfig" OFF)
-endif()
-
 set(SETTING_ALSA_SOUNDCARD "default"
   CACHE STRING "Name of the ALSA soundcard driver")
 set(SETTING_BSPWM_SOCKET_PATH "/tmp/bspwm_0_0-socket"
@@ -69,10 +8,8 @@ set(SETTING_CONNECTION_TEST_IP "8.8.8.8"
   CACHE STRING "Address to ping when testing network connection")
 set(SETTING_PATH_ADAPTER "/sys/class/power_supply/%adapter%"
   CACHE STRING "Path to adapter")
-set(SETTING_PATH_BACKLIGHT_MAX "/sys/class/backlight/%card%/max_brightness"
+set(SETTING_PATH_BACKLIGHT "/sys/class/backlight/%card%"
-  CACHE STRING "Path to file containing the maximum backlight value")
+  CACHE STRING "Path to backlight sysfs folder")
-set(SETTING_PATH_BACKLIGHT_VAL "/sys/class/backlight/%card%/brightness"
-  CACHE STRING "Path to file containing the current backlight value")
 set(SETTING_PATH_BATTERY "/sys/class/power_supply/%battery%"
   CACHE STRING "Path to battery")
 set(SETTING_PATH_CPU_INFO "/proc/stat"
@@ -83,8 +20,5 @@ set(SETTING_PATH_MESSAGING_FIFO "/tmp/polybar_mqueue.%pid%"
   CACHE STRING "Path to file containing the current temperature")
 set(SETTING_PATH_TEMPERATURE_INFO "/sys/class/thermal/thermal_zone%zone%/temp"
   CACHE STRING "Path to file containing the current temperature")
-
+set(SETTING_PATH_THERMAL_ZONE_WILDCARD "/sys/class/thermal/thermal_zone*"
-if(CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
+  CACHE STRING "Wildcard path to different thermal zones")
-  set(DEBUG_HINTS_OFFSET_X 0 CACHE INTEGER "Debug hint offset x")
-  set(DEBUG_HINTS_OFFSET_Y 0 CACHE INTEGER "Debug hint offset y")
-endif()

cmake/03-libs.cmake

@@ -1,33 +0,0 @@
-#
-# Check libraries
-#
-
-find_package(Threads REQUIRED)
-list(APPEND libs ${CMAKE_THREAD_LIBS_INIT})
-
-querylib(TRUE "pkg-config" cairo-fc libs dirs)
-
-querylib(ENABLE_ALSA "pkg-config" alsa libs dirs)
-querylib(ENABLE_CURL "pkg-config" libcurl libs dirs)
-querylib(ENABLE_MPD "pkg-config" libmpdclient libs dirs)
-if(WITH_LIBNL)
-  querylib(ENABLE_NETWORK "pkg-config" libnl-genl-3.0 libs dirs)
-else()
-  querylib(ENABLE_NETWORK "cmake" Libiw libs dirs)
-endif()
-querylib(ENABLE_PULSEAUDIO "pkg-config" libpulse libs dirs)
-
-querylib(WITH_XCOMPOSITE "pkg-config" xcb-composite libs dirs)
-querylib(WITH_XDAMAGE "pkg-config" xcb-damage libs dirs)
-querylib(WITH_XKB "pkg-config" xcb-xkb libs dirs)
-querylib(WITH_XRANDR "pkg-config" xcb-randr libs dirs)
-querylib(WITH_XRANDR_MONITORS "pkg-config" "xcb-randr>=1.12" libs dirs)
-querylib(WITH_XRENDER "pkg-config" xcb-render libs dirs)
-querylib(WITH_XRM "pkg-config" xcb-xrm libs dirs)
-querylib(WITH_XSYNC "pkg-config" xcb-sync libs dirs)
-querylib(WITH_XCURSOR "pkg-config" xcb-cursor libs dirs)
-
-# FreeBSD Support
-if(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
-  querylib(TRUE "pkg-config" libinotify libs dirs)
-endif()

cmake/04-targets.cmake

@@ -2,18 +2,6 @@
 # Custom targets
 #
 
-# Target: userconfig {{{
-
-configure_file(
-  ${PROJECT_SOURCE_DIR}/cmake/templates/userconfig.cmake.in
-  ${PROJECT_BINARY_DIR}/cmake/userconfig.cmake
-  ESCAPE_QUOTES @ONLY)
-
-add_custom_target(userconfig
-  DEPENDS ${PROJECT_NAME}
-  COMMAND ${CMAKE_COMMAND} -P ${PROJECT_BINARY_DIR}/cmake/userconfig.cmake)
-
-# }}}
 # Target: uninstall {{{
 
 configure_file(
@@ -29,13 +17,23 @@ add_custom_target(uninstall
 # folders where the clang tools should operate
 set(CLANG_SEARCH_PATHS ${PROJECT_SOURCE_DIR}/src ${PROJECT_SOURCE_DIR}/include ${PROJECT_SOURCE_DIR}/tests)
 
-# Target: codeformat (clang-format) {{{
+# Runs clang-format on all source files
+add_custom_target(
+  clangformat
+  COMMAND ${PROJECT_SOURCE_DIR}/common/file-runner.py
+  --dirs ${CLANG_SEARCH_PATHS}
+  -- clang-format -style=file -i --verbose
+  )
 
-add_custom_target(codeformat)
+# Dry-runs clang-format on all source files
-add_custom_command(TARGET codeformat
+# Useful for CI since it will exit with an error code
-  COMMAND ${PROJECT_SOURCE_DIR}/common/clang-format.sh ${CLANG_SEARCH_PATHS})
+add_custom_target(
+  clangformat-dryrun
+  COMMAND ${PROJECT_SOURCE_DIR}/common/file-runner.py
+  --dirs ${CLANG_SEARCH_PATHS}
+  -- clang-format -style=file --dry-run -Werror --verbose
+  )
 
-# }}}
 # Target: codecheck (clang-tidy) {{{
 
 add_custom_target(codecheck)

cmake/05-summary.cmake

@@ -1,44 +1,60 @@
 #
 # Output build summary
 #
-
 message(STATUS " Build:")
+message_colored(STATUS "   Version: ${APP_VERSION}" "32;1")
 message_colored(STATUS "   Type: ${CMAKE_BUILD_TYPE}" "37;2")
-message_colored(STATUS "   CC: ${CMAKE_C_COMPILER} ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${CMAKE_BUILD_TYPE_UPPER}}" "37;2")
+if (HAS_CXX_COMPILATION)
-message_colored(STATUS "   CXX: ${CMAKE_CXX_COMPILER} ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE_UPPER}}" "37;2")
+  message_colored(STATUS "   CXX: ${CMAKE_CXX_COMPILER} ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE_UPPER}} ${cxx_flags_str}" "37;2")
-message_colored(STATUS "   LD: ${CMAKE_LINKER} ${CMAKE_EXE_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UPPER}}" "37;2")
+  message_colored(STATUS "   LD: ${CMAKE_LINKER} ${CMAKE_EXE_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS_${CMAKE_BUILD_TYPE_UPPER}} ${cxx_linker_flags_str}" "37;2")
+endif()
+if (BUILD_DOC)
+  message_colored(STATUS "   sphinx-build: ${BIN_SPHINX} ${SPHINX_FLAGS}" "37;2")
+endif()
+
+message(STATUS " Install Paths:")
+message_colored(STATUS "   PREFIX:     ${CMAKE_INSTALL_PREFIX}" "32")
+message_colored(STATUS "   BINDIR:     ${CMAKE_INSTALL_FULL_BINDIR}" "32")
+message_colored(STATUS "   DATADIR:    ${CMAKE_INSTALL_FULL_DATADIR}" "32")
+message_colored(STATUS "   DOCDIR:     ${CMAKE_INSTALL_FULL_DOCDIR}" "32")
+message_colored(STATUS "   MANDIR:     ${CMAKE_INSTALL_FULL_MANDIR}" "32")
+message_colored(STATUS "   SYSCONFDIR: ${CMAKE_INSTALL_FULL_SYSCONFDIR}" "32")
 
 message(STATUS " Targets:")
-colored_option("   polybar-msg" BUILD_IPC_MSG)
+colored_option("   polybar" BUILD_POLYBAR)
+colored_option("   polybar-msg" BUILD_POLYBAR_MSG)
 colored_option("   testsuite" BUILD_TESTS)
+colored_option("   documentation" BUILD_DOC)
+colored_option("      html" BUILD_DOC_HTML)
+colored_option("      man" BUILD_DOC_MAN)
+colored_option("   default config" BUILD_CONFIG)
+colored_option("   shell files" BUILD_SHELL)
 
-message(STATUS " Module support:")
+if (BUILD_LIBPOLY)
-colored_option("   alsa" ENABLE_ALSA)
+  message(STATUS " Module support:")
-colored_option("   curl" ENABLE_CURL)
+  colored_option("   alsa" ENABLE_ALSA ALSA_VERSION)
-colored_option("   i3" ENABLE_I3)
+  colored_option("   curl" ENABLE_CURL CURL_VERSION)
-colored_option("   mpd" ENABLE_MPD)
+  colored_option("   i3" ENABLE_I3)
-colored_option("   network (${WIRELESS_LIB})" ENABLE_NETWORK)
+  colored_option("   mpd" ENABLE_MPD MPD_VERSION)
-colored_option("   pulseaudio" ENABLE_PULSEAUDIO)
+  colored_option("   network (${WIRELESS_LIB})" ENABLE_NETWORK NETWORK_LIBRARY_VERSION)
-colored_option("   xkeyboard" WITH_XKB)
+  colored_option("   pulseaudio" ENABLE_PULSEAUDIO PULSEAUDIO_VERSION)
+  colored_option("   xkeyboard" WITH_XKB Xcb_XKB_VERSION)
 
-message(STATUS " X extensions:")
+  message(STATUS " X extensions:")
-colored_option("   xcb-randr" WITH_XRANDR)
+  colored_option("   xcb-randr" Xcb_RANDR_FOUND Xcb_RANDR_VERSION)
-colored_option("   xcb-randr (monitor support)" WITH_XRANDR_MONITORS)
+  colored_option("   xcb-randr (monitor support)" WITH_XRANDR_MONITORS Xcb_RANDR_VERSION)
-colored_option("   xcb-render" WITH_XRENDER)
+  colored_option("   xcb-composite" Xcb_COMPOSITE_FOUND Xcb_COMPOSITE_VERSION)
-colored_option("   xcb-damage" WITH_XDAMAGE)
+  colored_option("   xcb-xkb" WITH_XKB Xcb_XKB_VERSION)
-colored_option("   xcb-sync" WITH_XSYNC)
+  colored_option("   xcb-xrm" WITH_XRM Xcb_XRM_VERSION)
-colored_option("   xcb-composite" WITH_XCOMPOSITE)
+  colored_option("   xcb-cursor" WITH_XCURSOR Xcb_CURSOR_VERSION)
-colored_option("   xcb-xkb" WITH_XKB)
-colored_option("   xcb-xrm" WITH_XRM)
-colored_option("   xcb-cursor" WITH_XCURSOR)
 
-message(STATUS " Log options:")
+  message(STATUS " Log options:")
-colored_option("   Trace logging" DEBUG_LOGGER)
+  colored_option("   Trace logging" DEBUG_LOGGER)
 
-if(CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
+  if(CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
-  message(STATUS " Debug options:")
+    message(STATUS " Debug options:")
-  colored_option("   Trace logging (verbose)" DEBUG_LOGGER_VERBOSE)
+    colored_option("   Trace logging (verbose)" DEBUG_LOGGER_VERBOSE)
-  colored_option("   Draw clickable areas" DEBUG_HINTS)
+    colored_option("   Draw clickable areas" DEBUG_HINTS)
-  colored_option("   Print fc-match details" DEBUG_FONTCONFIG)
+    colored_option("   Print fc-match details" DEBUG_FONTCONFIG)
-  colored_option("   Enable window shading" DEBUG_SHADED)
+  endif()
 endif()

cmake/common/utils.cmake

@@ -13,11 +13,8 @@ endfunction()
 # colored_option {{{
 
 function(colored_option text flag)
-  # Append version of option, if ${flag}_VERSION is set
+  if(ARGC GREATER 2 AND NOT "${${ARGV2}}" STREQUAL "")
-  set(version ${${flag}_VERSION})
+    set(text "${text} (${${ARGV2}})")
-
-  if(NOT "${version}" STREQUAL "")
-    set(text "${text} (${version})")
   endif()
 
   if(${flag})
@@ -29,230 +26,58 @@ endfunction()
 
 # }}}
 
-# make_executable {{{
+# find_package_impl {{{
 
-function(make_executable target_name)
+# Uses PkgConfig to search for pkg_config_name
-  set(zero_value_args)
+#
-  set(one_value_args PACKAGE)
+# Defines the following variables:
-  set(multi_value_args SOURCES INCLUDE_DIRS PKG_DEPENDS CMAKE_DEPENDS TARGET_DEPENDS RAW_DEPENDS)
+# ${find_pkg_name}_FOUND - True if the package has been found
+# ${find_pkg_name}_INCLUDE_DIR - <...>_INCLUDE_DIRS exported by pkg_check_modules
+# ${find_pkg_name}_INCLUDE_DIRS - Same as ${find_pkg_name}_INCLUDE_DIR
+# ${find_pkg_name}_LIBRARY - <...>_LIBRARIES exported by pkg_check_modules
+# ${find_pkg_name}_LIBRARIES - Same as ${find_pkg_name}_LIBRARY
+# ${find_pkg_name}_VERSION - <...>_VERSION exported by pkg_check_modules
+#
+macro(find_package_impl pkg_config_name find_pkg_name header_to_find)
+  find_package(PkgConfig REQUIRED)
+  include(FindPackageHandleStandardArgs)
 
-  cmake_parse_arguments(BIN
+  pkg_check_modules(PC_${find_pkg_name} REQUIRED ${pkg_config_name})
-    "${zero_value_args}" "${one_value_args}"
-    "${multi_value_args}" ${ARGN})
 
-  # add defined INCLUDE_DIRS
+  if (NOT ${header_to_find} STREQUAL "")
-  include_directories(${BIN_INCLUDE_DIRS})
+    find_path(PC_${find_pkg_name}_INCLUDE_DIRS_
+      NAMES "${header_to_find}"
+      HINTS "${PC_${find_pkg_name}_INCLUDE_DIRS}"
+    )
+    set(PC_${find_pkg_name}_INCLUDE_DIRS ${PC_${find_pkg_name}_INCLUDE_DIRS_})
+  endif()
 
-  # add INCLUDE_DIRS for all external dependencies
+  set(${find_pkg_name}_INCLUDE_DIR ${PC_${find_pkg_name}_INCLUDE_DIRS})
-  foreach(DEP ${BIN_TARGET_DEPENDS} ${BIN_PKG_DEPENDS} ${BIN_CMAKE_DEPENDS})
+  set(${find_pkg_name}_INCLUDE_DIRS ${${find_pkg_name}_INCLUDE_DIR})
-    string(TOUPPER ${DEP} DEP)
+  set(${find_pkg_name}_LIBRARY ${PC_${find_pkg_name}_LIBRARIES})
-    include_directories(${${DEP}_INCLUDE_DIRS})
+  set(${find_pkg_name}_VERSION ${PC_${find_pkg_name}_VERSION})
-    include_directories(${${DEP}_INCLUDEDIR})
+  set(${find_pkg_name}_LIBRARIES ${${find_pkg_name}_LIBRARY})
-  endforeach()
 
-  # create target
+  find_package_handle_standard_args(${find_pkg_name}
-  add_executable(${target_name} ${BIN_SOURCES})
+    REQUIRED_VARS
+    ${find_pkg_name}_INCLUDE_DIRS
+    ${find_pkg_name}_LIBRARIES
+    VERSION_VAR
+    ${find_pkg_name}_VERSION
+  )
 
-  # set the output file basename the same for static and shared
+  mark_as_advanced(${find_pkg_name}_INCLUDE_DIR ${find_pkg_name}_LIBRARY)
-  set_target_properties(${target_name} PROPERTIES OUTPUT_NAME ${target_name})
+endmacro()
-
-  # link libraries from pkg-config imports
-  foreach(DEP ${BIN_PKG_DEPENDS})
-    string(TOUPPER ${DEP} DEP)
-    target_link_libraries(${target_name} ${${DEP}_LDFLAGS})
-  endforeach()
-
-  # link libraries from cmake imports
-  foreach(DEP ${BIN_CMAKE_DEPENDS})
-    string(TOUPPER ${DEP} DEP)
-    target_link_libraries(${target_name}
-      ${${DEP}_LIB}
-      ${${DEP}_LIBRARY}
-      ${${DEP}_LIBRARIES})
-  endforeach()
-
-  # link libraries that are build as part of this project
-  target_link_libraries(${target_name}
-    ${BIN_TARGET_DEPENDS}
-    ${BIN_RAW_DEPENDS})
-
-  # install targets
-  install(TARGETS ${target_name}
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    COMPONENT runtime)
-endfunction()
 
 # }}}
-# make_library {{{
+# create_imported_target {{{
-
+function(create_imported_target library_name includes libraries)
-function(make_library target_name)
+  add_library(${library_name} INTERFACE IMPORTED)
-  set(zero_value_args SHARED STATIC)
+  set_target_properties(${library_name} PROPERTIES
-  set(one_value_args PACKAGE HEADER_INSTALL_DIR)
+    INTERFACE_LINK_LIBRARIES "${libraries}"
-  set(multi_value_args SOURCES HEADERS INCLUDE_DIRS PKG_DEPENDS CMAKE_DEPENDS TARGET_DEPENDS RAW_DEPENDS)
+    INTERFACE_INCLUDE_DIRECTORIES "${includes}"
-
+  )
-  cmake_parse_arguments(LIB
-    "${zero_value_args}" "${one_value_args}"
-    "${multi_value_args}" ${ARGN})
-
-  # make the header paths absolute
-  foreach(HEADER ${LIB_HEADERS})
-    set(LIB_HEADERS_ABS ${LIB_HEADERS_ABS} ${PROJECT_SOURCE_DIR}/include/${HEADER})
-  endforeach()
-
-  # add defined INCLUDE_DIRS
-  foreach(DIR ${LIB_INCLUDE_DIRS})
-    string(TOUPPER ${DIR} DIR)
-    include_directories(${DIR})
-    include_directories(${${DIR}_INCLUDE_DIRS})
-  endforeach()
-
-  # add INCLUDE_DIRS for all external dependencies
-  foreach(DEP ${LIB_TARGET_DEPENDS} ${LIB_PKG_DEPENDS} ${LIB_CMAKE_DEPENDS})
-    string(TOUPPER ${DEP} DEP)
-    include_directories(${${DEP}_INCLUDE_DIRS} ${${DEP}_INCLUDEDIRS})
-  endforeach()
-
-  if(LIB_SHARED)
-    list(APPEND library_targets ${target_name}_shared)
-  endif()
-  if(LIB_STATIC)
-    list(APPEND library_targets ${target_name}_static)
-  endif()
-
-  foreach(library_target_name ${library_targets})
-    message(STATUS "${library_target_name}")
-    add_library(${library_target_name}
-      ${LIB_HEADERS_ABS}
-      ${LIB_SOURCES})
-
-    # link libraries from pkg-config imports
-    foreach(DEP ${LIB_PKG_DEPENDS})
-      string(TOUPPER ${DEP} DEP)
-      target_link_libraries(${library_target_name} ${${DEP}_LDFLAGS})
-    endforeach()
-
-    # link libraries from cmake imports
-    foreach(DEP ${LIB_CMAKE_DEPENDS})
-      string(TOUPPER ${DEP} DEP)
-      target_link_libraries(${library_target_name}
-        ${${DEP}_LIB}
-        ${${DEP}_LIBRARY}
-        ${${DEP}_LIBRARIES})
-    endforeach()
-
-    # link libraries that are build as part of this project
-    foreach(DEP ${LIB_TARGET_DEPENDS})
-      string(TOUPPER ${DEP} DEP)
-      if(LIB_BUILD_SHARED)
-        target_link_libraries(${library_target_name} ${DEP}_shared)
-      endif()
-      if(LIB_BUILD_STATIC)
-        target_link_libraries(${library_target_name} ${DEP}_static)
-      endif()
-    endforeach()
-
-    if(${LIB_RAW_DEPENDS})
-      if(LIB_BUILD_STATIC)
-        target_link_libraries(${library_target_name} ${LIB_RAW_DEPENDS})
-      endif()
-    endif()
-
-    # set the output file basename
-    set_target_properties(${library_target_name} PROPERTIES OUTPUT_NAME ${target_name})
-
-    # install headers
-    install(FILES ${LIBRARY_HEADERS} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${LIB_HEADERS_ABS})
-
-    # install targets
-    install(TARGETS ${LIBRARY_TARGETS}
-      RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-      LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      COMPONENT library)
-  endforeach()
 endfunction()
-
-# }}}
-
-# queryfont {{{
-
-function(queryfont output_variable fontname)
-  set(multi_value_args FIELDS)
-  cmake_parse_arguments(ARG "" "" "${multi_value_args}" ${ARGN})
-
-  find_program(BIN_FCLIST fc-list)
-  if(NOT BIN_FCLIST)
-    message_colored(WARNING "Failed to locate `fc-list`" "33;1")
-    return()
-  endif()
-
-  string(REPLACE ";" " " FIELDS "${ARG_FIELDS}")
-  if(NOT FIELDS)
-    set(FIELDS family)
-  endif()
-
-  execute_process(
-    COMMAND sh -c "${BIN_FCLIST} : ${FIELDS}"
-    RESULT_VARIABLE status
-    OUTPUT_VARIABLE output
-    ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
-  STRING(REGEX REPLACE ";" "\\\\;" output "${output}")
-  STRING(REGEX REPLACE "\n" ";" output "${output}")
-  STRING(TOLOWER "${output}" output)
-
-  foreach(match LISTS ${output})
-    if(${match} MATCHES ".*${fontname}.*$")
-      list(APPEND matches ${match})
-    endif()
-  endforeach()
-
-  if(matches)
-    list(GET matches 0 fst_match)
-    set(${output_variable} "${fst_match}" PARENT_SCOPE)
-    message(STATUS "Found font: ${fst_match}")
-  else()
-    message_colored(STATUS "Font not found: ${fontname}" "33;1")
-  endif()
-endfunction()
-
-# }}}
-# querybin {{{
-
-function(querybin binary_name)
-  find_program(BIN_${binary_name} ${binary_name})
-  if(NOT BIN_${binary_name})
-    message_colored(FATAL_ERROR "Failed to locate ${binary_name} binary" 31)
-  endif()
-endfunction()
-
-# }}}
-# querylib {{{
-
-function(querylib flag type pkg out_library out_include_dirs)
-  if(${flag})
-    if(${type} STREQUAL "cmake")
-      find_package(${pkg} REQUIRED)
-      string(TOUPPER ${pkg} pkg_upper)
-      list(APPEND ${out_library} ${${pkg_upper}_LIBRARY})
-      list(APPEND ${out_include_dirs} ${${pkg_upper}_INCLUDE_DIR})
-    elseif(${type} STREQUAL "pkg-config")
-      find_package(PkgConfig REQUIRED)
-      pkg_check_modules(PKG_${flag} REQUIRED ${pkg})
-
-      # Set packet version so that it can be used in the summary
-      set(${flag}_VERSION ${PKG_${flag}_VERSION} PARENT_SCOPE)
-      list(APPEND ${out_library} ${PKG_${flag}_LIBRARIES})
-      list(APPEND ${out_include_dirs} ${PKG_${flag}_INCLUDE_DIRS})
-    else()
-      message(FATAL_ERROR "Invalid lookup type '${type}'")
-    endif()
-    set(${out_library} ${${out_library}} PARENT_SCOPE)
-    set(${out_include_dirs} ${${out_include_dirs}} PARENT_SCOPE)
-  endif()
-endfunction()
-
 # }}}
 # checklib {{{
 
@@ -271,7 +96,21 @@ function(checklib flag type pkg)
     else()
       message(FATAL_ERROR "Invalid lookup type '${type}'")
     endif()
+    mark_as_advanced(${flag})
   endif()
 endfunction()
 
+function(get_include_dirs output)
+  get_filename_component(generated_sources_dir  ${CMAKE_BINARY_DIR}/generated-sources   ABSOLUTE)
+  get_filename_component(include_dir            ${CMAKE_SOURCE_DIR}/include             ABSOLUTE)
+
+  set(${output} ${include_dir} ${generated_sources_dir} PARENT_SCOPE)
+endfunction()
+
+function(get_sources_dirs output)
+  get_filename_component(src_dir                ${CMAKE_SOURCE_DIR}/src                 ABSOLUTE)
+
+  set(${output} ${src_dir} PARENT_SCOPE)
+endfunction()
+
 # }}}

cmake/cxx.cmake

@@ -0,0 +1,108 @@
+option(ENABLE_CCACHE "Enable ccache support" ON)
+if(ENABLE_CCACHE)
+  find_program(BIN_CCACHE ccache)
+  mark_as_advanced(BIN_CCACHE)
+
+  if(NOT BIN_CCACHE)
+    message_colored(STATUS "Couldn't locate ccache, disabling ccache..." "33")
+  else()
+    # Enable only if the binary is found
+    message_colored(STATUS "Using compiler cache ${BIN_CCACHE}" "32")
+    set(CMAKE_CXX_COMPILER_LAUNCHER ${BIN_CCACHE} CACHE STRING "")
+  endif()
+endif()
+
+option(CXXLIB_CLANG "Link against libc++" OFF)
+option(CXXLIB_GCC "Link against stdlibc++" OFF)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+
+set(POLYBAR_FLAGS "" CACHE STRING "C++ compiler flags used for compiling polybar")
+
+list(APPEND cxx_base -Wall -Wextra -Wpedantic -Wdeprecated-copy-dtor)
+list(APPEND cxx_debug -DDEBUG -g2 -Og)
+list(APPEND cxx_minsizerel "")
+list(APPEND cxx_sanitize ${cxx_debug} -O0 -fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer -fno-optimize-sibling-calls)
+list(APPEND cxx_coverage ${cxx_debug} --coverage)
+
+list(APPEND cxx_linker_base "")
+list(APPEND cxx_linker_minsizerel "")
+
+# Compiler flags
+include(CheckCXXCompilerFlag)
+check_cxx_compiler_flag("-Wsuggest-override" HAS_SUGGEST_OVERRIDE)
+if (HAS_SUGGEST_OVERRIDE)
+  list(APPEND cxx_base -Wsuggest-override)
+endif()
+unset(HAS_SUGGEST_OVERRIDE)
+
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  # Need dprintf() for FreeBSD 11.1 and older
+  # libinotify uses c99 extension, so suppress this error
+  list(APPEND cxx_base -D_WITH_DPRINTF -Wno-c99-extensions)
+  # Ensures that libraries from dependencies in LOCALBASE are used
+  list(APPEND cxx_linker_base -L/usr/local/lib)
+endif()
+
+# Check compiler
+if(${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang")
+  list(APPEND cxx_base -Wno-error=parentheses-equality -Wno-zero-length-array)
+  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "3.4.0")
+    message_colored(FATAL_ERROR "Compiler not supported (Requires clang-3.4+ or gcc-5.1+)" 31)
+  else()
+    message_colored(STATUS "Using supported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}" 32)
+  endif()
+elseif(${CMAKE_CXX_COMPILER_ID} STREQUAL "GNU")
+  list(APPEND cxx_minsizerel -fdata-sections -ffunction-sections -flto)
+  list(APPEND cxx_linker_minsizerel -Wl,--gc-sections)
+  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "5.1.0")
+    message_colored(FATAL_ERROR "Compiler not supported (Requires clang-3.4+ or gcc-5.1+)" 31)
+  else()
+    message_colored(STATUS "Using supported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}" 32)
+  endif()
+else()
+  message_colored(WARNING "Using unsupported compiler ${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION} !" 31)
+endif()
+
+# Set compiler and linker flags for preferred C++ library
+if(CXXLIB_CLANG)
+  message_colored(STATUS "Linking against libc++" 32)
+  list(APPEND cxx_base -stdlib=libc++)
+  list(APPEND cxx_linker_base -lc++ -lc++abi)
+elseif(CXXLIB_GCC)
+  message_colored(STATUS "Linking against libstdc++" 32)
+  list(APPEND cxx_linker_base -lstdc++)
+endif()
+
+SET(CMAKE_CXX_FLAGS_COVERAGE "${CMAKE_CXX_FLAGS_DEBUG} ${CMAKE_CXX_FLAGS_COVERAGE}")
+SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE "${CMAKE_EXE_LINKER_FLAGS_DEBUG} ${CMAKE_EXE_LINKER_FLAGS_COVERAGE}")
+SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE "${CMAKE_SHARED_LINKER_FLAGS_DEBUG} ${CMAKE_SHARED_LINKER_FLAGS_COVERAGE}")
+
+list(APPEND cxx_flags ${cxx_base})
+list(APPEND cxx_linker_flags ${cxx_linker_base})
+
+if (CMAKE_BUILD_TYPE_UPPER STREQUAL "DEBUG")
+  list(APPEND cxx_flags ${cxx_debug})
+elseif (CMAKE_BUILD_TYPE_UPPER STREQUAL "MINSIZEREL")
+  list(APPEND cxx_flags ${cxx_minsizerel})
+  list(APPEND cxx_linker_flags ${cxx_linker_minsizerel})
+elseif (CMAKE_BUILD_TYPE_UPPER STREQUAL "SANITIZE")
+  list(APPEND cxx_flags ${cxx_sanitize})
+elseif (CMAKE_BUILD_TYPE_UPPER STREQUAL "COVERAGE")
+  list(APPEND cxx_flags ${cxx_coverage})
+endif()
+
+string(REPLACE " " ";" polybar_flags_list "${POLYBAR_FLAGS}")
+list(APPEND cxx_flags ${polybar_flags_list})
+
+list(APPEND cxx_linker_flags ${cxx_flags})
+
+string(REPLACE ";" " " cxx_flags_str "${cxx_flags}")
+string(REPLACE ";" " " cxx_linker_flags_str "${cxx_linker_flags}")
+
+# TODO use target_link_options once min cmake version is >= 3.13
+set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${cxx_linker_flags_str}")

cmake/libpoly.cmake

@@ -0,0 +1,106 @@
+# Sets up options and dependencies for libpoly
+
+
+# Automatically enable all optional dependencies that are available on the machine
+checklib(ENABLE_ALSA "pkg-config" alsa)
+checklib(ENABLE_CURL "pkg-config" libcurl)
+checklib(ENABLE_I3 "binary" i3)
+checklib(ENABLE_MPD "pkg-config" libmpdclient)
+checklib(WITH_LIBNL "pkg-config" libnl-genl-3.0)
+if(WITH_LIBNL)
+  checklib(ENABLE_NETWORK "pkg-config" libnl-genl-3.0)
+  set(WIRELESS_LIB "libnl")
+else()
+  checklib(ENABLE_NETWORK "cmake" Libiw)
+  set(WIRELESS_LIB "wireless-tools")
+endif()
+checklib(ENABLE_PULSEAUDIO "pkg-config" libpulse)
+checklib(WITH_XKB "pkg-config" xcb-xkb)
+checklib(WITH_XRM "pkg-config" xcb-xrm)
+checklib(WITH_XRANDR_MONITORS "pkg-config" "xcb-randr>=1.12")
+checklib(WITH_XCURSOR "pkg-config" "xcb-cursor")
+
+option(ENABLE_ALSA "Enable alsa support" ON)
+option(ENABLE_CURL "Enable curl support" ON)
+option(ENABLE_I3 "Enable i3 support" ON)
+option(ENABLE_MPD "Enable mpd support" ON)
+option(WITH_LIBNL "Use netlink interface for wireless" ON)
+option(ENABLE_NETWORK "Enable network support" ON)
+option(ENABLE_XKEYBOARD "Enable xkeyboard support" ON)
+option(ENABLE_PULSEAUDIO "Enable PulseAudio support" ON)
+
+option(WITH_XRANDR_MONITORS "xcb-randr monitor support" ON)
+option(WITH_XKB "xcb-xkb support" ON)
+option(WITH_XRM "xcb-xrm support" ON)
+option(WITH_XCURSOR "xcb-cursor support" ON)
+
+option(DEBUG_LOGGER "Trace logging" ON)
+
+if(CMAKE_BUILD_TYPE_UPPER MATCHES DEBUG)
+  option(DEBUG_LOGGER_VERBOSE "Trace logging (verbose)" OFF)
+  option(DEBUG_HINTS "Debug clickable areas" OFF)
+  option(DEBUG_WHITESPACE "Debug whitespace" OFF)
+  option(DEBUG_FONTCONFIG "Debug fontconfig" OFF)
+endif()
+
+# Load all packages for enabled components
+
+find_package(Threads REQUIRED)
+find_package(CairoFC REQUIRED)
+
+find_package(LibUV 1.3.0 REQUIRED)
+
+if (ENABLE_ALSA)
+  find_package(ALSA REQUIRED)
+endif()
+
+if (ENABLE_CURL)
+  find_package(CURL REQUIRED)
+endif()
+
+if (ENABLE_MPD)
+  find_package(LibMPDClient REQUIRED)
+  set(MPD_VERSION ${LibMPDClient_VERSION})
+endif()
+
+if (ENABLE_NETWORK)
+  if(WITH_LIBNL)
+    find_package(LibNlGenl3 REQUIRED)
+    set(NETWORK_LIBRARY_VERSION ${LibNlGenl3_VERSION})
+  else()
+    find_package(Libiw REQUIRED)
+  endif()
+endif()
+
+if (ENABLE_PULSEAUDIO)
+  find_package(LibPulse REQUIRED)
+  set(PULSEAUDIO_VERSION ${LibPulse_VERSION})
+endif()
+
+# xcomposite is required
+list(APPEND XORG_EXTENSIONS COMPOSITE)
+if (WITH_XKB)
+  list(APPEND XORG_EXTENSIONS XKB)
+endif()
+if (WITH_XCURSOR)
+  list(APPEND XORG_EXTENSIONS CURSOR)
+endif()
+if (WITH_XRM)
+  list(APPEND XORG_EXTENSIONS XRM)
+endif()
+
+# Set min xrandr version required
+if (WITH_XRANDR_MONITORS)
+  set(XRANDR_VERSION "1.12")
+else ()
+  set(XRANDR_VERSION "")
+endif()
+
+# Randr is required. Searches for randr only because we may do a version check
+find_package(Xcb ${XRANDR_VERSION} REQUIRED COMPONENTS RANDR)
+find_package(Xcb REQUIRED COMPONENTS ${XORG_EXTENSIONS})
+
+# FreeBSD Support
+if(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  find_package(LibInotify REQUIRED)
+endif()

cmake/modules/FindALSA.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `ALSA::ALSA` if alsa is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# ALSA_FOUND
+# ALSA_INCLUDE_DIR
+# ALSA_INCLUDE_DIRS
+# ALSA_LIBRARY
+# ALSA_LIBRARIES
+# ALSA_VERSION
+find_package_impl("alsa" "ALSA" "alsa/asoundlib.h")
+
+if(ALSA_FOUND AND NOT TARGET ALSA::ALSA)
+  create_imported_target("ALSA::ALSA" "${ALSA_INCLUDE_DIR}" "${ALSA_LIBRARY}")
+endif()

cmake/modules/FindCURL.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `CURL::libcurl` if libcurl is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# CURL_FOUND
+# CURL_INCLUDE_DIR
+# CURL_INCLUDE_DIRS
+# CURL_LIBRARY
+# CURL_LIBRARIES
+# CURL_VERSION
+find_package_impl("libcurl" "CURL" "curl/curl.h")
+
+if(CURL_FOUND AND NOT TARGET CURL::libcurl)
+  create_imported_target("CURL::libcurl" "${CURL_INCLUDE_DIR}" "${CURL_LIBRARY}")
+endif()

cmake/modules/FindCairoFC.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `Cairo::CairoFC` if cairo-fc is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# CairoFC_FOUND
+# CairoFC_INCLUDE_DIR
+# CairoFC_INCLUDE_DIRS
+# CairoFC_LIBRARY
+# CairoFC_LIBRARIES
+# CairoFC_VERSION
+find_package_impl("cairo-fc" "CairoFC" "")
+
+if(CairoFC_FOUND AND NOT TARGET Cairo::CairoFC)
+  create_imported_target("Cairo::CairoFC" "${CairoFC_INCLUDE_DIR}" "${CairoFC_LIBRARY}")
+endif()

cmake/modules/FindCppUnit.cmake

@@ -1,54 +0,0 @@
-#
-# Find the CppUnit includes and library
-#
-# This module defines
-# CPPUNIT_INCLUDE_DIR, where to find tiff.h, etc.
-# CPPUNIT_LIBRARIES, the libraries to link against to use CppUnit.
-# CPPUNIT_FOUND, If false, do not try to use CppUnit.
-
-# also defined, but not for general use are
-# CPPUNIT_LIBRARY, where to find the CppUnit library.
-# CPPUNIT_DEBUG_LIBRARY, where to find the CppUnit library in debug
-# mode.
-
-SET(CPPUNIT_FOUND "NO")
-
-FIND_PATH(CPPUNIT_INCLUDE_DIR cppunit/TestCase.h /usr/local/include /usr/include)
-
-# With Win32, important to have both
-IF(WIN32)
-  FIND_LIBRARY(CPPUNIT_LIBRARY cppunit
-               ${CPPUNIT_INCLUDE_DIR}/../lib
-               /usr/local/lib
-               /usr/lib)
-  FIND_LIBRARY(CPPUNIT_DEBUG_LIBRARY cppunitd
-               ${CPPUNIT_INCLUDE_DIR}/../lib
-               /usr/local/lib
-               /usr/lib)
-ELSE(WIN32)
-  # On unix system, debug and release have the same name
-  FIND_LIBRARY(CPPUNIT_LIBRARY cppunit
-               ${CPPUNIT_INCLUDE_DIR}/../lib
-               /usr/local/lib
-               /usr/lib)
-  FIND_LIBRARY(CPPUNIT_DEBUG_LIBRARY cppunit
-               ${CPPUNIT_INCLUDE_DIR}/../lib
-               /usr/local/lib
-               /usr/lib)
-ENDIF(WIN32)
-
-IF(CPPUNIT_INCLUDE_DIR)
-  IF(CPPUNIT_LIBRARY)
-    SET(CPPUNIT_FOUND "YES")
-    SET(CPPUNIT_LIBRARIES ${CPPUNIT_LIBRARY} ${CMAKE_DL_LIBS})
-    SET(CPPUNIT_DEBUG_LIBRARIES ${CPPUNIT_DEBUG_LIBRARY} ${CMAKE_DL_LIBS})
-  ELSE (CPPUNIT_LIBRARY)
-    IF (CPPUNIT_FIND_REQUIRED)
-      MESSAGE(SEND_ERROR "Could not find library CppUnit.")
-    ENDIF (CPPUNIT_FIND_REQUIRED)
-  ENDIF(CPPUNIT_LIBRARY)
-ELSE(CPPUNIT_INCLUDE_DIR)
-  IF (CPPUNIT_FIND_REQUIRED)
-    MESSAGE(SEND_ERROR "Could not find library CppUnit.")
-  ENDIF(CPPUNIT_FIND_REQUIRED)
-ENDIF(CPPUNIT_INCLUDE_DIR)

cmake/modules/FindLibInotify.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `LibInotify::LibInotify` if libinotify is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibInotify_FOUND
+# LibInotify_INCLUDE_DIR
+# LibInotify_INCLUDE_DIRS
+# LibInotify_LIBRARY
+# LibInotify_LIBRARIES
+# LibInotify_VERSION
+find_package_impl("libinotify" "LibInotify" "")
+
+if(LibInotify_FOUND AND NOT TARGET LibInotify::LibInotify)
+  create_imported_target("LibInotify::LibInotify" "${LibInotify_INCLUDE_DIR}" "${LibInotify_LIBRARY}")
+endif()

cmake/modules/FindLibMPDClient.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `LibMPDClient::LibMPDClient` if libmpdclient is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibMPDClient_FOUND
+# LibMPDClient_INCLUDE_DIR
+# LibMPDClient_INCLUDE_DIRS
+# LibMPDClient_LIBRARY
+# LibMPDClient_LIBRARIES
+# LibMPDClient_VERSION
+find_package_impl("libmpdclient" "LibMPDClient" "mpd/player.h")
+
+if(LibMPDClient_FOUND AND NOT TARGET LibMPDClient::LibMPDClient)
+  create_imported_target("LibMPDClient::LibMPDClient" "${LibMPDClient_INCLUDE_DIR}" "${LibMPDClient_LIBRARY}")
+endif()

cmake/modules/FindLibNlGenl3.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `LibNlGenl3::LibNlGenl3` if libnl-genl-3.0 is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibNlGenl3_FOUND
+# LibNlGenl3_INCLUDE_DIR
+# LibNlGenl3_INCLUDE_DIRS
+# LibNlGenl3_LIBRARY
+# LibNlGenl3_LIBRARIES
+# LibNlGenl3_VERSION
+find_package_impl("libnl-genl-3.0" "LibNlGenl3" "")
+
+if(LibNlGenl3_FOUND AND NOT TARGET LibNlGenl3::LibNlGenl3)
+  create_imported_target("LibNlGenl3::LibNlGenl3" "${LibNlGenl3_INCLUDE_DIR}" "${LibNlGenl3_LIBRARY}")
+endif()

cmake/modules/FindLibPulse.cmake

@@ -0,0 +1,14 @@
+# This module defines an imported target `LibPulse::LibPulse` if libpulse is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# LibPulse_FOUND
+# LibPulse_INCLUDE_DIR
+# LibPulse_INCLUDE_DIRS
+# LibPulse_LIBRARY
+# LibPulse_LIBRARIES
+# LibPulse_VERSION
+find_package_impl("libpulse" "LibPulse" "pulse/version.h")
+
+if(LibPulse_FOUND AND NOT TARGET LibPulse::LibPulse)
+  create_imported_target("LibPulse::LibPulse" "${LibPulse_INCLUDE_DIR}" "${LibPulse_LIBRARY}")
+endif()

cmake/modules/FindLibUV.cmake

@@ -0,0 +1,13 @@
+# This module defines
+# LibUV_FOUND
+# LibUV_INCLUDE_DIR
+# LibUV_INCLUDE_DIRS
+# LibUV_LIBRARY
+# LibUV_LIBRARIES
+# LibUV_VERSION
+
+find_package_impl("libuv" "LibUV" "uv.h")
+
+if(LibUV_FOUND AND NOT TARGET LibUV::LibUV)
+  create_imported_target("LibUV::LibUV" "${LibUV_INCLUDE_DIR}" "${LibUV_LIBRARY}")
+endif()

cmake/modules/FindLibiw.cmake

@@ -6,7 +6,7 @@
 find_library(LIBIW_LIBRARY iw)
 
 if(LIBIW_LIBRARY)
-    set(LIBIW_LIBRARIES ${LIBIW_LIBRARY})
+  set(LIBIW_LIBRARIES ${LIBIW_LIBRARY})
 endif(LIBIW_LIBRARY)
 
 find_path(LIBIW_INCLUDE_DIR NAMES iwlib.h)
@@ -15,3 +15,7 @@ include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(Libiw DEFAULT_MSG LIBIW_LIBRARY LIBIW_INCLUDE_DIR)
 
 mark_as_advanced(LIBIW_INCLUDE_DIR LIBIW_LIBRARY)
+
+if(Libiw_FOUND AND NOT TARGET Libiw::Libiw)
+  create_imported_target("Libiw::Libiw" "${LIBIW_INCLUDE_DIR}" "${LIBIW_LIBRARIES}")
+endif()

cmake/modules/FindXcb.cmake

@@ -0,0 +1,59 @@
+# Loads multiple XCB components
+# Version checks will be made against all requested components
+#
+# For each component ${comp} it does the following:
+#
+# Defines an imported target `Xcb::${comp}` if xcb-${comp} is found
+#
+# Defines the following Variables (see find_package_impl for more info):
+# Xcb_${comp}_FOUND
+# Xcb_${comp}_INCLUDE_DIR
+# Xcb_${comp}_INCLUDE_DIRS
+# Xcb_${comp}_LIBRARY
+# Xcb_${comp}_LIBRARIES
+# Xcb_${comp}_VERSION
+
+# This script only supports the following components of XCB
+set(XCB_known_components
+  XCB
+  RANDR
+  COMPOSITE
+  XKB
+  XRM
+  CURSOR)
+
+# Deducing header from the name of the component
+foreach(_comp ${XCB_known_components})
+  string(TOLOWER "${_comp}" _lc_comp)
+  set(XCB_${_comp}_pkg_config "xcb-${_lc_comp}")
+  set(XCB_${_comp}_header "xcb/${_lc_comp}.h")
+endforeach()
+# Exception cases
+set(XCB_XRM_header "xcb/xcb_xrm.h")
+set(XCB_CURSOR_header "xcb/xcb_cursor.h")
+
+foreach(_comp ${Xcb_FIND_COMPONENTS})
+  if (NOT ${_comp} IN_LIST XCB_known_components)
+    message(FATAL_ERROR "Unknow component \"${_comp}\" of XCB")
+  endif()
+
+  # Forward the different find options set for FindXcb to the individual
+  # components. This is required because find_package_handle_standard_args in
+  # find_package_impl uses these variables for version checks and other things.
+  set(Xcb_${_comp}_FIND_VERSION ${Xcb_FIND_VERSION})
+  set(Xcb_${_comp}_FIND_QUIETLY ${Xcb_FIND_QUIETLY})
+  set(Xcb_${_comp}_FIND_REQUIRED ${Xcb_FIND_REQUIRED})
+
+  # Bypass developer warning that the first argument to
+  # find_package_handle_standard_args (Xcb_...) does not match the name of the
+  # calling package (Xcb)
+  # https://cmake.org/cmake/help/v3.17/module/FindPackageHandleStandardArgs.html
+  set(FPHSA_NAME_MISMATCHED TRUE)
+  find_package_impl(${XCB_${_comp}_pkg_config} "Xcb_${_comp}" "${XCB_${_comp}_header}")
+
+  if(Xcb_${_comp}_FOUND AND NOT TARGET Xcb::${_comp})
+    create_imported_target("Xcb::${_comp}" "${Xcb_${_comp}_INCLUDE_DIRS}" "${Xcb_${_comp}_LIBRARIES}")
+  elseif(NOT Xcb_${_comp}_FOUND AND Xcb_FIND_REQUIRED)
+    message(FATAL_ERROR "Xcb: Required component \"${_comp}\" was not found")
+  endif()
+endforeach()

cmake/templates/userconfig.cmake.in

@@ -1,8 +0,0 @@
-set(USER_CONFIG_HOME "$ENV{XDG_CONFIG_HOME}")
-if(NOT USER_CONFIG_HOME)
-  set(USER_CONFIG_HOME "$ENV{HOME}/.config")
-endif()
-set(USER_CONFIG_HOME "${USER_CONFIG_HOME}/polybar")
-
-file(INSTALL "@CMAKE_SOURCE_DIR@/doc/config"
-  DESTINATION "${USER_CONFIG_HOME}")

common/bump.sh

@@ -1,34 +0,0 @@
-#!/bin/sh
-
-main() {
-  if [ $# -eq 0 ]; then
-    version=$(git describe --tags --abbrev=0)
-    set -- "${version%.*}.$((${version##*.}+1))"
-  fi
-
-  git tag "$@" || exit 1
-
-  tag_curr="$(git tag --sort=version:refname | tail -1)"
-  tag_prev="$(git tag --sort=version:refname | tail -2 | head -1)"
-
-  if [ -x ./common/version.sh ]; then
-    ./common/version.sh "$tag_curr"
-  fi
-
-  sed -r "s/${tag_prev}/${tag_curr}/g" -i \
-    README.md CMakeLists.txt \
-    contrib/polybar.aur/PKGBUILD \
-    contrib/polybar-git.aur/PKGBUILD
-
-  git add -u README.md CMakeLists.txt \
-    contrib/polybar.aur/PKGBUILD \
-    contrib/polybar-git.aur/PKGBUILD \
-    include/version.hpp
-
-  git commit -m "build: Bump version to ${tag_curr}"
-
-  # Recreate the tag to include the last commit
-  [ $# -eq 1 ] && git tag -f "$@"
-}
-
-main "$@"

common/ci/configure.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+if [ -d "$BUILD_DIR" ]; then
+  rm -Rf "$BUILD_DIR"
+fi
+
+mkdir -p "${BUILD_DIR}"
+cd "${BUILD_DIR}"
+
+if [ "$POLYBAR_BUILD_TYPE" != "minimal" ]; then
+  ENABLE_PULSEAUDIO=ON
+  ENABLE_NETWORK=ON
+  ENABLE_MPD=ON
+  ENABLE_CURL=ON
+  ENABLE_ALSA=ON
+  ENABLE_I3=ON
+  WITH_XRM=ON
+  WITH_XKB=ON
+  WITH_XRANDR_MONITORS=ON
+  WITH_XCURSOR=ON
+fi
+
+if [ "$POLYBAR_BUILD_TYPE" = "tests" ]; then
+  BUILD_TESTS=ON
+fi
+
+cmake \
+  -DCMAKE_CXX_COMPILER="${CXX}" \
+  -DPOLYBAR_FLAGS="${CXXFLAGS} -Werror" \
+  -DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
+  -DBUILD_TESTS:BOOL="${BUILD_TESTS:-OFF}" \
+  -DBUILD_DOC:BOOL=OFF \
+  -DENABLE_PULSEAUDIO="${ENABLE_PULSEAUDIO:-OFF}" \
+  -DENABLE_NETWORK="${ENABLE_NETWORK:-OFF}" \
+  -DENABLE_MPD="${ENABLE_MPD:-OFF}" \
+  -DENABLE_CURL="${ENABLE_CURL:-OFF}" \
+  -DENABLE_ALSA="${ENABLE_ALSA:-OFF}" \
+  -DENABLE_I3="${ENABLE_I3:-OFF}" \
+  -DWITH_XRM="${WITH_XRM:-OFF}" \
+  -DWITH_XKB="${WITH_XKB:-OFF}" \
+  -DWITH_XRANDR_MONITORS="${WITH_XRANDR_MONITORS:-OFF}" \
+  -DWITH_XCURSOR="${WITH_XCURSOR:-OFF}" \
+  ..

common/ci/summary.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+set -x
+
+"${CXX}" --version
+cmake --version
+
+set +x
+
+echo "PATH=${PATH}"
+echo "CXX=${CXX}"
+echo "CXXFLAGS=${CXXFLAGS}"
+echo "LDFLAGS=${LDFLAGS}"
+echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}"
+echo "MAKEFLAGS=${MAKEFLAGS}"
+echo "POLYBAR_BUILD_TYPE=${POLYBAR_BUILD_TYPE}"
+echo "CMAKE_BUILD_TYPE=${BUILD_TYPE}"

common/clang-format.sh

@@ -1,20 +0,0 @@
-#!/bin/sh
-
-main() {
-  if [ $# -lt 1 ]; then
-    echo "$0 DIR..." 1>&2
-    exit 1
-  fi
-
-  # Search paths
-  search="${*:-.}"
-
-  echo "$0 in $search"
-
-  # shellcheck disable=2086
-  find $search -regex ".*.[c|h]pp"                           \
-    -exec printf "\\033[32;1m** \\033[0mFormatting %s\\n" {} \; \
-    -exec clang-format -style=file -i {} \;
-}
-
-main "$@"

common/file-runner.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+
+from pathlib import Path
+import sys
+import os
+import argparse
+import subprocess
+
+EXTENSIONS = set('.' + ext for ext in ['c', 'h', 'cpp', 'hpp', 'inl'])
+
+
+def get_files(dirs):
+    """
+    Generator which yields all files in the given directories with any of the
+    EXTENSIONS.
+    """
+    for dir in dirs:
+        for root, _, files in os.walk(dir):
+            for file in files:
+                path = Path(os.path.join(root, file))
+                if path.suffix in EXTENSIONS:
+                    yield path
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="""
+        Run command on all C/C++ source files in the given directories
+        """)
+    parser.add_argument('--dirs', type=Path, nargs='+',
+                        help='Directories to search in')
+    parser.add_argument('command', nargs='+',
+                        help='Command to which to pass found files')
+    args = parser.parse_args()
+
+    all_files = list(str(file) for file in get_files(args.dirs))
+
+    if not all_files:
+        print("No files found")
+        sys.exit(1)
+
+    result = subprocess.run(args.command + all_files)
+    print(f'Formatted {len(all_files)} files')
+
+    if result.returncode != 0:
+        sys.exit(result.returncode)
+
+
+if __name__ == '__main__':
+    main()

common/travis/build.sh

@@ -1,3 +0,0 @@
-#!/bin/bash
-cd "${TRAVIS_BUILD_DIR}/build" || false
-make || exit $?

common/travis/configure.sh

@@ -1,32 +0,0 @@
-#!/bin/bash
-mkdir -p "${TRAVIS_BUILD_DIR}/build"
-cd "${TRAVIS_BUILD_DIR}/build" || false
-
-FLAGS=""
-
-# Disable all extra modules and X extensions for minimal builds
-# Most of these should already be turned off because their libraries are not
-# installed, but some may not be
-if [ "$POLYBAR_BUILD_TYPE" == "minimal" ]; then
-  FLAGS=(
-  "-DENABLE_PULSEAUDIO=OFF"
-  "-DENABLE_NETWORK=OFF"
-  "-DENABLE_MPD=OFF"
-  "-DENABLE_CURL=OFF"
-  "-DENABLE_ALSA=OFF"
-  "-DENABLE_I3=OFF"
-  "-DWITH_XRM=OFF"
-  "-DWITH_XKB=OFF"
-  "-DWITH_XRANDR_MONITORS=OFF"
-  "-DWITH_XCURSOR=OFF"
-  "-DWITH_XRANDR=ON"
-  )
-fi
-
-cmake \
-  -DCMAKE_C_COMPILER="${CC}" \
-  -DCMAKE_CXX_COMPILER="${CXX}" \
-  -DCMAKE_CXX_FLAGS="${CXXFLAGS}" \
-  -DCMAKE_BUILD_TYPE="${BUILD_TYPE}" \
-  -DBUILD_TESTS:BOOL="${BUILD_TESTS:-OFF}" \
-  "${FLAGS[@]}" ..

common/travis/environment.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-# Update compiler flags
-if [ "${CXX}" = "clang++" ]; then
-  export CXXFLAGS="${CXXFLAGS} -Qunused-arguments"
-elif [ "${CXX}" = "g++" ]; then
-  export CXX="g++-5"
-  export CC="gcc-5"
-fi

common/travis/install_xcb_xrm.sh

@@ -1,26 +0,0 @@
-#!/bin/bash
-
-# Don't install xrm on minimal builds because it is an optional dependency
-if [ "$POLYBAR_BUILD_TYPE" == "minimal" ]; then
-  echo "Not installing xcb-xrm on minimal build"
-  return 0
-fi
-
-# Fail on error
-set -e
-
-# If the Makefile exists, we have already cached xrm
-if [ ! -e "${DEPS_DIR}/xcb-util-xrm/Makefile" ]; then
-  git clone --recursive https://github.com/Airblader/xcb-util-xrm
-fi
-
-cd xcb-util-xrm
-
-# Install xrm on the system
-# If that doesn't work for some reason (not yet compiled, corrupt cache)
-# we compile xrm and try to install it again
-sudo make install || {
-  ./autogen.sh --prefix=/usr --libdir=/usr/lib
-  make
-  sudo make install
-}

common/travis/summary.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-echo "${CXX} --version"
-eval "${CXX} --version"
-
-echo "${CC} --version"
-eval "${CC} --version"
-
-echo "cmake --version"
-cmake --version
-
-echo "PATH=${PATH}"
-echo "CXX=${CXX}"
-echo "CC=${CC}"
-echo "CXXFLAGS=${CXXFLAGS}"
-echo "LDFLAGS=${LDFLAGS}"
-echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}"
-echo "JOBS=${JOBS}"

common/travis/tests.sh

@@ -1,16 +0,0 @@
-#!/bin/bash
-r=0
-
-make all_unit_tests || exit $?
-
-for test in tests/unit_test.*; do
-  [ -x "$test" ] || continue
-
-  if $test; then
-    printf "\033[1;32m%s\033[0m\n" "${test##*/} passed"
-  else
-    r=1
-    printf "\033[1;31m%s\033[0m\n" "${test##*/} failed"
-  fi
-done
-exit $r

common/version.sh

@@ -1,29 +0,0 @@
-#!/bin/sh
-
-msg() {
-  if [ -t 1 ]; then
-    printf " \033[1;32m**\033[0m %s\n" "$@"
-  else
-    printf "** %s\n" "$@"
-  fi
-}
-
-main() {
-  if [ $# -eq 0 ]; then
-    set -- "$(git describe --tags --dirty=-dev)"
-  fi
-
-  GIT_TAG_NAMESPACE=$(echo "v$1" | sed "s/[^a-zA-Z0-9_]/_/g")
-
-  msg "Current version: $1"
-  sed -r "/#define GIT_TAG/s/GIT_TAG .*/GIT_TAG \"$1\"/" -i include/version.hpp
-  sed -r "/#define GIT_TAG_NAMESPACE/s/GIT_TAG_NAMESPACE .*/GIT_TAG_NAMESPACE $GIT_TAG_NAMESPACE/" -i include/version.hpp
-
-  if git diff include/version.hpp 2>/dev/null | grep -q .; then
-    msg "Updated include/version.hpp"
-  else
-    msg "<include/version.hpp> is already up-to-date"
-  fi
-}
-
-main "$@"

contrib/bash/CMakeLists.txt

@@ -2,5 +2,5 @@
 # Bash completion template
 #
 install(FILES polybar
-  DESTINATION share/bash-completion/completions
+  DESTINATION ${CMAKE_INSTALL_DATADIR}/bash-completion/completions
   COMPONENT tools)

contrib/bash/polybar

@@ -0,0 +1,107 @@
+_polybar_default_file() {
+  local suffix=/polybar/config.ini
+
+  local home_path=${XDG_CONFIG_HOME:-$HOME/.config}${suffix}
+  local etc_xdg_path=${XDG_CONFIG_DIRS:-/etc/xdg}${suffix}
+  local etc_path=/etc${suffix}
+
+  if [ -r "$home_path" ]; then
+    echo "$home_path"
+  elif [ -r "$etc_xdg_path" ]; then
+    echo "$etc_xdg_path"
+  elif [ -r "$etc_path" ]; then
+    echo "$etc_path"
+  fi
+}
+
+_polybar_config_file() {
+  for ((i = 0; i < COMP_CWORD; i++)); do
+    case ${COMP_WORDS[i]} in
+    --config)
+      echo "${COMP_WORDS[i + 2]}"
+      return
+      ;;
+    -c)
+      echo "${COMP_WORDS[i + 1]}"
+      return
+      ;;
+    esac
+  done
+
+  _polybar_default_file
+}
+
+_polybar_bars() {
+  local config_file=$(_polybar_config_file)
+
+  if [ -r "$config_file" ]; then
+    sed -nE 's|[[:space:]]*\[bar/([^\]+)\][[:space:]]*$|\1|p' "$config_file"
+  fi
+}
+
+_polybar() {
+  local options='-h --help
+                 -v --version
+                 -l --log=
+                 -q --quiet
+                 -c --config=
+                 -r --reload
+                 -d --dump=
+                 -m --list-monitors
+                 -M --list-all-monitors
+                 -w --print-wmname
+                 -s --stdout
+                 -p --png='
+
+  local log_levels='error
+                    warning
+                    notice
+                    info
+                    trace'
+
+  COMPREPLY=()
+
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  case "$cur" in
+  -*)
+    COMPREPLY=( $(compgen -W "$options" -- "$cur") )
+    ;;
+  *)
+    local prev=${COMP_WORDS[COMP_CWORD - 1]}
+    if [ "$prev" = "=" ]; then
+      prev=${COMP_WORDS[COMP_CWORD - 2]}
+    fi
+
+    case "$prev" in
+    -l|--log)
+      COMPREPLY=( $(compgen -W "$log_levels" -- "$cur") )
+      return 0
+      ;;
+    -c|--config)
+      COMPREPLY=( $(compgen -f "$cur") )
+      return 0
+      ;;
+    -p|--png)
+      COMPREPLY=( $(compgen -f -X "!*.png" "$cur") )
+      return 0
+      ;;
+    -d|--dump)
+      return 0
+      ;;
+    *)
+      COMPREPLY=( $(compgen -W "$options $(_polybar_bars)" -- "$cur") )
+      ;;
+    esac
+  esac
+
+  for ((i = 0; i < ${#COMPREPLY[@]}; i++)); do
+    case ${COMPREPLY[i]} in
+    --*=) ;;
+    -*) COMPREPLY[i]+=" "
+    esac
+  done
+
+  return 0
+}
+
+complete -o filenames -o noquote -o nospace -F _polybar polybar

contrib/polybar-git.aur/PKGBUILD

@@ -1,31 +1,24 @@
-# Maintainer: Michael Carlberg <c@rlberg.se>
+# Maintainer: Patrick Ziegler <p.ziegler96@gmail.com>
-# Contributor: Michael Carlberg <c@rlberg.se>
 _pkgname=polybar
 pkgname="${_pkgname}-git"
-pkgver=3.2.0
+pkgver=3.7.2
 pkgrel=1
 pkgdesc="A fast and easy-to-use status bar"
-arch=("i686" "x86_64")
+# aarch64 is not officially supported by polybar, it is only listed here for convenience
-url="https://github.com/jaagr/polybar"
+arch=("i686" "x86_64" "aarch64")
+url="https://github.com/polybar/polybar"
 license=("MIT")
-depends=("cairo" "xcb-util-image" "xcb-util-wm" "xcb-util-xrm" "xcb-util-cursor")
+depends=("libuv" "cairo" "xcb-util-image" "xcb-util-wm" "xcb-util-xrm"
-optdepends=("alsa-lib: alsa module support"
+         "xcb-util-cursor" "alsa-lib" "libpulse" "libmpdclient" "libnl"
-            "pulseaudio: pulseaudio module support"
+         "jsoncpp" "curl")
-            "libmpdclient: mpd module support"
+optdepends=("i3-wm: i3 module support")
-            "libnl: network module support"
+makedepends=("cmake" "git" "python" "pkg-config" "python-sphinx"
-            "wireless_tools: network module support (legacy)"
+             "python-packaging" "i3-wm")
-            "jsoncpp: i3 module support"
+backup=("etc/polybar/config.ini")
-            "i3-wm: i3 module support"
-            "ttf-unifont: Font used in example config"
-            "siji-git: Font used in example config"
-            "xorg-fonts-misc: Font used in example config"
-            "curl: github module support")
-makedepends=("cmake" "git" "python" "python2" "pkg-config")
 provides=("polybar")
 conflicts=("polybar")
-install="${_pkgname}.install"
 source=("${_pkgname}::git+${url}.git")
-md5sums=("SKIP")
+sha256sums=("SKIP")
 
 pkgver() {
   git -C "${_pkgname}" describe --long --tags | sed "s/-/.r/;s/-/./g"
@@ -38,7 +31,8 @@ prepare() {
 
 build() {
   cd "${_pkgname}/build" || exit 1
-  cmake -DCMAKE_INSTALL_PREFIX=/usr ..
+  # Force cmake to use system python (to detect xcbgen)
+  cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DPYTHON_EXECUTABLE=/usr/bin/python3 ..
   cmake --build .
 }
 

contrib/polybar-git.aur/polybar.install

@@ -1,12 +0,0 @@
-post_install() {
-  cat << EOF
-
-  Get started with the example configuration:
-
-    $ install -Dm644 /usr/share/doc/polybar/config \$HOME/.config/polybar/config
-    $ polybar example
-
-  For more information, see https://github.com/jaagr/polybar/wiki
-
-EOF
-}

contrib/polybar.aur/PKGBUILD

@@ -1,42 +0,0 @@
-# Maintainer: Michael Carlberg <c@rlberg.se>
-# Contributor: Michael Carlberg <c@rlberg.se>
-pkgname=polybar
-pkgver=3.2.0
-pkgrel=1
-pkgdesc="A fast and easy-to-use status bar"
-arch=("i686" "x86_64")
-url="https://github.com/jaagr/polybar"
-license=("MIT")
-depends=("cairo" "xcb-util-image" "xcb-util-wm" "xcb-util-xrm" "xcb-util-cursor")
-optdepends=("alsa-lib: alsa module support"
-            "pulseaudio: pulseaudio module support"
-            "libmpdclient: mpd module support"
-            "libnl: network module support"
-            "wireless_tools: network module support (legacy)"
-            "jsoncpp: i3 module support"
-            "i3-wm: i3 module support"
-            "ttf-unifont: Font used in example config"
-            "siji-git: Font used in example config"
-            "xorg-fonts-misc: Font used in example config"
-            "curl: github module support")
-makedepends=("cmake" "git" "python" "python2" "pkg-config")
-conflicts=("polybar-git")
-install="${pkgname}.install"
-source=("${pkgname}::git+${url}.git#tag=${pkgver}")
-md5sums=("SKIP")
-
-prepare() {
-  git -C "${pkgname}" submodule update --init --recursive
-  mkdir -p "${pkgname}/build"
-}
-
-build() {
-  cd "${pkgname}/build" || exit 1
-  cmake -DCMAKE_INSTALL_PREFIX=/usr ..
-  cmake --build .
-}
-
-package() {
-  cmake --build "${pkgname}/build" --target install -- DESTDIR="${pkgdir}"
-  install -Dm644 "${pkgname}/LICENSE" "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
-}

contrib/polybar.aur/polybar.install

@@ -1,26 +0,0 @@
-post_install() {
-  cat << EOF
-
-  Get started with the example configuration:
-
-    $ install -Dm644 /usr/share/doc/polybar/config \$HOME/.config/polybar/config
-    $ polybar example
-
-  For more information, see https://github.com/jaagr/polybar/wiki
-
-EOF
-}
-
-post_upgrade() {
-  [ "$(vercmp "$2" "2.5.1-1")" = "-1" ] || exit 0
-  cat << EOF
-
-  The % suffix has been removed from percentage tokens.
-  The suffix is instead added by the user, for example:
-
-  format-charging = Capacity %percentage%%
-
-                                              -- jaagr
-
-EOF
-}

contrib/zsh/CMakeLists.txt

@@ -2,5 +2,5 @@
 # Zsh completion template
 #
 install(FILES _polybar _polybar_msg
-  DESTINATION share/zsh/site-functions
+  DESTINATION ${CMAKE_INSTALL_DATADIR}/zsh/site-functions
   COMPONENT tools)

contrib/zsh/_polybar

@@ -1,6 +1,6 @@
 #compdef polybar
 #
-# Completion for polybar (https://github.com/jaagr/polybar)
+# Completion for polybar (https://github.com/polybar/polybar)
 #   jaagr <c@rlberg.se>
 #
 _polybar() {
@@ -10,23 +10,41 @@ _polybar() {
   local R='-r --reload'
   local D='-d --dump'
   local M='-m --list-monitors'
+  local MM='-M --list-all-monitors'
   local W='-w --print-wmname'
   local S='-s --stdout'
 
   _arguments -n : \
     '(-)'{-h,--help}'[Display help text and exit]' \
     '(-)'{-v,--version}'[Display build details and exit]' \
-    "($L $Q)"{-l,--log=}'[Set the logging verbosity (default: warning)]:verbosity level:(error warning info trace)' \
+    "($L $Q)"{-l,--log=}'[Set the logging verbosity (default: notice)]:verbosity level:(error warning notice info trace)' \
     "($L $Q)"{-q,--quiet}'[Be quiet (will override -l)]' \
     "($C)"{-c,--config=}'[Path to the configuration file]:configuration file:_files' \
     "($R)"{-r,--reload}'[Reload when the configuration has been modified]' \
     "($D $R $M $W $S)"{-d,--dump=}'[Print parameter value in bar section and exit]:parameter name' \
-    "($M $D $R $W $S)"{-m,--list-monitors}'[Print list of available monitors and exit]' \
+    "($MM $M $D $R $W $S)"{-m,--list-monitors}'[Print list of available monitors (Excluding cloned monitors) and exit]' \
+    "($MM $M $D $R $W $S)"{-M,--list-all-monitors}'[Print list of all available monitors (Including cloned monitors) and exit]' \
     "($W $R $D $M $S)"{-w,--print-wmname}'[Print the generated WM_NAME and exit]' \
     "($S)"{-s,--stdout}'[Output data to stdout instead of drawing the X window]' \
     '::bar name:_polybar_list_names'
 }
 
+(( $+functions[_polybar_default_file] )) || _polybar_default_file() {
+  local suffix=/polybar/config.ini
+
+  local home_path=${XDG_CONFIG_HOME:-$HOME/.config}${suffix}
+  local etc_xdg_path=${XDG_CONFIG_DIRS:-/etc/xdg}${suffix}
+  local etc_path=/etc${suffix}
+
+  if [ -r "$home_path" ]; then
+    echo "$home_path"
+  elif [ -r "$etc_xdg_path" ]; then
+    echo "$etc_xdg_path"
+  elif [ -r "$etc_path" ]; then
+    echo "$etc_path"
+  fi
+}
+
 (( $+functions[_polybar_list_names] )) || _polybar_list_names() {
   local conf
   if (( $+opt_args[-c] )); then
@@ -34,9 +52,9 @@ _polybar() {
   elif (( $+opt_args[--config] )); then
     conf=${(e)opt_args[--config]}
   else
-    conf=${XDG_CONFIG_HOME:-$HOME/.config}/polybar/config
+    conf=$(_polybar_default_file)
   fi
-  local names; names=(${(f)"$(sed -nr 's|\[bar/([^\]+)\]$|\1|p' ${conf} 2>/dev/null)"})
+  local names; names=(${(f)"$(sed -nE 's|[[:space:]]*\[bar/([^\]+)\][[:space:]]*$|\1|p' ${conf} 2>/dev/null)"})
   _describe -t names 'configuration name' names
 }
 

contrib/zsh/_polybar_msg

@@ -1,6 +1,6 @@
 #compdef polybar-msg
 #
-# Completion for polybar-msg (https://github.com/jaagr/polybar)
+# Completion for polybar-msg (https://github.com/polybar/polybar)
 #   jaagr <c@rlberg.se>
 #
 _polybar_msg() {

doc/.gitignore

@@ -0,0 +1 @@
+build

doc/CMakeLists.txt

@@ -1,94 +1,80 @@
-#
+set(SPHINX_BUILD "sphinx-build" CACHE STRING "Name/Path of the sphinx-build executable to use.")
-# Generate configuration file
+set(SPHINX_FLAGS "" CACHE STRING "Flags to pass to sphinx-build")
-#
 
-set(MODULES_LEFT "bspwm i3")
+find_program(BIN_SPHINX "${SPHINX_BUILD}")
-set(MODULES_CENTER "mpd")
-set(MODULES_RIGHT "filesystem xbacklight alsa pulseaudio xkeyboard memory cpu wlan eth battery temperature date powermenu")
 
-set(FONT_FIXED "fixed:pixelsize=10")
+if(NOT BIN_SPHINX)
-set(FONT_UNIFONT "unifont:fontformat=truetype")
+  message(FATAL_ERROR "sphinx-build executable '${SPHINX_BUILD}' not found.")
-set(FONT_SIJI "siji:pixelsize=10")
-
-queryfont(FONT_FIXED ${FONT_FIXED} FIELDS family pixelsize)
-queryfont(FONT_UNIFONT ${FONT_UNIFONT} FIELDS family fontformat)
-queryfont(FONT_SIJI ${FONT_SIJI} FIELDS family pixelsize)
-
-# Strip disabled modules {{{
-
-if(NOT ENABLE_PULSEAUDIO)
-  string(REPLACE " pulseaudio" "" MODULES_RIGHT ${MODULES_RIGHT})
-endif()
-if(NOT ENABLE_ALSA)
-  string(REPLACE " alsa" "" MODULES_RIGHT ${MODULES_RIGHT})
-endif()
-if(NOT ENABLE_I3)
-  string(REPLACE " i3" "" MODULES_LEFT ${MODULES_LEFT})
-endif()
-if(NOT ENABLE_MPD)
-  string(REPLACE "mpd" "" MODULES_CENTER ${MODULES_CENTER})
-endif()
-if(NOT ENABLE_NETWORK)
-  string(REPLACE " wlan eth" "" MODULES_RIGHT ${MODULES_RIGHT})
-endif()
-if(NOT WITH_XRANDR)
-  string(REPLACE "xbacklight " "backlight-acpi " MODULES_RIGHT ${MODULES_RIGHT})
-endif()
-if(NOT WITH_XKB)
-  string(REPLACE "xkeyboard " "" MODULES_RIGHT ${MODULES_RIGHT})
 endif()
 
-# }}}
+separate_arguments(sphinx_flags UNIX_COMMAND "${SPHINX_FLAGS}")
-# Get battery/adapter name {{{
 
-string(REGEX REPLACE /%battery%.* "" PATH_BAT ${SETTING_PATH_BATTERY})
+set(doc_path "${CMAKE_CURRENT_SOURCE_DIR}")
-string(REGEX REPLACE /%adapter%.* "" PATH_ADP ${SETTING_PATH_ADAPTER})
+
-file(GLOB BAT_LIST RELATIVE ${PATH_BAT} ${PATH_ADP}/B*)
+# Configures conf.py in the current folder and puts it in the build folder
-file(GLOB ADP_LIST RELATIVE ${PATH_ADP} ${PATH_ADP}/A*)
+configure_file(conf.py conf.py @ONLY)
-if(BAT_LIST)
+
-  list(GET BAT_LIST 0 BATTERY)
+# We want to run `sphinx-build` with the following builders
-else()
+if (BUILD_DOC_HTML)
-  set(BATTERY BAT0)
+  list(APPEND doc_builders "html")
-endif()
-if(ADP_LIST)
-  list(GET ADP_LIST 0 ADAPTER)
-else()
-  set(ADAPTER ADP1)
 endif()
 
-# }}}
+if (BUILD_DOC_MAN)
-# Get network interfaces {{{
+  list(APPEND doc_builders "man")
-
-if(ENABLE_NETWORK)
-  file(GLOB IFLIST RELATIVE /sys/class/net /sys/class/net/*)
-  foreach(INTERFACE ${IFLIST})
-    if(NOT ${INTERFACE} STREQUAL "lo")
-      file(GLOB IS_WIRELESS /sys/class/net/${INTERFACE}/wireless)
-      if(IS_WIRELESS)
-        set(INTERFACE_WLAN ${INTERFACE})
-      else()
-        set(INTERFACE_ETH ${INTERFACE})
-      endif()
-    endif()
-  endforeach()
-  if(NOT INTERFACE_ETH)
-    set(INTERFACE_ETH net0)
-  endif()
-  if(NOT INTERFACE_WLAN)
-    set(INTERFACE_WLAN net1)
-  endif()
 endif()
 
-# }}}
+# Name of all documentation targets
-# Configure and install {{{
+set(doc_targets "")
 
-configure_file(
+foreach(builder ${doc_builders})
-  ${CMAKE_CURRENT_LIST_DIR}/config.cmake
+  set(doc_target "doc_${builder}")
-  ${CMAKE_CURRENT_LIST_DIR}/config
+  set(builder_log "builder-${builder}.log")
-  ESCAPE_QUOTES @ONLY)
+  add_custom_target(${doc_target}
+    COMMAND ${BIN_SPHINX}
+            -b ${builder}
+            # conf.py dir
+            -c "${CMAKE_CURRENT_BINARY_DIR}"
+            -d "${CMAKE_CURRENT_BINARY_DIR}/doctrees"
+            -n
+            ${sphinx_flags}
+            # Documentation source file dir
+            "${CMAKE_CURRENT_SOURCE_DIR}"
+            # Output dir
+            "${CMAKE_CURRENT_BINARY_DIR}/${builder}" > ${builder_log}
+    COMMENT "sphinx-build ${builder}: see doc/${builder_log}")
 
-install(FILES config
+  list(APPEND doc_targets ${doc_target})
-  DESTINATION share/doc/polybar
+endforeach()
-  COMPONENT config)
+
+# Dummy target that depends on all documentation targets
+add_custom_target(doc ALL DEPENDS ${doc_targets})
+
+if (BUILD_DOC_HTML)
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/
+  DESTINATION ${CMAKE_INSTALL_DOCDIR}
+  COMPONENT doc
+  PATTERN ".buildinfo" EXCLUDE)
+endif()
+
+install(FILES ${CMAKE_SOURCE_DIR}/CHANGELOG.md
+  DESTINATION ${CMAKE_INSTALL_DOCDIR}
+  COMPONENT doc)
+
+install(FILES ${CMAKE_CURRENT_LIST_DIR}/config.ini
+  DESTINATION ${CMAKE_INSTALL_DOCDIR}/examples
+  COMPONENT doc)
+
+if (BUILD_DOC_MAN)
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar.1
+  DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
+  COMPONENT doc)
+
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar-msg.1
+  DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
+  COMPONENT doc)
+
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/polybar.5
+  DESTINATION ${CMAKE_INSTALL_MANDIR}/man5
+  COMPONENT doc)
+endif()
 
-# }}}

doc/README.md

@@ -0,0 +1,19 @@
+Polybar Manual
+==============
+
+The official polybar documentation lives here.
+
+The html documentation and man pages are built automatically when you build with cmake (cmake creates the custom
+target `doc`).
+
+## Preview Locally
+The documentation uses [Sphinx](https://www.sphinx-doc.org/en/stable/) to generate the documentation, so you will need to
+have that installed.
+
+If you build polybar normally while having Sphinx installed during configuration, the documentation will be enabled and
+built as well. Building the documentation can be disabled by passing `-DBUILD_DOC=OFF` to `cmake`.
+
+Once configured, all of the documentation can be generated with `make doc` or use `make doc_html` or `make doc_man` to
+only generate the html documentation or the man pages respectively.
+
+The HTML documentation is in `doc/html/index.html` in your build directory and the man pages are in `doc/man`.

doc/_templates/layout.html

@@ -0,0 +1,26 @@
+{% extends "!layout.html" -%}
+{# Refer to https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html #}
+
+{%- block document %}
+{#
+  Adds a warning message on the 'latest' version.
+  The warning is only added on readthedocs, if the version is 'latest'.
+  For the 'dev' folder, no warning is shown since the 'latest' version is
+  usually the most up-to-date.
+#}
+{% if READTHEDOCS and polybar_is_latest and not pagename.startswith('dev/') %}
+<div class="admonition important">
+  <p class="admonition-title">Development Version</p>
+  <p>
+  This is the <code class="docutils literal notranslate"><span class="pre">latest</span></code>
+  (unstable) version of this documentation, which may document features
+  not available in or compatible with released stable versions of polybar.
+  </p>
+  <p>
+  See the <a href="https://polybar.readthedocs.io/{{ pagename }}.html">stable version</a> of this documentation page instead.
+  </p>
+</div>
+{% endif %}
+
+{{ super() }}
+{%- endblock %}

doc/bash/polybar

@@ -1,93 +0,0 @@
-_polybar_config_file() {
-	local config_path=${XDG_CONFIG_HOME:-$HOME/.config}/polybar/config
-
-	for ((i = 0; i < COMP_CWORD; i++)); do
-		case ${COMP_WORDS[i]} in
-		--config)
-			config_path=${COMP_WORDS[i + 2]}
-			break
-			;;
-		-c)
-			config_path=${COMP_WORDS[i + 1]}
-			break
-			;;
-		esac
-	done
-
-	# Use eval + cd for to get bash's parameter/tilde expansion etc
-	(eval cd $(dirname "$config_path"); echo $PWD/$(basename "$config_path"))
-}
-
-_polybar_bars() {
-	local config_file=$(_polybar_config_file)
-
-	if [ -r "$config_file" ]; then
-		grep -Po '\[bar/\K(.*)(?=\])' "$config_file"
-	fi
-}
-
-_polybar() {
-	local options='-h --help
-	               -v --version
-	               -l --log=
-	               -q --quiet
-	               -c --config=
-	               -r --reload
-	               -d --dump=
-	               -m --list-monitors
-	               -w --print-wmname
-	               -s --stdout
-	               -p --png='
-
-	local log_levels='error
-	                  warning
-	                  info
-	                  trace'
-
-	COMPREPLY=()
-
-	local cur=${COMP_WORDS[COMP_CWORD]}
-	case "$cur" in
-	-*)
-		COMPREPLY=( $(compgen -W "$options" -- "$cur") )
-		;;
-	*)
-		local prev=${COMP_WORDS[COMP_CWORD - 1]}
-		if [ "$prev" = "=" ]; then
-			prev=${COMP_WORDS[COMP_CWORD - 2]}
-		fi
-
-		case "$prev" in
-		-l|--log)
-			COMPREPLY=( $(compgen -W "$log_levels" -- "$cur") )
-			return 0
-			;;
-		-c|--config)
-			COMPREPLY=( $(compgen -f "$cur") )
-			return 0
-			;;
-		-p|--png)
-			COMPREPLY=( $(compgen -f -X "!*.png" "$cur") )
-			return 0
-			;;
-		# TODO: read properties of the selected bar from config
-		-d|--dump)
-			return 0
-			;;
-		*)
-			COMPREPLY=( $(compgen -W "$options $(_polybar_bars)" -- "$cur") )
-			;;
-		esac
-	esac
-
-	for ((i = 0; i < ${#COMPREPLY[@]}; i++)); do
-		case ${COMPREPLY[i]} in
-		--*=) ;;
-		-*) COMPREPLY[i]+=" "
-		esac
-	done
-
-	return 0
-}
-
-complete -o filenames -o noquote -o nospace -F _polybar polybar

doc/conf.py

@@ -0,0 +1,354 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# https://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+from pathlib import Path
+import datetime
+import sphinx
+import packaging.version
+
+from sphinx.util.docfields import Field
+from sphinx.locale import _
+
+
+def get_version(root_path):
+    """
+    Reads the polybar version from the version.txt at the root of the repo.
+    """
+    path = Path(root_path) / "version.txt"
+    with open(path, "r") as f:
+        for line in f.readlines():
+            if not line.startswith("#"):
+                # NB: we can't parse it yet since sphinx could import
+                # pkg_resources later on and it could patch packaging.version
+                return line
+
+    raise RuntimeError("No version found in {}".format(path))
+
+
+sphinx_version = packaging.version.parse(sphinx.__version__)
+
+# -- Project information -----------------------------------------------------
+
+
+project = 'Polybar User Manual'
+copyright = '2016-{}, Michael Carlberg & contributors'.format(
+    datetime.datetime.now().year
+)
+author = 'Polybar Team'
+
+# is whether we are on readthedocs.io
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if on_rtd:
+    # On readthedocs, cmake isn't run so the version string isn't available
+    version = os.environ.get('READTHEDOCS_VERSION', None)
+else:
+    # The short X.Y version
+    version = '@APP_VERSION@'
+
+# The full version, including alpha/beta/rc tags
+release = version
+
+# Set path to documentation
+if on_rtd:
+    # On readthedocs conf.py is already in the doc folder
+    doc_path = '.'
+else:
+    # In all other builds conf.py is configured with cmake and put into the
+    # build folder.
+    doc_path = '@doc_path@'
+
+# The version from the version.txt file. Since we are not always first
+# configured by cmake, we don't necessarily have access to the current version
+# number
+version_txt = get_version(Path(doc_path).absolute().parent)
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.extlinks",
+]
+
+if on_rtd:
+    extensions += [
+        # The custom 404 page is only needed
+        "notfound.extension",
+        # The search extension works only on readthedocs
+        # See https://readthedocs-sphinx-search.readthedocs.io
+        "sphinx_search.extension",
+    ]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = [doc_path + '/_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+# language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+highlight_language = 'none'
+
+smartquotes = False
+
+# Quickly link to issues or PRs using :issue:`...` or :pull:`...`
+if sphinx_version >= packaging.version.parse("4.0.0"):
+    extlinks = {
+        "issue": ("https://github.com/polybar/polybar/issues/%s", "#%s"),
+        "pull": ("https://github.com/polybar/polybar/pull/%s", "PR #%s"),
+    }
+else:
+    # Versions before 4.0 (e.g. on readthedocs) do not support %s in the
+    # caption and simply append the value
+    extlinks = {
+        "issue": ("https://github.com/polybar/polybar/issues/%s", "#"),
+        "pull": ("https://github.com/polybar/polybar/pull/%s", "PR #"),
+    }
+
+extlinks_detect_hardcoded_links = True
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {}
+
+html_context = {
+        'polybar_is_latest': version == 'latest',
+}
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+if on_rtd or os.environ.get('USE_RTD_THEME', '0') == '1':
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_options['collapse_navigation'] = False
+    html_theme_options['style_external_links'] = True
+else:
+    html_theme = 'alabaster'
+    html_theme_options['description'] = version
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = [doc_path + '/_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'polybardoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'polybar.tex', 'polybar Documentation',
+     'Polybar Team', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        'man/polybar.1', 'polybar',
+        'A fast and easy-to-use tool status bar', [], 1
+    ),
+    (
+        'man/polybar-msg.1', 'polybar-msg',
+        'Send IPC messages to polybar', [], 1
+    ),
+    (
+        'man/polybar.5', 'polybar',
+        'configuration file for polybar(1)', [], 5
+    )
+]
+
+man_make_section_directory = False
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'polybar', 'polybar Documentation',
+     author, 'polybar', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# The 'versionadded' and 'versionchanged' directives are overridden.
+suppress_warnings = ['app.add_directive']
+
+
+def setup(app):
+
+    # Adds a new directive for document a polybar config setting
+    # Inside goes the description of the option as well as custom roles to
+    # document the type, default value, etc:
+    # .. poly-setting:: NAME
+    #
+    #   Description
+    #   :type: ...
+    #   :default: ...
+    app.add_object_type(
+        'poly-setting',
+        'poly-setting',
+        objname='configuration value',
+        indextemplate='pair: %s; configuration value',
+        doc_field_types=[
+            Field('type',
+                  label=_("Type"),
+                  names=['type'],
+                  has_arg=False,
+                  ),
+            Field('tags',
+                  label=_("Available Tags"),
+                  names=['tags'],
+                  has_arg=False,
+                  ),
+            Field('tokens',
+                  label=_("Supported Tokens"),
+                  names=['tokens'],
+                  has_arg=False,
+                  ),
+            Field('default',
+                  label=_("Default Value"),
+                  names=['default'],
+                  has_arg=False,
+                  ),
+        ]
+    )
+
+    try:
+        inject_version_directives(app)
+    except NameError:
+        # Function was not defined because sphinx version was too low
+        pass
+
+
+# It is not exactly clear in which version the VersionChange class was
+# introduced, but we know it is available in at least 1.8.5.
+# This feature is mainly needed for the online docs on readthedocs for the docs
+# built from master, documentation built for proper releases should not even
+# mention unreleased changes. Because of that it's not that important that this
+# is added to local builds.
+if sphinx_version >= packaging.version.parse("1.8.5"):
+
+    from typing import List
+    from docutils.nodes import Node
+    from sphinx.domains.changeset import VersionChange
+
+    def inject_version_directives(app):
+        app.add_directive('deprecated', VersionDirective)
+        app.add_directive('versionadded', VersionDirective)
+        app.add_directive('versionchanged', VersionDirective)
+
+    class VersionDirective(VersionChange):
+        """
+        Overwrites the Sphinx directive for versionchanged, versionadded, and
+        deprecated and adds an unreleased tag to versions that are not yet
+        released
+        """
+
+        def run(self) -> List[Node]:
+            directive_version = packaging.version.parse(self.arguments[0])
+            parsed_version_txt = packaging.version.parse(version_txt)
+
+            if directive_version > parsed_version_txt:
+                self.arguments[0] += " (unreleased)"
+
+            return super().run()

doc/config.cmake

@@ -1,423 +0,0 @@
-;==========================================================
-;
-;
-;   ██████╗  ██████╗ ██╗  ██╗   ██╗██████╗  █████╗ ██████╗
-;   ██╔══██╗██╔═══██╗██║  ╚██╗ ██╔╝██╔══██╗██╔══██╗██╔══██╗
-;   ██████╔╝██║   ██║██║   ╚████╔╝ ██████╔╝███████║██████╔╝
-;   ██╔═══╝ ██║   ██║██║    ╚██╔╝  ██╔══██╗██╔══██║██╔══██╗
-;   ██║     ╚██████╔╝███████╗██║   ██████╔╝██║  ██║██║  ██║
-;   ╚═╝      ╚═════╝ ╚══════╝╚═╝   ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝
-;
-;
-;   To learn more about how to configure Polybar
-;   go to https://github.com/jaagr/polybar
-;
-;   The README contains alot of information
-;
-;==========================================================
-
-[colors]
-;background = ${xrdb:color0:#222}
-background = #222
-background-alt = #444
-;foreground = ${xrdb:color7:#222}
-foreground = #dfdfdf
-foreground-alt = #555
-primary = #ffb52a
-secondary = #e60053
-alert = #bd2c40
-
-[bar/example]
-;monitor = ${env:MONITOR:HDMI-1}
-width = 100%
-height = 27
-;offset-x = 1%
-;offset-y = 1%
-radius = 6.0
-fixed-center = false
-
-background = ${colors.background}
-foreground = ${colors.foreground}
-
-line-size = 3
-line-color = #f00
-
-border-size = 4
-border-color = #00000000
-
-padding-left = 0
-padding-right = 2
-
-module-margin-left = 1
-module-margin-right = 2
-
-font-0 = @FONT_FIXED@;1
-font-1 = @FONT_UNIFONT@:size=8:antialias=false;0
-font-2 = @FONT_SIJI@;1
-
-modules-left = @MODULES_LEFT@
-modules-center = @MODULES_CENTER@
-modules-right = @MODULES_RIGHT@
-
-tray-position = right
-tray-padding = 2
-;tray-transparent = true
-;tray-background = #0063ff
-
-;wm-restack = bspwm
-;wm-restack = i3
-
-;override-redirect = true
-
-;scroll-up = bspwm-desknext
-;scroll-down = bspwm-deskprev
-
-;scroll-up = i3wm-wsnext
-;scroll-down = i3wm-wsprev
-
-cursor-click = pointer
-cursor-scroll = ns-resize
-
-[module/xwindow]
-type = internal/xwindow
-label = %title:0:30:...%
-
-[module/xkeyboard]
-type = internal/xkeyboard
-blacklist-0 = num lock
-
-format-prefix = " "
-format-prefix-foreground = ${colors.foreground-alt}
-format-prefix-underline = ${colors.secondary}
-
-label-layout = %layout%
-label-layout-underline = ${colors.secondary}
-
-label-indicator-padding = 2
-label-indicator-margin = 1
-label-indicator-background = ${colors.secondary}
-label-indicator-underline = ${colors.secondary}
-
-[module/filesystem]
-type = internal/fs
-interval = 25
-
-mount-0 = /
-
-label-mounted = %{F#0a81f5}%mountpoint%%{F-}: %percentage_used%%
-label-unmounted = %mountpoint% not mounted
-label-unmounted-foreground = ${colors.foreground-alt}
-
-[module/bspwm]
-type = internal/bspwm
-
-label-focused = %index%
-label-focused-background = ${colors.background-alt}
-label-focused-underline= ${colors.primary}
-label-focused-padding = 2
-
-label-occupied = %index%
-label-occupied-padding = 2
-
-label-urgent = %index%!
-label-urgent-background = ${colors.alert}
-label-urgent-padding = 2
-
-label-empty = %index%
-label-empty-foreground = ${colors.foreground-alt}
-label-empty-padding = 2
-
-; Separator in between workspaces
-; label-separator = |
-
-[module/i3]
-type = internal/i3
-format = <label-state> <label-mode>
-index-sort = true
-wrapping-scroll = false
-
-; Only show workspaces on the same output as the bar
-;pin-workspaces = true
-
-label-mode-padding = 2
-label-mode-foreground = #000
-label-mode-background = ${colors.primary}
-
-; focused = Active workspace on focused monitor
-label-focused = %index%
-label-focused-background = ${module/bspwm.label-focused-background}
-label-focused-underline = ${module/bspwm.label-focused-underline}
-label-focused-padding = ${module/bspwm.label-focused-padding}
-
-; unfocused = Inactive workspace on any monitor
-label-unfocused = %index%
-label-unfocused-padding = ${module/bspwm.label-occupied-padding}
-
-; visible = Active workspace on unfocused monitor
-label-visible = %index%
-label-visible-background = ${self.label-focused-background}
-label-visible-underline = ${self.label-focused-underline}
-label-visible-padding = ${self.label-focused-padding}
-
-; urgent = Workspace with urgency hint set
-label-urgent = %index%
-label-urgent-background = ${module/bspwm.label-urgent-background}
-label-urgent-padding = ${module/bspwm.label-urgent-padding}
-
-; Separator in between workspaces
-; label-separator = |
-
-
-[module/mpd]
-type = internal/mpd
-format-online = <label-song>  <icon-prev> <icon-stop> <toggle> <icon-next>
-
-icon-prev = 
-icon-stop = 
-icon-play = 
-icon-pause = 
-icon-next = 
-
-label-song-maxlen = 25
-label-song-ellipsis = true
-
-[module/xbacklight]
-type = internal/xbacklight
-
-format = <label> <bar>
-label = BL
-
-bar-width = 10
-bar-indicator = |
-bar-indicator-foreground = #fff
-bar-indicator-font = 2
-bar-fill = ─
-bar-fill-font = 2
-bar-fill-foreground = #9f78e1
-bar-empty = ─
-bar-empty-font = 2
-bar-empty-foreground = ${colors.foreground-alt}
-
-[module/backlight-acpi]
-inherit = module/xbacklight
-type = internal/backlight
-card = intel_backlight
-
-[module/cpu]
-type = internal/cpu
-interval = 2
-format-prefix = " "
-format-prefix-foreground = ${colors.foreground-alt}
-format-underline = #f90000
-label = %percentage:2%%
-
-[module/memory]
-type = internal/memory
-interval = 2
-format-prefix = " "
-format-prefix-foreground = ${colors.foreground-alt}
-format-underline = #4bffdc
-label = %percentage_used%%
-
-[module/wlan]
-type = internal/network
-interface = @INTERFACE_WLAN@
-interval = 3.0
-
-format-connected = <ramp-signal> <label-connected>
-format-connected-underline = #9f78e1
-label-connected = %essid%
-
-format-disconnected =
-;format-disconnected = <label-disconnected>
-;format-disconnected-underline = ${self.format-connected-underline}
-;label-disconnected = %ifname% disconnected
-;label-disconnected-foreground = ${colors.foreground-alt}
-
-ramp-signal-0 = 
-ramp-signal-1 = 
-ramp-signal-2 = 
-ramp-signal-3 = 
-ramp-signal-4 = 
-ramp-signal-foreground = ${colors.foreground-alt}
-
-[module/eth]
-type = internal/network
-interface = @INTERFACE_ETH@
-interval = 3.0
-
-format-connected-underline = #55aa55
-format-connected-prefix = " "
-format-connected-prefix-foreground = ${colors.foreground-alt}
-label-connected = %local_ip%
-
-format-disconnected =
-;format-disconnected = <label-disconnected>
-;format-disconnected-underline = ${self.format-connected-underline}
-;label-disconnected = %ifname% disconnected
-;label-disconnected-foreground = ${colors.foreground-alt}
-
-[module/date]
-type = internal/date
-interval = 5
-
-date =
-date-alt = " %Y-%m-%d"
-
-time = %H:%M
-time-alt = %H:%M:%S
-
-format-prefix = 
-format-prefix-foreground = ${colors.foreground-alt}
-format-underline = #0a6cf5
-
-label = %date% %time%
-
-[module/pulseaudio]
-type = internal/pulseaudio
-
-format-volume = <label-volume> <bar-volume>
-label-volume = VOL %percentage%%
-label-volume-foreground = ${root.foreground}
-
-label-muted = 🔇 muted
-label-muted-foreground = #666
-
-bar-volume-width = 10
-bar-volume-foreground-0 = #55aa55
-bar-volume-foreground-1 = #55aa55
-bar-volume-foreground-2 = #55aa55
-bar-volume-foreground-3 = #55aa55
-bar-volume-foreground-4 = #55aa55
-bar-volume-foreground-5 = #f5a70a
-bar-volume-foreground-6 = #ff5555
-bar-volume-gradient = false
-bar-volume-indicator = |
-bar-volume-indicator-font = 2
-bar-volume-fill = ─
-bar-volume-fill-font = 2
-bar-volume-empty = ─
-bar-volume-empty-font = 2
-bar-volume-empty-foreground = ${colors.foreground-alt}
-
-[module/alsa]
-type = internal/alsa
-
-format-volume = <label-volume> <bar-volume>
-label-volume = VOL
-label-volume-foreground = ${root.foreground}
-
-format-muted-prefix = " "
-format-muted-foreground = ${colors.foreground-alt}
-label-muted = sound muted
-
-bar-volume-width = 10
-bar-volume-foreground-0 = #55aa55
-bar-volume-foreground-1 = #55aa55
-bar-volume-foreground-2 = #55aa55
-bar-volume-foreground-3 = #55aa55
-bar-volume-foreground-4 = #55aa55
-bar-volume-foreground-5 = #f5a70a
-bar-volume-foreground-6 = #ff5555
-bar-volume-gradient = false
-bar-volume-indicator = |
-bar-volume-indicator-font = 2
-bar-volume-fill = ─
-bar-volume-fill-font = 2
-bar-volume-empty = ─
-bar-volume-empty-font = 2
-bar-volume-empty-foreground = ${colors.foreground-alt}
-
-[module/battery]
-type = internal/battery
-battery = @BATTERY@
-adapter = @ADAPTER@
-full-at = 98
-
-format-charging = <animation-charging> <label-charging>
-format-charging-underline = #ffb52a
-
-format-discharging = <animation-discharging> <label-discharging>
-format-discharging-underline = ${self.format-charging-underline}
-
-format-full-prefix = " "
-format-full-prefix-foreground = ${colors.foreground-alt}
-format-full-underline = ${self.format-charging-underline}
-
-ramp-capacity-0 = 
-ramp-capacity-1 = 
-ramp-capacity-2 = 
-ramp-capacity-foreground = ${colors.foreground-alt}
-
-animation-charging-0 = 
-animation-charging-1 = 
-animation-charging-2 = 
-animation-charging-foreground = ${colors.foreground-alt}
-animation-charging-framerate = 750
-
-animation-discharging-0 = 
-animation-discharging-1 = 
-animation-discharging-2 = 
-animation-discharging-foreground = ${colors.foreground-alt}
-animation-discharging-framerate = 750
-
-[module/temperature]
-type = internal/temperature
-thermal-zone = 0
-warn-temperature = 60
-
-format = <ramp> <label>
-format-underline = #f50a4d
-format-warn = <ramp> <label-warn>
-format-warn-underline = ${self.format-underline}
-
-label = %temperature-c%
-label-warn = %temperature-c%
-label-warn-foreground = ${colors.secondary}
-
-ramp-0 = 
-ramp-1 = 
-ramp-2 = 
-ramp-foreground = ${colors.foreground-alt}
-
-[module/powermenu]
-type = custom/menu
-
-expand-right = true
-
-format-spacing = 1
-
-label-open = 
-label-open-foreground = ${colors.secondary}
-label-close =  cancel
-label-close-foreground = ${colors.secondary}
-label-separator = |
-label-separator-foreground = ${colors.foreground-alt}
-
-menu-0-0 = reboot
-menu-0-0-exec = menu-open-1
-menu-0-1 = power off
-menu-0-1-exec = menu-open-2
-
-menu-1-0 = cancel
-menu-1-0-exec = menu-open-0
-menu-1-1 = reboot
-menu-1-1-exec = sudo reboot
-
-menu-2-0 = power off
-menu-2-0-exec = sudo poweroff
-menu-2-1 = cancel
-menu-2-1-exec = menu-open-0
-
-[settings]
-screenchange-reload = true
-;compositing-background = xor
-;compositing-background = screen
-;compositing-foreground = source
-;compositing-border = over
-
-[global/wm]
-margin-top = 5
-margin-bottom = 5
-
-; vim:ft=dosini

doc/config.ini

@@ -0,0 +1,184 @@
+;==========================================================
+;
+;
+;   ██████╗  ██████╗ ██╗  ██╗   ██╗██████╗  █████╗ ██████╗
+;   ██╔══██╗██╔═══██╗██║  ╚██╗ ██╔╝██╔══██╗██╔══██╗██╔══██╗
+;   ██████╔╝██║   ██║██║   ╚████╔╝ ██████╔╝███████║██████╔╝
+;   ██╔═══╝ ██║   ██║██║    ╚██╔╝  ██╔══██╗██╔══██║██╔══██╗
+;   ██║     ╚██████╔╝███████╗██║   ██████╔╝██║  ██║██║  ██║
+;   ╚═╝      ╚═════╝ ╚══════╝╚═╝   ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝
+;
+;
+;   To learn more about how to configure Polybar
+;   go to https://github.com/polybar/polybar
+;
+;   The README contains a lot of information
+;
+;==========================================================
+
+[colors]
+background = #282A2E
+background-alt = #373B41
+foreground = #C5C8C6
+primary = #F0C674
+secondary = #8ABEB7
+alert = #A54242
+disabled = #707880
+
+[bar/example]
+width = 100%
+height = 24pt
+radius = 6
+
+; dpi = 96
+
+background = ${colors.background}
+foreground = ${colors.foreground}
+
+line-size = 3pt
+
+border-size = 4pt
+border-color = #00000000
+
+padding-left = 0
+padding-right = 1
+
+module-margin = 1
+
+separator = |
+separator-foreground = ${colors.disabled}
+
+font-0 = monospace;2
+
+modules-left = xworkspaces xwindow
+modules-right = filesystem pulseaudio xkeyboard memory cpu wlan eth date
+
+cursor-click = pointer
+cursor-scroll = ns-resize
+
+enable-ipc = true
+
+; wm-restack = generic
+; wm-restack = bspwm
+; wm-restack = i3
+
+; override-redirect = true
+
+; This module is not active by default (to enable it, add it to one of the
+; modules-* list above).
+; Please note that only a single tray can exist at any time. If you launch
+; multiple bars with this module, only a single one will show it, the others
+; will produce a warning. Which bar gets the module is timing dependent and can
+; be quite random.
+; For more information, see the documentation page for this module:
+; https://polybar.readthedocs.io/en/stable/user/modules/tray.html
+[module/systray]
+type = internal/tray
+
+format-margin = 8pt
+tray-spacing = 16pt
+
+[module/xworkspaces]
+type = internal/xworkspaces
+
+label-active = %name%
+label-active-background = ${colors.background-alt}
+label-active-underline= ${colors.primary}
+label-active-padding = 1
+
+label-occupied = %name%
+label-occupied-padding = 1
+
+label-urgent = %name%
+label-urgent-background = ${colors.alert}
+label-urgent-padding = 1
+
+label-empty = %name%
+label-empty-foreground = ${colors.disabled}
+label-empty-padding = 1
+
+[module/xwindow]
+type = internal/xwindow
+label = %title:0:60:...%
+
+[module/filesystem]
+type = internal/fs
+interval = 25
+
+mount-0 = /
+
+label-mounted = %{F#F0C674}%mountpoint%%{F-} %percentage_used%%
+
+label-unmounted = %mountpoint% not mounted
+label-unmounted-foreground = ${colors.disabled}
+
+[module/pulseaudio]
+type = internal/pulseaudio
+
+format-volume-prefix = "VOL "
+format-volume-prefix-foreground = ${colors.primary}
+format-volume = <label-volume>
+
+label-volume = %percentage%%
+
+label-muted = muted
+label-muted-foreground = ${colors.disabled}
+
+[module/xkeyboard]
+type = internal/xkeyboard
+blacklist-0 = num lock
+
+label-layout = %layout%
+label-layout-foreground = ${colors.primary}
+
+label-indicator-padding = 2
+label-indicator-margin = 1
+label-indicator-foreground = ${colors.background}
+label-indicator-background = ${colors.secondary}
+
+[module/memory]
+type = internal/memory
+interval = 2
+format-prefix = "RAM "
+format-prefix-foreground = ${colors.primary}
+label = %percentage_used:2%%
+
+[module/cpu]
+type = internal/cpu
+interval = 2
+format-prefix = "CPU "
+format-prefix-foreground = ${colors.primary}
+label = %percentage:2%%
+
+[network-base]
+type = internal/network
+interval = 5
+format-connected = <label-connected>
+format-disconnected = <label-disconnected>
+label-disconnected = %{F#F0C674}%ifname%%{F#707880} disconnected
+
+[module/wlan]
+inherit = network-base
+interface-type = wireless
+label-connected = %{F#F0C674}%ifname%%{F-} %essid% %local_ip%
+
+[module/eth]
+inherit = network-base
+interface-type = wired
+label-connected = %{F#F0C674}%ifname%%{F-} %local_ip%
+
+[module/date]
+type = internal/date
+interval = 1
+
+date = %H:%M
+date-alt = %Y-%m-%d %H:%M:%S
+
+label = %date%
+label-foreground = ${colors.primary}
+
+[settings]
+screenchange-reload = true
+pseudo-transparency = true
+
+; vim:ft=dosini

doc/dev/getting-started.rst

@@ -0,0 +1,41 @@
+Getting Started
+===============
+
+Setting up polybar for development is basically the same process as `compiling
+it from source <https://github.com/polybar/polybar/wiki/Compiling>`_.
+However, we recommend using the ``Debug`` or ``Sanitize`` cmake build type when
+configuring the project:
+
+.. code-block:: shell
+
+  cmake -DCMAKE_BUILD_TYPE=Debug ..
+  # Or
+  cmake -DCMAKE_BUILD_TYPE=Sanitize ..
+
+This will give you debug symbols in the executable and the ``Sanitize`` build
+type will also enable the ``AddressSanitizer`` and
+``UndefinedBehaviorSanitizer``, which can give you very useful information
+about crashes and undefined behavior at runtime.
+
+Editors
+-------
+
+Since this is a cmake project, most IDEs will have built-in support or a plugin
+to automatically setup this project.
+
+In addition, the ``cmake`` command creates a ``compile_commands.json`` file in
+the build folder, which can be used by many `language servers
+<https://microsoft.github.io/language-server-protocol/>`_.
+If you are using a C++ language server in your editor, it should be as easy as
+symlinking the ``compile_commands.json`` into the repo root directory:
+
+.. code-block:: shell
+
+  ln -s build/compile_commands.json .
+
+Distro-Specific Setup
+---------------------
+
+The wiki contains user-contributed `setup tips
+<https://github.com/polybar/polybar/wiki/Distro-Specific-Setup>`_ for some
+distros.

doc/dev/packaging.rst

@@ -0,0 +1,87 @@
+Packaging Polybar
+=================
+
+Do you want to package polybar for a distro? Great! Read this page to get
+started.
+
+First Steps
+-----------
+
+Before you get started, have a look at the `Packaging Label
+<https://github.com/polybar/polybar/issues?q=label%3APackaging>`_ on our GitHub
+repo and `Repology <https://repology.org/project/polybar/versions>`_ to see if
+polybar is already packaged for that distro or if there are efforts to do so.
+
+Even if a package already exists, it might still make sense for you to package
+polybar in some cases. Some of these cases are:
+
+- The existing package is out-of-date and the packager is no longer able/willing
+  to continue maintaining the package (or they are simply not reachable
+  anymore).
+- The existing package exist in some non-official repository and you are able to
+  introduce the package into the official package repository for the
+  distro/package manager. For example if there is a PPA providing polybar for
+  Ubuntu and you can add polybar to the official Ubuntu repositories, please do
+  :)
+
+The list above is not exhaustive, if you are unsure, feel free to ask in a new
+GitHub issue or on `Gitter <https://gitter.im/polybar>`_. Please also ask if you
+run into any polybar related issues while packaging.
+
+Packaging
+---------
+
+If you haven't already, carefully read the `Compiling
+<https://github.com/polybar/polybar/wiki/Compiling>`_ wiki page to make sure you
+fully understand all the dependencies involved and how to build polybar
+manually.
+
+We can't really tell you how to create a package for your distro, you need to
+figure that out yourself. But we can give you some guidance on building polybar
+for a package
+
+Gathering the Source Code
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Unless you are creating a package that tracks the ``master`` branch, don't clone
+the git repository. We provide a tarball with all the required source code on
+our `Release Page <https://github.com/polybar/polybar/releases>`_, use that in
+your build.
+
+Configuring and Compiling
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. note::
+
+  Do not use the ``build.sh`` script for building polybar for your package. The
+  usage and flags of the script may change without notice and we don't consider
+  that a breaking change.
+
+You can mostly follow the instructions on the `wiki
+<https://github.com/polybar/polybar/wiki/Compiling#compiling>`_ for how to
+compile polybar, but there are some additional ``cmake`` arguments you might
+want to use:
+
+- ``-DCMAKE_BUILD_TYPE=Release``: As of writing this is already the default, but
+  use it just to be on the safe side.
+- ``-DCMAKE_INSTALL_PREFIX=/usr``: Without this all the polybar files will be
+  installed under ``/usr/local``. However, for packages it is often recommended
+  they directly install to ``/usr``. So this flag will install polybar to
+  ``/usr/bin/polybar`` instead of ``/usr/local/bin/polybar``. The packaging
+  guidelines for your distro may disagree with this, in that case be sure to
+  follow your distro's guidelines.
+
+Instead of ``sudo make install``, you will most likely want to use
+``DESTDIR=<dir> make install``. That way the files will be installed into
+``<dir>`` instead of your filesystem root.
+
+Finishing Up
+------------
+
+Finally, subscribe to our :issue:`GitHub thread for package maintainers <1971>`
+to get notified about new releases and changes to how polybar is built.
+If you want to, you can also open a PR to add your package to the `Getting
+Started <https://github.com/polybar/polybar#getting-started>`_ section of our
+README.
+
+Thank you very much for maintaining a polybar package! 🎉

doc/dev/release-workflow.rst

@@ -0,0 +1,273 @@
+Release Workflow
+================
+
+We try to follow `Semantic Versioning <https://semver.org/>`_ in this project.
+Patch releases (e.g. ``3.3.X``) contain only bug fixes. Minor releases (e.g.
+``3.X.0``) can have backwards-compatible features. And major releases (
+``X.0.0``) can introduce incompatible changes.
+
+.. note::
+
+  This document replaces the "`Release Guidelines
+  <https://github.com/polybar/polybar/wiki/Release-Guidelines>`_" on the wiki
+  that we used between 3.2.0 and 3.4.3. Starting with 3.5.0, we will follow
+  the workflow described here to publish releases.
+
+Polybar uses the `OneFlow
+<https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow>`_
+branching model for publishing new releases and introducing hotfixes.
+
+The way we accept code from contributors does not change: Contributors fork
+polybar, commit their changes to a new branch and open a PR to get that branch
+merged.
+After reviewing and approving the changes, a maintainer "merges" the PR.
+"Merging" is done in the GitHub UI by either rebasing or squashing the
+changes.
+Regular merging is disabled because we do not want merge a merge commit for
+every PR.
+
+This document is mainly concerned with how to properly release a new version of
+polybar.
+For that reason this might not be of interest to you, if you are not a
+maintainer, but feel free to read on anyway.
+
+Drafting a new Release
+----------------------
+
+There a two processes for how to draft a new release. The process for major and
+minor versions is the same as they both are "regular" releases.
+Patch releases are triggered by bugfixes that cannot wait until the next regular
+release and have a slightly different workflow.
+
+Regular Releases (Major, Minor)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Regular releases are created once we find that ``master`` is in a stable state
+and that there are enough new features to justify a new release.
+A release branch ``release/X.Y.0`` is branched off of a commit on ``master``
+that contains all the features we want in the release, this branch is pushed to
+the official repository.
+For example for version ``3.5.0`` the branch ``release/3.5.0`` would be created:
+
+.. code-block:: shell
+
+  git checkout -b release/3.5.0 <commit>
+
+The release branch should typically only exist for at most a few days.
+
+Hotfix Releases (Patch)
+~~~~~~~~~~~~~~~~~~~~~~~
+
+A hotfix release is created whenever we receive a fix for a bug that we believe
+should be released immediately instead of it only being part of the next regular
+release.
+Generally any bugfix qualifies, but it is up to the maintainers to decide
+whether a hotfix release should be created.
+
+The hotfix release branch ``hotfix/X.Y.Z`` is created by branching off at the
+previous release tag (``X.Y.Z-1``).
+For example, if the latest version is ``3.5.2``, the next hotfix will be on
+branch ``hotfix/3.5.3``:
+
+.. code-block:: shell
+
+  git checkout -b hotfix/3.5.3 3.5.2
+
+Since the PRs for such bugfixes are often not created by maintainers, they will
+often not be based on the latest release tag, but just be branched off
+``master`` because contributors don't necessarily know about this branching
+model and also may well not know whether a hotfix will be created for a certain
+bugfix.
+
+.. TODO create contributor page that describes where to branch off. And link to
+   that page.
+
+In case a PR containing a bugfix that is destined for a patch release is not
+branched off the previous release, a maintainer creates the proper release
+branch and cherry-picks the bugfix commits.
+
+.. note::
+
+  Alternatively, the contributor can also ``git rebase --onto`` to base the
+  branch off the previous release tag. However, in most cases it makes sense for
+  a maintainer to create the release branch since they will also need to create
+  a `Release PR`_ for it.
+
+Once the release branch is created and contains the right commits, the
+maintainer should follow `Publishing a new Release`_ to finish this patch
+release.
+
+If multiple bugfixes are submitted in close succession, they can all be
+cherry-picked onto the same patch release branch to not create many individual
+release with only a single fix.
+The maintainer can also decide to leave the release branch for this patch
+release open for a week in order to possibly combine multiple bugfixes into a
+single release.
+
+Publishing a new Release
+------------------------
+
+The process for publishing a release is the same for all release types. It goes
+as follows:
+
+* A `Release PR`_ is created for the release. This PR MUST NOT be merged in
+  GitHub's interface, it is only here for review, merging happens at the
+  commandline.
+* After approval, a signed git tag without message is created locally at the
+  tip of the release branch and pushed:
+
+.. code-block:: shell
+
+  git tag -m "" -s X.Y.Z <release-branch>
+  git push --tags
+
+* A `draft release`_ targetting the new tag is created in GitHub's release
+  publishing tools and published.
+* After the tag is created, the release branch is manually merged into
+  ``master``.
+  Here it is vitally important that the history of the release branch does not
+  change and so we use ``git merge``. We do it manually because using ``git
+  merge`` is disabled on PRs.
+
+.. code-block:: shell
+
+  git checkout master
+  git merge <release-branch>
+  git push origin
+
+* After the tag is created, the release branch can be deleted with ``git push
+  origin :<release-branch>``.
+* Work through the `After-Release Checklist`_.
+
+Here ``<release-branch>`` is either a ``release/X.Y.0`` branch or a
+``hotfix/X.Y.Z`` branch.
+
+Release PR
+~~~~~~~~~~
+
+The final state of the release branch is prepared as a draft PR on
+GitHub.
+That PR is not merged from the GitHub interface though.
+
+The release PR must do the following things:
+
+* Write any missing migration guides for:
+
+  * Deprecated or removed options
+  * New features that it might be worth migrating to
+* Have a release commit at its tip with the message ``Version X.Y.Z`` and the following changes
+
+  * Finalizes the `Changelog`_ for this release
+  * Updates the version number in ``version.txt``
+
+Changelog
+~~~~~~~~~
+
+The ``CHANGELOG.md`` file at the root of the repo should already contain all the
+changes for the upcoming release in a format based on
+`keep a changelog <https://keepachangelog.com/en/1.0.0/>`_.
+For each release those changes should be checked to make sure we did not miss
+anything.
+
+For all releases, a new section of the following form should be created below
+the ``Unreleased`` section:
+
+.. code-block:: md
+
+  ## [X.Y.Z] - YYYY-MM-DD
+
+In addition, the reference link for the release should be added and the
+reference link for the unreleased section should be updated at the bottom of the
+document:
+
+.. code-block:: md
+
+  [Unreleased]: https://github.com/polybar/polybar/compare/X.Y.Z...HEAD
+  [X.Y.Z]: https://github.com/polybar/polybar/releases/tag/X.Y.Z
+
+Since the release tag doesn't exist yet, both of these links will be invalid
+until the release is published.
+
+All changes from the ``Unreleased`` section that apply to this release should be
+moved into the new release section.
+For regular releases this is generally the entire ``Unreleased`` section, while
+for patch releases it will only be a few entries.
+
+The contents of the release section can be copied into the draft release in
+GitHub's release tool with a heading named ``## Changelog``.
+
+Since major releases generally break backwards compatibility in some way, their
+changelog should also prominently feature precisely what breaking changes were
+introduced. If suitable, maybe even separate documentation dedicated to the
+migration should be written.
+
+Draft Release
+~~~~~~~~~~~~~
+
+On `GitHub <https://github.com/polybar/polybar/releases/new>`_ a new release
+should be drafted.
+The release targets the git tag that was just pushed, the name of the release
+and the tag is simply the release number.
+
+The content of the release message should contain the changelog copied from
+``CHANGELOG.md`` under the heading ``## Changelog``.
+In addition using GitHub's "Auto-generate release notes" feature, the list of
+new contributors should be generated and put at the end of the release notes.
+The generated list of PRs can be removed.
+
+For minor and major releases, add a link to the migration guide directly under
+the ``## Changelog`` header:
+
+.. code-block:: markdown
+
+  **[Migration Guide](https://polybar.readthedocs.io/en/stable/migration/X.Y/index.html)**
+
+At the bottom, check the two boxes "Set as the latest release" and "Create a
+discussion for this release" (select the category "Announcements").
+
+After-Release Checklist
+~~~~~~~~~~~~~~~~~~~~~~~
+
+* Verify the release archive (see `Verify Release`_)
+* Update the Wiki
+
+  * Make sure all the new functionality is documented
+  * Mark deprecated features appropriately (see `Deprecations`_)
+  * Remove all "unreleased" notes (not for patch releases)
+* Inform packagers of new release in :issue:`1971`. Mention any dependency
+  changes and any changes to the build workflow. Also mention any new files are
+  created by the installation.
+* Create a PR that updates the AUR ``PKGBUILD`` file for the ``polybar-git``
+  package (push after the release archive is uploaded).
+* Close the `GitHub Milestone <https://github.com/polybar/polybar/milestones>`_
+  for the new release and move open issues (if any) to a later release.
+* Activate the version on `Read the Docs
+  <https://readthedocs.org/projects/polybar/versions/>`_ and deactivate all
+  previous versions for the same minor release (e.g. for 3.5.4, deactivate all
+  other 3.5.X versions).
+
+Verify Release
+~~~~~~~~~~~~~~
+
+Confirm that the release archive was added to the release.
+We have a GitHub action workflow called 'Release Workflow' that on every
+release automatically creates a release archive, uploads it to the release,
+and adds a 'Download' section to the release body.
+If this fails for some reason, it should be triggered manually.
+
+Afterwards, download the archive, verify its hash, and sign it:
+
+.. code-block:: shell
+
+  gpg --armor --detach-sign polybar-X.Y.Z.tar.gz
+
+Finally, upload the generated ``polybar-X.Y.Z.tar.gz.asc`` to the GitHub
+release.
+
+Deprecations
+~~~~~~~~~~~~
+
+If any publicly facing part of polybar is being deprecated, it should be marked
+as such in the code, through warnings/errors in the log, and by comments in the
+wiki. Every deprecated functionality is kept until the next major release and
+removed there, unless it has not been deprecated in a minor release before.

doc/dev/style-guide.rst

@@ -0,0 +1,75 @@
+Style Guide
+===========
+
+There is a ``.editorconfig`` and a ``.clang-format`` file in the project root
+that defines some basic guidelines, mainly relating to indentation.
+
+Code Formatting
+---------------
+
+We use ``clang-format`` for code formatting, the style rules are defined in
+``.clang-format``, before submitting a PR, make sure to run the following command
+on all the C++ files you changed:
+
+.. code-block:: shell
+
+  clang-format -style=file -i <FILES>
+
+**Note:** Depending on which file you change, this may produce a lot of changes
+because we have not run ``clang-format`` on all files in the project. This is
+fine.
+
+Indentation
+~~~~~~~~~~~
+
+Files use 2 spaces for indentation.
+
+Line Width
+~~~~~~~~~~
+
+Lines should not be longer than 120 characters, ``clang-format`` will enforce
+this when run. However, try to keep lines under 80 characters if it seems
+reasonable in the current situation.
+
+In some cases it makes sense to have lines longer than 80 characters for
+readability. But long lines can just the same be unreadable, for example if you
+have long if-conditions or use complex expressions as function parameters. Make
+sure you only use longer lines if keeping it under 80 would be less readable.
+
+Comments
+--------
+
+Use Doxygen ``/** */`` comments in front of functions, methods, types, members and
+classes:
+
+.. code-block:: cpp
+
+  /**
+   * @brief Generates a config object from a config file
+   *
+   * For modularity the parsing and storing of the config is separated
+   */
+  class config_parser {
+  ...
+    /**
+     * @brief Is used to resolve ${root...} references
+     */
+    string m_barname;
+  ...
+  }
+
+For all other comments use ``//`` for single-line and ``/* */`` for multi-line comments.
+
+Your comments should describe the intent and purpose of your code, not necessarily what it does.
+
+Header Files
+------------
+
+Header files should end in ``.hpp``.
+
+We use pragmas instead of include guards to guarantee header files are included
+only once:
+
+.. code-block:: cpp
+
+  #pragma once

doc/dev/testing.rst

@@ -0,0 +1,26 @@
+Testing
+=======
+
+Polybar uses `googletest <https://google.github.io/googletest/>`_ as its
+testing and mocking framework.
+Tests live in the ``tests/`` directory; they can be enabled during cmake with
+``-DBUILD_TESTS=ON`` and compiled with ``make all_unit_tests``.
+
+Each test gets its own executable in ``build/tests``, which can be executed to run
+a specific test.
+
+Running all tests is preferably done with the following command:
+
+.. code-block:: shell
+
+  make check
+
+This runs all available tests and prints the output in color for failed tests
+only.
+
+Adding New Tests
+----------------
+
+All new tests need to be added to the ``tests/CMakeLists.txt`` file. Have a look
+at the other unit tests in ``tests/unit_tests`` to see how to write tests for your
+code.

doc/index.rst

@@ -0,0 +1,52 @@
+Polybar Documentation
+=====================
+
+.. note:: This is still very much a work-in-progress. Most information is still
+          to be found on our `GitHub Wiki <https://github.com/polybar/polybar/wiki>`_.
+          We will migrate the wiki content step-by-step.
+
+
+Welcome to the official polybar documentation.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Content:
+
+   user/actions
+   user/ipc
+   user/modules/index
+   user/fonts/index
+   user/default-config
+   migration/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Manual Pages:
+
+   man/polybar.1
+   man/polybar-msg.1
+   man/polybar.5
+
+.. toctree::
+   :maxdepth: 1
+   :caption: For Contributors:
+
+   dev/packaging
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Developer Documentation:
+
+   dev/getting-started
+   dev/style-guide
+   dev/testing
+   dev/release-workflow
+
+Getting Help
+============
+
+* `Polybar Wiki <https://github.com/polybar/polybar/wiki>`_
+* `Gitter <https://gitter.im/polybar/polybar>`_
+* `/r/polybar <https://reddit.com/r/polybar>`_ on reddit
+* ``#polybar`` on `irc.libera.chat:6697 <https://libera.chat/>`_
+

doc/man/polybar-msg.1.rst

@@ -0,0 +1,75 @@
+polybar-msg(1)
+==============
+
+SYNOPSIS
+--------
+| **polybar-msg** [*OPTIONS*] **action** *action-string*
+| **polybar-msg** [*OPTIONS*] **action** *module* *action* [*data*]
+| **polybar-msg** [*OPTIONS*] **cmd** *command*
+
+DESCRIPTION
+-----------
+Polybar allows external control through *actions* and *commands*.
+Actions control individual modules and commands control the bar itself.
+
+The full IPC documentation is linked at the end of this document.
+
+The available actions depend on the target module.
+For actions, the payload is either a single action string or the module name,
+the action name, and the optional data string specified separately.
+
+In order for **polybar-msg** being able to send a message to a running
+**polybar** process, the bar must have IPC enabled and both **polybar-msg** and
+**polybar** must run under the same user.
+
+OPTIONS
+-------
+
+.. program:: polybar-msg
+
+.. option:: -h, --help
+
+   Display help text and exit
+
+.. option:: -p PID
+
+   Send message only to **polybar** process running under the given process ID.
+   If not specified, the message is sent to all running **polybar** processes.
+
+EXAMPLES
+--------
+
+**polybar-msg** **cmd** *quit*
+  Terminate all running **polybar** instances.
+
+**polybar-msg** **action** *mymodule* *module_hide*
+
+**polybar-msg** **action** "*#mymodule.module_hide*"
+  Hide the module named *mymodule*.
+  The first variant specifies the module and action names separately, the second uses an action string.
+
+AUTHORS
+-------
+| Polybar was created by Michael Carlberg and is currently maintained by Patrick Ziegler.
+| Contributors can be listed on GitHub.
+
+REPORTING BUGS
+--------------
+Report issues on GitHub <https://github.com/polybar/polybar>
+
+SEE ALSO
+--------
+.. only:: man
+
+  :manpage:`polybar`\(1),
+  :manpage:`polybar`\(5)
+
+  | IPC documentation: <https://polybar.rtfd.org/en/stable/user/ipc.html>
+
+
+.. only:: not man
+
+  :doc:`polybar.1`,
+  :doc:`polybar.5`
+
+  :doc:`/user/ipc`

doc/man/polybar.1.rst

@@ -0,0 +1,92 @@
+polybar(1)
+==========
+
+SYNOPSIS
+--------
+**polybar** [*OPTIONS*]... [*BAR*]
+
+DESCRIPTION
+-----------
+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.
+If the *BAR* argument is not provided and the configuration file only contains one bar definition, polybar will display this bar.
+
+OPTIONS
+-------
+
+.. program:: polybar
+
+.. option:: -h, --help
+
+   Display help text and exit
+
+.. option:: -v, --version
+
+   Display build details and exit
+.. option:: -l, --log=LEVEL
+
+   | Set the logging verbosity (default: **notice**)
+   | *LEVEL* is one of: error, warning, notice, info, trace
+.. option:: -q, --quiet
+
+   Be quiet (will override -l)
+.. option:: -c, --config=FILE
+
+   Specify the path to the configuration file. By default, the configuration file is loaded from:
+
+   * ``$XDG_CONFIG_HOME/polybar/config``
+   * ``$XDG_CONFIG_HOME/polybar/config.ini``
+   * ``$HOME/.config/polybar/config``
+   * ``$HOME/.config/polybar/config.ini``
+   * ``$XDG_CONFIG_DIRS/polybar/config.ini``
+   * ``/etc/xdg/polybar/config.ini`` (only if ``XDG_CONFIG_DIRS`` is not set)
+   * ``/etc/polybar/config.ini``
+.. option:: -r, --reload
+
+   Reload the application when the config file has been modified
+.. option:: -d, --dump=PARAM
+
+   Print the value of the specified parameter *PARAM* in bar section and exit
+.. option:: -m, --list-monitors
+
+   | Print list of available monitors and exit.
+   | If some monitors are cloned, this will exclude all but one of them.
+   | If polybar was compiled with RandR monitor support, only monitors are listed and not physical outputs.
+.. option:: -M, --list-all-monitors
+
+   | Print list of all available monitors and exit.
+   | This includes cloned monitors as well as both physical outputs and RandR monitors (if supported).
+   | Only the names listed here can be used as monitor names in polybar.
+.. option:: -w, --print-wmname
+
+   Print the generated *WM_NAME* and exit
+.. option:: -s, --stdout
+
+   Output the data to stdout instead of drawing it to the X window
+.. option:: -p, --png=FILE
+
+   Save png snapshot to *FILE* after running for 3 seconds
+
+AUTHORS
+-------
+| Polybar was created by Michael Carlberg and is currently maintained by Patrick Ziegler.
+| Contributors can be listed on GitHub.
+
+REPORTING BUGS
+--------------
+Report issues on GitHub <https://github.com/polybar/polybar>
+
+SEE ALSO
+--------
+.. only:: man
+
+  :manpage:`polybar-msg`\(1),
+  :manpage:`polybar`\(5)
+
+
+.. only:: not man
+
+  :doc:`polybar-msg.1`,
+  :doc:`polybar.5`
+
+| Full documentation at: <https://github.com/polybar/polybar>
+| Project wiki: <https://github.com/polybar/polybar/wiki>

doc/man/polybar.5.rst

@@ -0,0 +1,184 @@
+.. highlight:: ini
+
+polybar(5)
+==========
+
+Description
+-----------
+
+The polybar configuration file defines the behavior and look of polybar. It uses
+a variant of the `INI <https://en.wikipedia.org/wiki/INI_file>`_ file format.
+The exact syntax is described below but first a small snippet to get familiar
+with the syntax:
+
+::
+
+  [section_name]
+  ; A comment
+  # Another comment
+
+  background = #ff992a
+  width = 90%
+  monitor = HDMI-0
+
+  screenchange-reload = false
+
+  ; Use double quotes if you want to keep the surrounding space.
+  text = " Some text "
+
+When started ``polybar`` will search for the config file in one of several
+places in the following order:
+
+* If the ``-c`` or ``--config`` command line argument is specified, it will use
+  the path given there.
+* ``$XDG_CONFIG_HOME/polybar/config``
+* ``$XDG_CONFIG_HOME/polybar/config.ini``
+* ``$HOME/.config/polybar/config``
+* ``$HOME/.config/polybar/config.ini``
+* ``$XDG_CONFIG_DIRS/polybar/config.ini``
+* ``/etc/xdg/polybar/config.ini`` (only if ``XDG_CONFIG_DIRS`` is not set)
+* ``/etc/polybar/config.ini``
+
+Syntax
+------
+
+The entire config is line-based so everything is constrained to a single line.
+This means there are no multiline values or other multiline constructs (except
+for sections).
+Each line has one of four types:
+
+* Empty
+* Comment
+* Section Header
+* Key
+
+Spaces at the beginning and end of each line will be ignored.
+
+.. note::
+
+  In this context "spaces" include the regular space character as well as the
+  tab character and any other character for which :manpage:`isspace(3)` returns
+  ``true`` (e.g. ``\r``).
+
+Any line that doesn't fit into one of these four types is a syntax error.
+
+.. note::
+
+  It is recommended that `section header` names and `key` names only use
+  alphanumeric characters as well as dashes (``-``), underscores (``_``) and
+  forward slashes (``/``).
+
+  In practice all characters are allowed except for spaces and any of these:
+  ``"'=;#[](){}:.$\%``
+
+Section Headers
+^^^^^^^^^^^^^^^
+
+Sections are used to group config options together. For example each module is
+defined in its own section.
+
+A section is defined by placing the name of the section in square brackets
+(``[`` and ``]``). For example:
+
+::
+
+  [module/wm]
+
+This declares a section with the name ``module/wm`` and all keys defined after
+this line will belong to that section until a new section is declared.
+
+.. warning::
+  The first non-empty and non-comment line in the main config file must be a
+  section header. It cannot be a key because that key would not belong to any
+  section.
+
+.. note::
+  The following section names are reserved and cannot be used inside the config:
+  ``self``, ``root``, and ``BAR``.
+
+Keys
+^^^^
+
+Keys are defined by assigning a value to a name like this:
+
+
+::
+
+  name = value
+
+This assigns ``value`` to the key ``name`` in whatever section this line is in.
+Key names need to be unique per section.
+If the value is enclosed by double-quotes (``"``), the quotes will be ignored.
+So the following still assigns ``value`` to ``name``:
+
+::
+
+  name = "value"
+
+Spaces around the equal sign are ignored, the following are all equivalent:
+
+::
+
+  name=value
+  name = value
+  name =      value
+
+Because spaces at the beginning and end of the line are also ignored, if you
+want your value to begin and/or end with a space, the value needs to be enclosed
+in double-quotes:
+
+::
+
+  name = " value "
+
+Here the value of the ``name`` key has a leading and trailing whitespace.
+
+To treat characters with special meaning as literal characters, you need to
+prepend them with the backslash (``\``) escape character:
+
+::
+
+  name = "value\\value\\value"
+
+Value of this key ``name`` results in ``value\value\value``.
+
+.. note::
+
+  The only character with a special meaning right now is the backslash character
+  (``\``), which serves as the escape character.
+  More will be added in the future.
+
+Empty Lines & Comments
+^^^^^^^^^^^^^^^^^^^^^^
+
+Empty lines and comment lines are ignored when reading the config file, they do
+not affect polybar's behavior. Comment lines start with either the ``;`` or the
+``#`` character.
+
+.. note::
+
+  Inline comments are not supported. For example the following line does not end
+  with a comment, the value of ``name`` is actually set to ``value ; comment``:
+
+  ::
+
+    name = value ; comment
+
+AUTHORS
+-------
+| Polybar was created by Michael Carlberg and is currently maintained by Patrick Ziegler.
+| Contributors can be listed on GitHub.
+
+SEE ALSO
+--------
+
+.. only:: man
+
+  :manpage:`polybar`\(1),
+  :manpage:`polybar-msg`\(1)
+
+
+.. only:: not man
+
+  :doc:`polybar.1`,
+  :doc:`polybar-msg.1`

doc/migration/3.7/index.rst

@@ -0,0 +1,40 @@
+Migrating From Version 3.6 to 3.7
+=================================
+
+Text Module (``custom/text``)
+-----------------------------
+
+Using ``content`` to specify the text of the module is deprecated in favor of
+using the same concepts as all other modules (formats and labels).
+
+For example, the following text module:
+
+.. code-block:: dosini
+
+  [module/text]
+  type = custom/text
+  content = Hello World
+  content-foreground = #ff0000
+
+Should now look like this:
+
+.. code-block:: dosini
+
+  [module/text]
+  type = custom/text
+  label = Hello World
+  label-foreground = #ff0000
+
+Because it is set to its default value, the ``format`` setting can also be
+completely left out.
+
+In general, all properties on ``content`` also apply the same on ``label``
+(e.g. ``background``, ``font``), except for ``offset``,
+``prefix``, ``suffix`` (and their sub-properties).
+Those three properties have to instead be applied to ``format`` (e.g.
+``format-offset``).
+
+System Tray
+-----------
+
+.. include:: tray.rst

doc/migration/3.7/tray.rst

@@ -0,0 +1,57 @@
+..
+  File included directly in other pages describing migrating to the new tray module
+
+Polybar version 3.7 introduced the new tray module and deprecated the legacy
+tray implementation which uses ``tray-position`` to position the tray.
+You should switch over to the tray module as soon as possible.
+
+The legacy tray was configured in the `bar section
+<https://github.com/polybar/polybar/wiki/Configuration#bar-settings>`_, the
+setting for the module live in that module's section of the config file.
+The settings in the bar section don't always directly correspond to an
+equivalent setting in the module section for the new tray module.
+
+The following lists how each old setting in the bar section should be migrated:
+
+``tray-position``
+  The tray is now positioned as a module and so its positioning is done by
+  placing it where you want it to appear in one of the three module lists
+  ``modules-left``, ``modules-center``, ``modules-right``.
+
+``tray-detached``
+  This setting does not have an equivalent, detaching the tray is no longer
+  possible.
+
+``tray-maxsize``
+  The :poly-setting:`tray-size` setting now determines the size of tray icons.
+
+``tray-transparent``
+  Was already deprecated and does not exist in the tray module.
+  Transparency is enabled automatically if a transparent background is used.
+
+``tray-background``
+  Also exists in the module section (see :poly-setting:`tray-background`). Now,
+  the setting only applies to the icons themselves and no longer to the space
+  around them.
+
+``tray-foreground``
+  Also exists in the module section with the same functionality (see
+  :poly-setting:`tray-foreground`).
+
+``tray-offset-x``, ``tray-offset-y``
+  Has no direct equivalent in the module settings. Horizontally, the tray can
+  be moved in the same way other module content can be moved; by reordering the
+  modules or using things like ``format-offset``, ``format-margin``, or
+  ``format-padding``.
+  The tray can't be moved vertically.
+
+  In any case, the tray can no longer be moved outside of the bar window.
+
+``tray-padding``
+  Spacing between tray icons works a bit different now and needs to be
+  completely reconfigured (see :poly-setting:`tray-padding` and
+  :poly-setting:`tray-spacing`).
+
+``tray-scale``
+  No longer exist. The size of the icons is solely determined by
+  :poly-setting:`tray-size`.

doc/migration/index.rst

@@ -0,0 +1,24 @@
+Polybar Migration Guides
+========================
+
+Updating polybar to the newest version often requires updating your
+configuration files to use the newest features and replace outdated settings.
+
+Starting from version 3.7, we include a small guide here for how to migrate
+from the previous version.
+If you are upgrading over multiple versions (e.g. from 3.5 to 3.7), also read
+the migration guides for all versions in between.
+
+For migration guides before version 3.7, please look at our `release blog posts
+<https://polybar.github.io/blog/>`_.
+
+When upgrading make sure to run polybar from the terminal and look for errors,
+warnings, and deprecation messages.
+This can save you a lot of issues in the future when deprecated settings and
+features are removed.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Guides
+
+   3.7/index

doc/requirements.txt

@@ -0,0 +1,7 @@
+# Installing these packages is only really needed on readthedocs, building
+# locally works as long as sphinx is installed.
+# For local development, you may want to install some of these though.
+sphinx~=7.2.6
+sphinx-rtd-theme~=2.0.0rc2
+sphinx-notfound-page~=1.0.0
+readthedocs-sphinx-search~=0.3.2

doc/user/actions.rst

@@ -0,0 +1,463 @@
+Actions
+=======
+
+.. versionadded:: 3.5.0
+
+.. contents:: Table of Contents
+   :local:
+
+"Actions" are used to trigger certain behavior in modules.
+For example, when you click on your volume module (pulseaudio or alsa), polybar
+internally sends an action to that module that tells it to mute/unmute the
+audio.
+
+These actions are not only used internally, but users can also send these
+actions to polybar through `Inter Process Communication
+<https://github.com/polybar/polybar/wiki/Inter-process-messaging>`_ (IPC) to
+trigger certain behavior in polybar modules.
+
+.. _action-string-format:
+
+Action String Format
+--------------------
+
+An action string follows the following format:
+
+::
+
+  #NAME.ACTION[.DATA]
+
+Where ``NAME`` is the name of the target module (not the type!) and ``ACTION``
+is the name of the action in that module. ``DATA`` is optional data attached to
+an action (for example to say which menu level should be opened).
+
+For example the
+`date module <https://github.com/polybar/polybar/wiki/Module:-date>`_ supports
+the ``toggle`` action to toggle between the regular and the alternative time and
+date format.
+If you have the following date module:
+
+.. code-block:: ini
+
+  [module/mydate]
+  type = internal/date
+  ...
+
+The action string for toggling between the date formats would look like this:
+
+::
+
+  #mydate.toggle
+
+Note that we use the name of the module (``mydate``) and not the type.
+
+As an example for an action string with additional data, take the menu module:
+
+.. code-block:: ini
+
+  [module/powermenu]
+  type = custom/menu
+  menu-0-0 = Poweroff
+  menu-0-0-exec = poweroff
+  menu-0-1 = Suspend
+  menu-0-1-exec = systemctl suspend
+
+The action name to open a certain menu level is ``open``, so to open level 0
+(`menu-0`), the action string additionally has the level attached to it:
+
+::
+
+  #powermenu.open.0
+
+Triggering Actions
+------------------
+
+Most modules already use action strings to trigger actions when you click on or
+scroll over a module.
+But in some cases you may want or need to manually send action strings to
+polybar to trigger a certain behavior.
+
+Everywhere where you can specify a command to run on click or scroll, you can
+also specify an action string.
+For example, in the bar section, you can specify a command that is triggered
+when you click anywhere on the bar (where there isn't another click action):
+
+.. code-block:: ini
+
+  [bar/mybar]
+  ...
+  click-left = #mydate.toggle
+  ...
+
+This will then trigger the ``toggle`` action on the ``mydate`` module when you
+click anywhere on the bar.
+
+Similarly, we can use action strings in ``%{A}``
+`formatting tags <https://github.com/polybar/polybar/wiki/Formatting#action-a>`_
+just as we would regular commands:
+
+::
+
+  %{A1:firefox:}%{A3:#mydate.toggle:}Opens firefox on left-click and toggles the
+  date on right-click %{A}%{A}
+
+Finally, polybar's `Inter Process Communication
+<https://github.com/polybar/polybar/wiki/Inter-process-messaging>`_ (IPC) can
+also be used to trigger actions:
+
+.. code-block:: bash
+
+  polybar-msg action "#mydate.toggle"
+
+.. note::
+
+  The quotes around the action string are necessary, otherwise your shell may
+  interpret the ``#`` as the beginning of the comment and ignore the rest of the
+  line.
+
+Available Actions
+-----------------
+
+The following modules have actions available. Most of them are already used by
+the module by default for click and scroll events.
+
+All Modules
+^^^^^^^^^^^
+
+These actions are available to all modules and are prefixed with ``module_``.
+
+:``module_show``, ``module_hide``:
+  Shows/Hides a module. The module is still running in the background when
+  hidden, it is just not drawn. The starting state can be configured with the
+  `hidden` configuration option.
+
+  .. versionadded:: 3.6.0
+
+:``module_toggle``:
+  Toggles the visibility of a module.
+
+  .. versionadded:: 3.6.0
+
+internal/date
+^^^^^^^^^^^^^
+
+:``toggle``:
+  Toggles the date/time format between ``date``/``time`` and
+  ``date-alt``/``time-alt``
+
+internal/alsa
+^^^^^^^^^^^^^
+
+:``inc``, ``dec``:
+  Increases/Decreases the volume by ``interval`` percentage points, where
+  ``interval`` is the config setting in the module. Volume changed like this
+  will never go above 100%.
+
+  if ``unmute-on-scroll`` is turned on, the sound will also be unmuted when
+  this action is called.
+
+:``toggle``:
+  Toggles between muted and unmuted.
+
+internal/pulseaudio
+^^^^^^^^^^^^^^^^^^^
+
+:``inc``, ``dec``:
+  Increases/Decreases the volume by ``interval`` percentage points, where
+  ``interval`` is the config setting in the module. Volume changed like this
+  will never go above ~153% (if ``use-ui-max`` is set to ``true``) or 100% (if
+  not).
+
+  if ``unmute-on-scroll`` is turned on, the sound will also be unmuted when
+  this action is called.
+
+:``toggle``:
+  Toggles between muted and unmuted.
+
+internal/xbacklight
+^^^^^^^^^^^^^^^^^^^
+
+:``inc``, ``dec``:
+  Increases/Decreases screen brightness 5 percentage points.
+
+internal/backlight
+^^^^^^^^^^^^^^^^^^
+
+:``inc``, ``dec``:
+  Increases/Decreases screen brightness 5 percentage points.
+
+internal/xkeyboard
+^^^^^^^^^^^^^^^^^^
+
+:``switch``:
+  Cycles through configured keyboard layouts.
+
+internal/mpd
+^^^^^^^^^^^^
+
+:``play``: Starts playing the current song.
+:``pause``: Pauses the current song.
+:``stop``: Stops playing.
+:``prev``: Starts playing the previous song.
+:``next``: Starts playing the next song.
+:``repeat``: Toggles repeat mode.
+:``single``: Toggles single mode.
+:``random``: Toggles random mode.
+:``consume``: Toggles consume mode.
+:``seek``: *(Has Data)* Seeks inside the current song.
+
+           The data must be of the form ``[+-]N``, where ``N`` is a number
+           between 0 and 100.
+
+           If either ``+`` or ``-`` is used, it will seek forward or backward
+           from the current position by ``N%`` (relative to the length of the
+           song).
+           Otherwise it will seek to ``N%`` of the current song.
+
+internal/xworkspaces
+^^^^^^^^^^^^^^^^^^^^
+
+:``focus``: *(Has Data)* Switches to the given workspace.
+
+            The data is the index of the workspace that should be selected.
+:``next``: Switches to the next workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+:``prev``: Switches to the previous workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+
+internal/bspwm
+^^^^^^^^^^^^^^
+
+:``focus``: *(Has Data)* Switches to the given workspace.
+
+            The data has the form ``N+M``, where ``N`` is the index of the
+            monitor and ``M`` the index of the workspace on that monitor.
+            Both indices are 0-based and correspond to the position the monitor
+            and workspace appear in the output of ``bspc subscribe report``.
+:``next``: Switches to the next workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+:``prev``: Switches to the previous workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+
+
+internal/i3
+^^^^^^^^^^^
+
+:``focus``: *(Has Data)* Switches to the given workspace.
+
+            The data is the name of the workspace defined in the i3 config.
+:``next``: Switches to the next workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+:``prev``: Switches to the previous workspace. The behavior of this action is
+           affected by the ``pin-workspaces`` setting.
+
+custom/menu
+^^^^^^^^^^^
+
+:``open``: *(Has Data)* Opens the given menu level
+
+           The data is a single number specifying which menu level should be
+           opened.
+:``close``: Closes the menu
+:``exec``: *(Has Data)* Executes the command at the given menu element.
+
+           The data has the form ``N-M`` and the action will execute the command
+           in ``menu-N-M-exec``.
+
+
+.. _actions-ipc:
+
+custom/ipc
+^^^^^^^^^^
+
+.. versionadded:: 3.6.0
+
+:``send``: *(Has Data)* Replace the contents of the module with the data passed in this action.
+:``hook``: *(Has Data)* Trigger the given hook.
+
+           The data is the 0-based index of the hook to trigger.
+:``next``: Switches to the next hook and wrap around when the last hook was displayed.
+:``prev``: Switches to the previous hook and wrap around when the first hook was displayed.
+:``reset``: Reset the module to its startup state: either empty or according to the ``initial`` setting.
+
+
+Deprecated Action Names
+-----------------------
+
+.. deprecated:: 3.5.0
+
+In earlier versions (< 3.5.0) action strings only included information about the
+module type.
+This meant in bars that contained multiple different modules of the same type,
+actions for these modules were sometimes processed by the wrong module with the
+same type.
+
+Since version 3.5.0, this no longer happens. However, this also means we had to
+change what actions are recognized by polybar modules.
+
+If you explicitly use any polybar action names in your config or any of your
+scripts, you are advised to change them, as they may stop working at some point
+in the future.
+For now polybar still supports the old action names, will convert them to the
+appropriate new action name, and will print a warning to help you find old
+action names in your config.
+
+If you use the `menu module
+<https://github.com/polybar/polybar/wiki/Module:-menu>`_, you most likely use
+old action names to open and close the menu (for example ``menu-open-1`` or
+``menu-close``).
+The ``i3wm-wsnext``, ``i3wm-wsprev``, ``bspwm-desknext``, and ``bspwm-deskprev``
+actions, to switch workspaces in i3 and bspwm, may also appear in your config.
+
+Migration
+^^^^^^^^^
+
+Updating your config to use the new action names is quite straightforward.
+
+For each action name, consult the table below to find the new action name.
+Afterwards build the complete action string as described in
+:ref:`action-string-format`.
+
+Please see :ref:`below <menu-example>` for an example of migrating a typical menu module.
+
++-------------------------+-----------------------+---------------+
+|Module Type              |Deprecated Action Name |New Action Name|
++=========================+=======================+===============+
+|``internal/date``        |``datetoggle``         |``toggle``     |
++-------------------------+-----------------------+---------------+
+|``internal/alsa``        |``volup``              |``inc``        |
+|                         +-----------------------+---------------+
+|                         |``voldown``            |``dec``        |
+|                         +-----------------------+---------------+
+|                         |``volmute``            |``toggle``     |
++-------------------------+-----------------------+---------------+
+|``internal/pulseaudio``  |``pa_volup``           |``inc``        |
+|                         +-----------------------+---------------+
+|                         |``pa_voldown``         |``dec``        |
+|                         +-----------------------+---------------+
+|                         |``pa_volmute``         |``toggle``     |
++-------------------------+-----------------------+---------------+
+|``internal/xbacklight``  |``xbacklight+``        |``inc``        |
+|                         +-----------------------+---------------+
+|                         |``xbacklight-``        |``dec``        |
++-------------------------+-----------------------+---------------+
+|``internal/backlight``   |``backlight+``         |``inc``        |
+|                         +-----------------------+---------------+
+|                         |``backlight-``         |``dec``        |
++-------------------------+-----------------------+---------------+
+|``internal/xkeyboard``   |``xkeyboard/switch``   |``switch``     |
++-------------------------+-----------------------+---------------+
+|``internal/mpd``         |``mpdplay``            |``play``       |
+|                         +-----------------------+---------------+
+|                         |``mpdpause``           |``pause``      |
+|                         +-----------------------+---------------+
+|                         |``mpdstop``            |``stop``       |
+|                         +-----------------------+---------------+
+|                         |``mpdprev``            |``prev``       |
+|                         +-----------------------+---------------+
+|                         |``mpdnext``            |``next``       |
+|                         +-----------------------+---------------+
+|                         |``mpdrepeat``          |``repeat``     |
+|                         +-----------------------+---------------+
+|                         |``mpdsingle``          |``single``     |
+|                         +-----------------------+---------------+
+|                         |``mpdrandom``          |``random``     |
+|                         +-----------------------+---------------+
+|                         |``mpdconsume``         |``consume``    |
+|                         +-----------------------+---------------+
+|                         |``mpdseekN``           |``seek.N``     |
++-------------------------+-----------------------+---------------+
+|``internal/xworkspaces`` |``xworkspaces-focus=N``|``focus.N``    |
+|                         +-----------------------+---------------+
+|                         |``xworkspaces-next``   |``next``       |
+|                         +-----------------------+---------------+
+|                         |``xworkspaces-prev``   |``prev``       |
++-------------------------+-----------------------+---------------+
+|``internal/bspwm``       |``bspwm-deskfocusN``   |``focus.N``    |
+|                         +-----------------------+---------------+
+|                         |``bspwm-desknext``     |``next``       |
+|                         +-----------------------+---------------+
+|                         |``bspwm-deskprev``     |``prev``       |
++-------------------------+-----------------------+---------------+
+|``internal/i3``          |``i3wm-wsfocus-N``     |``focus.N``    |
+|                         +-----------------------+---------------+
+|                         |``i3-wsnext``          |``next``       |
+|                         +-----------------------+---------------+
+|                         |``i3-wsprev``          |``prev``       |
++-------------------------+-----------------------+---------------+
+|``custom/menu``          |``menu-open-N``        |``open.N``     |
+|                         +-----------------------+---------------+
+|                         |``menu-close``         |``close``      |
++-------------------------+-----------------------+---------------+
+
+.. note::
+
+   Some deprecated action names are suffixed with ``N``, this means that that
+   action has some additional data (represented by that ``N``), in the new
+   action names this data will appear in exactly the same way, after a period.
+
+.. _menu-example:
+
+Menu Module Example
+"""""""""""""""""""
+
+The menu module is the only module where we have to explicitly use actions for
+it to work. Because of this, almost everyone will need to update their menu
+module to use the new action format.
+
+Below you can see an example of a menu module:
+
+.. code-block:: ini
+
+  [module/apps]
+  type = custom/menu
+
+  label-open = Apps
+
+  menu-0-0 = Browsers
+  menu-0-0-exec = menu-open-1
+  menu-0-1 = Multimedia
+  menu-0-1-exec = menu-open-2
+
+  menu-1-0 = Firefox
+  menu-1-0-exec = firefox
+  menu-1-1 = Chromium
+  menu-1-1-exec = chromium
+
+  menu-2-0 = Gimp
+  menu-2-0-exec = gimp
+  menu-2-1 = Scrot
+  menu-2-1-exec = scrot
+
+This module uses two actions: ``menu-open-1`` and ``menu-open-2``.
+These are actions with data, the data specifies which level of the menu should
+be opened.
+
+Looking at the table, we see that the new action name for ``menu-open-N`` is
+``open.N``, where ``.N`` is the data attached to the action.
+Putting this together with the name of the module gives us ``#apps.open.1`` and
+``#apps.open.2`` as action strings.
+Since your menu module likely has a different name, your action strings will
+likely not use ``apps``, but the name of your module.
+
+.. code-block:: ini
+
+  [module/apps]
+  type = custom/menu
+
+  label-open = Apps
+
+  menu-0-0 = Browsers
+  menu-0-0-exec = #apps.open.1
+  menu-0-1 = Multimedia
+  menu-0-1-exec = #apps.open.2
+
+  menu-1-0 = Firefox
+  menu-1-0-exec = firefox
+  menu-1-1 = Chromium
+  menu-1-1-exec = chromium
+
+  menu-2-0 = Gimp
+  menu-2-0-exec = gimp
+  menu-2-1 = Scrot
+  menu-2-1-exec = scrot

doc/user/default-config.rst

@@ -0,0 +1,16 @@
+Default Configuration
+=====================
+
+.. versionadded:: 3.6.0
+
+Polybar's default configuration lives in ``/etc/polybar/config.ini`` and is
+loaded if no other configuration file can be found.
+
+
+.. image:: ../_static/default.png
+   :alt: Screenshot of default polybar configuration
+
+.. literalinclude:: ../config.ini
+   :language: ini
+   :linenos:
+   :caption: :download:`Download <../config.ini>`

doc/user/fonts/index.rst

@@ -0,0 +1,8 @@
+Fonts
+=====
+
+.. toctree::
+   :maxdepth: 1
+
+   Wiki <https://github.com/polybar/polybar/wiki/Fonts>
+   Nerd Fonts <nerd-fonts>

doc/user/fonts/nerd-fonts.rst

@@ -0,0 +1,54 @@
+Nerd Fonts
+==========
+
+`Nerd Fonts <https://www.nerdfonts.com/>`_ (`GitHub
+<https://github.com/ryanoasis/nerd-fonts/>`_) is a project that patches
+together a textual font with font icons (or glyphs) from other projects (e.g.
+`Font Awesome <https://github.com/FortAwesome/Font-Awesome>`_, `Material Design
+Icons <https://github.com/Templarian/MaterialDesign>`_, etc.) into a single
+font.
+
+In polybar, just using nerd fonts can lead to some issues:
+
+* Cut-off Characters
+* Overlapping
+* No Spacing
+
+These look something like this:
+
+.. image:: /_static/nerd-fonts/bad.png
+   :alt: Showcase of the three issues listed above.
+
+This behavior is intrinsic to Nerd Fonts and is described in more detail `here
+<https://github.com/ryanoasis/nerd-fonts/issues/442#issuecomment-1263358904>`_.
+Also see :issue:`991` for more information.
+
+**To resolve these issues, we recommend using Nerd Fonts like this:**
+
+The monospaced variants of the different Nerd Fonts (all characters have the
+same width) don't have this issue.
+However, then you often have the problem that the icons are too small and that
+their size cannot be set independently of the text.
+
+Due to that, we recommend using ``Symbols Nerd Font Mono`` (available for
+`download <https://github.com/ryanoasis/nerd-fonts/releases/>`_ as
+``NerdFontsSymbolsOnly.zip``).
+This font only contains the nerd font icons and no text.
+For the text, simply use any non-Nerd Font:
+
+.. code-block:: ini
+
+  font-0 = "Liberation Mono:size=20"
+  font-1 = "Symbols Nerd Font Mono:size=26"
+
+Now the icon sizes can be adjusted separately to get the best experience.
+This solves all three problems shown above:
+
+.. image:: /_static/nerd-fonts/good.png
+   :alt: The same config as in the previous screenshot but using ``Symbols Nerd
+         Font Mono`` for the font icons
+
+.. note::
+
+   In the overlap example, there is no space between the icon and text, that's
+   why they're so close together.

doc/user/ipc.rst

@@ -0,0 +1,120 @@
+Inter-process-messaging
+=======================
+
+Polybar supports controlling parts of the bar and its modules from the outside
+through inter-process-messaging (IPC).
+
+IPC is disabled by default and can be enabled by setting ``enable-ipc = true``
+in the bar section.
+
+By default polybar ships with the ``polybar-msg`` tool that is needed to send
+messages to polybar.
+
+.. note:: Starting with version 3.6.0, the underlying IPC mechanism has been
+          completely changed.
+
+          Writing directly to the named pipe to send IPC messages has been
+          deprecated, ``polybar-msg`` should be used exclusively
+          Everything you could do by directly writing to the named pipe, you
+          can also do using ``polybar-msg``.
+          In addition, hook messages are also deprecated; they are replaced by
+          actions on the :ref:`ipc module <actions-ipc>`.
+
+          Unless noted otherwise, everything in this guide is still valid for
+          older versions.
+
+Sending Messages
+----------------
+
+``polybar-msg`` can be called on the commandline like this:
+
+.. code-block:: shell
+
+  polybar-msg [-p <pid>] <type> <payload>
+
+If the ``-p`` argument is specified, the message is only sent to the running
+polybar instance with the given process ID.
+Otherwise, the message is sent to all running polybar processes that have IPC
+enabled.
+
+.. note:: IPC messages are only sent to polybar instances running under the
+          same user as ``polybar-msg`` is running as.
+
+          Concretely, ``polybar`` and ``polybar-msg`` use the
+          ``$XDG_RUNTIME_DIR`` environment variable in accordance with the `XDG
+          Base Directory Specification`_ to determine where to find the socket
+          to communicate.
+
+          If ``polybar`` and ``polybar-msg`` don't have the same value for
+          ``$XDG_RUNTIME_DIR``, they will likely not be able to communicate.
+          The variable may not be set if you use ``su`` or ``sudo`` to execute
+          ``polybar-msg`` as a different user, often a full user session is
+          required.
+
+          .. _XDG Base Directory Specification: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
+
+The ``<type>`` argument is either :ref:`action <ipc-actions>` or
+:ref:`cmd <ipc-commands>`.
+The allowed values for ``<payload>`` depend on the type.
+
+Message Types
+-------------
+
+.. _ipc-commands:
+
+Commands
+^^^^^^^^
+
+Using ``cmd`` for ``<type>``, you can control certain aspects of the bar.
+
+Available values for ``<payload>`` are:
+
+* ``quit``: Terminates the bar
+* ``restart``: Restarts the bar in-place
+* ``hide``: Hides the bar
+* ``show``: Makes the bar visible again, if it was hidden
+* ``toggle``: Toggles between the hidden and visible state.
+
+.. _ipc-actions:
+
+Module Actions
+^^^^^^^^^^^^^^
+
+For the ``<type>`` ``action``, ``polybar-msg`` can execute
+:doc:`module actions <actions>` in the bar.
+
+An action consists of the name of the target module, the name of the action and an optional data string:
+
+::
+
+  #<modulename>.<actionname>[.<data>]
+
+More information about action strings and available actions can be found in
+:doc:`actions`
+
+For example, if you have a date module named ``date``, you can toggle between
+the regular and alternative label with:
+
+.. code-block:: shell
+
+  polybar-msg action "#date.toggle"
+
+As an example for an action with data, say you have a menu module named
+``powermenu``, you can open the menu level 0 using:
+
+.. code-block:: shell
+
+  polybar-msg action "#powermenu.open.0"
+
+
+.. note::
+
+  For convenience, ``polybar-msg`` also allows you to pass the module name,
+  action name, and data as separate arguments:
+
+  .. code-block:: shell
+
+    polybar-msg action date toggle
+    polybar-msg action powermenu open 0
+
+  .. versionadded:: 3.6.0