aboutsummaryrefslogtreecommitdiff
path: root/vim/doc/copy_linebreak.txt
blob: 581c6166ed73be1f83a6df51ebba6aff2be6e3ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
*copy_linebreak.txt*	For Vim version 7.0	Last change: 2017 November 12

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.

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>.

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. See <https://sanctum.geek.nz/cgit/dotfiles.git/about/> for more
information.

 vim:tw=78:ts=8:ft=help:norl: