blob: f0935da0eba104eef008c17fbbecaf409edd0407 [file] [log] [blame]
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001*motion.txt* For Vim version 8.1. Last change: 2019 Jun 02
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
Bram Moolenaar68e65602019-05-26 21:33:31 +020056 |gw| gw text formatting with no cursor movement
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 |g?| g? ROT13 encoding
58 |>| > shift right
59 |<| < shift left
60 |zf| zf define a fold
Bram Moolenaar6c35bea2012-07-25 17:49:10 +020061 |g@| g@ call function set with the 'operatorfunc' option
Bram Moolenaar071d4272004-06-13 20:20:40 +000062
63If the motion includes a count and the operator also had a count before it,
64the two counts are multiplied. For example: "2d3w" deletes six words.
65
66After applying the operator the cursor is mostly left at the start of the text
67that was operated upon. For example, "yfe" doesn't move the cursor, but "yFe"
68moves the cursor leftwards to the "e" where the yank started.
69
70 *linewise* *characterwise*
71The operator either affects whole lines, or the characters between the start
72and end position. Generally, motions that move between lines affect lines
73(are linewise), and motions that move within a line affect characters (are
74characterwise). However, there are some exceptions.
75
76 *exclusive* *inclusive*
Bram Moolenaar78984f52005-08-01 07:19:10 +000077A character motion is either inclusive or exclusive. When inclusive, the
78start and end position of the motion are included in the operation. When
79exclusive, the last character towards the end of the buffer is not included.
80Linewise motions always include the start and end position.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081
Bram Moolenaar78984f52005-08-01 07:19:10 +000082Which motions are linewise, inclusive or exclusive is mentioned with the
83command. There are however, two general exceptions:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841. If the motion is exclusive and the end of the motion is in column 1, the
85 end of the motion is moved to the end of the previous line and the motion
86 becomes inclusive. Example: "}" moves to the first line after a paragraph,
87 but "d}" will not include that line.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000088 *exclusive-linewise*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892. If the motion is exclusive, the end of the motion is in column 1 and the
90 start of the motion was at or before the first non-blank in the line, the
91 motion becomes linewise. Example: If a paragraph begins with some blanks
92 and you do "d}" while standing on the first non-blank, all the lines of
93 the paragraph are deleted, including the blanks. If you do a put now, the
94 deleted lines will be inserted below the cursor position.
95
96Note that when the operator is pending (the operator command is typed, but the
97motion isn't yet), a special set of mappings can be used. See |:omap|.
98
99Instead of first giving the operator and then a motion you can use Visual
100mode: mark the start of the text with "v", move the cursor to the end of the
101text that is to be affected and then hit the operator. The text between the
102start and the cursor position is highlighted, so you can see what text will
103be operated upon. This allows much more freedom, but requires more key
104strokes and has limited redo functionality. See the chapter on Visual mode
105|Visual-mode|.
106
107You can use a ":" command for a motion. For example "d:call FindEnd()".
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100108But this can't be repeated with "." if the command is more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109This can be repeated: >
110 d:call search("f")<CR>
111This cannot be repeated: >
112 d:if 1<CR>
113 call search("f")<CR>
114 endif<CR>
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100115Note that when using ":" any motion becomes characterwise exclusive.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100117 *forced-motion*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000118FORCING A MOTION TO BE LINEWISE, CHARACTERWISE OR BLOCKWISE
119
120When a motion is not of the type you would like to use, you can force another
121type by using "v", "V" or CTRL-V just after the operator.
122Example: >
123 dj
124deletes two lines >
125 dvj
126deletes from the cursor position until the character below the cursor >
127 d<C-V>j
128deletes the character under the cursor and the character below the cursor. >
129
130Be careful with forcing a linewise movement to be used characterwise or
131blockwise, the column may not always be defined.
132
133 *o_v*
134v When used after an operator, before the motion command: Force
135 the operator to work characterwise, also when the motion is
136 linewise. If the motion was linewise, it will become
137 |exclusive|.
138 If the motion already was characterwise, toggle
139 inclusive/exclusive. This can be used to make an exclusive
140 motion inclusive and an inclusive motion exclusive.
141
142 *o_V*
143V When used after an operator, before the motion command: Force
144 the operator to work linewise, also when the motion is
145 characterwise.
146
147 *o_CTRL-V*
148CTRL-V When used after an operator, before the motion command: Force
149 the operator to work blockwise. This works like Visual block
150 mode selection, with the corners defined by the cursor
151 position before and after the motion.
152
153==============================================================================
1542. Left-right motions *left-right-motions*
155
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100156These commands move the cursor to the specified column in the current line.
157They stop at the first column and at the end of the line, except "$", which
158may move to one of the next lines. See 'whichwrap' option to make some of the
159commands move across line boundaries.
160
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161h or *h*
162<Left> or *<Left>*
163CTRL-H or *CTRL-H* *<BS>*
164<BS> [count] characters to the left. |exclusive| motion.
165 Note: If you prefer <BS> to delete a character, use
166 the mapping:
167 :map CTRL-V<BS> X
168 (to enter "CTRL-V<BS>" type the CTRL-V key, followed
169 by the <BS> key)
170 See |:fixdel| if the <BS> key does not do what you
171 want.
172
173l or *l*
174<Right> or *<Right>* *<Space>*
175<Space> [count] characters to the right. |exclusive| motion.
Bram Moolenaarf2571c62015-06-09 19:44:55 +0200176 See the 'whichwrap' option for adjusting the behavior
177 at end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178
179 *0*
1800 To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000181 motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182
183 *<Home>* *<kHome>*
184<Home> To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000185 motion. When moving up or down next, stay in same
186 TEXT column (if possible). Most other commands stay
187 in the same SCREEN column. <Home> works like "1|",
188 which differs from "0" when the line starts with a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200189 <Tab>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190
191 *^*
192^ To the first non-blank character of the line.
193 |exclusive| motion.
194
195 *$* *<End>* *<kEnd>*
196$ or <End> To the end of the line. When a count is given also go
Bram Moolenaar036986f2017-03-16 17:41:02 +0100197 [count - 1] lines downward. |inclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198 In Visual mode the cursor goes to just after the last
199 character in the line.
200 When 'virtualedit' is active, "$" may move the cursor
201 back from past the end of the line to the last
202 character in the line.
203
204 *g_*
205g_ To the last non-blank character of the line and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200206 [count - 1] lines downward |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207
208 *g0* *g<Home>*
209g0 or g<Home> When lines wrap ('wrap' on): To the first character of
210 the screen line. |exclusive| motion. Differs from
211 "0" when a line is wider than the screen.
212 When lines don't wrap ('wrap' off): To the leftmost
213 character of the current line that is on the screen.
214 Differs from "0" when the first character of the line
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200215 is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
217 *g^*
218g^ When lines wrap ('wrap' on): To the first non-blank
219 character of the screen line. |exclusive| motion.
220 Differs from "^" when a line is wider than the screen.
221 When lines don't wrap ('wrap' off): To the leftmost
222 non-blank character of the current line that is on the
223 screen. Differs from "^" when the first non-blank
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200224 character of the line is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225
226 *gm*
227gm Like "g0", but half a screenwidth to the right (or as
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200228 much as possible).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000229
230 *g$* *g<End>*
231g$ or g<End> When lines wrap ('wrap' on): To the last character of
232 the screen line and [count - 1] screen lines downward
233 |inclusive|. Differs from "$" when a line is wider
234 than the screen.
235 When lines don't wrap ('wrap' off): To the rightmost
236 character of the current line that is visible on the
237 screen. Differs from "$" when the last character of
238 the line is not on the screen or when a count is used.
239 Additionally, vertical movements keep the column,
240 instead of going to the end of the line.
Bram Moolenaar9ba7e172013-07-17 22:37:26 +0200241 When 'virtualedit' is enabled moves to the end of the
242 screen line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243
244 *bar*
245| To screen column [count] in the current line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100246 |exclusive| motion. Ceci n'est pas une pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247
248 *f*
249f{char} To [count]'th occurrence of {char} to the right. The
250 cursor is placed on {char} |inclusive|.
251 {char} can be entered as a digraph |digraph-arg|.
252 When 'encoding' is set to Unicode, composing
253 characters may be used, see |utf-8-char-arg|.
254 |:lmap| mappings apply to {char}. The CTRL-^ command
255 in Insert mode can be used to switch this on/off
256 |i_CTRL-^|.
257
258 *F*
259F{char} To the [count]'th occurrence of {char} to the left.
Bram Moolenaar78984f52005-08-01 07:19:10 +0000260 The cursor is placed on {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 {char} can be entered like with the |f| command.
262
263 *t*
264t{char} Till before [count]'th occurrence of {char} to the
265 right. The cursor is placed on the character left of
266 {char} |inclusive|.
267 {char} can be entered like with the |f| command.
268
269 *T*
270T{char} Till after [count]'th occurrence of {char} to the
271 left. The cursor is placed on the character right of
Bram Moolenaar78984f52005-08-01 07:19:10 +0000272 {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 {char} can be entered like with the |f| command.
274
275 *;*
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200276; Repeat latest f, t, F or T [count] times. See |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
278 *,*
279, Repeat latest f, t, F or T in opposite direction
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200280 [count] times. See also |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282==============================================================================
2833. Up-down motions *up-down-motions*
284
285k or *k*
286<Up> or *<Up>* *CTRL-P*
287CTRL-P [count] lines upward |linewise|.
288
289j or *j*
290<Down> or *<Down>*
291CTRL-J or *CTRL-J*
292<NL> or *<NL>* *CTRL-N*
293CTRL-N [count] lines downward |linewise|.
294
295gk or *gk* *g<Up>*
296g<Up> [count] display lines upward. |exclusive| motion.
297 Differs from 'k' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200298 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299
300gj or *gj* *g<Down>*
301g<Down> [count] display lines downward. |exclusive| motion.
302 Differs from 'j' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200303 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
305 *-*
306- <minus> [count] lines upward, on the first non-blank
307 character |linewise|.
308
309+ or *+*
310CTRL-M or *CTRL-M* *<CR>*
311<CR> [count] lines downward, on the first non-blank
312 character |linewise|.
313
314 *_*
315_ <underscore> [count] - 1 lines downward, on the first non-blank
316 character |linewise|.
317
318 *G*
319G Goto line [count], default last line, on the first
320 non-blank character |linewise|. If 'startofline' not
321 set, keep the same column.
Bram Moolenaar26967612019-03-17 17:13:16 +0100322 G is one of the |jump-motions|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *<C-End>*
325<C-End> Goto line [count], default last line, on the last
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200326 character |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000327
328<C-Home> or *gg* *<C-Home>*
329gg Goto line [count], default first line, on the first
330 non-blank character |linewise|. If 'startofline' not
331 set, keep the same column.
332
Bram Moolenaar9b451252012-08-15 17:43:31 +0200333 *:[range]*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100334:[range] Set the cursor on the last line number in [range].
335 [range] can also be just one line number, e.g., ":1"
336 or ":'m".
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200337 In contrast with |G| this command does not modify the
338 |jumplist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 *N%*
340{count}% Go to {count} percentage in the file, on the first
341 non-blank in the line |linewise|. To compute the new
342 line number this formula is used:
343 ({count} * number-of-lines + 99) / 100
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200344 See also 'startofline' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346:[range]go[to] [count] *:go* *:goto* *go*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100347[count]go Go to [count] byte in the buffer. Default [count] is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348 one, start of the file. When giving [range], the
349 last number in it used as the byte count. End-of-line
350 characters are counted depending on the current
351 'fileformat' setting.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200352 Also see the |line2byte()| function, and the 'o'
353 option in 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 {not available when compiled without the
355 |+byte_offset| feature}
356
357These commands move to the specified line. They stop when reaching the first
358or the last line. The first two commands put the cursor in the same column
359(if possible) as it was after the last command that changed the column,
360except after the "$" command, then the cursor will be put on the last
361character of the line.
362
Bram Moolenaar7c626922005-02-07 22:01:03 +0000363If "k", "-" or CTRL-P is used with a [count] and there are less than [count]
364lines above the cursor and the 'cpo' option includes the "-" flag it is an
365error. |cpo--|.
366
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367==============================================================================
3684. Word motions *word-motions*
369
370<S-Right> or *<S-Right>* *w*
371w [count] words forward. |exclusive| motion.
372
373<C-Right> or *<C-Right>* *W*
374W [count] WORDS forward. |exclusive| motion.
375
376 *e*
377e Forward to the end of word [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000378 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379
380 *E*
381E Forward to the end of WORD [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000382 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383
384<S-Left> or *<S-Left>* *b*
385b [count] words backward. |exclusive| motion.
386
387<C-Left> or *<C-Left>* *B*
388B [count] WORDS backward. |exclusive| motion.
389
390 *ge*
391ge Backward to the end of word [count] |inclusive|.
392
393 *gE*
394gE Backward to the end of WORD [count] |inclusive|.
395
396These commands move over words or WORDS.
397 *word*
398A word consists of a sequence of letters, digits and underscores, or a
399sequence of other non-blank characters, separated with white space (spaces,
Bram Moolenaar4770d092006-01-12 23:22:24 +0000400tabs, <EOL>). This can be changed with the 'iskeyword' option. An empty line
401is also considered to be a word.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402 *WORD*
403A WORD consists of a sequence of non-blank characters, separated with white
Bram Moolenaar4770d092006-01-12 23:22:24 +0000404space. An empty line is also considered to be a WORD.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405
406A sequence of folded lines is counted for one word of a single character.
407"w" and "W", "e" and "E" move to the start/end of the first word or WORD after
408a range of folded lines. "b" and "B" move to the start of the first word or
409WORD before the fold.
410
411Special case: "cw" and "cW" are treated like "ce" and "cE" if the cursor is
412on a non-blank. This is because "cw" is interpreted as change-word, and a
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200413word does not include the following white space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414
415Another special case: When using the "w" motion in combination with an
416operator and the last word moved over is at the end of a line, the end of
417that word becomes the end of the operated text, not the first word in the
418next line.
419
420The original Vi implementation of "e" is buggy. For example, the "e" command
421will stop on the first character of a line if the previous line was empty.
422But when you use "2e" this does not happen. In Vim "ee" and "2e" are the
423same, which is more logical. However, this causes a small incompatibility
424between Vi and Vim.
425
426==============================================================================
4275. Text object motions *object-motions*
428
429 *(*
430( [count] sentences backward. |exclusive| motion.
431
432 *)*
433) [count] sentences forward. |exclusive| motion.
434
435 *{*
436{ [count] paragraphs backward. |exclusive| motion.
437
438 *}*
439} [count] paragraphs forward. |exclusive| motion.
440
441 *]]*
442]] [count] sections forward or to the next '{' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000443 first column. When used after an operator, then also
444 stops below a '}' in the first column. |exclusive|
445 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
447 *][*
448][ [count] sections forward or to the next '}' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000449 first column. |exclusive|
450 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451
452 *[[*
453[[ [count] sections backward or to the previous '{' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000454 the first column. |exclusive|
455 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456
457 *[]*
458[] [count] sections backward or to the previous '}' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000459 the first column. |exclusive|
460 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461
462These commands move over three kinds of text objects.
463
464 *sentence*
465A sentence is defined as ending at a '.', '!' or '?' followed by either the
466end of a line, or by a space or tab. Any number of closing ')', ']', '"'
467and ''' characters may appear after the '.', '!' or '?' before the spaces,
468tabs or end of line. A paragraph and section boundary is also a sentence
469boundary.
470If the 'J' flag is present in 'cpoptions', at least two spaces have to
471follow the punctuation mark; <Tab>s are not recognized as white space.
472The definition of a sentence cannot be changed.
473
474 *paragraph*
475A paragraph begins after each empty line, and also at each of a set of
476paragraph macros, specified by the pairs of characters in the 'paragraphs'
Bram Moolenaar446cb832008-06-24 21:56:24 +0000477option. The default is "IPLPPPQPP TPHPLIPpLpItpplpipbp", which corresponds to
478the macros ".IP", ".LP", etc. (These are nroff macros, so the dot must be in
479the first column). A section boundary is also a paragraph boundary.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000480Note that a blank line (only containing white space) is NOT a paragraph
481boundary.
482Also note that this does not include a '{' or '}' in the first column. When
483the '{' flag is in 'cpoptions' then '{' in the first column is used as a
484paragraph boundary |posix|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 *section*
487A section begins after a form-feed (<C-L>) in the first column and at each of
488a set of section macros, specified by the pairs of characters in the
489'sections' option. The default is "SHNHH HUnhsh", which defines a section to
490start at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
491
492The "]" and "[" commands stop at the '{' or '}' in the first column. This is
493useful to find the start or end of a function in a C program. Note that the
494first character of the command determines the search direction and the
495second character the type of brace found.
496
497If your '{' or '}' are not in the first column, and you would like to use "[["
498and "]]" anyway, try these mappings: >
499 :map [[ ?{<CR>w99[{
500 :map ][ /}<CR>b99]}
501 :map ]] j0[[%/{<CR>
502 :map [] k$][%?}<CR>
503[type these literally, see |<>|]
504
505==============================================================================
5066. Text object selection *object-select* *text-objects*
507 *v_a* *v_i*
508
509This is a series of commands that can only be used while in Visual mode or
510after an operator. The commands that start with "a" select "a"n object
511including white space, the commands starting with "i" select an "inner" object
512without white space, or just the white space. Thus the "inner" commands
513always select less text than the "a" commands.
514
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515These commands are not available when the |+textobjects| feature has been
516disabled at compile time.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200517Also see `gn` and `gN`, operating on the last search pattern.
518
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 *v_aw* *aw*
520aw "a word", select [count] words (see |word|).
521 Leading or trailing white space is included, but not
522 counted.
523 When used in Visual linewise mode "aw" switches to
524 Visual characterwise mode.
525
526 *v_iw* *iw*
527iw "inner word", select [count] words (see |word|).
528 White space between words is counted too.
529 When used in Visual linewise mode "iw" switches to
530 Visual characterwise mode.
531
532 *v_aW* *aW*
533aW "a WORD", select [count] WORDs (see |WORD|).
534 Leading or trailing white space is included, but not
535 counted.
536 When used in Visual linewise mode "aW" switches to
537 Visual characterwise mode.
538
539 *v_iW* *iW*
540iW "inner WORD", select [count] WORDs (see |WORD|).
541 White space between words is counted too.
542 When used in Visual linewise mode "iW" switches to
543 Visual characterwise mode.
544
545 *v_as* *as*
546as "a sentence", select [count] sentences (see
547 |sentence|).
548 When used in Visual mode it is made characterwise.
549
550 *v_is* *is*
551is "inner sentence", select [count] sentences (see
552 |sentence|).
553 When used in Visual mode it is made characterwise.
554
555 *v_ap* *ap*
556ap "a paragraph", select [count] paragraphs (see
557 |paragraph|).
558 Exception: a blank line (only containing white space)
559 is also a paragraph boundary.
560 When used in Visual mode it is made linewise.
561
562 *v_ip* *ip*
563ip "inner paragraph", select [count] paragraphs (see
564 |paragraph|).
565 Exception: a blank line (only containing white space)
566 is also a paragraph boundary.
567 When used in Visual mode it is made linewise.
568
569a] *v_a]* *v_a[* *a]* *a[*
570a[ "a [] block", select [count] '[' ']' blocks. This
571 goes backwards to the [count] unclosed '[', and finds
572 the matching ']'. The enclosed text is selected,
573 including the '[' and ']'.
574 When used in Visual mode it is made characterwise.
575
576i] *v_i]* *v_i[* *i]* *i[*
577i[ "inner [] block", select [count] '[' ']' blocks. This
578 goes backwards to the [count] unclosed '[', and finds
579 the matching ']'. The enclosed text is selected,
580 excluding the '[' and ']'.
581 When used in Visual mode it is made characterwise.
582
583a) *v_a)* *a)* *a(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200584a( *vab* *v_ab* *v_a(* *ab*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585ab "a block", select [count] blocks, from "[count] [(" to
586 the matching ')', including the '(' and ')' (see
587 |[(|). Does not include white space outside of the
588 parenthesis.
589 When used in Visual mode it is made characterwise.
590
591i) *v_i)* *i)* *i(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200592i( *vib* *v_ib* *v_i(* *ib*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593ib "inner block", select [count] blocks, from "[count] [("
594 to the matching ')', excluding the '(' and ')' (see
595 |[(|).
596 When used in Visual mode it is made characterwise.
597
598a> *v_a>* *v_a<* *a>* *a<*
599a< "a <> block", select [count] <> blocks, from the
600 [count]'th unmatched '<' backwards to the matching
601 '>', including the '<' and '>'.
602 When used in Visual mode it is made characterwise.
603
604i> *v_i>* *v_i<* *i>* *i<*
605i< "inner <> block", select [count] <> blocks, from
606 the [count]'th unmatched '<' backwards to the matching
607 '>', excluding the '<' and '>'.
608 When used in Visual mode it is made characterwise.
609
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000610 *v_at* *at*
611at "a tag block", select [count] tag blocks, from the
612 [count]'th unmatched "<aaa>" backwards to the matching
613 "</aaa>", including the "<aaa>" and "</aaa>".
614 See |tag-blocks| about the details.
615 When used in Visual mode it is made characterwise.
616
617 *v_it* *it*
618it "inner tag block", select [count] tag blocks, from the
619 [count]'th unmatched "<aaa>" backwards to the matching
620 "</aaa>", excluding the "<aaa>" and "</aaa>".
621 See |tag-blocks| about the details.
622 When used in Visual mode it is made characterwise.
623
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624a} *v_a}* *a}* *a{*
625a{ *v_aB* *v_a{* *aB*
626aB "a Block", select [count] Blocks, from "[count] [{" to
627 the matching '}', including the '{' and '}' (see
628 |[{|).
629 When used in Visual mode it is made characterwise.
630
631i} *v_i}* *i}* *i{*
632i{ *v_iB* *v_i{* *iB*
633iB "inner Block", select [count] Blocks, from "[count] [{"
634 to the matching '}', excluding the '{' and '}' (see
635 |[{|).
636 When used in Visual mode it is made characterwise.
637
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000638a" *v_aquote* *aquote*
639a' *v_a'* *a'*
640a` *v_a`* *a`*
641 "a quoted string". Selects the text from the previous
Bram Moolenaar5a305422006-04-28 22:38:25 +0000642 quote until the next quote. The 'quoteescape' option
643 is used to skip escaped quotes.
644 Only works within one line.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000645 When the cursor starts on a quote, Vim will figure out
646 which quote pairs form a string by searching from the
647 start of the line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100648 Any trailing white space is included, unless there is
649 none, then leading white space is included.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000650 When used in Visual mode it is made characterwise.
651 Repeating this object in Visual mode another string is
652 included. A count is currently not used.
653
654i" *v_iquote* *iquote*
655i' *v_i'* *i'*
656i` *v_i`* *i`*
657 Like a", a' and a`, but exclude the quotes and
658 repeating won't extend the Visual selection.
Bram Moolenaarab194812005-09-14 21:40:12 +0000659 Special case: With a count of 2 the quotes are
660 included, but no extra white space as with a"/a'/a`.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000661
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662When used after an operator:
663For non-block objects:
664 For the "a" commands: The operator applies to the object and the white
665 space after the object. If there is no white space after the object
666 or when the cursor was in the white space before the object, the white
667 space before the object is included.
668 For the "inner" commands: If the cursor was on the object, the
669 operator applies to the object. If the cursor was on white space, the
670 operator applies to the white space.
671For a block object:
672 The operator applies to the block where the cursor is in, or the block
673 on which the cursor is on one of the braces. For the "inner" commands
674 the surrounding braces are excluded. For the "a" commands, the braces
675 are included.
676
677When used in Visual mode:
678When start and end of the Visual area are the same (just after typing "v"):
679 One object is selected, the same as for using an operator.
680When start and end of the Visual area are not the same:
681 For non-block objects the area is extended by one object or the white
682 space up to the next object, or both for the "a" objects. The
683 direction in which this happens depends on which side of the Visual
684 area the cursor is. For the block objects the block is extended one
685 level outwards.
686
687For illustration, here is a list of delete commands, grouped from small to big
688objects. Note that for a single character and a whole line the existing vi
689movement commands are used.
690 "dl" delete character (alias: "x") |dl|
691 "diw" delete inner word *diw*
692 "daw" delete a word *daw*
693 "diW" delete inner WORD (see |WORD|) *diW*
694 "daW" delete a WORD (see |WORD|) *daW*
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200695 "dgn" delete the next search pattern match *dgn*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 "dd" delete one line |dd|
697 "dis" delete inner sentence *dis*
698 "das" delete a sentence *das*
699 "dib" delete inner '(' ')' block *dib*
700 "dab" delete a '(' ')' block *dab*
701 "dip" delete inner paragraph *dip*
702 "dap" delete a paragraph *dap*
703 "diB" delete inner '{' '}' block *diB*
704 "daB" delete a '{' '}' block *daB*
705
706Note the difference between using a movement command and an object. The
707movement command operates from here (cursor position) to where the movement
708takes us. When using an object the whole object is operated upon, no matter
709where on the object the cursor is. For example, compare "dw" and "daw": "dw"
710deletes from the cursor position to the start of the next word, "daw" deletes
711the word under the cursor and the space after or before it.
712
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000713
714Tag blocks *tag-blocks*
715
716For the "it" and "at" text objects an attempt is done to select blocks between
717matching tags for HTML and XML. But since these are not completely compatible
718there are a few restrictions.
719
720The normal method is to select a <tag> until the matching </tag>. For "at"
721the tags are included, for "it" they are excluded. But when "it" is repeated
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000722the tags will be included (otherwise nothing would change). Also, "it" used
723on a tag block with no contents will select the leading tag.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000724
725"<aaa/>" items are skipped. Case is ignored, also for XML where case does
726matter.
727
728In HTML it is possible to have a tag like <br> or <meta ...> without a
729matching end tag. These are ignored.
730
731The text objects are tolerant about mistakes. Stray end tags are ignored.
732
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733==============================================================================
7347. Marks *mark-motions* *E20* *E78*
735
736Jumping to a mark can be done in two ways:
7371. With ` (backtick): The cursor is positioned at the specified location
738 and the motion is |exclusive|.
7392. With ' (single quote): The cursor is positioned on the first non-blank
740 character in the line of the specified location and
741 the motion is linewise.
742
743 *m* *mark* *Mark*
744m{a-zA-Z} Set mark {a-zA-Z} at cursor position (does not move
745 the cursor, this is not a motion command).
746
747 *m'* *m`*
748m' or m` Set the previous context mark. This can be jumped to
749 with the "''" or "``" command (does not move the
750 cursor, this is not a motion command).
751
752 *m[* *m]*
753m[ or m] Set the |'[| or |']| mark. Useful when an operator is
754 to be simulated by multiple commands. (does not move
755 the cursor, this is not a motion command).
756
Bram Moolenaar30b65812012-07-12 22:01:11 +0200757 *m<* *m>*
758m< or m> Set the |'<| or |'>| mark. Useful to change what the
759 `gv` command selects. (does not move the cursor, this
760 is not a motion command).
761 Note that the Visual mode cannot be set, only the
762 start and end position.
763
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 *:ma* *:mark* *E191*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000765:[range]ma[rk] {a-zA-Z'}
766 Set mark {a-zA-Z'} at last line number in [range],
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 column 0. Default is cursor line.
768
769 *:k*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000770:[range]k{a-zA-Z'} Same as :mark, but the space before the mark name can
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 be omitted.
772
773 *'* *'a* *`* *`a*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000774'{a-z} `{a-z} Jump to the mark {a-z} in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775
776 *'A* *'0* *`A* *`0*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000777'{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 +0200778 a motion command when in another file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779
780 *g'* *g'a* *g`* *g`a*
781g'{mark} g`{mark}
782 Jump to the {mark}, but don't change the jumplist when
783 jumping within the current buffer. Example: >
784 g`"
785< jumps to the last known position in a file. See
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000786 $VIMRUNTIME/vimrc_example.vim.
787 Also see |:keepjumps|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788
789 *:marks*
790:marks List all the current marks (not a motion command).
791 The |'(|, |')|, |'{| and |'}| marks are not listed.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000792 The first column has number zero.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200793
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 *E283*
795:marks {arg} List the marks that are mentioned in {arg} (not a
796 motion command). For example: >
797 :marks aB
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200798< to list marks 'a' and 'B'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000800 *:delm* *:delmarks*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000801:delm[arks] {marks} Delete the specified marks. Marks that can be deleted
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000802 include A-Z and 0-9. You cannot delete the ' mark.
803 They can be specified by giving the list of mark
804 names, or with a range, separated with a dash. Spaces
805 are ignored. Examples: >
806 :delmarks a deletes mark a
807 :delmarks a b 1 deletes marks a, b and 1
808 :delmarks Aa deletes marks A and a
809 :delmarks p-z deletes marks in the range p to z
810 :delmarks ^.[] deletes marks ^ . [ ]
811 :delmarks \" deletes mark "
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000812
813:delm[arks]! Delete all marks for the current buffer, but not marks
814 A-Z or 0-9.
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000815
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816A mark is not visible in any way. It is just a position in the file that is
817remembered. Do not confuse marks with named registers, they are totally
818unrelated.
819
820'a - 'z lowercase marks, valid within one file
821'A - 'Z uppercase marks, also called file marks, valid between files
822'0 - '9 numbered marks, set from .viminfo file
823
824Lowercase marks 'a to 'z are remembered as long as the file remains in the
825buffer list. If you remove the file from the buffer list, all its marks are
826lost. If you delete a line that contains a mark, that mark is erased.
827
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828Lowercase marks can be used in combination with operators. For example: "d't"
829deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for
830Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and
831redo.
832
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200833Uppercase marks 'A to 'Z include the file name. You can use them to jump from
834file to file. You can only use an uppercase mark with an operator if the mark
835is in the current file. The line number of the mark remains correct, even if
836you insert/delete lines or edit another file for a moment. When the 'viminfo'
837option is not empty, uppercase marks are kept in the .viminfo file. See
838|viminfo-file-marks|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839
840Numbered marks '0 to '9 are quite different. They can not be set directly.
841They are only present when using a viminfo file |viminfo-file|. Basically '0
842is the location of the cursor when you last exited Vim, '1 the last but one
843time, etc. Use the "r" flag in 'viminfo' to specify files for which no
844Numbered mark should be stored. See |viminfo-file-marks|.
845
846
847 *'[* *`[*
848'[ `[ To the first character of the previously changed
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200849 or yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850
851 *']* *`]*
852'] `] To the last character of the previously changed or
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200853 yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855After executing an operator the Cursor is put at the beginning of the text
856that was operated upon. After a put command ("p" or "P") the cursor is
857sometimes placed at the first inserted line and sometimes on the last inserted
858character. The four commands above put the cursor at either end. Example:
859After yanking 10 lines you want to go to the last one of them: "10Y']". After
860inserting several lines with the "p" command you want to jump to the lowest
861inserted line: "p']". This also works for text that has been inserted.
862
863Note: After deleting text, the start and end positions are the same, except
864when using blockwise Visual mode. These commands do not work when no change
865was made yet in the current file.
866
867 *'<* *`<*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000868'< `< To the first line or character of the last selected
869 Visual area in the current buffer. For block mode it
870 may also be the last character in the first line (to
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200871 be able to define the block).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873 *'>* *`>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000874'> `> To the last line or character of the last selected
875 Visual area in the current buffer. For block mode it
876 may also be the first character of the last line (to
877 be able to define the block). Note that 'selection'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000878 applies, the position may be just after the Visual
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200879 area.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880
881 *''* *``*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000882'' `` To the position before the latest jump, or where the
883 last "m'" or "m`" command was given. Not set when the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 |:keepjumps| command modifier was used.
885 Also see |restore-position|.
886
887 *'quote* *`quote*
888'" `" To the cursor position when last exiting the current
889 buffer. Defaults to the first character of the first
890 line. See |last-position-jump| for how to use this
891 for each opened file.
892 Only one position is remembered per buffer, not one
893 for each window. As long as the buffer is visible in
894 a window the position won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895
896 *'^* *`^*
897'^ `^ To the position where the cursor was the last time
Bram Moolenaar81695252004-12-29 20:58:21 +0000898 when Insert mode was stopped. This is used by the
899 |gi| command. Not set when the |:keepjumps| command
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200900 modifier was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
902 *'.* *`.*
903'. `. To the position where the last change was made. The
904 position is at or near where the change started.
905 Sometimes a command is executed as several changes,
906 then the position can be near the end of what the
907 command changed. For example when inserting a word,
908 the position will be on the last character.
Bram Moolenaar51628222016-12-01 23:03:28 +0100909 To jump to older changes use |g;|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910
911 *'(* *`(*
912'( `( To the start of the current sentence, like the |(|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200913 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914
915 *')* *`)*
916') `) To the end of the current sentence, like the |)|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200917 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918
919 *'{* *`{*
920'{ `{ To the start of the current paragraph, like the |{|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200921 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 *'}* *`}*
924'} `} To the end of the current paragraph, like the |}|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200925 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927These commands are not marks themselves, but jump to a mark:
928
929 *]'*
930]' [count] times to next line with a lowercase mark below
931 the cursor, on the first non-blank character in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200932 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933
934 *]`*
935]` [count] times to lowercase mark after the cursor. {not
936 in Vi}
937
938 *['*
939[' [count] times to previous line with a lowercase mark
940 before the cursor, on the first non-blank character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200941 the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942
943 *[`*
944[` [count] times to lowercase mark before the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200947:loc[kmarks] {command} *:loc* *:lock* *:lockmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 Execute {command} without adjusting marks. This is
949 useful when changing text in a way that the line count
950 will be the same when the change has completed.
951 WARNING: When the line count does change, marks below
952 the change will keep their line number, thus move to
953 another text line.
954 These items will not be adjusted for deleted/inserted
955 lines:
956 - lower case letter marks 'a - 'z
957 - upper case letter marks 'A - 'Z
958 - numbered marks '0 - '9
959 - last insert position '^
960 - last change position '.
961 - the Visual area '< and '>
962 - line numbers in placed signs
963 - line numbers in quickfix positions
964 - positions in the |jumplist|
965 - positions in the |tagstack|
966 These items will still be adjusted:
967 - previous context mark ''
968 - the cursor position
969 - the view of a window on a buffer
970 - folds
971 - diffs
972
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200973:kee[pmarks] {command} *:kee* *:keep* *:keepmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 Currently only has effect for the filter command
975 |:range!|:
976 - When the number of lines after filtering is equal to
977 or larger than before, all marks are kept at the
978 same line number.
979 - When the number of lines decreases, the marks in the
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000980 lines that disappeared are deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 In any case the marks below the filtered text have
982 their line numbers adjusted, thus stick to the text,
983 as usual.
984 When the 'R' flag is missing from 'cpoptions' this has
985 the same effect as using ":keepmarks".
986
987 *:keepj* *:keepjumps*
988:keepj[umps] {command}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000989 Moving around in {command} does not change the |''|,
990 |'.| and |'^| marks, the |jumplist| or the
991 |changelist|.
992 Useful when making a change or inserting text
993 automatically and the user doesn't want to go to this
994 position. E.g., when updating a "Last change"
995 timestamp in the first line: >
996
Bram Moolenaare5180522005-12-10 20:19:46 +0000997 :let lnum = line(".")
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000998 :keepjumps normal gg
999 :call SetLastChange()
1000 :keepjumps exe "normal " . lnum . "G"
1001<
1002 Note that ":keepjumps" must be used for every command.
1003 When invoking a function the commands in that function
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001004 can still change the jumplist. Also, for
Bram Moolenaar13065c42005-01-08 16:08:21 +00001005 ":keepjumps exe 'command '" the "command" won't keep
1006 jumps. Instead use: ":exe 'keepjumps command'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007
1008==============================================================================
10098. Jumps *jump-motions*
1010
Bram Moolenaarb477af22018-07-15 20:20:18 +02001011A "jump" is a command that normally moves the cursor several lines away. If
1012you make the cursor "jump" the position of the cursor before the jump is
Bram Moolenaar26967612019-03-17 17:13:16 +01001013remembered. You can return to that position with the "''" and "``" commands,
Bram Moolenaarb477af22018-07-15 20:20:18 +02001014unless the line containing that position was changed or deleted. The
1015following commands are "jump" commands: "'", "`", "G", "/", "?", "n", "N",
1016"%", "(", ")", "[[", "]]", "{", "}", ":s", ":tag", "L", "M", "H" and the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001017commands that start editing a new file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 *CTRL-O*
1020CTRL-O Go to [count] Older cursor position in jump list
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001021 (not a motion command).
Bram Moolenaardb84e452010-08-15 13:50:43 +02001022 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023
1024<Tab> or *CTRL-I* *<Tab>*
1025CTRL-I Go to [count] newer cursor position in jump list
1026 (not a motion command).
Bram Moolenaardb84e452010-08-15 13:50:43 +02001027 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028
1029 *:ju* *:jumps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001030:ju[mps] Print the jump list (not a motion command).
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001031 {not available without the |+jumplist| feature}
1032
1033 *:cle* *:clearjumps*
1034:cle[arjumps] Clear the jump list of the current window.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001035 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
1037 *jumplist*
1038Jumps are remembered in a jump list. With the CTRL-O and CTRL-I command you
1039can go to cursor positions before older jumps, and back again. Thus you can
1040move up and down the list. There is a separate jump list for each window.
1041The maximum number of entries is fixed at 100.
Bram Moolenaardb84e452010-08-15 13:50:43 +02001042{not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043
1044For example, after three jump commands you have this jump list:
1045
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001046 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 3 1 0 some text ~
1048 2 70 0 another line ~
1049 1 1154 23 end. ~
1050 > ~
1051
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001052The "file/text" column shows the file name, or the text at the jump if it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053in the current file (an indent is removed and a long line is truncated to fit
1054in the window).
1055
1056You are currently in line 1167. If you then use the CTRL-O command, the
1057cursor is put in line 1154. This results in:
1058
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001059 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 2 1 0 some text ~
1061 1 70 0 another line ~
1062 > 0 1154 23 end. ~
1063 1 1167 0 foo bar ~
1064
1065The pointer will be set at the last used jump position. The next CTRL-O
1066command will use the entry above it, the next CTRL-I command will use the
1067entry below it. If the pointer is below the last entry, this indicates that
1068you did not use a CTRL-I or CTRL-O before. In this case the CTRL-O command
1069will cause the cursor position to be added to the jump list, so you can get
1070back to the position before the CTRL-O. In this case this is line 1167.
1071
1072With more CTRL-O commands you will go to lines 70 and 1. If you use CTRL-I
1073you can go back to 1154 and 1167 again. Note that the number in the "jump"
1074column indicates the count for the CTRL-O or CTRL-I command that takes you to
1075this position.
1076
1077If you use a jump command, the current line number is inserted at the end of
1078the jump list. If the same line was already in the jump list, it is removed.
1079The result is that when repeating CTRL-O you will get back to old positions
1080only once.
1081
1082When the |:keepjumps| command modifier is used, jumps are not stored in the
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001083jumplist. Jumps are also not stored in other cases, e.g., in a |:global|
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001084command. You can explicitly add a jump by setting the ' mark with "m'". Note
1085that calling setpos() does not do this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086
1087After the CTRL-O command that got you into line 1154 you could give another
1088jump command (e.g., "G"). The jump list would then become:
1089
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001090 jump line col file/text ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 4 1 0 some text ~
1092 3 70 0 another line ~
1093 2 1167 0 foo bar ~
1094 1 1154 23 end. ~
1095 > ~
1096
1097The line numbers will be adjusted for deleted and inserted lines. This fails
1098if you stop editing a file without writing, like with ":n!".
1099
1100When you split a window, the jumplist will be copied to the new window.
1101
1102If you have included the ' item in the 'viminfo' option the jumplist will be
1103stored in the viminfo file and restored when starting Vim.
1104
1105
1106CHANGE LIST JUMPS *changelist* *change-list-jumps* *E664*
1107
1108When making a change the cursor position is remembered. One position is
1109remembered for every change that can be undone, unless it is close to a
1110previous change. Two commands can be used to jump to positions of changes,
1111also those that have been undone:
1112
1113 *g;* *E662*
1114g; Go to [count] older position in change list.
1115 If [count] is larger than the number of older change
1116 positions go to the oldest change.
1117 If there is no older change an error message is given.
1118 (not a motion command)
Bram Moolenaardb84e452010-08-15 13:50:43 +02001119 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
1121 *g,* *E663*
1122g, Go to [count] newer cursor position in change list.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001123 Just like |g;| but in the opposite direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 (not a motion command)
Bram Moolenaardb84e452010-08-15 13:50:43 +02001125 {not available without the |+jumplist| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127When using a count you jump as far back or forward as possible. Thus you can
1128use "999g;" to go to the first change for which the position is still
1129remembered. The number of entries in the change list is fixed and is the same
1130as for the |jumplist|.
1131
1132When two undo-able changes are in the same line and at a column position less
1133than 'textwidth' apart only the last one is remembered. This avoids that a
1134sequence of small changes in a line, for example "xxxxx", adds many positions
1135to the change list. When 'textwidth' is zero 'wrapmargin' is used. When that
1136also isn't set a fixed number of 79 is used. Detail: For the computations
1137bytes are used, not characters, to avoid a speed penalty (this only matters
1138for multi-byte encodings).
1139
1140Note that when text has been inserted or deleted the cursor position might be
1141a bit different from the position of the change. Especially when lines have
1142been deleted.
1143
1144When the |:keepjumps| command modifier is used the position of a change is not
1145remembered.
1146
1147 *:changes*
1148:changes Print the change list. A ">" character indicates the
1149 current position. Just after a change it is below the
Bram Moolenaara9604e62018-07-21 05:56:22 +02001150 newest entry, indicating that `g;` takes you to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151 newest entry position. The first column indicates the
1152 count needed to take you to this position. Example:
1153
1154 change line col text ~
1155 3 9 8 bla bla bla
1156 2 11 57 foo is a bar
1157 1 14 54 the latest changed line
1158 >
1159
Bram Moolenaara9604e62018-07-21 05:56:22 +02001160 The `3g;` command takes you to line 9. Then the
1161 output of `:changes` is:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 change line col text ~
1164 > 0 9 8 bla bla bla
1165 1 11 57 foo is a bar
1166 2 14 54 the latest changed line
1167
1168 Now you can use "g," to go to line 11 and "2g," to go
1169 to line 14.
1170
1171==============================================================================
11729. Various motions *various-motions*
1173
1174 *%*
1175% Find the next item in this line after or under the
1176 cursor and jump to its match. |inclusive| motion.
1177 Items can be:
1178 ([{}]) parenthesis or (curly/square) brackets
1179 (this can be changed with the
1180 'matchpairs' option)
1181 /* */ start or end of C-style comment
1182 #if, #ifdef, #else, #elif, #endif
1183 C preprocessor conditionals (when the
1184 cursor is on the # or no ([{
1185 following)
1186 For other items the matchit plugin can be used, see
Bram Moolenaar446cb832008-06-24 21:56:24 +00001187 |matchit-install|. This plugin also helps to skip
1188 matches in comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189
1190 When 'cpoptions' contains "M" |cpo-M| backslashes
1191 before parens and braces are ignored. Without "M" the
1192 number of backslashes matters: an even number doesn't
1193 match with an odd number. Thus in "( \) )" and "\( (
1194 \)" the first and last parenthesis match.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001195
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 When the '%' character is not present in 'cpoptions'
1197 |cpo-%|, parens and braces inside double quotes are
1198 ignored, unless the number of parens/braces in a line
1199 is uneven and this line and the previous one does not
1200 end in a backslash. '(', '{', '[', ']', '}' and ')'
1201 are also ignored (parens and braces inside single
1202 quotes). Note that this works fine for C, but not for
1203 Perl, where single quotes are used for strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001204
1205 Nothing special is done for matches in comments. You
1206 can either use the matchit plugin |matchit-install| or
1207 put quotes around matches.
1208
1209 No count is allowed, {count}% jumps to a line {count}
1210 percentage down the file |N%|. Using '%' on
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 #if/#else/#endif makes the movement linewise.
1212
1213 *[(*
1214[( go to [count] previous unmatched '('.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001215 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
1217 *[{*
1218[{ go to [count] previous unmatched '{'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001219 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 *])*
1222]) go to [count] next unmatched ')'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001223 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224
1225 *]}*
1226]} go to [count] next unmatched '}'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001227 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228
1229The above four commands can be used to go to the start or end of the current
1230code block. It is like doing "%" on the '(', ')', '{' or '}' at the other
1231end of the code block, but you can do this from anywhere in the code block.
1232Very useful for C programs. Example: When standing on "case x:", "[{" will
1233bring you back to the switch statement.
1234
1235 *]m*
1236]m Go to [count] next start of a method (for Java or
1237 similar structured language). When not before the
1238 start of a method, jump to the start or end of the
1239 class. When no '{' is found after the cursor, this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001240 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 *]M*
1242]M Go to [count] next end of a method (for Java or
1243 similar structured language). When not before the end
1244 of a method, jump to the start or end of the class.
1245 When no '}' is found after the cursor, this is an
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001246 error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 *[m*
1248[m Go to [count] previous start of a method (for Java or
1249 similar structured language). When not after the
1250 start of a method, jump to the start or end of the
1251 class. When no '{' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001252 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 *[M*
1254[M Go to [count] previous end of a method (for Java or
1255 similar structured language). When not after the
1256 end of a method, jump to the start or end of the
1257 class. When no '}' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001258 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259
1260The above two commands assume that the file contains a class with methods.
1261The class definition is surrounded in '{' and '}'. Each method in the class
1262is also surrounded with '{' and '}'. This applies to the Java language. The
1263file looks like this: >
1264
1265 // comment
1266 class foo {
1267 int method_one() {
1268 body_one();
1269 }
1270 int method_two() {
1271 body_two();
1272 }
1273 }
1274Starting with the cursor on "body_two()", using "[m" will jump to the '{' at
1275the start of "method_two()" (obviously this is much more useful when the
1276method is long!). Using "2[m" will jump to the start of "method_one()".
1277Using "3[m" will jump to the start of the class.
1278
1279 *[#*
1280[# go to [count] previous unmatched "#if" or "#else".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001281 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282
1283 *]#*
1284]# go to [count] next unmatched "#else" or "#endif".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001285 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286
1287These two commands work in C programs that contain #if/#else/#endif
1288constructs. It brings you to the start or end of the #if/#else/#endif where
1289the current line is included. You can then use "%" to go to the matching line.
1290
1291 *[star* *[/*
1292[* or [/ go to [count] previous start of a C comment "/*".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001293 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294
1295 *]star* *]/*
1296]* or ]/ go to [count] next end of a C comment "*/".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001297 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298
1299
1300 *H*
1301H To line [count] from top (Home) of window (default:
1302 first line on the window) on the first non-blank
1303 character |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001304 Cursor is adjusted for 'scrolloff' option, unless an
1305 operator is pending, in which case the text may
1306 scroll. E.g. "yH" yanks from the first visible line
1307 until the cursor line (inclusive).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308
1309 *M*
1310M To Middle line of window, on the first non-blank
1311 character |linewise|. See also 'startofline' option.
1312
1313 *L*
1314L To line [count] from bottom of window (default: Last
1315 line on the window) on the first non-blank character
1316 |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001317 Cursor is adjusted for 'scrolloff' option, unless an
1318 operator is pending, in which case the text may
1319 scroll. E.g. "yL" yanks from the cursor to the last
1320 visible line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321
1322<LeftMouse> Moves to the position on the screen where the mouse
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001323 click is |exclusive|. See also |<LeftMouse>|. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 position is in a status line, that window is made the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001325 active window and the cursor is not moved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001327 vim:tw=78:ts=8:noet:ft=help:norl: