aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/strip_trailing_whitespace.txt
diff options
context:
space:
mode:
Diffstat (limited to 'vim/doc/strip_trailing_whitespace.txt')
-rw-r--r--vim/doc/strip_trailing_whitespace.txt51
1 files changed, 41 insertions, 10 deletions
diff --git a/vim/doc/strip_trailing_whitespace.txt b/vim/doc/strip_trailing_whitespace.txt
index d50fbfb7..9e2907d4 100644
--- a/vim/doc/strip_trailing_whitespace.txt
+++ b/vim/doc/strip_trailing_whitespace.txt
@@ -1,15 +1,46 @@
-*strip_trailing_whitespace.txt* Strip trailing whitespace from whole buffer
+*strip_trailing_whitespace.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 *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.
+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.
-If also provides a :StripTrailingWhitespace command if you have +user_commands,
-but this is not required.
+REQUIREMENTS *strip_trailing_whitespace-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.
+
+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>.
+
+LICENSE *strip_trailing_whitespace-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+DISTRIBUTION *strip_trailing_whitespace-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: