]> git.wincent.com - docvim.git/blob - tests/fixtures/integration/scalpel/golden/plaintext.golden
Add Vim help integration tests
[docvim.git] / tests / fixtures / integration / scalpel / golden / plaintext.golden
1 *scalpel.txt*    Scalpel plug-in for Vim      *scalpel*
2
3 CONTENTS                                                      *scalpel-contents*
4
5 1. Intro            |scalpel-intro|
6 2. Installation     |scalpel-installation|
7 3. Website          |scalpel-website|
8 4. License          |scalpel-license|
9 5. Development      |scalpel-development|
10 6. Authors          |scalpel-authors|
11 7. History          |scalpel-history|
12
13 INTRO                                                            *scalpel-intro*
14
15 Scalpel provides a streamlined shortcut for replacing all instances of the
16 word currently under the cursor throughout a file.
17
18 In normal mode pressing `<Leader>e` (mnemonic: "edit") will display a prompt
19 pre-populated with the current word and with the cursor placed so that you
20 can start typing the desired replacement:
21 >
22     :Scalpel/\v<foo>//
23 <
24 Press `<Enter>` and Scalpel will prompt to confirm each substitution, starting
25 at the current word (unlike a normal `:%s` command, which starts at the top of
26 the file).
27
28 Scalpel works similarly in visual mode, except that it scopes itself to the
29 current visual selection rather than operating over the entire file.
30
31 Note that `:Scalpel` just calls through to an underlying `scalpel#substitute`
32 function that does the real work, ultimately calling Vim's own `:substitute`.
33 As such, be aware that whatever changes you make to the command-line prior
34 to pressing `<Enter>` must keep it a valid pattern, or bad things will happen.
35
36 The mapping can be suppressed by setting:
37 >
38     let g:ScalpelMap=0
39 <
40 Or overridden:
41 >
42     " Use <Leader>s instead of default <Leader>e:
43     nmap <Leader>s <Plug>(Scalpel)
44 <
45 In any case, Scalpel won't overwrite any pre-existing mapping that you might
46 have defined for `<Leader>e`, nor will it create an unnecessary redundant
47 mapping if you've already mapped something to `<Plug>(Scalpel)`.
48
49 The `:Scalpel` command name can be overridden if desired. For example, you
50 could shorten it to `:S` with:
51 >
52     let g:ScalpelCommand='S'
53 <
54 Then your Scalpel prompt would look like:
55 >
56     :S/\v<foo>//
57 <
58 The command can be entirely suppressed by setting `g:ScalpelCommand` to an
59 empty string:
60 >
61     let g:ScalpelCommand=''
62 <
63 Finally, all plug-in functionality can be deactivated by setting:
64 >
65     let g:ScalpelLoaded=1
66 <
67 in your `~/.vimrc`.
68
69 INSTALLATION                                              *scalpel-installation*
70
71 To install Scalpel, use your plug-in management system of choice.
72
73 If you don't have a "plug-in management system of choice" and your version
74 of Vim has `packages` support (ie. `+packages` appears in the output of
75 `:version`) then you can simply place the plugin at a location under your
76 `'packpath'` (eg. `~/.vim/pack/bundle/start/scalpel` or similar).
77
78 For older versions of Vim, I recommend
79 [Pathogen](https://github.com/tpope/vim-pathogen) due to its simplicity and
80 robustness. Assuming that you have Pathogen installed and configured, and
81 that you want to install Scalpel into `~/.vim/bundle`, you can do so with:
82 >
83     git clone https://github.com/wincent/scalpel.git ~/.vim/bundle/scalpel
84 <
85 Alternatively, if you use a Git submodule for each Vim plug-in, you could do
86 the following after `cd`-ing into the top-level of your Git superproject:
87 >
88     git submodule add https://github.com/wincent/scalpel.git ~/vim/bundle/scalpel
89     git submodule init
90 <
91 To generate help tags under Pathogen, you can do so from inside Vim with:
92 >
93     :call pathogen#helptags()
94 <
95 WEBSITE                                                        *scalpel-website*
96
97 The official Scalpel source code repo is at:
98
99 http://git.wincent.com/scalpel.git
100
101 Mirrors exist at:
102
103 - https://github.com/wincent/scalpel
104 - https://gitlab.com/wincent/scalpel
105 - https://bitbucket.org/ghurrell/scalpel
106
107 Official releases are listed at:
108
109 http://www.vim.org/scripts/script.php?script_id=5381
110
111 LICENSE                                                        *scalpel-license*
112
113 Copyright (c) 2016-present Greg Hurrell
114
115 Permission is hereby granted, free of charge, to any person obtaining a copy
116 of this software and associated documentation files (the "Software"), to
117 deal in the Software without restriction, including without limitation the
118 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
119 sell copies of the Software, and to permit persons to whom the Software is
120 furnished to do so, subject to the following conditions:
121
122 The above copyright notice and this permission notice shall be included in
123 all copies or substantial portions of the Software.
124
125 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
126 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
127 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
128 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
129 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
130 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
131 IN THE SOFTWARE.
132
133 DEVELOPMENT                                                *scalpel-development*
134
135 Contributing patches ~
136
137 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests
138 at: https://github.com/wincent/scalpel/pulls
139
140 Cutting a new release ~
141
142 At the moment the release process is manual:
143
144 - Perform final sanity checks and manual testing.
145 - Update the [scalpel-history](#user-content-scalpel-history) section of the
146   documentation.
147 - Regenerate the documentation:
148 >
149     docvim README.md doc/scalpel.txt
150 <
151 - Verify clean work tree:
152 >
153     git status
154 <
155 - Tag the release:
156 >
157     git tag -s -m "$VERSION release" $VERSION
158 <
159 - Publish the code:
160 >
161     git push origin master --follow-tags
162     git push github master --follow-tags
163 <
164 - Produce the release archive:
165 >
166     git archive -o scalpel-$VERSION.zip HEAD -- .
167 <
168 - Upload to http://www.vim.org/scripts/script.php?script_id=5381
169
170 AUTHORS                                                        *scalpel-authors*
171
172 Scalpel is written and maintained by Greg Hurrell <greg@hurrell.net>.
173
174 HISTORY                                                        *scalpel-history*
175
176 0.2 (not yet released) ~
177
178 - Support visual mode.
179
180 0.1 (29 April 2016) ~
181
182 - Initial release.