What inspired me to write vimux was [tslime.vim](https://github.com/kikijump/tslime.vim), a plugin that lets you send input to tmux. While tslime.vim works well, I felt it wasn't optimized for my primary use case which was having a smaller tmux pane that I would use to run tests or play with a REPL.
@ -21,143 +23,4 @@ Otherwise download the latest [tarball](https://github.com/benmills/vimux/tarbal
## Usage
### RunVimTmuxCommand
Run a system command in a small horizontal split bellow the current pane vim is in. You can optionally pass a second argument to stop vimux from automatically sending a return after the command.
Now, open a clojure file. Let's say your leader is backslash (\). Type \vp, and then type lein repl at the prompt. This opens a tmux split running a REPL. Then, select text or put the cursor on a function and type \vs. This will send it to the REPL and evaluate it. The reason we pass `0` to `RunVimTmuxCommand` is to stop the normal return that is sent to the runner pane and use our own new line so the clojure REPL will evaluate the selected text without adding an extra return. Thanks to @trptcolin for discovering this issue.
## Options
### VimuxHeight
Set the percent height of the runner pane opened by `RunVimTmuxCommand`.
**Default: `"20"`**
```viml
let VimuxHeight = "50"
```
### VimuxOrientation
Set the default position of the runner pane.
**Acceptable Values:**
`"v"` Vertical
`"h"` Horizontal
**Default: `"v"`**
```viml
let VimuxOrientation = "h"
```
### VimuxUseNearestPane
Use nearest pane (not used by vim) if found instead of running split-window. Useful if you always have two panes opened and you want Vimux to use the existing one.
```viml
let VimuxUseNearestPane = 1
```
### VimuxResetSequence
The keys sent to the runner pane before running a command. By default it sends `q` to make sure the pane is not in scroll-mode and `C-u` to clear the line.
**Default: `"q C-u"`
```viml
let VimuxResetSequence = ""
```
The full documentation is available [online](https://raw.github.com/benmills/vimux/master/doc/vimux.txt) and accessible inside vim `:help vimux`