aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:20:39 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:20:39 +1300
commitab4c81f6082ea9c34dc76119c669fc6821c1780f (patch)
tree5621957c2c1432c13a758635d925eca7a4b0e37f
parent54b493bba73106276b568115b7485c4d5afd84e4 (diff)
downloaddotfiles-ab4c81f6082ea9c34dc76119c669fc6821c1780f.tar.gz
Flesh out fixed_join.vim interface documentation
-rw-r--r--vim/doc/fixed_join.txt35
1 files changed, 27 insertions, 8 deletions
diff --git a/vim/doc/fixed_join.txt b/vim/doc/fixed_join.txt
index 7bfb6c8b..d12985ef 100644
--- a/vim/doc/fixed_join.txt
+++ b/vim/doc/fixed_join.txt
@@ -2,19 +2,38 @@
DESCRIPTION *fixed_join*
-This plugin provides a mapping target <Plug>FixedJoin to create a binding for a
-user to `:join` lines in normal mode without the cursor jumping around. If the
-user's configuration does not specify a mapping to this target by the time this
-plugin is loaded, it will attempt to map 'J' in normal mode to simply replace
-the default functionality.
-
-The plugin also provides a `:FixedJoin` command if you have |+user_commands|, but
-this is not required.
+This plugin provides a mapping target and an optional command to `:join` lines
+in normal mode while keeping the cursor in-place.
REQUIREMENTS *fixed_join-requirements*
This plugin is only available if 'compatible' is not set.
+MAPPINGS *fixed_join-mappings*
+ *<Plug>FixedJoin*
+
+This plugin provides a mapping target |<Plug>FixedJoin| to create a binding
+for a user to `:join` lines in normal mode without the cursor jumping around.
+
+If the user's configuration does not specify a mapping to this target by the
+time this plugin is loaded, it will attempt to map 'J' in normal mode to
+simply replace the default functionality.
+
+COMMANDS *fixed_join-commands*
+ *:FixedJoin*
+
+The plugin also provides a `:FixedJoin` command if Vim has the
+|+user_commands| feature, but this is not required.
+
+ALTERNATIVE *fixed-join-alternative*
+
+If you don't mind clobbering a mark, this whole plugin can be replaced with
+one mapping in your |vimrc|:
+>
+ :nnoremap J mzJ`z
+<
+This was what the author was doing before writing this plugin as an exercise.
+
AUTHOR *fixed_join-author*
Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.