aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorDeveshi Dwivedi <120312681+deveshidwivedi@users.noreply.github.com>2025-04-03 18:44:08 +0530
committerGitHub <noreply@github.com>2025-04-03 06:14:08 -0700
commit9722bd7b1b4793fa00af0dc971ceabb075c46d37 (patch)
treecf673c7d0d6f71f05392c42d6b121ce9357f5365 /runtime/doc
parent5cdfa3324f4cafe2ac98d2e9ec4e812aa9c0598e (diff)
downloadrneovim-9722bd7b1b4793fa00af0dc971ceabb075c46d37.tar.gz
rneovim-9722bd7b1b4793fa00af0dc971ceabb075c46d37.tar.bz2
rneovim-9722bd7b1b4793fa00af0dc971ceabb075c46d37.zip
feat(clipboard): g:clipboard="foo" forces the "foo" clipboard tool #33235
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/news.txt2
-rw-r--r--runtime/doc/provider.txt21
2 files changed, 23 insertions, 0 deletions
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index eee39f81f5..72ab3373f7 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -138,6 +138,8 @@ OPTIONS
• 'winborder' add bold style.
+• |g:clipboard| accepts a string name to force any builtin clipboard tool.
+
PERFORMANCE
• todo
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
index 7a4cc0ee7d..4f7807f721 100644
--- a/runtime/doc/provider.txt
+++ b/runtime/doc/provider.txt
@@ -240,6 +240,27 @@ The "copy" function stores a list of lines and the register type. The "paste"
function returns the clipboard as a `[lines, regtype]` list, where `lines` is
a list of lines and `regtype` is a register type conforming to |setreg()|.
+Nvim also supports setting g:clipboard to a string to use a builtin clipboard provider:
+
+ - "tmux" - Use tmux clipboard
+ - "xclip" - Use xclip for X11 clipboard
+ - "xsel" - Use xsel for X11 clipboard
+ - "wl-copy" - Use Wayland clipboard with wl-copy/wl-paste
+ - "wayclip" - Use Wayland clipboard with waycopy/waypaste
+ - "lemonade" - Use lemonade clipboard (for SSH)
+ - "doitclient" - Use doitclient clipboard (for SSH)
+ - "win32yank" - Use win32yank clipboard (for Windows)
+ - "clip" - Use clip/powershell clipboard (for Windows)
+ - "putclip" - Use putclip/getclip clipboard (for Windows/Cygwin)
+ - "termux" - Use Termux clipboard
+ - "pbcopy" - Use macOS clipboard
+ - "osc52" - Use OSC 52 sequence
+
+Example: >vim
+ let g:clipboard = 'tmux'
+
+This is equivalent to using the full dictionary configuration for tmux shown above.
+
*clipboard-wsl*
For Windows WSL, try this g:clipboard definition:
>vim