aboutsummaryrefslogtreecommitdiff
path: root/doc/fixed_join.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fixed_join.txt')
-rw-r--r--doc/fixed_join.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/fixed_join.txt b/doc/fixed_join.txt
new file mode 100644
index 0000000..c1fc4dc
--- /dev/null
+++ b/doc/fixed_join.txt
@@ -0,0 +1,45 @@
+*fixed_join.txt* For Vim version 7.0 Last change: 2018 May 30
+
+DESCRIPTION *fixed_join*
+
+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>.
+
+LICENSE *fixed_join-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+ vim:tw=78:ts=8:ft=help:norl: