aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTomek Łaziuk2015-08-17 23:18:47 +0200
committerTomek Łaziuk2015-09-02 09:53:08 +0200
commita30524a9fc3e79ae9982b5e93888ee4bc0c1f4db (patch)
treec07bab1cb3965d9c9806fbe270f6f0fd4b68790a /README.md
parent750002ade00e2b8264bb131906a605e49985d812 (diff)
downloadvim-system-copy-master.tar.bz2
user options for copy and paste commands addedHEADmaster
in this commit: user custom options for copy and paste commands more specific and unique checks for build-in mappings checking if plugin was initialized moved to very first lines
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 27 insertions, 7 deletions
diff --git a/README.md b/README.md
index f87b360..e04c753 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
System Copy
===========
-System copy provides vim mappings for copying / pastying text to the os specific
+System copy provides vim mappings for copying / pasting text to the os specific
clipboard. Most people will be happy just setting their Vim clipboard to the
system clipboard, but I find that doing so pollutes my clipboard history.
Instead, this plugin creates a unique mapping that explicitly pulls content
@@ -22,25 +22,45 @@ object. For instance:
In addition, `cP` is mapped to copy the current line directly.
-The sequence `cv` is mapped to paste the content of system clipboard.
+The sequence `cv` is mapped to paste the content of system clipboard to the
+next line.
Clipboard Utilities
-------------------
- - OSX - pbcopy
- - Windows - clip
- - Linux - xsel
+ - OSX - `pbcopy` and `pbpaste`
+ - Windows - `clip` and `paste`
+ - Linux - `xsel`
+
+Options
+-------
+
+`system-copy` uses default copy and paste command based on your OS, but
+you can override either of these commands if you have more specific needs.
+
+To declare custom copy command use following example:
+``` vim
+let g:system_copy#copy_command='xclip -sel clipboard'
+```
+And to declare custom paste command use:
+``` vim
+let g:system_copy#paste_command='xclip -sel clipboard -o'
+```
Installation
------------
-If you don't have a preferred installation method, I recommend using [Vundle][].
+If you don't have a preferred installation method, I recommend using [Vundle](https://github.com/VundleVim/Vundle.vim).
Assuming you have Vundle installed and configured, the following steps will
install the plugin:
-Add the following line to your `~/.vimrc` and then run `PluginInstall` from
+Add the following line to your `~/.vimrc` and then run `:PluginInstall` from
within Vim:
``` vim
+call vundle#begin()
+" ...
Plugin 'christoomey/vim-system-copy'
+" ...
+call vundle#end()
```