diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:57:39 +1300 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2017-11-04 17:59:54 +1300 |
commit | dae845727dbb3a7f91137d85d322ee475d604289 (patch) | |
tree | 4fe5abe81f0ce3087dc38ec69a9cad36222b840a /vim/doc/copy_linebreak.txt | |
parent | Use same comment boilerplate for custom plugins (diff) | |
download | dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.tar.gz dotfiles-dae845727dbb3a7f91137d85d322ee475d604289.zip |
Add short documentation for new custom plugins
I'm using the plugin_name.txt syntax suggested by the Vim documentation.
That may change in future as I study plugins written by experienced
authors like Tim Pope.
There will almost certainly be a lot more detail to add to each of
these.
Diffstat (limited to 'vim/doc/copy_linebreak.txt')
-rw-r--r-- | vim/doc/copy_linebreak.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt new file mode 100644 index 00000000..c8463386 --- /dev/null +++ b/vim/doc/copy_linebreak.txt @@ -0,0 +1,13 @@ +*copy_linebreak.txt* Mapping to toggle copy-paste friendly linebreak options + +Author: Tom Ryder <tom@sanctum.geek.nz> +License: Same terms as Vim itself (see |license|) + +This plugin provides a mapping target <Plug>CopyLinebreak to create a binding +for a user to quickly 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. + +This plugin lives in Tom Ryder's "dotfiles" suite, and will eventually be spun +off into a separate distribution as it solidifies and this documentation +improves. |