aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/fixed_join.txt
diff options
context:
space:
mode:
Diffstat (limited to 'vim/doc/fixed_join.txt')
-rw-r--r--vim/doc/fixed_join.txt56
1 files changed, 47 insertions, 9 deletions
diff --git a/vim/doc/fixed_join.txt b/vim/doc/fixed_join.txt
index df0df251..d12985ef 100644
--- a/vim/doc/fixed_join.txt
+++ b/vim/doc/fixed_join.txt
@@ -1,14 +1,52 @@
-*fixed_join.txt* Join lines in normal mode without moving cursor
+*fixed_join.txt* For Vim version 7.0 Last change: 2017 November 12
-Author: Tom Ryder <tom@sanctum.geek.nz>
-License: Same terms as Vim itself (see |license|)
+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.
+This plugin provides a mapping target and an optional command to `:join` lines
+in normal mode while keeping the cursor in-place.
-If also provides a :FixedJoin command if you have +user_commands, but this is
-not required.
+REQUIREMENTS *fixed_join-requirements*
-This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+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|).
+
+DISTRIBUTION *fixed_join-distribution*
+
+This plugin lives in Tom Ryder's "dotfiles" suite, and may eventually be spun
off into a separate distribution as it solidifies and this documentation
-improves.
+improves. See <https://sanctum.geek.nz/cgit/dotfiles.git/about/> for more
+information.
+
+ vim:tw=78:ts=8:ft=help:norl: