History

DOCS/man: add documentation of wayland backend and properties

nanahi committed 1 year ago

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

Showing the changes to DOCS (2 of 2 files). Show all

Unified · Split

2 files
  1. DOCS/man/input.rst +28 −2
  2. DOCS/man/options.rst +5 −1
DOCS/man/input.rst+28−2
@@ -3968,10 +3968,36 @@ Property list · 3967 unmodified lines
39683968 The text content in the clipboard (Windows, Wayland and macOS only).
39693969 Writing to this property sets the text clipboard content (Windows only).
39703970
3971+ ``clipboard/text-primary``
3972+ The text content in the primary selection (Wayland only).
3973+
39713974 .. note::
39723975
3973− On Wayland, the clipboard content is only updated when the compositor
3974− sends a selection data offer (typically when VO window is focused).
3976+ On Wayland with the ``vo`` clipboard backend, the clipboard content is
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.
39754001
39764002 Inconsistencies between options and properties
39774003 ----------------------------------------------
DOCS/man/options.rst+5−1
@@ -7871,10 +7871,14 @@ Miscellaneous · 7870 unmodified lines
78717871 writing to the ``clipboard`` property to get and set clipboard contents.
78727872
78737873 ``--clipboard-monitor=<yes|no>``
7874− (Windows and macOS only)
7874+ (Windows, Wayland and macOS only)
78757875
78767876 Enable clipboard monitoring so that the ``clipboard`` property can be
78777877 observed for content changes (default: no). This only affects clipboard
78787878 implementations which use polling to monitor clipboard updates.
78797879 Other platforms currently ignore this option and always/never notify
78807880 changes.
7881+
7882+ On Wayland, this option only has effect on the ``wayland`` backend, and
7883+ not for the ``vo`` backend. See ``current-clipboard-backend`` property for
7884+ more details.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t