Update URLs after migration

patrick96 2019-05-06 13:57:59 +02:00
parent fd1514ec1b
commit 78d3565204
No known key found for this signature in database
GPG Key ID: 521E5E03AEBCA1A7
19 changed files with 45 additions and 45 deletions

@ -1,7 +1,7 @@
## Dependencies
See the [README](/jaagr/polybar/#dependencies) for a general list of dependencies.
See the [README](/polybar/polybar/#dependencies) for a general list of dependencies.
Click [here](/jaagr/polybar#getting-started) to check if polybar was already packaged for your distro.
Click [here](/polybar/polybar#getting-started) to check if polybar was already packaged for your distro.
### Build Dependencies
The following dependencies are only needed during compilation, you can remove them, if you don't need them, after you built polybar
@ -67,7 +67,7 @@ or directly against the newest commit in the repository.
**Release Archive**
Download the release archive `polybar-<version>.tar` over at our
[release page](https://github.com/jaagr/polybar/releases) and extract it with
[release page](https://github.com/polybar/polybar/releases) and extract it with
`tar xvf polybar-<version>.tar`. Now change into the extracted folder
(generally `cd polybar`)
@ -79,7 +79,7 @@ To get the sources directly from the repository, run the following commands:
changes, there may be bugs.
```sh
# Make sure to type the `git' command as is to clone all git submodules too
git clone --recursive https://github.com/jaagr/polybar
git clone --recursive https://github.com/polybar/polybar
cd polybar
```
@ -89,7 +89,7 @@ folder where the polybar sources are located.
To compile, run the following commands:
**Note:** If you are using anaconda, run `conda deactivate` before running `cmake`, also see the note on the [Known Issues page](/jaagr/polybar/wiki/Known-Issues#building-with-anaconda-installed) if that doesn't work.
**Note:** If you are using anaconda, run `conda deactivate` before running `cmake`, also see the note on the [Known Issues page](/polybar/polybar/wiki/Known-Issues#building-with-anaconda-installed) if that doesn't work.
```sh
mkdir build

@ -111,7 +111,7 @@ exec = ${root.myscript-command}
## Bar settings
***Note*** For configuring multiple monitors automatically see https://github.com/jaagr/polybar/issues/763
***Note*** For configuring multiple monitors automatically see https://github.com/polybar/polybar/issues/763
~~~ dosini
[bar/mybar]

@ -53,15 +53,15 @@ when you just drop 200 lines of configs on them with the comment "It doesn't wor
## Read the Documentation
The above should have given you a specific location where your bar has issues. The next step should be to read on the
[Wiki](https://github.com/jaagr/polybar/wiki) about whatever component is not working. Most problems arise from incorrect
[Wiki](https://github.com/polybar/polybar/wiki) about whatever component is not working. Most problems arise from incorrect
or incomplete configuration, so make sure you haven't missed some configuration option that could solve your issue.
Also consult the [Known Issues](https://github.com/jaagr/polybar/wiki/Known-Issues) page and search through the
[GitHub issues](https://github.com/jaagr/polybar/issues?utf8=%E2%9C%93&q=is%3Aissue) for people that had the same issue.
Also consult the [Known Issues](https://github.com/polybar/polybar/wiki/Known-Issues) page and search through the
[GitHub issues](https://github.com/polybar/polybar/issues?utf8=%E2%9C%93&q=is%3Aissue) for people that had the same issue.
## Ask for Help (if needed)
If you completed all the steps above and weren't able to fix the issue yourself, it may be time to ask someone for help.
On our [SUPPORT.md](https://github.com/jaagr/polybar/blob/master/SUPPORT.md) page, you can find resources where you can
On our [SUPPORT.md](https://github.com/polybar/polybar/blob/master/SUPPORT.md) page, you can find resources where you can
ask for help. When you finally do reach out, make sure to include the MVCE that you created above as well as precise
instructions on how to reproduce your issue.

@ -1,4 +1,4 @@
Make sure you read the [Configuration wiki page](/jaagr/polybar/wiki/Configuration) on how to define the list of fonts to use.
Make sure you read the [Configuration wiki page](/polybar/polybar/wiki/Configuration) on how to define the list of fonts to use.
The sample config shipped with polybar uses the the following fonts by default: xorg's misc-fixed, [Unifont](http://unifoundry.com/unifont/index.html), and [siji](https://github.com/stark/siji).
Siji on debian-based system won't work right away after you install it with their script, you need to make sure to run `sudo dpkg-reconfigure fontconfig-config` and enable bitmap fonts.
@ -7,7 +7,7 @@ On Ubuntu even that command doesn't work and you have to manually `sudo rm /etc/
In the example configurations in this wiki we try to use icons from siji or unifont or we use emojis (provided by for example Noto Color Emoji). If you find icons that are neither emojis nor from these fonts, please let us know.
## Fonts
If you don't explicitly set the font-index for a tag, the bar will iterate the font list and pick the first one that is able to draw the character. [Read more on the wiki page about Formatting](https://github.com/jaagr/polybar/wiki/Formatting) and about what tags allow you to define a specific font index.
If you don't explicitly set the font-index for a tag, the bar will iterate the font list and pick the first one that is able to draw the character. [Read more on the wiki page about Formatting](https://github.com/polybar/polybar/wiki/Formatting) and about what tags allow you to define a specific font index.
**NOTE**: The `-font` property is a 1-based index of available fonts (which means that `*-font = 1` will use `font-0`).
@ -95,7 +95,7 @@ Icons can be provided in the form of text characters. Popular icon fonts include
- [IcoMoon](https://icomoon.io/app/#/select/library) - Custom/Mixed Licenses
- [Nerd Patched Fonts](https://github.com/ryanoasis/nerd-fonts) - Mixed Licenses
Most icon fonts make use of the Private Use Area unicode block and can conflict. Setting system priority via FontConfig may be preferable. After defining a font as explained above, [formatting tags](https://github.com/jaagr/polybar/wiki/Formatting#format-tags) can be used. Order of font definitions can also affect precedence.
Most icon fonts make use of the Private Use Area unicode block and can conflict. Setting system priority via FontConfig may be preferable. After defining a font as explained above, [formatting tags](https://github.com/polybar/polybar/wiki/Formatting#format-tags) can be used. Order of font definitions can also affect precedence.
### [GNOME Character Map](https://en.wikipedia.org/wiki/GNOME_Character_Map)
`gucharmap` is a convenient utility for browsing selected fonts. Filter `View > By Unicode Block + Show only glyphs from this font` and navigate to Private Use Area.
@ -137,4 +137,4 @@ Usage: `perl test-fonts.pl "😀"`
Note: maybe you need to install "Font::FreeType" module for the Script
```
$ perl -MCPAN -e 'install Font::FreeType'
```
```

@ -1,5 +1,5 @@
Make sure you read the [Configuration wiki page](https://github.com/jaagr/polybar/wiki/Configuration).
Make sure you read the [Configuration wiki page](https://github.com/polybar/polybar/wiki/Configuration).
## Formats
@ -152,7 +152,7 @@ you could use the foreground tag like this:
~~~dosini
label-volume = %{F#f00}%percentage%%{F-}%
~~~
**Pitfalls:** As described in [`#615`](https://github.com/jaagr/polybar/issues/615) using polybar variables inside
**Pitfalls:** As described in [`#615`](https://github.com/polybar/polybar/issues/615) using polybar variables inside
format tags is not possible. So something like this **won't** work:
```dosini
label = "Some text %{F${colors.foreground-alt}}Colored%{F-}"

@ -13,7 +13,7 @@ This sample configuration may not be fully functional on your machine without mo
[![](https://u.teknik.io/x32YI.png)](https://u.teknik.io/x32YI.png)
See the [Configuration wiki page](https://github.com/jaagr/polybar/wiki/Configuration) for more details on how to configure the bar.
See the [Configuration wiki page](https://github.com/polybar/polybar/wiki/Configuration) for more details on how to configure the bar.
## Running the app
@ -104,4 +104,4 @@ To allow other windows to be placed above the bar, or to avoid having the bar vi
[bar/mybar]
override-redirect = true
wm-restack = i3
~~~
~~~

@ -7,7 +7,7 @@ By default the project is built with a helper tool called `polybar-msg` used to
### Hook message for custom/ipc modules
Format: `hook:module/<module-name><hook-id>`
See the [module wiki page](https://github.com/jaagr/polybar/wiki/Module:-ipc) for more details on how to setup message hooks.
See the [module wiki page](https://github.com/polybar/polybar/wiki/Module:-ipc) for more details on how to setup message hooks.
### Action message to simulate mouse action
Format: `action:<message>`

@ -59,29 +59,29 @@ Do the same thing for `PKG_CONFIG_PATH` (though this variable is often already e
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/jaagr/polybar/issues/502),
[`#733`](https://github.com/jaagr/polybar/issues/733), [`#659`](https://github.com/jaagr/polybar/issues/659),
[`#1629`](https://github.com/jaagr/polybar/issues/1629)
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.
**Fix:** Add the `scale` property to the font definition in your config. For example `font-7 = NotoEmoji:scale=10`. The larger the number the smaller the Emojis.
This issue was discovered in [`#905`](https://github.com/jaagr/polybar/issues/905).
This issue was discovered in [`#905`](https://github.com/polybar/polybar/issues/905).
## Click Commands are not Executed
**Problem:** Some `click-*` commands are not executed when the bar is clicked. This is a bug that is triggered by the `click-*` command producing output on `stdout` or `stderr`.
**Workaround:** The `click-*` command must not produce any output, so redirect any output to `/dev/null`. This can be done by appending `>/dev/null 2>&1` to the `click-*` command (If you background the program with `&`, make sure that `&` is still at the very end).
This issue was discovered in [`#916`](https://github.com/jaagr/polybar/issues/916).
This issue was discovered in [`#916`](https://github.com/polybar/polybar/issues/916).
## With multiple modules of the same type, actions on those modules control the leftmost module
**Problem:** This affects all modules that provide their internal mouse actions that change the module behaviour:
* `internal/alsa`
* `internal/date`
* `custom/menu` (Per it's [Wiki Page](https://github.com/jaagr/polybar/wiki/Module:-menu) you can already only define one menu per bar)
* `custom/menu` (Per it's [Wiki Page](https://github.com/polybar/polybar/wiki/Module:-menu) you can already only define one menu per bar)
* `internal/mpd`
* `internal/pulseaudio`
* `internal/xbacklight`
@ -102,7 +102,7 @@ This issue occurs because `jsoncpp` changes the name of their `.so` file every r
**Workaround:** If you want to explicitly set a module's (or parts of its) background to `background-0`, use a color that is almost the same. E.g. if `background-0` is `#FFFF00` use `#FFFF01`.
This behaviour was introduced in [`#831`](https://github.com/jaagr/polybar/pull/831), to resolve the issue described in [`#759`](https://github.com/jaagr/polybar/issues/759). There is no way to resolve this without some major code changes to the renderer.
This behaviour was introduced in [`#831`](https://github.com/polybar/polybar/pull/831), to resolve the issue described in [`#759`](https://github.com/polybar/polybar/issues/759). There is no way to resolve this without some major code changes to the renderer.
## `override-redirect` in i3
**Problem:** i3 and polybar sometimes interact quite weirdly and often `override-redirect = true` is needed to resolve it. This however makes i3 not reserve space for the polybar window, making other windows overlap polybar. There doesn't seem to be that much that we can do about this from polybar's side, because as soon as we need to use `override-redirect = true`, we can't tell i3 to reserve space for the polybar window.
@ -132,4 +132,4 @@ Note that it will not be installed via `apt` and thus to uninstall you'll need t
Now you should be able to compile polybar without problems, just clear the build directory first.
This issue was discovered in [`#644`](https://github.com/jaagr/polybar/issues/644), you will find more details there.
This issue was discovered in [`#644`](https://github.com/polybar/polybar/issues/644), you will find more details there.

@ -1,5 +1,5 @@
This module shows volume and mute state for ALSA mixers. Most of the module functionality should work as long as you are using an alsa backend, like pulseaudio-alsa.
If you use `pulseaudio` use the [`internal/pulseaudio`](https://github.com/jaagr/polybar/wiki/Module:-pulseaudio) module instead, even if it uses alsa as the backend.
If you use `pulseaudio` use the [`internal/pulseaudio`](https://github.com/polybar/polybar/wiki/Module:-pulseaudio) module instead, even if it uses alsa as the backend.
**NOTE**: This module requires the project to be built with ALSA support.

@ -1,4 +1,4 @@
**If this module doesn't work for you, try to use [the new xbacklight module](https://github.com/jaagr/polybar/wiki/Module:-xbacklight)**
**If this module doesn't work for you, try to use [the new xbacklight module](https://github.com/polybar/polybar/wiki/Module:-xbacklight)**
---

@ -1,6 +1,6 @@
This module uses the bspwm ipc client to display information about available monitors, desktops and layout states.
See the [Configuration wiki page](https://github.com/jaagr/polybar/wiki/Configuration#global-wm-settings) for details on how to configure the `_NET_WM_STRUT_PARTIAL` values. This will allow you to update `padding_{top,bottom}` when the bar is launched.
See the [Configuration wiki page](https://github.com/polybar/polybar/wiki/Configuration#global-wm-settings) for details on how to configure the `_NET_WM_STRUT_PARTIAL` values. This will allow you to update `padding_{top,bottom}` when the bar is launched.
### Accessible workspace cycling
@ -154,4 +154,4 @@ counter=0
bspc query -D --names | while read -r name; do
printf 'ws-icon-%i = "%s;<insert-icon-here>"\n' $((counter++)) $name
done
~~~
~~~

@ -32,4 +32,4 @@ format = <label>
; %notifications% (default)
; Default: Notifications: %notifications%
label = %notifications%
~~~
~~~

@ -63,4 +63,4 @@ initial = 1
click-left = polybar-msg -p %pid% hook demo 1
click-right = polybar-msg -p %pid% hook demo 2
double-click-left = polybar-msg -p %pid% hook demo 3
~~~
~~~

@ -1,4 +1,4 @@
This module lets you create text menus. It is possible to control the menu using [Inter-process messaging](https://github.com/jaagr/polybar/wiki/Inter-process-messaging).
This module lets you create text menus. It is possible to control the menu using [Inter-process messaging](https://github.com/polybar/polybar/wiki/Inter-process-messaging).
**NOTE:** Currently there can only be one menu defined for each bar.
@ -50,4 +50,4 @@ label-close = x
; Optional item separator
; Default: none
label-separator = |
~~~
~~~

@ -1,6 +1,6 @@
This module shows information related to [MPD](https://www.musicpd.org).
You must have `libmpdclient` or `libmpdclient-dev` installed before you compile polybar. See [compiling](https://github.com/jaagr/polybar/wiki/Compiling).
You must have `libmpdclient` or `libmpdclient-dev` installed before you compile polybar. See [compiling](https://github.com/polybar/polybar/wiki/Compiling).
**NOTE**: The module won't be displayed if the current playlist is empty.

@ -5,7 +5,7 @@ The module will wait for the `exec` script to finish until updating its contents
If your script is using an infinite loop in combination with `tail = true`, the `exec-if` condition is only checked until it evaluates to true for the first time, because it is only checked before running the `exec` command and since the `exec` command never returns (because of the infinite loop), `exec-if` is never evaluated again, once the `exec` command is running. So if the `exec-if` condition at some point, while the infinite loop is running, would evaluate to false the script will not suddenly stop running and the module will not disappear.
If you want that your module disappear from the bar in some cases, your output has to be created with `echo ""` Otherwise an outdated output is still on the bar. See [#504](https://github.com/jaagr/polybar/issues/504).
If you want that your module disappear from the bar in some cases, your output has to be created with `echo ""` Otherwise an outdated output is still on the bar. See [#504](https://github.com/polybar/polybar/issues/504).
### Basic settings
~~~ ini

@ -22,4 +22,4 @@ click-right = echo right
; "scroll-(up|down)" will be executed using "/usr/bin/env sh -c $COMMAND"
scroll-up = echo scroll up
scroll-down = echo scroll down
~~~
~~~

@ -3,7 +3,7 @@
Things to be done:
- Occupied state
- Filtering (only display workspaces with defined name/index/range)
- Label for visible but not focused workspaces (on multiple monitors, see [`#950`](https://github.com/jaagr/polybar/issues/950))
- Label for visible but not focused workspaces (on multiple monitors, see [`#950`](https://github.com/polybar/polybar/issues/950))
---

@ -14,13 +14,13 @@ We try to follow [Semantic Versioning](https://semver.org/) in this project. Thi
## Publishing a new Release
There can be three types of releases: major, minor and patch releases. The process for major and minor releases is the same, we're going to reference both of them as minor releases below.
All releases, after their release PR was merged, have to be drafted and released with the [github release tool](https://github.com/jaagr/polybar/releases/new), this ensures that they show up in github's [list of releases](https://github.com/jaagr/polybar/releases) and that they are properly tagged.
All releases, after their release PR was merged, have to be drafted and released with the [github release tool](https://github.com/polybar/polybar/releases/new), this ensures that they show up in github's [list of releases](https://github.com/polybar/polybar/releases) and that they are properly tagged.
### Minor Release
A minor release marks the current state of the `master` branch as the new version. To retain our ability to do patch releases even when there have been new features added, on every minor release, a new branch is created for that release. The name of that branch is the numeric name of the release without the patch number (e.g. 3.2 or 4.0), this avoids name conflicts with the version tags. The branch points to the release commit on the `master` branch.
The release commit is created by first opening a release PR (see [`#1338`](https://github.com/jaagr/polybar/pull/1338) or [`#863`](https://github.com/jaagr/polybar/pull/863)) and after review squashing it into a single commit containing the changelog for that release.
The release commit is created by first opening a release PR (see [`#1338`](https://github.com/polybar/polybar/pull/1338) or [`#863`](https://github.com/polybar/polybar/pull/863)) and after review squashing it into a single commit containing the changelog for that release.
After all this is done, a new release is drafted and published with the [github release tool](https://github.com/jaagr/polybar/releases/new) with the target set to the release branch. Ideally the release text is already drafted and only has to be published.
After all this is done, a new release is drafted and published with the [github release tool](https://github.com/polybar/polybar/releases/new) with the target set to the release branch. Ideally the release text is already drafted and only has to be published.
This way we can do normal development on the `master` branch and fix errors in minor releases by cherry-picking commits onto the release branch without having to release all the work on `master` (which would force us to do a minor release).
@ -47,7 +47,7 @@ After it is reviewed, the release PR is squashed and the changelog for the new v
### Changelog
Each release should come with a changelog briefly explaining what has changed for the user. It should generally be separated into 'Deprecations', 'Features', and 'Fixes', with 'Breaking Changes' listed separately at the top.
See [old releases](https://github.com/jaagr/polybar/releases) for how to format the changelog.
See [old releases](https://github.com/polybar/polybar/releases) for how to format the 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.
@ -57,10 +57,10 @@ After any release is published, the following things should be done:
* Make sure all the new functionality is documented on the wiki
* Mark deprecated features appropriately
* Remove all `unreleased` notes from the wiki
* Inform packagers of new release, specifically mention dependency changes. Look through the `Packaging` issue tag for packagers [here](https://github.com/jaagr/polybar/issues?q=is%3Aissue+label%3APackaging+is%3Aopen).
* Inform packagers of new release, specifically mention dependency changes. Look through the `Packaging` issue tag for packagers [here](https://github.com/polybar/polybar/issues?q=is%3Aissue+label%3APackaging+is%3Aopen).
* Create a source archive named `polybar-@POLYBAR_VERSION@.tar` that includes the submodule source code with the following commands and attach it to the github release:
```bash
git clone --branch @POLYBAR_VERSION@ --recursive git://github.com/jaagr/polybar.git
git clone --branch @POLYBAR_VERSION@ --recursive git://github.com/polybar/polybar.git
find polybar -name ".git" -exec rm -rf {} \+
tar cf polybar-@POLYBAR_VERSION@.tar polybar
```