|
237
|
1 *repeat.txt* For Vim version 7.0aa. Last change: 2005 Apr 01
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 Repeating commands, Vim scripts and debugging *repeating*
|
|
|
8
|
|
|
9 Chapter 26 of the user manual introduces repeating |usr_26.txt|.
|
|
|
10
|
|
|
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|
|
|
170
|
16 6. Profiling |profiling|
|
|
7
|
17
|
|
|
18 ==============================================================================
|
|
|
19 1. Single repeats *single-repeat*
|
|
|
20
|
|
|
21 *.*
|
|
|
22 . Repeat last change, with count replaced with [count].
|
|
|
23 Also repeat a yank command, when the 'y' flag is
|
|
22
|
24 included in 'cpoptions'. Does not repeat a
|
|
|
25 command-line command.
|
|
7
|
26
|
|
|
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|.
|
|
|
33
|
|
|
34 *@:*
|
|
|
35 @: Repeat last command-line [count] times.
|
|
|
36 {not available when compiled without the
|
|
|
37 |+cmdline_hist| feature}
|
|
|
38
|
|
|
39
|
|
|
40 ==============================================================================
|
|
|
41 2. Multiple repeats *multi-repeat*
|
|
|
42
|
|
|
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.
|
|
|
47
|
|
|
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.
|
|
|
51
|
|
|
52 *:v* *:vglobal*
|
|
|
53 :[range]v[global]/{pattern}/[cmd]
|
|
|
54 Same as :g!.
|
|
|
55
|
|
|
56 The global commands work by first scanning through the [range] lines and
|
|
|
57 marking each line where a match occurs (for a multi-line pattern, only the
|
|
|
58 start of the match matters).
|
|
|
59 In a second scan the [cmd] is executed for each marked line with its line
|
|
|
60 number prepended. For ":v" and ":g!" the command is executed for each not
|
|
|
61 marked line. If a line is deleted its mark disappears.
|
|
|
62 The default for [range] is the whole buffer (1,$). Use "CTRL-C" to interrupt
|
|
|
63 the command. If an error message is given for a line, the command for that
|
|
|
64 line is aborted and the global command continues with the next marked or
|
|
|
65 unmarked line.
|
|
|
66
|
|
|
67 To repeat a non-Ex command, you can use the ":normal" command: >
|
|
|
68 :g/pat/normal {commands}
|
|
|
69 Make sure that {commands} ends with a whole command, otherwise Vim will wait
|
|
|
70 for you to type the rest of the command for each match. The screen will not
|
|
|
71 have been updated, so you don't know what you are doing. See |:normal|.
|
|
|
72
|
|
|
73 The undo/redo command will undo/redo the whole global command at once.
|
|
|
74 The previous context mark will only be set once (with "''" you go back to
|
|
|
75 where the cursor was before the global command).
|
|
|
76
|
|
|
77 The global command sets both the last used search pattern and the last used
|
|
|
78 substitute pattern (this is vi compatible). This makes it easy to globally
|
|
|
79 replace a string:
|
|
|
80 :g/pat/s//PAT/g
|
|
|
81 This replaces all occurrences of "pat" with "PAT". The same can be done with:
|
|
|
82 :%s/pat/PAT/g
|
|
|
83 Which is two characters shorter!
|
|
|
84
|
|
168
|
85 A special case is using ":visual" as a command. This will move to a matching
|
|
|
86 line, go to Normal mode to let you execute commands there until you use |Q| to
|
|
|
87 return to Ex mode. This will be repeated for each matching line. While doing
|
|
|
88 this you cannot use ":global".
|
|
|
89
|
|
7
|
90 ==============================================================================
|
|
|
91 3. Complex repeats *complex-repeat*
|
|
|
92
|
|
|
93 *q* *recording*
|
|
|
94 q{0-9a-zA-Z"} Record typed characters into register {0-9a-zA-Z"}
|
|
|
95 (uppercase to append). The 'q' command is disabled
|
|
|
96 while executing a register, and it doesn't work inside
|
|
|
97 a mapping. {Vi: no recording}
|
|
|
98
|
|
|
99 q Stops recording. (Implementation note: The 'q' that
|
|
|
100 stops recording is not stored in the register, unless
|
|
|
101 it was the result of a mapping) {Vi: no recording}
|
|
|
102
|
|
|
103 *@*
|
|
|
104 @{0-9a-z".=*} Execute the contents of register {0-9a-z".=*} [count]
|
|
|
105 times. Note that register '%' (name of the current
|
|
|
106 file) and '#' (name of the alternate file) cannot be
|
|
|
107 used. For "@=" you are prompted to enter an
|
|
|
108 expression. The result of the expression is then
|
|
|
109 executed. See also |@:|. {Vi: only named registers}
|
|
|
110
|
|
168
|
111 *@@* *E748*
|
|
7
|
112 @@ Repeat the previous @{0-9a-z":*} [count] times.
|
|
|
113
|
|
|
114 :[addr]*{0-9a-z".=} *:@* *:star*
|
|
|
115 :[addr]@{0-9a-z".=*} Execute the contents of register {0-9a-z".=*} as an Ex
|
|
|
116 command. First set cursor at line [addr] (default is
|
|
|
117 current line). When the last line in the register does
|
|
|
118 not have a <CR> it will be added automatically when
|
|
|
119 the 'e' flag is present in 'cpoptions'.
|
|
|
120 Note that the ":*" command is only recognized when the
|
|
|
121 '*' flag is present in 'cpoptions'. This is NOT the
|
|
|
122 default when 'nocompatible' is used.
|
|
|
123 For ":@=" the last used expression is used. The
|
|
|
124 result of evaluating the expression is executed as an
|
|
|
125 Ex command.
|
|
|
126 Mappings are not recognized in these commands.
|
|
|
127 {Vi: only in some versions} Future: Will execute the
|
|
|
128 register for each line in the address range.
|
|
|
129
|
|
|
130 *:@:*
|
|
|
131 :[addr]@: Repeat last command-line. First set cursor at line
|
|
|
132 [addr] (default is current line). {not in Vi}
|
|
|
133
|
|
|
134 *:@@*
|
|
|
135 :[addr]@@ Repeat the previous :@{0-9a-z"}. First set cursor at
|
|
|
136 line [addr] (default is current line). {Vi: only in
|
|
|
137 some versions}
|
|
|
138
|
|
|
139 ==============================================================================
|
|
|
140 4. Using Vim scripts *using-scripts*
|
|
|
141
|
|
|
142 For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
|
|
|
143
|
|
|
144 *:so* *:source* *load-vim-script*
|
|
|
145 :so[urce] {file} Read Ex commands from {file}. These are commands that
|
|
|
146 start with a ":".
|
|
|
147
|
|
|
148 :so[urce]! {file} Read Vim commands from {file}. These are commands
|
|
|
149 that are executed from Normal mode, like you type
|
|
|
150 them.
|
|
|
151 When used after |:global|, |:argdo|, |:windo|,
|
|
|
152 |:bufdo|, in a loop or when another command follows
|
|
|
153 the display won't be updated while executing the
|
|
|
154 commands.
|
|
|
155 {not in Vi}
|
|
|
156
|
|
|
157 *:ru* *:runtime*
|
|
|
158 :ru[ntime][!] {file} ..
|
|
|
159 Read Ex commands from {file} in each directory given
|
|
|
160 by 'runtimepath'. There is no error for non-existing
|
|
|
161 files. Example: >
|
|
|
162 :runtime syntax/c.vim
|
|
|
163
|
|
|
164 < There can be multiple {file} arguments, separated by
|
|
|
165 spaces. Each {file} is searched for in the first
|
|
|
166 directory from 'runtimepath', then in the second
|
|
|
167 directory, etc. Use a backslash to include a space
|
|
|
168 inside {file} (although it's better not to use spaces
|
|
|
169 in file names, it causes trouble).
|
|
|
170
|
|
|
171 When [!] is included, all found files are sourced.
|
|
|
172 When it is not included only the first found file is
|
|
|
173 sourced.
|
|
|
174
|
|
|
175 When {file} contains wildcards it is expanded to all
|
|
|
176 matching files. Example: >
|
|
|
177 :runtime! plugin/*.vim
|
|
|
178 < This is what Vim uses to load the plugin files when
|
|
237
|
179 starting up. This similar command: >
|
|
7
|
180 :runtime plugin/*.vim
|
|
|
181 < would source the first file only.
|
|
|
182
|
|
|
183 When 'verbose' is one or higher, there is a message
|
|
|
184 when no file could be found.
|
|
|
185 When 'verbose' is two or higher, there is a message
|
|
|
186 about each searched file.
|
|
|
187 {not in Vi}
|
|
|
188
|
|
|
189 :scripte[ncoding] [encoding] *:scripte* *:scriptencoding* *E167*
|
|
|
190 Specify the character encoding used in the script.
|
|
|
191 The following lines will be converted from [encoding]
|
|
|
192 to the value of the 'encoding' option, if they are
|
|
|
193 different. Examples: >
|
|
|
194 scriptencoding iso-8859-5
|
|
|
195 scriptencoding cp932
|
|
|
196 <
|
|
|
197 When [encoding] is empty, no conversion is done. This
|
|
|
198 can be used to restrict conversion to a sequence of
|
|
|
199 lines: >
|
|
|
200 scriptencoding euc-jp
|
|
|
201 ... lines to be converted ...
|
|
|
202 scriptencoding
|
|
|
203 ... not converted ...
|
|
|
204
|
|
|
205 < When conversion isn't supported by the system, there
|
|
|
206 is no error message and no conversion is done.
|
|
|
207
|
|
|
208 Don't use "ucs-2" or "ucs-4", scripts cannot be in
|
|
|
209 these encodings (they would contain NUL bytes).
|
|
|
210 When a sourced script starts with a BOM (Byte Order
|
|
|
211 Mark) in utf-8 format Vim will recognized it, no need
|
|
|
212 to use ":scriptencoding utf-8" then.
|
|
|
213
|
|
|
214 When compiled without the |+multi_byte| feature this
|
|
|
215 command is ignored.
|
|
|
216 {not in Vi}
|
|
|
217
|
|
|
218 *:scrip* *:scriptnames*
|
|
|
219 :scrip[tnames] List all sourced script names, in the order they were
|
|
|
220 first sourced. The number is used for the script ID
|
|
|
221 |<SID>|.
|
|
|
222 {not in Vi} {not available when compiled without the
|
|
|
223 |+eval| feature}
|
|
|
224
|
|
|
225 *:fini* *:finish* *E168*
|
|
|
226 :fini[sh] Stop sourcing a script. Can only be used in a Vim
|
|
|
227 script file. This is a quick way to skip the rest of
|
|
|
228 the file. If it is used after a |:try| but before the
|
|
|
229 matching |:finally| (if present), the commands
|
|
|
230 following the ":finally" up to the matching |:endtry|
|
|
|
231 are executed first. This process applies to all
|
|
|
232 nested ":try"s in the script. The outermost ":endtry"
|
|
|
233 then stops sourcing the script. {not in Vi}
|
|
|
234
|
|
|
235 All commands and command sequences can be repeated by putting them in a named
|
|
|
236 register and then executing it. There are two ways to get the commands in the
|
|
|
237 register:
|
|
|
238 - Use the record command "q". You type the commands once, and while they are
|
|
|
239 being executed they are stored in a register. Easy, because you can see
|
|
|
240 what you are doing. If you make a mistake, "p"ut the register into the
|
|
|
241 file, edit the command sequence, and then delete it into the register
|
|
|
242 again. You can continue recording by appending to the register (use an
|
|
|
243 uppercase letter).
|
|
|
244 - Delete or yank the command sequence into the register.
|
|
|
245
|
|
|
246 Often used command sequences can be put under a function key with the ':map'
|
|
|
247 command.
|
|
|
248
|
|
|
249 An alternative is to put the commands in a file, and execute them with the
|
|
|
250 ':source!' command. Useful for long command sequences. Can be combined with
|
|
|
251 the ':map' command to put complicated commands under a function key.
|
|
|
252
|
|
|
253 The ':source' command reads Ex commands from a file line by line. You will
|
|
|
254 have to type any needed keyboard input. The ':source!' command reads from a
|
|
|
255 script file character by character, interpreting each character as if you
|
|
|
256 typed it.
|
|
|
257
|
|
|
258 Example: When you give the ":!ls" command you get the |hit-enter| prompt. If
|
|
|
259 you ':source' a file with the line "!ls" in it, you will have to type the
|
|
|
260 <Enter> yourself. But if you ':source!' a file with the line ":!ls" in it,
|
|
|
261 the next characters from that file are read until a <CR> is found. You will
|
|
|
262 not have to type <CR> yourself, unless ":!ls" was the last line in the file.
|
|
|
263
|
|
|
264 It is possible to put ':source[!]' commands in the script file, so you can
|
|
|
265 make a top-down hierarchy of script files. The ':source' command can be
|
|
|
266 nested as deep as the number of files that can be opened at one time (about
|
|
|
267 15). The ':source!' command can be nested up to 15 levels deep.
|
|
|
268
|
|
|
269 You can use the "<sfile>" string (literally, this is not a special key) inside
|
|
|
270 of the sourced file, in places where a file name is expected. It will be
|
|
|
271 replaced by the file name of the sourced file. For example, if you have a
|
|
|
272 "other.vimrc" file in the same directory as your ".vimrc" file, you can source
|
|
|
273 it from your ".vimrc" file with this command: >
|
|
|
274 :source <sfile>:h/other.vimrc
|
|
|
275
|
|
|
276 In script files terminal-dependent key codes are represented by
|
|
|
277 terminal-independent two character codes. This means that they can be used
|
|
|
278 in the same way on different kinds of terminals. The first character of a
|
|
|
279 key code is 0x80 or 128, shown on the screen as "~@". The second one can be
|
|
|
280 found in the list |key-notation|. Any of these codes can also be entered
|
|
|
281 with CTRL-V followed by the three digit decimal code. This does NOT work for
|
|
|
282 the <t_xx> termcap codes, these can only be used in mappings.
|
|
|
283
|
|
|
284 *:source_crnl* *W15*
|
|
|
285 MS-DOS, Win32 and OS/2: Files that are read with ":source" normally have
|
|
|
286 <CR><NL> <EOL>s. These always work. If you are using a file with <NL> <EOL>s
|
|
|
287 (for example, a file made on Unix), this will be recognized if 'fileformats'
|
|
|
288 is not empty and the first line does not end in a <CR>. This fails if the
|
|
|
289 first line has something like ":map <F1> :help^M", where "^M" is a <CR>. If
|
|
|
290 the first line ends in a <CR>, but following ones don't, you will get an error
|
|
|
291 message, because the <CR> from the first lines will be lost.
|
|
|
292
|
|
|
293 Macintosh: Files that are read with ":source" normally have <CR> <EOL>s.
|
|
|
294 These always work. If you are using a file with <NL> <EOL>s (for example, a
|
|
|
295 file made on Unix), this will be recognized if 'fileformats' is not empty and
|
|
|
296 the first line does not end in a <CR>. Be careful not to use a file with <NL>
|
|
|
297 linebreaks which has a <CR> in first line.
|
|
|
298
|
|
|
299 On other systems, Vim expects ":source"ed files to end in a <NL>. These
|
|
|
300 always work. If you are using a file with <CR><NL> <EOL>s (for example, a
|
|
|
301 file made on MS-DOS), all lines will have a trailing <CR>. This may cause
|
|
|
302 problems for some commands (e.g., mappings). There is no automatic <EOL>
|
|
|
303 detection, because it's common to start with a line that defines a mapping
|
|
|
304 that ends in a <CR>, which will confuse the automaton.
|
|
|
305
|
|
|
306 *line-continuation*
|
|
|
307 Long lines in a ":source"d Ex command script file can be split by inserting
|
|
|
308 a line continuation symbol "\" (backslash) at the start of the next line.
|
|
|
309 There can be white space before the backslash, which is ignored.
|
|
|
310
|
|
|
311 Example: the lines >
|
|
|
312 :set comments=sr:/*,mb:*,el:*/,
|
|
|
313 \://,
|
|
|
314 \b:#,
|
|
|
315 \:%,
|
|
|
316 \n:>,
|
|
|
317 \fb:-
|
|
|
318 are interpreted as if they were given in one line:
|
|
|
319 :set comments=sr:/*,mb:*,el:*/,://,b:#,:%,n:>,fb:-
|
|
|
320
|
|
|
321 All leading whitespace characters in the line before a backslash are ignored.
|
|
|
322 Note however that trailing whitespace in the line before it cannot be
|
|
|
323 inserted freely; it depends on the position where a command is split up
|
|
|
324 whether additional whitespace is allowed or not.
|
|
|
325
|
|
|
326 There is a problem with the ":append" and ":insert" commands: >
|
|
|
327 :1append
|
|
|
328 \asdf
|
|
|
329 .
|
|
|
330 The backslash is seen as a line-continuation symbol, thus this results in the
|
|
|
331 command: >
|
|
|
332 :1appendasdf
|
|
|
333 .
|
|
|
334 To avoid this, add the 'C' flag to the 'cpoptions' option: >
|
|
|
335 :set cpo+=C
|
|
|
336 :1append
|
|
|
337 \asdf
|
|
|
338 .
|
|
|
339 :set cpo-=C
|
|
|
340
|
|
|
341 Note that when the commands are inside a function, you need to add the 'C'
|
|
|
342 flag when defining the function, it is not relevant when executing it. >
|
|
|
343 :set cpo+=C
|
|
|
344 :function Foo()
|
|
|
345 :1append
|
|
|
346 \asdf
|
|
|
347 .
|
|
|
348 :endfunction
|
|
|
349 :set cpo-=C
|
|
|
350
|
|
|
351 Rationale:
|
|
|
352 Most programs work with a trailing backslash to indicate line
|
|
|
353 continuation. Using this in Vim would cause incompatibility with Vi.
|
|
|
354 For example for this Vi mapping: >
|
|
|
355 :map xx asdf\
|
|
|
356 < Therefore the unusual leading backslash is used.
|
|
|
357
|
|
|
358 ==============================================================================
|
|
|
359 5. Debugging scripts *debug-scripts*
|
|
|
360
|
|
|
361 Besides the obvious messages that you can add to your scripts to find out what
|
|
|
362 they are doing, Vim offers a debug mode. This allows you to step through a
|
|
|
363 sourced file or user function and set breakpoints.
|
|
|
364
|
|
|
365 NOTE: The debugging mode is far from perfect. Debugging will have side
|
|
|
366 effects on how Vim works. You cannot use it to debug everything. For
|
|
|
367 example, the display is messed up by the debugging messages.
|
|
|
368 {Vi does not have a debug mode}
|
|
|
369
|
|
|
370 An alternative to debug mode is setting the 'verbose' option. With a bigger
|
|
|
371 number it will give more verbose messages about what Vim is doing.
|
|
|
372
|
|
|
373
|
|
|
374 STARTING DEBUG MODE *debug-mode*
|
|
|
375
|
|
|
376 To enter debugging mode use one of these methods:
|
|
|
377 1. Start Vim with the |-D| argument: >
|
|
|
378 vim -D file.txt
|
|
|
379 < Debugging will start as soon as the first vimrc file is sourced. This is
|
|
|
380 useful to find out what is happening when Vim is starting up. A side
|
|
|
381 effect is that Vim will switch the terminal mode before initialisations
|
|
|
382 have finished, with unpredictable results.
|
|
|
383 For a GUI-only version (Windows, Macintosh) the debugging will start as
|
|
|
384 soon as the GUI window has been opened. To make this happen early, add a
|
|
|
385 ":gui" command in the vimrc file.
|
|
|
386 *:debug*
|
|
|
387 2. Run a command with ":debug" prepended. Debugging will only be done while
|
|
|
388 this command executes. Useful for debugging a specific script or user
|
|
|
389 function. And for scripts and functions used by autocommands. Example: >
|
|
|
390 :debug edit test.txt.gz
|
|
|
391
|
|
|
392 3. Set a breakpoint in a sourced file or user function. You could do this in
|
|
|
393 the command line: >
|
|
|
394 vim -c "breakadd file */explorer.vim" .
|
|
|
395 < This will run Vim and stop in the first line of the "explorer.vim" script.
|
|
|
396 Breakpoints can also be set while in debugging mode.
|
|
|
397
|
|
|
398 In debugging mode every executed command is displayed before it is executed.
|
|
|
399 Comment lines, empty lines and lines that are not executed are skipped. When
|
|
|
400 a line contains two commands, separated by "|", each command will be displayed
|
|
|
401 separately.
|
|
|
402
|
|
|
403
|
|
|
404 DEBUG MODE
|
|
|
405
|
|
|
406 Once in debugging mode, the usual Ex commands can be used. For example, to
|
|
|
407 inspect the value of a variable: >
|
|
|
408 echo idx
|
|
|
409 When inside a user function, this will print the value of the local variable
|
|
|
410 "idx". Prepend "g:" to get the value of a global variable: >
|
|
|
411 echo g:idx
|
|
|
412 All commands are executed in the context of the current function or script.
|
|
|
413 You can also set options, for example setting or resetting 'verbose' will show
|
|
|
414 what happens, but you might want to set it just before executing the lines you
|
|
|
415 are interested in: >
|
|
|
416 :set verbose=20
|
|
|
417
|
|
|
418 Commands that require updating the screen should be avoided, because their
|
|
|
419 effect won't be noticed until after leaving debug mode. For example: >
|
|
|
420 :help
|
|
|
421 won't be very helpful.
|
|
|
422
|
|
|
423 There is a separate command-line history for debug mode.
|
|
|
424
|
|
|
425 The line number for a function line is relative to the start of the function.
|
|
|
426 If you have trouble figuring out where you are, edit the file that defines
|
|
|
427 the function in another Vim, search for the start of the function and do
|
|
|
428 "99j". Replace "99" with the line number.
|
|
|
429
|
|
|
430 Additionally, these commands can be used:
|
|
|
431 *>cont*
|
|
|
432 cont Continue execution until the next breakpoint is hit.
|
|
|
433 *>quit*
|
|
|
434 quit Abort execution. This is like using CTRL-C, some
|
|
|
435 things might still be executed, doesn't abort
|
|
|
436 everything. Still stops at the next breakpoint.
|
|
|
437 *>next*
|
|
|
438 next Execute the command and come back to debug mode when
|
|
|
439 it's finished. This steps over user function calls
|
|
|
440 and sourced files.
|
|
|
441 *>step*
|
|
|
442 step Execute the command and come back to debug mode for
|
|
|
443 the next command. This steps into called user
|
|
|
444 functions and sourced files.
|
|
|
445 *>interrupt*
|
|
|
446 interrupt This is like using CTRL-C, but unlike ">quit" comes
|
|
|
447 back to debug mode for the next command that is
|
|
|
448 executed. Useful for testing |:finally| and |:catch|
|
|
|
449 on interrupt exceptions.
|
|
|
450 *>finish*
|
|
|
451 finish Finish the current script or user function and come
|
|
|
452 back to debug mode for the command after the one that
|
|
|
453 sourced or called it.
|
|
|
454
|
|
|
455 About the additional commands in debug mode:
|
|
|
456 - There is no command-line completion for them, you get the completion for the
|
|
|
457 normal Ex commands only.
|
|
|
458 - You can shorten them, up to a single character: "c", "n", "s" and "f".
|
|
|
459 - Hitting <CR> will repeat the previous one. When doing another command, this
|
|
|
460 is reset (because it's not clear what you want to repeat).
|
|
|
461 - When you want to use the Ex command with the same name, prepend a colon:
|
|
|
462 ":cont", ":next", ":finish" (or shorter).
|
|
|
463
|
|
|
464
|
|
|
465 DEFINING BREAKPOINTS
|
|
|
466 *:breaka* *:breakadd*
|
|
|
467 :breaka[dd] func [lnum] {name}
|
|
|
468 Set a breakpoint in a function. Example: >
|
|
|
469 :breakadd func Explore
|
|
|
470 < Doesn't check for a valid function name, thus the breakpoint
|
|
|
471 can be set before the function is defined.
|
|
|
472
|
|
|
473 :breaka[dd] file [lnum] {name}
|
|
|
474 Set a breakpoint in a sourced file. Example: >
|
|
|
475 :breakadd file 43 .vimrc
|
|
|
476
|
|
10
|
477 :breaka[dd] here
|
|
|
478 Set a breakpoint in the current line of the current file.
|
|
|
479 Like doing: >
|
|
|
480 :breakadd file <cursor-line> <current-file>
|
|
|
481 < Note that this only works for commands that are executed when
|
|
|
482 sourcing the file, not for a function defined in that file.
|
|
|
483
|
|
7
|
484 The [lnum] is the line number of the breakpoint. Vim will stop at or after
|
|
|
485 this line. When omitted line 1 is used.
|
|
|
486
|
|
170
|
487 *:debug-name*
|
|
7
|
488 {name} is a pattern that is matched with the file or function name. The
|
|
|
489 pattern is like what is used for autocommands. There must be a full match (as
|
|
|
490 if the pattern starts with "^" and ends in "$"). A "*" matches any sequence
|
|
|
491 of characters. 'ignorecase' is not used, but "\c" can be used in the pattern
|
|
|
492 to ignore case |/\c|. Don't include the () for the function name!
|
|
|
493
|
|
11
|
494 The match for sourced scripts is done against the full file name. If no path
|
|
|
495 is specified the current directory is used. Examples: >
|
|
|
496 breakadd file explorer.vim
|
|
|
497 matches "explorer.vim" in the current directory. >
|
|
7
|
498 breakadd file *explorer.vim
|
|
11
|
499 matches ".../plugin/explorer.vim", ".../plugin/iexplorer.vim", etc. >
|
|
7
|
500 breakadd file */explorer.vim
|
|
11
|
501 matches ".../plugin/explorer.vim" and "explorer.vim" in any other directory.
|
|
7
|
502
|
|
|
503 The match for functions is done against the name as it's shown in the output
|
|
|
504 of ":function". For local functions this means that something like "<SNR>99_"
|
|
|
505 is prepended.
|
|
|
506
|
|
148
|
507 Note that functions are first loaded and later executed. When they are loaded
|
|
|
508 the "file" breakpoints are checked, when they are executed the "func"
|
|
|
509 breakpoints.
|
|
|
510
|
|
7
|
511
|
|
|
512 DELETING BREAKPOINTS
|
|
|
513 *:breakd* *:breakdel* *E161*
|
|
|
514 :breakd[el] {nr}
|
|
|
515 Delete breakpoint {nr}. Use |:breaklist| to see the number of
|
|
|
516 each breakpoint.
|
|
|
517
|
|
|
518 :breakd[el] func [lnum] {name}
|
|
|
519 Delete a breakpoint in a function.
|
|
|
520
|
|
|
521 :breakd[el] file [lnum] {name}
|
|
|
522 Delete a breakpoint in a sourced file.
|
|
|
523
|
|
10
|
524 :breakd[el] here
|
|
|
525 Delete a breakpoint at the current line of the current file.
|
|
|
526
|
|
7
|
527 When [lnum] is omitted, the first breakpoint in the function or file is
|
|
|
528 deleted.
|
|
|
529 The {name} must be exactly the same as what was typed for the ":breakadd"
|
|
|
530 command. "explorer", "*explorer.vim" and "*explorer*" are different.
|
|
|
531
|
|
|
532
|
|
|
533 LISTING BREAKPOINTS
|
|
|
534 *:breakl* *:breaklist*
|
|
|
535 :breakl[ist]
|
|
|
536 List all breakpoints.
|
|
|
537
|
|
|
538
|
|
|
539 OBSCURE
|
|
|
540
|
|
|
541 *:debugg* *:debuggreedy*
|
|
|
542 :debugg[reedy]
|
|
|
543 Read debug mode commands from the normal input stream, instead
|
|
|
544 of getting them directly from the user. Only useful for test
|
|
|
545 scripts. Example: >
|
|
|
546 echo 'q^Mq' | vim -e -s -c debuggreedy -c 'breakadd file script.vim' -S script.vim
|
|
|
547
|
|
|
548 :0debugg[reedy]
|
|
|
549 Undo ":debuggreedy": get debug mode commands directly from the
|
|
|
550 user, don't use typeahead for debug commands.
|
|
|
551
|
|
170
|
552 ==============================================================================
|
|
|
553 6. Profiling *profile* *profiling*
|
|
|
554
|
|
|
555 Profiling means that Vim measures the time that is spend on executing
|
|
|
556 functions and/or scripts. The |+profile| feature is required for this.
|
|
|
557 It is only included when Vim was compiled with "huge" features.
|
|
|
558 {Vi does not have profiling}
|
|
|
559
|
|
|
560 :prof[ile] start {fname} *:prof* *:profile* *E750*
|
|
|
561 Start profiling, write the output in {fname} upon exit.
|
|
|
562 If {fname} already exists it will be overwritten.
|
|
|
563 The variable |v:profiling| is set to one.
|
|
|
564
|
|
|
565 :prof[ile] func {pattern}
|
|
|
566 Profile function that matches the pattern {pattern}.
|
|
|
567 See |:debug-name| for how {pattern} is used.
|
|
|
568
|
|
|
569 :prof[ile][!] file {pattern}
|
|
|
570 Profile script file that matches the pattern {pattern}.
|
|
|
571 See |:debug-name| for how {pattern} is used.
|
|
|
572 This only profiles the script itself, not the functions
|
|
|
573 defined in it.
|
|
|
574 When the [!] is added then all functions defined in the script
|
|
177
|
575 will also be profiled. But only if the script is loaded after
|
|
|
576 this command.
|
|
170
|
577
|
|
|
578
|
|
|
579 You must always start with a ":profile start fname" command. The resulting
|
|
|
580 file is written when Vim exits. Here is an example of the output, with line
|
|
|
581 numbers prepended for the explanation:
|
|
|
582
|
|
|
583 1 FUNCTION Test2() ~
|
|
|
584 2 Called 1 time ~
|
|
|
585 3 Total time: 0.155251 ~
|
|
|
586 4 Self time: 0.002006 ~
|
|
|
587 5 ~
|
|
|
588 6 count total (s) self (s) ~
|
|
|
589 7 9 0.000096 for i in range(8) ~
|
|
|
590 8 8 0.153655 0.000410 call Test3() ~
|
|
|
591 9 8 0.000070 endfor ~
|
|
|
592 10 " Ask a question ~
|
|
|
593 11 1 0.001341 echo input("give me an answer: ") ~
|
|
|
594
|
|
|
595 The header (lines 1-4) gives the time for the whole function. The "Total"
|
|
|
596 time is the time passed while the function was executing. The "Self" time is
|
|
|
597 the "Total" time reduced by time spent in:
|
|
|
598 - other user defined functions
|
|
|
599 - sourced scripts
|
|
|
600 - executed autocommands
|
|
|
601 - external (shell) commands
|
|
|
602
|
|
|
603 Lines 7-11 show the time spent in each executed line. Lines that are not
|
|
|
604 executed do not count. Thus a comment line is never counted.
|
|
|
605
|
|
|
606 The Count column shows how many times a line was executed. Note that the
|
|
|
607 "for" command in line 7 is executed one more time as the following lines.
|
|
|
608 That is because the line is also executed to detect the end of the loop.
|
|
|
609
|
|
|
610 The time Vim spends waiting for user input isn't counted at all. Thus how
|
|
|
611 long you take to respond to the input() prompt is irrelevant.
|
|
|
612
|
|
|
613 Profiling should give a good indication of where time is spent, but keep in
|
|
|
614 mind there are various things that may clobber the results:
|
|
|
615
|
|
|
616 - The accuracy of the time measured depends on the gettimeofday() system
|
|
|
617 function. It may only be as accurate as 1/100 second, even though the times
|
|
|
618 are displayed in micro seconds.
|
|
|
619
|
|
|
620 - Real elapsed time is measured, if other processes are busy they may cause
|
|
|
621 delays at unpredictable moments. You may want to run the profiling several
|
|
|
622 times and use the lowest results.
|
|
|
623
|
|
|
624 - If you have several commands in one line you only get one time. Split the
|
|
|
625 line to see the time for the individual commands.
|
|
|
626
|
|
|
627 - The time of the lines added up is mostly less than the time of the whole
|
|
|
628 function. There is some overhead in between.
|
|
|
629
|
|
|
630 - Functions that are deleted before Vim exits will not produce profiling
|
|
|
631 information. You can check the |v:profiling| variable if needed: >
|
|
|
632 :if !v:profiling
|
|
|
633 : delfunc MyFunc
|
|
|
634 :endif
|
|
|
635 <
|
|
177
|
636 - Profiling may give weird results on multi-processor systems, when sleep
|
|
|
637 mode kicks in or the processor frequency is reduced to save power.
|
|
170
|
638
|
|
7
|
639 vim:tw=78:ts=8:ft=help:norl:
|
