navid.sassan/vim-tmux-runner.vim
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation around VtrSendCommandToRunner

Browse Source 
Fixes #80.

Updates the helpfile and README to include information about the bang
version of `VtrSendCommandToRunner`.
This commit is contained in:
Michael Anhari 2019-06-25 14:21:47 -04:00 committed by Chris Toomey
parent 186643da4c
commit 436b17e62d
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -14,9 +14,11 @@ VtrSendCommandToRunner
```
This command will prompt for a command to run, then send it to the runner pane
for execution. If one doesn't currently exist, a new runner pane will be
created. Subsequent calls to `VtrSendCommandToRunner` will reuse the provided
command.
for execution. Subsequent calls to `VtrSendCommandToRunner` will reuse the
provided command.
If you would like VTR to create a runner pane if one doesn't exist while issuing
a command, a bang version can be used: `VtrSendCommandToRunner!`.
VTR provides configuration options that allow for control over the size and
location of the VTR runner pane. In addition, VTR provides commands to resize,

13
doc/vim-tmux-runner.txt
View File

@ -89,10 +89,15 @@ environments and it is this ability that give VTR its power.
*VtrSendCommandToRunner*
2.1 VtrSendCommandToRunner~
Send a command to the tmux runner pane. This is the primary purpose of VTR. A
new runner pane will be created. A detached pane will be reattached. By
default, the runner will be cleared before sending the provided command, but
this behavior can be disabled with the |VtrClearBeforeSend| setting.
Send a command to the tmux runner pane. This is the primary purpose of VTR.
Before using this command, attaching to a tmux runner pane via VtrOpenRunner
or VtrAttachToPane is required. If you would like VTR to create a runner pane
if it doesn't exist while issuing a command, a bang version can be used:
VtrSendCommandToRunner!.
By default, the runner will be cleared before sending the provided command,
but this behavior can be disabled with the |VtrClearBeforeSend| setting.
The first time this command is called, it will prompt for a command to send to
the runner. The specific prompt text can be configured via the |VtPrompt|