blob: 2ddd1b9cec5539cdc5295ed0a859ee185810aa5f [file] [log] [blame]
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001*motion.txt* For Vim version 9.0. Last change: 2022 Sep 26
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
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010036positions where there is no character or within a multi-column character (like
37a tab).
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39==============================================================================
401. Motions and operators *operator*
41
42The motion commands can be used after an operator command, to have the command
43operate on the text that was moved over. That is the text between the cursor
44position before and after the motion. Operators are generally used to delete
45or change text. The following operators are available:
46
47 |c| c change
48 |d| d delete
49 |y| y yank into register (does not change the text)
50 |~| ~ swap case (only if 'tildeop' is set)
51 |g~| g~ swap case
52 |gu| gu make lowercase
53 |gU| gU make uppercase
54 |!| ! filter through an external program
55 |=| = filter through 'equalprg' or C-indenting if empty
56 |gq| gq text formatting
Bram Moolenaar68e65602019-05-26 21:33:31 +020057 |gw| gw text formatting with no cursor movement
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 |g?| g? ROT13 encoding
59 |>| > shift right
60 |<| < shift left
61 |zf| zf define a fold
Bram Moolenaar6c35bea2012-07-25 17:49:10 +020062 |g@| g@ call function set with the 'operatorfunc' option
Bram Moolenaar2346a632021-06-13 19:02:49 +020063 *motion-count-multiplied*
Bram Moolenaar071d4272004-06-13 20:20:40 +000064If the motion includes a count and the operator also had a count before it,
65the two counts are multiplied. For example: "2d3w" deletes six words.
Bram Moolenaar2346a632021-06-13 19:02:49 +020066 *operator-doubled*
67When doubling the operator it operates on a line. When using a count, before
68or after the first character, that many lines are operated upon. Thus `3dd`
69deletes three lines. A count before and after the first character is
70multiplied, thus `2y3y` yanks six lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +000071
72After applying the operator the cursor is mostly left at the start of the text
73that was operated upon. For example, "yfe" doesn't move the cursor, but "yFe"
74moves the cursor leftwards to the "e" where the yank started.
75
76 *linewise* *characterwise*
77The operator either affects whole lines, or the characters between the start
78and end position. Generally, motions that move between lines affect lines
79(are linewise), and motions that move within a line affect characters (are
80characterwise). However, there are some exceptions.
81
82 *exclusive* *inclusive*
Bram Moolenaar78984f52005-08-01 07:19:10 +000083A character motion is either inclusive or exclusive. When inclusive, the
84start and end position of the motion are included in the operation. When
85exclusive, the last character towards the end of the buffer is not included.
86Linewise motions always include the start and end position.
Bram Moolenaar071d4272004-06-13 20:20:40 +000087
Bram Moolenaar78984f52005-08-01 07:19:10 +000088Which motions are linewise, inclusive or exclusive is mentioned with the
89command. There are however, two general exceptions:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901. If the motion is exclusive and the end of the motion is in column 1, the
91 end of the motion is moved to the end of the previous line and the motion
92 becomes inclusive. Example: "}" moves to the first line after a paragraph,
93 but "d}" will not include that line.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000094 *exclusive-linewise*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952. If the motion is exclusive, the end of the motion is in column 1 and the
96 start of the motion was at or before the first non-blank in the line, the
97 motion becomes linewise. Example: If a paragraph begins with some blanks
98 and you do "d}" while standing on the first non-blank, all the lines of
99 the paragraph are deleted, including the blanks. If you do a put now, the
100 deleted lines will be inserted below the cursor position.
101
102Note that when the operator is pending (the operator command is typed, but the
103motion isn't yet), a special set of mappings can be used. See |:omap|.
104
105Instead of first giving the operator and then a motion you can use Visual
106mode: mark the start of the text with "v", move the cursor to the end of the
107text that is to be affected and then hit the operator. The text between the
108start and the cursor position is highlighted, so you can see what text will
109be operated upon. This allows much more freedom, but requires more key
110strokes and has limited redo functionality. See the chapter on Visual mode
111|Visual-mode|.
112
113You can use a ":" command for a motion. For example "d:call FindEnd()".
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100114But this can't be repeated with "." if the command is more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115This can be repeated: >
116 d:call search("f")<CR>
117This cannot be repeated: >
118 d:if 1<CR>
119 call search("f")<CR>
120 endif<CR>
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100121Note that when using ":" any motion becomes characterwise exclusive.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100123 *forced-motion*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124FORCING A MOTION TO BE LINEWISE, CHARACTERWISE OR BLOCKWISE
125
126When a motion is not of the type you would like to use, you can force another
127type by using "v", "V" or CTRL-V just after the operator.
128Example: >
129 dj
130deletes two lines >
131 dvj
132deletes from the cursor position until the character below the cursor >
133 d<C-V>j
134deletes the character under the cursor and the character below the cursor. >
135
136Be careful with forcing a linewise movement to be used characterwise or
137blockwise, the column may not always be defined.
138
139 *o_v*
140v When used after an operator, before the motion command: Force
141 the operator to work characterwise, also when the motion is
142 linewise. If the motion was linewise, it will become
143 |exclusive|.
144 If the motion already was characterwise, toggle
145 inclusive/exclusive. This can be used to make an exclusive
146 motion inclusive and an inclusive motion exclusive.
147
148 *o_V*
149V When used after an operator, before the motion command: Force
150 the operator to work linewise, also when the motion is
151 characterwise.
152
153 *o_CTRL-V*
154CTRL-V When used after an operator, before the motion command: Force
155 the operator to work blockwise. This works like Visual block
156 mode selection, with the corners defined by the cursor
157 position before and after the motion.
158
159==============================================================================
1602. Left-right motions *left-right-motions*
161
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100162These commands move the cursor to the specified column in the current line.
163They stop at the first column and at the end of the line, except "$", which
164may move to one of the next lines. See 'whichwrap' option to make some of the
165commands move across line boundaries.
166
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167h or *h*
168<Left> or *<Left>*
169CTRL-H or *CTRL-H* *<BS>*
170<BS> [count] characters to the left. |exclusive| motion.
171 Note: If you prefer <BS> to delete a character, use
172 the mapping:
173 :map CTRL-V<BS> X
174 (to enter "CTRL-V<BS>" type the CTRL-V key, followed
175 by the <BS> key)
176 See |:fixdel| if the <BS> key does not do what you
177 want.
178
179l or *l*
180<Right> or *<Right>* *<Space>*
181<Space> [count] characters to the right. |exclusive| motion.
Bram Moolenaarf2571c62015-06-09 19:44:55 +0200182 See the 'whichwrap' option for adjusting the behavior
183 at end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184
185 *0*
1860 To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000187 motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188
189 *<Home>* *<kHome>*
190<Home> To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000191 motion. When moving up or down next, stay in same
192 TEXT column (if possible). Most other commands stay
193 in the same SCREEN column. <Home> works like "1|",
194 which differs from "0" when the line starts with a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200195 <Tab>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
197 *^*
198^ To the first non-blank character of the line.
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100199 |exclusive| motion. Any count is ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200
201 *$* *<End>* *<kEnd>*
202$ or <End> To the end of the line. When a count is given also go
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100203 [count - 1] lines downward, or as far is possible.
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200204 |inclusive| motion. If a count of 2 or larger is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100205 given and the cursor is on the last line, that is an
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200206 error and the cursor doesn't move.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 In Visual mode the cursor goes to just after the last
208 character in the line.
209 When 'virtualedit' is active, "$" may move the cursor
210 back from past the end of the line to the last
211 character in the line.
212
213 *g_*
214g_ To the last non-blank character of the line and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200215 [count - 1] lines downward |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
217 *g0* *g<Home>*
218g0 or g<Home> When lines wrap ('wrap' on): To the first character of
219 the screen line. |exclusive| motion. Differs from
220 "0" when a line is wider than the screen.
221 When lines don't wrap ('wrap' off): To the leftmost
222 character of the current line that is on the screen.
223 Differs from "0" when the first character of the line
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200224 is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225
226 *g^*
227g^ When lines wrap ('wrap' on): To the first non-blank
228 character of the screen line. |exclusive| motion.
229 Differs from "^" when a line is wider than the screen.
230 When lines don't wrap ('wrap' off): To the leftmost
231 non-blank character of the current line that is on the
232 screen. Differs from "^" when the first non-blank
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200233 character of the line is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234
235 *gm*
236gm Like "g0", but half a screenwidth to the right (or as
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200237 much as possible).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000238
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100239 *gM*
Bram Moolenaar8b530c12019-10-28 02:13:05 +0100240gM Like "g0", but to halfway the text of the line.
241 With a count: to this percentage of text in the line.
242 Thus "10gM" is near the start of the text and "90gM"
243 is near the end of the text.
244
Christian Brabandtb5f6fe92023-08-19 15:53:16 +0200245 *g$*
246g$ When lines wrap ('wrap' on): To the last character of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000247 the screen line and [count - 1] screen lines downward
248 |inclusive|. Differs from "$" when a line is wider
249 than the screen.
250 When lines don't wrap ('wrap' off): To the rightmost
251 character of the current line that is visible on the
252 screen. Differs from "$" when the last character of
253 the line is not on the screen or when a count is used.
254 Additionally, vertical movements keep the column,
255 instead of going to the end of the line.
Bram Moolenaar9ba7e172013-07-17 22:37:26 +0200256 When 'virtualedit' is enabled moves to the end of the
257 screen line.
zeertzjq654bdbb2023-08-20 18:24:20 +0200258
259 *g<End>* *g<kEnd>*
Christian Brabandtb5f6fe92023-08-19 15:53:16 +0200260g<End> Like |g$| but to the last non-blank character
261 instead of the last character.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262
263 *bar*
264| To screen column [count] in the current line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100265 |exclusive| motion. Ceci n'est pas une pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266
267 *f*
268f{char} To [count]'th occurrence of {char} to the right. The
269 cursor is placed on {char} |inclusive|.
270 {char} can be entered as a digraph |digraph-arg|.
271 When 'encoding' is set to Unicode, composing
272 characters may be used, see |utf-8-char-arg|.
273 |:lmap| mappings apply to {char}. The CTRL-^ command
274 in Insert mode can be used to switch this on/off
275 |i_CTRL-^|.
276
277 *F*
278F{char} To the [count]'th occurrence of {char} to the left.
Bram Moolenaar78984f52005-08-01 07:19:10 +0000279 The cursor is placed on {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 {char} can be entered like with the |f| command.
281
282 *t*
283t{char} Till before [count]'th occurrence of {char} to the
284 right. The cursor is placed on the character left of
285 {char} |inclusive|.
286 {char} can be entered like with the |f| command.
287
288 *T*
289T{char} Till after [count]'th occurrence of {char} to the
290 left. The cursor is placed on the character right of
Bram Moolenaar78984f52005-08-01 07:19:10 +0000291 {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 {char} can be entered like with the |f| command.
293
294 *;*
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200295; Repeat latest f, t, F or T [count] times. See |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296
297 *,*
298, Repeat latest f, t, F or T in opposite direction
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200299 [count] times. See also |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301==============================================================================
3023. Up-down motions *up-down-motions*
303
304k or *k*
305<Up> or *<Up>* *CTRL-P*
306CTRL-P [count] lines upward |linewise|.
307
308j or *j*
309<Down> or *<Down>*
310CTRL-J or *CTRL-J*
311<NL> or *<NL>* *CTRL-N*
312CTRL-N [count] lines downward |linewise|.
313
314gk or *gk* *g<Up>*
315g<Up> [count] display lines upward. |exclusive| motion.
316 Differs from 'k' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200317 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318
319gj or *gj* *g<Down>*
320g<Down> [count] display lines downward. |exclusive| motion.
321 Differs from 'j' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200322 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324 *-*
325- <minus> [count] lines upward, on the first non-blank
326 character |linewise|.
327
328+ or *+*
329CTRL-M or *CTRL-M* *<CR>*
330<CR> [count] lines downward, on the first non-blank
331 character |linewise|.
332
333 *_*
334_ <underscore> [count] - 1 lines downward, on the first non-blank
335 character |linewise|.
336
337 *G*
338G Goto line [count], default last line, on the first
339 non-blank character |linewise|. If 'startofline' not
340 set, keep the same column.
Bram Moolenaar26967612019-03-17 17:13:16 +0100341 G is one of the |jump-motions|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342
343 *<C-End>*
344<C-End> Goto line [count], default last line, on the last
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200345 character |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346
347<C-Home> or *gg* *<C-Home>*
348gg Goto line [count], default first line, on the first
349 non-blank character |linewise|. If 'startofline' not
350 set, keep the same column.
351
Bram Moolenaar9b451252012-08-15 17:43:31 +0200352 *:[range]*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100353:[range] Set the cursor on the last line number in [range].
354 [range] can also be just one line number, e.g., ":1"
355 or ":'m".
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200356 In contrast with |G| this command does not modify the
357 |jumplist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358 *N%*
359{count}% Go to {count} percentage in the file, on the first
360 non-blank in the line |linewise|. To compute the new
361 line number this formula is used:
362 ({count} * number-of-lines + 99) / 100
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200363 See also 'startofline' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364
365:[range]go[to] [count] *:go* *:goto* *go*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100366[count]go Go to [count] byte in the buffer. Default [count] is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367 one, start of the file. When giving [range], the
368 last number in it used as the byte count. End-of-line
369 characters are counted depending on the current
370 'fileformat' setting.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200371 Also see the |line2byte()| function, and the 'o'
372 option in 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373 {not available when compiled without the
374 |+byte_offset| feature}
375
376These commands move to the specified line. They stop when reaching the first
377or the last line. The first two commands put the cursor in the same column
378(if possible) as it was after the last command that changed the column,
379except after the "$" command, then the cursor will be put on the last
380character of the line.
381
Bram Moolenaar7c626922005-02-07 22:01:03 +0000382If "k", "-" or CTRL-P is used with a [count] and there are less than [count]
383lines above the cursor and the 'cpo' option includes the "-" flag it is an
384error. |cpo--|.
385
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386==============================================================================
3874. Word motions *word-motions*
388
389<S-Right> or *<S-Right>* *w*
390w [count] words forward. |exclusive| motion.
391
392<C-Right> or *<C-Right>* *W*
393W [count] WORDS forward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000394 If <C-Right> does not work, check out
395 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396
397 *e*
398e Forward to the end of word [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000399 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400
401 *E*
402E Forward to the end of WORD [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000403 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404
405<S-Left> or *<S-Left>* *b*
406b [count] words backward. |exclusive| motion.
407
408<C-Left> or *<C-Left>* *B*
409B [count] WORDS backward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000410 If <C-Left> does not work, check out
411 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412
413 *ge*
414ge Backward to the end of word [count] |inclusive|.
415
416 *gE*
417gE Backward to the end of WORD [count] |inclusive|.
418
419These commands move over words or WORDS.
420 *word*
421A word consists of a sequence of letters, digits and underscores, or a
422sequence of other non-blank characters, separated with white space (spaces,
Bram Moolenaar4770d092006-01-12 23:22:24 +0000423tabs, <EOL>). This can be changed with the 'iskeyword' option. An empty line
424is also considered to be a word.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 *WORD*
426A WORD consists of a sequence of non-blank characters, separated with white
Bram Moolenaar4770d092006-01-12 23:22:24 +0000427space. An empty line is also considered to be a WORD.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428
429A sequence of folded lines is counted for one word of a single character.
430"w" and "W", "e" and "E" move to the start/end of the first word or WORD after
431a range of folded lines. "b" and "B" move to the start of the first word or
432WORD before the fold.
433
434Special case: "cw" and "cW" are treated like "ce" and "cE" if the cursor is
435on a non-blank. This is because "cw" is interpreted as change-word, and a
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200436word does not include the following white space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Another special case: When using the "w" motion in combination with an
439operator and the last word moved over is at the end of a line, the end of
440that word becomes the end of the operated text, not the first word in the
441next line.
442
443The original Vi implementation of "e" is buggy. For example, the "e" command
444will stop on the first character of a line if the previous line was empty.
445But when you use "2e" this does not happen. In Vim "ee" and "2e" are the
446same, which is more logical. However, this causes a small incompatibility
447between Vi and Vim.
448
449==============================================================================
4505. Text object motions *object-motions*
451
452 *(*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100453( [count] |sentence|s backward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454
455 *)*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100456) [count] |sentence|s forward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000457
458 *{*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100459{ [count] |paragraph|s backward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460
461 *}*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100462} [count] |paragraph|s forward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000463
464 *]]*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100465]] [count] |section|s forward or to the next '{' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000466 first column. When used after an operator, then also
467 stops below a '}' in the first column. |exclusive|
468 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469
470 *][*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100471][ [count] |section|s forward or to the next '}' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000472 first column. |exclusive|
473 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475 *[[*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100476[[ [count] |section|s backward or to the previous '{' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000477 the first column. |exclusive|
478 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479
480 *[]*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100481[] [count] |section|s backward or to the previous '}' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000482 the first column. |exclusive|
483 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
485These commands move over three kinds of text objects.
486
487 *sentence*
488A sentence is defined as ending at a '.', '!' or '?' followed by either the
489end of a line, or by a space or tab. Any number of closing ')', ']', '"'
490and ''' characters may appear after the '.', '!' or '?' before the spaces,
491tabs or end of line. A paragraph and section boundary is also a sentence
492boundary.
493If the 'J' flag is present in 'cpoptions', at least two spaces have to
494follow the punctuation mark; <Tab>s are not recognized as white space.
495The definition of a sentence cannot be changed.
496
497 *paragraph*
498A paragraph begins after each empty line, and also at each of a set of
499paragraph macros, specified by the pairs of characters in the 'paragraphs'
Bram Moolenaar446cb832008-06-24 21:56:24 +0000500option. The default is "IPLPPPQPP TPHPLIPpLpItpplpipbp", which corresponds to
501the macros ".IP", ".LP", etc. (These are nroff macros, so the dot must be in
502the first column). A section boundary is also a paragraph boundary.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000503Note that a blank line (only containing white space) is NOT a paragraph
504boundary.
505Also note that this does not include a '{' or '}' in the first column. When
506the '{' flag is in 'cpoptions' then '{' in the first column is used as a
507paragraph boundary |posix|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
509 *section*
510A section begins after a form-feed (<C-L>) in the first column and at each of
511a set of section macros, specified by the pairs of characters in the
512'sections' option. The default is "SHNHH HUnhsh", which defines a section to
513start at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
514
Bram Moolenaar207f0092020-08-30 17:20:20 +0200515The "]]" and "[[" commands stop at the '{' in the first column. This is
516useful to find the start of a function in a C program. To search for a '}' in
517the first column, the end of a C function, use "][" (forward) or "[]"
518(backward). Note that the first character of the command determines the
519search direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520
521If your '{' or '}' are not in the first column, and you would like to use "[["
522and "]]" anyway, try these mappings: >
523 :map [[ ?{<CR>w99[{
524 :map ][ /}<CR>b99]}
525 :map ]] j0[[%/{<CR>
526 :map [] k$][%?}<CR>
527[type these literally, see |<>|]
528
529==============================================================================
5306. Text object selection *object-select* *text-objects*
531 *v_a* *v_i*
532
533This is a series of commands that can only be used while in Visual mode or
534after an operator. The commands that start with "a" select "a"n object
535including white space, the commands starting with "i" select an "inner" object
536without white space, or just the white space. Thus the "inner" commands
537always select less text than the "a" commands.
538
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200539Also see `gn` and `gN`, operating on the last search pattern.
540
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541 *v_aw* *aw*
542aw "a word", select [count] words (see |word|).
543 Leading or trailing white space is included, but not
544 counted.
545 When used in Visual linewise mode "aw" switches to
546 Visual characterwise mode.
547
548 *v_iw* *iw*
549iw "inner word", select [count] words (see |word|).
550 White space between words is counted too.
551 When used in Visual linewise mode "iw" switches to
552 Visual characterwise mode.
553
554 *v_aW* *aW*
555aW "a WORD", select [count] WORDs (see |WORD|).
556 Leading or trailing white space is included, but not
557 counted.
558 When used in Visual linewise mode "aW" switches to
559 Visual characterwise mode.
560
561 *v_iW* *iW*
562iW "inner WORD", select [count] WORDs (see |WORD|).
563 White space between words is counted too.
564 When used in Visual linewise mode "iW" switches to
565 Visual characterwise mode.
566
567 *v_as* *as*
568as "a sentence", select [count] sentences (see
569 |sentence|).
570 When used in Visual mode it is made characterwise.
571
572 *v_is* *is*
573is "inner sentence", select [count] sentences (see
574 |sentence|).
575 When used in Visual mode it is made characterwise.
576
577 *v_ap* *ap*
578ap "a paragraph", select [count] paragraphs (see
579 |paragraph|).
580 Exception: a blank line (only containing white space)
581 is also a paragraph boundary.
582 When used in Visual mode it is made linewise.
583
584 *v_ip* *ip*
585ip "inner paragraph", select [count] paragraphs (see
586 |paragraph|).
587 Exception: a blank line (only containing white space)
588 is also a paragraph boundary.
589 When used in Visual mode it is made linewise.
590
591a] *v_a]* *v_a[* *a]* *a[*
592a[ "a [] block", select [count] '[' ']' blocks. This
593 goes backwards to the [count] unclosed '[', and finds
594 the matching ']'. The enclosed text is selected,
595 including the '[' and ']'.
596 When used in Visual mode it is made characterwise.
597
598i] *v_i]* *v_i[* *i]* *i[*
599i[ "inner [] block", select [count] '[' ']' blocks. This
600 goes backwards to the [count] unclosed '[', and finds
601 the matching ']'. The enclosed text is selected,
602 excluding the '[' and ']'.
603 When used in Visual mode it is made characterwise.
604
605a) *v_a)* *a)* *a(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200606a( *vab* *v_ab* *v_a(* *ab*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607ab "a block", select [count] blocks, from "[count] [(" to
608 the matching ')', including the '(' and ')' (see
609 |[(|). Does not include white space outside of the
610 parenthesis.
611 When used in Visual mode it is made characterwise.
612
613i) *v_i)* *i)* *i(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200614i( *vib* *v_ib* *v_i(* *ib*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615ib "inner block", select [count] blocks, from "[count] [("
616 to the matching ')', excluding the '(' and ')' (see
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100617 |[(|). If the cursor is not inside a () block, then
618 find the next "(".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619 When used in Visual mode it is made characterwise.
620
621a> *v_a>* *v_a<* *a>* *a<*
622a< "a <> block", select [count] <> blocks, from the
623 [count]'th unmatched '<' backwards to the matching
624 '>', including the '<' and '>'.
625 When used in Visual mode it is made characterwise.
626
627i> *v_i>* *v_i<* *i>* *i<*
628i< "inner <> block", select [count] <> blocks, from
629 the [count]'th unmatched '<' backwards to the matching
630 '>', excluding the '<' and '>'.
631 When used in Visual mode it is made characterwise.
632
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000633 *v_at* *at*
634at "a tag block", select [count] tag blocks, from the
635 [count]'th unmatched "<aaa>" backwards to the matching
636 "</aaa>", including the "<aaa>" and "</aaa>".
637 See |tag-blocks| about the details.
638 When used in Visual mode it is made characterwise.
Bram Moolenaar88774872022-08-16 20:24:29 +0100639 Only available when compiled with the |+eval| feature.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000640
641 *v_it* *it*
642it "inner tag block", select [count] tag blocks, from the
643 [count]'th unmatched "<aaa>" backwards to the matching
644 "</aaa>", excluding the "<aaa>" and "</aaa>".
645 See |tag-blocks| about the details.
646 When used in Visual mode it is made characterwise.
647
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648a} *v_a}* *a}* *a{*
649a{ *v_aB* *v_a{* *aB*
650aB "a Block", select [count] Blocks, from "[count] [{" to
651 the matching '}', including the '{' and '}' (see
652 |[{|).
653 When used in Visual mode it is made characterwise.
654
655i} *v_i}* *i}* *i{*
656i{ *v_iB* *v_i{* *iB*
657iB "inner Block", select [count] Blocks, from "[count] [{"
658 to the matching '}', excluding the '{' and '}' (see
659 |[{|).
660 When used in Visual mode it is made characterwise.
661
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000662a" *v_aquote* *aquote*
663a' *v_a'* *a'*
664a` *v_a`* *a`*
665 "a quoted string". Selects the text from the previous
Bram Moolenaar5a305422006-04-28 22:38:25 +0000666 quote until the next quote. The 'quoteescape' option
667 is used to skip escaped quotes.
668 Only works within one line.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000669 When the cursor starts on a quote, Vim will figure out
670 which quote pairs form a string by searching from the
671 start of the line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100672 Any trailing white space is included, unless there is
673 none, then leading white space is included.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000674 When used in Visual mode it is made characterwise.
675 Repeating this object in Visual mode another string is
676 included. A count is currently not used.
677
678i" *v_iquote* *iquote*
679i' *v_i'* *i'*
680i` *v_i`* *i`*
681 Like a", a' and a`, but exclude the quotes and
682 repeating won't extend the Visual selection.
Bram Moolenaarab194812005-09-14 21:40:12 +0000683 Special case: With a count of 2 the quotes are
684 included, but no extra white space as with a"/a'/a`.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000685
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686When used after an operator:
687For non-block objects:
688 For the "a" commands: The operator applies to the object and the white
689 space after the object. If there is no white space after the object
690 or when the cursor was in the white space before the object, the white
691 space before the object is included.
692 For the "inner" commands: If the cursor was on the object, the
693 operator applies to the object. If the cursor was on white space, the
694 operator applies to the white space.
695For a block object:
696 The operator applies to the block where the cursor is in, or the block
697 on which the cursor is on one of the braces. For the "inner" commands
698 the surrounding braces are excluded. For the "a" commands, the braces
699 are included.
700
701When used in Visual mode:
702When start and end of the Visual area are the same (just after typing "v"):
703 One object is selected, the same as for using an operator.
704When start and end of the Visual area are not the same:
705 For non-block objects the area is extended by one object or the white
706 space up to the next object, or both for the "a" objects. The
707 direction in which this happens depends on which side of the Visual
708 area the cursor is. For the block objects the block is extended one
709 level outwards.
710
711For illustration, here is a list of delete commands, grouped from small to big
712objects. Note that for a single character and a whole line the existing vi
713movement commands are used.
714 "dl" delete character (alias: "x") |dl|
715 "diw" delete inner word *diw*
716 "daw" delete a word *daw*
717 "diW" delete inner WORD (see |WORD|) *diW*
718 "daW" delete a WORD (see |WORD|) *daW*
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200719 "dgn" delete the next search pattern match *dgn*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 "dd" delete one line |dd|
721 "dis" delete inner sentence *dis*
722 "das" delete a sentence *das*
723 "dib" delete inner '(' ')' block *dib*
724 "dab" delete a '(' ')' block *dab*
725 "dip" delete inner paragraph *dip*
726 "dap" delete a paragraph *dap*
727 "diB" delete inner '{' '}' block *diB*
728 "daB" delete a '{' '}' block *daB*
729
730Note the difference between using a movement command and an object. The
731movement command operates from here (cursor position) to where the movement
732takes us. When using an object the whole object is operated upon, no matter
733where on the object the cursor is. For example, compare "dw" and "daw": "dw"
734deletes from the cursor position to the start of the next word, "daw" deletes
735the word under the cursor and the space after or before it.
736
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000737
738Tag blocks *tag-blocks*
739
740For the "it" and "at" text objects an attempt is done to select blocks between
741matching tags for HTML and XML. But since these are not completely compatible
742there are a few restrictions.
743
744The normal method is to select a <tag> until the matching </tag>. For "at"
745the tags are included, for "it" they are excluded. But when "it" is repeated
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000746the tags will be included (otherwise nothing would change). Also, "it" used
747on a tag block with no contents will select the leading tag.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000748
749"<aaa/>" items are skipped. Case is ignored, also for XML where case does
750matter.
751
752In HTML it is possible to have a tag like <br> or <meta ...> without a
753matching end tag. These are ignored.
754
755The text objects are tolerant about mistakes. Stray end tags are ignored.
756
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757==============================================================================
7587. Marks *mark-motions* *E20* *E78*
759
760Jumping to a mark can be done in two ways:
7611. With ` (backtick): The cursor is positioned at the specified location
762 and the motion is |exclusive|.
7632. With ' (single quote): The cursor is positioned on the first non-blank
764 character in the line of the specified location and
765 the motion is linewise.
766
767 *m* *mark* *Mark*
768m{a-zA-Z} Set mark {a-zA-Z} at cursor position (does not move
769 the cursor, this is not a motion command).
770
771 *m'* *m`*
772m' or m` Set the previous context mark. This can be jumped to
773 with the "''" or "``" command (does not move the
774 cursor, this is not a motion command).
775
776 *m[* *m]*
777m[ or m] Set the |'[| or |']| mark. Useful when an operator is
778 to be simulated by multiple commands. (does not move
779 the cursor, this is not a motion command).
780
Bram Moolenaar30b65812012-07-12 22:01:11 +0200781 *m<* *m>*
782m< or m> Set the |'<| or |'>| mark. Useful to change what the
783 `gv` command selects. (does not move the cursor, this
784 is not a motion command).
785 Note that the Visual mode cannot be set, only the
786 start and end position.
787
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 *:ma* *:mark* *E191*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000789:[range]ma[rk] {a-zA-Z'}
790 Set mark {a-zA-Z'} at last line number in [range],
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 column 0. Default is cursor line.
792
793 *:k*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000794:[range]k{a-zA-Z'} Same as :mark, but the space before the mark name can
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795 be omitted.
Bram Moolenaara4d131d2021-12-27 21:33:07 +0000796 This command is not supported in |Vim9| script,
797 because it is too easily confused with a variable
798 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799
800 *'* *'a* *`* *`a*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000801'{a-z} `{a-z} Jump to the mark {a-z} in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802
803 *'A* *'0* *`A* *`0*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000804'{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 +0200805 a motion command when in another file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *g'* *g'a* *g`* *g`a*
808g'{mark} g`{mark}
809 Jump to the {mark}, but don't change the jumplist when
810 jumping within the current buffer. Example: >
811 g`"
812< jumps to the last known position in a file. See
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000813 $VIMRUNTIME/vimrc_example.vim.
814 Also see |:keepjumps|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815
816 *:marks*
817:marks List all the current marks (not a motion command).
818 The |'(|, |')|, |'{| and |'}| marks are not listed.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000819 The first column has number zero.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200820
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 *E283*
822:marks {arg} List the marks that are mentioned in {arg} (not a
823 motion command). For example: >
824 :marks aB
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200825< to list marks 'a' and 'B'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000827 *:delm* *:delmarks*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000828:delm[arks] {marks} Delete the specified marks. Marks that can be deleted
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000829 include A-Z and 0-9. You cannot delete the ' mark.
830 They can be specified by giving the list of mark
831 names, or with a range, separated with a dash. Spaces
832 are ignored. Examples: >
833 :delmarks a deletes mark a
834 :delmarks a b 1 deletes marks a, b and 1
835 :delmarks Aa deletes marks A and a
836 :delmarks p-z deletes marks in the range p to z
837 :delmarks ^.[] deletes marks ^ . [ ]
838 :delmarks \" deletes mark "
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000839
840:delm[arks]! Delete all marks for the current buffer, but not marks
841 A-Z or 0-9.
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000842
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843A mark is not visible in any way. It is just a position in the file that is
844remembered. Do not confuse marks with named registers, they are totally
845unrelated.
846
847'a - 'z lowercase marks, valid within one file
848'A - 'Z uppercase marks, also called file marks, valid between files
849'0 - '9 numbered marks, set from .viminfo file
850
851Lowercase marks 'a to 'z are remembered as long as the file remains in the
852buffer list. If you remove the file from the buffer list, all its marks are
853lost. If you delete a line that contains a mark, that mark is erased.
854
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855Lowercase marks can be used in combination with operators. For example: "d't"
856deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for
857Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and
858redo.
859
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200860Uppercase marks 'A to 'Z include the file name. You can use them to jump from
861file to file. You can only use an uppercase mark with an operator if the mark
862is in the current file. The line number of the mark remains correct, even if
863you insert/delete lines or edit another file for a moment. When the 'viminfo'
864option is not empty, uppercase marks are kept in the .viminfo file. See
865|viminfo-file-marks|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866
867Numbered marks '0 to '9 are quite different. They can not be set directly.
868They are only present when using a viminfo file |viminfo-file|. Basically '0
869is the location of the cursor when you last exited Vim, '1 the last but one
870time, etc. Use the "r" flag in 'viminfo' to specify files for which no
871Numbered mark should be stored. See |viminfo-file-marks|.
872
873
874 *'[* *`[*
875'[ `[ To the first character of the previously changed
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200876 or yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877
878 *']* *`]*
879'] `] To the last character of the previously changed or
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200880 yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000881
882After executing an operator the Cursor is put at the beginning of the text
883that was operated upon. After a put command ("p" or "P") the cursor is
884sometimes placed at the first inserted line and sometimes on the last inserted
885character. The four commands above put the cursor at either end. Example:
886After yanking 10 lines you want to go to the last one of them: "10Y']". After
887inserting several lines with the "p" command you want to jump to the lowest
888inserted line: "p']". This also works for text that has been inserted.
889
890Note: After deleting text, the start and end positions are the same, except
891when using blockwise Visual mode. These commands do not work when no change
892was made yet in the current file.
893
894 *'<* *`<*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000895'< `< To the first line or character of the last selected
896 Visual area in the current buffer. For block mode it
897 may also be the last character in the first line (to
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200898 be able to define the block).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *'>* *`>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000901'> `> To the last line or character of the last selected
902 Visual area in the current buffer. For block mode it
903 may also be the first character of the last line (to
904 be able to define the block). Note that 'selection'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000905 applies, the position may be just after the Visual
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200906 area.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907
908 *''* *``*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000909'' `` To the position before the latest jump, or where the
910 last "m'" or "m`" command was given. Not set when the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 |:keepjumps| command modifier was used.
912 Also see |restore-position|.
913
914 *'quote* *`quote*
915'" `" To the cursor position when last exiting the current
916 buffer. Defaults to the first character of the first
917 line. See |last-position-jump| for how to use this
918 for each opened file.
919 Only one position is remembered per buffer, not one
920 for each window. As long as the buffer is visible in
921 a window the position won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 *'^* *`^*
924'^ `^ To the position where the cursor was the last time
Bram Moolenaar81695252004-12-29 20:58:21 +0000925 when Insert mode was stopped. This is used by the
926 |gi| command. Not set when the |:keepjumps| command
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200927 modifier was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928
929 *'.* *`.*
930'. `. To the position where the last change was made. The
931 position is at or near where the change started.
932 Sometimes a command is executed as several changes,
933 then the position can be near the end of what the
934 command changed. For example when inserting a word,
935 the position will be on the last character.
Bram Moolenaar51628222016-12-01 23:03:28 +0100936 To jump to older changes use |g;|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937
938 *'(* *`(*
939'( `( To the start of the current sentence, like the |(|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200940 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941
942 *')* *`)*
943') `) To the end of the current sentence, like the |)|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200944 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946 *'{* *`{*
947'{ `{ To the start of the current paragraph, like the |{|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200948 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950 *'}* *`}*
951'} `} To the end of the current paragraph, like the |}|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200952 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953
954These commands are not marks themselves, but jump to a mark:
955
956 *]'*
957]' [count] times to next line with a lowercase mark below
958 the cursor, on the first non-blank character in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200959 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 *]`*
Bram Moolenaardad44732021-03-31 20:07:33 +0200962]` [count] times to lowercase mark after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 *['*
965[' [count] times to previous line with a lowercase mark
966 before the cursor, on the first non-blank character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200967 the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968
969 *[`*
970[` [count] times to lowercase mark before the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200973:loc[kmarks] {command} *:loc* *:lock* *:lockmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 Execute {command} without adjusting marks. This is
975 useful when changing text in a way that the line count
976 will be the same when the change has completed.
977 WARNING: When the line count does change, marks below
978 the change will keep their line number, thus move to
979 another text line.
980 These items will not be adjusted for deleted/inserted
981 lines:
982 - lower case letter marks 'a - 'z
983 - upper case letter marks 'A - 'Z
984 - numbered marks '0 - '9
985 - last insert position '^
986 - last change position '.
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100987 - last affected text area '[ and ']
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988 - the Visual area '< and '>
989 - line numbers in placed signs
990 - line numbers in quickfix positions
991 - positions in the |jumplist|
992 - positions in the |tagstack|
993 These items will still be adjusted:
994 - previous context mark ''
995 - the cursor position
996 - the view of a window on a buffer
997 - folds
998 - diffs
999
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001000:kee[pmarks] {command} *:kee* *:keep* *:keepmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001 Currently only has effect for the filter command
1002 |:range!|:
1003 - When the number of lines after filtering is equal to
1004 or larger than before, all marks are kept at the
1005 same line number.
1006 - When the number of lines decreases, the marks in the
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001007 lines that disappeared are deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 In any case the marks below the filtered text have
1009 their line numbers adjusted, thus stick to the text,
1010 as usual.
1011 When the 'R' flag is missing from 'cpoptions' this has
1012 the same effect as using ":keepmarks".
1013
1014 *:keepj* *:keepjumps*
1015:keepj[umps] {command}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001016 Moving around in {command} does not change the |''|,
1017 |'.| and |'^| marks, the |jumplist| or the
1018 |changelist|.
1019 Useful when making a change or inserting text
1020 automatically and the user doesn't want to go to this
1021 position. E.g., when updating a "Last change"
1022 timestamp in the first line: >
1023
Bram Moolenaare5180522005-12-10 20:19:46 +00001024 :let lnum = line(".")
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001025 :keepjumps normal gg
1026 :call SetLastChange()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001027 :keepjumps exe "normal " .. lnum .. "G"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001028<
1029 Note that ":keepjumps" must be used for every command.
1030 When invoking a function the commands in that function
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001031 can still change the jumplist. Also, for
Bram Moolenaar13065c42005-01-08 16:08:21 +00001032 ":keepjumps exe 'command '" the "command" won't keep
1033 jumps. Instead use: ":exe 'keepjumps command'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035==============================================================================
10368. Jumps *jump-motions*
1037
Bram Moolenaarb477af22018-07-15 20:20:18 +02001038A "jump" is a command that normally moves the cursor several lines away. If
1039you make the cursor "jump" the position of the cursor before the jump is
Bram Moolenaar26967612019-03-17 17:13:16 +01001040remembered. You can return to that position with the "''" and "``" commands,
Bram Moolenaarb477af22018-07-15 20:20:18 +02001041unless the line containing that position was changed or deleted. The
1042following commands are "jump" commands: "'", "`", "G", "/", "?", "n", "N",
1043"%", "(", ")", "[[", "]]", "{", "}", ":s", ":tag", "L", "M", "H" and the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001044commands that start editing a new file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
1046 *CTRL-O*
1047CTRL-O Go to [count] Older cursor position in jump list
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001048 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050<Tab> or *CTRL-I* *<Tab>*
1051CTRL-I Go to [count] newer cursor position in jump list
1052 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
Bram Moolenaardad44732021-03-31 20:07:33 +02001054 NOTE: In the GUI and in a terminal supporting
1055 |modifyOtherKeys|, CTRL-I can be mapped separately
1056 from <Tab>, on the condition that CTRL-I is
1057 mapped before <Tab>, otherwise the mapping applies to
1058 both.
1059
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 *:ju* *:jumps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001061:ju[mps] Print the jump list (not a motion command).
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001062
1063 *:cle* *:clearjumps*
1064:cle[arjumps] Clear the jump list of the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065
1066 *jumplist*
1067Jumps are remembered in a jump list. With the CTRL-O and CTRL-I command you
1068can go to cursor positions before older jumps, and back again. Thus you can
1069move up and down the list. There is a separate jump list for each window.
1070The maximum number of entries is fixed at 100.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
1072For example, after three jump commands you have this jump list:
1073
Bram Moolenaardad44732021-03-31 20:07:33 +02001074 jump line col file/text ~
1075 3 1 0 some text ~
1076 2 70 0 another line ~
1077 1 1154 23 end. ~
1078 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001080The "file/text" column shows the file name, or the text at the jump if it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081in the current file (an indent is removed and a long line is truncated to fit
1082in the window).
1083
Christian Brabandta0f659c2022-04-09 13:35:00 +01001084The marker ">" indicates the current position in the jumplist. It may not be
Bram Moolenaar75ab5902022-04-18 15:36:40 +01001085shown when filtering the |:jumps| command using |:filter|
Christian Brabandta0f659c2022-04-09 13:35:00 +01001086
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087You are currently in line 1167. If you then use the CTRL-O command, the
1088cursor is put in line 1154. This results in:
1089
Bram Moolenaardad44732021-03-31 20:07:33 +02001090 jump line col file/text ~
1091 2 1 0 some text ~
1092 1 70 0 another line ~
1093 > 0 1154 23 end. ~
1094 1 1167 0 foo bar ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096The pointer will be set at the last used jump position. The next CTRL-O
1097command will use the entry above it, the next CTRL-I command will use the
1098entry below it. If the pointer is below the last entry, this indicates that
1099you did not use a CTRL-I or CTRL-O before. In this case the CTRL-O command
1100will cause the cursor position to be added to the jump list, so you can get
1101back to the position before the CTRL-O. In this case this is line 1167.
1102
1103With more CTRL-O commands you will go to lines 70 and 1. If you use CTRL-I
1104you can go back to 1154 and 1167 again. Note that the number in the "jump"
1105column indicates the count for the CTRL-O or CTRL-I command that takes you to
1106this position.
1107
1108If you use a jump command, the current line number is inserted at the end of
1109the jump list. If the same line was already in the jump list, it is removed.
1110The result is that when repeating CTRL-O you will get back to old positions
1111only once.
1112
1113When the |:keepjumps| command modifier is used, jumps are not stored in the
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001114jumplist. Jumps are also not stored in other cases, e.g., in a |:global|
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001115command. You can explicitly add a jump by setting the ' mark with "m'". Note
1116that calling setpos() does not do this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
1118After the CTRL-O command that got you into line 1154 you could give another
1119jump command (e.g., "G"). The jump list would then become:
1120
Bram Moolenaardad44732021-03-31 20:07:33 +02001121 jump line col file/text ~
1122 4 1 0 some text ~
1123 3 70 0 another line ~
1124 2 1167 0 foo bar ~
1125 1 1154 23 end. ~
1126 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127
1128The line numbers will be adjusted for deleted and inserted lines. This fails
1129if you stop editing a file without writing, like with ":n!".
1130
1131When you split a window, the jumplist will be copied to the new window.
1132
1133If you have included the ' item in the 'viminfo' option the jumplist will be
1134stored in the viminfo file and restored when starting Vim.
1135
1136
1137CHANGE LIST JUMPS *changelist* *change-list-jumps* *E664*
1138
1139When making a change the cursor position is remembered. One position is
1140remembered for every change that can be undone, unless it is close to a
1141previous change. Two commands can be used to jump to positions of changes,
1142also those that have been undone:
1143
1144 *g;* *E662*
1145g; Go to [count] older position in change list.
1146 If [count] is larger than the number of older change
1147 positions go to the oldest change.
1148 If there is no older change an error message is given.
1149 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150
1151 *g,* *E663*
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +01001152g, Go to [count] newer position in change list.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001153 Just like |g;| but in the opposite direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155
1156When using a count you jump as far back or forward as possible. Thus you can
1157use "999g;" to go to the first change for which the position is still
1158remembered. The number of entries in the change list is fixed and is the same
1159as for the |jumplist|.
1160
1161When two undo-able changes are in the same line and at a column position less
1162than 'textwidth' apart only the last one is remembered. This avoids that a
1163sequence of small changes in a line, for example "xxxxx", adds many positions
1164to the change list. When 'textwidth' is zero 'wrapmargin' is used. When that
1165also isn't set a fixed number of 79 is used. Detail: For the computations
1166bytes are used, not characters, to avoid a speed penalty (this only matters
Bram Moolenaar207f0092020-08-30 17:20:20 +02001167for multibyte encodings).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
1169Note that when text has been inserted or deleted the cursor position might be
1170a bit different from the position of the change. Especially when lines have
1171been deleted.
1172
Bram Moolenaardad44732021-03-31 20:07:33 +02001173When the `:keepjumps` command modifier is used the position of a change is not
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174remembered.
1175
1176 *:changes*
1177:changes Print the change list. A ">" character indicates the
1178 current position. Just after a change it is below the
Bram Moolenaara9604e62018-07-21 05:56:22 +02001179 newest entry, indicating that `g;` takes you to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 newest entry position. The first column indicates the
1181 count needed to take you to this position. Example:
1182
1183 change line col text ~
1184 3 9 8 bla bla bla
1185 2 11 57 foo is a bar
1186 1 14 54 the latest changed line
1187 >
1188
Bram Moolenaara9604e62018-07-21 05:56:22 +02001189 The `3g;` command takes you to line 9. Then the
1190 output of `:changes` is:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191
1192 change line col text ~
1193 > 0 9 8 bla bla bla
1194 1 11 57 foo is a bar
1195 2 14 54 the latest changed line
1196
1197 Now you can use "g," to go to line 11 and "2g," to go
1198 to line 14.
1199
1200==============================================================================
12019. Various motions *various-motions*
1202
1203 *%*
1204% Find the next item in this line after or under the
1205 cursor and jump to its match. |inclusive| motion.
1206 Items can be:
1207 ([{}]) parenthesis or (curly/square) brackets
1208 (this can be changed with the
1209 'matchpairs' option)
1210 /* */ start or end of C-style comment
1211 #if, #ifdef, #else, #elif, #endif
1212 C preprocessor conditionals (when the
1213 cursor is on the # or no ([{
Bram Moolenaardad44732021-03-31 20:07:33 +02001214 is following)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 For other items the matchit plugin can be used, see
Bram Moolenaar446cb832008-06-24 21:56:24 +00001216 |matchit-install|. This plugin also helps to skip
1217 matches in comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218
1219 When 'cpoptions' contains "M" |cpo-M| backslashes
1220 before parens and braces are ignored. Without "M" the
1221 number of backslashes matters: an even number doesn't
1222 match with an odd number. Thus in "( \) )" and "\( (
1223 \)" the first and last parenthesis match.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001224
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 When the '%' character is not present in 'cpoptions'
1226 |cpo-%|, parens and braces inside double quotes are
1227 ignored, unless the number of parens/braces in a line
1228 is uneven and this line and the previous one does not
1229 end in a backslash. '(', '{', '[', ']', '}' and ')'
1230 are also ignored (parens and braces inside single
1231 quotes). Note that this works fine for C, but not for
1232 Perl, where single quotes are used for strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001233
1234 Nothing special is done for matches in comments. You
1235 can either use the matchit plugin |matchit-install| or
1236 put quotes around matches.
1237
1238 No count is allowed, {count}% jumps to a line {count}
1239 percentage down the file |N%|. Using '%' on
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 #if/#else/#endif makes the movement linewise.
1241
1242 *[(*
Bram Moolenaardad44732021-03-31 20:07:33 +02001243[( Go to [count] previous unmatched '('.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001244 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 *[{*
Bram Moolenaardad44732021-03-31 20:07:33 +02001246[{ Go to [count] previous unmatched '{'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001247 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 *])*
Bram Moolenaardad44732021-03-31 20:07:33 +02001249]) Go to [count] next unmatched ')'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001250 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 *]}*
Bram Moolenaardad44732021-03-31 20:07:33 +02001252]} Go to [count] next unmatched '}'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001253 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254
1255The above four commands can be used to go to the start or end of the current
1256code block. It is like doing "%" on the '(', ')', '{' or '}' at the other
1257end of the code block, but you can do this from anywhere in the code block.
1258Very useful for C programs. Example: When standing on "case x:", "[{" will
1259bring you back to the switch statement.
1260
1261 *]m*
1262]m Go to [count] next start of a method (for Java or
1263 similar structured language). When not before the
1264 start of a method, jump to the start or end of the
1265 class. When no '{' is found after the cursor, this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001266 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 *]M*
1268]M Go to [count] next end of a method (for Java or
1269 similar structured language). When not before the end
1270 of a method, jump to the start or end of the class.
1271 When no '}' is found after the cursor, this is an
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001272 error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 *[m*
1274[m Go to [count] previous start of a method (for Java or
1275 similar structured language). When not after the
1276 start of a method, jump to the start or end of the
1277 class. When no '{' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001278 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 *[M*
1280[M Go to [count] previous end of a method (for Java or
1281 similar structured language). When not after the
1282 end of a method, jump to the start or end of the
1283 class. When no '}' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001284 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285
Bram Moolenaardad44732021-03-31 20:07:33 +02001286The above four commands assume that the file contains a class with methods.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287The class definition is surrounded in '{' and '}'. Each method in the class
1288is also surrounded with '{' and '}'. This applies to the Java language. The
1289file looks like this: >
1290
1291 // comment
1292 class foo {
1293 int method_one() {
1294 body_one();
1295 }
1296 int method_two() {
1297 body_two();
1298 }
1299 }
Bram Moolenaardad44732021-03-31 20:07:33 +02001300
1301[To try this out copy the text and put it in a new buffer, the help text above
1302confuses the jump commands]
1303
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304Starting with the cursor on "body_two()", using "[m" will jump to the '{' at
1305the start of "method_two()" (obviously this is much more useful when the
1306method is long!). Using "2[m" will jump to the start of "method_one()".
1307Using "3[m" will jump to the start of the class.
1308
1309 *[#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001310[# Go to [count] previous unmatched "#if" or "#else".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001311 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312
1313 *]#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001314]# Go to [count] next unmatched "#else" or "#endif".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001315 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316
1317These two commands work in C programs that contain #if/#else/#endif
1318constructs. It brings you to the start or end of the #if/#else/#endif where
1319the current line is included. You can then use "%" to go to the matching line.
1320
1321 *[star* *[/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001322[* or [/ Go to [count] previous start of a C comment "/*".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001323 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324
1325 *]star* *]/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001326]* or ]/ Go to [count] next end of a C comment "*/".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001327 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328
1329
1330 *H*
1331H To line [count] from top (Home) of window (default:
1332 first line on the window) on the first non-blank
1333 character |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001334 Cursor is adjusted for 'scrolloff' option, unless an
1335 operator is pending, in which case the text may
1336 scroll. E.g. "yH" yanks from the first visible line
1337 until the cursor line (inclusive).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338
1339 *M*
1340M To Middle line of window, on the first non-blank
1341 character |linewise|. See also 'startofline' option.
1342
1343 *L*
1344L To line [count] from bottom of window (default: Last
1345 line on the window) on the first non-blank character
1346 |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001347 Cursor is adjusted for 'scrolloff' option, unless an
1348 operator is pending, in which case the text may
1349 scroll. E.g. "yL" yanks from the cursor to the last
1350 visible line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351
1352<LeftMouse> Moves to the position on the screen where the mouse
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001353 click is |exclusive|. See also |<LeftMouse>|. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 position is in a status line, that window is made the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001355 active window and the cursor is not moved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001357 vim:tw=78:ts=8:noet:ft=help:norl: