blob: 64b1fbfc2266c932acb41ec46d31036b4c1b444f [file] [log] [blame]
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001*motion.txt* For Vim version 8.1. Last change: 2019 May 07
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Cursor motions *cursor-motions* *navigation*
8
9These commands move the cursor position. If the new position is off of the
10screen, the screen is scrolled to show the cursor (see also 'scrolljump' and
11'scrolloff' options).
12
131. Motions and operators |operator|
142. Left-right motions |left-right-motions|
153. Up-down motions |up-down-motions|
164. Word motions |word-motions|
175. Text object motions |object-motions|
186. Text object selection |object-select|
197. Marks |mark-motions|
208. Jumps |jump-motions|
219. Various motions |various-motions|
22
23General remarks:
24
25If you want to know where you are in the file use the "CTRL-G" command
26|CTRL-G| or the "g CTRL-G" command |g_CTRL-G|. If you set the 'ruler' option,
27the cursor position is continuously shown in the status line (which slows down
28Vim a little).
29
30Experienced users prefer the hjkl keys because they are always right under
31their fingers. Beginners often prefer the arrow keys, because they do not
32know what the hjkl keys do. The mnemonic value of hjkl is clear from looking
33at the keyboard. Think of j as an arrow pointing downwards.
34
35The 'virtualedit' option can be set to make it possible to move the cursor to
36positions where there is no character or halfway a character.
37
38==============================================================================
391. Motions and operators *operator*
40
41The motion commands can be used after an operator command, to have the command
42operate on the text that was moved over. That is the text between the cursor
43position before and after the motion. Operators are generally used to delete
44or change text. The following operators are available:
45
46 |c| c change
47 |d| d delete
48 |y| y yank into register (does not change the text)
49 |~| ~ swap case (only if 'tildeop' is set)
50 |g~| g~ swap case
51 |gu| gu make lowercase
52 |gU| gU make uppercase
53 |!| ! filter through an external program
54 |=| = filter through 'equalprg' or C-indenting if empty
55 |gq| gq text formatting
56 |g?| g? ROT13 encoding
57 |>| > shift right
58 |<| < shift left
59 |zf| zf define a fold
Bram Moolenaar6c35bea2012-07-25 17:49:10 +020060 |g@| g@ call function set with the 'operatorfunc' option
Bram Moolenaar071d4272004-06-13 20:20:40 +000061
62If the motion includes a count and the operator also had a count before it,
63the two counts are multiplied. For example: "2d3w" deletes six words.
64
65After applying the operator the cursor is mostly left at the start of the text
66that was operated upon. For example, "yfe" doesn't move the cursor, but "yFe"
67moves the cursor leftwards to the "e" where the yank started.
68
69 *linewise* *characterwise*
70The operator either affects whole lines, or the characters between the start
71and end position. Generally, motions that move between lines affect lines
72(are linewise), and motions that move within a line affect characters (are
73characterwise). However, there are some exceptions.
74
75 *exclusive* *inclusive*
Bram Moolenaar78984f52005-08-01 07:19:10 +000076A character motion is either inclusive or exclusive. When inclusive, the
77start and end position of the motion are included in the operation. When
78exclusive, the last character towards the end of the buffer is not included.
79Linewise motions always include the start and end position.
Bram Moolenaar071d4272004-06-13 20:20:40 +000080
Bram Moolenaar78984f52005-08-01 07:19:10 +000081Which motions are linewise, inclusive or exclusive is mentioned with the
82command. There are however, two general exceptions:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831. If the motion is exclusive and the end of the motion is in column 1, the
84 end of the motion is moved to the end of the previous line and the motion
85 becomes inclusive. Example: "}" moves to the first line after a paragraph,
86 but "d}" will not include that line.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000087 *exclusive-linewise*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882. If the motion is exclusive, the end of the motion is in column 1 and the
89 start of the motion was at or before the first non-blank in the line, the
90 motion becomes linewise. Example: If a paragraph begins with some blanks
91 and you do "d}" while standing on the first non-blank, all the lines of
92 the paragraph are deleted, including the blanks. If you do a put now, the
93 deleted lines will be inserted below the cursor position.
94
95Note that when the operator is pending (the operator command is typed, but the
96motion isn't yet), a special set of mappings can be used. See |:omap|.
97
98Instead of first giving the operator and then a motion you can use Visual
99mode: mark the start of the text with "v", move the cursor to the end of the
100text that is to be affected and then hit the operator. The text between the
101start and the cursor position is highlighted, so you can see what text will
102be operated upon. This allows much more freedom, but requires more key
103strokes and has limited redo functionality. See the chapter on Visual mode
104|Visual-mode|.
105
106You can use a ":" command for a motion. For example "d:call FindEnd()".
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100107But this can't be repeated with "." if the command is more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108This can be repeated: >
109 d:call search("f")<CR>
110This cannot be repeated: >
111 d:if 1<CR>
112 call search("f")<CR>
113 endif<CR>
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100114Note that when using ":" any motion becomes characterwise exclusive.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100116 *forced-motion*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117FORCING A MOTION TO BE LINEWISE, CHARACTERWISE OR BLOCKWISE
118
119When a motion is not of the type you would like to use, you can force another
120type by using "v", "V" or CTRL-V just after the operator.
121Example: >
122 dj
123deletes two lines >
124 dvj
125deletes from the cursor position until the character below the cursor >
126 d<C-V>j
127deletes the character under the cursor and the character below the cursor. >
128
129Be careful with forcing a linewise movement to be used characterwise or
130blockwise, the column may not always be defined.
131
132 *o_v*
133v When used after an operator, before the motion command: Force
134 the operator to work characterwise, also when the motion is
135 linewise. If the motion was linewise, it will become
136 |exclusive|.
137 If the motion already was characterwise, toggle
138 inclusive/exclusive. This can be used to make an exclusive
139 motion inclusive and an inclusive motion exclusive.
140
141 *o_V*
142V When used after an operator, before the motion command: Force
143 the operator to work linewise, also when the motion is
144 characterwise.
145
146 *o_CTRL-V*
147CTRL-V When used after an operator, before the motion command: Force
148 the operator to work blockwise. This works like Visual block
149 mode selection, with the corners defined by the cursor
150 position before and after the motion.
151
152==============================================================================
1532. Left-right motions *left-right-motions*
154
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100155These commands move the cursor to the specified column in the current line.
156They stop at the first column and at the end of the line, except "$", which
157may move to one of the next lines. See 'whichwrap' option to make some of the
158commands move across line boundaries.
159
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160h or *h*
161<Left> or *<Left>*
162CTRL-H or *CTRL-H* *<BS>*
163<BS> [count] characters to the left. |exclusive| motion.
164 Note: If you prefer <BS> to delete a character, use
165 the mapping:
166 :map CTRL-V<BS> X
167 (to enter "CTRL-V<BS>" type the CTRL-V key, followed
168 by the <BS> key)
169 See |:fixdel| if the <BS> key does not do what you
170 want.
171
172l or *l*
173<Right> or *<Right>* *<Space>*
174<Space> [count] characters to the right. |exclusive| motion.
Bram Moolenaarf2571c62015-06-09 19:44:55 +0200175 See the 'whichwrap' option for adjusting the behavior
176 at end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177
178 *0*
1790 To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000180 motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181
182 *<Home>* *<kHome>*
183<Home> To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000184 motion. When moving up or down next, stay in same
185 TEXT column (if possible). Most other commands stay
186 in the same SCREEN column. <Home> works like "1|",
187 which differs from "0" when the line starts with a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200188 <Tab>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189
190 *^*
191^ To the first non-blank character of the line.
192 |exclusive| motion.
193
194 *$* *<End>* *<kEnd>*
195$ or <End> To the end of the line. When a count is given also go
Bram Moolenaar036986f2017-03-16 17:41:02 +0100196 [count - 1] lines downward. |inclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 In Visual mode the cursor goes to just after the last
198 character in the line.
199 When 'virtualedit' is active, "$" may move the cursor
200 back from past the end of the line to the last
201 character in the line.
202
203 *g_*
204g_ To the last non-blank character of the line and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200205 [count - 1] lines downward |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206
207 *g0* *g<Home>*
208g0 or g<Home> When lines wrap ('wrap' on): To the first character of
209 the screen line. |exclusive| motion. Differs from
210 "0" when a line is wider than the screen.
211 When lines don't wrap ('wrap' off): To the leftmost
212 character of the current line that is on the screen.
213 Differs from "0" when the first character of the line
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200214 is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215
216 *g^*
217g^ When lines wrap ('wrap' on): To the first non-blank
218 character of the screen line. |exclusive| motion.
219 Differs from "^" when a line is wider than the screen.
220 When lines don't wrap ('wrap' off): To the leftmost
221 non-blank character of the current line that is on the
222 screen. Differs from "^" when the first non-blank
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200223 character of the line is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224
225 *gm*
226gm Like "g0", but half a screenwidth to the right (or as
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200227 much as possible).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228
229 *g$* *g<End>*
230g$ or g<End> When lines wrap ('wrap' on): To the last character of
231 the screen line and [count - 1] screen lines downward
232 |inclusive|. Differs from "$" when a line is wider
233 than the screen.
234 When lines don't wrap ('wrap' off): To the rightmost
235 character of the current line that is visible on the
236 screen. Differs from "$" when the last character of
237 the line is not on the screen or when a count is used.
238 Additionally, vertical movements keep the column,
239 instead of going to the end of the line.
Bram Moolenaar9ba7e172013-07-17 22:37:26 +0200240 When 'virtualedit' is enabled moves to the end of the
241 screen line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242
243 *bar*
244| To screen column [count] in the current line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100245 |exclusive| motion. Ceci n'est pas une pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246
247 *f*
248f{char} To [count]'th occurrence of {char} to the right. The
249 cursor is placed on {char} |inclusive|.
250 {char} can be entered as a digraph |digraph-arg|.
251 When 'encoding' is set to Unicode, composing
252 characters may be used, see |utf-8-char-arg|.
253 |:lmap| mappings apply to {char}. The CTRL-^ command
254 in Insert mode can be used to switch this on/off
255 |i_CTRL-^|.
256
257 *F*
258F{char} To the [count]'th occurrence of {char} to the left.
Bram Moolenaar78984f52005-08-01 07:19:10 +0000259 The cursor is placed on {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 {char} can be entered like with the |f| command.
261
262 *t*
263t{char} Till before [count]'th occurrence of {char} to the
264 right. The cursor is placed on the character left of
265 {char} |inclusive|.
266 {char} can be entered like with the |f| command.
267
268 *T*
269T{char} Till after [count]'th occurrence of {char} to the
270 left. The cursor is placed on the character right of
Bram Moolenaar78984f52005-08-01 07:19:10 +0000271 {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000272 {char} can be entered like with the |f| command.
273
274 *;*
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200275; Repeat latest f, t, F or T [count] times. See |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276
277 *,*
278, Repeat latest f, t, F or T in opposite direction
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200279 [count] times. See also |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281==============================================================================
2823. Up-down motions *up-down-motions*
283
284k or *k*
285<Up> or *<Up>* *CTRL-P*
286CTRL-P [count] lines upward |linewise|.
287
288j or *j*
289<Down> or *<Down>*
290CTRL-J or *CTRL-J*
291<NL> or *<NL>* *CTRL-N*
292CTRL-N [count] lines downward |linewise|.
293
294gk or *gk* *g<Up>*
295g<Up> [count] display lines upward. |exclusive| motion.
296 Differs from 'k' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200297 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298
299gj or *gj* *g<Down>*
300g<Down> [count] display lines downward. |exclusive| motion.
301 Differs from 'j' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200302 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304 *-*
305- <minus> [count] lines upward, on the first non-blank
306 character |linewise|.
307
308+ or *+*
309CTRL-M or *CTRL-M* *<CR>*
310<CR> [count] lines downward, on the first non-blank
311 character |linewise|.
312
313 *_*
314_ <underscore> [count] - 1 lines downward, on the first non-blank
315 character |linewise|.
316
317 *G*
318G Goto line [count], default last line, on the first
319 non-blank character |linewise|. If 'startofline' not
320 set, keep the same column.
Bram Moolenaar26967612019-03-17 17:13:16 +0100321 G is one of the |jump-motions|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
323 *<C-End>*
324<C-End> Goto line [count], default last line, on the last
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200325 character |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326
327<C-Home> or *gg* *<C-Home>*
328gg Goto line [count], default first line, on the first
329 non-blank character |linewise|. If 'startofline' not
330 set, keep the same column.
331
Bram Moolenaar9b451252012-08-15 17:43:31 +0200332 *:[range]*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100333:[range] Set the cursor on the last line number in [range].
334 [range] can also be just one line number, e.g., ":1"
335 or ":'m".
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200336 In contrast with |G| this command does not modify the
337 |jumplist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338 *N%*
339{count}% Go to {count} percentage in the file, on the first
340 non-blank in the line |linewise|. To compute the new
341 line number this formula is used:
342 ({count} * number-of-lines + 99) / 100
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200343 See also 'startofline' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344
345:[range]go[to] [count] *:go* *:goto* *go*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100346[count]go Go to [count] byte in the buffer. Default [count] is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347 one, start of the file. When giving [range], the
348 last number in it used as the byte count. End-of-line
349 characters are counted depending on the current
350 'fileformat' setting.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200351 Also see the |line2byte()| function, and the 'o'
352 option in 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 {not available when compiled without the
354 |+byte_offset| feature}
355
356These commands move to the specified line. They stop when reaching the first
357or the last line. The first two commands put the cursor in the same column
358(if possible) as it was after the last command that changed the column,
359except after the "$" command, then the cursor will be put on the last
360character of the line.
361
Bram Moolenaar7c626922005-02-07 22:01:03 +0000362If "k", "-" or CTRL-P is used with a [count] and there are less than [count]
363lines above the cursor and the 'cpo' option includes the "-" flag it is an
364error. |cpo--|.
365
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366==============================================================================
3674. Word motions *word-motions*
368
369<S-Right> or *<S-Right>* *w*
370w [count] words forward. |exclusive| motion.
371
372<C-Right> or *<C-Right>* *W*
373W [count] WORDS forward. |exclusive| motion.
374
375 *e*
376e Forward to the end of word [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000377 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378
379 *E*
380E Forward to the end of WORD [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000381 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382
383<S-Left> or *<S-Left>* *b*
384b [count] words backward. |exclusive| motion.
385
386<C-Left> or *<C-Left>* *B*
387B [count] WORDS backward. |exclusive| motion.
388
389 *ge*
390ge Backward to the end of word [count] |inclusive|.
391
392 *gE*
393gE Backward to the end of WORD [count] |inclusive|.
394
395These commands move over words or WORDS.
396 *word*
397A word consists of a sequence of letters, digits and underscores, or a
398sequence of other non-blank characters, separated with white space (spaces,
Bram Moolenaar4770d092006-01-12 23:22:24 +0000399tabs, <EOL>). This can be changed with the 'iskeyword' option. An empty line
400is also considered to be a word.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401 *WORD*
402A WORD consists of a sequence of non-blank characters, separated with white
Bram Moolenaar4770d092006-01-12 23:22:24 +0000403space. An empty line is also considered to be a WORD.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404
405A sequence of folded lines is counted for one word of a single character.
406"w" and "W", "e" and "E" move to the start/end of the first word or WORD after
407a range of folded lines. "b" and "B" move to the start of the first word or
408WORD before the fold.
409
410Special case: "cw" and "cW" are treated like "ce" and "cE" if the cursor is
411on a non-blank. This is because "cw" is interpreted as change-word, and a
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200412word does not include the following white space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000413
414Another special case: When using the "w" motion in combination with an
415operator and the last word moved over is at the end of a line, the end of
416that word becomes the end of the operated text, not the first word in the
417next line.
418
419The original Vi implementation of "e" is buggy. For example, the "e" command
420will stop on the first character of a line if the previous line was empty.
421But when you use "2e" this does not happen. In Vim "ee" and "2e" are the
422same, which is more logical. However, this causes a small incompatibility
423between Vi and Vim.
424
425==============================================================================
4265. Text object motions *object-motions*
427
428 *(*
429( [count] sentences backward. |exclusive| motion.
430
431 *)*
432) [count] sentences forward. |exclusive| motion.
433
434 *{*
435{ [count] paragraphs backward. |exclusive| motion.
436
437 *}*
438} [count] paragraphs forward. |exclusive| motion.
439
440 *]]*
441]] [count] sections forward or to the next '{' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000442 first column. When used after an operator, then also
443 stops below a '}' in the first column. |exclusive|
444 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445
446 *][*
447][ [count] sections forward or to the next '}' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000448 first column. |exclusive|
449 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450
451 *[[*
452[[ [count] sections backward or to the previous '{' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000453 the first column. |exclusive|
454 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455
456 *[]*
457[] [count] sections backward or to the previous '}' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000458 the first column. |exclusive|
459 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461These commands move over three kinds of text objects.
462
463 *sentence*
464A sentence is defined as ending at a '.', '!' or '?' followed by either the
465end of a line, or by a space or tab. Any number of closing ')', ']', '"'
466and ''' characters may appear after the '.', '!' or '?' before the spaces,
467tabs or end of line. A paragraph and section boundary is also a sentence
468boundary.
469If the 'J' flag is present in 'cpoptions', at least two spaces have to
470follow the punctuation mark; <Tab>s are not recognized as white space.
471The definition of a sentence cannot be changed.
472
473 *paragraph*
474A paragraph begins after each empty line, and also at each of a set of
475paragraph macros, specified by the pairs of characters in the 'paragraphs'
Bram Moolenaar446cb832008-06-24 21:56:24 +0000476option. The default is "IPLPPPQPP TPHPLIPpLpItpplpipbp", which corresponds to
477the macros ".IP", ".LP", etc. (These are nroff macros, so the dot must be in
478the first column). A section boundary is also a paragraph boundary.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000479Note that a blank line (only containing white space) is NOT a paragraph
480boundary.
481Also note that this does not include a '{' or '}' in the first column. When
482the '{' flag is in 'cpoptions' then '{' in the first column is used as a
483paragraph boundary |posix|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
485 *section*
486A section begins after a form-feed (<C-L>) in the first column and at each of
487a set of section macros, specified by the pairs of characters in the
488'sections' option. The default is "SHNHH HUnhsh", which defines a section to
489start at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
490
491The "]" and "[" commands stop at the '{' or '}' in the first column. This is
492useful to find the start or end of a function in a C program. Note that the
493first character of the command determines the search direction and the
494second character the type of brace found.
495
496If your '{' or '}' are not in the first column, and you would like to use "[["
497and "]]" anyway, try these mappings: >
498 :map [[ ?{<CR>w99[{
499 :map ][ /}<CR>b99]}
500 :map ]] j0[[%/{<CR>
501 :map [] k$][%?}<CR>
502[type these literally, see |<>|]
503
504==============================================================================
5056. Text object selection *object-select* *text-objects*
506 *v_a* *v_i*
507
508This is a series of commands that can only be used while in Visual mode or
509after an operator. The commands that start with "a" select "a"n object
510including white space, the commands starting with "i" select an "inner" object
511without white space, or just the white space. Thus the "inner" commands
512always select less text than the "a" commands.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514These commands are not available when the |+textobjects| feature has been
515disabled at compile time.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200516Also see `gn` and `gN`, operating on the last search pattern.
517
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518 *v_aw* *aw*
519aw "a word", select [count] words (see |word|).
520 Leading or trailing white space is included, but not
521 counted.
522 When used in Visual linewise mode "aw" switches to
523 Visual characterwise mode.
524
525 *v_iw* *iw*
526iw "inner word", select [count] words (see |word|).
527 White space between words is counted too.
528 When used in Visual linewise mode "iw" switches to
529 Visual characterwise mode.
530
531 *v_aW* *aW*
532aW "a WORD", select [count] WORDs (see |WORD|).
533 Leading or trailing white space is included, but not
534 counted.
535 When used in Visual linewise mode "aW" switches to
536 Visual characterwise mode.
537
538 *v_iW* *iW*
539iW "inner WORD", select [count] WORDs (see |WORD|).
540 White space between words is counted too.
541 When used in Visual linewise mode "iW" switches to
542 Visual characterwise mode.
543
544 *v_as* *as*
545as "a sentence", select [count] sentences (see
546 |sentence|).
547 When used in Visual mode it is made characterwise.
548
549 *v_is* *is*
550is "inner sentence", select [count] sentences (see
551 |sentence|).
552 When used in Visual mode it is made characterwise.
553
554 *v_ap* *ap*
555ap "a paragraph", select [count] paragraphs (see
556 |paragraph|).
557 Exception: a blank line (only containing white space)
558 is also a paragraph boundary.
559 When used in Visual mode it is made linewise.
560
561 *v_ip* *ip*
562ip "inner paragraph", select [count] paragraphs (see
563 |paragraph|).
564 Exception: a blank line (only containing white space)
565 is also a paragraph boundary.
566 When used in Visual mode it is made linewise.
567
568a] *v_a]* *v_a[* *a]* *a[*
569a[ "a [] block", select [count] '[' ']' blocks. This
570 goes backwards to the [count] unclosed '[', and finds
571 the matching ']'. The enclosed text is selected,
572 including the '[' and ']'.
573 When used in Visual mode it is made characterwise.
574
575i] *v_i]* *v_i[* *i]* *i[*
576i[ "inner [] block", select [count] '[' ']' blocks. This
577 goes backwards to the [count] unclosed '[', and finds
578 the matching ']'. The enclosed text is selected,
579 excluding the '[' and ']'.
580 When used in Visual mode it is made characterwise.
581
582a) *v_a)* *a)* *a(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200583a( *vab* *v_ab* *v_a(* *ab*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584ab "a block", select [count] blocks, from "[count] [(" to
585 the matching ')', including the '(' and ')' (see
586 |[(|). Does not include white space outside of the
587 parenthesis.
588 When used in Visual mode it is made characterwise.
589
590i) *v_i)* *i)* *i(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200591i( *vib* *v_ib* *v_i(* *ib*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592ib "inner block", select [count] blocks, from "[count] [("
593 to the matching ')', excluding the '(' and ')' (see
594 |[(|).
595 When used in Visual mode it is made characterwise.
596
597a> *v_a>* *v_a<* *a>* *a<*
598a< "a <> block", select [count] <> blocks, from the
599 [count]'th unmatched '<' backwards to the matching
600 '>', including the '<' and '>'.
601 When used in Visual mode it is made characterwise.
602
603i> *v_i>* *v_i<* *i>* *i<*
604i< "inner <> block", select [count] <> blocks, from
605 the [count]'th unmatched '<' backwards to the matching
606 '>', excluding the '<' and '>'.
607 When used in Visual mode it is made characterwise.
608
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000609 *v_at* *at*
610at "a tag block", select [count] tag blocks, from the
611 [count]'th unmatched "<aaa>" backwards to the matching
612 "</aaa>", including the "<aaa>" and "</aaa>".
613 See |tag-blocks| about the details.
614 When used in Visual mode it is made characterwise.
615
616 *v_it* *it*
617it "inner tag block", select [count] tag blocks, from the
618 [count]'th unmatched "<aaa>" backwards to the matching
619 "</aaa>", excluding the "<aaa>" and "</aaa>".
620 See |tag-blocks| about the details.
621 When used in Visual mode it is made characterwise.
622
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623a} *v_a}* *a}* *a{*
624a{ *v_aB* *v_a{* *aB*
625aB "a Block", select [count] Blocks, from "[count] [{" to
626 the matching '}', including the '{' and '}' (see
627 |[{|).
628 When used in Visual mode it is made characterwise.
629
630i} *v_i}* *i}* *i{*
631i{ *v_iB* *v_i{* *iB*
632iB "inner Block", select [count] Blocks, from "[count] [{"
633 to the matching '}', excluding the '{' and '}' (see
634 |[{|).
635 When used in Visual mode it is made characterwise.
636
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000637a" *v_aquote* *aquote*
638a' *v_a'* *a'*
639a` *v_a`* *a`*
640 "a quoted string". Selects the text from the previous
Bram Moolenaar5a305422006-04-28 22:38:25 +0000641 quote until the next quote. The 'quoteescape' option
642 is used to skip escaped quotes.
643 Only works within one line.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000644 When the cursor starts on a quote, Vim will figure out
645 which quote pairs form a string by searching from the
646 start of the line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100647 Any trailing white space is included, unless there is
648 none, then leading white space is included.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000649 When used in Visual mode it is made characterwise.
650 Repeating this object in Visual mode another string is
651 included. A count is currently not used.
652
653i" *v_iquote* *iquote*
654i' *v_i'* *i'*
655i` *v_i`* *i`*
656 Like a", a' and a`, but exclude the quotes and
657 repeating won't extend the Visual selection.
Bram Moolenaarab194812005-09-14 21:40:12 +0000658 Special case: With a count of 2 the quotes are
659 included, but no extra white space as with a"/a'/a`.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000660
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661When used after an operator:
662For non-block objects:
663 For the "a" commands: The operator applies to the object and the white
664 space after the object. If there is no white space after the object
665 or when the cursor was in the white space before the object, the white
666 space before the object is included.
667 For the "inner" commands: If the cursor was on the object, the
668 operator applies to the object. If the cursor was on white space, the
669 operator applies to the white space.
670For a block object:
671 The operator applies to the block where the cursor is in, or the block
672 on which the cursor is on one of the braces. For the "inner" commands
673 the surrounding braces are excluded. For the "a" commands, the braces
674 are included.
675
676When used in Visual mode:
677When start and end of the Visual area are the same (just after typing "v"):
678 One object is selected, the same as for using an operator.
679When start and end of the Visual area are not the same:
680 For non-block objects the area is extended by one object or the white
681 space up to the next object, or both for the "a" objects. The
682 direction in which this happens depends on which side of the Visual
683 area the cursor is. For the block objects the block is extended one
684 level outwards.
685
686For illustration, here is a list of delete commands, grouped from small to big
687objects. Note that for a single character and a whole line the existing vi
688movement commands are used.
689 "dl" delete character (alias: "x") |dl|
690 "diw" delete inner word *diw*
691 "daw" delete a word *daw*
692 "diW" delete inner WORD (see |WORD|) *diW*
693 "daW" delete a WORD (see |WORD|) *daW*
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200694 "dgn" delete the next search pattern match *dgn*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 "dd" delete one line |dd|
696 "dis" delete inner sentence *dis*
697 "das" delete a sentence *das*
698 "dib" delete inner '(' ')' block *dib*
699 "dab" delete a '(' ')' block *dab*
700 "dip" delete inner paragraph *dip*
701 "dap" delete a paragraph *dap*
702 "diB" delete inner '{' '}' block *diB*
703 "daB" delete a '{' '}' block *daB*
704
705Note the difference between using a movement command and an object. The
706movement command operates from here (cursor position) to where the movement
707takes us. When using an object the whole object is operated upon, no matter
708where on the object the cursor is. For example, compare "dw" and "daw": "dw"
709deletes from the cursor position to the start of the next word, "daw" deletes
710the word under the cursor and the space after or before it.
711
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000712
713Tag blocks *tag-blocks*
714
715For the "it" and "at" text objects an attempt is done to select blocks between
716matching tags for HTML and XML. But since these are not completely compatible
717there are a few restrictions.
718
719The normal method is to select a <tag> until the matching </tag>. For "at"
720the tags are included, for "it" they are excluded. But when "it" is repeated
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000721the tags will be included (otherwise nothing would change). Also, "it" used
722on a tag block with no contents will select the leading tag.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000723
724"<aaa/>" items are skipped. Case is ignored, also for XML where case does
725matter.
726
727In HTML it is possible to have a tag like <br> or <meta ...> without a
728matching end tag. These are ignored.
729
730The text objects are tolerant about mistakes. Stray end tags are ignored.
731
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732==============================================================================
7337. Marks *mark-motions* *E20* *E78*
734
735Jumping to a mark can be done in two ways:
7361. With ` (backtick): The cursor is positioned at the specified location
737 and the motion is |exclusive|.
7382. With ' (single quote): The cursor is positioned on the first non-blank
739 character in the line of the specified location and
740 the motion is linewise.
741
742 *m* *mark* *Mark*
743m{a-zA-Z} Set mark {a-zA-Z} at cursor position (does not move
744 the cursor, this is not a motion command).
745
746 *m'* *m`*
747m' or m` Set the previous context mark. This can be jumped to
748 with the "''" or "``" command (does not move the
749 cursor, this is not a motion command).
750
751 *m[* *m]*
752m[ or m] Set the |'[| or |']| mark. Useful when an operator is
753 to be simulated by multiple commands. (does not move
754 the cursor, this is not a motion command).
755
Bram Moolenaar30b65812012-07-12 22:01:11 +0200756 *m<* *m>*
757m< or m> Set the |'<| or |'>| mark. Useful to change what the
758 `gv` command selects. (does not move the cursor, this
759 is not a motion command).
760 Note that the Visual mode cannot be set, only the
761 start and end position.
762
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 *:ma* *:mark* *E191*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000764:[range]ma[rk] {a-zA-Z'}
765 Set mark {a-zA-Z'} at last line number in [range],
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 column 0. Default is cursor line.
767
768 *:k*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000769:[range]k{a-zA-Z'} Same as :mark, but the space before the mark name can
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 be omitted.
771
772 *'* *'a* *`* *`a*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000773'{a-z} `{a-z} Jump to the mark {a-z} in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774
775 *'A* *'0* *`A* *`0*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000776'{A-Z0-9} `{A-Z0-9} To the mark {A-Z0-9} in the file where it was set (not
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200777 a motion command when in another file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
779 *g'* *g'a* *g`* *g`a*
780g'{mark} g`{mark}
781 Jump to the {mark}, but don't change the jumplist when
782 jumping within the current buffer. Example: >
783 g`"
784< jumps to the last known position in a file. See
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000785 $VIMRUNTIME/vimrc_example.vim.
786 Also see |:keepjumps|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788 *:marks*
789:marks List all the current marks (not a motion command).
790 The |'(|, |')|, |'{| and |'}| marks are not listed.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000791 The first column has number zero.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200792
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 *E283*
794:marks {arg} List the marks that are mentioned in {arg} (not a
795 motion command). For example: >
796 :marks aB
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200797< to list marks 'a' and 'B'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000799 *:delm* *:delmarks*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000800:delm[arks] {marks} Delete the specified marks. Marks that can be deleted
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000801 include A-Z and 0-9. You cannot delete the ' mark.
802 They can be specified by giving the list of mark
803 names, or with a range, separated with a dash. Spaces
804 are ignored. Examples: >
805 :delmarks a deletes mark a
806 :delmarks a b 1 deletes marks a, b and 1
807 :delmarks Aa deletes marks A and a
808 :delmarks p-z deletes marks in the range p to z
809 :delmarks ^.[] deletes marks ^ . [ ]
810 :delmarks \" deletes mark "
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000811
812:delm[arks]! Delete all marks for the current buffer, but not marks
813 A-Z or 0-9.
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000814
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815A mark is not visible in any way. It is just a position in the file that is
816remembered. Do not confuse marks with named registers, they are totally
817unrelated.
818
819'a - 'z lowercase marks, valid within one file
820'A - 'Z uppercase marks, also called file marks, valid between files
821'0 - '9 numbered marks, set from .viminfo file
822
823Lowercase marks 'a to 'z are remembered as long as the file remains in the
824buffer list. If you remove the file from the buffer list, all its marks are
825lost. If you delete a line that contains a mark, that mark is erased.
826
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827Lowercase marks can be used in combination with operators. For example: "d't"
828deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for
829Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and
830redo.
831
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200832Uppercase marks 'A to 'Z include the file name. You can use them to jump from
833file to file. You can only use an uppercase mark with an operator if the mark
834is in the current file. The line number of the mark remains correct, even if
835you insert/delete lines or edit another file for a moment. When the 'viminfo'
836option is not empty, uppercase marks are kept in the .viminfo file. See
837|viminfo-file-marks|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838
839Numbered marks '0 to '9 are quite different. They can not be set directly.
840They are only present when using a viminfo file |viminfo-file|. Basically '0
841is the location of the cursor when you last exited Vim, '1 the last but one
842time, etc. Use the "r" flag in 'viminfo' to specify files for which no
843Numbered mark should be stored. See |viminfo-file-marks|.
844
845
846 *'[* *`[*
847'[ `[ To the first character of the previously changed
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200848 or yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849
850 *']* *`]*
851'] `] To the last character of the previously changed or
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200852 yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853
854After executing an operator the Cursor is put at the beginning of the text
855that was operated upon. After a put command ("p" or "P") the cursor is
856sometimes placed at the first inserted line and sometimes on the last inserted
857character. The four commands above put the cursor at either end. Example:
858After yanking 10 lines you want to go to the last one of them: "10Y']". After
859inserting several lines with the "p" command you want to jump to the lowest
860inserted line: "p']". This also works for text that has been inserted.
861
862Note: After deleting text, the start and end positions are the same, except
863when using blockwise Visual mode. These commands do not work when no change
864was made yet in the current file.
865
866 *'<* *`<*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000867'< `< To the first line or character of the last selected
868 Visual area in the current buffer. For block mode it
869 may also be the last character in the first line (to
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200870 be able to define the block).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871
872 *'>* *`>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000873'> `> To the last line or character of the last selected
874 Visual area in the current buffer. For block mode it
875 may also be the first character of the last line (to
876 be able to define the block). Note that 'selection'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000877 applies, the position may be just after the Visual
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200878 area.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879
880 *''* *``*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000881'' `` To the position before the latest jump, or where the
882 last "m'" or "m`" command was given. Not set when the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |:keepjumps| command modifier was used.
884 Also see |restore-position|.
885
886 *'quote* *`quote*
887'" `" To the cursor position when last exiting the current
888 buffer. Defaults to the first character of the first
889 line. See |last-position-jump| for how to use this
890 for each opened file.
891 Only one position is remembered per buffer, not one
892 for each window. As long as the buffer is visible in
893 a window the position won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000894
895 *'^* *`^*
896'^ `^ To the position where the cursor was the last time
Bram Moolenaar81695252004-12-29 20:58:21 +0000897 when Insert mode was stopped. This is used by the
898 |gi| command. Not set when the |:keepjumps| command
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200899 modifier was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900
901 *'.* *`.*
902'. `. To the position where the last change was made. The
903 position is at or near where the change started.
904 Sometimes a command is executed as several changes,
905 then the position can be near the end of what the
906 command changed. For example when inserting a word,
907 the position will be on the last character.
Bram Moolenaar51628222016-12-01 23:03:28 +0100908 To jump to older changes use |g;|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909
910 *'(* *`(*
911'( `( To the start of the current sentence, like the |(|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200912 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913
914 *')* *`)*
915') `) To the end of the current sentence, like the |)|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200916 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917
918 *'{* *`{*
919'{ `{ To the start of the current paragraph, like the |{|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200920 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921
922 *'}* *`}*
923'} `} To the end of the current paragraph, like the |}|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200924 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926These commands are not marks themselves, but jump to a mark:
927
928 *]'*
929]' [count] times to next line with a lowercase mark below
930 the cursor, on the first non-blank character in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200931 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932
933 *]`*
934]` [count] times to lowercase mark after the cursor. {not
935 in Vi}
936
937 *['*
938[' [count] times to previous line with a lowercase mark
939 before the cursor, on the first non-blank character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200940 the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941
942 *[`*
943[` [count] times to lowercase mark before the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944
945
946:loc[kmarks] {command} *:loc* *:lockmarks*
947 Execute {command} without adjusting marks. This is
948 useful when changing text in a way that the line count
949 will be the same when the change has completed.
950 WARNING: When the line count does change, marks below
951 the change will keep their line number, thus move to
952 another text line.
953 These items will not be adjusted for deleted/inserted
954 lines:
955 - lower case letter marks 'a - 'z
956 - upper case letter marks 'A - 'Z
957 - numbered marks '0 - '9
958 - last insert position '^
959 - last change position '.
960 - the Visual area '< and '>
961 - line numbers in placed signs
962 - line numbers in quickfix positions
963 - positions in the |jumplist|
964 - positions in the |tagstack|
965 These items will still be adjusted:
966 - previous context mark ''
967 - the cursor position
968 - the view of a window on a buffer
969 - folds
970 - diffs
971
972:kee[pmarks] {command} *:kee* *:keepmarks*
973 Currently only has effect for the filter command
974 |:range!|:
975 - When the number of lines after filtering is equal to
976 or larger than before, all marks are kept at the
977 same line number.
978 - When the number of lines decreases, the marks in the
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000979 lines that disappeared are deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 In any case the marks below the filtered text have
981 their line numbers adjusted, thus stick to the text,
982 as usual.
983 When the 'R' flag is missing from 'cpoptions' this has
984 the same effect as using ":keepmarks".
985
986 *:keepj* *:keepjumps*
987:keepj[umps] {command}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000988 Moving around in {command} does not change the |''|,
989 |'.| and |'^| marks, the |jumplist| or the
990 |changelist|.
991 Useful when making a change or inserting text
992 automatically and the user doesn't want to go to this
993 position. E.g., when updating a "Last change"
994 timestamp in the first line: >
995
Bram Moolenaare5180522005-12-10 20:19:46 +0000996 :let lnum = line(".")
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000997 :keepjumps normal gg
998 :call SetLastChange()
999 :keepjumps exe "normal " . lnum . "G"
1000<
1001 Note that ":keepjumps" must be used for every command.
1002 When invoking a function the commands in that function
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001003 can still change the jumplist. Also, for
Bram Moolenaar13065c42005-01-08 16:08:21 +00001004 ":keepjumps exe 'command '" the "command" won't keep
1005 jumps. Instead use: ":exe 'keepjumps command'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006
1007==============================================================================
10088. Jumps *jump-motions*
1009
Bram Moolenaarb477af22018-07-15 20:20:18 +02001010A "jump" is a command that normally moves the cursor several lines away. If
1011you make the cursor "jump" the position of the cursor before the jump is
Bram Moolenaar26967612019-03-17 17:13:16 +01001012remembered. You can return to that position with the "''" and "``" commands,
Bram Moolenaarb477af22018-07-15 20:20:18 +02001013unless the line containing that position was changed or deleted. The
1014following commands are "jump" commands: "'", "`", "G", "/", "?", "n", "N",
1015"%", "(", ")", "[[", "]]", "{", "}", ":s", ":tag", "L", "M", "H" and the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001016commands that start editing a new file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
1018 *CTRL-O*
1019CTRL-O Go to [count] Older cursor position in jump list
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001020 (not a motion command).
Bram Moolenaardb84e452010-08-15 13:50:43 +02001021 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022
1023<Tab> or *CTRL-I* *<Tab>*
1024CTRL-I Go to [count] newer cursor position in jump list
1025 (not a motion command).
Bram Moolenaardb84e452010-08-15 13:50:43 +02001026 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027
1028 *:ju* *:jumps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001029:ju[mps] Print the jump list (not a motion command).
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001030 {not available without the |+jumplist| feature}
1031
1032 *:cle* *:clearjumps*
1033:cle[arjumps] Clear the jump list of the current window.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001034 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035
1036 *jumplist*
1037Jumps are remembered in a jump list. With the CTRL-O and CTRL-I command you
1038can go to cursor positions before older jumps, and back again. Thus you can
1039move up and down the list. There is a separate jump list for each window.
1040The maximum number of entries is fixed at 100.
Bram Moolenaardb84e452010-08-15 13:50:43 +02001041{not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042
1043For example, after three jump commands you have this jump list:
1044
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001045 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 3 1 0 some text ~
1047 2 70 0 another line ~
1048 1 1154 23 end. ~
1049 > ~
1050
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001051The "file/text" column shows the file name, or the text at the jump if it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052in the current file (an indent is removed and a long line is truncated to fit
1053in the window).
1054
1055You are currently in line 1167. If you then use the CTRL-O command, the
1056cursor is put in line 1154. This results in:
1057
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001058 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 2 1 0 some text ~
1060 1 70 0 another line ~
1061 > 0 1154 23 end. ~
1062 1 1167 0 foo bar ~
1063
1064The pointer will be set at the last used jump position. The next CTRL-O
1065command will use the entry above it, the next CTRL-I command will use the
1066entry below it. If the pointer is below the last entry, this indicates that
1067you did not use a CTRL-I or CTRL-O before. In this case the CTRL-O command
1068will cause the cursor position to be added to the jump list, so you can get
1069back to the position before the CTRL-O. In this case this is line 1167.
1070
1071With more CTRL-O commands you will go to lines 70 and 1. If you use CTRL-I
1072you can go back to 1154 and 1167 again. Note that the number in the "jump"
1073column indicates the count for the CTRL-O or CTRL-I command that takes you to
1074this position.
1075
1076If you use a jump command, the current line number is inserted at the end of
1077the jump list. If the same line was already in the jump list, it is removed.
1078The result is that when repeating CTRL-O you will get back to old positions
1079only once.
1080
1081When the |:keepjumps| command modifier is used, jumps are not stored in the
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001082jumplist. Jumps are also not stored in other cases, e.g., in a |:global|
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001083command. You can explicitly add a jump by setting the ' mark with "m'". Note
1084that calling setpos() does not do this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085
1086After the CTRL-O command that got you into line 1154 you could give another
1087jump command (e.g., "G"). The jump list would then become:
1088
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001089 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 4 1 0 some text ~
1091 3 70 0 another line ~
1092 2 1167 0 foo bar ~
1093 1 1154 23 end. ~
1094 > ~
1095
1096The line numbers will be adjusted for deleted and inserted lines. This fails
1097if you stop editing a file without writing, like with ":n!".
1098
1099When you split a window, the jumplist will be copied to the new window.
1100
1101If you have included the ' item in the 'viminfo' option the jumplist will be
1102stored in the viminfo file and restored when starting Vim.
1103
1104
1105CHANGE LIST JUMPS *changelist* *change-list-jumps* *E664*
1106
1107When making a change the cursor position is remembered. One position is
1108remembered for every change that can be undone, unless it is close to a
1109previous change. Two commands can be used to jump to positions of changes,
1110also those that have been undone:
1111
1112 *g;* *E662*
1113g; Go to [count] older position in change list.
1114 If [count] is larger than the number of older change
1115 positions go to the oldest change.
1116 If there is no older change an error message is given.
1117 (not a motion command)
Bram Moolenaardb84e452010-08-15 13:50:43 +02001118 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 *g,* *E663*
1121g, Go to [count] newer cursor position in change list.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001122 Just like |g;| but in the opposite direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 (not a motion command)
Bram Moolenaardb84e452010-08-15 13:50:43 +02001124 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125
1126When using a count you jump as far back or forward as possible. Thus you can
1127use "999g;" to go to the first change for which the position is still
1128remembered. The number of entries in the change list is fixed and is the same
1129as for the |jumplist|.
1130
1131When two undo-able changes are in the same line and at a column position less
1132than 'textwidth' apart only the last one is remembered. This avoids that a
1133sequence of small changes in a line, for example "xxxxx", adds many positions
1134to the change list. When 'textwidth' is zero 'wrapmargin' is used. When that
1135also isn't set a fixed number of 79 is used. Detail: For the computations
1136bytes are used, not characters, to avoid a speed penalty (this only matters
1137for multi-byte encodings).
1138
1139Note that when text has been inserted or deleted the cursor position might be
1140a bit different from the position of the change. Especially when lines have
1141been deleted.
1142
1143When the |:keepjumps| command modifier is used the position of a change is not
1144remembered.
1145
1146 *:changes*
1147:changes Print the change list. A ">" character indicates the
1148 current position. Just after a change it is below the
Bram Moolenaara9604e62018-07-21 05:56:22 +02001149 newest entry, indicating that `g;` takes you to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 newest entry position. The first column indicates the
1151 count needed to take you to this position. Example:
1152
1153 change line col text ~
1154 3 9 8 bla bla bla
1155 2 11 57 foo is a bar
1156 1 14 54 the latest changed line
1157 >
1158
Bram Moolenaara9604e62018-07-21 05:56:22 +02001159 The `3g;` command takes you to line 9. Then the
1160 output of `:changes` is:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161
1162 change line col text ~
1163 > 0 9 8 bla bla bla
1164 1 11 57 foo is a bar
1165 2 14 54 the latest changed line
1166
1167 Now you can use "g," to go to line 11 and "2g," to go
1168 to line 14.
1169
1170==============================================================================
11719. Various motions *various-motions*
1172
1173 *%*
1174% Find the next item in this line after or under the
1175 cursor and jump to its match. |inclusive| motion.
1176 Items can be:
1177 ([{}]) parenthesis or (curly/square) brackets
1178 (this can be changed with the
1179 'matchpairs' option)
1180 /* */ start or end of C-style comment
1181 #if, #ifdef, #else, #elif, #endif
1182 C preprocessor conditionals (when the
1183 cursor is on the # or no ([{
1184 following)
1185 For other items the matchit plugin can be used, see
Bram Moolenaar446cb832008-06-24 21:56:24 +00001186 |matchit-install|. This plugin also helps to skip
1187 matches in comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188
1189 When 'cpoptions' contains "M" |cpo-M| backslashes
1190 before parens and braces are ignored. Without "M" the
1191 number of backslashes matters: an even number doesn't
1192 match with an odd number. Thus in "( \) )" and "\( (
1193 \)" the first and last parenthesis match.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001194
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 When the '%' character is not present in 'cpoptions'
1196 |cpo-%|, parens and braces inside double quotes are
1197 ignored, unless the number of parens/braces in a line
1198 is uneven and this line and the previous one does not
1199 end in a backslash. '(', '{', '[', ']', '}' and ')'
1200 are also ignored (parens and braces inside single
1201 quotes). Note that this works fine for C, but not for
1202 Perl, where single quotes are used for strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001203
1204 Nothing special is done for matches in comments. You
1205 can either use the matchit plugin |matchit-install| or
1206 put quotes around matches.
1207
1208 No count is allowed, {count}% jumps to a line {count}
1209 percentage down the file |N%|. Using '%' on
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 #if/#else/#endif makes the movement linewise.
1211
1212 *[(*
1213[( go to [count] previous unmatched '('.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001214 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215
1216 *[{*
1217[{ go to [count] previous unmatched '{'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001218 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219
1220 *])*
1221]) go to [count] next unmatched ')'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001222 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
1224 *]}*
1225]} go to [count] next unmatched '}'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001226 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227
1228The above four commands can be used to go to the start or end of the current
1229code block. It is like doing "%" on the '(', ')', '{' or '}' at the other
1230end of the code block, but you can do this from anywhere in the code block.
1231Very useful for C programs. Example: When standing on "case x:", "[{" will
1232bring you back to the switch statement.
1233
1234 *]m*
1235]m Go to [count] next start of a method (for Java or
1236 similar structured language). When not before the
1237 start of a method, jump to the start or end of the
1238 class. When no '{' is found after the cursor, this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001239 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 *]M*
1241]M Go to [count] next end of a method (for Java or
1242 similar structured language). When not before the end
1243 of a method, jump to the start or end of the class.
1244 When no '}' is found after the cursor, this is an
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001245 error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 *[m*
1247[m Go to [count] previous start of a method (for Java or
1248 similar structured language). When not after the
1249 start of a method, jump to the start or end of the
1250 class. When no '{' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001251 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 *[M*
1253[M Go to [count] previous end of a method (for Java or
1254 similar structured language). When not after the
1255 end of a method, jump to the start or end of the
1256 class. When no '}' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001257 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259The above two commands assume that the file contains a class with methods.
1260The class definition is surrounded in '{' and '}'. Each method in the class
1261is also surrounded with '{' and '}'. This applies to the Java language. The
1262file looks like this: >
1263
1264 // comment
1265 class foo {
1266 int method_one() {
1267 body_one();
1268 }
1269 int method_two() {
1270 body_two();
1271 }
1272 }
1273Starting with the cursor on "body_two()", using "[m" will jump to the '{' at
1274the start of "method_two()" (obviously this is much more useful when the
1275method is long!). Using "2[m" will jump to the start of "method_one()".
1276Using "3[m" will jump to the start of the class.
1277
1278 *[#*
1279[# go to [count] previous unmatched "#if" or "#else".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001280 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281
1282 *]#*
1283]# go to [count] next unmatched "#else" or "#endif".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001284 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
1286These two commands work in C programs that contain #if/#else/#endif
1287constructs. It brings you to the start or end of the #if/#else/#endif where
1288the current line is included. You can then use "%" to go to the matching line.
1289
1290 *[star* *[/*
1291[* or [/ go to [count] previous start of a C comment "/*".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001292 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
1294 *]star* *]/*
1295]* or ]/ go to [count] next end of a C comment "*/".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001296 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297
1298
1299 *H*
1300H To line [count] from top (Home) of window (default:
1301 first line on the window) on the first non-blank
1302 character |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001303 Cursor is adjusted for 'scrolloff' option, unless an
1304 operator is pending, in which case the text may
1305 scroll. E.g. "yH" yanks from the first visible line
1306 until the cursor line (inclusive).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307
1308 *M*
1309M To Middle line of window, on the first non-blank
1310 character |linewise|. See also 'startofline' option.
1311
1312 *L*
1313L To line [count] from bottom of window (default: Last
1314 line on the window) on the first non-blank character
1315 |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001316 Cursor is adjusted for 'scrolloff' option, unless an
1317 operator is pending, in which case the text may
1318 scroll. E.g. "yL" yanks from the cursor to the last
1319 visible line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320
1321<LeftMouse> Moves to the position on the screen where the mouse
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001322 click is |exclusive|. See also |<LeftMouse>|. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 position is in a status line, that window is made the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001324 active window and the cursor is not moved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001326 vim:tw=78:ts=8:noet:ft=help:norl: