aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/copy_linebreak.txt
diff options
context:
space:
mode:
Diffstat (limited to 'vim/doc/copy_linebreak.txt')
-rw-r--r--vim/doc/copy_linebreak.txt57
1 files changed, 44 insertions, 13 deletions
diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt
index 15e4b1b0..7efbad4b 100644
--- a/vim/doc/copy_linebreak.txt
+++ b/vim/doc/copy_linebreak.txt
@@ -1,25 +1,56 @@
-*copy_linebreak.txt* Mapping to toggle copy-paste friendly linebreak options
+*copy_linebreak.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 *copy_linebreak*
This plugin provides mapping targets for a user to set, unset, or toggle
|'linebreak'|-related settings when |'wrap'| is enabled, to switch between
human-readable output and a format friendly for copy-pasting with terminal
emulators or screen/tmux.
-Mappings:
+REQUIREMENTS *copy_linebreak-requirements*
- <Plug>CopyLinebreakEnable
- <Plug>CopyLinebreakDisable
- <Plug>CopyLinebreakToggle
+This plugin is only available if 'compatible' is not set.
-Commands:
+MAPPINGS *copy_linebreak-mappings*
- :CopyLinebreakEnable
- :CopyLinebreakDisable
- :CopyLinebreakToggle
+Mapping targets provided are:
-This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun
+|<Plug>CopyLinebreakEnable|: *<Plug>CopyLinebreakEnable*
+ Enable copy-paste friendly line break options.
+|<Plug>CopyLinebreakDisable|: *<Plug>CopyLinebreakDisable*
+ Revert to human-readable line break options.
+|<Plug>CopyLinebreakToggle|: *<Plug>CopyLinebreakToggle*
+ Toggle between the above two states.
+
+There are no default key mappings to any of these targers; you should define
+them yourself in your |vimrc|. For example:
+>
+ :nmap <Leader>b <Plug>CopyLinebreakToggle
+
+COMMANDS *copy_linebreak-commands*
+
+If the |+user_commands| feature is available, commands provided are:
+>
+`:CopyLinebreakEnable`: *:CopyLinebreakEnable*
+ Enable copy-paste friendly line break options.
+`:CopyLinebreakDisable`: *:CopyLinebreakDisable*
+ Revert to human-readable line break options.
+`:CopyLinebreakToggle`: *:CopyLinebreakToggle*
+ Toggle between the above two states.
+
+AUTHOR *copy_linebreak-author*
+
+Written and maintained by Tom Ryder <tom@sanctum.geek.nz>.
+
+LICENSE *copy_linebreak-license*
+
+Licensed for distribution under the same terms as Vim itself (see |license|).
+
+DISTRIBUTION *copy_linebreak-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: