blob: 4253684d1a08b5d4bfeafe0486bfbe50cca0e240 [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*motion.txt* For Vim version 9.0. Last change: 2022 Apr 18
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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245 *g$* *g<End>*
246g$ or g<End> When lines wrap ('wrap' on): To the last character of
247 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258
259 *bar*
260| To screen column [count] in the current line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100261 |exclusive| motion. Ceci n'est pas une pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262
263 *f*
264f{char} To [count]'th occurrence of {char} to the right. The
265 cursor is placed on {char} |inclusive|.
266 {char} can be entered as a digraph |digraph-arg|.
267 When 'encoding' is set to Unicode, composing
268 characters may be used, see |utf-8-char-arg|.
269 |:lmap| mappings apply to {char}. The CTRL-^ command
270 in Insert mode can be used to switch this on/off
271 |i_CTRL-^|.
272
273 *F*
274F{char} To the [count]'th occurrence of {char} to the left.
Bram Moolenaar78984f52005-08-01 07:19:10 +0000275 The cursor is placed on {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 {char} can be entered like with the |f| command.
277
278 *t*
279t{char} Till before [count]'th occurrence of {char} to the
280 right. The cursor is placed on the character left of
281 {char} |inclusive|.
282 {char} can be entered like with the |f| command.
283
284 *T*
285T{char} Till after [count]'th occurrence of {char} to the
286 left. The cursor is placed on the character right of
Bram Moolenaar78984f52005-08-01 07:19:10 +0000287 {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288 {char} can be entered like with the |f| command.
289
290 *;*
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200291; Repeat latest f, t, F or T [count] times. See |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *,*
294, Repeat latest f, t, F or T in opposite direction
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200295 [count] times. See also |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297==============================================================================
2983. Up-down motions *up-down-motions*
299
300k or *k*
301<Up> or *<Up>* *CTRL-P*
302CTRL-P [count] lines upward |linewise|.
303
304j or *j*
305<Down> or *<Down>*
306CTRL-J or *CTRL-J*
307<NL> or *<NL>* *CTRL-N*
308CTRL-N [count] lines downward |linewise|.
309
310gk or *gk* *g<Up>*
311g<Up> [count] display lines upward. |exclusive| motion.
312 Differs from 'k' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200313 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315gj or *gj* *g<Down>*
316g<Down> [count] display lines downward. |exclusive| motion.
317 Differs from 'j' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200318 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320 *-*
321- <minus> [count] lines upward, on the first non-blank
322 character |linewise|.
323
324+ or *+*
325CTRL-M or *CTRL-M* *<CR>*
326<CR> [count] lines downward, on the first non-blank
327 character |linewise|.
328
329 *_*
330_ <underscore> [count] - 1 lines downward, on the first non-blank
331 character |linewise|.
332
333 *G*
334G Goto line [count], default last line, on the first
335 non-blank character |linewise|. If 'startofline' not
336 set, keep the same column.
Bram Moolenaar26967612019-03-17 17:13:16 +0100337 G is one of the |jump-motions|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000338
339 *<C-End>*
340<C-End> Goto line [count], default last line, on the last
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200341 character |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000342
343<C-Home> or *gg* *<C-Home>*
344gg Goto line [count], default first line, on the first
345 non-blank character |linewise|. If 'startofline' not
346 set, keep the same column.
347
Bram Moolenaar9b451252012-08-15 17:43:31 +0200348 *:[range]*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100349:[range] Set the cursor on the last line number in [range].
350 [range] can also be just one line number, e.g., ":1"
351 or ":'m".
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200352 In contrast with |G| this command does not modify the
353 |jumplist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 *N%*
355{count}% Go to {count} percentage in the file, on the first
356 non-blank in the line |linewise|. To compute the new
357 line number this formula is used:
358 ({count} * number-of-lines + 99) / 100
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200359 See also 'startofline' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360
361:[range]go[to] [count] *:go* *:goto* *go*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100362[count]go Go to [count] byte in the buffer. Default [count] is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363 one, start of the file. When giving [range], the
364 last number in it used as the byte count. End-of-line
365 characters are counted depending on the current
366 'fileformat' setting.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200367 Also see the |line2byte()| function, and the 'o'
368 option in 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369 {not available when compiled without the
370 |+byte_offset| feature}
371
372These commands move to the specified line. They stop when reaching the first
373or the last line. The first two commands put the cursor in the same column
374(if possible) as it was after the last command that changed the column,
375except after the "$" command, then the cursor will be put on the last
376character of the line.
377
Bram Moolenaar7c626922005-02-07 22:01:03 +0000378If "k", "-" or CTRL-P is used with a [count] and there are less than [count]
379lines above the cursor and the 'cpo' option includes the "-" flag it is an
380error. |cpo--|.
381
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382==============================================================================
3834. Word motions *word-motions*
384
385<S-Right> or *<S-Right>* *w*
386w [count] words forward. |exclusive| motion.
387
388<C-Right> or *<C-Right>* *W*
389W [count] WORDS forward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000390 If <C-Right> does not work, check out
391 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392
393 *e*
394e Forward to the end of word [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000395 Does not stop in an empty line.
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<S-Left> or *<S-Left>* *b*
402b [count] words backward. |exclusive| motion.
403
404<C-Left> or *<C-Left>* *B*
405B [count] WORDS backward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000406 If <C-Left> does not work, check out
407 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409 *ge*
410ge Backward to the end of word [count] |inclusive|.
411
412 *gE*
413gE Backward to the end of WORD [count] |inclusive|.
414
415These commands move over words or WORDS.
416 *word*
417A word consists of a sequence of letters, digits and underscores, or a
418sequence of other non-blank characters, separated with white space (spaces,
Bram Moolenaar4770d092006-01-12 23:22:24 +0000419tabs, <EOL>). This can be changed with the 'iskeyword' option. An empty line
420is also considered to be a word.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 *WORD*
422A WORD consists of a sequence of non-blank characters, separated with white
Bram Moolenaar4770d092006-01-12 23:22:24 +0000423space. An empty line is also considered to be a WORD.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424
425A sequence of folded lines is counted for one word of a single character.
426"w" and "W", "e" and "E" move to the start/end of the first word or WORD after
427a range of folded lines. "b" and "B" move to the start of the first word or
428WORD before the fold.
429
430Special case: "cw" and "cW" are treated like "ce" and "cE" if the cursor is
431on a non-blank. This is because "cw" is interpreted as change-word, and a
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200432word does not include the following white space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434Another special case: When using the "w" motion in combination with an
435operator and the last word moved over is at the end of a line, the end of
436that word becomes the end of the operated text, not the first word in the
437next line.
438
439The original Vi implementation of "e" is buggy. For example, the "e" command
440will stop on the first character of a line if the previous line was empty.
441But when you use "2e" this does not happen. In Vim "ee" and "2e" are the
442same, which is more logical. However, this causes a small incompatibility
443between Vi and Vim.
444
445==============================================================================
4465. Text object motions *object-motions*
447
448 *(*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100449( [count] |sentence|s backward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450
451 *)*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100452) [count] |sentence|s forward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453
454 *{*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100455{ [count] |paragraph|s backward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456
457 *}*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100458} [count] |paragraph|s forward. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459
460 *]]*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100461]] [count] |section|s forward or to the next '{' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000462 first column. When used after an operator, then also
463 stops below a '}' in the first column. |exclusive|
464 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465
466 *][*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100467][ [count] |section|s forward or to the next '}' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000468 first column. |exclusive|
469 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470
471 *[[*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100472[[ [count] |section|s backward or to the previous '{' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000473 the first column. |exclusive|
474 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
476 *[]*
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100477[] [count] |section|s backward or to the previous '}' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000478 the first column. |exclusive|
479 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480
481These commands move over three kinds of text objects.
482
483 *sentence*
484A sentence is defined as ending at a '.', '!' or '?' followed by either the
485end of a line, or by a space or tab. Any number of closing ')', ']', '"'
486and ''' characters may appear after the '.', '!' or '?' before the spaces,
487tabs or end of line. A paragraph and section boundary is also a sentence
488boundary.
489If the 'J' flag is present in 'cpoptions', at least two spaces have to
490follow the punctuation mark; <Tab>s are not recognized as white space.
491The definition of a sentence cannot be changed.
492
493 *paragraph*
494A paragraph begins after each empty line, and also at each of a set of
495paragraph macros, specified by the pairs of characters in the 'paragraphs'
Bram Moolenaar446cb832008-06-24 21:56:24 +0000496option. The default is "IPLPPPQPP TPHPLIPpLpItpplpipbp", which corresponds to
497the macros ".IP", ".LP", etc. (These are nroff macros, so the dot must be in
498the first column). A section boundary is also a paragraph boundary.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000499Note that a blank line (only containing white space) is NOT a paragraph
500boundary.
501Also note that this does not include a '{' or '}' in the first column. When
502the '{' flag is in 'cpoptions' then '{' in the first column is used as a
503paragraph boundary |posix|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505 *section*
506A section begins after a form-feed (<C-L>) in the first column and at each of
507a set of section macros, specified by the pairs of characters in the
508'sections' option. The default is "SHNHH HUnhsh", which defines a section to
509start at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
510
Bram Moolenaar207f0092020-08-30 17:20:20 +0200511The "]]" and "[[" commands stop at the '{' in the first column. This is
512useful to find the start of a function in a C program. To search for a '}' in
513the first column, the end of a C function, use "][" (forward) or "[]"
514(backward). Note that the first character of the command determines the
515search direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
517If your '{' or '}' are not in the first column, and you would like to use "[["
518and "]]" anyway, try these mappings: >
519 :map [[ ?{<CR>w99[{
520 :map ][ /}<CR>b99]}
521 :map ]] j0[[%/{<CR>
522 :map [] k$][%?}<CR>
523[type these literally, see |<>|]
524
525==============================================================================
5266. Text object selection *object-select* *text-objects*
527 *v_a* *v_i*
528
529This is a series of commands that can only be used while in Visual mode or
530after an operator. The commands that start with "a" select "a"n object
531including white space, the commands starting with "i" select an "inner" object
532without white space, or just the white space. Thus the "inner" commands
533always select less text than the "a" commands.
534
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200535Also see `gn` and `gN`, operating on the last search pattern.
536
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 *v_aw* *aw*
538aw "a word", select [count] words (see |word|).
539 Leading or trailing white space is included, but not
540 counted.
541 When used in Visual linewise mode "aw" switches to
542 Visual characterwise mode.
543
544 *v_iw* *iw*
545iw "inner word", select [count] words (see |word|).
546 White space between words is counted too.
547 When used in Visual linewise mode "iw" switches to
548 Visual characterwise mode.
549
550 *v_aW* *aW*
551aW "a WORD", select [count] WORDs (see |WORD|).
552 Leading or trailing white space is included, but not
553 counted.
554 When used in Visual linewise mode "aW" switches to
555 Visual characterwise mode.
556
557 *v_iW* *iW*
558iW "inner WORD", select [count] WORDs (see |WORD|).
559 White space between words is counted too.
560 When used in Visual linewise mode "iW" switches to
561 Visual characterwise mode.
562
563 *v_as* *as*
564as "a sentence", select [count] sentences (see
565 |sentence|).
566 When used in Visual mode it is made characterwise.
567
568 *v_is* *is*
569is "inner sentence", select [count] sentences (see
570 |sentence|).
571 When used in Visual mode it is made characterwise.
572
573 *v_ap* *ap*
574ap "a paragraph", select [count] paragraphs (see
575 |paragraph|).
576 Exception: a blank line (only containing white space)
577 is also a paragraph boundary.
578 When used in Visual mode it is made linewise.
579
580 *v_ip* *ip*
581ip "inner paragraph", select [count] paragraphs (see
582 |paragraph|).
583 Exception: a blank line (only containing white space)
584 is also a paragraph boundary.
585 When used in Visual mode it is made linewise.
586
587a] *v_a]* *v_a[* *a]* *a[*
588a[ "a [] block", select [count] '[' ']' blocks. This
589 goes backwards to the [count] unclosed '[', and finds
590 the matching ']'. The enclosed text is selected,
591 including the '[' and ']'.
592 When used in Visual mode it is made characterwise.
593
594i] *v_i]* *v_i[* *i]* *i[*
595i[ "inner [] block", select [count] '[' ']' blocks. This
596 goes backwards to the [count] unclosed '[', and finds
597 the matching ']'. The enclosed text is selected,
598 excluding the '[' and ']'.
599 When used in Visual mode it is made characterwise.
600
601a) *v_a)* *a)* *a(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200602a( *vab* *v_ab* *v_a(* *ab*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603ab "a block", select [count] blocks, from "[count] [(" to
604 the matching ')', including the '(' and ')' (see
605 |[(|). Does not include white space outside of the
606 parenthesis.
607 When used in Visual mode it is made characterwise.
608
609i) *v_i)* *i)* *i(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200610i( *vib* *v_ib* *v_i(* *ib*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611ib "inner block", select [count] blocks, from "[count] [("
612 to the matching ')', excluding the '(' and ')' (see
Bram Moolenaare1f3fd12022-08-15 18:51:32 +0100613 |[(|). If the cursor is not inside a () block, then
614 find the next "(".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 When used in Visual mode it is made characterwise.
616
617a> *v_a>* *v_a<* *a>* *a<*
618a< "a <> block", select [count] <> blocks, from the
619 [count]'th unmatched '<' backwards to the matching
620 '>', including the '<' and '>'.
621 When used in Visual mode it is made characterwise.
622
623i> *v_i>* *v_i<* *i>* *i<*
624i< "inner <> block", select [count] <> blocks, from
625 the [count]'th unmatched '<' backwards to the matching
626 '>', excluding the '<' and '>'.
627 When used in Visual mode it is made characterwise.
628
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000629 *v_at* *at*
630at "a tag block", select [count] tag blocks, from the
631 [count]'th unmatched "<aaa>" backwards to the matching
632 "</aaa>", including the "<aaa>" and "</aaa>".
633 See |tag-blocks| about the details.
634 When used in Visual mode it is made characterwise.
Bram Moolenaar88774872022-08-16 20:24:29 +0100635 Only available when compiled with the |+eval| feature.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000636
637 *v_it* *it*
638it "inner tag block", select [count] tag blocks, from the
639 [count]'th unmatched "<aaa>" backwards to the matching
640 "</aaa>", excluding the "<aaa>" and "</aaa>".
641 See |tag-blocks| about the details.
642 When used in Visual mode it is made characterwise.
643
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644a} *v_a}* *a}* *a{*
645a{ *v_aB* *v_a{* *aB*
646aB "a Block", select [count] Blocks, from "[count] [{" to
647 the matching '}', including the '{' and '}' (see
648 |[{|).
649 When used in Visual mode it is made characterwise.
650
651i} *v_i}* *i}* *i{*
652i{ *v_iB* *v_i{* *iB*
653iB "inner Block", select [count] Blocks, from "[count] [{"
654 to the matching '}', excluding the '{' and '}' (see
655 |[{|).
656 When used in Visual mode it is made characterwise.
657
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000658a" *v_aquote* *aquote*
659a' *v_a'* *a'*
660a` *v_a`* *a`*
661 "a quoted string". Selects the text from the previous
Bram Moolenaar5a305422006-04-28 22:38:25 +0000662 quote until the next quote. The 'quoteescape' option
663 is used to skip escaped quotes.
664 Only works within one line.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000665 When the cursor starts on a quote, Vim will figure out
666 which quote pairs form a string by searching from the
667 start of the line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100668 Any trailing white space is included, unless there is
669 none, then leading white space is included.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000670 When used in Visual mode it is made characterwise.
671 Repeating this object in Visual mode another string is
672 included. A count is currently not used.
673
674i" *v_iquote* *iquote*
675i' *v_i'* *i'*
676i` *v_i`* *i`*
677 Like a", a' and a`, but exclude the quotes and
678 repeating won't extend the Visual selection.
Bram Moolenaarab194812005-09-14 21:40:12 +0000679 Special case: With a count of 2 the quotes are
680 included, but no extra white space as with a"/a'/a`.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000681
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682When used after an operator:
683For non-block objects:
684 For the "a" commands: The operator applies to the object and the white
685 space after the object. If there is no white space after the object
686 or when the cursor was in the white space before the object, the white
687 space before the object is included.
688 For the "inner" commands: If the cursor was on the object, the
689 operator applies to the object. If the cursor was on white space, the
690 operator applies to the white space.
691For a block object:
692 The operator applies to the block where the cursor is in, or the block
693 on which the cursor is on one of the braces. For the "inner" commands
694 the surrounding braces are excluded. For the "a" commands, the braces
695 are included.
696
697When used in Visual mode:
698When start and end of the Visual area are the same (just after typing "v"):
699 One object is selected, the same as for using an operator.
700When start and end of the Visual area are not the same:
701 For non-block objects the area is extended by one object or the white
702 space up to the next object, or both for the "a" objects. The
703 direction in which this happens depends on which side of the Visual
704 area the cursor is. For the block objects the block is extended one
705 level outwards.
706
707For illustration, here is a list of delete commands, grouped from small to big
708objects. Note that for a single character and a whole line the existing vi
709movement commands are used.
710 "dl" delete character (alias: "x") |dl|
711 "diw" delete inner word *diw*
712 "daw" delete a word *daw*
713 "diW" delete inner WORD (see |WORD|) *diW*
714 "daW" delete a WORD (see |WORD|) *daW*
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200715 "dgn" delete the next search pattern match *dgn*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 "dd" delete one line |dd|
717 "dis" delete inner sentence *dis*
718 "das" delete a sentence *das*
719 "dib" delete inner '(' ')' block *dib*
720 "dab" delete a '(' ')' block *dab*
721 "dip" delete inner paragraph *dip*
722 "dap" delete a paragraph *dap*
723 "diB" delete inner '{' '}' block *diB*
724 "daB" delete a '{' '}' block *daB*
725
726Note the difference between using a movement command and an object. The
727movement command operates from here (cursor position) to where the movement
728takes us. When using an object the whole object is operated upon, no matter
729where on the object the cursor is. For example, compare "dw" and "daw": "dw"
730deletes from the cursor position to the start of the next word, "daw" deletes
731the word under the cursor and the space after or before it.
732
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000733
734Tag blocks *tag-blocks*
735
736For the "it" and "at" text objects an attempt is done to select blocks between
737matching tags for HTML and XML. But since these are not completely compatible
738there are a few restrictions.
739
740The normal method is to select a <tag> until the matching </tag>. For "at"
741the tags are included, for "it" they are excluded. But when "it" is repeated
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000742the tags will be included (otherwise nothing would change). Also, "it" used
743on a tag block with no contents will select the leading tag.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000744
745"<aaa/>" items are skipped. Case is ignored, also for XML where case does
746matter.
747
748In HTML it is possible to have a tag like <br> or <meta ...> without a
749matching end tag. These are ignored.
750
751The text objects are tolerant about mistakes. Stray end tags are ignored.
752
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753==============================================================================
7547. Marks *mark-motions* *E20* *E78*
755
756Jumping to a mark can be done in two ways:
7571. With ` (backtick): The cursor is positioned at the specified location
758 and the motion is |exclusive|.
7592. With ' (single quote): The cursor is positioned on the first non-blank
760 character in the line of the specified location and
761 the motion is linewise.
762
763 *m* *mark* *Mark*
764m{a-zA-Z} Set mark {a-zA-Z} at cursor position (does not move
765 the cursor, this is not a motion command).
766
767 *m'* *m`*
768m' or m` Set the previous context mark. This can be jumped to
769 with the "''" or "``" command (does not move the
770 cursor, this is not a motion command).
771
772 *m[* *m]*
773m[ or m] Set the |'[| or |']| mark. Useful when an operator is
774 to be simulated by multiple commands. (does not move
775 the cursor, this is not a motion command).
776
Bram Moolenaar30b65812012-07-12 22:01:11 +0200777 *m<* *m>*
778m< or m> Set the |'<| or |'>| mark. Useful to change what the
779 `gv` command selects. (does not move the cursor, this
780 is not a motion command).
781 Note that the Visual mode cannot be set, only the
782 start and end position.
783
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 *:ma* *:mark* *E191*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000785:[range]ma[rk] {a-zA-Z'}
786 Set mark {a-zA-Z'} at last line number in [range],
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 column 0. Default is cursor line.
788
789 *:k*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000790:[range]k{a-zA-Z'} Same as :mark, but the space before the mark name can
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 be omitted.
Bram Moolenaara4d131d2021-12-27 21:33:07 +0000792 This command is not supported in |Vim9| script,
793 because it is too easily confused with a variable
794 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
796 *'* *'a* *`* *`a*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000797'{a-z} `{a-z} Jump to the mark {a-z} in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
799 *'A* *'0* *`A* *`0*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000800'{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 +0200801 a motion command when in another file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802
803 *g'* *g'a* *g`* *g`a*
804g'{mark} g`{mark}
805 Jump to the {mark}, but don't change the jumplist when
806 jumping within the current buffer. Example: >
807 g`"
808< jumps to the last known position in a file. See
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000809 $VIMRUNTIME/vimrc_example.vim.
810 Also see |:keepjumps|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811
812 *:marks*
813:marks List all the current marks (not a motion command).
814 The |'(|, |')|, |'{| and |'}| marks are not listed.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000815 The first column has number zero.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200816
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 *E283*
818:marks {arg} List the marks that are mentioned in {arg} (not a
819 motion command). For example: >
820 :marks aB
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200821< to list marks 'a' and 'B'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000823 *:delm* *:delmarks*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000824:delm[arks] {marks} Delete the specified marks. Marks that can be deleted
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000825 include A-Z and 0-9. You cannot delete the ' mark.
826 They can be specified by giving the list of mark
827 names, or with a range, separated with a dash. Spaces
828 are ignored. Examples: >
829 :delmarks a deletes mark a
830 :delmarks a b 1 deletes marks a, b and 1
831 :delmarks Aa deletes marks A and a
832 :delmarks p-z deletes marks in the range p to z
833 :delmarks ^.[] deletes marks ^ . [ ]
834 :delmarks \" deletes mark "
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000835
836:delm[arks]! Delete all marks for the current buffer, but not marks
837 A-Z or 0-9.
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000838
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839A mark is not visible in any way. It is just a position in the file that is
840remembered. Do not confuse marks with named registers, they are totally
841unrelated.
842
843'a - 'z lowercase marks, valid within one file
844'A - 'Z uppercase marks, also called file marks, valid between files
845'0 - '9 numbered marks, set from .viminfo file
846
847Lowercase marks 'a to 'z are remembered as long as the file remains in the
848buffer list. If you remove the file from the buffer list, all its marks are
849lost. If you delete a line that contains a mark, that mark is erased.
850
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851Lowercase marks can be used in combination with operators. For example: "d't"
852deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for
853Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and
854redo.
855
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200856Uppercase marks 'A to 'Z include the file name. You can use them to jump from
857file to file. You can only use an uppercase mark with an operator if the mark
858is in the current file. The line number of the mark remains correct, even if
859you insert/delete lines or edit another file for a moment. When the 'viminfo'
860option is not empty, uppercase marks are kept in the .viminfo file. See
861|viminfo-file-marks|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
863Numbered marks '0 to '9 are quite different. They can not be set directly.
864They are only present when using a viminfo file |viminfo-file|. Basically '0
865is the location of the cursor when you last exited Vim, '1 the last but one
866time, etc. Use the "r" flag in 'viminfo' to specify files for which no
867Numbered mark should be stored. See |viminfo-file-marks|.
868
869
870 *'[* *`[*
871'[ `[ To the first character of the previously changed
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200872 or yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874 *']* *`]*
875'] `] To the last character of the previously changed or
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200876 yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877
878After executing an operator the Cursor is put at the beginning of the text
879that was operated upon. After a put command ("p" or "P") the cursor is
880sometimes placed at the first inserted line and sometimes on the last inserted
881character. The four commands above put the cursor at either end. Example:
882After yanking 10 lines you want to go to the last one of them: "10Y']". After
883inserting several lines with the "p" command you want to jump to the lowest
884inserted line: "p']". This also works for text that has been inserted.
885
886Note: After deleting text, the start and end positions are the same, except
887when using blockwise Visual mode. These commands do not work when no change
888was made yet in the current file.
889
890 *'<* *`<*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000891'< `< To the first line or character of the last selected
892 Visual area in the current buffer. For block mode it
893 may also be the last character in the first line (to
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200894 be able to define the block).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895
896 *'>* *`>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000897'> `> To the last line or character of the last selected
898 Visual area in the current buffer. For block mode it
899 may also be the first character of the last line (to
900 be able to define the block). Note that 'selection'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000901 applies, the position may be just after the Visual
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200902 area.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903
904 *''* *``*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000905'' `` To the position before the latest jump, or where the
906 last "m'" or "m`" command was given. Not set when the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 |:keepjumps| command modifier was used.
908 Also see |restore-position|.
909
910 *'quote* *`quote*
911'" `" To the cursor position when last exiting the current
912 buffer. Defaults to the first character of the first
913 line. See |last-position-jump| for how to use this
914 for each opened file.
915 Only one position is remembered per buffer, not one
916 for each window. As long as the buffer is visible in
917 a window the position won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918
919 *'^* *`^*
920'^ `^ To the position where the cursor was the last time
Bram Moolenaar81695252004-12-29 20:58:21 +0000921 when Insert mode was stopped. This is used by the
922 |gi| command. Not set when the |:keepjumps| command
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200923 modifier was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924
925 *'.* *`.*
926'. `. To the position where the last change was made. The
927 position is at or near where the change started.
928 Sometimes a command is executed as several changes,
929 then the position can be near the end of what the
930 command changed. For example when inserting a word,
931 the position will be on the last character.
Bram Moolenaar51628222016-12-01 23:03:28 +0100932 To jump to older changes use |g;|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933
934 *'(* *`(*
935'( `( To the start of the current sentence, like the |(|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200936 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937
938 *')* *`)*
939') `) To the end 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 start of the current paragraph, like the |{|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200944 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946 *'}* *`}*
947'} `} To the end of the current paragraph, like the |}|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200948 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949
950These commands are not marks themselves, but jump to a mark:
951
952 *]'*
953]' [count] times to next line with a lowercase mark below
954 the cursor, on the first non-blank character in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200955 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956
957 *]`*
Bram Moolenaardad44732021-03-31 20:07:33 +0200958]` [count] times to lowercase mark after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959
960 *['*
961[' [count] times to previous line with a lowercase mark
962 before the cursor, on the first non-blank character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200963 the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964
965 *[`*
966[` [count] times to lowercase mark before the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967
968
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200969:loc[kmarks] {command} *:loc* *:lock* *:lockmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 Execute {command} without adjusting marks. This is
971 useful when changing text in a way that the line count
972 will be the same when the change has completed.
973 WARNING: When the line count does change, marks below
974 the change will keep their line number, thus move to
975 another text line.
976 These items will not be adjusted for deleted/inserted
977 lines:
978 - lower case letter marks 'a - 'z
979 - upper case letter marks 'A - 'Z
980 - numbered marks '0 - '9
981 - last insert position '^
982 - last change position '.
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100983 - last affected text area '[ and ']
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 - the Visual area '< and '>
985 - line numbers in placed signs
986 - line numbers in quickfix positions
987 - positions in the |jumplist|
988 - positions in the |tagstack|
989 These items will still be adjusted:
990 - previous context mark ''
991 - the cursor position
992 - the view of a window on a buffer
993 - folds
994 - diffs
995
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200996:kee[pmarks] {command} *:kee* *:keep* *:keepmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 Currently only has effect for the filter command
998 |:range!|:
999 - When the number of lines after filtering is equal to
1000 or larger than before, all marks are kept at the
1001 same line number.
1002 - When the number of lines decreases, the marks in the
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001003 lines that disappeared are deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 In any case the marks below the filtered text have
1005 their line numbers adjusted, thus stick to the text,
1006 as usual.
1007 When the 'R' flag is missing from 'cpoptions' this has
1008 the same effect as using ":keepmarks".
1009
1010 *:keepj* *:keepjumps*
1011:keepj[umps] {command}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001012 Moving around in {command} does not change the |''|,
1013 |'.| and |'^| marks, the |jumplist| or the
1014 |changelist|.
1015 Useful when making a change or inserting text
1016 automatically and the user doesn't want to go to this
1017 position. E.g., when updating a "Last change"
1018 timestamp in the first line: >
1019
Bram Moolenaare5180522005-12-10 20:19:46 +00001020 :let lnum = line(".")
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001021 :keepjumps normal gg
1022 :call SetLastChange()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001023 :keepjumps exe "normal " .. lnum .. "G"
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001024<
1025 Note that ":keepjumps" must be used for every command.
1026 When invoking a function the commands in that function
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001027 can still change the jumplist. Also, for
Bram Moolenaar13065c42005-01-08 16:08:21 +00001028 ":keepjumps exe 'command '" the "command" won't keep
1029 jumps. Instead use: ":exe 'keepjumps command'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031==============================================================================
10328. Jumps *jump-motions*
1033
Bram Moolenaarb477af22018-07-15 20:20:18 +02001034A "jump" is a command that normally moves the cursor several lines away. If
1035you make the cursor "jump" the position of the cursor before the jump is
Bram Moolenaar26967612019-03-17 17:13:16 +01001036remembered. You can return to that position with the "''" and "``" commands,
Bram Moolenaarb477af22018-07-15 20:20:18 +02001037unless the line containing that position was changed or deleted. The
1038following commands are "jump" commands: "'", "`", "G", "/", "?", "n", "N",
1039"%", "(", ")", "[[", "]]", "{", "}", ":s", ":tag", "L", "M", "H" and the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001040commands that start editing a new file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041
1042 *CTRL-O*
1043CTRL-O Go to [count] Older cursor position in jump list
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001044 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
1046<Tab> or *CTRL-I* *<Tab>*
1047CTRL-I Go to [count] newer cursor position in jump list
1048 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
Bram Moolenaardad44732021-03-31 20:07:33 +02001050 NOTE: In the GUI and in a terminal supporting
1051 |modifyOtherKeys|, CTRL-I can be mapped separately
1052 from <Tab>, on the condition that CTRL-I is
1053 mapped before <Tab>, otherwise the mapping applies to
1054 both.
1055
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 *:ju* *:jumps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001057:ju[mps] Print the jump list (not a motion command).
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001058
1059 *:cle* *:clearjumps*
1060:cle[arjumps] Clear the jump list of the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
1062 *jumplist*
1063Jumps are remembered in a jump list. With the CTRL-O and CTRL-I command you
1064can go to cursor positions before older jumps, and back again. Thus you can
1065move up and down the list. There is a separate jump list for each window.
1066The maximum number of entries is fixed at 100.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
1068For example, after three jump commands you have this jump list:
1069
Bram Moolenaardad44732021-03-31 20:07:33 +02001070 jump line col file/text ~
1071 3 1 0 some text ~
1072 2 70 0 another line ~
1073 1 1154 23 end. ~
1074 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001076The "file/text" column shows the file name, or the text at the jump if it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077in the current file (an indent is removed and a long line is truncated to fit
1078in the window).
1079
Christian Brabandta0f659c2022-04-09 13:35:00 +01001080The marker ">" indicates the current position in the jumplist. It may not be
Bram Moolenaar75ab5902022-04-18 15:36:40 +01001081shown when filtering the |:jumps| command using |:filter|
Christian Brabandta0f659c2022-04-09 13:35:00 +01001082
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083You are currently in line 1167. If you then use the CTRL-O command, the
1084cursor is put in line 1154. This results in:
1085
Bram Moolenaardad44732021-03-31 20:07:33 +02001086 jump line col file/text ~
1087 2 1 0 some text ~
1088 1 70 0 another line ~
1089 > 0 1154 23 end. ~
1090 1 1167 0 foo bar ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092The pointer will be set at the last used jump position. The next CTRL-O
1093command will use the entry above it, the next CTRL-I command will use the
1094entry below it. If the pointer is below the last entry, this indicates that
1095you did not use a CTRL-I or CTRL-O before. In this case the CTRL-O command
1096will cause the cursor position to be added to the jump list, so you can get
1097back to the position before the CTRL-O. In this case this is line 1167.
1098
1099With more CTRL-O commands you will go to lines 70 and 1. If you use CTRL-I
1100you can go back to 1154 and 1167 again. Note that the number in the "jump"
1101column indicates the count for the CTRL-O or CTRL-I command that takes you to
1102this position.
1103
1104If you use a jump command, the current line number is inserted at the end of
1105the jump list. If the same line was already in the jump list, it is removed.
1106The result is that when repeating CTRL-O you will get back to old positions
1107only once.
1108
1109When the |:keepjumps| command modifier is used, jumps are not stored in the
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001110jumplist. Jumps are also not stored in other cases, e.g., in a |:global|
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001111command. You can explicitly add a jump by setting the ' mark with "m'". Note
1112that calling setpos() does not do this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113
1114After the CTRL-O command that got you into line 1154 you could give another
1115jump command (e.g., "G"). The jump list would then become:
1116
Bram Moolenaardad44732021-03-31 20:07:33 +02001117 jump line col file/text ~
1118 4 1 0 some text ~
1119 3 70 0 another line ~
1120 2 1167 0 foo bar ~
1121 1 1154 23 end. ~
1122 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123
1124The line numbers will be adjusted for deleted and inserted lines. This fails
1125if you stop editing a file without writing, like with ":n!".
1126
1127When you split a window, the jumplist will be copied to the new window.
1128
1129If you have included the ' item in the 'viminfo' option the jumplist will be
1130stored in the viminfo file and restored when starting Vim.
1131
1132
1133CHANGE LIST JUMPS *changelist* *change-list-jumps* *E664*
1134
1135When making a change the cursor position is remembered. One position is
1136remembered for every change that can be undone, unless it is close to a
1137previous change. Two commands can be used to jump to positions of changes,
1138also those that have been undone:
1139
1140 *g;* *E662*
1141g; Go to [count] older position in change list.
1142 If [count] is larger than the number of older change
1143 positions go to the oldest change.
1144 If there is no older change an error message is given.
1145 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146
1147 *g,* *E663*
1148g, Go to [count] newer cursor position in change list.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001149 Just like |g;| but in the opposite direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
1152When using a count you jump as far back or forward as possible. Thus you can
1153use "999g;" to go to the first change for which the position is still
1154remembered. The number of entries in the change list is fixed and is the same
1155as for the |jumplist|.
1156
1157When two undo-able changes are in the same line and at a column position less
1158than 'textwidth' apart only the last one is remembered. This avoids that a
1159sequence of small changes in a line, for example "xxxxx", adds many positions
1160to the change list. When 'textwidth' is zero 'wrapmargin' is used. When that
1161also isn't set a fixed number of 79 is used. Detail: For the computations
1162bytes are used, not characters, to avoid a speed penalty (this only matters
Bram Moolenaar207f0092020-08-30 17:20:20 +02001163for multibyte encodings).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165Note that when text has been inserted or deleted the cursor position might be
1166a bit different from the position of the change. Especially when lines have
1167been deleted.
1168
Bram Moolenaardad44732021-03-31 20:07:33 +02001169When the `:keepjumps` command modifier is used the position of a change is not
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170remembered.
1171
1172 *:changes*
1173:changes Print the change list. A ">" character indicates the
1174 current position. Just after a change it is below the
Bram Moolenaara9604e62018-07-21 05:56:22 +02001175 newest entry, indicating that `g;` takes you to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 newest entry position. The first column indicates the
1177 count needed to take you to this position. Example:
1178
1179 change line col text ~
1180 3 9 8 bla bla bla
1181 2 11 57 foo is a bar
1182 1 14 54 the latest changed line
1183 >
1184
Bram Moolenaara9604e62018-07-21 05:56:22 +02001185 The `3g;` command takes you to line 9. Then the
1186 output of `:changes` is:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187
1188 change line col text ~
1189 > 0 9 8 bla bla bla
1190 1 11 57 foo is a bar
1191 2 14 54 the latest changed line
1192
1193 Now you can use "g," to go to line 11 and "2g," to go
1194 to line 14.
1195
1196==============================================================================
11979. Various motions *various-motions*
1198
1199 *%*
1200% Find the next item in this line after or under the
1201 cursor and jump to its match. |inclusive| motion.
1202 Items can be:
1203 ([{}]) parenthesis or (curly/square) brackets
1204 (this can be changed with the
1205 'matchpairs' option)
1206 /* */ start or end of C-style comment
1207 #if, #ifdef, #else, #elif, #endif
1208 C preprocessor conditionals (when the
1209 cursor is on the # or no ([{
Bram Moolenaardad44732021-03-31 20:07:33 +02001210 is following)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 For other items the matchit plugin can be used, see
Bram Moolenaar446cb832008-06-24 21:56:24 +00001212 |matchit-install|. This plugin also helps to skip
1213 matches in comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214
1215 When 'cpoptions' contains "M" |cpo-M| backslashes
1216 before parens and braces are ignored. Without "M" the
1217 number of backslashes matters: an even number doesn't
1218 match with an odd number. Thus in "( \) )" and "\( (
1219 \)" the first and last parenthesis match.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001220
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 When the '%' character is not present in 'cpoptions'
1222 |cpo-%|, parens and braces inside double quotes are
1223 ignored, unless the number of parens/braces in a line
1224 is uneven and this line and the previous one does not
1225 end in a backslash. '(', '{', '[', ']', '}' and ')'
1226 are also ignored (parens and braces inside single
1227 quotes). Note that this works fine for C, but not for
1228 Perl, where single quotes are used for strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001229
1230 Nothing special is done for matches in comments. You
1231 can either use the matchit plugin |matchit-install| or
1232 put quotes around matches.
1233
1234 No count is allowed, {count}% jumps to a line {count}
1235 percentage down the file |N%|. Using '%' on
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 #if/#else/#endif makes the movement linewise.
1237
1238 *[(*
Bram Moolenaardad44732021-03-31 20:07:33 +02001239[( Go to [count] previous unmatched '('.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001240 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 *[{*
Bram Moolenaardad44732021-03-31 20:07:33 +02001242[{ Go to [count] previous unmatched '{'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001243 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 *])*
Bram Moolenaardad44732021-03-31 20:07:33 +02001245]) Go to [count] next unmatched ')'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001246 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 *]}*
Bram Moolenaardad44732021-03-31 20:07:33 +02001248]} Go to [count] next unmatched '}'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001249 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
1251The above four commands can be used to go to the start or end of the current
1252code block. It is like doing "%" on the '(', ')', '{' or '}' at the other
1253end of the code block, but you can do this from anywhere in the code block.
1254Very useful for C programs. Example: When standing on "case x:", "[{" will
1255bring you back to the switch statement.
1256
1257 *]m*
1258]m Go to [count] next start of a method (for Java or
1259 similar structured language). When not before the
1260 start of a method, jump to the start or end of the
1261 class. When no '{' is found after the cursor, this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001262 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 *]M*
1264]M Go to [count] next end of a method (for Java or
1265 similar structured language). When not before the end
1266 of a method, jump to the start or end of the class.
1267 When no '}' is found after the cursor, this is an
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001268 error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 *[m*
1270[m Go to [count] previous start of a method (for Java or
1271 similar structured language). When not after the
1272 start of a method, jump to the start or end of the
1273 class. When no '{' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001274 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 *[M*
1276[M Go to [count] previous end of a method (for Java or
1277 similar structured language). When not after the
1278 end of a method, jump to the start or end of the
1279 class. When no '}' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001280 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281
Bram Moolenaardad44732021-03-31 20:07:33 +02001282The above four commands assume that the file contains a class with methods.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283The class definition is surrounded in '{' and '}'. Each method in the class
1284is also surrounded with '{' and '}'. This applies to the Java language. The
1285file looks like this: >
1286
1287 // comment
1288 class foo {
1289 int method_one() {
1290 body_one();
1291 }
1292 int method_two() {
1293 body_two();
1294 }
1295 }
Bram Moolenaardad44732021-03-31 20:07:33 +02001296
1297[To try this out copy the text and put it in a new buffer, the help text above
1298confuses the jump commands]
1299
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300Starting with the cursor on "body_two()", using "[m" will jump to the '{' at
1301the start of "method_two()" (obviously this is much more useful when the
1302method is long!). Using "2[m" will jump to the start of "method_one()".
1303Using "3[m" will jump to the start of the class.
1304
1305 *[#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001306[# Go to [count] previous unmatched "#if" or "#else".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001307 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308
1309 *]#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001310]# Go to [count] next unmatched "#else" or "#endif".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001311 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312
1313These two commands work in C programs that contain #if/#else/#endif
1314constructs. It brings you to the start or end of the #if/#else/#endif where
1315the current line is included. You can then use "%" to go to the matching line.
1316
1317 *[star* *[/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001318[* or [/ Go to [count] previous start of a C comment "/*".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001319 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320
1321 *]star* *]/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001322]* or ]/ Go to [count] next end of a C comment "*/".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001323 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324
1325
1326 *H*
1327H To line [count] from top (Home) of window (default:
1328 first line on the window) on the first non-blank
1329 character |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001330 Cursor is adjusted for 'scrolloff' option, unless an
1331 operator is pending, in which case the text may
1332 scroll. E.g. "yH" yanks from the first visible line
1333 until the cursor line (inclusive).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334
1335 *M*
1336M To Middle line of window, on the first non-blank
1337 character |linewise|. See also 'startofline' option.
1338
1339 *L*
1340L To line [count] from bottom of window (default: Last
1341 line on the window) on the first non-blank character
1342 |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001343 Cursor is adjusted for 'scrolloff' option, unless an
1344 operator is pending, in which case the text may
1345 scroll. E.g. "yL" yanks from the cursor to the last
1346 visible line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
1348<LeftMouse> Moves to the position on the screen where the mouse
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001349 click is |exclusive|. See also |<LeftMouse>|. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 position is in a status line, that window is made the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001351 active window and the cursor is not moved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001353 vim:tw=78:ts=8:noet:ft=help:norl: