From b0050069574d8a18ca2069b5e3156306c2612796 Mon Sep 17 00:00:00 2001
From: patrick96
Date: Thu, 26 Nov 2020 14:06:22 +0100
Subject: [PATCH] Separate Known Issues in runtime and build issues
---
Known-Issues.md | 96 ++++++++++++++++++++++++++-----------------------
1 file changed, 51 insertions(+), 45 deletions(-)
diff --git a/Known-Issues.md b/Known-Issues.md
index 3cfcc5f..32ac395 100644
--- a/Known-Issues.md
+++ b/Known-Issues.md
@@ -1,17 +1,20 @@
This page lists some of the issues one can encounter when using polybar. Either quirks in polybar's behaviour or actual bugs we haven't been able to fix yet.
# Contents
-- [`Failed to get root pixmap, default to black (is there a wallpaper?)`](#failed-to-get-root-pixmap-default-to-black-is-there-a-wallpaper)
-- [`Cannot find root pixmap, try a different tool to set the desktop background`](#cannot-find-root-pixmap-try-a-different-tool-to-set-the-desktop-background)
-- [Building with Anaconda installed](#building-with-anaconda-installed)
-- [Huge Emojis](#huge-emojis)
-- [Click Commands are not Executed](#click-commands-are-not-executed)
-- [With multiple modules of the same type, actions on those modules always control the leftmost module](#with-multiple-modules-of-the-same-type-actions-on-those-modules-control-the-leftmost-module)
-- [Error While Loading Shared Libraries: libjsoncpp](#error-while-loading-shared-libraries-libjsoncpp)
-- [Setting Module Backgrounds when using Gradients](#setting-module-backgrounds-when-using-gradients)
-- [`override-redirect` in i3](#override-redirect-in-i3)
-- [Mouse Interactions not Working in AwesomeWM](#mouse-interactions-not-working-in-awesomewm)
+- [Running Polybar](#running-polybar)
+ * [`Failed to get root pixmap, default to black (is there a wallpaper?)`](#-failed-to-get-root-pixmap--default-to-black--is-there-a-wallpaper---)
+ * [`Cannot find root pixmap, try a different tool to set the desktop background`](#-cannot-find-root-pixmap--try-a-different-tool-to-set-the-desktop-background-)
+ * [Huge Emojis](#huge-emojis)
+ * [Click Commands are not Executed](#click-commands-are-not-executed)
+ * [With multiple modules of the same type, actions on those modules control the leftmost module](#with-multiple-modules-of-the-same-type--actions-on-those-modules-control-the-leftmost-module)
+ * [Error While Loading Shared Libraries: libjsoncpp](#error-while-loading-shared-libraries--libjsoncpp)
+ * [Setting Module Backgrounds when using Gradients](#setting-module-backgrounds-when-using-gradients)
+ * [`override-redirect` in i3](#-override-redirect--in-i3)
+ * [Mouse Interactions not Working in AwesomeWM](#mouse-interactions-not-working-in-awesomewm)
+- [Compiling Polybar](#compiling-polybar)
+ * [Building with Anaconda installed](#building-with-anaconda-installed)
+# Running Polybar
## `Failed to get root pixmap, default to black (is there a wallpaper?)`
Polybar prints this warning when there is no wallpaper set and `pseudo-transparency = true` is set. Polybar will still
@@ -28,41 +31,6 @@ when rendering transparent colors.
with a tool like `feh` or `nitrogen`
-## Building with Anaconda installed
-**Problem:** On systems using Anaconda compiling polybar will likely fail with one of these error messages:
-* `Missing required python module: xcbgen`
-* `ERROR: could not calc required_start_align of Struct "xcb.Setup"`
-* `Cairo was not compiled with support for the xcb backend`
-
-The general issue is that the libraries and programs provided by Anaconda cannot be used to build polybar in many cases.
-
-**Fix:** The easiest fix is to uninstall Anaconda if you don't need it.
-
-If you can't/don't want to uninstall Anaconda, we need to force polybar to not use any resources provided by Anaconda.
-This can be done by temporarily removing any paths that point to anaconda from both the `$PATH` and `$PKG_CONFIG_PATH` environment variables in the terminal before building polybar.
-
-People have reported that `conda deactivate` does that for you for the currently open terminal. If that doesn't work, try doing it manually:
-
-For example if your `PATH` variable contains:
-
-```
-/home//anaconda2/bin:/home//bin:...:/usr/bin
-```
-
-Remove `/home//anaconda2/bin` and reexport the variable:
-
-```
-export PATH=/home//bin:...:/usr/bin
-```
-
-Do the same thing for `PKG_CONFIG_PATH` (though this variable is often already empty). Now you should be able to build
-polybar with either the `build.sh` script or `cmake` and `make`. Make sure that you do a clean build (redownload all
-polybar sources).
-
-This was reported in [`#502`](https://github.com/polybar/polybar/issues/502),
-[`#733`](https://github.com/polybar/polybar/issues/733), [`#659`](https://github.com/polybar/polybar/issues/659),
-[`#1629`](https://github.com/polybar/polybar/issues/1629)
-
## Huge Emojis
**Problem:** When using the Noto Emoji font, Emojis appear extremely big on the bar. Setting the `size` property doesn't help.
@@ -122,3 +90,41 @@ mouse events on the bar once polybar is the focused window.
**Solution:** The only fix for this seems to be to set `override-redirect =
true` in your bar section. This tells AwesomeWM to not manage the polybar
window.
+
+# Compiling Polybar
+
+## Building with Anaconda installed
+**Problem:** On systems using Anaconda compiling polybar will likely fail with one of these error messages:
+* `Missing required python module: xcbgen`
+* `ERROR: could not calc required_start_align of Struct "xcb.Setup"`
+* `Cairo was not compiled with support for the xcb backend`
+
+The general issue is that the libraries and programs provided by Anaconda cannot be used to build polybar in many cases.
+
+**Fix:** The easiest fix is to uninstall Anaconda if you don't need it.
+
+If you can't/don't want to uninstall Anaconda, we need to force polybar to not use any resources provided by Anaconda.
+This can be done by temporarily removing any paths that point to anaconda from both the `$PATH` and `$PKG_CONFIG_PATH` environment variables in the terminal before building polybar.
+
+People have reported that `conda deactivate` does that for you for the currently open terminal. If that doesn't work, try doing it manually:
+
+For example if your `PATH` variable contains:
+
+```
+/home//anaconda2/bin:/home//bin:...:/usr/bin
+```
+
+Remove `/home//anaconda2/bin` and reexport the variable:
+
+```
+export PATH=/home//bin:...:/usr/bin
+```
+
+Do the same thing for `PKG_CONFIG_PATH` (though this variable is often already empty). Now you should be able to build
+polybar with either the `build.sh` script or `cmake` and `make`. Make sure that you do a clean build (redownload all
+polybar sources).
+
+This was reported in [`#502`](https://github.com/polybar/polybar/issues/502),
+[`#733`](https://github.com/polybar/polybar/issues/733), [`#659`](https://github.com/polybar/polybar/issues/659),
+[`#1629`](https://github.com/polybar/polybar/issues/1629)
+