neovim

Neovim text editor
git clone https://git.dasho.dev/neovim.git
Log | Files | Refs | README

usr_03.txt (23585B)


      1 *usr_03.txt*	Nvim
      2 
      3 
      4 	     VIM USER MANUAL	by Bram Moolenaar
      5 
      6 
      7 		     Moving around
      8 
      9 
     10 Before you can insert or delete text the cursor has to be moved to the right
     11 place.  Vim has a large number of commands to position the cursor.  This
     12 chapter shows you how to use the most important ones.  You can find a list of
     13 these commands below |Q_lr|.
     14 
     15 |03.1|	Word movement
     16 |03.2|	Moving to the start or end of a line
     17 |03.3|	Moving to a character
     18 |03.4|	Matching a parenthesis
     19 |03.5|	Moving to a specific line
     20 |03.6|	Telling where you are
     21 |03.7|	Scrolling around
     22 |03.8|	Simple searches
     23 |03.9|	Simple search patterns
     24 |03.10|	Using marks
     25 
     26     Next chapter: |usr_04.txt|  Making small changes
     27 Previous chapter: |usr_02.txt|  The first steps in Vim
     28 Table of contents: |usr_toc.txt|
     29 
     30 ==============================================================================
     31 *03.1*	Word movement
     32 
     33 To move the cursor forward one word, use the "w" command.  Like most Vim
     34 commands, you can use a numeric prefix to move past multiple words.  For
     35 example, "3w" moves three words.  This figure shows how it works (starting at
     36 the position marked with "x"):
     37 
     38 This is a line with example text ~
     39   x-->-->->----------------->
     40    w  w  w    3w
     41 
     42 Notice that "w" moves to the start of the next word if it already is at the
     43 start of a word.
     44   The "b" command moves backward to the start of the previous word:
     45 
     46 This is a line with example text ~
     47 <----<--<-<---------<--x
     48    b   b b    2b      b
     49 
     50 There is also the "e" command that moves to the next end of a word and "ge",
     51 which moves to the previous end of a word:
     52 
     53 This is a line with example text ~
     54    <----<----x---->------------>
     55    2ge   ge     e       2e
     56 
     57 If you are at the last word of a line, the "w" command will take you to the
     58 first word in the next line.  Thus you can use this to move through a
     59 paragraph, much faster than using "l".  "b" does the same in the other
     60 direction.
     61 
     62 A word ends at a non-word character, such as a ".", "-" or ")".  To change
     63 what Vim considers to be a word, see the 'iskeyword' option.  If you try this
     64 out in the help directly, 'iskeyword' needs to be reset for the examples to
     65 work: >
     66 :set iskeyword&
     67 It is also possible to move by white-space separated WORDs.  This is not a
     68 word in the normal sense, that's why the uppercase is used.  The commands for
     69 moving by WORDs are also uppercase, as this figure shows:
     70 
     71        ge      b	  w				e
     72        <-     <-	 --->			       --->
     73 This is-a line, with special/separated/words (and some more). ~
     74    <----- <-----	 -------------------->	       ----->
     75      gE      B			 W			 E
     76 
     77 With this mix of lowercase and uppercase commands, you can quickly move
     78 forward and backward through a paragraph.
     79 
     80 ==============================================================================
     81 *03.2*	Moving to the start or end of a line
     82 
     83 The "$" command moves the cursor to the end of a line.  If your keyboard has
     84 an <End> key it will do the same thing.
     85 
     86 The "^" command moves to the first non-blank character of the line.  The "0"
     87 command (zero) moves to the very first character of the line, and the <Home>
     88 key does the same thing.  In a picture ("." indicates a space):
     89 
     90 	  ^
     91      <-----------x
     92 .....This is a line with example text ~
     93 <----------------x   x-------------->
     94 	0		   $
     95 
     96 (the "....." indicates blanks here)
     97 
     98   The "$" command takes a count, like most movement commands.  But moving to
     99 the end of the line several times doesn't make sense.  Therefore it causes the
    100 editor to move to the end of another line.  For example, "1$" moves you to
    101 the end of the first line (the one you're on), "2$" to the end of the next
    102 line, and so on.
    103   The "0" command doesn't take a count argument, because the "0" would be
    104 part of the count.  Unexpectedly, using a count with "^" doesn't have any
    105 effect.
    106 
    107 ==============================================================================
    108 *03.3*	Moving to a character
    109 
    110 One of the most useful movement commands is the single-character search
    111 command.  The command "fx" searches forward in the line for the single
    112 character x.  Hint: "f" stands for "Find".
    113   For example, you are at the beginning of the following line.  Suppose you
    114 want to go to the h of human.  Just execute the command "fh" and the cursor
    115 will be positioned over the h:
    116 
    117 To err is human.  To really foul up you need a computer. ~
    118 ---------->--------------->
    119     fh		 fy
    120 
    121 This also shows that the command "fy" moves to the end of the word really.
    122   You can specify a count; therefore, you can go to the "l" of "foul" with
    123 "3fl":
    124 
    125 To err is human.  To really foul up you need a computer. ~
    126 	  --------------------->
    127 		   3fl
    128 
    129 The "F" command searches to the left:
    130 
    131 To err is human.  To really foul up you need a computer. ~
    132 	  <---------------------
    133 		    Fh
    134 
    135 The "tx" command works like the "fx" command, except it stops one character
    136 before the searched character.  Hint: "t" stands for "To".  The backward
    137 version of this command is "Tx".
    138 
    139 To err is human.  To really foul up you need a computer. ~
    140 	   <------------  ------------->
    141 		Th		tn
    142 
    143 These four commands can be repeated with ";".  "," repeats in the other
    144 direction.  The cursor is never moved to another line.  Not even when the
    145 sentence continues.
    146 
    147 Sometimes you will start a search, only to realize that you have typed the
    148 wrong command.  You type "f" to search backward, for example, only to realize
    149 that you really meant "F".  To abort a search, press <Esc>.  So "f<Esc>" is an
    150 aborted forward search and doesn't do anything.  Note: <Esc> cancels most
    151 operations, not just searches.
    152 
    153 ==============================================================================
    154 *03.4*	Matching a parenthesis
    155 
    156 When writing a program you often end up with nested () constructs.  Then the
    157 "%" command is very handy: It moves to the matching paren.  If the cursor is
    158 on a "(" it will move to the matching ")".  If it's on a ")" it will move to
    159 the matching "(".
    160 
    161 		    %
    162 		 <----->
    163 	if (a == (b * c) / d) ~
    164 	   <---------------->
    165 		    %
    166 
    167 This also works for [] and {} pairs.  (This can be defined with the
    168 'matchpairs' option.)
    169 
    170 When the cursor is not on a useful character, "%" will search forward to find
    171 one.  Thus if the cursor is at the start of the line of the previous example,
    172 "%" will search forward and find the first "(".  Then it moves to its match:
    173 
    174 	if (a == (b * c) / d) ~
    175 	---+---------------->
    176 		   %
    177 
    178 Other ways to move around code can be found in |usr_29.txt|.
    179 
    180 ==============================================================================
    181 *03.5*	Moving to a specific line
    182 
    183 If you are a C or C++ programmer, you are familiar with error messages such as
    184 the following:
    185 
    186 prog.c:33: j   undeclared (first use in this function) ~
    187 
    188 This tells you that you might want to fix something on line 33.  So how do you
    189 find line 33?  One way is to do "9999k" to go to the top of the file and "32j"
    190 to go down thirty-two lines.  It is not a good way, but it works.  A much
    191 better way of doing things is to use the "G" command.  With a count, this
    192 command positions you at the given line number.  For example, "33G" puts you
    193 on line 33.  (For a better way of going through a compiler's error list, see
    194 |usr_30.txt|, for information on the :make command.)
    195   With no argument, "G" positions you at the end of the file.  A quick way to
    196 go to the start of a file use "gg".  "1G" will do the same, but is a tiny bit
    197 more typing.
    198 
    199     |	first line of a file   ^
    200     |	text text text text    |
    201     |	text text text text    |  gg
    202 7G  |	text text text text    |
    203     |	text text text text
    204     |	text text text text
    205     V	text text text text    |
    206 	text text text text    |  G
    207 	text text text text    |
    208 	last line of a file    V
    209 
    210 Another way to move to a line is using the "%" command with a count.  For
    211 example, "50%" moves you halfway through the file, and "90%" goes to near the
    212 end.
    213 
    214 The previous assumes that you want to move to a line in the file, no matter if
    215 it's currently visible or not.  What if you want to move to one of the lines
    216 you can see?  This figure shows the three commands you can use:
    217 
    218 		+---------------------------+
    219 	H -->	| text sample text	    |
    220 		| sample text		    |
    221 		| text sample text	    |
    222 		| sample text		    |
    223 	M -->	| text sample text	    |
    224 		| sample text		    |
    225 		| text sample text	    |
    226 		| sample text		    |
    227 	L -->	| text sample text	    |
    228 		+---------------------------+
    229 
    230 Hints: "H" stands for Home, "M" for Middle and "L" for Last.  Alternatively,
    231 "H" for High, "M" for Middle and "L" for Low.
    232 
    233 ==============================================================================
    234 *03.6*	Telling where you are
    235 
    236 To see where you are in a file, there are three ways:
    237 
    238 1.  Use the CTRL-G command.  You get a message like this (assuming the 'ruler'
    239    option is off):
    240 
    241 "usr_03.txt" line 233 of 650 --35%-- col 45-52 ~
    242 
    243    This shows the name of the file you are editing, the line number where the
    244    cursor is, the total number of lines, the percentage of the way through
    245    the file and the column of the cursor.
    246       Sometimes you will see a split column number.  For example, "col 2-9".
    247    This indicates that the cursor is positioned on the second character, but
    248    because character one is a tab, occupying eight spaces worth of columns,
    249    the screen column is 9.
    250 
    251 2.  Set the 'number' option.  This will display a line number in front of
    252    every line: >
    253 
    254 :set number
    255 <
    256    To switch this off again: >
    257 
    258 :set nonumber
    259 <
    260    Since 'number' is a boolean option, prepending "no" to its name has the
    261    effect of switching it off.  A boolean option has only these two values,
    262    it is either on or off.
    263       Vim has many options.  Besides the boolean ones there are options with
    264    a numerical value and string options.  You will see examples of this where
    265    they are used.
    266 
    267 3.  Set the 'ruler' option.  This will display the cursor position in the
    268    lower right corner of the Vim window: >
    269 
    270 :set ruler
    271 
    272 Using the 'ruler' option has the advantage that it doesn't take much room,
    273 thus there is more space for your text.
    274 
    275 ==============================================================================
    276 *03.7*	Scrolling around
    277 
    278 The CTRL-U command scrolls down half a screen of text.  Think of looking
    279 through a viewing window at the text and moving this window up by half the
    280 height of the window.  Thus the window moves up over the text, which is
    281 backward in the file.  Don't worry if you have a little trouble remembering
    282 which end is up.  Most users have the same problem.
    283   The CTRL-D command moves the viewing window down half a screen in the file,
    284 thus scrolls the text up half a screen.
    285 
    286 			       +----------------+
    287 			       | some text	|
    288 			       | some text	|
    289 			       | some text	|
    290 +---------------+	       | some text	|
    291 | some text	|  CTRL-U  --> |		|
    292 |		|	       | 123456		|
    293 | 123456	|	       +----------------+
    294 | 7890		|
    295 |		|	       +----------------+
    296 | example	|  CTRL-D -->  | 7890		|
    297 +---------------+	       |		|
    298 			       | example	|
    299 			       | example	|
    300 			       | example	|
    301 			       | example	|
    302 			       +----------------+
    303 
    304 To scroll one line at a time use CTRL-E (scroll up) and CTRL-Y (scroll down).
    305 Think of CTRL-E to give you one line Extra.  (If you use MS-Windows compatible
    306 key mappings CTRL-Y will redo a change instead of scroll.)
    307 
    308 To scroll forward by a whole screen (except for two lines) use CTRL-F.  To
    309 scroll backwards, use CTRL-B.  These should be easy to remember: F for
    310 Forwards and B for Backwards.
    311 
    312 A common issue is that after moving down many lines with "j" your cursor is at
    313 the bottom of the screen.  You would like to see the context of the line with
    314 the cursor.  That's done with the "zz" command.
    315 
    316 +------------------+		 +------------------+
    317 | earlier text	   |		 | earlier text	    |
    318 | earlier text	   |		 | earlier text	    |
    319 | earlier text	   |		 | earlier text	    |
    320 | earlier text	   |   zz  -->	 | line with cursor |
    321 | earlier text	   |		 | later text	    |
    322 | earlier text	   |		 | later text	    |
    323 | line with cursor |		 | later text	    |
    324 +------------------+		 +------------------+
    325 
    326 The "zt" command puts the cursor line at the top, "zb" at the bottom.  There
    327 are a few more scrolling commands, see |Q_sc|.  To always keep a few lines of
    328 context around the cursor, use the 'scrolloff' option.
    329 
    330 ==============================================================================
    331 *03.8*	Simple searches
    332 
    333 To search for a string, use the "/string" command.  To find the word include,
    334 for example, use the command: >
    335 
    336 /include
    337 
    338 You will notice that when you type the "/" the cursor jumps to the last line
    339 of the Vim window, like with colon commands.  That is where you type the word.
    340 You can press the backspace key (backarrow or <BS>) to make corrections.  Use
    341 the <Left> and <Right> cursor keys when necessary.
    342   Pressing <Enter> executes the command.
    343 
    344 Note:
    345 The characters `.*[]^%/\?~$` have special meanings.  If you want to use
    346 them in a search you must put a \ in front of them.  See below.
    347 
    348 To find the next occurrence of the same string use the "n" command.  Use this
    349 to find the first #include after the cursor: >
    350 
    351 /#include
    352 
    353 And then type "n" several times.  You will move to each #include in the text.
    354 You can also use a count if you know which match you want.  Thus "3n" finds
    355 the third match.  You can also use a count with "/": "4/the" goes to the
    356 fourth match of "the".
    357 
    358 The "?" command works like "/" but searches backwards: >
    359 
    360 ?word
    361 
    362 The "N" command repeats the last search the opposite direction.  Thus using
    363 "N" after a "/" command searches backwards, using "N" after "?" searches
    364 forwards.
    365 
    366 
    367 IGNORING CASE
    368 
    369 Normally you have to type exactly what you want to find.  If you don't care
    370 about upper or lowercase in a word, set the 'ignorecase' option: >
    371 
    372 :set ignorecase
    373 
    374 If you now search for "word", it will also match "Word" and "WORD".  To match
    375 case again: >
    376 
    377 :set noignorecase
    378 
    379 
    380 HISTORY
    381 
    382 Suppose you do three searches: >
    383 
    384 /one
    385 /two
    386 /three
    387 
    388 Now let's start searching by typing a simple "/" without pressing <Enter>.  If
    389 you press <Up> (the cursor key), Vim puts "/three" on the command line.
    390 Pressing <Enter> at this point searches for three.  If you do not press
    391 <Enter>, but press <Up> instead, Vim changes the prompt to "/two".  Another
    392 press of <Up> moves you to "/one".
    393   You can also use the <Down> cursor key to move through the history of
    394 search commands in the other direction.
    395 
    396 If you know what a previously used pattern starts with, and you want to use it
    397 again, type that character before pressing <Up>.  With the previous example,
    398 you can type "/o<Up>" and Vim will put "/one" on the command line.
    399 
    400 The commands starting with ":" also have a history.  That allows you to recall
    401 a previous command and execute it again.  These two histories are separate.
    402 
    403 
    404 SEARCHING FOR A WORD IN THE TEXT
    405 
    406 Suppose you see the word "TheLongFunctionName" in the text and you want to
    407 find the next occurrence of it.  You could type "/TheLongFunctionName", but
    408 that's a lot of typing.  And when you make a mistake Vim won't find it.
    409   There is an easier way: Position the cursor on the word and use the "*"
    410 command.  Vim will grab the word under the cursor and use it as the search
    411 string.
    412   The "#" command does the same in the other direction.  You can prepend a
    413 count: "3*" searches for the third occurrence of the word under the cursor.
    414 
    415 
    416 SEARCHING FOR WHOLE WORDS
    417 
    418 If you type "/the" it will also match "there".  To only find words that end
    419 in "the" use: >
    420 
    421 /the\>
    422 
    423 The "\>" item is a special marker that only matches at the end of a word.
    424 Similarly "\<" only matches at the beginning of a word.  Thus to search for
    425 the word "the" only: >
    426 
    427 /\<the\>
    428 
    429 This does not match "there" or "soothe".  Notice that the "*" and "#" commands
    430 use these start-of-word and end-of-word markers to only find whole words (you
    431 can use "g*" and "g#" to match partial words).
    432 
    433 
    434 HIGHLIGHTING MATCHES
    435 
    436 While editing a program you see a variable called "nr".  You want to check
    437 where it's used.  You could move the cursor to "nr" and use the "*" command
    438 and press "n" to go along all the matches.
    439 
    440 Vim will highlight all matches. That is a very good way to see where the
    441 variable is used, without the need to type commands.
    442   To switch this off: >
    443 
    444 :set nohlsearch
    445 
    446 Then you need to switch it on again if you want to use it for the next search
    447 command: >
    448 
    449 :set hlsearch
    450 
    451 If you only want to remove the highlighting, use this command: >
    452 
    453 :nohlsearch
    454 
    455 This doesn't reset the option.  Instead, it disables the highlighting.  As
    456 soon as you execute a search command, the highlighting will be used again.
    457 Also for the "n" and "N" commands.
    458 
    459 
    460 TUNING SEARCHES
    461 
    462 There are a few options that change how searching works.  These are the
    463 essential ones:
    464 >
    465 :set nowrapscan
    466 
    467 This stops the search at the end of the file.  Or, when you are searching
    468 backwards, it stops the search at the start of the file.  The 'wrapscan'
    469 option is on by default, thus searching wraps around the end of the file.
    470 >
    471 :set noincsearch
    472 
    473 This disables the display of the matches while you are still typing your
    474 search.
    475 
    476 
    477 INTERMEZZO
    478 
    479 If you like one of the options mentioned before, and set it each time you use
    480 Vim, you can put the command in your Vim startup file.  Edit the file, for
    481 example with: >
    482 
    483 :edit ~/.config/nvim/init.vim
    484 
    485 Then add a line with the command to set the option, just like you typed it in
    486 Vim.  Example: >
    487 
    488 Go:set hlsearch<Esc>
    489 
    490 "G" moves to the end of the file.  "o" starts a new line, where you type the
    491 ":set" command.  You end insert mode with <Esc>.  Then write and close the
    492 file: >
    493 
    494 ZZ
    495 
    496 If you now start Vim again, the 'hlsearch' option will already be set.
    497 
    498 ==============================================================================
    499 *03.9*	Simple search patterns
    500 
    501 The Vim editor uses regular expressions to specify what to search for.
    502 Regular expressions are an extremely powerful and compact way to specify a
    503 search pattern.  Unfortunately, this power comes at a price, because regular
    504 expressions are a bit tricky to specify.
    505   In this section we mention only a few essential ones.  More about search
    506 patterns and commands can be found in chapter 27 |usr_27.txt|.  You can find
    507 the full explanation here: |pattern|.
    508 
    509 
    510 BEGINNING AND END OF A LINE
    511 
    512 The ^ character matches the beginning of a line.  On an English-US keyboard
    513 you find it above the 6.  The pattern "include" matches the word include
    514 anywhere on the line.  But the pattern "^include" matches the word include
    515 only if it is at the beginning of a line.
    516   The $ character matches the end of a line.  Therefore, "was$" matches the
    517 word was only if it is at the end of a line.
    518 
    519 Let's mark the places where "/the" matches in this example line with "x"s:
    520 
    521 the solder holding one of the chips melted and the ~
    522 xxx			  xxx		       xxx
    523 
    524 Using "/the$" we find this match:
    525 
    526 the solder holding one of the chips melted and the ~
    527 					       xxx
    528 
    529 And with "/^the" we find this one:
    530 the solder holding one of the chips melted and the ~
    531 xxx
    532 
    533 You can try searching with "/^the$"; it will only match a single line
    534 consisting entirely of "the".  White space does matter here, thus if a line
    535 contains a space after the word, like "the ", the pattern will not match.
    536 
    537 
    538 MATCHING ANY SINGLE CHARACTER
    539 
    540 The . (dot) character matches any existing character.  For example, the
    541 pattern "c.m" matches a string whose first character is a c, whose second
    542 character is anything, and whose third character is m.  Example:
    543 
    544 We use a computer that became the cummin winter. ~
    545 	 xxx		 xxx	  xxx
    546 
    547 
    548 MATCHING SPECIAL CHARACTERS
    549 
    550 If you really want to match a dot, you must avoid its special meaning by
    551 putting a backslash before it.
    552   If you search for "ter.", you will find these matches:
    553 
    554 We use a computer that became the cummin winter. ~
    555 	      xxxx			    xxxx
    556 
    557 Searching for "ter\." only finds the second match.
    558 
    559 ==============================================================================
    560 *03.10*	Using marks
    561 
    562 When you make a jump to a position with the "G" command, Vim remembers the
    563 position from before this jump.  This position is called a mark.  To go back
    564 where you came from, use this command: >
    565 
    566 ``
    567 
    568 This ` is a backtick or open single-quote character.
    569   If you use the same command a second time you will jump back again.  That's
    570 because the "`" command is a jump itself, and the position from before this
    571 jump is remembered.
    572 
    573 Generally, every time you do a command that can move the cursor further than
    574 within the same line, this is called a jump.  This includes the search
    575 commands "/" and "n" (it doesn't matter how far away the match is).  But not
    576 the character searches with "fx" and "tx" or the word movements "w" and "e".
    577   Also, "j" and "k" are not considered to be a jump, even when you use a
    578 count to make them move the cursor quite a long way away.
    579 
    580 The "``" command jumps back and forth, between two points.  The CTRL-O command
    581 jumps to older positions (Hint: O for older).  CTRL-I then jumps back to newer
    582 positions (Hint: for many common keyboard layouts, I is just next to O).
    583 Consider this sequence of commands: >
    584 
    585 33G
    586 /^The
    587 CTRL-O
    588 
    589 You first jump to line 33, then search for a line that starts with "The".
    590 Then with CTRL-O you jump back to line 33.  Another CTRL-O takes you back to
    591 where you started.  If you now use CTRL-I you jump to line 33 again.  And
    592 to the match for "The" with another CTRL-I.
    593 
    594 
    595      |	example text   ^	     |
    596 33G  |	example text   |  CTRL-O     | CTRL-I
    597      |	example text   |	     |
    598      V	line 33 text   ^	     V
    599      |	example text   |	     |
    600       /^The |	example text   |  CTRL-O     | CTRL-I
    601      V	There you are  |	     V
    602 	example text
    603 
    604 Note:
    605 CTRL-I is the same as <Tab>.
    606 
    607 The ":jumps" command gives a list of positions you jumped to.  The entry which
    608 you used last is marked with a ">".
    609 
    610 
    611 NAMED MARKS							*bookmark*
    612 
    613 Vim enables you to place your own marks in the text.  The command "ma" marks
    614 the place under the cursor as mark a.  You can place 26 marks (a through z) in
    615 your text.  You can't see them, it's just a position that Vim remembers.
    616   To go to a mark, use the command `{mark}, where {mark} is the mark letter.
    617 Thus to move to the a mark:
    618 >
    619 `a
    620 
    621 The command "'mark" (single quotation mark, or apostrophe) moves you to the
    622 beginning of the line containing the mark.  This differs from the "`mark"
    623 command, which also moves you to the marked column.
    624 
    625 The marks can be very useful when working on two related parts in a file.
    626 Suppose you have some text near the start of the file you need to look at,
    627 while working on some text near the end of the file.
    628   Move to the text at the start and place the s (start) mark there: >
    629 
    630 ms
    631 
    632 Then move to the text you want to work on and put the e (end) mark there: >
    633 
    634 me
    635 
    636 Now you can move around, and when you want to look at the start of the file,
    637 you use this to jump there: >
    638 
    639 's
    640 
    641 Then you can use '' to jump back to where you were, or 'e to jump to the text
    642 you were working on at the end.
    643   There is nothing special about using s for start and e for end, they are
    644 just easy to remember.
    645 
    646 You can use this command to get a list of marks: >
    647 
    648 :marks
    649 
    650 You will notice a few special marks.  These include:
    651 
    652 '	The cursor position before doing a jump
    653 "	The cursor position when last editing the file
    654 [	Start of the last change
    655 ]	End of the last change
    656 
    657 ==============================================================================
    658 
    659 Next chapter: |usr_04.txt|  Making small changes
    660 
    661 Copyright: see |manual-copyright|  vim:tw=78:ts=8:noet:ft=help:norl: