aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim_clipboard.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/nvim_clipboard.txt')
-rw-r--r--runtime/doc/nvim_clipboard.txt47
1 files changed, 47 insertions, 0 deletions
diff --git a/runtime/doc/nvim_clipboard.txt b/runtime/doc/nvim_clipboard.txt
new file mode 100644
index 0000000000..ab7a8c3423
--- /dev/null
+++ b/runtime/doc/nvim_clipboard.txt
@@ -0,0 +1,47 @@
+*nvim_clipboard.txt* For Nvim. {Nvim}
+
+
+ NVIM REFERENCE MANUAL by Thiago de Arruda
+
+
+Clipboard integration for Nvim *nvim-clipboard*
+
+By default, Nvim has no connection to the system clipboard. Eventually that
+will be implemented by UI programs, which connect to Nvim via |msgpack-rpc|.
+
+Even though externalized UIs are not available yet, there's a workaround that
+enables clipboard usage through the python interface(which also uses
+|msgpack-rpc| and consequently can implement the clipboard methods required
+by Nvim):
+
+- Make sure you follow the setup instructions in |nvim-python-quickstart|.
+- Install the `xerox` python module:
+ >
+ $ pip install xerox
+<
+- Create a ~/.vim/pythonx/nvim_clipboard.py file with the following contents:
+ >
+ import xerox
+
+ class NvimClipboard(object):
+ def __init__(self, vim):
+ self.provides = ['clipboard']
+
+ def clipboard_get(self):
+ return xerox.paste().split('\n')
+
+ def clipboard_set(self, lines):
+ xerox.copy(u'\n'.join([line.decode('utf-8') for line in lines]))
+<
+This should enable the '+' and '*' registers. As an optional step, set the
+'unnamedclip' option to transparently access clipboard using the unnamed
+register. If you use the same |vimrc| for both Vim and Nvim, make sure you
+only set the option when `has('neovim')` is true:
+>
+ if has('neovim')
+ set unnamedclip
+ endif
+<
+
+==============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl: