DOCS/man: add documentation of wayland backend and properties

This commit is contained in:
nanahi
2025-01-27 18:51:31 +01:00
committed by Kacper Michajłow
parent ab461e0209
commit 27db2e1d50
2 changed files with 33 additions and 3 deletions
+28 -2
View File
@@ -3968,10 +3968,36 @@ Property list
The text content in the clipboard (Windows, Wayland and macOS only).
Writing to this property sets the text clipboard content (Windows only).
``clipboard/text-primary``
The text content in the primary selection (Wayland only).
.. note::
On Wayland, the clipboard content is only updated when the compositor
sends a selection data offer (typically when VO window is focused).
On Wayland with the ``vo`` clipboard backend, the clipboard content is
only updated when the compositor sends a selection data offer
(typically when VO window is focused). The ``wayland`` backend typically
does not have this limitation.
See ``current-clipboard-backend`` property for more details.
``current-clipboard-backend``
A string containing the currently active clipboard backend.
The following clipboard backends are implemented:
``win32``
Windows backend.
``mac``
macOS backend.
``wayland``
Wayland backend. This backend is only available if the compositor
supports the ``zwlr_data_control_manager_v1`` protocol.
``vo``
VO backend. Requires an active VO window, and support differs across
platforms. Currently, this is used as a fallback for Wayland
compositors without support for the ``zwlr_data_control_manager_v1``
protocol.
Inconsistencies between options and properties
----------------------------------------------
+5 -1
View File
@@ -7871,10 +7871,14 @@ Miscellaneous
writing to the ``clipboard`` property to get and set clipboard contents.
``--clipboard-monitor=<yes|no>``
(Windows and macOS only)
(Windows, Wayland and macOS only)
Enable clipboard monitoring so that the ``clipboard`` property can be
observed for content changes (default: no). This only affects clipboard
implementations which use polling to monitor clipboard updates.
Other platforms currently ignore this option and always/never notify
changes.
On Wayland, this option only has effect on the ``wayland`` backend, and
not for the ``vo`` backend. See ``current-clipboard-backend`` property for
more details.