DOCS: add clipboard documentations

mpv-player · Nov 22, 2024 · a7a338c · a7a338c
1 parent 49a4e5a
commit a7a338c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 8 deletions.
diff --git a/DOCS/interface-changes/clipboard.txt b/DOCS/interface-changes/clipboard.txt
@@ -0,0 +1,2 @@
+add `--clipboard-enabled` and `--clipboard-monitor` options
+add `clipboard` property
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
@@ -3893,6 +3893,18 @@ Property list
 
     This property is read-only, and change notification is not supported.
 
+``clipboard``
+    The clipboard contents, only works when native clipboard
+    (``--clipboard-enable``) is supported on the platform.
+    Depending on the platform, some sub-properties, writing to properties,
+    or change notifications are not currently functional.
+
+    This has a number of sub-properties:
+
+    ``clipboard/text`` (RW)
+        The text content in the clipboard (Windows and Wayland only).
+        Writing to this property sets the text clipboard content (Windows only).
+
 Inconsistencies between options and properties
 ----------------------------------------------
 

diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
@@ -7783,13 +7783,17 @@ Miscellaneous
     See the FFmpeg libavfilter documentation for details on the available
     filters.
 
-``--metadata-codepage=<codepage>``
-    Codepage for various input metadata (default: ``auto``). This affects how
-    file tags, chapter titles, etc. are interpreted. In most cases, this merely
-    evaluates to UTF-8 as non-UTF-8 codepages are obscure.
+``--clipboard-enable=<yes|no>``
+    (Windows and Wayland only)
 
-    See ``--sub-codepage`` option on how codepages are specified and further
-    details regarding autodetection and codepage conversion. (The underlying
-    code is the same.)
+    Enable native clipboard support (default: yes). This allows reading and
+    writing to the ``clipboard`` property to get and set clipboard contents.
 
-    Conversion is not applied to metadata that is updated at runtime.
+``--clipboard-monitor=<yes|no>``
+    (Windows 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.