commit 2a906bfad60b179a6ebe028c7d58ac44bc3545de
parent a2b92a5efbb4159d15311f015bb270f80de42e3a
Author: Kevin Locke <kevin@kevinlocke.name>
Date: Wed, 4 Feb 2026 18:53:08 +0000
docs: setting g:clipboard after provider init #37705
Problem:
Users may be unaware that setting `g:clipboard` after providers are
initialized has no effect, and that `has('clipboard')` initializes
providers, as in #13062.
Solution:
Note the restriction and link to workarounds in FAQ for discoverability.
Diffstat:
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
@@ -199,7 +199,11 @@ registers. Nvim supports these clipboard tools, in order of priority:
*g:clipboard*
To configure a custom clipboard tool, set `g:clipboard` to a string name (from
the above |clipboard-tool| list), or dict (to explicitly specify the shell
-commands or |lambda| functions).
+commands or |lambda| functions) before clipboard providers are initialized.
+
+Note: Clipboard providers are initialized by calling `has('clipboard')`, which
+is best avoided before setting `g:clipboard`. See "G:CLIPBOARD SETTINGS ARE NOT
+USED" in |faq-runtime| for workarounds.
If "cache_enabled" is |TRUE| then when a selection is copied Nvim will cache
the selection until the copy command process dies. When pasting, if the copy
