aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:19:33 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-12 23:19:33 +1300
commit3d5021d659d2864e484fe03f35d52adf2cb0c98b (patch)
tree809f4fb7d6efd1a271079aff89e67b74aa9e05a5
parentRemove nonexistent keyword references from Vim doc (diff)
downloaddotfiles-3d5021d659d2864e484fe03f35d52adf2cb0c98b.tar.gz
dotfiles-3d5021d659d2864e484fe03f35d52adf2cb0c98b.zip
Flesh out copy_linebreak.vim interface docs
-rw-r--r--vim/doc/copy_linebreak.txt39
1 files changed, 27 insertions, 12 deletions
diff --git a/vim/doc/copy_linebreak.txt b/vim/doc/copy_linebreak.txt
index f9aacfb4..7efbad4b 100644
--- a/vim/doc/copy_linebreak.txt
+++ b/vim/doc/copy_linebreak.txt
@@ -7,22 +7,37 @@ This plugin provides mapping targets for a user to set, unset, or toggle
human-readable output and a format friendly for copy-pasting with terminal
emulators or screen/tmux.
-Mappings:
->
- <Plug>CopyLinebreakEnable
- <Plug>CopyLinebreakDisable
- <Plug>CopyLinebreakToggle
-<
-Commands:
->
- :CopyLinebreakEnable
- :CopyLinebreakDisable
- :CopyLinebreakToggle
-
REQUIREMENTS *copy_linebreak-requirements*
This plugin is only available if 'compatible' is not set.
+MAPPINGS *copy_linebreak-mappings*
+
+Mapping targets provided are:
+
+|<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>.