aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:21:50 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:21:50 +1300
commitfe513487fbf20772641b45ba0ff9ddc0a586d296 (patch)
tree978aa37d70fc7031c22df1e02a1262a3aa951d62
parentSpecify type of example in mail_mutt.vim doc (diff)
downloaddotfiles-fe513487fbf20772641b45ba0ff9ddc0a586d296.tar.gz
dotfiles-fe513487fbf20772641b45ba0ff9ddc0a586d296.zip
Flesh out strip_trailing_whitespace.vim help
-rw-r--r--vim/doc/strip_trailing_whitespace.txt27
1 files changed, 21 insertions, 6 deletions
diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt
index f7ea1a95..9e2907d4 100644
--- a/vim/doc/strip_trailing_whitespace.txt
+++ b/vim/doc/strip_trailing_whitespace.txt
@@ -2,17 +2,32 @@
DESCRIPTION *strip_trailing_whitespace*
-This plugin is the author's approach to stripping trailing whitespace from an
-entire buffer, including empty lines at the end, without making command noise
-and without moving the cursor from its current position.
-
-If also provides a :StripTrailingWhitespace command if you have +user_commands,
-but this is not required.
+This plugin provides a mapping target and an optional custom command with the
+author's approach to stripping trailing whitespace from an entire buffer,
+including removing empty or whitespace-only lines at the end of the buffer,
+without making command noise and without moving the cursor from its current
+position.
REQUIREMENTS *strip_trailing_whitespace-requirements*
This plugin is only available if 'compatible' is not set.
+COMMANDS *strip_trailing_whitespace-commands*
+
+ *:StripTrailingWhitespace*
+The plugin provides a single `:StripTrailingWhitespace` command if Vim has the
+|+user_commands| feature, but this is not required. It operates on the entire
+buffer, and accepts neither a range nor arguments.
+
+MAPPINGS *strip_trailing_whitespace-mappings*
+
+ *<Plug>StripTrailingWhitespace*
+The single mapping target provided is |<Plug>StripTrailingWhitespace|,
+mappable in any mode. There is no default key mapping to the target; you
+should define this yourself in your |vimrc|. For example:
+>
+ :nmap <Leader>x <Plug>StripTrailingWhitespace>
+
AUTHOR *strip_trailing_whitespace-author*
Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.