1 *repeat.txt* For Vim version 7.2. Last change: 2007 Aug 12
4 VIM REFERENCE MANUAL by Bram Moolenaar
7 Repeating commands, Vim scripts and debugging *repeating*
9 Chapter 26 of the user manual introduces repeating |usr_26.txt|.
11 1. Single repeats |single-repeat|
12 2. Multiple repeats |multi-repeat|
13 3. Complex repeats |complex-repeat|
14 4. Using Vim scripts |using-scripts|
15 5. Debugging scripts |debug-scripts|
16 6. Profiling |profiling|
18 ==============================================================================
19 1. Single repeats *single-repeat*
22 . Repeat last change, with count replaced with [count].
23 Also repeat a yank command, when the 'y' flag is
24 included in 'cpoptions'. Does not repeat a
27 Simple changes can be repeated with the "." command. Without a count, the
28 count of the last change is used. If you enter a count, it will replace the
29 last one. If the last change included a specification of a numbered register,
30 the register number will be incremented. See |redo-register| for an example
31 how to use this. Note that when repeating a command that used a Visual
32 selection, the same SIZE of area is used, see |visual-repeat|.
35 @: Repeat last command-line [count] times.
36 {not available when compiled without the
37 |+cmdline_hist| feature}
40 ==============================================================================
41 2. Multiple repeats *multi-repeat*
43 *:g* *:global* *E147* *E148*
44 :[range]g[lobal]/{pattern}/[cmd]
45 Execute the Ex command [cmd] (default ":p") on the
46 lines within [range] where {pattern} matches.
48 :[range]g[lobal]!/{pattern}/[cmd]
49 Execute the Ex command [cmd] (default ":p") on the
50 lines within [range] where {pattern} does NOT match.
53 :[range]v[global]/{pattern}/[cmd]
56 Instead of the '/' which surrounds the {pattern}, you can use any other
57 single byte character, but not an alphanumeric character, '\', '"' or '|'.
58 This is useful if you want to include a '/' in the search pattern or
61 For the definition of a pattern, see |pattern|.
63 The global commands work by first scanning through the [range] lines and
64 marking each line where a match occurs (for a multi-line pattern, only the
65 start of the match matters).
66 In a second scan the [cmd] is executed for each marked line with its line
67 number prepended. For ":v" and ":g!" the command is executed for each not
68 marked line. If a line is deleted its mark disappears.
69 The default for [range] is the whole buffer (1,$). Use "CTRL-C" to interrupt
70 the command. If an error message is given for a line, the command for that
71 line is aborted and the global command continues with the next marked or
74 To repeat a non-Ex command, you can use the ":normal" command: >
75 :g/pat/normal {commands}
76 Make sure that {commands} ends with a whole command, otherwise Vim will wait
77 for you to type the rest of the command for each match. The screen will not
78 have been updated, so you don't know what you are doing. See |:normal|.
80 The undo/redo command will undo/redo the whole global command at once.
81 The previous context mark will only be set once (with "''" you go back to
82 where the cursor was before the global command).
84 The global command sets both the last used search pattern and the last used
85 substitute pattern (this is vi compatible). This makes it easy to globally
88 This replaces all occurrences of "pat" with "PAT". The same can be done with:
90 Which is two characters shorter!
92 When using "global" in Ex mode, a special case is using ":visual" as a
93 command. This will move to a matching line, go to Normal mode to let you
94 execute commands there until you use |Q| to return to Ex mode. This will be
95 repeated for each matching line. While doing this you cannot use ":global".
96 To abort this type CTRL-C twice.
98 ==============================================================================
99 3. Complex repeats *complex-repeat*
102 q{0-9a-zA-Z"} Record typed characters into register {0-9a-zA-Z"}
103 (uppercase to append). The 'q' command is disabled
104 while executing a register, and it doesn't work inside
105 a mapping. {Vi: no recording}
107 q Stops recording. (Implementation note: The 'q' that
108 stops recording is not stored in the register, unless
109 it was the result of a mapping) {Vi: no recording}
112 @{0-9a-z".=*} Execute the contents of register {0-9a-z".=*} [count]
113 times. Note that register '%' (name of the current
114 file) and '#' (name of the alternate file) cannot be
115 used. For "@=" you are prompted to enter an
116 expression. The result of the expression is then
117 executed. See also |@:|. {Vi: only named registers}
120 @@ Repeat the previous @{0-9a-z":*} [count] times.
122 :[addr]*{0-9a-z".=} *:@* *:star*
123 :[addr]@{0-9a-z".=*} Execute the contents of register {0-9a-z".=*} as an Ex
124 command. First set cursor at line [addr] (default is
125 current line). When the last line in the register does
126 not have a <CR> it will be added automatically when
127 the 'e' flag is present in 'cpoptions'.
128 Note that the ":*" command is only recognized when the
129 '*' flag is present in 'cpoptions'. This is NOT the
130 default when 'nocompatible' is used.
131 For ":@=" the last used expression is used. The
132 result of evaluating the expression is executed as an
134 Mappings are not recognized in these commands.
135 {Vi: only in some versions} Future: Will execute the
136 register for each line in the address range.
139 :[addr]@: Repeat last command-line. First set cursor at line
140 [addr] (default is current line). {not in Vi}
143 :[addr]@@ Repeat the previous :@{0-9a-z"}. First set cursor at
144 line [addr] (default is current line). {Vi: only in
147 ==============================================================================
148 4. Using Vim scripts *using-scripts*
150 For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
152 *:so* *:source* *load-vim-script*
153 :so[urce] {file} Read Ex commands from {file}. These are commands that
155 Triggers the |SourcePre| autocommand.
157 :so[urce]! {file} Read Vim commands from {file}. These are commands
158 that are executed from Normal mode, like you type
160 When used after |:global|, |:argdo|, |:windo|,
161 |:bufdo|, in a loop or when another command follows
162 the display won't be updated while executing the
167 :ru[ntime][!] {file} ..
168 Read Ex commands from {file} in each directory given
169 by 'runtimepath'. There is no error for non-existing
171 :runtime syntax/c.vim
173 < There can be multiple {file} arguments, separated by
174 spaces. Each {file} is searched for in the first
175 directory from 'runtimepath', then in the second
176 directory, etc. Use a backslash to include a space
177 inside {file} (although it's better not to use spaces
178 in file names, it causes trouble).
180 When [!] is included, all found files are sourced.
181 When it is not included only the first found file is
184 When {file} contains wildcards it is expanded to all
185 matching files. Example: >
186 :runtime! plugin/*.vim
187 < This is what Vim uses to load the plugin files when
188 starting up. This similar command: >
189 :runtime plugin/*.vim
190 < would source the first file only.
192 When 'verbose' is one or higher, there is a message
193 when no file could be found.
194 When 'verbose' is two or higher, there is a message
195 about each searched file.
198 :scripte[ncoding] [encoding] *:scripte* *:scriptencoding* *E167*
199 Specify the character encoding used in the script.
200 The following lines will be converted from [encoding]
201 to the value of the 'encoding' option, if they are
202 different. Examples: >
203 scriptencoding iso-8859-5
206 When [encoding] is empty, no conversion is done. This
207 can be used to restrict conversion to a sequence of
209 scriptencoding euc-jp
210 ... lines to be converted ...
212 ... not converted ...
214 < When conversion isn't supported by the system, there
215 is no error message and no conversion is done.
217 Don't use "ucs-2" or "ucs-4", scripts cannot be in
218 these encodings (they would contain NUL bytes).
219 When a sourced script starts with a BOM (Byte Order
220 Mark) in utf-8 format Vim will recognized it, no need
221 to use ":scriptencoding utf-8" then.
223 When compiled without the |+multi_byte| feature this
227 *:scrip* *:scriptnames*
228 :scrip[tnames] List all sourced script names, in the order they were
229 first sourced. The number is used for the script ID
231 {not in Vi} {not available when compiled without the
234 *:fini* *:finish* *E168*
235 :fini[sh] Stop sourcing a script. Can only be used in a Vim
236 script file. This is a quick way to skip the rest of
237 the file. If it is used after a |:try| but before the
238 matching |:finally| (if present), the commands
239 following the ":finally" up to the matching |:endtry|
240 are executed first. This process applies to all
241 nested ":try"s in the script. The outermost ":endtry"
242 then stops sourcing the script. {not in Vi}
244 All commands and command sequences can be repeated by putting them in a named
245 register and then executing it. There are two ways to get the commands in the
247 - Use the record command "q". You type the commands once, and while they are
248 being executed they are stored in a register. Easy, because you can see
249 what you are doing. If you make a mistake, "p"ut the register into the
250 file, edit the command sequence, and then delete it into the register
251 again. You can continue recording by appending to the register (use an
253 - Delete or yank the command sequence into the register.
255 Often used command sequences can be put under a function key with the ':map'
258 An alternative is to put the commands in a file, and execute them with the
259 ':source!' command. Useful for long command sequences. Can be combined with
260 the ':map' command to put complicated commands under a function key.
262 The ':source' command reads Ex commands from a file line by line. You will
263 have to type any needed keyboard input. The ':source!' command reads from a
264 script file character by character, interpreting each character as if you
267 Example: When you give the ":!ls" command you get the |hit-enter| prompt. If
268 you ':source' a file with the line "!ls" in it, you will have to type the
269 <Enter> yourself. But if you ':source!' a file with the line ":!ls" in it,
270 the next characters from that file are read until a <CR> is found. You will
271 not have to type <CR> yourself, unless ":!ls" was the last line in the file.
273 It is possible to put ':source[!]' commands in the script file, so you can
274 make a top-down hierarchy of script files. The ':source' command can be
275 nested as deep as the number of files that can be opened at one time (about
276 15). The ':source!' command can be nested up to 15 levels deep.
278 You can use the "<sfile>" string (literally, this is not a special key) inside
279 of the sourced file, in places where a file name is expected. It will be
280 replaced by the file name of the sourced file. For example, if you have a
281 "other.vimrc" file in the same directory as your ".vimrc" file, you can source
282 it from your ".vimrc" file with this command: >
283 :source <sfile>:h/other.vimrc
285 In script files terminal-dependent key codes are represented by
286 terminal-independent two character codes. This means that they can be used
287 in the same way on different kinds of terminals. The first character of a
288 key code is 0x80 or 128, shown on the screen as "~@". The second one can be
289 found in the list |key-notation|. Any of these codes can also be entered
290 with CTRL-V followed by the three digit decimal code. This does NOT work for
291 the <t_xx> termcap codes, these can only be used in mappings.
294 MS-DOS, Win32 and OS/2: Files that are read with ":source" normally have
295 <CR><NL> <EOL>s. These always work. If you are using a file with <NL> <EOL>s
296 (for example, a file made on Unix), this will be recognized if 'fileformats'
297 is not empty and the first line does not end in a <CR>. This fails if the
298 first line has something like ":map <F1> :help^M", where "^M" is a <CR>. If
299 the first line ends in a <CR>, but following ones don't, you will get an error
300 message, because the <CR> from the first lines will be lost.
302 Mac Classic: Files that are read with ":source" normally have <CR> <EOL>s.
303 These always work. If you are using a file with <NL> <EOL>s (for example, a
304 file made on Unix), this will be recognized if 'fileformats' is not empty and
305 the first line does not end in a <CR>. Be careful not to use a file with <NL>
306 linebreaks which has a <CR> in first line.
308 On other systems, Vim expects ":source"ed files to end in a <NL>. These
309 always work. If you are using a file with <CR><NL> <EOL>s (for example, a
310 file made on MS-DOS), all lines will have a trailing <CR>. This may cause
311 problems for some commands (e.g., mappings). There is no automatic <EOL>
312 detection, because it's common to start with a line that defines a mapping
313 that ends in a <CR>, which will confuse the automaton.
316 Long lines in a ":source"d Ex command script file can be split by inserting
317 a line continuation symbol "\" (backslash) at the start of the next line.
318 There can be white space before the backslash, which is ignored.
321 :set comments=sr:/*,mb:*,el:*/,
327 are interpreted as if they were given in one line:
328 :set comments=sr:/*,mb:*,el:*/,://,b:#,:%,n:>,fb:-
330 All leading whitespace characters in the line before a backslash are ignored.
331 Note however that trailing whitespace in the line before it cannot be
332 inserted freely; it depends on the position where a command is split up
333 whether additional whitespace is allowed or not.
335 There is a problem with the ":append" and ":insert" commands: >
339 The backslash is seen as a line-continuation symbol, thus this results in the
343 To avoid this, add the 'C' flag to the 'cpoptions' option: >
350 Note that when the commands are inside a function, you need to add the 'C'
351 flag when defining the function, it is not relevant when executing it. >
361 Most programs work with a trailing backslash to indicate line
362 continuation. Using this in Vim would cause incompatibility with Vi.
363 For example for this Vi mapping: >
365 < Therefore the unusual leading backslash is used.
367 ==============================================================================
368 5. Debugging scripts *debug-scripts*
370 Besides the obvious messages that you can add to your scripts to find out what
371 they are doing, Vim offers a debug mode. This allows you to step through a
372 sourced file or user function and set breakpoints.
374 NOTE: The debugging mode is far from perfect. Debugging will have side
375 effects on how Vim works. You cannot use it to debug everything. For
376 example, the display is messed up by the debugging messages.
377 {Vi does not have a debug mode}
379 An alternative to debug mode is setting the 'verbose' option. With a bigger
380 number it will give more verbose messages about what Vim is doing.
383 STARTING DEBUG MODE *debug-mode*
385 To enter debugging mode use one of these methods:
386 1. Start Vim with the |-D| argument: >
388 < Debugging will start as soon as the first vimrc file is sourced. This is
389 useful to find out what is happening when Vim is starting up. A side
390 effect is that Vim will switch the terminal mode before initialisations
391 have finished, with unpredictable results.
392 For a GUI-only version (Windows, Macintosh) the debugging will start as
393 soon as the GUI window has been opened. To make this happen early, add a
394 ":gui" command in the vimrc file.
396 2. Run a command with ":debug" prepended. Debugging will only be done while
397 this command executes. Useful for debugging a specific script or user
398 function. And for scripts and functions used by autocommands. Example: >
399 :debug edit test.txt.gz
401 3. Set a breakpoint in a sourced file or user function. You could do this in
403 vim -c "breakadd file */explorer.vim" .
404 < This will run Vim and stop in the first line of the "explorer.vim" script.
405 Breakpoints can also be set while in debugging mode.
407 In debugging mode every executed command is displayed before it is executed.
408 Comment lines, empty lines and lines that are not executed are skipped. When
409 a line contains two commands, separated by "|", each command will be displayed
415 Once in debugging mode, the usual Ex commands can be used. For example, to
416 inspect the value of a variable: >
418 When inside a user function, this will print the value of the local variable
419 "idx". Prepend "g:" to get the value of a global variable: >
421 All commands are executed in the context of the current function or script.
422 You can also set options, for example setting or resetting 'verbose' will show
423 what happens, but you might want to set it just before executing the lines you
427 Commands that require updating the screen should be avoided, because their
428 effect won't be noticed until after leaving debug mode. For example: >
430 won't be very helpful.
432 There is a separate command-line history for debug mode.
434 The line number for a function line is relative to the start of the function.
435 If you have trouble figuring out where you are, edit the file that defines
436 the function in another Vim, search for the start of the function and do
437 "99j". Replace "99" with the line number.
439 Additionally, these commands can be used:
441 cont Continue execution until the next breakpoint is hit.
443 quit Abort execution. This is like using CTRL-C, some
444 things might still be executed, doesn't abort
445 everything. Still stops at the next breakpoint.
447 next Execute the command and come back to debug mode when
448 it's finished. This steps over user function calls
451 step Execute the command and come back to debug mode for
452 the next command. This steps into called user
453 functions and sourced files.
455 interrupt This is like using CTRL-C, but unlike ">quit" comes
456 back to debug mode for the next command that is
457 executed. Useful for testing |:finally| and |:catch|
458 on interrupt exceptions.
460 finish Finish the current script or user function and come
461 back to debug mode for the command after the one that
462 sourced or called it.
464 About the additional commands in debug mode:
465 - There is no command-line completion for them, you get the completion for the
466 normal Ex commands only.
467 - You can shorten them, up to a single character: "c", "n", "s" and "f".
468 - Hitting <CR> will repeat the previous one. When doing another command, this
469 is reset (because it's not clear what you want to repeat).
470 - When you want to use the Ex command with the same name, prepend a colon:
471 ":cont", ":next", ":finish" (or shorter).
475 *:breaka* *:breakadd*
476 :breaka[dd] func [lnum] {name}
477 Set a breakpoint in a function. Example: >
478 :breakadd func Explore
479 < Doesn't check for a valid function name, thus the breakpoint
480 can be set before the function is defined.
482 :breaka[dd] file [lnum] {name}
483 Set a breakpoint in a sourced file. Example: >
484 :breakadd file 43 .vimrc
487 Set a breakpoint in the current line of the current file.
489 :breakadd file <cursor-line> <current-file>
490 < Note that this only works for commands that are executed when
491 sourcing the file, not for a function defined in that file.
493 The [lnum] is the line number of the breakpoint. Vim will stop at or after
494 this line. When omitted line 1 is used.
497 {name} is a pattern that is matched with the file or function name. The
498 pattern is like what is used for autocommands. There must be a full match (as
499 if the pattern starts with "^" and ends in "$"). A "*" matches any sequence
500 of characters. 'ignorecase' is not used, but "\c" can be used in the pattern
501 to ignore case |/\c|. Don't include the () for the function name!
503 The match for sourced scripts is done against the full file name. If no path
504 is specified the current directory is used. Examples: >
505 breakadd file explorer.vim
506 matches "explorer.vim" in the current directory. >
507 breakadd file *explorer.vim
508 matches ".../plugin/explorer.vim", ".../plugin/iexplorer.vim", etc. >
509 breakadd file */explorer.vim
510 matches ".../plugin/explorer.vim" and "explorer.vim" in any other directory.
512 The match for functions is done against the name as it's shown in the output
513 of ":function". For local functions this means that something like "<SNR>99_"
516 Note that functions are first loaded and later executed. When they are loaded
517 the "file" breakpoints are checked, when they are executed the "func"
522 *:breakd* *:breakdel* *E161*
524 Delete breakpoint {nr}. Use |:breaklist| to see the number of
528 Delete all breakpoints.
530 :breakd[el] func [lnum] {name}
531 Delete a breakpoint in a function.
533 :breakd[el] file [lnum] {name}
534 Delete a breakpoint in a sourced file.
537 Delete a breakpoint at the current line of the current file.
539 When [lnum] is omitted, the first breakpoint in the function or file is
541 The {name} must be exactly the same as what was typed for the ":breakadd"
542 command. "explorer", "*explorer.vim" and "*explorer*" are different.
546 *:breakl* *:breaklist*
548 List all breakpoints.
553 *:debugg* *:debuggreedy*
555 Read debug mode commands from the normal input stream, instead
556 of getting them directly from the user. Only useful for test
558 echo 'q^Mq' | vim -e -s -c debuggreedy -c 'breakadd file script.vim' -S script.vim
561 Undo ":debuggreedy": get debug mode commands directly from the
562 user, don't use typeahead for debug commands.
564 ==============================================================================
565 6. Profiling *profile* *profiling*
567 Profiling means that Vim measures the time that is spend on executing
568 functions and/or scripts. The |+profile| feature is required for this.
569 It is only included when Vim was compiled with "huge" features.
570 {Vi does not have profiling}
572 You can also use the |reltime()| function to measure time. This only requires
573 the |+reltime| feature, which is present more often.
575 :prof[ile] start {fname} *:prof* *:profile* *E750*
576 Start profiling, write the output in {fname} upon exit.
577 If {fname} already exists it will be silently overwritten.
578 The variable |v:profiling| is set to one.
581 Don't profile until the following ":profile continue". Can be
582 used when doing something that should not be counted (e.g., an
583 external command). Does not nest.
586 Continue profiling after ":profile pause".
588 :prof[ile] func {pattern}
589 Profile function that matches the pattern {pattern}.
590 See |:debug-name| for how {pattern} is used.
592 :prof[ile][!] file {pattern}
593 Profile script file that matches the pattern {pattern}.
594 See |:debug-name| for how {pattern} is used.
595 This only profiles the script itself, not the functions
597 When the [!] is added then all functions defined in the script
598 will also be profiled. But only if the script is loaded after
602 :profd[el] ... *:profd* *:profdel*
603 Stop profiling for the arguments specified. See |:breakdel|
607 You must always start with a ":profile start fname" command. The resulting
608 file is written when Vim exits. Here is an example of the output, with line
609 numbers prepended for the explanation:
613 3 Total time: 0.155251 ~
614 4 Self time: 0.002006 ~
616 6 count total (s) self (s) ~
617 7 9 0.000096 for i in range(8) ~
618 8 8 0.153655 0.000410 call Test3() ~
619 9 8 0.000070 endfor ~
620 10 " Ask a question ~
621 11 1 0.001341 echo input("give me an answer: ") ~
623 The header (lines 1-4) gives the time for the whole function. The "Total"
624 time is the time passed while the function was executing. The "Self" time is
625 the "Total" time reduced by time spent in:
626 - other user defined functions
628 - executed autocommands
629 - external (shell) commands
631 Lines 7-11 show the time spent in each executed line. Lines that are not
632 executed do not count. Thus a comment line is never counted.
634 The Count column shows how many times a line was executed. Note that the
635 "for" command in line 7 is executed one more time as the following lines.
636 That is because the line is also executed to detect the end of the loop.
638 The time Vim spends waiting for user input isn't counted at all. Thus how
639 long you take to respond to the input() prompt is irrelevant.
641 Profiling should give a good indication of where time is spent, but keep in
642 mind there are various things that may clobber the results:
644 - The accuracy of the time measured depends on the gettimeofday() system
645 function. It may only be as accurate as 1/100 second, even though the times
646 are displayed in micro seconds.
648 - Real elapsed time is measured, if other processes are busy they may cause
649 delays at unpredictable moments. You may want to run the profiling several
650 times and use the lowest results.
652 - If you have several commands in one line you only get one time. Split the
653 line to see the time for the individual commands.
655 - The time of the lines added up is mostly less than the time of the whole
656 function. There is some overhead in between.
658 - Functions that are deleted before Vim exits will not produce profiling
659 information. You can check the |v:profiling| variable if needed: >
664 - Profiling may give weird results on multi-processor systems, when sleep
665 mode kicks in or the processor frequency is reduced to save power.
667 - The "self" time is wrong when a function is used recursively.
670 vim:tw=78:ts=8:ft=help:norl: