summaryrefslogtreecommitdiff
path: root/plugins/vim-interaction/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc@mcornella.com>2024-08-09 09:44:46 +0200
committerMarc Cornellà <marc@mcornella.com>2024-08-09 09:44:46 +0200
commitefafef8495f030501e0df59ccb76a598bbce3ae1 (patch)
tree561eaba6adf7cd198d0b8d5b3c07dcd724572b72 /plugins/vim-interaction/README.md
parentfccaaf2fc60149baab966acaeae35f55325e6f98 (diff)
downloadzsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.gz
zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.bz2
zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.zip
docs: improve several plugin READMEs and add one for `ssh` plugin
Diffstat (limited to 'plugins/vim-interaction/README.md')
-rw-r--r--plugins/vim-interaction/README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/plugins/vim-interaction/README.md b/plugins/vim-interaction/README.md
index c2b45f1d8..437b48d99 100644
--- a/plugins/vim-interaction/README.md
+++ b/plugins/vim-interaction/README.md
@@ -1,5 +1,13 @@
# Vim Interaction #
+The idea for this script is to give you some decent interaction with a running
+GVim session. Normally you'll be running around your filesystem doing any
+number of amazing things and you'll need to load some files into GVim for
+editing, inspecting, destruction, or other bits of mayhem. This script lets you
+do that.
+
+## Usage
+
The plugin presents a function called `callvim` whose usage is:
usage: callvim [-b cmd] [-a cmd] [file ... fileN]
@@ -9,14 +17,6 @@ The plugin presents a function called `callvim` whose usage is:
file The file to edit
... fileN The other files to add to the argslist
-## Rationale ##
-
-The idea for this script is to give you some decent interaction with a running
-GVim session. Normally you'll be running around your filesystem doing any
-number of amazing things and you'll need to load some files into GVim for
-editing, inspecting, destruction, or other bits of mayhem. This script lets you
-do that.
-
## Aliases ##
There are a few aliases presented as well: