DOCS/man: add documentation of wayland backend and properties

nanahi committed 1 year ago

Commit 27db2e11 parent ab461e02 files · +33 −3Browse files

Unified · Split

2 files

DOCS/man/input.rst +28 −2
DOCS/man/options.rst +5 −1

@@ -3968,10 +3968,36 @@ Property list · 3967 unmodified lines
3968	The text content in the clipboard (Windows, Wayland and macOS only).	3968	The text content in the clipboard (Windows, Wayland and macOS only).
3969	Writing to this property sets the text clipboard content (Windows only).	3969	Writing to this property sets the text clipboard content (Windows only).
3970		3970
		3971	``clipboard/text-primary``
		3972	The text content in the primary selection (Wayland only).
		3973
3971	.. note::	3974	.. note::
3972		3975
3973	On Wayland, the clipboard content is only updated when the compositor	3976	On Wayland with the ``vo`` clipboard backend, the clipboard content is
3974	sends a selection data offer (typically when VO window is focused).	3977	only updated when the compositor sends a selection data offer
		3978	(typically when VO window is focused). The ``wayland`` backend typically
		3979	does not have this limitation.
		3980	See ``current-clipboard-backend`` property for more details.
		3981
		3982	``current-clipboard-backend``
		3983	A string containing the currently active clipboard backend.
		3984	The following clipboard backends are implemented:
		3985
		3986	``win32``
		3987	Windows backend.
		3988
		3989	``mac``
		3990	macOS backend.
		3991
		3992	``wayland``
		3993	Wayland backend. This backend is only available if the compositor
		3994	supports the ``zwlr_data_control_manager_v1`` protocol.
		3995
		3996	``vo``
		3997	VO backend. Requires an active VO window, and support differs across
		3998	platforms. Currently, this is used as a fallback for Wayland
		3999	compositors without support for the ``zwlr_data_control_manager_v1``
		4000	protocol.
3975		4001
3976	Inconsistencies between options and properties	4002	Inconsistencies between options and properties
3977	----------------------------------------------	4003	----------------------------------------------

DOCS/man/options.rst+5−1

     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.

DOCS/man: add documentation of wayland backend and properties

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code