Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Jorenar/fauxClip

Custom registers and clipboard support for Vim without +clipboard
https://github.com/Jorenar/fauxClip

clip clipboard nogui tmux vim

Last synced: 3 months ago
JSON representation

Custom registers and clipboard support for Vim without +clipboard

Awesome Lists containing this project

README

        

fauxClip
========

**fauxClip** is a Vim plugin allowing to define custom registers, with primary
goal of providing a pseudo _clipboard_ support for versions of Vim compiled
without _+clipboard_.

---

Default utilities for clipboard yank and paste are:

* `xclip` (on Linux with X server, or WSL)
* `xsel` (fallback to `xclip`)
* `pbcopy` + `pbpaste` (on macOS)
* `clip.exe` + `powershell.exe Get-Clipboard` (on Windows)
* `wl-copy` + `wl-paste` (on Linux with Wayland)

---

Assuming you are on Linux, using Tmux, `xclip` is installed, and you didn't
change any of fauxClip's defaults, then the dictionary with commands for
registers will be set as following:

```vim
let g:fauxClip_regcmds = {
\ '+': {
\ 'yank': 'xclip -f -i -selection clipboard',
\ 'paste': 'xclip -o -selection clipboard',
\ },
\ '*': {
\ 'yank': 'xclip -f -i',
\ 'paste': 'xclip -o',
\ },
\ ']': {
\ 'yank': 'tmux load-buffer -',
\ 'paste': 'tmux save-buffer -',
\ }
\ }
```

By manually setting any of the items you can overwrite the defaults, or craft
your own registers:
```vim
let g:fauxClip_regcmds = {
\ '!': {
\ 'paste': 'echo "Bang!"'
\ }
\ }
```

**Note:** to disable clipboard registers `*` and `+` you need to explicitly set
them to empty strings.

---

To set different "register" for Tmux than `]`:
```vim
let g:fauxClip_tmux_reg = 't'
```

If for some reason you don't want to suppress error messages from clipboard
command (e.g. `xclip`'s empty clipboard), then:
```vim
let g:fauxClip_suppress_errors = 0
```

If Vim is compiled with _+clipboard_, but you want to use custom commands
regardless, then:
```vim
let g:fauxClip_always_use = 1
```

## Installation

#### [vim-plug](https://github.com/junegunn/vim-plug):
```vim
Plug 'Jorengarenar/fauxClip'
```

#### Vim's packages
```bash
cd ~/.vim/pack/plugins/start
git clone git://github.com/Jorengarenar/fauxClip.git
```

#### Single file
```sh
curl --create-dirs -L https://raw.githubusercontent.com/Jorengarenar/fauxClip/master/plugin/fauxClip.vim -o ~/.vim/plugin/fauxClip.vim
```