blob: 4412d56d1d42b32e2fe1aec33d18b5e9a049c19c [file] [log] [blame]
Bram Moolenaar0e6adf82021-12-16 14:41:10 +00001*motion.txt* For Vim version 8.2. Last change: 2021 Dec 13
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Cursor motions *cursor-motions* *navigation*
8
9These commands move the cursor position. If the new position is off of the
10screen, the screen is scrolled to show the cursor (see also 'scrolljump' and
11'scrolloff' options).
12
131. Motions and operators |operator|
142. Left-right motions |left-right-motions|
153. Up-down motions |up-down-motions|
164. Word motions |word-motions|
175. Text object motions |object-motions|
186. Text object selection |object-select|
197. Marks |mark-motions|
208. Jumps |jump-motions|
219. Various motions |various-motions|
22
23General remarks:
24
25If you want to know where you are in the file use the "CTRL-G" command
26|CTRL-G| or the "g CTRL-G" command |g_CTRL-G|. If you set the 'ruler' option,
27the cursor position is continuously shown in the status line (which slows down
28Vim a little).
29
30Experienced users prefer the hjkl keys because they are always right under
31their fingers. Beginners often prefer the arrow keys, because they do not
32know what the hjkl keys do. The mnemonic value of hjkl is clear from looking
33at the keyboard. Think of j as an arrow pointing downwards.
34
35The 'virtualedit' option can be set to make it possible to move the cursor to
36positions where there is no character or halfway a character.
37
38==============================================================================
391. Motions and operators *operator*
40
41The motion commands can be used after an operator command, to have the command
42operate on the text that was moved over. That is the text between the cursor
43position before and after the motion. Operators are generally used to delete
44or change text. The following operators are available:
45
46 |c| c change
47 |d| d delete
48 |y| y yank into register (does not change the text)
49 |~| ~ swap case (only if 'tildeop' is set)
50 |g~| g~ swap case
51 |gu| gu make lowercase
52 |gU| gU make uppercase
53 |!| ! filter through an external program
54 |=| = filter through 'equalprg' or C-indenting if empty
55 |gq| gq text formatting
Bram Moolenaar68e65602019-05-26 21:33:31 +020056 |gw| gw text formatting with no cursor movement
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 |g?| g? ROT13 encoding
58 |>| > shift right
59 |<| < shift left
60 |zf| zf define a fold
Bram Moolenaar6c35bea2012-07-25 17:49:10 +020061 |g@| g@ call function set with the 'operatorfunc' option
Bram Moolenaar2346a632021-06-13 19:02:49 +020062 *motion-count-multiplied*
Bram Moolenaar071d4272004-06-13 20:20:40 +000063If the motion includes a count and the operator also had a count before it,
64the two counts are multiplied. For example: "2d3w" deletes six words.
Bram Moolenaar2346a632021-06-13 19:02:49 +020065 *operator-doubled*
66When doubling the operator it operates on a line. When using a count, before
67or after the first character, that many lines are operated upon. Thus `3dd`
68deletes three lines. A count before and after the first character is
69multiplied, thus `2y3y` yanks six lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +000070
71After applying the operator the cursor is mostly left at the start of the text
72that was operated upon. For example, "yfe" doesn't move the cursor, but "yFe"
73moves the cursor leftwards to the "e" where the yank started.
74
75 *linewise* *characterwise*
76The operator either affects whole lines, or the characters between the start
77and end position. Generally, motions that move between lines affect lines
78(are linewise), and motions that move within a line affect characters (are
79characterwise). However, there are some exceptions.
80
81 *exclusive* *inclusive*
Bram Moolenaar78984f52005-08-01 07:19:10 +000082A character motion is either inclusive or exclusive. When inclusive, the
83start and end position of the motion are included in the operation. When
84exclusive, the last character towards the end of the buffer is not included.
85Linewise motions always include the start and end position.
Bram Moolenaar071d4272004-06-13 20:20:40 +000086
Bram Moolenaar78984f52005-08-01 07:19:10 +000087Which motions are linewise, inclusive or exclusive is mentioned with the
88command. There are however, two general exceptions:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891. If the motion is exclusive and the end of the motion is in column 1, the
90 end of the motion is moved to the end of the previous line and the motion
91 becomes inclusive. Example: "}" moves to the first line after a paragraph,
92 but "d}" will not include that line.
Bram Moolenaar5eb86f92004-07-26 12:53:41 +000093 *exclusive-linewise*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942. If the motion is exclusive, the end of the motion is in column 1 and the
95 start of the motion was at or before the first non-blank in the line, the
96 motion becomes linewise. Example: If a paragraph begins with some blanks
97 and you do "d}" while standing on the first non-blank, all the lines of
98 the paragraph are deleted, including the blanks. If you do a put now, the
99 deleted lines will be inserted below the cursor position.
100
101Note that when the operator is pending (the operator command is typed, but the
102motion isn't yet), a special set of mappings can be used. See |:omap|.
103
104Instead of first giving the operator and then a motion you can use Visual
105mode: mark the start of the text with "v", move the cursor to the end of the
106text that is to be affected and then hit the operator. The text between the
107start and the cursor position is highlighted, so you can see what text will
108be operated upon. This allows much more freedom, but requires more key
109strokes and has limited redo functionality. See the chapter on Visual mode
110|Visual-mode|.
111
112You can use a ":" command for a motion. For example "d:call FindEnd()".
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100113But this can't be repeated with "." if the command is more than one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114This can be repeated: >
115 d:call search("f")<CR>
116This cannot be repeated: >
117 d:if 1<CR>
118 call search("f")<CR>
119 endif<CR>
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100120Note that when using ":" any motion becomes characterwise exclusive.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121
Bram Moolenaarc8c88492018-12-27 23:59:26 +0100122 *forced-motion*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000123FORCING A MOTION TO BE LINEWISE, CHARACTERWISE OR BLOCKWISE
124
125When a motion is not of the type you would like to use, you can force another
126type by using "v", "V" or CTRL-V just after the operator.
127Example: >
128 dj
129deletes two lines >
130 dvj
131deletes from the cursor position until the character below the cursor >
132 d<C-V>j
133deletes the character under the cursor and the character below the cursor. >
134
135Be careful with forcing a linewise movement to be used characterwise or
136blockwise, the column may not always be defined.
137
138 *o_v*
139v When used after an operator, before the motion command: Force
140 the operator to work characterwise, also when the motion is
141 linewise. If the motion was linewise, it will become
142 |exclusive|.
143 If the motion already was characterwise, toggle
144 inclusive/exclusive. This can be used to make an exclusive
145 motion inclusive and an inclusive motion exclusive.
146
147 *o_V*
148V When used after an operator, before the motion command: Force
149 the operator to work linewise, also when the motion is
150 characterwise.
151
152 *o_CTRL-V*
153CTRL-V When used after an operator, before the motion command: Force
154 the operator to work blockwise. This works like Visual block
155 mode selection, with the corners defined by the cursor
156 position before and after the motion.
157
158==============================================================================
1592. Left-right motions *left-right-motions*
160
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100161These commands move the cursor to the specified column in the current line.
162They stop at the first column and at the end of the line, except "$", which
163may move to one of the next lines. See 'whichwrap' option to make some of the
164commands move across line boundaries.
165
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166h or *h*
167<Left> or *<Left>*
168CTRL-H or *CTRL-H* *<BS>*
169<BS> [count] characters to the left. |exclusive| motion.
170 Note: If you prefer <BS> to delete a character, use
171 the mapping:
172 :map CTRL-V<BS> X
173 (to enter "CTRL-V<BS>" type the CTRL-V key, followed
174 by the <BS> key)
175 See |:fixdel| if the <BS> key does not do what you
176 want.
177
178l or *l*
179<Right> or *<Right>* *<Space>*
180<Space> [count] characters to the right. |exclusive| motion.
Bram Moolenaarf2571c62015-06-09 19:44:55 +0200181 See the 'whichwrap' option for adjusting the behavior
182 at end of line
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183
184 *0*
1850 To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000186 motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187
188 *<Home>* *<kHome>*
189<Home> To the first character of the line. |exclusive|
Bram Moolenaar9964e462007-05-05 17:54:07 +0000190 motion. When moving up or down next, stay in same
191 TEXT column (if possible). Most other commands stay
192 in the same SCREEN column. <Home> works like "1|",
193 which differs from "0" when the line starts with a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200194 <Tab>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195
196 *^*
197^ To the first non-blank character of the line.
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100198 |exclusive| motion. Any count is ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000199
200 *$* *<End>* *<kEnd>*
201$ or <End> To the end of the line. When a count is given also go
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100202 [count - 1] lines downward, or as far is possible.
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200203 |inclusive| motion. If a count of 2 or larger is
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100204 given and the cursor is on the last line, that is an
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200205 error and the cursor doesn't move.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 In Visual mode the cursor goes to just after the last
207 character in the line.
208 When 'virtualedit' is active, "$" may move the cursor
209 back from past the end of the line to the last
210 character in the line.
211
212 *g_*
213g_ To the last non-blank character of the line and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200214 [count - 1] lines downward |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215
216 *g0* *g<Home>*
217g0 or g<Home> When lines wrap ('wrap' on): To the first character of
218 the screen line. |exclusive| motion. Differs from
219 "0" when a line is wider than the screen.
220 When lines don't wrap ('wrap' off): To the leftmost
221 character of the current line that is on the screen.
222 Differs from "0" when the first character of the line
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200223 is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224
225 *g^*
226g^ When lines wrap ('wrap' on): To the first non-blank
227 character of the screen line. |exclusive| motion.
228 Differs from "^" when a line is wider than the screen.
229 When lines don't wrap ('wrap' off): To the leftmost
230 non-blank character of the current line that is on the
231 screen. Differs from "^" when the first non-blank
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200232 character of the line is not on the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233
234 *gm*
235gm Like "g0", but half a screenwidth to the right (or as
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200236 much as possible).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +0100238 *gM*
Bram Moolenaar8b530c12019-10-28 02:13:05 +0100239gM Like "g0", but to halfway the text of the line.
240 With a count: to this percentage of text in the line.
241 Thus "10gM" is near the start of the text and "90gM"
242 is near the end of the text.
243
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244 *g$* *g<End>*
245g$ or g<End> When lines wrap ('wrap' on): To the last character of
246 the screen line and [count - 1] screen lines downward
247 |inclusive|. Differs from "$" when a line is wider
248 than the screen.
249 When lines don't wrap ('wrap' off): To the rightmost
250 character of the current line that is visible on the
251 screen. Differs from "$" when the last character of
252 the line is not on the screen or when a count is used.
253 Additionally, vertical movements keep the column,
254 instead of going to the end of the line.
Bram Moolenaar9ba7e172013-07-17 22:37:26 +0200255 When 'virtualedit' is enabled moves to the end of the
256 screen line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *bar*
259| To screen column [count] in the current line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100260 |exclusive| motion. Ceci n'est pas une pipe.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261
262 *f*
263f{char} To [count]'th occurrence of {char} to the right. The
264 cursor is placed on {char} |inclusive|.
265 {char} can be entered as a digraph |digraph-arg|.
266 When 'encoding' is set to Unicode, composing
267 characters may be used, see |utf-8-char-arg|.
268 |:lmap| mappings apply to {char}. The CTRL-^ command
269 in Insert mode can be used to switch this on/off
270 |i_CTRL-^|.
271
272 *F*
273F{char} To the [count]'th occurrence of {char} to the left.
Bram Moolenaar78984f52005-08-01 07:19:10 +0000274 The cursor is placed on {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275 {char} can be entered like with the |f| command.
276
277 *t*
278t{char} Till before [count]'th occurrence of {char} to the
279 right. The cursor is placed on the character left of
280 {char} |inclusive|.
281 {char} can be entered like with the |f| command.
282
283 *T*
284T{char} Till after [count]'th occurrence of {char} to the
285 left. The cursor is placed on the character right of
Bram Moolenaar78984f52005-08-01 07:19:10 +0000286 {char} |exclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000287 {char} can be entered like with the |f| command.
288
289 *;*
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200290; Repeat latest f, t, F or T [count] times. See |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000291
292 *,*
293, Repeat latest f, t, F or T in opposite direction
Bram Moolenaar8b3e0332011-06-26 05:36:34 +0200294 [count] times. See also |cpo-;|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296==============================================================================
2973. Up-down motions *up-down-motions*
298
299k or *k*
300<Up> or *<Up>* *CTRL-P*
301CTRL-P [count] lines upward |linewise|.
302
303j or *j*
304<Down> or *<Down>*
305CTRL-J or *CTRL-J*
306<NL> or *<NL>* *CTRL-N*
307CTRL-N [count] lines downward |linewise|.
308
309gk or *gk* *g<Up>*
310g<Up> [count] display lines upward. |exclusive| motion.
311 Differs from 'k' when lines wrap, and when used with
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200312 an operator, because it's not linewise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000313
314gj or *gj* *g<Down>*
315g<Down> [count] display lines downward. |exclusive| motion.
316 Differs from 'j' 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
319 *-*
320- <minus> [count] lines upward, on the first non-blank
321 character |linewise|.
322
323+ or *+*
324CTRL-M or *CTRL-M* *<CR>*
325<CR> [count] lines downward, on the first non-blank
326 character |linewise|.
327
328 *_*
329_ <underscore> [count] - 1 lines downward, on the first non-blank
330 character |linewise|.
331
332 *G*
333G Goto line [count], default last line, on the first
334 non-blank character |linewise|. If 'startofline' not
335 set, keep the same column.
Bram Moolenaar26967612019-03-17 17:13:16 +0100336 G is one of the |jump-motions|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338 *<C-End>*
339<C-End> Goto line [count], default last line, on the last
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200340 character |inclusive|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342<C-Home> or *gg* *<C-Home>*
343gg Goto line [count], default first line, on the first
344 non-blank character |linewise|. If 'startofline' not
345 set, keep the same column.
346
Bram Moolenaar9b451252012-08-15 17:43:31 +0200347 *:[range]*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100348:[range] Set the cursor on the last line number in [range].
349 [range] can also be just one line number, e.g., ":1"
350 or ":'m".
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200351 In contrast with |G| this command does not modify the
352 |jumplist|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 *N%*
354{count}% Go to {count} percentage in the file, on the first
355 non-blank in the line |linewise|. To compute the new
356 line number this formula is used:
357 ({count} * number-of-lines + 99) / 100
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200358 See also 'startofline' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359
360:[range]go[to] [count] *:go* *:goto* *go*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100361[count]go Go to [count] byte in the buffer. Default [count] is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362 one, start of the file. When giving [range], the
363 last number in it used as the byte count. End-of-line
364 characters are counted depending on the current
365 'fileformat' setting.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200366 Also see the |line2byte()| function, and the 'o'
367 option in 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368 {not available when compiled without the
369 |+byte_offset| feature}
370
371These commands move to the specified line. They stop when reaching the first
372or the last line. The first two commands put the cursor in the same column
373(if possible) as it was after the last command that changed the column,
374except after the "$" command, then the cursor will be put on the last
375character of the line.
376
Bram Moolenaar7c626922005-02-07 22:01:03 +0000377If "k", "-" or CTRL-P is used with a [count] and there are less than [count]
378lines above the cursor and the 'cpo' option includes the "-" flag it is an
379error. |cpo--|.
380
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381==============================================================================
3824. Word motions *word-motions*
383
384<S-Right> or *<S-Right>* *w*
385w [count] words forward. |exclusive| motion.
386
387<C-Right> or *<C-Right>* *W*
388W [count] WORDS forward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000389 If <C-Right> does not work, check out
390 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391
392 *e*
393e Forward to the end of word [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000394 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000395
396 *E*
397E Forward to the end of WORD [count] |inclusive|.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000398 Does not stop in an empty line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399
400<S-Left> or *<S-Left>* *b*
401b [count] words backward. |exclusive| motion.
402
403<C-Left> or *<C-Left>* *B*
404B [count] WORDS backward. |exclusive| motion.
Bram Moolenaar47003982021-12-05 21:54:04 +0000405 If <C-Left> does not work, check out
406 |arrow_modifiers|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408 *ge*
409ge Backward to the end of word [count] |inclusive|.
410
411 *gE*
412gE Backward to the end of WORD [count] |inclusive|.
413
414These commands move over words or WORDS.
415 *word*
416A word consists of a sequence of letters, digits and underscores, or a
417sequence of other non-blank characters, separated with white space (spaces,
Bram Moolenaar4770d092006-01-12 23:22:24 +0000418tabs, <EOL>). This can be changed with the 'iskeyword' option. An empty line
419is also considered to be a word.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 *WORD*
421A WORD consists of a sequence of non-blank characters, separated with white
Bram Moolenaar4770d092006-01-12 23:22:24 +0000422space. An empty line is also considered to be a WORD.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423
424A sequence of folded lines is counted for one word of a single character.
425"w" and "W", "e" and "E" move to the start/end of the first word or WORD after
426a range of folded lines. "b" and "B" move to the start of the first word or
427WORD before the fold.
428
429Special case: "cw" and "cW" are treated like "ce" and "cE" if the cursor is
430on a non-blank. This is because "cw" is interpreted as change-word, and a
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200431word does not include the following white space.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432
433Another special case: When using the "w" motion in combination with an
434operator and the last word moved over is at the end of a line, the end of
435that word becomes the end of the operated text, not the first word in the
436next line.
437
438The original Vi implementation of "e" is buggy. For example, the "e" command
439will stop on the first character of a line if the previous line was empty.
440But when you use "2e" this does not happen. In Vim "ee" and "2e" are the
441same, which is more logical. However, this causes a small incompatibility
442between Vi and Vim.
443
444==============================================================================
4455. Text object motions *object-motions*
446
447 *(*
448( [count] sentences backward. |exclusive| motion.
449
450 *)*
451) [count] sentences forward. |exclusive| motion.
452
453 *{*
454{ [count] paragraphs backward. |exclusive| motion.
455
456 *}*
457} [count] paragraphs forward. |exclusive| motion.
458
459 *]]*
460]] [count] sections forward or to the next '{' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000461 first column. When used after an operator, then also
462 stops below a '}' in the first column. |exclusive|
463 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464
465 *][*
466][ [count] sections forward or to the next '}' in the
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000467 first column. |exclusive|
468 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469
470 *[[*
471[[ [count] sections backward or to the previous '{' in
Bram Moolenaar5eb86f92004-07-26 12:53:41 +0000472 the first column. |exclusive|
473 Note that |exclusive-linewise| often applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475 *[]*
476[] [count] sections 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
480These commands move over three kinds of text objects.
481
482 *sentence*
483A sentence is defined as ending at a '.', '!' or '?' followed by either the
484end of a line, or by a space or tab. Any number of closing ')', ']', '"'
485and ''' characters may appear after the '.', '!' or '?' before the spaces,
486tabs or end of line. A paragraph and section boundary is also a sentence
487boundary.
488If the 'J' flag is present in 'cpoptions', at least two spaces have to
489follow the punctuation mark; <Tab>s are not recognized as white space.
490The definition of a sentence cannot be changed.
491
492 *paragraph*
493A paragraph begins after each empty line, and also at each of a set of
494paragraph macros, specified by the pairs of characters in the 'paragraphs'
Bram Moolenaar446cb832008-06-24 21:56:24 +0000495option. The default is "IPLPPPQPP TPHPLIPpLpItpplpipbp", which corresponds to
496the macros ".IP", ".LP", etc. (These are nroff macros, so the dot must be in
497the first column). A section boundary is also a paragraph boundary.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000498Note that a blank line (only containing white space) is NOT a paragraph
499boundary.
500Also note that this does not include a '{' or '}' in the first column. When
501the '{' flag is in 'cpoptions' then '{' in the first column is used as a
502paragraph boundary |posix|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503
504 *section*
505A section begins after a form-feed (<C-L>) in the first column and at each of
506a set of section macros, specified by the pairs of characters in the
507'sections' option. The default is "SHNHH HUnhsh", which defines a section to
508start at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
509
Bram Moolenaar207f0092020-08-30 17:20:20 +0200510The "]]" and "[[" commands stop at the '{' in the first column. This is
511useful to find the start of a function in a C program. To search for a '}' in
512the first column, the end of a C function, use "][" (forward) or "[]"
513(backward). Note that the first character of the command determines the
514search direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
516If your '{' or '}' are not in the first column, and you would like to use "[["
517and "]]" anyway, try these mappings: >
518 :map [[ ?{<CR>w99[{
519 :map ][ /}<CR>b99]}
520 :map ]] j0[[%/{<CR>
521 :map [] k$][%?}<CR>
522[type these literally, see |<>|]
523
524==============================================================================
5256. Text object selection *object-select* *text-objects*
526 *v_a* *v_i*
527
528This is a series of commands that can only be used while in Visual mode or
529after an operator. The commands that start with "a" select "a"n object
530including white space, the commands starting with "i" select an "inner" object
531without white space, or just the white space. Thus the "inner" commands
532always select less text than the "a" commands.
533
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534These commands are not available when the |+textobjects| feature has been
535disabled at compile time.
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200536Also see `gn` and `gN`, operating on the last search pattern.
537
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538 *v_aw* *aw*
539aw "a word", select [count] words (see |word|).
540 Leading or trailing white space is included, but not
541 counted.
542 When used in Visual linewise mode "aw" switches to
543 Visual characterwise mode.
544
545 *v_iw* *iw*
546iw "inner word", select [count] words (see |word|).
547 White space between words is counted too.
548 When used in Visual linewise mode "iw" switches to
549 Visual characterwise mode.
550
551 *v_aW* *aW*
552aW "a WORD", select [count] WORDs (see |WORD|).
553 Leading or trailing white space is included, but not
554 counted.
555 When used in Visual linewise mode "aW" switches to
556 Visual characterwise mode.
557
558 *v_iW* *iW*
559iW "inner WORD", select [count] WORDs (see |WORD|).
560 White space between words is counted too.
561 When used in Visual linewise mode "iW" switches to
562 Visual characterwise mode.
563
564 *v_as* *as*
565as "a sentence", select [count] sentences (see
566 |sentence|).
567 When used in Visual mode it is made characterwise.
568
569 *v_is* *is*
570is "inner sentence", select [count] sentences (see
571 |sentence|).
572 When used in Visual mode it is made characterwise.
573
574 *v_ap* *ap*
575ap "a paragraph", select [count] paragraphs (see
576 |paragraph|).
577 Exception: a blank line (only containing white space)
578 is also a paragraph boundary.
579 When used in Visual mode it is made linewise.
580
581 *v_ip* *ip*
582ip "inner paragraph", select [count] paragraphs (see
583 |paragraph|).
584 Exception: a blank line (only containing white space)
585 is also a paragraph boundary.
586 When used in Visual mode it is made linewise.
587
588a] *v_a]* *v_a[* *a]* *a[*
589a[ "a [] block", select [count] '[' ']' blocks. This
590 goes backwards to the [count] unclosed '[', and finds
591 the matching ']'. The enclosed text is selected,
592 including the '[' and ']'.
593 When used in Visual mode it is made characterwise.
594
595i] *v_i]* *v_i[* *i]* *i[*
596i[ "inner [] block", select [count] '[' ']' blocks. This
597 goes backwards to the [count] unclosed '[', and finds
598 the matching ']'. The enclosed text is selected,
599 excluding the '[' and ']'.
600 When used in Visual mode it is made characterwise.
601
602a) *v_a)* *a)* *a(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200603a( *vab* *v_ab* *v_a(* *ab*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604ab "a block", select [count] blocks, from "[count] [(" to
605 the matching ')', including the '(' and ')' (see
606 |[(|). Does not include white space outside of the
607 parenthesis.
608 When used in Visual mode it is made characterwise.
609
610i) *v_i)* *i)* *i(*
Bram Moolenaar269f5952016-07-15 22:54:41 +0200611i( *vib* *v_ib* *v_i(* *ib*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612ib "inner block", select [count] blocks, from "[count] [("
613 to the matching ')', excluding the '(' and ')' (see
614 |[(|).
615 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.
635
636 *v_it* *it*
637it "inner tag block", select [count] tag blocks, from the
638 [count]'th unmatched "<aaa>" backwards to the matching
639 "</aaa>", excluding the "<aaa>" and "</aaa>".
640 See |tag-blocks| about the details.
641 When used in Visual mode it is made characterwise.
642
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643a} *v_a}* *a}* *a{*
644a{ *v_aB* *v_a{* *aB*
645aB "a Block", select [count] Blocks, from "[count] [{" to
646 the matching '}', including the '{' and '}' (see
647 |[{|).
648 When used in Visual mode it is made characterwise.
649
650i} *v_i}* *i}* *i{*
651i{ *v_iB* *v_i{* *iB*
652iB "inner Block", select [count] Blocks, from "[count] [{"
653 to the matching '}', excluding the '{' and '}' (see
654 |[{|).
655 When used in Visual mode it is made characterwise.
656
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000657a" *v_aquote* *aquote*
658a' *v_a'* *a'*
659a` *v_a`* *a`*
660 "a quoted string". Selects the text from the previous
Bram Moolenaar5a305422006-04-28 22:38:25 +0000661 quote until the next quote. The 'quoteescape' option
662 is used to skip escaped quotes.
663 Only works within one line.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000664 When the cursor starts on a quote, Vim will figure out
665 which quote pairs form a string by searching from the
666 start of the line.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100667 Any trailing white space is included, unless there is
668 none, then leading white space is included.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000669 When used in Visual mode it is made characterwise.
670 Repeating this object in Visual mode another string is
671 included. A count is currently not used.
672
673i" *v_iquote* *iquote*
674i' *v_i'* *i'*
675i` *v_i`* *i`*
676 Like a", a' and a`, but exclude the quotes and
677 repeating won't extend the Visual selection.
Bram Moolenaarab194812005-09-14 21:40:12 +0000678 Special case: With a count of 2 the quotes are
679 included, but no extra white space as with a"/a'/a`.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000680
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681When used after an operator:
682For non-block objects:
683 For the "a" commands: The operator applies to the object and the white
684 space after the object. If there is no white space after the object
685 or when the cursor was in the white space before the object, the white
686 space before the object is included.
687 For the "inner" commands: If the cursor was on the object, the
688 operator applies to the object. If the cursor was on white space, the
689 operator applies to the white space.
690For a block object:
691 The operator applies to the block where the cursor is in, or the block
692 on which the cursor is on one of the braces. For the "inner" commands
693 the surrounding braces are excluded. For the "a" commands, the braces
694 are included.
695
696When used in Visual mode:
697When start and end of the Visual area are the same (just after typing "v"):
698 One object is selected, the same as for using an operator.
699When start and end of the Visual area are not the same:
700 For non-block objects the area is extended by one object or the white
701 space up to the next object, or both for the "a" objects. The
702 direction in which this happens depends on which side of the Visual
703 area the cursor is. For the block objects the block is extended one
704 level outwards.
705
706For illustration, here is a list of delete commands, grouped from small to big
707objects. Note that for a single character and a whole line the existing vi
708movement commands are used.
709 "dl" delete character (alias: "x") |dl|
710 "diw" delete inner word *diw*
711 "daw" delete a word *daw*
712 "diW" delete inner WORD (see |WORD|) *diW*
713 "daW" delete a WORD (see |WORD|) *daW*
Bram Moolenaar6c35bea2012-07-25 17:49:10 +0200714 "dgn" delete the next search pattern match *dgn*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715 "dd" delete one line |dd|
716 "dis" delete inner sentence *dis*
717 "das" delete a sentence *das*
718 "dib" delete inner '(' ')' block *dib*
719 "dab" delete a '(' ')' block *dab*
720 "dip" delete inner paragraph *dip*
721 "dap" delete a paragraph *dap*
722 "diB" delete inner '{' '}' block *diB*
723 "daB" delete a '{' '}' block *daB*
724
725Note the difference between using a movement command and an object. The
726movement command operates from here (cursor position) to where the movement
727takes us. When using an object the whole object is operated upon, no matter
728where on the object the cursor is. For example, compare "dw" and "daw": "dw"
729deletes from the cursor position to the start of the next word, "daw" deletes
730the word under the cursor and the space after or before it.
731
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000732
733Tag blocks *tag-blocks*
734
735For the "it" and "at" text objects an attempt is done to select blocks between
736matching tags for HTML and XML. But since these are not completely compatible
737there are a few restrictions.
738
739The normal method is to select a <tag> until the matching </tag>. For "at"
740the tags are included, for "it" they are excluded. But when "it" is repeated
Bram Moolenaar06a89a52006-04-29 22:01:03 +0000741the tags will be included (otherwise nothing would change). Also, "it" used
742on a tag block with no contents will select the leading tag.
Bram Moolenaar6c131c42005-07-19 22:17:30 +0000743
744"<aaa/>" items are skipped. Case is ignored, also for XML where case does
745matter.
746
747In HTML it is possible to have a tag like <br> or <meta ...> without a
748matching end tag. These are ignored.
749
750The text objects are tolerant about mistakes. Stray end tags are ignored.
751
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752==============================================================================
7537. Marks *mark-motions* *E20* *E78*
754
755Jumping to a mark can be done in two ways:
7561. With ` (backtick): The cursor is positioned at the specified location
757 and the motion is |exclusive|.
7582. With ' (single quote): The cursor is positioned on the first non-blank
759 character in the line of the specified location and
760 the motion is linewise.
761
762 *m* *mark* *Mark*
763m{a-zA-Z} Set mark {a-zA-Z} at cursor position (does not move
764 the cursor, this is not a motion command).
765
766 *m'* *m`*
767m' or m` Set the previous context mark. This can be jumped to
768 with the "''" or "``" command (does not move the
769 cursor, this is not a motion command).
770
771 *m[* *m]*
772m[ or m] Set the |'[| or |']| mark. Useful when an operator is
773 to be simulated by multiple commands. (does not move
774 the cursor, this is not a motion command).
775
Bram Moolenaar30b65812012-07-12 22:01:11 +0200776 *m<* *m>*
777m< or m> Set the |'<| or |'>| mark. Useful to change what the
778 `gv` command selects. (does not move the cursor, this
779 is not a motion command).
780 Note that the Visual mode cannot be set, only the
781 start and end position.
782
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 *:ma* *:mark* *E191*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000784:[range]ma[rk] {a-zA-Z'}
785 Set mark {a-zA-Z'} at last line number in [range],
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 column 0. Default is cursor line.
787
788 *:k*
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000789:[range]k{a-zA-Z'} Same as :mark, but the space before the mark name can
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 be omitted.
791
792 *'* *'a* *`* *`a*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000793'{a-z} `{a-z} Jump to the mark {a-z} in the current buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
795 *'A* *'0* *`A* *`0*
Bram Moolenaar9964e462007-05-05 17:54:07 +0000796'{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 +0200797 a motion command when in another file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798
799 *g'* *g'a* *g`* *g`a*
800g'{mark} g`{mark}
801 Jump to the {mark}, but don't change the jumplist when
802 jumping within the current buffer. Example: >
803 g`"
804< jumps to the last known position in a file. See
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000805 $VIMRUNTIME/vimrc_example.vim.
806 Also see |:keepjumps|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *:marks*
809:marks List all the current marks (not a motion command).
810 The |'(|, |')|, |'{| and |'}| marks are not listed.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000811 The first column has number zero.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200812
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813 *E283*
814:marks {arg} List the marks that are mentioned in {arg} (not a
815 motion command). For example: >
816 :marks aB
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200817< to list marks 'a' and 'B'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000819 *:delm* *:delmarks*
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000820:delm[arks] {marks} Delete the specified marks. Marks that can be deleted
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000821 include A-Z and 0-9. You cannot delete the ' mark.
822 They can be specified by giving the list of mark
823 names, or with a range, separated with a dash. Spaces
824 are ignored. Examples: >
825 :delmarks a deletes mark a
826 :delmarks a b 1 deletes marks a, b and 1
827 :delmarks Aa deletes marks A and a
828 :delmarks p-z deletes marks in the range p to z
829 :delmarks ^.[] deletes marks ^ . [ ]
830 :delmarks \" deletes mark "
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000831
832:delm[arks]! Delete all marks for the current buffer, but not marks
833 A-Z or 0-9.
Bram Moolenaarc0197e22004-09-13 20:26:32 +0000834
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835A mark is not visible in any way. It is just a position in the file that is
836remembered. Do not confuse marks with named registers, they are totally
837unrelated.
838
839'a - 'z lowercase marks, valid within one file
840'A - 'Z uppercase marks, also called file marks, valid between files
841'0 - '9 numbered marks, set from .viminfo file
842
843Lowercase marks 'a to 'z are remembered as long as the file remains in the
844buffer list. If you remove the file from the buffer list, all its marks are
845lost. If you delete a line that contains a mark, that mark is erased.
846
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847Lowercase marks can be used in combination with operators. For example: "d't"
848deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for
849Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and
850redo.
851
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200852Uppercase marks 'A to 'Z include the file name. You can use them to jump from
853file to file. You can only use an uppercase mark with an operator if the mark
854is in the current file. The line number of the mark remains correct, even if
855you insert/delete lines or edit another file for a moment. When the 'viminfo'
856option is not empty, uppercase marks are kept in the .viminfo file. See
857|viminfo-file-marks|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
859Numbered marks '0 to '9 are quite different. They can not be set directly.
860They are only present when using a viminfo file |viminfo-file|. Basically '0
861is the location of the cursor when you last exited Vim, '1 the last but one
862time, etc. Use the "r" flag in 'viminfo' to specify files for which no
863Numbered mark should be stored. See |viminfo-file-marks|.
864
865
866 *'[* *`[*
867'[ `[ To the first character of the previously changed
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200868 or yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869
870 *']* *`]*
871'] `] To the last character of the previously changed or
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200872 yanked text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873
874After executing an operator the Cursor is put at the beginning of the text
875that was operated upon. After a put command ("p" or "P") the cursor is
876sometimes placed at the first inserted line and sometimes on the last inserted
877character. The four commands above put the cursor at either end. Example:
878After yanking 10 lines you want to go to the last one of them: "10Y']". After
879inserting several lines with the "p" command you want to jump to the lowest
880inserted line: "p']". This also works for text that has been inserted.
881
882Note: After deleting text, the start and end positions are the same, except
883when using blockwise Visual mode. These commands do not work when no change
884was made yet in the current file.
885
886 *'<* *`<*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000887'< `< To the first line or character of the last selected
888 Visual area in the current buffer. For block mode it
889 may also be the last character in the first line (to
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200890 be able to define the block).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891
892 *'>* *`>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000893'> `> To the last line or character of the last selected
894 Visual area in the current buffer. For block mode it
895 may also be the first character of the last line (to
896 be able to define the block). Note that 'selection'
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000897 applies, the position may be just after the Visual
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200898 area.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899
900 *''* *``*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000901'' `` To the position before the latest jump, or where the
902 last "m'" or "m`" command was given. Not set when the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 |:keepjumps| command modifier was used.
904 Also see |restore-position|.
905
906 *'quote* *`quote*
907'" `" To the cursor position when last exiting the current
908 buffer. Defaults to the first character of the first
909 line. See |last-position-jump| for how to use this
910 for each opened file.
911 Only one position is remembered per buffer, not one
912 for each window. As long as the buffer is visible in
913 a window the position won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914
915 *'^* *`^*
916'^ `^ To the position where the cursor was the last time
Bram Moolenaar81695252004-12-29 20:58:21 +0000917 when Insert mode was stopped. This is used by the
918 |gi| command. Not set when the |:keepjumps| command
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200919 modifier was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920
921 *'.* *`.*
922'. `. To the position where the last change was made. The
923 position is at or near where the change started.
924 Sometimes a command is executed as several changes,
925 then the position can be near the end of what the
926 command changed. For example when inserting a word,
927 the position will be on the last character.
Bram Moolenaar51628222016-12-01 23:03:28 +0100928 To jump to older changes use |g;|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 *'(* *`(*
931'( `( To the start of the current sentence, like the |(|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200932 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933
934 *')* *`)*
935') `) To the end 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 start of the current paragraph, 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 paragraph, like the |}|
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200944 command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946These commands are not marks themselves, but jump to a mark:
947
948 *]'*
949]' [count] times to next line with a lowercase mark below
950 the cursor, on the first non-blank character in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200951 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952
953 *]`*
Bram Moolenaardad44732021-03-31 20:07:33 +0200954]` [count] times to lowercase mark after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 *['*
957[' [count] times to previous line with a lowercase mark
958 before the cursor, on the first non-blank character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200959 the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 *[`*
962[` [count] times to lowercase mark before the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200965:loc[kmarks] {command} *:loc* *:lock* *:lockmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 Execute {command} without adjusting marks. This is
967 useful when changing text in a way that the line count
968 will be the same when the change has completed.
969 WARNING: When the line count does change, marks below
970 the change will keep their line number, thus move to
971 another text line.
972 These items will not be adjusted for deleted/inserted
973 lines:
974 - lower case letter marks 'a - 'z
975 - upper case letter marks 'A - 'Z
976 - numbered marks '0 - '9
977 - last insert position '^
978 - last change position '.
Bram Moolenaar09c6f262019-11-17 15:55:14 +0100979 - last affected text area '[ and ']
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 - the Visual area '< and '>
981 - line numbers in placed signs
982 - line numbers in quickfix positions
983 - positions in the |jumplist|
984 - positions in the |tagstack|
985 These items will still be adjusted:
986 - previous context mark ''
987 - the cursor position
988 - the view of a window on a buffer
989 - folds
990 - diffs
991
Bram Moolenaar61da1bf2019-06-06 12:14:49 +0200992:kee[pmarks] {command} *:kee* *:keep* *:keepmarks*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 Currently only has effect for the filter command
994 |:range!|:
995 - When the number of lines after filtering is equal to
996 or larger than before, all marks are kept at the
997 same line number.
998 - When the number of lines decreases, the marks in the
Bram Moolenaar69a7cb42004-06-20 12:51:53 +0000999 lines that disappeared are deleted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 In any case the marks below the filtered text have
1001 their line numbers adjusted, thus stick to the text,
1002 as usual.
1003 When the 'R' flag is missing from 'cpoptions' this has
1004 the same effect as using ":keepmarks".
1005
1006 *:keepj* *:keepjumps*
1007:keepj[umps] {command}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001008 Moving around in {command} does not change the |''|,
1009 |'.| and |'^| marks, the |jumplist| or the
1010 |changelist|.
1011 Useful when making a change or inserting text
1012 automatically and the user doesn't want to go to this
1013 position. E.g., when updating a "Last change"
1014 timestamp in the first line: >
1015
Bram Moolenaare5180522005-12-10 20:19:46 +00001016 :let lnum = line(".")
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001017 :keepjumps normal gg
1018 :call SetLastChange()
1019 :keepjumps exe "normal " . lnum . "G"
1020<
1021 Note that ":keepjumps" must be used for every command.
1022 When invoking a function the commands in that function
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001023 can still change the jumplist. Also, for
Bram Moolenaar13065c42005-01-08 16:08:21 +00001024 ":keepjumps exe 'command '" the "command" won't keep
1025 jumps. Instead use: ":exe 'keepjumps command'"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
1027==============================================================================
10288. Jumps *jump-motions*
1029
Bram Moolenaarb477af22018-07-15 20:20:18 +02001030A "jump" is a command that normally moves the cursor several lines away. If
1031you make the cursor "jump" the position of the cursor before the jump is
Bram Moolenaar26967612019-03-17 17:13:16 +01001032remembered. You can return to that position with the "''" and "``" commands,
Bram Moolenaarb477af22018-07-15 20:20:18 +02001033unless the line containing that position was changed or deleted. The
1034following commands are "jump" commands: "'", "`", "G", "/", "?", "n", "N",
1035"%", "(", ")", "[[", "]]", "{", "}", ":s", ":tag", "L", "M", "H" and the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001036commands that start editing a new file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037
1038 *CTRL-O*
1039CTRL-O Go to [count] Older cursor position in jump list
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001040 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041
1042<Tab> or *CTRL-I* *<Tab>*
1043CTRL-I Go to [count] newer cursor position in jump list
1044 (not a motion command).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
Bram Moolenaardad44732021-03-31 20:07:33 +02001046 NOTE: In the GUI and in a terminal supporting
1047 |modifyOtherKeys|, CTRL-I can be mapped separately
1048 from <Tab>, on the condition that CTRL-I is
1049 mapped before <Tab>, otherwise the mapping applies to
1050 both.
1051
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 *:ju* *:jumps*
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001053:ju[mps] Print the jump list (not a motion command).
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001054
1055 *:cle* *:clearjumps*
1056:cle[arjumps] Clear the jump list of the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
1058 *jumplist*
1059Jumps are remembered in a jump list. With the CTRL-O and CTRL-I command you
1060can go to cursor positions before older jumps, and back again. Thus you can
1061move up and down the list. There is a separate jump list for each window.
1062The maximum number of entries is fixed at 100.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
1064For example, after three jump commands you have this jump list:
1065
Bram Moolenaardad44732021-03-31 20:07:33 +02001066 jump line col file/text ~
1067 3 1 0 some text ~
1068 2 70 0 another line ~
1069 1 1154 23 end. ~
1070 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001072The "file/text" column shows the file name, or the text at the jump if it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073in the current file (an indent is removed and a long line is truncated to fit
1074in the window).
1075
1076You are currently in line 1167. If you then use the CTRL-O command, the
1077cursor is put in line 1154. This results in:
1078
Bram Moolenaardad44732021-03-31 20:07:33 +02001079 jump line col file/text ~
1080 2 1 0 some text ~
1081 1 70 0 another line ~
1082 > 0 1154 23 end. ~
1083 1 1167 0 foo bar ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
1085The pointer will be set at the last used jump position. The next CTRL-O
1086command will use the entry above it, the next CTRL-I command will use the
1087entry below it. If the pointer is below the last entry, this indicates that
1088you did not use a CTRL-I or CTRL-O before. In this case the CTRL-O command
1089will cause the cursor position to be added to the jump list, so you can get
1090back to the position before the CTRL-O. In this case this is line 1167.
1091
1092With more CTRL-O commands you will go to lines 70 and 1. If you use CTRL-I
1093you can go back to 1154 and 1167 again. Note that the number in the "jump"
1094column indicates the count for the CTRL-O or CTRL-I command that takes you to
1095this position.
1096
1097If you use a jump command, the current line number is inserted at the end of
1098the jump list. If the same line was already in the jump list, it is removed.
1099The result is that when repeating CTRL-O you will get back to old positions
1100only once.
1101
1102When the |:keepjumps| command modifier is used, jumps are not stored in the
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001103jumplist. Jumps are also not stored in other cases, e.g., in a |:global|
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001104command. You can explicitly add a jump by setting the ' mark with "m'". Note
1105that calling setpos() does not do this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106
1107After the CTRL-O command that got you into line 1154 you could give another
1108jump command (e.g., "G"). The jump list would then become:
1109
Bram Moolenaardad44732021-03-31 20:07:33 +02001110 jump line col file/text ~
1111 4 1 0 some text ~
1112 3 70 0 another line ~
1113 2 1167 0 foo bar ~
1114 1 1154 23 end. ~
1115 > ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117The line numbers will be adjusted for deleted and inserted lines. This fails
1118if you stop editing a file without writing, like with ":n!".
1119
1120When you split a window, the jumplist will be copied to the new window.
1121
1122If you have included the ' item in the 'viminfo' option the jumplist will be
1123stored in the viminfo file and restored when starting Vim.
1124
1125
1126CHANGE LIST JUMPS *changelist* *change-list-jumps* *E664*
1127
1128When making a change the cursor position is remembered. One position is
1129remembered for every change that can be undone, unless it is close to a
1130previous change. Two commands can be used to jump to positions of changes,
1131also those that have been undone:
1132
1133 *g;* *E662*
1134g; Go to [count] older position in change list.
1135 If [count] is larger than the number of older change
1136 positions go to the oldest change.
1137 If there is no older change an error message is given.
1138 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139
1140 *g,* *E663*
1141g, Go to [count] newer cursor position in change list.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001142 Just like |g;| but in the opposite direction.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 (not a motion command)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144
1145When using a count you jump as far back or forward as possible. Thus you can
1146use "999g;" to go to the first change for which the position is still
1147remembered. The number of entries in the change list is fixed and is the same
1148as for the |jumplist|.
1149
1150When two undo-able changes are in the same line and at a column position less
1151than 'textwidth' apart only the last one is remembered. This avoids that a
1152sequence of small changes in a line, for example "xxxxx", adds many positions
1153to the change list. When 'textwidth' is zero 'wrapmargin' is used. When that
1154also isn't set a fixed number of 79 is used. Detail: For the computations
1155bytes are used, not characters, to avoid a speed penalty (this only matters
Bram Moolenaar207f0092020-08-30 17:20:20 +02001156for multibyte encodings).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157
1158Note that when text has been inserted or deleted the cursor position might be
1159a bit different from the position of the change. Especially when lines have
1160been deleted.
1161
Bram Moolenaardad44732021-03-31 20:07:33 +02001162When the `:keepjumps` command modifier is used the position of a change is not
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163remembered.
1164
1165 *:changes*
1166:changes Print the change list. A ">" character indicates the
1167 current position. Just after a change it is below the
Bram Moolenaara9604e62018-07-21 05:56:22 +02001168 newest entry, indicating that `g;` takes you to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001169 newest entry position. The first column indicates the
1170 count needed to take you to this position. Example:
1171
1172 change line col text ~
1173 3 9 8 bla bla bla
1174 2 11 57 foo is a bar
1175 1 14 54 the latest changed line
1176 >
1177
Bram Moolenaara9604e62018-07-21 05:56:22 +02001178 The `3g;` command takes you to line 9. Then the
1179 output of `:changes` is:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180
1181 change line col text ~
1182 > 0 9 8 bla bla bla
1183 1 11 57 foo is a bar
1184 2 14 54 the latest changed line
1185
1186 Now you can use "g," to go to line 11 and "2g," to go
1187 to line 14.
1188
1189==============================================================================
11909. Various motions *various-motions*
1191
1192 *%*
1193% Find the next item in this line after or under the
1194 cursor and jump to its match. |inclusive| motion.
1195 Items can be:
1196 ([{}]) parenthesis or (curly/square) brackets
1197 (this can be changed with the
1198 'matchpairs' option)
1199 /* */ start or end of C-style comment
1200 #if, #ifdef, #else, #elif, #endif
1201 C preprocessor conditionals (when the
1202 cursor is on the # or no ([{
Bram Moolenaardad44732021-03-31 20:07:33 +02001203 is following)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 For other items the matchit plugin can be used, see
Bram Moolenaar446cb832008-06-24 21:56:24 +00001205 |matchit-install|. This plugin also helps to skip
1206 matches in comments.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207
1208 When 'cpoptions' contains "M" |cpo-M| backslashes
1209 before parens and braces are ignored. Without "M" the
1210 number of backslashes matters: an even number doesn't
1211 match with an odd number. Thus in "( \) )" and "\( (
1212 \)" the first and last parenthesis match.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001213
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 When the '%' character is not present in 'cpoptions'
1215 |cpo-%|, parens and braces inside double quotes are
1216 ignored, unless the number of parens/braces in a line
1217 is uneven and this line and the previous one does not
1218 end in a backslash. '(', '{', '[', ']', '}' and ')'
1219 are also ignored (parens and braces inside single
1220 quotes). Note that this works fine for C, but not for
1221 Perl, where single quotes are used for strings.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001222
1223 Nothing special is done for matches in comments. You
1224 can either use the matchit plugin |matchit-install| or
1225 put quotes around matches.
1226
1227 No count is allowed, {count}% jumps to a line {count}
1228 percentage down the file |N%|. Using '%' on
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 #if/#else/#endif makes the movement linewise.
1230
1231 *[(*
Bram Moolenaardad44732021-03-31 20:07:33 +02001232[( Go to [count] previous unmatched '('.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001233 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 *[{*
Bram Moolenaardad44732021-03-31 20:07:33 +02001235[{ Go to [count] previous unmatched '{'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001236 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 *])*
Bram Moolenaardad44732021-03-31 20:07:33 +02001238]) Go to [count] next unmatched ')'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001239 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 *]}*
Bram Moolenaardad44732021-03-31 20:07:33 +02001241]} Go to [count] next unmatched '}'.
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001242 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
1244The above four commands can be used to go to the start or end of the current
1245code block. It is like doing "%" on the '(', ')', '{' or '}' at the other
1246end of the code block, but you can do this from anywhere in the code block.
1247Very useful for C programs. Example: When standing on "case x:", "[{" will
1248bring you back to the switch statement.
1249
1250 *]m*
1251]m Go to [count] next start of a method (for Java or
1252 similar structured language). When not before the
1253 start of a method, jump to the start or end of the
1254 class. When no '{' is found after the cursor, this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001255 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 *]M*
1257]M Go to [count] next end of a method (for Java or
1258 similar structured language). When not before the end
1259 of a method, jump to the start or end of the class.
1260 When no '}' is found after the cursor, this is an
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001261 error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 *[m*
1263[m Go to [count] previous start of a method (for Java or
1264 similar structured language). When not after the
1265 start of a method, jump to the start or end of the
1266 class. When no '{' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001267 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 *[M*
1269[M Go to [count] previous end of a method (for Java or
1270 similar structured language). When not after the
1271 end of a method, jump to the start or end of the
1272 class. When no '}' is found before the cursor this is
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001273 an error. |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274
Bram Moolenaardad44732021-03-31 20:07:33 +02001275The above four commands assume that the file contains a class with methods.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276The class definition is surrounded in '{' and '}'. Each method in the class
1277is also surrounded with '{' and '}'. This applies to the Java language. The
1278file looks like this: >
1279
1280 // comment
1281 class foo {
1282 int method_one() {
1283 body_one();
1284 }
1285 int method_two() {
1286 body_two();
1287 }
1288 }
Bram Moolenaardad44732021-03-31 20:07:33 +02001289
1290[To try this out copy the text and put it in a new buffer, the help text above
1291confuses the jump commands]
1292
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293Starting with the cursor on "body_two()", using "[m" will jump to the '{' at
1294the start of "method_two()" (obviously this is much more useful when the
1295method is long!). Using "2[m" will jump to the start of "method_one()".
1296Using "3[m" will jump to the start of the class.
1297
1298 *[#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001299[# Go to [count] previous unmatched "#if" or "#else".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001300 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301
1302 *]#*
Bram Moolenaardad44732021-03-31 20:07:33 +02001303]# Go to [count] next unmatched "#else" or "#endif".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001304 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001305
1306These two commands work in C programs that contain #if/#else/#endif
1307constructs. It brings you to the start or end of the #if/#else/#endif where
1308the current line is included. You can then use "%" to go to the matching line.
1309
1310 *[star* *[/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001311[* or [/ Go to [count] previous start of a C comment "/*".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001312 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313
1314 *]star* *]/*
Bram Moolenaardad44732021-03-31 20:07:33 +02001315]* or ]/ Go to [count] next end of a C comment "*/".
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001316 |exclusive| motion.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317
1318
1319 *H*
1320H To line [count] from top (Home) of window (default:
1321 first line on the window) on the first non-blank
1322 character |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001323 Cursor is adjusted for 'scrolloff' option, unless an
1324 operator is pending, in which case the text may
1325 scroll. E.g. "yH" yanks from the first visible line
1326 until the cursor line (inclusive).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327
1328 *M*
1329M To Middle line of window, on the first non-blank
1330 character |linewise|. See also 'startofline' option.
1331
1332 *L*
1333L To line [count] from bottom of window (default: Last
1334 line on the window) on the first non-blank character
1335 |linewise|. See also 'startofline' option.
Bram Moolenaar44cc4cf2017-10-15 22:13:37 +02001336 Cursor is adjusted for 'scrolloff' option, unless an
1337 operator is pending, in which case the text may
1338 scroll. E.g. "yL" yanks from the cursor to the last
1339 visible line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340
1341<LeftMouse> Moves to the position on the screen where the mouse
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001342 click is |exclusive|. See also |<LeftMouse>|. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 position is in a status line, that window is made the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001344 active window and the cursor is not moved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001346 vim:tw=78:ts=8:noet:ft=help:norl: