blob: 2d51953714cba8554a01180a5a1a9273ddbab4d1 [file] [log] [blame]
Bram Moolenaarf84b1222017-06-10 14:29:52 +02001*repeat.txt* For Vim version 8.0. Last change: 2017 Jun 10
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Repeating commands, Vim scripts and debugging *repeating*
8
9Chapter 26 of the user manual introduces repeating |usr_26.txt|.
10
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100111. Single repeats |single-repeat|
122. Multiple repeats |multi-repeat|
133. Complex repeats |complex-repeat|
144. Using Vim scripts |using-scripts|
155. Using Vim packages |packages|
166. Creating Vim packages |package-create|
177. Debugging scripts |debug-scripts|
188. Profiling |profiling|
Bram Moolenaar071d4272004-06-13 20:20:40 +000019
20==============================================================================
211. Single repeats *single-repeat*
22
23 *.*
24. Repeat last change, with count replaced with [count].
25 Also repeat a yank command, when the 'y' flag is
Bram Moolenaard4755bb2004-09-02 19:12:26 +000026 included in 'cpoptions'. Does not repeat a
27 command-line command.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
29Simple changes can be repeated with the "." command. Without a count, the
30count of the last change is used. If you enter a count, it will replace the
Bram Moolenaar92dff182014-02-11 19:15:50 +010031last one. |v:count| and |v:count1| will be set.
32
33If the last change included a specification of a numbered register, the
34register number will be incremented. See |redo-register| for an example how
35to use this.
36
37Note that when repeating a command that used a Visual selection, the same SIZE
38of area is used, see |visual-repeat|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
40 *@:*
41@: Repeat last command-line [count] times.
42 {not available when compiled without the
43 |+cmdline_hist| feature}
44
45
46==============================================================================
472. Multiple repeats *multi-repeat*
48
Bram Moolenaarf84b1222017-06-10 14:29:52 +020049 *:g* *:global* *E148*
Bram Moolenaar071d4272004-06-13 20:20:40 +000050:[range]g[lobal]/{pattern}/[cmd]
51 Execute the Ex command [cmd] (default ":p") on the
52 lines within [range] where {pattern} matches.
53
54:[range]g[lobal]!/{pattern}/[cmd]
55 Execute the Ex command [cmd] (default ":p") on the
56 lines within [range] where {pattern} does NOT match.
57
58 *:v* *:vglobal*
59:[range]v[global]/{pattern}/[cmd]
60 Same as :g!.
61
Bram Moolenaarc81e5e72007-05-05 18:24:42 +000062Instead of the '/' which surrounds the {pattern}, you can use any other
Bram Moolenaare2db6952013-07-24 19:53:36 +020063single byte character, but not an alphabetic character, '\', '"' or '|'.
Bram Moolenaarc81e5e72007-05-05 18:24:42 +000064This is useful if you want to include a '/' in the search pattern or
65replacement string.
66
67For the definition of a pattern, see |pattern|.
68
Bram Moolenaar32efaf62014-11-05 17:02:17 +010069NOTE [cmd] may contain a range; see |collapse| and |edit-paragraph-join| for
70examples.
71
Bram Moolenaar071d4272004-06-13 20:20:40 +000072The global commands work by first scanning through the [range] lines and
73marking each line where a match occurs (for a multi-line pattern, only the
74start of the match matters).
Bram Moolenaar03413f42016-04-12 21:07:15 +020075In a second scan the [cmd] is executed for each marked line, as if the cursor
76was in that line. For ":v" and ":g!" the command is executed for each not
Bram Moolenaar071d4272004-06-13 20:20:40 +000077marked line. If a line is deleted its mark disappears.
78The default for [range] is the whole buffer (1,$). Use "CTRL-C" to interrupt
79the command. If an error message is given for a line, the command for that
80line is aborted and the global command continues with the next marked or
81unmarked line.
Bram Moolenaarf84b1222017-06-10 14:29:52 +020082 *E147*
83When the command is used recursively, it only works on one line. Giving a
84range is then not allowed. This is useful to find all lines that match a
85pattern and do not match another pattern: >
86 :g/found/v/notfound/{cmd}
87This first finds all lines containing "found", but only executes {cmd} when
88there is no match for "notfound".
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
Bram Moolenaarf84b1222017-06-10 14:29:52 +020090To execute a non-Ex command, you can use the `:normal` command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 :g/pat/normal {commands}
92Make sure that {commands} ends with a whole command, otherwise Vim will wait
93for you to type the rest of the command for each match. The screen will not
94have been updated, so you don't know what you are doing. See |:normal|.
95
96The undo/redo command will undo/redo the whole global command at once.
97The previous context mark will only be set once (with "''" you go back to
98where the cursor was before the global command).
99
100The global command sets both the last used search pattern and the last used
101substitute pattern (this is vi compatible). This makes it easy to globally
102replace a string:
103 :g/pat/s//PAT/g
104This replaces all occurrences of "pat" with "PAT". The same can be done with:
105 :%s/pat/PAT/g
106Which is two characters shorter!
107
Bram Moolenaar864207d2008-06-24 22:14:38 +0000108When using "global" in Ex mode, a special case is using ":visual" as a
109command. This will move to a matching line, go to Normal mode to let you
110execute commands there until you use |Q| to return to Ex mode. This will be
111repeated for each matching line. While doing this you cannot use ":global".
112To abort this type CTRL-C twice.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000113
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114==============================================================================
1153. Complex repeats *complex-repeat*
116
117 *q* *recording*
118q{0-9a-zA-Z"} Record typed characters into register {0-9a-zA-Z"}
119 (uppercase to append). The 'q' command is disabled
120 while executing a register, and it doesn't work inside
Bram Moolenaara0ed84a2015-11-19 17:56:13 +0100121 a mapping and |:normal|.
122
123 Note: If the register being used for recording is also
124 used for |y| and |p| the result is most likely not
125 what is expected, because the put will paste the
126 recorded macro and the yank will overwrite the
127 recorded macro. {Vi: no recording}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128
129q Stops recording. (Implementation note: The 'q' that
130 stops recording is not stored in the register, unless
131 it was the result of a mapping) {Vi: no recording}
132
133 *@*
Bram Moolenaar61d35bd2012-03-28 20:51:51 +0200134@{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135 times. Note that register '%' (name of the current
136 file) and '#' (name of the alternate file) cannot be
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +0100137 used.
138 The register is executed like a mapping, that means
139 that the difference between 'wildchar' and 'wildcharm'
140 applies.
141 For "@=" you are prompted to enter an expression. The
142 result of the expression is then executed.
143 See also |@:|. {Vi: only named registers}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000145 *@@* *E748*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146@@ Repeat the previous @{0-9a-z":*} [count] times.
147
Bram Moolenaar61d35bd2012-03-28 20:51:51 +0200148:[addr]*{0-9a-z".=+} *:@* *:star*
149:[addr]@{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} as an Ex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150 command. First set cursor at line [addr] (default is
151 current line). When the last line in the register does
152 not have a <CR> it will be added automatically when
153 the 'e' flag is present in 'cpoptions'.
154 Note that the ":*" command is only recognized when the
155 '*' flag is present in 'cpoptions'. This is NOT the
156 default when 'nocompatible' is used.
157 For ":@=" the last used expression is used. The
158 result of evaluating the expression is executed as an
159 Ex command.
160 Mappings are not recognized in these commands.
161 {Vi: only in some versions} Future: Will execute the
162 register for each line in the address range.
163
164 *:@:*
165:[addr]@: Repeat last command-line. First set cursor at line
166 [addr] (default is current line). {not in Vi}
167
Bram Moolenaar7e1479b2016-09-11 15:07:27 +0200168:[addr]@ *:@@*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169:[addr]@@ Repeat the previous :@{0-9a-z"}. First set cursor at
170 line [addr] (default is current line). {Vi: only in
171 some versions}
172
173==============================================================================
1744. Using Vim scripts *using-scripts*
175
176For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
177
178 *:so* *:source* *load-vim-script*
179:so[urce] {file} Read Ex commands from {file}. These are commands that
180 start with a ":".
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000181 Triggers the |SourcePre| autocommand.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182
183:so[urce]! {file} Read Vim commands from {file}. These are commands
184 that are executed from Normal mode, like you type
185 them.
186 When used after |:global|, |:argdo|, |:windo|,
187 |:bufdo|, in a loop or when another command follows
188 the display won't be updated while executing the
189 commands.
190 {not in Vi}
191
192 *:ru* *:runtime*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100193:ru[ntime][!] [where] {file} ..
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 Read Ex commands from {file} in each directory given
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100195 by 'runtimepath' and/or 'packpath'. There is no error
196 for non-existing files.
197
198 Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199 :runtime syntax/c.vim
200
201< There can be multiple {file} arguments, separated by
202 spaces. Each {file} is searched for in the first
203 directory from 'runtimepath', then in the second
204 directory, etc. Use a backslash to include a space
205 inside {file} (although it's better not to use spaces
206 in file names, it causes trouble).
207
208 When [!] is included, all found files are sourced.
209 When it is not included only the first found file is
210 sourced.
211
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100212 When [where] is omitted only 'runtimepath' is used.
213 Other values:
214 START search under "start" in 'packpath'
215 OPT search under "opt" in 'packpath'
216 PACK search under "start" and "opt" in
217 'packpath'
218 ALL first use 'runtimepath', then search
219 under "start" and "opt" in 'packpath'
220
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 When {file} contains wildcards it is expanded to all
222 matching files. Example: >
223 :runtime! plugin/*.vim
224< This is what Vim uses to load the plugin files when
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000225 starting up. This similar command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226 :runtime plugin/*.vim
227< would source the first file only.
228
229 When 'verbose' is one or higher, there is a message
230 when no file could be found.
231 When 'verbose' is two or higher, there is a message
232 about each searched file.
233 {not in Vi}
234
Bram Moolenaarbe82c252016-03-06 14:44:08 +0100235 *:pa* *:packadd* *E919*
Bram Moolenaar328da0d2016-03-04 22:22:32 +0100236:pa[ckadd][!] {name} Search for an optional plugin directory in 'packpath'
237 and source any plugin files found. The directory must
238 match:
239 pack/*/opt/{name} ~
240 The directory is added to 'runtimepath' if it wasn't
241 there yet.
Bram Moolenaar26852122016-05-24 20:02:38 +0200242 If the directory pack/*/opt/{name}/after exists it is
243 added at the end of 'runtimepath'.
Bram Moolenaardae8d212016-02-27 22:40:16 +0100244
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100245 Note that {name} is the directory name, not the name
Bram Moolenaar03413f42016-04-12 21:07:15 +0200246 of the .vim file. All the files matching the pattern
247 pack/*/opt/{name}/plugin/**/*.vim ~
248 will be sourced. This allows for using subdirectories
249 below "plugin", just like with plugins in
250 'runtimepath'.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100251
Bram Moolenaar328da0d2016-03-04 22:22:32 +0100252 If the filetype detection was not enabled yet (this
253 is usually done with a "syntax enable" or "filetype
254 on" command in your .vimrc file), this will also look
255 for "{name}/ftdetect/*.vim" files.
256
257 When the optional ! is added no plugin files or
258 ftdetect scripts are loaded, only the matching
259 directories are added to 'runtimepath'. This is
260 useful in your .vimrc. The plugins will then be
261 loaded during initialization, see |load-plugins|.
262
263 Also see |pack-add|.
264
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100265 *:packl* *:packloadall*
Bram Moolenaar03413f42016-04-12 21:07:15 +0200266:packl[oadall][!] Load all packages in the "start" directory under each
267 entry in 'packpath'.
268
269 First all the directories found are added to
270 'runtimepath', then the plugins found in the
271 directories are sourced. This allows for a plugin to
272 depend on something of another plugin, e.g. an
273 "autoload" directory. See |packload-two-steps| for
274 how this can be useful.
275
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100276 This is normally done automatically during startup,
277 after loading your .vimrc file. With this command it
278 can be done earlier.
Bram Moolenaar03413f42016-04-12 21:07:15 +0200279
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100280 Packages will be loaded only once. After this command
281 it won't happen again. When the optional ! is added
282 this command will load packages even when done before.
Bram Moolenaar03413f42016-04-12 21:07:15 +0200283
Bram Moolenaar7db8f6f2016-03-29 23:12:46 +0200284 An error only causes sourcing the script where it
Bram Moolenaare18c0b32016-03-20 21:08:34 +0100285 happens to be aborted, further plugins will be loaded.
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100286 See |packages|.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100287
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288:scripte[ncoding] [encoding] *:scripte* *:scriptencoding* *E167*
289 Specify the character encoding used in the script.
290 The following lines will be converted from [encoding]
291 to the value of the 'encoding' option, if they are
292 different. Examples: >
293 scriptencoding iso-8859-5
294 scriptencoding cp932
295<
296 When [encoding] is empty, no conversion is done. This
297 can be used to restrict conversion to a sequence of
298 lines: >
299 scriptencoding euc-jp
300 ... lines to be converted ...
301 scriptencoding
302 ... not converted ...
303
304< When conversion isn't supported by the system, there
Bram Moolenaar6f1d9a02016-07-24 14:12:38 +0200305 is no error message and no conversion is done. When a
306 line can't be converted there is no error and the
307 original line is kept.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
309 Don't use "ucs-2" or "ucs-4", scripts cannot be in
310 these encodings (they would contain NUL bytes).
311 When a sourced script starts with a BOM (Byte Order
Bram Moolenaar06b5d512010-05-22 15:37:44 +0200312 Mark) in utf-8 format Vim will recognize it, no need
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313 to use ":scriptencoding utf-8" then.
314
Bram Moolenaar3df01732017-02-17 22:47:16 +0100315 If you set the 'encoding' option in your |.vimrc|,
316 `:scriptencoding` must be placed after that. E.g.: >
317 set encoding=utf-8
318 scriptencoding utf-8
319<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 When compiled without the |+multi_byte| feature this
321 command is ignored.
322 {not in Vi}
323
Bram Moolenaar8feef4f2015-01-07 16:57:10 +0100324 *:scr* *:scriptnames*
325:scr[iptnames] List all sourced script names, in the order they were
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 first sourced. The number is used for the script ID
327 |<SID>|.
328 {not in Vi} {not available when compiled without the
329 |+eval| feature}
330
331 *:fini* *:finish* *E168*
332:fini[sh] Stop sourcing a script. Can only be used in a Vim
333 script file. This is a quick way to skip the rest of
334 the file. If it is used after a |:try| but before the
335 matching |:finally| (if present), the commands
336 following the ":finally" up to the matching |:endtry|
337 are executed first. This process applies to all
338 nested ":try"s in the script. The outermost ":endtry"
339 then stops sourcing the script. {not in Vi}
340
341All commands and command sequences can be repeated by putting them in a named
342register and then executing it. There are two ways to get the commands in the
343register:
344- Use the record command "q". You type the commands once, and while they are
345 being executed they are stored in a register. Easy, because you can see
346 what you are doing. If you make a mistake, "p"ut the register into the
347 file, edit the command sequence, and then delete it into the register
348 again. You can continue recording by appending to the register (use an
349 uppercase letter).
350- Delete or yank the command sequence into the register.
351
352Often used command sequences can be put under a function key with the ':map'
353command.
354
355An alternative is to put the commands in a file, and execute them with the
356':source!' command. Useful for long command sequences. Can be combined with
357the ':map' command to put complicated commands under a function key.
358
359The ':source' command reads Ex commands from a file line by line. You will
360have to type any needed keyboard input. The ':source!' command reads from a
361script file character by character, interpreting each character as if you
362typed it.
363
364Example: When you give the ":!ls" command you get the |hit-enter| prompt. If
365you ':source' a file with the line "!ls" in it, you will have to type the
366<Enter> yourself. But if you ':source!' a file with the line ":!ls" in it,
367the next characters from that file are read until a <CR> is found. You will
368not have to type <CR> yourself, unless ":!ls" was the last line in the file.
369
370It is possible to put ':source[!]' commands in the script file, so you can
371make a top-down hierarchy of script files. The ':source' command can be
372nested as deep as the number of files that can be opened at one time (about
37315). The ':source!' command can be nested up to 15 levels deep.
374
375You can use the "<sfile>" string (literally, this is not a special key) inside
376of the sourced file, in places where a file name is expected. It will be
377replaced by the file name of the sourced file. For example, if you have a
378"other.vimrc" file in the same directory as your ".vimrc" file, you can source
379it from your ".vimrc" file with this command: >
380 :source <sfile>:h/other.vimrc
381
382In script files terminal-dependent key codes are represented by
383terminal-independent two character codes. This means that they can be used
384in the same way on different kinds of terminals. The first character of a
385key code is 0x80 or 128, shown on the screen as "~@". The second one can be
386found in the list |key-notation|. Any of these codes can also be entered
387with CTRL-V followed by the three digit decimal code. This does NOT work for
388the <t_xx> termcap codes, these can only be used in mappings.
389
390 *:source_crnl* *W15*
391MS-DOS, Win32 and OS/2: Files that are read with ":source" normally have
392<CR><NL> <EOL>s. These always work. If you are using a file with <NL> <EOL>s
393(for example, a file made on Unix), this will be recognized if 'fileformats'
394is not empty and the first line does not end in a <CR>. This fails if the
395first line has something like ":map <F1> :help^M", where "^M" is a <CR>. If
396the first line ends in a <CR>, but following ones don't, you will get an error
397message, because the <CR> from the first lines will be lost.
398
Bram Moolenaar520470a2005-06-16 21:59:56 +0000399Mac Classic: Files that are read with ":source" normally have <CR> <EOL>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400These always work. If you are using a file with <NL> <EOL>s (for example, a
401file made on Unix), this will be recognized if 'fileformats' is not empty and
402the first line does not end in a <CR>. Be careful not to use a file with <NL>
403linebreaks which has a <CR> in first line.
404
405On other systems, Vim expects ":source"ed files to end in a <NL>. These
406always work. If you are using a file with <CR><NL> <EOL>s (for example, a
407file made on MS-DOS), all lines will have a trailing <CR>. This may cause
408problems for some commands (e.g., mappings). There is no automatic <EOL>
409detection, because it's common to start with a line that defines a mapping
410that ends in a <CR>, which will confuse the automaton.
411
412 *line-continuation*
413Long lines in a ":source"d Ex command script file can be split by inserting
414a line continuation symbol "\" (backslash) at the start of the next line.
415There can be white space before the backslash, which is ignored.
416
417Example: the lines >
418 :set comments=sr:/*,mb:*,el:*/,
419 \://,
420 \b:#,
421 \:%,
422 \n:>,
423 \fb:-
424are interpreted as if they were given in one line:
425 :set comments=sr:/*,mb:*,el:*/,://,b:#,:%,n:>,fb:-
426
427All leading whitespace characters in the line before a backslash are ignored.
428Note however that trailing whitespace in the line before it cannot be
429inserted freely; it depends on the position where a command is split up
430whether additional whitespace is allowed or not.
431
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100432When a space is required it's best to put it right after the backslash. A
433space at the end of a line is hard to see and may be accidentally deleted. >
434 :syn match Comment
435 \ "very long regexp"
436 \ keepend
437
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438There is a problem with the ":append" and ":insert" commands: >
439 :1append
440 \asdf
441 .
442The backslash is seen as a line-continuation symbol, thus this results in the
443command: >
444 :1appendasdf
445 .
446To avoid this, add the 'C' flag to the 'cpoptions' option: >
447 :set cpo+=C
448 :1append
449 \asdf
450 .
451 :set cpo-=C
452
453Note that when the commands are inside a function, you need to add the 'C'
454flag when defining the function, it is not relevant when executing it. >
455 :set cpo+=C
456 :function Foo()
457 :1append
458 \asdf
459 .
460 :endfunction
461 :set cpo-=C
462
463Rationale:
464 Most programs work with a trailing backslash to indicate line
465 continuation. Using this in Vim would cause incompatibility with Vi.
466 For example for this Vi mapping: >
467 :map xx asdf\
468< Therefore the unusual leading backslash is used.
469
470==============================================================================
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01004715. Using Vim packages *packages*
472
473A Vim package is a directory that contains one or more plugins. The
474advantages over normal plugins:
475- A package can be downloaded as an archive and unpacked in its own directory.
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100476 Thus the files are not mixed with files of other plugins. That makes it
477 easy to update and remove.
Bram Moolenaar91715872016-03-03 17:13:03 +0100478- A package can be a git, mercurial, etc. repository. That makes it really
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100479 easy to update.
480- A package can contain multiple plugins that depend on each other.
481- A package can contain plugins that are automatically loaded on startup and
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100482 ones that are only loaded when needed with `:packadd`.
483
484
485Using a package and loading automatically ~
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100486
487Let's assume your Vim files are in the "~/.vim" directory and you want to add a
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100488package from a zip archive "/tmp/foopack.zip":
489 % mkdir -p ~/.vim/pack/foo
490 % cd ~/.vim/pack/foo
491 % unzip /tmp/foopack.zip
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100492
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100493The directory name "foo" is arbitrary, you can pick anything you like.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100494
495You would now have these files under ~/.vim:
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100496 pack/foo/README.txt
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +0100497 pack/foo/start/foobar/plugin/foo.vim
498 pack/foo/start/foobar/syntax/some.vim
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100499 pack/foo/opt/foodebug/plugin/debugger.vim
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100500
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100501When Vim starts up, after processing your .vimrc, it scans all directories in
Bram Moolenaar03413f42016-04-12 21:07:15 +0200502'packpath' for plugins under the "pack/*/start" directory. First all those
503directories are added to 'runtimepath'. Then all the plugins are loaded.
504See |packload-two-steps| for how these two steps can be useful.
Bram Moolenaarf3654822016-03-04 22:12:23 +0100505
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +0100506In the example Vim will find "pack/foo/start/foobar/plugin/foo.vim" and adds
507"~/.vim/pack/foo/start/foobar" to 'runtimepath'.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100508
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100509If the "foobar" plugin kicks in and sets the 'filetype' to "some", Vim will
510find the syntax/some.vim file, because its directory is in 'runtimepath'.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100511
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100512Vim will also load ftdetect files, if there are any.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100513
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100514Note that the files under "pack/foo/opt" are not loaded automatically, only the
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +0100515ones under "pack/foo/start". See |pack-add| below for how the "opt" directory
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100516is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100517
Bram Moolenaar8dcf2592016-03-12 22:47:14 +0100518Loading packages automatically will not happen if loading plugins is disabled,
519see |load-plugins|.
520
521To load packages earlier, so that 'runtimepath' gets updated: >
522 :packloadall
523This also works when loading plugins is disabled. The automatic loading will
524only happen once.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100525
Bram Moolenaar26852122016-05-24 20:02:38 +0200526If the package has an "after" directory, that directory is added to the end of
527'runtimepath', so that anything there will be loaded later.
528
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100529
530Using a single plugin and loading it automatically ~
531
532If you don't have a package but a single plugin, you need to create the extra
533directory level:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +0100534 % mkdir -p ~/.vim/pack/foo/start/foobar
535 % cd ~/.vim/pack/foo/start/foobar
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100536 % unzip /tmp/someplugin.zip
537
538You would now have these files:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +0100539 pack/foo/start/foobar/plugin/foo.vim
540 pack/foo/start/foobar/syntax/some.vim
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100541
542From here it works like above.
543
544
545Optional plugins ~
546 *pack-add*
547To load an optional plugin from a pack use the `:packadd` command: >
548 :packadd foodebug
549This searches for "pack/*/opt/foodebug" in 'packpath' and will find
550~/.vim/pack/foo/opt/foodebug/plugin/debugger.vim and source it.
551
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100552This could be done if some conditions are met. For example, depending on
553whether Vim supports a feature or a dependency is missing.
554
555You can also load an optional plugin at startup, by putting this command in
556your |.vimrc|: >
557 :packadd! foodebug
Bram Moolenaarc95a3022016-06-12 23:01:46 +0200558The extra "!" is so that the plugin isn't loaded if Vim was started with
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100559|--noplugin|.
Bram Moolenaar5f148ec2016-03-07 22:59:26 +0100560
561It is perfectly normal for a package to only have files in the "opt"
562directory. You then need to load each plugin when you want to use it.
563
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100564
565Where to put what ~
566
567Since color schemes, loaded with `:colorscheme`, are found below
568"pack/*/start" and "pack/*/opt", you could put them anywhere. We recommend
569you put them below "pack/*/opt", for example
570".vim/pack/mycolors/opt/dark/colors/very_dark.vim".
571
572Filetype plugins should go under "pack/*/start", so that they are always
573found. Unless you have more than one plugin for a file type and want to
574select which one to load with `:packadd`. E.g. depending on the compiler
575version: >
576 if foo_compiler_version > 34
577 packadd foo_new
578 else
579 packadd foo_old
580 endif
581
582The "after" directory is most likely not useful in a package. It's not
583disallowed though.
584
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +0100585==============================================================================
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005866. Creating Vim packages *package-create*
587
588This assumes you write one or more plugins that you distribute as a package.
589
590If you have two unrelated plugins you would use two packages, so that Vim
591users can chose what they include or not. Or you can decide to use one
592package with optional plugins, and tell the user to add the ones he wants with
593`:packadd`.
594
595Decide how you want to distribute the package. You can create an archive or
596you could use a repository. An archive can be used by more users, but is a
597bit harder to update to a new version. A repository can usually be kept
598up-to-date easily, but it requires a program like "git" to be available.
599You can do both, github can automatically create an archive for a release.
600
601Your directory layout would be like this:
602 start/foobar/plugin/foo.vim " always loaded, defines commands
603 start/foobar/plugin/bar.vim " always loaded, defines commands
604 start/foobar/autoload/foo.vim " loaded when foo command used
605 start/foobar/doc/foo.txt " help for foo.vim
606 start/foobar/doc/tags " help tags
607 opt/fooextra/plugin/extra.vim " optional plugin, defines commands
608 opt/fooextra/autoload/extra.vim " loaded when extra command used
609 opt/fooextra/doc/extra.txt " help for extra.vim
610 opt/fooextra/doc/tags " help tags
611
612This allows for the user to do: >
613 mkdir ~/.vim/pack/myfoobar
614 cd ~/.vim/pack/myfoobar
615 git clone https://github.com/you/foobar.git
616
617Here "myfoobar" is a name that the user can choose, the only condition is that
618it differs from other packages.
619
620In your documentation you explain what the plugins do, and tell the user how
621to load the optional plugin: >
622 :packadd! fooextra
623
624You could add this packadd command in one of your plugins, to be executed when
625the optional plugin is needed.
626
627Run the `:helptags` command to generate the doc/tags file. Including this
628generated file in the package means that the user can drop the package in his
629pack directory and the help command works right away. Don't forget to re-run
630the command after changing the plugin help: >
631 :helptags path/start/foobar/doc
632 :helptags path/opt/fooextra/doc
633
Bram Moolenaar03413f42016-04-12 21:07:15 +0200634
635Dependencies between plugins ~
636 *packload-two-steps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +0200637Suppose you have two plugins that depend on the same functionality. You can
Bram Moolenaar03413f42016-04-12 21:07:15 +0200638put the common functionality in an autoload directory, so that it will be
639found automatically. Your package would have these files:
640
641 pack/foo/start/one/plugin/one.vim >
642 call foolib#getit()
643< pack/foo/start/two/plugin/two.vim >
644 call foolib#getit()
645< pack/foo/start/lib/autoload/foolib.vim >
646 func foolib#getit()
647
648This works, because loading packages will first add all found directories to
649'runtimepath' before sourcing the plugins.
650
Bram Moolenaar4f3f6682016-03-26 23:01:59 +0100651==============================================================================
6527. Debugging scripts *debug-scripts*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
654Besides the obvious messages that you can add to your scripts to find out what
655they are doing, Vim offers a debug mode. This allows you to step through a
656sourced file or user function and set breakpoints.
657
658NOTE: The debugging mode is far from perfect. Debugging will have side
659effects on how Vim works. You cannot use it to debug everything. For
660example, the display is messed up by the debugging messages.
661{Vi does not have a debug mode}
662
663An alternative to debug mode is setting the 'verbose' option. With a bigger
664number it will give more verbose messages about what Vim is doing.
665
666
667STARTING DEBUG MODE *debug-mode*
668
669To enter debugging mode use one of these methods:
6701. Start Vim with the |-D| argument: >
671 vim -D file.txt
672< Debugging will start as soon as the first vimrc file is sourced. This is
673 useful to find out what is happening when Vim is starting up. A side
674 effect is that Vim will switch the terminal mode before initialisations
675 have finished, with unpredictable results.
676 For a GUI-only version (Windows, Macintosh) the debugging will start as
677 soon as the GUI window has been opened. To make this happen early, add a
678 ":gui" command in the vimrc file.
679 *:debug*
6802. Run a command with ":debug" prepended. Debugging will only be done while
681 this command executes. Useful for debugging a specific script or user
682 function. And for scripts and functions used by autocommands. Example: >
683 :debug edit test.txt.gz
684
6853. Set a breakpoint in a sourced file or user function. You could do this in
686 the command line: >
687 vim -c "breakadd file */explorer.vim" .
688< This will run Vim and stop in the first line of the "explorer.vim" script.
689 Breakpoints can also be set while in debugging mode.
690
691In debugging mode every executed command is displayed before it is executed.
692Comment lines, empty lines and lines that are not executed are skipped. When
693a line contains two commands, separated by "|", each command will be displayed
694separately.
695
696
697DEBUG MODE
698
699Once in debugging mode, the usual Ex commands can be used. For example, to
700inspect the value of a variable: >
701 echo idx
702When inside a user function, this will print the value of the local variable
703"idx". Prepend "g:" to get the value of a global variable: >
704 echo g:idx
705All commands are executed in the context of the current function or script.
706You can also set options, for example setting or resetting 'verbose' will show
707what happens, but you might want to set it just before executing the lines you
708are interested in: >
709 :set verbose=20
710
711Commands that require updating the screen should be avoided, because their
712effect won't be noticed until after leaving debug mode. For example: >
713 :help
714won't be very helpful.
715
716There is a separate command-line history for debug mode.
717
718The line number for a function line is relative to the start of the function.
719If you have trouble figuring out where you are, edit the file that defines
720the function in another Vim, search for the start of the function and do
721"99j". Replace "99" with the line number.
722
723Additionally, these commands can be used:
724 *>cont*
725 cont Continue execution until the next breakpoint is hit.
726 *>quit*
727 quit Abort execution. This is like using CTRL-C, some
728 things might still be executed, doesn't abort
729 everything. Still stops at the next breakpoint.
730 *>next*
731 next Execute the command and come back to debug mode when
732 it's finished. This steps over user function calls
733 and sourced files.
734 *>step*
735 step Execute the command and come back to debug mode for
736 the next command. This steps into called user
737 functions and sourced files.
738 *>interrupt*
739 interrupt This is like using CTRL-C, but unlike ">quit" comes
740 back to debug mode for the next command that is
741 executed. Useful for testing |:finally| and |:catch|
742 on interrupt exceptions.
743 *>finish*
744 finish Finish the current script or user function and come
745 back to debug mode for the command after the one that
746 sourced or called it.
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100747 *>bt*
748 *>backtrace*
749 *>where*
750 backtrace Show the call stacktrace for current debugging session.
751 bt
752 where
753 *>frame*
Bram Moolenaar38a55632016-02-15 22:07:32 +0100754 frame N Goes to N backtrace level. + and - signs make movement
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100755 relative. E.g., ":frame +3" goes three frames up.
756 *>up*
757 up Goes one level up from call stacktrace.
758 *>down*
759 down Goes one level down from call stacktrace.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760
761About the additional commands in debug mode:
762- There is no command-line completion for them, you get the completion for the
763 normal Ex commands only.
Bram Moolenaardae8d212016-02-27 22:40:16 +0100764- You can shorten them, up to a single character, unless more than one command
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100765 starts with the same letter. "f" stands for "finish", use "fr" for "frame".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766- Hitting <CR> will repeat the previous one. When doing another command, this
767 is reset (because it's not clear what you want to repeat).
768- When you want to use the Ex command with the same name, prepend a colon:
769 ":cont", ":next", ":finish" (or shorter).
770
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100771The backtrace shows the hierarchy of function calls, e.g.:
772 >bt ~
773 3 function One[3] ~
774 2 Two[3] ~
775 ->1 Three[3] ~
776 0 Four ~
777 line 1: let four = 4 ~
778
779The "->" points to the current frame. Use "up", "down" and "frame N" to
780select another frame.
781
782In the current frame you can evaluate the local function variables. There is
783no way to see the command at the current line yet.
784
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785
786DEFINING BREAKPOINTS
787 *:breaka* *:breakadd*
788:breaka[dd] func [lnum] {name}
789 Set a breakpoint in a function. Example: >
790 :breakadd func Explore
791< Doesn't check for a valid function name, thus the breakpoint
792 can be set before the function is defined.
793
794:breaka[dd] file [lnum] {name}
795 Set a breakpoint in a sourced file. Example: >
796 :breakadd file 43 .vimrc
797
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000798:breaka[dd] here
799 Set a breakpoint in the current line of the current file.
800 Like doing: >
801 :breakadd file <cursor-line> <current-file>
802< Note that this only works for commands that are executed when
803 sourcing the file, not for a function defined in that file.
804
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805The [lnum] is the line number of the breakpoint. Vim will stop at or after
806this line. When omitted line 1 is used.
807
Bram Moolenaar05159a02005-02-26 23:04:13 +0000808 *:debug-name*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809{name} is a pattern that is matched with the file or function name. The
810pattern is like what is used for autocommands. There must be a full match (as
811if the pattern starts with "^" and ends in "$"). A "*" matches any sequence
812of characters. 'ignorecase' is not used, but "\c" can be used in the pattern
813to ignore case |/\c|. Don't include the () for the function name!
814
Bram Moolenaar843ee412004-06-30 16:16:41 +0000815The match for sourced scripts is done against the full file name. If no path
816is specified the current directory is used. Examples: >
817 breakadd file explorer.vim
818matches "explorer.vim" in the current directory. >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 breakadd file *explorer.vim
Bram Moolenaar843ee412004-06-30 16:16:41 +0000820matches ".../plugin/explorer.vim", ".../plugin/iexplorer.vim", etc. >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 breakadd file */explorer.vim
Bram Moolenaar843ee412004-06-30 16:16:41 +0000822matches ".../plugin/explorer.vim" and "explorer.vim" in any other directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
824The match for functions is done against the name as it's shown in the output
825of ":function". For local functions this means that something like "<SNR>99_"
826is prepended.
827
Bram Moolenaar2ce06f62005-01-31 19:19:04 +0000828Note that functions are first loaded and later executed. When they are loaded
829the "file" breakpoints are checked, when they are executed the "func"
830breakpoints.
831
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832
833DELETING BREAKPOINTS
834 *:breakd* *:breakdel* *E161*
835:breakd[el] {nr}
836 Delete breakpoint {nr}. Use |:breaklist| to see the number of
837 each breakpoint.
838
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000839:breakd[el] *
840 Delete all breakpoints.
841
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842:breakd[el] func [lnum] {name}
843 Delete a breakpoint in a function.
844
845:breakd[el] file [lnum] {name}
846 Delete a breakpoint in a sourced file.
847
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000848:breakd[el] here
849 Delete a breakpoint at the current line of the current file.
850
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851When [lnum] is omitted, the first breakpoint in the function or file is
852deleted.
853The {name} must be exactly the same as what was typed for the ":breakadd"
854command. "explorer", "*explorer.vim" and "*explorer*" are different.
855
856
857LISTING BREAKPOINTS
858 *:breakl* *:breaklist*
859:breakl[ist]
860 List all breakpoints.
861
862
863OBSCURE
864
865 *:debugg* *:debuggreedy*
866:debugg[reedy]
867 Read debug mode commands from the normal input stream, instead
868 of getting them directly from the user. Only useful for test
869 scripts. Example: >
870 echo 'q^Mq' | vim -e -s -c debuggreedy -c 'breakadd file script.vim' -S script.vim
871
872:0debugg[reedy]
873 Undo ":debuggreedy": get debug mode commands directly from the
874 user, don't use typeahead for debug commands.
875
Bram Moolenaar05159a02005-02-26 23:04:13 +0000876==============================================================================
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01008778. Profiling *profile* *profiling*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000878
Bram Moolenaar996343d2010-07-04 22:20:21 +0200879Profiling means that Vim measures the time that is spent on executing
Bram Moolenaar05159a02005-02-26 23:04:13 +0000880functions and/or scripts. The |+profile| feature is required for this.
881It is only included when Vim was compiled with "huge" features.
882{Vi does not have profiling}
883
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000884You can also use the |reltime()| function to measure time. This only requires
885the |+reltime| feature, which is present more often.
886
Bram Moolenaar16ea3672013-07-28 16:02:18 +0200887For profiling syntax highlighting see |:syntime|.
888
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +0100889For example, to profile the one_script.vim script file: >
890 :profile start /tmp/one_script_profile
891 :profile file one_script.vim
892 :source one_script.vim
893 :exit
894
Bram Moolenaar16ea3672013-07-28 16:02:18 +0200895
Bram Moolenaar05159a02005-02-26 23:04:13 +0000896:prof[ile] start {fname} *:prof* *:profile* *E750*
897 Start profiling, write the output in {fname} upon exit.
Bram Moolenaar0a63ded2015-04-15 13:31:24 +0200898 "~/" and environment variables in {fname} will be expanded.
Bram Moolenaar9b2200a2006-03-20 21:55:45 +0000899 If {fname} already exists it will be silently overwritten.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000900 The variable |v:profiling| is set to one.
901
Bram Moolenaar9b2200a2006-03-20 21:55:45 +0000902:prof[ile] pause
903 Don't profile until the following ":profile continue". Can be
904 used when doing something that should not be counted (e.g., an
905 external command). Does not nest.
906
907:prof[ile] continue
908 Continue profiling after ":profile pause".
909
Bram Moolenaar05159a02005-02-26 23:04:13 +0000910:prof[ile] func {pattern}
911 Profile function that matches the pattern {pattern}.
912 See |:debug-name| for how {pattern} is used.
913
914:prof[ile][!] file {pattern}
915 Profile script file that matches the pattern {pattern}.
916 See |:debug-name| for how {pattern} is used.
917 This only profiles the script itself, not the functions
918 defined in it.
919 When the [!] is added then all functions defined in the script
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +0100920 will also be profiled.
921 Note that profiling only starts when the script is loaded
922 after this command. A :profile command in the script itself
923 won't work.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000924
925
Bram Moolenaard9fba312005-06-26 22:34:35 +0000926:profd[el] ... *:profd* *:profdel*
927 Stop profiling for the arguments specified. See |:breakdel|
928 for the arguments.
929
930
Bram Moolenaar05159a02005-02-26 23:04:13 +0000931You must always start with a ":profile start fname" command. The resulting
932file is written when Vim exits. Here is an example of the output, with line
933numbers prepended for the explanation:
934
935 1 FUNCTION Test2() ~
936 2 Called 1 time ~
937 3 Total time: 0.155251 ~
938 4 Self time: 0.002006 ~
939 5 ~
940 6 count total (s) self (s) ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000941 7 9 0.000096 for i in range(8) ~
942 8 8 0.153655 0.000410 call Test3() ~
943 9 8 0.000070 endfor ~
944 10 " Ask a question ~
945 11 1 0.001341 echo input("give me an answer: ") ~
Bram Moolenaar05159a02005-02-26 23:04:13 +0000946
947The header (lines 1-4) gives the time for the whole function. The "Total"
948time is the time passed while the function was executing. The "Self" time is
949the "Total" time reduced by time spent in:
950- other user defined functions
951- sourced scripts
952- executed autocommands
953- external (shell) commands
954
955Lines 7-11 show the time spent in each executed line. Lines that are not
956executed do not count. Thus a comment line is never counted.
957
958The Count column shows how many times a line was executed. Note that the
959"for" command in line 7 is executed one more time as the following lines.
960That is because the line is also executed to detect the end of the loop.
961
962The time Vim spends waiting for user input isn't counted at all. Thus how
963long you take to respond to the input() prompt is irrelevant.
964
965Profiling should give a good indication of where time is spent, but keep in
966mind there are various things that may clobber the results:
967
968- The accuracy of the time measured depends on the gettimeofday() system
969 function. It may only be as accurate as 1/100 second, even though the times
970 are displayed in micro seconds.
971
972- Real elapsed time is measured, if other processes are busy they may cause
973 delays at unpredictable moments. You may want to run the profiling several
974 times and use the lowest results.
975
976- If you have several commands in one line you only get one time. Split the
977 line to see the time for the individual commands.
978
979- The time of the lines added up is mostly less than the time of the whole
980 function. There is some overhead in between.
981
982- Functions that are deleted before Vim exits will not produce profiling
983 information. You can check the |v:profiling| variable if needed: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000984 :if !v:profiling
Bram Moolenaar05159a02005-02-26 23:04:13 +0000985 : delfunc MyFunc
986 :endif
987<
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000988- Profiling may give weird results on multi-processor systems, when sleep
989 mode kicks in or the processor frequency is reduced to save power.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000990
Bram Moolenaarc81e5e72007-05-05 18:24:42 +0000991- The "self" time is wrong when a function is used recursively.
992
993
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 vim:tw=78:ts=8:ft=help:norl: