Permalink
Browse files

Version 0.3.1

* Bug fixes
* Normalized API to `Vimux<command>`
* Added new command to clear pane history
  • Loading branch information...
1 parent 041294b commit ad63f2e979535b16f897c669872d38b3c1f35475 @benmills benmills committed with Jun 21, 2012
Showing with 430 additions and 173 deletions.
  1. +1 −0 .gitignore
  2. +5 −111 README.mkd
  3. +0 −6 doc/tags
  4. +257 −13 doc/vimux.txt
  5. +167 −43 plugin/vimux.vim
View
@@ -0,0 +1 @@
+doc/tags
View
@@ -1,6 +1,8 @@
# vimux
-Easily interact with tmux from vim. This project is still in development, so some features are still missing.
+Easily interact with tmux from vim.
+
+![vimux](https://www.braintreepayments.com/assets-faccd47687/assets/images/blog/vimux3.png)
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.
@@ -17,116 +19,8 @@ Otherwise download the latest [tarball](https://github.com/benmills/vimux/tarbal
## Platform-specific Plugins
* [vimux-ruby-test](https://github.com/pgr0ss/vimux-ruby-test) a set of commands to easily run ruby tests
+* [vimux-cucumber](https://github.com/cloud8421/vimux-cucumber) run Cucumber Features through Vimux
## Usage
-### RunVimTmuxCommand
-Run a system command in a small horizontal split bellow the current pane vim is in.
-
-```viml
-" Run the current file with rspec
-map <Leader>rb :call RunVimTmuxCommand("clear; rspec " . bufname("%"))<CR>
-```
-
-### PromptVimTmuxCommand
-Prompt for a command and run it in a small horizontal split bellow the current pane.
-
-```viml
-" Prompt for a command to run
-map <Leader>rp :PromptVimTmuxCommand<CR>
-```
-
-### RunLastVimTmuxCommand
-Run the last command executed by `RunVimTmuxCommand`
-
-```viml
-" Run last command executed by RunVimTmuxCommand
-map <Leader>rl :RunLastVimTmuxCommand<CR>
-```
-
-### InspectVimTmuxRunner
-Move into the tmux runner pane created by `RunVimTmuxCommand` and enter copy mode (scroll mode).
-
-```viml
-" Inspect runner pane
-map <Leader>ri :InspectVimTmuxRunner<CR>
-```
-
-### CloseVimTmuxPanes
-Close all other tmux panes in the current window.
-
-```viml
-" Close all other tmux panes in current window
-map <Leader>rx :CloseVimTmuxPanes<CR>
-```
-
-### InterruptVimTmuxRunner
-Interrupt any command that is running inside the runner pane.
-
-```viml
-" Interrupt any command running in the runner pane
-map <Leader>rs :InterruptVimTmuxRunner<CR>
-```
-
-### Full Keybind Example
-
-```viml
-" Run the current file with rspec
-map <Leader>rb :call RunVimTmuxCommand("clear; rspec " . bufname("%"))<CR>
-
-" Prompt for a command to run
-map <Leader>rp :PromptVimTmuxCommand<CR>
-
-" Run last command executed by RunVimTmuxCommand
-map <Leader>rl :RunLastVimTmuxCommand<CR>
-
-" Inspect runner pane
-map <Leader>ri :InspectVimTmuxRunner<CR>
-
-" Close all other tmux panes in current window
-map <Leader>rx :CloseVimTmuxPanes<CR>
-
-" Interrupt any command running in the runner pane
-map <Leader>rs :InterruptVimTmuxRunner<CR>
-```
-
-### tslime replacement
-
-Here is how to use vimux to send code to a REPL. This is similar to tslime. First, add some helpful mappings.
-
-```viml
-
-" Prompt for a command to run
-map <LocalLeader>vp :PromptVimTmuxCommand<CR>
-
-" If text is selected, save it in the v buffer and send that buffer it to tmux
-vmap <LocalLeader>vs "vy :call RunVimTmuxCommand(@v)<CR>
-
-" Select current paragraph and send it to tmux
-nmap <LocalLeader>vs vip<LocalLeader>vs<CR>
-```
-
-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.
-
-## 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"
-```
+The full documentation is available [online](https://raw.github.com/benmills/vimux/master/doc/vimux.txt) and accessible inside vim `:help vimux`
View
@@ -1,6 +0,0 @@
-VimuxConfiguration vimux.txt /*VimuxConfiguration*
-VimuxConfiguration_height vimux.txt /*VimuxConfiguration_height*
-VimuxConfiguration_oriengation vimux.txt /*VimuxConfiguration_oriengation*
-VimuxUsage vimux.txt /*VimuxUsage*
-vimux-contents vimux.txt /*vimux-contents*
-vimux.txt vimux.txt /*vimux.txt*
Oops, something went wrong.

0 comments on commit ad63f2e

Please sign in to comment.