doc: Improve tray documentation

Unaware users may be confused by why the tray module is not shown in the
default config and if they add it, they may be confused why only one of
their bars shows the module.
This commit is contained in:
patrick96 2024-07-28 14:53:04 +02:00 committed by Patrick Ziegler
parent 81ea16931e
commit baed54bc76
2 changed files with 12 additions and 2 deletions

View File

@ -64,6 +64,14 @@ enable-ipc = true
; 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

View File

@ -15,14 +15,16 @@ the Dropbox application).
Polybar is only responsible for embedding the windows in the bar and
positioning them correctly.
.. note::
.. attention::
Only a single instance of this module can be active at the same time (across
all polybar instances).
all polybar instances in the same graphical session).
The way the `system tray protocol <systray-spec_>`_ works, at most one tray
can exist at any time.
Polybar will produce a warning if additional tray instances are created.
This also applies when another tray application (e.g. ``stalonetray``) is
active.
For transparent background colors, the tray will use pseudo-transparency, true
transparency is not possible for the tray icons.