aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2019-06-03 22:46:23 +1200
committerTom Ryder <tom@sanctum.geek.nz>2019-06-03 22:46:23 +1200
commit6c107a31ace12fb2fac9cb41c4aac20d632e67dc (patch)
treeb9b88c146c86d397c0967ebfa183b834036f7241 /doc
parentAdd files as they stand (diff)
downloadvim-keep-position-6c107a31ace12fb2fac9cb41c4aac20d632e67dc.tar.gz
vim-keep-position-6c107a31ace12fb2fac9cb41c4aac20d632e67dc.zip
Add comments and documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/keep_position.txt28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/keep_position.txt b/doc/keep_position.txt
new file mode 100644
index 0000000..6f1d516
--- /dev/null
+++ b/doc/keep_position.txt
@@ -0,0 +1,28 @@
+*keep_position.txt* For Vim version 7.0 Last change: 2019 Jun 3
+
+DESCRIPTION *keep_position*
+
+This tiny plugin provides a command prefix to run commands without moving the
+cursor or window view around. It does this by saving the window view before
+running the command, and then restoring it afterwards.
+
+REQUIREMENTS *keep_position-requirements*
+
+This plugin only loads if 'compatible' is not set. It also requires the
+|+user_commands| feature.
+
+COMMANDS *keep_position-commands*
+
+ *:KeepPosition*
+Run the given command while preserving the cursor position and window view.
+Works rather like |:keepalt| or |:keepjumps|.
+
+AUTHOR *keep_position-author*
+
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+
+LICENSE *keep_position-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+ vim:tw=78:ts=8:ft=help:norl: