Hirohito Higashi | 26ebe21 | 2025-06-26 20:31:24 +0200 | [diff] [blame] | 1 | *change.txt* For Vim version 9.1. Last change: 2025 Jun 26 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
| 3 | |
| 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
| 5 | |
| 6 | |
| 7 | This file describes commands that delete or change text. In this context, |
| 8 | changing text means deleting the text and replacing it with other text using |
| 9 | one command. You can undo all of these commands. You can repeat the non-Ex |
| 10 | commands with the "." command. |
| 11 | |
| 12 | 1. Deleting text |deleting| |
| 13 | 2. Delete and insert |delete-insert| |
| 14 | 3. Simple changes |simple-change| *changing* |
| 15 | 4. Complex changes |complex-change| |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 16 | 4.1 Filter commands |filter| |
| 17 | 4.2 Substitute |:substitute| |
| 18 | 4.3 Search and replace |search-replace| |
| 19 | 4.4 Changing tabs |change-tabs| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 20 | 5. Copying and moving text |copy-move| |
| 21 | 6. Formatting text |formatting| |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 22 | 7. Sorting text |sorting| |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 23 | 8. Deduplicating text |deduplicating| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 24 | |
| 25 | For inserting text see |insert.txt|. |
| 26 | |
| 27 | ============================================================================== |
| 28 | 1. Deleting text *deleting* *E470* |
| 29 | |
| 30 | ["x]<Del> or *<Del>* *x* *dl* |
| 31 | ["x]x Delete [count] characters under and after the cursor |
| 32 | [into register x] (not |linewise|). Does the same as |
| 33 | "dl". |
| 34 | The <Del> key does not take a [count]. Instead, it |
| 35 | deletes the last character of the count. |
| 36 | See |:fixdel| if the <Del> key does not do what you |
| 37 | want. See |'whichwrap'| for deleting a line break |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 38 | (join lines). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 39 | |
| 40 | *X* *dh* |
| 41 | ["x]X Delete [count] characters before the cursor [into |
| 42 | register x] (not |linewise|). Does the same as "dh". |
| 43 | Also see |'whichwrap'|. |
| 44 | |
| 45 | *d* |
| 46 | ["x]d{motion} Delete text that {motion} moves over [into register |
| 47 | x]. See below for exceptions. |
| 48 | |
| 49 | *dd* |
| 50 | ["x]dd Delete [count] lines [into register x] |linewise|. |
| 51 | |
| 52 | *D* |
| 53 | ["x]D Delete the characters under the cursor until the end |
| 54 | of the line and [count]-1 more lines [into register |
| 55 | x]; synonym for "d$". |
| 56 | (not |linewise|) |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 57 | When the '#' flag is in 'cpoptions' the count is |
| 58 | ignored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 59 | |
| 60 | {Visual}["x]x or *v_x* *v_d* *v_<Del>* |
| 61 | {Visual}["x]d or |
| 62 | {Visual}["x]<Del> Delete the highlighted text [into register x] (for |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 63 | {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 64 | |
| 65 | {Visual}["x]CTRL-H or *v_CTRL-H* *v_<BS>* |
| 66 | {Visual}["x]<BS> When in Select mode: Delete the highlighted text [into |
| 67 | register x]. |
| 68 | |
| 69 | {Visual}["x]X or *v_X* *v_D* *v_b_D* |
| 70 | {Visual}["x]D Delete the highlighted lines [into register x] (for |
| 71 | {Visual} see |Visual-mode|). In Visual block mode, |
| 72 | "D" deletes the highlighted text plus all text until |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 73 | the end of the line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 74 | |
Bram Moolenaar | 9ba7e17 | 2013-07-17 22:37:26 +0200 | [diff] [blame] | 75 | *:d* *:de* *:del* *:delete* *:dl* *:dp* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 76 | :[range]d[elete] [x] Delete [range] lines (default: current line) [into |
| 77 | register x]. |
Bram Moolenaar | 9ba7e17 | 2013-07-17 22:37:26 +0200 | [diff] [blame] | 78 | Note these weird abbreviations: |
| 79 | :dl delete and list |
| 80 | :dell idem |
| 81 | :delel idem |
| 82 | :deletl idem |
| 83 | :deletel idem |
| 84 | :dp delete and print |
| 85 | :dep idem |
| 86 | :delp idem |
| 87 | :delep idem |
| 88 | :deletp idem |
| 89 | :deletep idem |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 90 | |
| 91 | :[range]d[elete] [x] {count} |
| 92 | Delete {count} lines, starting with [range] |
| 93 | (default: current line |cmdline-ranges|) [into |
| 94 | register x]. |
| 95 | |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 96 | These commands delete text. You can repeat them with the `.` command |
| 97 | (except `:d`) and undo them. Use Visual mode to delete blocks of text. See |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 98 | |registers| for an explanation of registers. |
Christian Brabandt | 22105fd | 2024-07-15 20:51:11 +0200 | [diff] [blame] | 99 | *d-special* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 100 | An exception for the d{motion} command: If the motion is not linewise, the |
| 101 | start and end of the motion are not in the same line, and there are only |
Bram Moolenaar | 38a5563 | 2016-02-15 22:07:32 +0100 | [diff] [blame] | 102 | blanks before the start and there are no non-blanks after the end of the |
| 103 | motion, the delete becomes linewise. This means that the delete also removes |
| 104 | the line of blanks that you might expect to remain. Use the |o_v| operator to |
Christian Brabandt | 22105fd | 2024-07-15 20:51:11 +0200 | [diff] [blame] | 105 | force the motion to be characterwise or remove the "z" flag from 'cpoptions' |
| 106 | (see |cpo-z|) to disable this peculiarity. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 107 | |
| 108 | Trying to delete an empty region of text (e.g., "d0" in the first column) |
| 109 | is an error when 'cpoptions' includes the 'E' flag. |
| 110 | |
| 111 | *J* |
| 112 | J Join [count] lines, with a minimum of two lines. |
| 113 | Remove the indent and insert up to two spaces (see |
Bram Moolenaar | 77cdfd1 | 2016-03-12 12:57:59 +0100 | [diff] [blame] | 114 | below). Fails when on the last line of the buffer. |
Bram Moolenaar | 85eee13 | 2018-05-06 17:57:30 +0200 | [diff] [blame] | 115 | If [count] is too big it is reduced to the number of |
Bram Moolenaar | 77cdfd1 | 2016-03-12 12:57:59 +0100 | [diff] [blame] | 116 | lines available. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 117 | |
| 118 | *v_J* |
| 119 | {Visual}J Join the highlighted lines, with a minimum of two |
| 120 | lines. Remove the indent and insert up to two spaces |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 121 | (see below). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 122 | |
| 123 | *gJ* |
| 124 | gJ Join [count] lines, with a minimum of two lines. |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 125 | Don't insert or remove any spaces. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 126 | |
| 127 | *v_gJ* |
| 128 | {Visual}gJ Join the highlighted lines, with a minimum of two |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 129 | lines. Don't insert or remove any spaces. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 130 | |
| 131 | *:j* *:join* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 132 | :[range]j[oin][!] [flags] |
| 133 | Join [range] lines. Same as "J", except with [!] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 134 | the join does not insert or delete any spaces. |
| 135 | If a [range] has equal start and end values, this |
| 136 | command does nothing. The default behavior is to |
| 137 | join the current line with the line below it. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 138 | See |ex-flags| for [flags]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 139 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 140 | :[range]j[oin][!] {count} [flags] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 141 | Join {count} lines, starting with [range] (default: |
| 142 | current line |cmdline-ranges|). Same as "J", except |
| 143 | with [!] the join does not insert or delete any |
| 144 | spaces. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 145 | See |ex-flags| for [flags]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 146 | |
| 147 | These commands delete the <EOL> between lines. This has the effect of joining |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 148 | multiple lines into one line. You can repeat these commands (except `:j`) and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 149 | undo them. |
| 150 | |
| 151 | These commands, except "gJ", insert one space in place of the <EOL> unless |
| 152 | there is trailing white space or the next line starts with a ')'. These |
| 153 | commands, except "gJ", delete any leading white space on the next line. If |
| 154 | the 'joinspaces' option is on, these commands insert two spaces after a '.', |
| 155 | '!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces |
| 156 | only after a '.'). |
| 157 | The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 158 | spaces before and after a multibyte character |fo-table|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 159 | |
Christian Brabandt | df68419 | 2025-04-03 12:33:02 +0200 | [diff] [blame] | 160 | The |'[| mark is set at the end of the first line that was joined, |']| at the |
| 161 | end of the resulting line. |
Bram Moolenaar | 251835e | 2014-02-24 02:51:51 +0100 | [diff] [blame] | 162 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 163 | |
| 164 | ============================================================================== |
| 165 | 2. Delete and insert *delete-insert* *replacing* |
| 166 | |
| 167 | *R* |
| 168 | R Enter Replace mode: Each character you type replaces |
| 169 | an existing character, starting with the character |
| 170 | under the cursor. Repeat the entered text [count]-1 |
| 171 | times. See |Replace-mode| for more details. |
| 172 | |
| 173 | *gR* |
| 174 | gR Enter Virtual Replace mode: Each character you type |
| 175 | replaces existing characters in screen space. So a |
| 176 | <Tab> may replace several characters at once. |
| 177 | Repeat the entered text [count]-1 times. See |
| 178 | |Virtual-Replace-mode| for more details. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 179 | |
| 180 | *c* |
| 181 | ["x]c{motion} Delete {motion} text [into register x] and start |
| 182 | insert. When 'cpoptions' includes the 'E' flag and |
| 183 | there is no text to delete (e.g., with "cTx" when the |
| 184 | cursor is just after an 'x'), an error occurs and |
| 185 | insert mode does not start (this is Vi compatible). |
| 186 | When 'cpoptions' does not include the 'E' flag, the |
| 187 | "c" command always starts insert mode, even if there |
| 188 | is no text to delete. |
| 189 | |
| 190 | *cc* |
| 191 | ["x]cc Delete [count] lines [into register x] and start |
| 192 | insert |linewise|. If 'autoindent' is on, preserve |
| 193 | the indent of the first line. |
| 194 | |
| 195 | *C* |
| 196 | ["x]C Delete from the cursor position to the end of the |
| 197 | line and [count]-1 more lines [into register x], and |
| 198 | start insert. Synonym for c$ (not |linewise|). |
| 199 | |
| 200 | *s* |
| 201 | ["x]s Delete [count] characters [into register x] and start |
| 202 | insert (s stands for Substitute). Synonym for "cl" |
| 203 | (not |linewise|). |
| 204 | |
| 205 | *S* |
| 206 | ["x]S Delete [count] lines [into register x] and start |
| 207 | insert. Synonym for "cc" |linewise|. |
| 208 | |
| 209 | {Visual}["x]c or *v_c* *v_s* |
| 210 | {Visual}["x]s Delete the highlighted text [into register x] and |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 211 | start insert (for {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 212 | |
| 213 | *v_r* |
Bram Moolenaar | 2c7f8c5 | 2020-04-20 19:52:53 +0200 | [diff] [blame] | 214 | {Visual}r{char} Replace all selected characters by {char}. |
Christian Brabandt | 476733f | 2023-09-19 20:41:51 +0200 | [diff] [blame] | 215 | CTRL-C will be inserted literally. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 216 | |
| 217 | *v_C* |
| 218 | {Visual}["x]C Delete the highlighted lines [into register x] and |
| 219 | start insert. In Visual block mode it works |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 220 | differently |v_b_C|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 221 | *v_S* |
| 222 | {Visual}["x]S Delete the highlighted lines [into register x] and |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 223 | start insert (for {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 224 | *v_R* |
| 225 | {Visual}["x]R Currently just like {Visual}["x]S. In a next version |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 226 | it might work differently. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 227 | |
| 228 | Notes: |
| 229 | - You can end Insert and Replace mode with <Esc>. |
| 230 | - See the section "Insert and Replace mode" |mode-ins-repl| for the other |
| 231 | special characters in these modes. |
| 232 | - The effect of [count] takes place after Vim exits Insert or Replace mode. |
| 233 | - When the 'cpoptions' option contains '$' and the change is within one line, |
| 234 | Vim continues to show the text to be deleted and puts a '$' at the last |
| 235 | deleted character. |
| 236 | |
| 237 | See |registers| for an explanation of registers. |
| 238 | |
| 239 | Replace mode is just like Insert mode, except that every character you enter |
| 240 | deletes one character. If you reach the end of a line, Vim appends any |
| 241 | further characters (just like Insert mode). In Replace mode, the backspace |
| 242 | key restores the original text (if there was any). (See section "Insert and |
| 243 | Replace mode" |mode-ins-repl|). |
| 244 | |
| 245 | *cw* *cW* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 246 | Special case: When the cursor is in a word, "cw" and "cW" do not include the |
| 247 | white space after a word, they only change up to the end of the word. This is |
| 248 | because Vim interprets "cw" as change-word, and a word does not include the |
| 249 | following white space. |
| 250 | {Vi: "cw" when on a blank followed by other blanks changes only the first |
| 251 | blank; this is probably a bug, because "dw" deletes all the blanks; use the |
| 252 | 'w' flag in 'cpoptions' to make it work like Vi anyway} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 253 | |
| 254 | If you prefer "cw" to include the space after a word, use this mapping: > |
| 255 | :map cw dwi |
Christian Brabandt | 22105fd | 2024-07-15 20:51:11 +0200 | [diff] [blame] | 256 | Alternatively use "caw" (see also |aw| and |cpo-z|). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 257 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 258 | *:c* *:ch* *:change* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 259 | :{range}c[hange][!] Replace lines of text with some different text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 260 | Type a line containing only "." to stop replacing. |
| 261 | Without {range}, this command changes only the current |
| 262 | line. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 263 | Adding [!] toggles 'autoindent' for the time this |
| 264 | command is executed. |
Bram Moolenaar | a4d131d | 2021-12-27 21:33:07 +0000 | [diff] [blame] | 265 | This command is not supported in |Vim9| script, |
| 266 | because it is too easily confused with a variable |
| 267 | name. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 268 | |
| 269 | ============================================================================== |
| 270 | 3. Simple changes *simple-change* |
| 271 | |
| 272 | *r* |
| 273 | r{char} Replace the character under the cursor with {char}. |
| 274 | If {char} is a <CR> or <NL>, a line break replaces the |
| 275 | character. To replace with a real <CR>, use CTRL-V |
| 276 | <CR>. CTRL-V <NL> replaces with a <Nul>. |
Bram Moolenaar | 8071607 | 2012-05-01 21:14:34 +0200 | [diff] [blame] | 277 | |
| 278 | If {char} is CTRL-E or CTRL-Y the character from the |
| 279 | line below or above is used, just like with |i_CTRL-E| |
| 280 | and |i_CTRL-Y|. This also works with a count, thus |
| 281 | `10r<C-E>` copies 10 characters from the line below. |
| 282 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 283 | If you give a [count], Vim replaces [count] characters |
| 284 | with [count] {char}s. When {char} is a <CR> or <NL>, |
| 285 | however, Vim inserts only one <CR>: "5r<CR>" replaces |
| 286 | five characters with a single line break. |
| 287 | When {char} is a <CR> or <NL>, Vim performs |
| 288 | autoindenting. This works just like deleting the |
| 289 | characters that are replaced and then doing |
| 290 | "i<CR><Esc>". |
| 291 | {char} can be entered as a digraph |digraph-arg|. |
| 292 | |:lmap| mappings apply to {char}. The CTRL-^ command |
| 293 | in Insert mode can be used to switch this on/off |
| 294 | |i_CTRL-^|. See |utf-8-char-arg| about using |
| 295 | composing characters when 'encoding' is Unicode. |
| 296 | |
| 297 | *gr* |
| 298 | gr{char} Replace the virtual characters under the cursor with |
| 299 | {char}. This replaces in screen space, not file |
| 300 | space. See |gR| and |Virtual-Replace-mode| for more |
| 301 | details. As with |r| a count may be given. |
Bram Moolenaar | dd60c36 | 2023-02-27 15:49:53 +0000 | [diff] [blame] | 302 | {char} can be entered like with |r|, but characters |
| 303 | that have a special meaning in Insert mode, such as |
| 304 | most CTRL-keys, cannot be used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 305 | |
| 306 | *digraph-arg* |
| 307 | The argument for Normal mode commands like |r| and |t| is a single character. |
| 308 | When 'cpo' doesn't contain the 'D' flag, this character can also be entered |
| 309 | like |digraphs|. First type CTRL-K and then the two digraph characters. |
| 310 | {not available when compiled without the |+digraphs| feature} |
| 311 | |
| 312 | *case* |
| 313 | The following commands change the case of letters. The currently active |
| 314 | |locale| is used. See |:language|. The LC_CTYPE value matters here. |
| 315 | |
| 316 | *~* |
| 317 | ~ 'notildeop' option: Switch case of the character |
| 318 | under the cursor and move the cursor to the right. |
Bram Moolenaar | a6c27c4 | 2019-05-09 19:16:22 +0200 | [diff] [blame] | 319 | If a [count] is given, do that many characters. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 320 | |
Bram Moolenaar | a6c27c4 | 2019-05-09 19:16:22 +0200 | [diff] [blame] | 321 | ~{motion} 'tildeop' option: switch case of {motion} text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 322 | |
| 323 | *g~* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 324 | g~{motion} Switch case of {motion} text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 325 | |
| 326 | g~g~ *g~g~* *g~~* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 327 | g~~ Switch case of current line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 328 | |
| 329 | *v_~* |
| 330 | {Visual}~ Switch case of highlighted text (for {Visual} see |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 331 | |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 332 | |
| 333 | *v_U* |
| 334 | {Visual}U Make highlighted text uppercase (for {Visual} see |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 335 | |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 336 | |
| 337 | *gU* *uppercase* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 338 | gU{motion} Make {motion} text uppercase. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 339 | Example: > |
| 340 | :map! <C-F> <Esc>gUiw`]a |
| 341 | < This works in Insert mode: press CTRL-F to make the |
| 342 | word before the cursor uppercase. Handy to type |
| 343 | words in lowercase and then make them uppercase. |
| 344 | |
| 345 | |
| 346 | gUgU *gUgU* *gUU* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 347 | gUU Make current line uppercase. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 348 | |
| 349 | *v_u* |
| 350 | {Visual}u Make highlighted text lowercase (for {Visual} see |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 351 | |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 352 | |
| 353 | *gu* *lowercase* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 354 | gu{motion} Make {motion} text lowercase. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 355 | |
| 356 | gugu *gugu* *guu* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 357 | guu Make current line lowercase. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 358 | |
| 359 | *g?* *rot13* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 360 | g?{motion} Rot13 encode {motion} text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 361 | |
| 362 | *v_g?* |
| 363 | {Visual}g? Rot13 encode the highlighted text (for {Visual} see |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 364 | |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 365 | |
| 366 | g?g? *g?g?* *g??* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 367 | g?? Rot13 encode current line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 368 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 369 | To turn one line into title caps, make every first letter of a word |
| 370 | uppercase: > |
| 371 | :s/\v<(.)(\w*)/\u\1\L\2/g |
| 372 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 373 | |
| 374 | Adding and subtracting ~ |
| 375 | *CTRL-A* |
| 376 | CTRL-A Add [count] to the number or alphabetic character at |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 377 | or after the cursor. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 378 | |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 379 | *v_CTRL-A* |
| 380 | {Visual}CTRL-A Add [count] to the number or alphabetic character in |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 381 | the highlighted text. |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 382 | |
| 383 | *v_g_CTRL-A* |
| 384 | {Visual}g CTRL-A Add [count] to the number or alphabetic character in |
| 385 | the highlighted text. If several lines are |
| 386 | highlighted, each one will be incremented by an |
| 387 | additional [count] (so effectively creating a |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 388 | [count] incrementing sequence). |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 389 | For Example, if you have this list of numbers: |
| 390 | 1. ~ |
| 391 | 1. ~ |
| 392 | 1. ~ |
| 393 | 1. ~ |
| 394 | Move to the second "1." and Visually select three |
| 395 | lines, pressing g CTRL-A results in: |
| 396 | 1. ~ |
| 397 | 2. ~ |
| 398 | 3. ~ |
| 399 | 4. ~ |
| 400 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 401 | *CTRL-X* |
| 402 | CTRL-X Subtract [count] from the number or alphabetic |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 403 | character at or after the cursor. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 404 | |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 405 | *v_CTRL-X* |
| 406 | {Visual}CTRL-X Subtract [count] from the number or alphabetic |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 407 | character in the highlighted text. |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 408 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 409 | On MS-Windows, this is mapped to cut Visual text |
| 410 | |dos-standard-mappings|. If you want to disable the |
| 411 | mapping, use this: > |
| 412 | silent! vunmap <C-X> |
| 413 | < |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 414 | *v_g_CTRL-X* |
| 415 | {Visual}g CTRL-X Subtract [count] from the number or alphabetic |
| 416 | character in the highlighted text. If several lines |
| 417 | are highlighted, each value will be decremented by an |
| 418 | additional [count] (so effectively creating a [count] |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 419 | decrementing sequence). |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 420 | |
Bram Moolenaar | 887c1fe | 2016-01-02 17:56:35 +0100 | [diff] [blame] | 421 | The CTRL-A and CTRL-X commands can work for: |
| 422 | - signed and unsigned decimal numbers |
| 423 | - unsigned binary, octal and hexadecimal numbers |
| 424 | - alphabetic characters |
| 425 | |
| 426 | This depends on the 'nrformats' option: |
| 427 | - When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or |
| 428 | '0B' are binary. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 429 | - When 'nrformats' includes "octal", Vim considers numbers starting with a '0' |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 430 | to be octal, unless the number includes a '8' or '9'. Other numbers are |
| 431 | decimal and may have a preceding minus sign. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 432 | If the cursor is on a number, the commands apply to that number; otherwise |
| 433 | Vim uses the number to the right of the cursor. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 434 | - When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or |
| 435 | '0X' are hexadecimal. The case of the rightmost letter in the number |
| 436 | determines the case of the resulting hexadecimal number. If there is no |
| 437 | letter in the current number, Vim uses the previously detected case. |
| 438 | - When 'nrformats' includes "alpha", Vim will change the alphabetic character |
| 439 | under or after the cursor. This is useful to make lists with an alphabetic |
| 440 | index. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 441 | |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 442 | For decimals a leading negative sign is considered for incrementing/ |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 443 | decrementing, for binary, octal and hex values, it won't be considered. To |
Bram Moolenaar | 85eee13 | 2018-05-06 17:57:30 +0200 | [diff] [blame] | 444 | ignore the sign Visually select the number before using CTRL-A or CTRL-X. |
Bram Moolenaar | 979243b | 2015-06-26 19:35:49 +0200 | [diff] [blame] | 445 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 446 | For numbers with leading zeros (including all octal and hexadecimal numbers), |
| 447 | Vim preserves the number of characters in the number when possible. CTRL-A on |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 448 | "0077" results in "0100", CTRL-X on "0x100" results in "0x0ff". |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 449 | There is one exception: When a number that starts with a zero is found not to |
| 450 | be octal (it contains a '8' or '9'), but 'nrformats' does include "octal", |
| 451 | leading zeros are removed to avoid that the result may be recognized as an |
| 452 | octal number. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 453 | |
| 454 | Note that when 'nrformats' includes "octal", decimal numbers with leading |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 455 | zeros cause mistakes, because they can be confused with octal numbers. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 456 | |
K.Takata | 955652f | 2023-12-20 04:15:47 +0900 | [diff] [blame] | 457 | Note similarly, when 'nrformats' includes both "bin" and "hex", binary numbers |
| 458 | with a leading '0x' or '0X' can be interpreted as hexadecimal rather than |
| 459 | binary since '0b' are valid hexadecimal digits. CTRL-A on "0x0b11" results in |
| 460 | "0x0b12", not "0x0b100". |
| 461 | When 'nrformats' includes "bin" and doesn't include "hex", CTRL-A on "0b11" in |
| 462 | "0x0b11" results in "0x0b100". |
Bram Moolenaar | 887c1fe | 2016-01-02 17:56:35 +0100 | [diff] [blame] | 463 | |
Bram Moolenaar | 71badf9 | 2023-04-22 22:40:14 +0100 | [diff] [blame] | 464 | When the number under the cursor is too big to fit into 32 or 64 bit |
| 465 | (depending on how Vim was build), it will be rounded off to the nearest number |
| 466 | that can be represented, and the addition/subtraction is skipped. E.g. with |
| 467 | 64 bit support using CTRL-X on 18446744073709551616 results in |
| 468 | 18446744073709551615. Same for larger numbers, such as 18446744073709551618. |
| 469 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 470 | The CTRL-A command is very useful in a macro. Example: Use the following |
| 471 | steps to make a numbered list. |
| 472 | |
| 473 | 1. Create the first list entry, make sure it starts with a number. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 474 | 2. qa - start recording into register 'a' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 475 | 3. Y - yank the entry |
| 476 | 4. p - put a copy of the entry below the first one |
| 477 | 5. CTRL-A - increment the number |
| 478 | 6. q - stop recording |
| 479 | 7. <count>@a - repeat the yank, put and increment <count> times |
| 480 | |
| 481 | |
| 482 | SHIFTING LINES LEFT OR RIGHT *shift-left-right* |
| 483 | |
| 484 | *<* |
| 485 | <{motion} Shift {motion} lines one 'shiftwidth' leftwards. |
| 486 | |
Bram Moolenaar | f951416 | 2018-11-22 03:08:29 +0100 | [diff] [blame] | 487 | If the 'vartabstop' feature is enabled, and the |
| 488 | 'shiftwidth' option is set to zero, the amount of |
| 489 | indent is calculated at the first non-blank character |
| 490 | in the line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 491 | *<<* |
| 492 | << Shift [count] lines one 'shiftwidth' leftwards. |
| 493 | |
| 494 | *v_<* |
| 495 | {Visual}[count]< Shift the highlighted lines [count] 'shiftwidth' |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 496 | leftwards (for {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 497 | |
| 498 | *>* |
| 499 | >{motion} Shift {motion} lines one 'shiftwidth' rightwards. |
| 500 | |
Bram Moolenaar | f951416 | 2018-11-22 03:08:29 +0100 | [diff] [blame] | 501 | If the 'vartabstop' feature is enabled, and the |
| 502 | 'shiftwidth' option is set to zero, the amount of |
| 503 | indent is calculated at the first non-blank character |
| 504 | in the line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 505 | *>>* |
| 506 | >> Shift [count] lines one 'shiftwidth' rightwards. |
| 507 | |
| 508 | *v_>* |
| 509 | {Visual}[count]> Shift the highlighted lines [count] 'shiftwidth' |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 510 | rightwards (for {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 511 | |
| 512 | *:<* |
| 513 | :[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<' |
| 514 | for shifting multiple 'shiftwidth's. |
| 515 | |
| 516 | :[range]< {count} Shift {count} lines one 'shiftwidth' left, starting |
| 517 | with [range] (default current line |cmdline-ranges|). |
| 518 | Repeat '<' for shifting multiple 'shiftwidth's. |
| 519 | |
| 520 | :[range]le[ft] [indent] left align lines in [range]. Sets the indent in the |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 521 | lines to [indent] (default 0). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 522 | |
| 523 | *:>* |
Roy Orbitson | 2103a56 | 2023-12-06 01:14:33 +1030 | [diff] [blame] | 524 | :[range]> [flags] Shift [range] lines one 'shiftwidth' right. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 525 | Repeat '>' for shifting multiple 'shiftwidth's. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 526 | See |ex-flags| for [flags]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 527 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 528 | :[range]> {count} [flags] |
| 529 | Shift {count} lines one 'shiftwidth' right, starting |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 530 | with [range] (default current line |cmdline-ranges|). |
| 531 | Repeat '>' for shifting multiple 'shiftwidth's. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 532 | See |ex-flags| for [flags]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 533 | |
| 534 | The ">" and "<" commands are handy for changing the indentation within |
| 535 | programs. Use the 'shiftwidth' option to set the size of the white space |
| 536 | which these commands insert or delete. Normally the 'shiftwidth' option is 8, |
| 537 | but you can set it to, say, 3 to make smaller indents. The shift leftwards |
| 538 | stops when there is no indent. The shift right does not affect empty lines. |
| 539 | |
| 540 | If the 'shiftround' option is on, the indent is rounded to a multiple of |
| 541 | 'shiftwidth'. |
| 542 | |
| 543 | If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains |
Bram Moolenaar | 8e69b4a | 2013-11-09 03:41:58 +0100 | [diff] [blame] | 544 | '#' with a zero value, shift right does not affect lines starting with '#' |
| 545 | (these are supposed to be C preprocessor lines that must stay in column 1). |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 546 | This can be changed with the 'cino' option, see |cino-#|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 547 | |
| 548 | When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as |
| 549 | much as possible to make the indent. You can use ">><<" to replace an indent |
| 550 | made out of spaces with the same indent made out of <Tab>s (and a few spaces |
| 551 | if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then |
| 552 | you can use ">><<" to replace <Tab>s in the indent by spaces (or use |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 553 | `:retab!`). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 554 | |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 555 | To move a line several 'shiftwidth's, use Visual mode or the `:` commands. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 556 | For example: > |
| 557 | Vjj4> move three lines 4 indents to the right |
| 558 | :<<< move current line 3 indents to the left |
| 559 | :>> 5 move 5 lines 2 indents to the right |
| 560 | :5>> move line 5 2 indents to the right |
| 561 | |
| 562 | ============================================================================== |
| 563 | 4. Complex changes *complex-change* |
| 564 | |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 565 | 4.1 Filter commands *filter* |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 566 | |
| 567 | A filter is a program that accepts text at standard input, changes it in some |
| 568 | way, and sends it to standard output. You can use the commands below to send |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 569 | some text through a filter, so that it is replaced by the filter output. |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 570 | Examples of filters are "sort", which sorts lines alphabetically, and |
| 571 | "indent", which formats C program files (you need a version of indent that |
| 572 | works like a filter; not all versions do). The 'shell' option specifies the |
| 573 | shell Vim uses to execute the filter command (See also the 'shelltype' |
| 574 | option). You can repeat filter commands with ".". Vim does not recognize a |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 575 | comment (starting with '"') after the `:!` command. |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 576 | |
| 577 | *!* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 578 | !{motion}{filter} Filter {motion} text lines through the external |
| 579 | program {filter}. |
| 580 | |
| 581 | *!!* |
| 582 | !!{filter} Filter [count] lines through the external program |
| 583 | {filter}. |
| 584 | |
| 585 | *v_!* |
| 586 | {Visual}!{filter} Filter the highlighted lines through the external |
| 587 | program {filter} (for {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 588 | |
| 589 | :{range}![!]{filter} [!][arg] *:range!* |
Christian Brabandt | f18987c | 2024-11-12 21:38:22 +0100 | [diff] [blame] | 590 | For executing external commands see |:!| |
| 591 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 592 | Filter {range} lines through the external program |
| 593 | {filter}. Vim replaces the optional bangs with the |
| 594 | latest given command and appends the optional [arg]. |
| 595 | Vim saves the output of the filter command in a |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 596 | temporary file and then reads the file into the buffer |
| 597 | |tempfile|. Vim uses the 'shellredir' option to |
| 598 | redirect the filter output to the temporary file. |
Bram Moolenaar | 83c465c | 2005-12-16 21:53:56 +0000 | [diff] [blame] | 599 | However, if the 'shelltemp' option is off then pipes |
| 600 | are used when possible (on Unix). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 601 | When the 'R' flag is included in 'cpoptions' marks in |
| 602 | the filtered lines are deleted, unless the |
| 603 | |:keepmarks| command is used. Example: > |
| 604 | :keepmarks '<,'>!sort |
| 605 | < When the number of lines after filtering is less than |
| 606 | before, marks in the missing lines are deleted anyway. |
| 607 | |
| 608 | *=* |
| 609 | ={motion} Filter {motion} lines through the external program |
| 610 | given with the 'equalprg' option. When the 'equalprg' |
| 611 | option is empty (this is the default), use the |
Bram Moolenaar | 20f90cf | 2011-05-19 12:22:51 +0200 | [diff] [blame] | 612 | internal formatting function |C-indenting| and |
| 613 | |'lisp'|. But when 'indentexpr' is not empty, it will |
| 614 | be used instead |indent-expression|. When Vim was |
| 615 | compiled without internal formatting then the "indent" |
| 616 | program is used as a last resort. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 617 | |
| 618 | *==* |
| 619 | == Filter [count] lines like with ={motion}. |
| 620 | |
| 621 | *v_=* |
| 622 | {Visual}= Filter the highlighted lines like with ={motion}. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 623 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 624 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 625 | *tempfile* *setuid* |
| 626 | Vim uses temporary files for filtering, generating diffs and also for |
| 627 | tempname(). For Unix, the file will be in a private directory (only |
| 628 | accessible by the current user) to avoid security problems (e.g., a symlink |
| 629 | attack or other people reading your file). When Vim exits the directory and |
Christian Brabandt | 5cf5301 | 2024-05-18 10:13:11 +0200 | [diff] [blame] | 630 | all files in it are deleted (only on Unix, on other systems you will have to |
| 631 | clean up yourself). When Vim has the setuid bit set this may cause |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 632 | problems, the temp file is owned by the setuid user but the filter command |
| 633 | probably runs as the original user. |
Bram Moolenaar | 75ab590 | 2022-04-18 15:36:40 +0100 | [diff] [blame] | 634 | Directory for temporary files is created in the first of these directories |
| 635 | that works: |
| 636 | Unix: $TMPDIR, /tmp, current-dir, $HOME. |
| 637 | Windows: $TMP, $TEMP, c:\TMP, c:\TEMP |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 638 | For MS-Windows the GetTempFileName() system function is used. |
| 639 | For other systems the tmpnam() library function is used. |
| 640 | |
| 641 | |
| 642 | |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 643 | 4.2 Substitute *:substitute* |
| 644 | *:s* *:su* |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 645 | :[range]s[ubstitute]/{pattern}/{string}/[flags] [count] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 646 | For each line in [range] replace a match of {pattern} |
| 647 | with {string}. |
| 648 | For the {pattern} see |pattern|. |
| 649 | {string} can be a literal string, or something |
| 650 | special; see |sub-replace-special|. |
| 651 | When [range] and [count] are omitted, replace in the |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 652 | current line only. When [count] is given, replace in |
| 653 | [count] lines, starting with the last line in [range]. |
| 654 | When [range] is omitted start in the current line. |
Christian Brabandt | ac63787 | 2023-11-14 20:45:48 +0100 | [diff] [blame] | 655 | *E939* *E1510* |
| 656 | [count] must be a positive number (max 2147483647) |
| 657 | Also see |cmdline-ranges|. |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 658 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 659 | See |:s_flags| for [flags]. |
Bram Moolenaar | ebdf3c9 | 2020-02-15 21:41:42 +0100 | [diff] [blame] | 660 | The delimiter doesn't need to be /, see |
| 661 | |pattern-delimiter|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 662 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 663 | :[range]s[ubstitute] [flags] [count] |
| 664 | :[range]&[&][flags] [count] *:&* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 665 | Repeat last :substitute with same search pattern and |
| 666 | substitute string, but without the same flags. You |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 667 | may add [flags], see |:s_flags|. |
Christian Brabandt | 0bc8709 | 2025-05-28 20:23:29 +0200 | [diff] [blame] | 668 | Note that after `:substitute` the '&' and '#' flags |
| 669 | can't be used, they're recognized as a pattern |
| 670 | separator. |
Bram Moolenaar | fc39ecf | 2015-08-11 20:34:49 +0200 | [diff] [blame] | 671 | The space between `:substitute` and the 'c', 'g', |
| 672 | 'i', 'I' and 'r' flags isn't required, but in scripts |
| 673 | it's a good idea to keep it to avoid confusion. |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 674 | Also see the two and three letter commands to repeat |
| 675 | :substitute below |:substitute-repeat|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 676 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 677 | :[range]~[&][flags] [count] *:~* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 678 | Repeat last substitute with same substitute string |
| 679 | but with last used search pattern. This is like |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 680 | `:&r`. See |:s_flags| for [flags]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 681 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 682 | *&* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 683 | & Synonym for `:s` (repeat last substitute). Note |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 684 | that the flags are not remembered, thus it might |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 685 | actually work differently. You can use `:&&` to keep |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 686 | the flags. |
| 687 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 688 | *g&* |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 689 | g& Synonym for `:%s//~/&` (repeat last substitute with |
| 690 | last search pattern on all lines with the same flags). |
Bram Moolenaar | 34700a6 | 2013-03-07 13:20:54 +0100 | [diff] [blame] | 691 | For example, when you first do a substitution with |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 692 | `:s/pattern/repl/flags` and then `/search` for |
| 693 | something else, `g&` will do `:%s/search/repl/flags`. |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 694 | Mnemonic: global substitute. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 695 | |
| 696 | *:snomagic* *:sno* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 697 | :[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 698 | |
| 699 | *:smagic* *:sm* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 700 | :[range]sm[agic] ... Same as `:substitute`, but always use 'magic'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 701 | |
| 702 | *:s_flags* |
| 703 | The flags that you can use for the substitute commands: |
| 704 | |
Bram Moolenaar | 5162822 | 2016-12-01 23:03:28 +0100 | [diff] [blame] | 705 | *:&&* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 706 | [&] Must be the first one: Keep the flags from the previous substitute |
| 707 | command. Examples: > |
| 708 | :&& |
| 709 | :s/this/that/& |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 710 | < Note that `:s` and `:&` don't keep the flags. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 711 | |
| 712 | [c] Confirm each substitution. Vim highlights the matching string (with |
| 713 | |hl-IncSearch|). You can type: *:s_c* |
| 714 | 'y' to substitute this match |
| 715 | 'l' to substitute this match and then quit ("last") |
| 716 | 'n' to skip this match |
| 717 | <Esc> to quit substituting |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 718 | 'a' to substitute this and all remaining matches |
| 719 | 'q' to quit substituting |
Bram Moolenaar | e2c453d | 2019-08-21 14:37:09 +0200 | [diff] [blame] | 720 | CTRL-E to scroll the screen up |
| 721 | CTRL-Y to scroll the screen down |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 722 | If the 'edcompatible' option is on, Vim remembers the [c] flag and |
| 723 | toggles it each time you use it, but resets it when you give a new |
| 724 | search pattern. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 725 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 726 | *:s_e* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 727 | [e] When the search pattern fails, do not issue an error message and, in |
| 728 | particular, continue in maps as if no error occurred. This is most |
| 729 | useful to prevent the "No match" error from breaking a mapping. Vim |
| 730 | does not suppress the following error messages, however: |
| 731 | Regular expressions can't be delimited by letters |
| 732 | \ should be followed by /, ? or & |
| 733 | No previous substitute regular expression |
| 734 | Trailing characters |
| 735 | Interrupted |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 736 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 737 | *:s_g* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 738 | [g] Replace all occurrences in the line. Without this argument, |
| 739 | replacement occurs only for the first occurrence in each line. If |
| 740 | the 'edcompatible' option is on, Vim remembers this flag and toggles |
| 741 | it each time you use it, but resets it when you give a new search |
| 742 | pattern. If the 'gdefault' option is on, this flag is on by default |
| 743 | and the [g] argument switches it off. |
| 744 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 745 | *:s_i* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 746 | [i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options |
| 747 | are not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 748 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 749 | *:s_I* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 750 | [I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase' |
| 751 | options are not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 752 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 753 | *:s_n* |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 754 | [n] Report the number of matches, do not actually substitute. The [c] |
| 755 | flag is ignored. The matches are reported as if 'report' is zero. |
| 756 | Useful to |count-items|. |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 757 | If \= |sub-replace-expression| is used, the expression will be |
| 758 | evaluated in the |sandbox| at every match. |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 759 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 760 | [p] Print the line containing the last substitute. *:s_p* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 761 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 762 | [#] Like [p] and prepend the line number. *:s_#* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 763 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 764 | [l] Like [p] but print the text like |:list|. *:s_l* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 765 | |
Bram Moolenaar | 95bafa2 | 2018-10-02 13:26:25 +0200 | [diff] [blame] | 766 | *:s_r* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 767 | [r] Only useful in combination with `:&` or `:s` without arguments. `:&r` |
| 768 | works the same way as `:~`: When the search pattern is empty, use the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 769 | previously used search pattern instead of the search pattern from the |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 770 | last substitute or `:global`. If the last command that did a search |
| 771 | was a substitute or `:global`, there is no effect. If the last |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 772 | command was a search command such as "/", use the pattern from that |
| 773 | command. |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 774 | For `:s` with an argument this already happens: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 775 | :s/blue/red/ |
| 776 | /green |
| 777 | :s//red/ or :~ or :&r |
| 778 | < The last commands will replace "green" with "red". > |
| 779 | :s/blue/red/ |
| 780 | /green |
| 781 | :& |
| 782 | < The last command will replace "blue" with "red". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 783 | |
| 784 | Note that there is no flag to change the "magicness" of the pattern. A |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 785 | different command is used instead, or you can use |/\v| and friends. The |
| 786 | reason is that the flags can only be found by skipping the pattern, and in |
| 787 | order to skip the pattern the "magicness" must be known. Catch 22! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 788 | |
| 789 | If the {pattern} for the substitute command is empty, the command uses the |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 790 | pattern from the last substitute or `:global` command. If there is none, but |
Bram Moolenaar | 662db67 | 2011-03-22 14:05:35 +0100 | [diff] [blame] | 791 | there is a previous search pattern, that one is used. With the [r] flag, the |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 792 | command uses the pattern from the last substitute, `:global`, or search |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 793 | command. |
| 794 | |
Bram Moolenaar | 9964e46 | 2007-05-05 17:54:07 +0000 | [diff] [blame] | 795 | If the {string} is omitted the substitute is done as if it's empty. Thus the |
| 796 | matched pattern is deleted. The separator after {pattern} can also be left |
| 797 | out then. Example: > |
| 798 | :%s/TESTING |
| 799 | This deletes "TESTING" from all lines, but only one per line. |
Bram Moolenaar | 1588bc8 | 2022-03-08 21:35:07 +0000 | [diff] [blame] | 800 | *E1270* |
| 801 | For compatibility with Vi these two exceptions are allowed in legacy script: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 802 | "\/{string}/" and "\?{string}?" do the same as "//{string}/r". |
| 803 | "\&{string}&" does the same as "//{string}/". |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 804 | *pattern-delimiter* *E146* *E1241* *E1242* |
Bram Moolenaar | 4d8f476 | 2021-06-27 15:18:56 +0200 | [diff] [blame] | 805 | Instead of the '/' which surrounds the pattern and replacement string, you can |
| 806 | use another single-byte character. This is useful if you want to include a |
| 807 | '/' in the search pattern or replacement string. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 808 | :s+/+//+ |
| 809 | |
Bram Moolenaar | 4d8f476 | 2021-06-27 15:18:56 +0200 | [diff] [blame] | 810 | You can use most characters, but not an alphanumeric character, '\', '"' or |
| 811 | '|'. In Vim9 script you should not use '#' because it may be recognized as |
| 812 | the start of a comment. |
| 813 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 814 | For the definition of a pattern, see |pattern|. In Visual block mode, use |
| 815 | |/\%V| in the pattern to have the substitute work in the block only. |
| 816 | Otherwise it works on whole lines anyway. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 817 | |
| 818 | *sub-replace-special* *:s\=* |
| 819 | When the {string} starts with "\=" it is evaluated as an expression, see |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 820 | |sub-replace-expression|. You can use that for complex replacement or special |
| 821 | characters. |
| 822 | |
Bram Moolenaar | 2ecbe53 | 2022-07-29 21:36:21 +0100 | [diff] [blame] | 823 | The substitution is limited in recursion to 4 levels. *E1290* |
| 824 | |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 825 | Otherwise these characters in {string} have a special meaning: |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 826 | *:s%* |
Bram Moolenaar | 551dbcc | 2006-04-25 22:13:59 +0000 | [diff] [blame] | 827 | When {string} is equal to "%" and '/' is included with the 'cpoptions' option, |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 828 | then the {string} of the previous substitute command is used, see |cpo-/| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 829 | |
| 830 | magic nomagic action ~ |
| 831 | & \& replaced with the whole matched pattern *s/\&* |
| 832 | \& & replaced with & |
| 833 | \0 replaced with the whole matched pattern *\0* *s/\0* |
| 834 | \1 replaced with the matched pattern in the first |
| 835 | pair of () *s/\1* |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 836 | \2 replaced with the matched pattern in the second |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 837 | pair of () *s/\2* |
| 838 | .. .. *s/\3* |
| 839 | \9 replaced with the matched pattern in the ninth |
| 840 | pair of () *s/\9* |
| 841 | ~ \~ replaced with the {string} of the previous |
| 842 | substitute *s~* |
| 843 | \~ ~ replaced with ~ *s/\~* |
| 844 | \u next character made uppercase *s/\u* |
| 845 | \U following characters made uppercase, until \E *s/\U* |
| 846 | \l next character made lowercase *s/\l* |
| 847 | \L following characters made lowercase, until \E *s/\L* |
| 848 | \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e* |
| 849 | \E end of \u, \U, \l and \L *s/\E* |
| 850 | <CR> split line in two at this point |
| 851 | (Type the <CR> as CTRL-V <Enter>) *s<CR>* |
| 852 | \r idem *s/\r* |
| 853 | \<CR> insert a carriage-return (CTRL-M) |
| 854 | (Type the <CR> as CTRL-V <Enter>) *s/\<CR>* |
| 855 | \n insert a <NL> (<NUL> in the file) |
| 856 | (does NOT break the line) *s/\n* |
| 857 | \b insert a <BS> *s/\b* |
| 858 | \t insert a <Tab> *s/\t* |
| 859 | \\ insert a single backslash *s/\\* |
| 860 | \x where x is any character not mentioned above: |
| 861 | Reserved for future expansion |
| 862 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 863 | The special meaning is also used inside the third argument {sub} of |
| 864 | the |substitute()| function with the following exceptions: |
| 865 | - A % inserts a percent literally without regard to 'cpoptions'. |
| 866 | - magic is always set without regard to 'magic'. |
| 867 | - A ~ inserts a tilde literally. |
| 868 | - <CR> and \r inserts a carriage-return (CTRL-M). |
Bram Moolenaar | ba3ff53 | 2018-11-04 14:45:49 +0100 | [diff] [blame] | 869 | - \<CR> does not have a special meaning. It's just one of \x. |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 870 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 871 | Examples: > |
| 872 | :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx" |
| 873 | :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb" |
| 874 | :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines) |
| 875 | :s/$/\^M/ modifies "abcde" to "abcde^M" |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 876 | :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla" |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 877 | :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla" |
Bram Moolenaar | bf88493 | 2013-04-05 22:26:15 +0200 | [diff] [blame] | 878 | |
| 879 | Note: "\L\u" can be used to capitalize the first letter of a word. This is |
| 880 | not compatible with Vi and older versions of Vim, where the "\u" would cancel |
| 881 | out the "\L". Same for "\U\l". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 882 | |
| 883 | Note: In previous versions CTRL-V was handled in a special way. Since this is |
| 884 | not Vi compatible, this was removed. Use a backslash instead. |
| 885 | |
| 886 | command text result ~ |
| 887 | :s/aa/a^Ma/ aa a<line-break>a |
| 888 | :s/aa/a\^Ma/ aa a^Ma |
| 889 | :s/aa/a\\^Ma/ aa a\<line-break>a |
| 890 | |
| 891 | (you need to type CTRL-V <CR> to get a ^M here) |
| 892 | |
| 893 | The numbering of "\1", "\2" etc. is done based on which "\(" comes first in |
| 894 | the pattern (going left to right). When a parentheses group matches several |
| 895 | times, the last one will be used for "\1", "\2", etc. Example: > |
| 896 | :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x" |
Bram Moolenaar | 7e1479b | 2016-09-11 15:07:27 +0200 | [diff] [blame] | 897 | The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 898 | |
| 899 | When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\), |
| 900 | either the first or second pattern in parentheses did not match, so either |
| 901 | \1 or \2 is empty. Example: > |
| 902 | :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x" |
| 903 | < |
| 904 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 905 | *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc* |
| 906 | *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si* |
| 907 | *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp* |
| 908 | *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl* |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 909 | *:srn* *:srp* *:substitute-repeat* |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 910 | 2-letter and 3-letter :substitute commands ~ |
| 911 | |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 912 | These commands repeat the previous `:substitute` command with the given flags. |
| 913 | The first letter is always "s", followed by one or two of the possible flag |
| 914 | characters. For example `:sce` works like `:s///ce`. The table lists the |
| 915 | possible combinations, not all flags are possible, because the command is |
| 916 | short for another command. |
| 917 | |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 918 | List of :substitute commands |
| 919 | | c e g i I n p l r |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 920 | | c :sc :sce :scg :sci :scI :scn :scp :scl |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 921 | | e |
| 922 | | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 923 | | i :sic :sie :si :siI :sin :sip :sir |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 924 | | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr |
| 925 | | n |
| 926 | | p |
| 927 | | l |
Bram Moolenaar | c8cdf0f | 2021-03-13 13:28:13 +0100 | [diff] [blame] | 928 | | r :src :srg :sri :srI :srn :srp :srl :sr |
Bram Moolenaar | a0f849e | 2015-10-30 14:37:44 +0100 | [diff] [blame] | 929 | |
| 930 | Exceptions: |
| 931 | :scr is `:scriptnames` |
| 932 | :se is `:set` |
| 933 | :sig is `:sign` |
| 934 | :sil is `:silent` |
| 935 | :sn is `:snext` |
| 936 | :sp is `:split` |
| 937 | :sl is `:sleep` |
| 938 | :sre is `:srewind` |
| 939 | |
| 940 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 941 | Substitute with an expression *sub-replace-expression* |
Bram Moolenaar | 92dff18 | 2014-02-11 19:15:50 +0100 | [diff] [blame] | 942 | *sub-replace-\=* *s/\=* |
Bram Moolenaar | a7fc010 | 2005-05-18 22:17:12 +0000 | [diff] [blame] | 943 | When the substitute string starts with "\=" the remainder is interpreted as an |
Bram Moolenaar | 6100d02 | 2016-10-02 16:51:57 +0200 | [diff] [blame] | 944 | expression. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 945 | |
| 946 | The special meaning for characters as mentioned at |sub-replace-special| does |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 947 | not apply except for "<CR>". A <NL> character is used as a line break, you |
| 948 | can get one with a double-quote string: "\n". Prepend a backslash to get a |
| 949 | real <NL> character (which will be a NUL in the file). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 950 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 951 | The "\=" notation can also be used inside the third argument {sub} of |
| 952 | |substitute()| function. In this case, the special meaning for characters as |
| 953 | mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and |
| 954 | <NL> are interpreted not as a line break but as a carriage-return and a |
| 955 | new-line respectively. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 956 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 957 | When the result is a |List| then the items are joined with separating line |
| 958 | breaks. Thus each item becomes a line, except that they can contain line |
| 959 | breaks themselves. |
| 960 | |
Bram Moolenaar | 9d87a37 | 2018-12-18 21:41:50 +0100 | [diff] [blame] | 961 | The |submatch()| function can be used to obtain matched text. The whole |
| 962 | matched text can be accessed with "submatch(0)". The text matched with the |
| 963 | first pair of () with "submatch(1)". Likewise for further sub-matches in (). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 964 | |
| 965 | Be careful: The separation character must not appear in the expression! |
| 966 | Consider using a character like "@" or ":". There is no problem if the result |
| 967 | of the expression contains the separation character. |
| 968 | |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 969 | Examples: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 970 | :s@\n@\="\r" .. expand("$HOME") .. "\r"@ |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 971 | This replaces an end-of-line with a new line containing the value of $HOME. > |
| 972 | |
| 973 | s/E/\="\<Char-0x20ac>"/g |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 974 | This replaces each 'E' character with a euro sign. Read more in |<Char->|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 975 | |
| 976 | |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 977 | 4.3 Search and replace *search-replace* |
| 978 | |
| 979 | *:pro* *:promptfind* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 980 | :promptf[ind] [string] |
| 981 | Put up a Search dialog. When [string] is given, it is |
| 982 | used as the initial search string. |
| 983 | {only for Win32, Motif and GTK GUI} |
| 984 | |
| 985 | *:promptr* *:promptrepl* |
| 986 | :promptr[epl] [string] |
| 987 | Put up a Search/Replace dialog. When [string] is |
| 988 | given, it is used as the initial search string. |
| 989 | {only for Win32, Motif and GTK GUI} |
| 990 | |
Bram Moolenaar | 47136d7 | 2004-10-12 20:02:24 +0000 | [diff] [blame] | 991 | |
| 992 | 4.4 Changing tabs *change-tabs* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 993 | *:ret* *:retab* *:retab!* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 994 | :[range]ret[ab][!] [new_tabstop] |
| 995 | Replace all sequences of white-space containing a |
| 996 | <Tab> with new strings of white-space using the new |
| 997 | tabstop value given. If you do not specify a new |
| 998 | tabstop size or it is zero, Vim uses the current value |
| 999 | of 'tabstop'. |
| 1000 | The current value of 'tabstop' is always used to |
| 1001 | compute the width of existing tabs. |
| 1002 | With !, Vim also replaces strings of only normal |
| 1003 | spaces with tabs where appropriate. |
| 1004 | With 'expandtab' on, Vim replaces all tabs with the |
| 1005 | appropriate number of spaces. |
| 1006 | This command sets 'tabstop' to the new value given, |
| 1007 | and if performed on the whole file, which is default, |
| 1008 | should not make any visible change. |
| 1009 | Careful: This command modifies any <Tab> characters |
| 1010 | inside of strings in a C program. Use "\t" to avoid |
| 1011 | this (that's a good habit anyway). |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1012 | `:retab!` may also change a sequence of spaces by |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1013 | <Tab> characters, which can mess up a printf(). |
Bram Moolenaar | 04958cb | 2018-06-23 19:23:02 +0200 | [diff] [blame] | 1014 | If the |+vartabs| feature is enabled then a list of |
| 1015 | tab widths separated by commas may be used in place of |
| 1016 | a single tabstop. Each value in the list represents |
| 1017 | the width of one tabstop, except the final value which |
| 1018 | applies to all following tabstops. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1019 | |
| 1020 | *retab-example* |
| 1021 | Example for using autocommands and ":retab" to edit a file which is stored |
| 1022 | with tabstops at 8 but edited with tabstops set at 4. Warning: white space |
| 1023 | inside of strings can change! Also see 'softtabstop' option. > |
| 1024 | |
| 1025 | :auto BufReadPost *.xx retab! 4 |
| 1026 | :auto BufWritePre *.xx retab! 8 |
| 1027 | :auto BufWritePost *.xx retab! 4 |
| 1028 | :auto BufNewFile *.xx set ts=4 |
| 1029 | |
| 1030 | ============================================================================== |
| 1031 | 5. Copying and moving text *copy-move* |
| 1032 | |
| 1033 | *quote* |
Bram Moolenaar | 7ceefb3 | 2020-05-01 16:07:38 +0200 | [diff] [blame] | 1034 | "{register} Use {register} for next delete, yank or put. Use |
| 1035 | an uppercase character to append with delete and yank. |
| 1036 | Registers ".", "%", "#" and ":" only work with put. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1037 | |
| 1038 | *:reg* *:registers* |
Bram Moolenaar | 3691f1e | 2019-10-24 20:17:00 +0200 | [diff] [blame] | 1039 | :reg[isters] Display the type and contents of all numbered and |
| 1040 | named registers. If a register is written to for |
| 1041 | |:redir| it will not be listed. |
| 1042 | Type can be one of: |
| 1043 | "c" for |characterwise| text |
| 1044 | "l" for |linewise| text |
| 1045 | "b" for |blockwise-visual| text |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1046 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1047 | |
| 1048 | :reg[isters] {arg} Display the contents of the numbered and named |
| 1049 | registers that are mentioned in {arg}. For example: > |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 1050 | :reg 1a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1051 | < to display registers '1' and 'a'. Spaces are allowed |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1052 | in {arg}. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1053 | |
Bram Moolenaar | dd60c36 | 2023-02-27 15:49:53 +0000 | [diff] [blame] | 1054 | *:di* *:dis* *:display* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1055 | :di[splay] [arg] Same as :registers. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1056 | |
| 1057 | *y* *yank* |
| 1058 | ["x]y{motion} Yank {motion} text [into register x]. When no |
| 1059 | characters are to be yanked (e.g., "y0" in column 1), |
| 1060 | this is an error when 'cpoptions' includes the 'E' |
| 1061 | flag. |
| 1062 | |
| 1063 | *yy* |
| 1064 | ["x]yy Yank [count] lines [into register x] |linewise|. |
| 1065 | |
| 1066 | *Y* |
| 1067 | ["x]Y yank [count] lines [into register x] (synonym for |
| 1068 | yy, |linewise|). If you like "Y" to work from the |
| 1069 | cursor to the end of line (which is more logical, |
| 1070 | but not Vi-compatible) use ":map Y y$". |
| 1071 | |
Christian Brabandt | 544a38e | 2021-06-10 19:39:11 +0200 | [diff] [blame] | 1072 | *zy* |
| 1073 | ["x]zy{motion} Yank {motion} text [into register x]. Only differs |
| 1074 | from `y` when selecting a block of text, see |v_zy|. |
| 1075 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1076 | *v_y* |
| 1077 | {Visual}["x]y Yank the highlighted text [into register x] (for |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1078 | {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1079 | |
| 1080 | *v_Y* |
| 1081 | {Visual}["x]Y Yank the highlighted lines [into register x] (for |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1082 | {Visual} see |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1083 | |
Christian Brabandt | 544a38e | 2021-06-10 19:39:11 +0200 | [diff] [blame] | 1084 | *v_zy* |
| 1085 | {Visual}["x]zy Yank the highlighted text [into register x]. Trailing |
| 1086 | whitespace at the end of each line of a selected block |
| 1087 | won't be yanked. Especially useful in combination |
| 1088 | with `zp`. (for {Visual} see |Visual-mode|) |
| 1089 | |
Bram Moolenaar | 85de206 | 2011-05-05 14:26:41 +0200 | [diff] [blame] | 1090 | *:y* *:yank* *E850* |
| 1091 | :[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 1092 | "* or "+ registers is possible only when the |
| 1093 | |+clipboard| feature is included. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1094 | |
| 1095 | :[range]y[ank] [x] {count} |
| 1096 | Yank {count} lines, starting with last line number |
| 1097 | in [range] (default: current line |cmdline-ranges|), |
| 1098 | [into register x]. |
| 1099 | |
Bram Moolenaar | a2baa73 | 2022-02-04 16:09:54 +0000 | [diff] [blame] | 1100 | *p* *put* *E353* *E1240* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1101 | ["x]p Put the text [from register x] after the cursor |
Bram Moolenaar | a6c27c4 | 2019-05-09 19:16:22 +0200 | [diff] [blame] | 1102 | [count] times. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1103 | |
| 1104 | *P* |
| 1105 | ["x]P Put the text [from register x] before the cursor |
Bram Moolenaar | a6c27c4 | 2019-05-09 19:16:22 +0200 | [diff] [blame] | 1106 | [count] times. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1107 | |
| 1108 | *<MiddleMouse>* |
| 1109 | ["x]<MiddleMouse> Put the text from a register before the cursor [count] |
| 1110 | times. Uses the "* register, unless another is |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 1111 | specified. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1112 | Leaves the cursor at the end of the new text. |
| 1113 | Using the mouse only works when 'mouse' contains 'n' |
| 1114 | or 'a'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1115 | If you have a scrollwheel and often accidentally paste |
| 1116 | text, you can use these mappings to disable the |
| 1117 | pasting with the middle mouse button: > |
| 1118 | :map <MiddleMouse> <Nop> |
| 1119 | :imap <MiddleMouse> <Nop> |
| 1120 | < You might want to disable the multi-click versions |
| 1121 | too, see |double-click|. |
| 1122 | |
| 1123 | *gp* |
| 1124 | ["x]gp Just like "p", but leave the cursor just after the new |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1125 | text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1126 | |
| 1127 | *gP* |
| 1128 | ["x]gP Just like "P", but leave the cursor just after the new |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1129 | text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1130 | |
| 1131 | *:pu* *:put* |
| 1132 | :[line]pu[t] [x] Put the text [from register x] after [line] (default |
| 1133 | current line). This always works |linewise|, thus |
| 1134 | this command can be used to put a yanked block as new |
| 1135 | lines. |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1136 | If no register is specified, it depends on the 'cb' |
| 1137 | option: If 'cb' contains "unnamedplus", paste from the |
| 1138 | + register |quoteplus|. Otherwise, if 'cb' contains |
Bram Moolenaar | ddbb555 | 2012-04-26 20:17:03 +0200 | [diff] [blame] | 1139 | "unnamed", paste from the * register |quotestar|. |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1140 | Otherwise, paste from the unnamed register |
| 1141 | |quote_quote|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1142 | The register can also be '=' followed by an optional |
| 1143 | expression. The expression continues until the end of |
| 1144 | the command. You need to escape the '|' and '"' |
| 1145 | characters to prevent them from terminating the |
| 1146 | command. Example: > |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 1147 | :put ='path' .. \",/test\" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1148 | < If there is no expression after '=', Vim uses the |
| 1149 | previous expression. You can see it with ":dis =". |
| 1150 | |
| 1151 | :[line]pu[t]! [x] Put the text [from register x] before [line] (default |
| 1152 | current line). |
| 1153 | |
64-bitman | e08f10a | 2025-03-18 22:14:34 +0100 | [diff] [blame] | 1154 | *:ip* *:iput* |
| 1155 | :[line]ip[ut] [x] like |:put|, but adjust indent to the current line |
| 1156 | |
| 1157 | :[line]ip[ut]! [x] like |:put|!, but adjust indent to the current line |
| 1158 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1159 | ["x]]p or *]p* *]<MiddleMouse>* |
| 1160 | ["x]]<MiddleMouse> Like "p", but adjust the indent to the current line. |
| 1161 | Using the mouse only works when 'mouse' contains 'n' |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1162 | or 'a'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1163 | |
| 1164 | ["x][P or *[P* |
| 1165 | ["x]]P or *]P* |
| 1166 | ["x][p or *[p* *[<MiddleMouse>* |
| 1167 | ["x][<MiddleMouse> Like "P", but adjust the indent to the current line. |
| 1168 | Using the mouse only works when 'mouse' contains 'n' |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1169 | or 'a'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1170 | |
Christian Brabandt | 2fa9384 | 2021-05-30 22:17:25 +0200 | [diff] [blame] | 1171 | ["x]zp or *zp* *zP* |
| 1172 | ["x]zP Like "p" and "P", except without adding trailing spaces |
| 1173 | when pasting a block. Thus the inserted text will not |
Christian Brabandt | 544a38e | 2021-06-10 19:39:11 +0200 | [diff] [blame] | 1174 | always be a rectangle. Especially useful in |
| 1175 | combination with |v_zy|. |
Christian Brabandt | 2fa9384 | 2021-05-30 22:17:25 +0200 | [diff] [blame] | 1176 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1177 | You can use these commands to copy text from one place to another. Do this |
| 1178 | by first getting the text into a register with a yank, delete or change |
| 1179 | command, then inserting the register contents with a put command. You can |
| 1180 | also use these commands to move text from one file to another, because Vim |
| 1181 | preserves all registers when changing buffers (the CTRL-^ command is a quick |
| 1182 | way to toggle between two files). |
| 1183 | |
| 1184 | *linewise-register* *characterwise-register* |
| 1185 | You can repeat the put commands with "." (except for :put) and undo them. If |
| 1186 | the command that was used to get the text into the register was |linewise|, |
| 1187 | Vim inserts the text below ("p") or above ("P") the line where the cursor is. |
| 1188 | Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With |
| 1189 | the ":put" command, Vim always inserts the text in the next line. You can |
| 1190 | exchange two characters with the command sequence "xp". You can exchange two |
| 1191 | lines with the command sequence "ddp". You can exchange two words with the |
| 1192 | command sequence "deep" (start with the cursor in the blank space before the |
Christian Brabandt | df68419 | 2025-04-03 12:33:02 +0200 | [diff] [blame] | 1193 | first word). You can use the |']| or |`]| command after the put command to |
| 1194 | move the cursor to the end of the inserted text, or use |'[| or |`[| to move |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1195 | the cursor to the start. |
| 1196 | |
| 1197 | *put-Visual-mode* *v_p* *v_P* |
| 1198 | When using a put command like |p| or |P| in Visual mode, Vim will try to |
| 1199 | replace the selected text with the contents of the register. Whether this |
| 1200 | works well depends on the type of selection and the type of the text in the |
| 1201 | register. With blockwise selection it also depends on the size of the block |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 1202 | and whether the corners are on an existing character. (Implementation detail: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1203 | it actually works by first putting the register after the selection and then |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 1204 | deleting the selection.) |
Shougo Matsushita | 509142a | 2022-05-06 11:45:09 +0100 | [diff] [blame] | 1205 | With |p| the previously selected text is put in the unnamed register (and |
| 1206 | possibly the selection and/or clipboard). This is useful if you want to put |
| 1207 | that text somewhere else. But you cannot repeat the same change. |
| 1208 | With |P| the unnamed register is not changed (and neither the selection or |
| 1209 | clipboard), you can repeat the same change. But the deleted text cannot be |
| 1210 | used. If you do need it you can use |p| with another register. E.g., yank |
| 1211 | the text to copy, Visually select the text to replace and use "0p . You can |
| 1212 | repeat this as many times as you like, and the unnamed register will be |
| 1213 | changed each time. |
Bram Moolenaar | 9712ff1 | 2022-09-18 13:04:22 +0100 | [diff] [blame] | 1214 | *blockwise-put* |
| 1215 | When a register contains text from one line (characterwise), using a |
| 1216 | blockwise Visual selection, putting that register will paste that text |
| 1217 | repeatedly in each of the selected lines, thus replacing the blockwise |
| 1218 | selected region by multiple copies of the register text. For example: |
| 1219 | - yank the word "TEXT" into a register with `yw` |
| 1220 | - select a visual block, marked with "v" in this text: |
| 1221 | aaavvaaa |
| 1222 | bbbvvbbb |
| 1223 | cccvvccc |
| 1224 | - press `p`, results in: |
| 1225 | aaaTEXTaaa |
| 1226 | bbbTEXTbbb |
| 1227 | cccTEXTccc |
Bram Moolenaar | ec11aef | 2013-09-22 15:23:44 +0200 | [diff] [blame] | 1228 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1229 | *blockwise-register* |
| 1230 | If you use a blockwise Visual mode command to get the text into the register, |
| 1231 | the block of text will be inserted before ("P") or after ("p") the cursor |
| 1232 | column in the current and next lines. Vim makes the whole block of text start |
| 1233 | in the same column. Thus the inserted text looks the same as when it was |
| 1234 | yanked or deleted. Vim may replace some <Tab> characters with spaces to make |
| 1235 | this happen. However, if the width of the block is not a multiple of a <Tab> |
| 1236 | width and the text after the inserted block contains <Tab>s, that text may be |
| 1237 | misaligned. |
| 1238 | |
Bram Moolenaar | 2286304 | 2021-10-16 15:23:36 +0100 | [diff] [blame] | 1239 | Use |zP|/|zp| to paste a blockwise yanked register without appending trailing |
| 1240 | spaces. |
| 1241 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1242 | Note that after a characterwise yank command, Vim leaves the cursor on the |
| 1243 | first yanked character that is closest to the start of the buffer. This means |
| 1244 | that "yl" doesn't move the cursor, but "yh" moves the cursor one character |
| 1245 | left. |
| 1246 | Rationale: In Vi the "y" command followed by a backwards motion would |
| 1247 | sometimes not move the cursor to the first yanked character, |
| 1248 | because redisplaying was skipped. In Vim it always moves to |
| 1249 | the first character, as specified by Posix. |
| 1250 | With a linewise yank command the cursor is put in the first line, but the |
| 1251 | column is unmodified, thus it may not be on the first yanked character. |
| 1252 | |
Bram Moolenaar | 5be4cee | 2019-09-27 19:34:08 +0200 | [diff] [blame] | 1253 | There are ten types of registers: *registers* *{register}* *E354* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1254 | 1. The unnamed register "" |
| 1255 | 2. 10 numbered registers "0 to "9 |
| 1256 | 3. The small delete register "- |
| 1257 | 4. 26 named registers "a to "z or "A to "Z |
Bram Moolenaar | 396e829 | 2019-07-13 23:04:31 +0200 | [diff] [blame] | 1258 | 5. Three read-only registers ":, "., "% |
| 1259 | 6. Alternate buffer register "# |
| 1260 | 7. The expression register "= |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1261 | 8. The selection and drop registers "*, "+ and "~ |
| 1262 | 9. The black hole register "_ |
| 1263 | 10. Last search pattern register "/ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1264 | |
| 1265 | 1. Unnamed register "" *quote_quote* *quotequote* |
| 1266 | Vim fills this register with text deleted with the "d", "c", "s", "x" commands |
| 1267 | or copied with the yank "y" command, regardless of whether or not a specific |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 1268 | register was used (e.g. "xdd). This is like the unnamed register is pointing |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1269 | to the last used register. Thus when appending using an uppercase register |
| 1270 | name, the unnamed register contains the same text as the named register. |
| 1271 | An exception is the '_' register: "_dd does not store the deleted text in any |
| 1272 | register. |
Bram Moolenaar | 8169525 | 2004-12-29 20:58:21 +0000 | [diff] [blame] | 1273 | Vim uses the contents of the unnamed register for any put command (p or P) |
| 1274 | which does not specify a register. Additionally you can access it with the |
| 1275 | name '"'. This means you have to type two double quotes. Writing to the "" |
| 1276 | register writes to register "0. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1277 | {Vi: register contents are lost when changing files, no '"'} |
| 1278 | |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 1279 | 2. Numbered registers "0 to "9 *quote_number* *quote0* *quote1* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1280 | *quote2* *quote3* *quote4* *quote9* |
| 1281 | Vim fills these registers with text from yank and delete commands. |
| 1282 | Numbered register 0 contains the text from the most recent yank command, |
| 1283 | unless the command specified another register with ["x]. |
| 1284 | Numbered register 1 contains the text deleted by the most recent delete or |
Christian Brabandt | ecd642a | 2024-06-23 20:24:52 +0200 | [diff] [blame] | 1285 | change command (even when the command specified another register), unless the |
| 1286 | text is less than one line (the small delete register is used then). An |
| 1287 | exception is made for the delete operator with these movement commands: |%|, |
| 1288 | |(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| and |}|. |
| 1289 | Register "1 is always used then (this is Vi compatible). The "- register is |
| 1290 | used as well if the delete is within a line. Note that these characters may be |
| 1291 | mapped. E.g. |%| is mapped by the matchit plugin. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1292 | With each successive deletion or change, Vim shifts the previous contents |
| 1293 | of register 1 into register 2, 2 into 3, and so forth, losing the previous |
| 1294 | contents of register 9. |
Frederick Key Abell III | 6e56484 | 2024-10-07 21:07:12 +0200 | [diff] [blame] | 1295 | {Vi: register 0 does not exist} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1296 | |
| 1297 | 3. Small delete register "- *quote_-* *quote-* |
| 1298 | This register contains text from commands that delete less than one line, |
| 1299 | except when the command specifies a register with ["x]. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1300 | |
| 1301 | 4. Named registers "a to "z or "A to "Z *quote_alpha* *quotea* |
| 1302 | Vim fills these registers only when you say so. Specify them as lowercase |
| 1303 | letters to replace their previous contents or as uppercase letters to append |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1304 | to their previous contents. When the '>' flag is present in 'cpoptions' then |
| 1305 | a line break is inserted before the appended text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1306 | |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1307 | 5. Read-only registers ":, ". and "% |
Bram Moolenaar | cfa8f9a | 2022-06-03 21:59:47 +0100 | [diff] [blame] | 1308 | These are '%', ':' and '.'. You can use them only with the "p", "P", |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1309 | and ":put" commands and with CTRL-R. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1310 | *quote_.* *quote.* *E29* |
| 1311 | ". Contains the last inserted text (the same as what is inserted |
| 1312 | with the insert mode commands CTRL-A and CTRL-@). Note: this |
| 1313 | doesn't work with CTRL-R on the command-line. It works a bit |
| 1314 | differently, like inserting the text instead of putting it |
| 1315 | ('textwidth' and other options affect what is inserted). |
| 1316 | *quote_%* *quote%* |
| 1317 | "% Contains the name of the current file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1318 | *quote_:* *quote:* *E30* |
| 1319 | ": Contains the most recent executed command-line. Example: Use |
| 1320 | "@:" to repeat the previous command-line command. |
| 1321 | The command-line is only stored in this register when at least |
| 1322 | one character of it was typed. Thus it remains unchanged if |
| 1323 | the command was completely from a mapping. |
| 1324 | {not available when compiled without the |+cmdline_hist| |
| 1325 | feature} |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1326 | *quote_#* *quote#* |
| 1327 | 6. Alternate file register "# |
| 1328 | Contains the name of the alternate file for the current window. It will |
| 1329 | change how the |CTRL-^| command works. |
| 1330 | This register is writable, mainly to allow for restoring it after a plugin has |
| 1331 | changed it. It accepts buffer number: > |
| 1332 | let altbuf = bufnr(@#) |
| 1333 | ... |
| 1334 | let @# = altbuf |
| 1335 | It will give error |E86| if you pass buffer number and this buffer does not |
| 1336 | exist. |
| 1337 | It can also accept a match with an existing buffer name: > |
| 1338 | let @# = 'buffer_name' |
| 1339 | Error |E93| if there is more than one buffer matching the given name or |E94| |
| 1340 | if none of buffers matches the given name. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1341 | |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1342 | 7. Expression register "= *quote_=* *quote=* *@=* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1343 | This is not really a register that stores text, but is a way to use an |
| 1344 | expression in commands which use a register. The expression register is |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 1345 | read-write. |
| 1346 | |
| 1347 | When typing the '=' after " or CTRL-R the cursor moves to the command-line, |
| 1348 | where you can enter any expression (see |expression|). All normal |
| 1349 | command-line editing commands are available, including a special history for |
| 1350 | expressions. When you end the command-line by typing <CR>, Vim computes the |
| 1351 | result of the expression. If you end it with <Esc>, Vim abandons the |
| 1352 | expression. If you do not enter an expression, Vim uses the previous |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1353 | expression (like with the "/" command). |
| 1354 | |
| 1355 | The expression must evaluate to a String. A Number is always automatically |
| 1356 | converted to a String. For the "p" and ":put" command, if the result is a |
| 1357 | Float it's converted into a String. If the result is a List each element is |
Yegappan Lakshmanan | f01493c | 2024-04-14 23:21:02 +0200 | [diff] [blame] | 1358 | turned into a String and used as a line. A Dictionary is converted into a |
h-east | 53753f6 | 2024-05-05 18:42:31 +0200 | [diff] [blame] | 1359 | String. A Funcref results in an error message (use string() to convert). |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1360 | |
| 1361 | If the "= register is used for the "p" command, the String is split up at <NL> |
| 1362 | characters. If the String ends in a <NL>, it is regarded as a linewise |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1363 | register. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1364 | |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1365 | 8. Selection and drop registers "*, "+ and "~ |
Bram Moolenaar | 06b5d51 | 2010-05-22 15:37:44 +0200 | [diff] [blame] | 1366 | Use these registers for storing and retrieving the selected text for the GUI. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1367 | See |quotestar| and |quoteplus|. When the clipboard is not available or not |
Bram Moolenaar | f4d1145 | 2005-12-02 00:46:37 +0000 | [diff] [blame] | 1368 | working, the unnamed register is used instead. For Unix systems the clipboard |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1369 | is only available when the |+xterm_clipboard| feature is present. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1370 | |
| 1371 | Note that there is only a distinction between "* and "+ for X11 systems. For |
| 1372 | an explanation of the difference, see |x11-selection|. Under MS-Windows, use |
| 1373 | of "* and "+ is actually synonymous and refers to the |gui-clipboard|. |
| 1374 | |
| 1375 | *quote_~* *quote~* *<Drop>* |
| 1376 | The read-only "~ register stores the dropped text from the last drag'n'drop |
| 1377 | operation. When something has been dropped onto Vim, the "~ register is |
| 1378 | filled in and the <Drop> pseudo key is sent for notification. You can remap |
| 1379 | this key if you want; the default action (for all modes) is to insert the |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1380 | contents of the "~ register at the cursor position. |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1381 | {only available when compiled with the |+dnd| feature, currently only with the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1382 | GTK GUI} |
| 1383 | |
| 1384 | Note: The "~ register is only used when dropping plain text onto Vim. |
| 1385 | Drag'n'drop of URI lists is handled internally. |
| 1386 | |
Bram Moolenaar | 3b3a949 | 2015-01-27 18:44:16 +0100 | [diff] [blame] | 1387 | 9. Black hole register "_ *quote_* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1388 | When writing to this register, nothing happens. This can be used to delete |
| 1389 | text without affecting the normal registers. When reading from this register, |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1390 | nothing is returned. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1391 | |
Bram Moolenaar | 5be4cee | 2019-09-27 19:34:08 +0200 | [diff] [blame] | 1392 | 10. Last search pattern register "/ *quote_/* *quote/* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1393 | Contains the most recent search-pattern. This is used for "n" and 'hlsearch'. |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1394 | It is writable with `:let`, you can change it to have 'hlsearch' highlight |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1395 | other matches without actually searching. You can't yank or delete into this |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1396 | register. The search direction is available in |v:searchforward|. |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 1397 | Note that the value is restored when returning from a function |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1398 | |function-search-undo|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1399 | |
| 1400 | *@/* |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1401 | You can write to a register with a `:let` command |:let-@|. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1402 | :let @/ = "the" |
| 1403 | |
| 1404 | If you use a put command without specifying a register, Vim uses the register |
| 1405 | that was last filled (this is also the contents of the unnamed register). If |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1406 | you are confused, use the `:dis` command to find out what Vim will put (this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1407 | command displays all named and numbered registers; the unnamed register is |
| 1408 | labelled '"'). |
| 1409 | |
| 1410 | The next three commands always work on whole lines. |
| 1411 | |
| 1412 | :[range]co[py] {address} *:co* *:copy* |
| 1413 | Copy the lines given by [range] to below the line |
| 1414 | given by {address}. |
| 1415 | |
| 1416 | *:t* |
| 1417 | :t Synonym for copy. |
Bram Moolenaar | a4d131d | 2021-12-27 21:33:07 +0000 | [diff] [blame] | 1418 | This command is not supported in |Vim9| script, |
| 1419 | because it is too easily confused with a variable |
| 1420 | name. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1421 | |
| 1422 | :[range]m[ove] {address} *:m* *:mo* *:move* *E134* |
| 1423 | Move the lines given by [range] to below the line |
| 1424 | given by {address}. |
h-east | 52e7cc2 | 2024-07-28 17:03:29 +0200 | [diff] [blame] | 1425 | Any text properties in [range] are cleared. See |
Christian Brabandt | 946f61c | 2024-06-17 13:17:58 +0200 | [diff] [blame] | 1426 | |text-prop-cleared|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1427 | |
| 1428 | ============================================================================== |
| 1429 | 6. Formatting text *formatting* |
| 1430 | |
| 1431 | :[range]ce[nter] [width] *:ce* *:center* |
| 1432 | Center lines in [range] between [width] columns |
| 1433 | (default 'textwidth' or 80 when 'textwidth' is 0). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1434 | |
| 1435 | :[range]ri[ght] [width] *:ri* *:right* |
| 1436 | Right-align lines in [range] at [width] columns |
| 1437 | (default 'textwidth' or 80 when 'textwidth' is 0). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1438 | |
| 1439 | *:le* *:left* |
| 1440 | :[range]le[ft] [indent] |
| 1441 | Left-align lines in [range]. Sets the indent in the |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1442 | lines to [indent] (default 0). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1443 | |
| 1444 | *gq* |
Bram Moolenaar | 4317d9b | 2005-03-18 20:25:31 +0000 | [diff] [blame] | 1445 | gq{motion} Format the lines that {motion} moves over. |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1446 | Formatting is done with one of three methods: |
| 1447 | 1. If 'formatexpr' is not empty the expression is |
| 1448 | evaluated. This can differ for each buffer. |
Bram Moolenaar | 4c7ed46 | 2006-02-15 22:18:42 +0000 | [diff] [blame] | 1449 | 2. If 'formatprg' is not empty an external program |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1450 | is used. |
Bram Moolenaar | 551dbcc | 2006-04-25 22:13:59 +0000 | [diff] [blame] | 1451 | 3. Otherwise formatting is done internally. |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1452 | |
| 1453 | In the third case the 'textwidth' option controls the |
| 1454 | length of each formatted line (see below). |
Bram Moolenaar | 4317d9b | 2005-03-18 20:25:31 +0000 | [diff] [blame] | 1455 | If the 'textwidth' option is 0, the formatted line |
| 1456 | length is the screen width (with a maximum width of |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1457 | 79). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1458 | The 'formatoptions' option controls the type of |
| 1459 | formatting |fo-table|. |
Bram Moolenaar | 4317d9b | 2005-03-18 20:25:31 +0000 | [diff] [blame] | 1460 | The cursor is left on the first non-blank of the last |
| 1461 | formatted line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1462 | NOTE: The "Q" command formerly performed this |
| 1463 | function. If you still want to use "Q" for |
| 1464 | formatting, use this mapping: > |
| 1465 | :nnoremap Q gq |
| 1466 | |
| 1467 | gqgq *gqgq* *gqq* |
Bram Moolenaar | 40af4e3 | 2010-07-29 22:33:18 +0200 | [diff] [blame] | 1468 | gqq Format the current line. With a count format that |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1469 | many lines. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1470 | |
| 1471 | *v_gq* |
| 1472 | {Visual}gq Format the highlighted text. (for {Visual} see |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1473 | |Visual-mode|). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1474 | |
| 1475 | *gw* |
| 1476 | gw{motion} Format the lines that {motion} moves over. Similar to |
| 1477 | |gq| but puts the cursor back at the same position in |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1478 | the text. However, 'formatprg' and 'formatexpr' are |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1479 | not used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1480 | |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1481 | gwgw *gwgw* *gww* |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1482 | gww Format the current line as with "gw". |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1483 | |
| 1484 | *v_gw* |
| 1485 | {Visual}gw Format the highlighted text as with "gw". (for |
Bram Moolenaar | 25c9c68 | 2019-05-05 18:13:34 +0200 | [diff] [blame] | 1486 | {Visual} see |Visual-mode|). |
Bram Moolenaar | 69a7cb4 | 2004-06-20 12:51:53 +0000 | [diff] [blame] | 1487 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1488 | Example: To format the current paragraph use: *gqap* > |
| 1489 | gqap |
| 1490 | |
| 1491 | The "gq" command leaves the cursor in the line where the motion command takes |
| 1492 | the cursor. This allows you to repeat formatting repeated with ".". This |
| 1493 | works well with "gqj" (format current and next line) and "gq}" (format until |
| 1494 | end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on |
| 1495 | the first formatted line (as with using a filter command). |
| 1496 | |
| 1497 | If you want to format the current paragraph and continue where you were, use: > |
| 1498 | gwap |
| 1499 | If you always want to keep paragraphs formatted you may want to add the 'a' |
| 1500 | flag to 'formatoptions'. See |auto-format|. |
| 1501 | |
| 1502 | If the 'autoindent' option is on, Vim uses the indent of the first line for |
| 1503 | the following lines. |
| 1504 | |
| 1505 | Formatting does not change empty lines (but it does change lines with only |
| 1506 | white space!). |
| 1507 | |
| 1508 | The 'joinspaces' option is used when lines are joined together. |
| 1509 | |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 1510 | You can set the 'formatexpr' option to an expression or the 'formatprg' option |
| 1511 | to the name of an external program for Vim to use for text formatting. The |
| 1512 | 'textwidth' and other options have no effect on formatting by an external |
| 1513 | program. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1514 | |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1515 | *format-formatexpr* |
Bram Moolenaar | d473c8c | 2018-08-11 18:00:22 +0200 | [diff] [blame] | 1516 | The 'formatexpr' option can be set to a Vim script function that performs |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1517 | reformatting of the buffer. This should usually happen in an |ftplugin|, |
| 1518 | since formatting is highly dependent on the type of file. It makes |
| 1519 | sense to use an |autoload| script, so the corresponding script is only loaded |
| 1520 | when actually needed and the script should be called <filetype>format.vim. |
| 1521 | |
Antonio Giovanni Colombo | 41d6de2 | 2024-12-15 21:17:49 +0100 | [diff] [blame] | 1522 | For example, the XML filetype plugin distributed with Vim in the |
| 1523 | $VIMRUNTIME/ftplugin directory, sets the 'formatexpr' option to: > |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1524 | |
| 1525 | setlocal formatexpr=xmlformat#Format() |
| 1526 | |
| 1527 | That means, you will find the corresponding script, defining the |
Antonio Giovanni Colombo | 41d6de2 | 2024-12-15 21:17:49 +0100 | [diff] [blame] | 1528 | xmlformat#Format() function, in the file `$VIMRUNTIME/autoload/xmlformat.vim` |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1529 | |
| 1530 | Here is an example script that removes trailing whitespace from the selected |
Antonio Giovanni Colombo | 41d6de2 | 2024-12-15 21:17:49 +0100 | [diff] [blame] | 1531 | text. Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: |
| 1532 | >vim |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1533 | func! format#Format() |
| 1534 | " only reformat on explicit gq command |
| 1535 | if mode() != 'n' |
Bram Moolenaar | d1caa94 | 2020-04-10 22:10:56 +0200 | [diff] [blame] | 1536 | " fall back to Vim's internal reformatting |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1537 | return 1 |
| 1538 | endif |
| 1539 | let lines = getline(v:lnum, v:lnum + v:count - 1) |
| 1540 | call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')}) |
| 1541 | call setline('.', lines) |
| 1542 | |
| 1543 | " do not run internal formatter! |
| 1544 | return 0 |
| 1545 | endfunc |
| 1546 | |
| 1547 | You can then enable the formatting by executing: > |
| 1548 | setlocal formatexpr=format#Format() |
Bram Moolenaar | d473c8c | 2018-08-11 18:00:22 +0200 | [diff] [blame] | 1549 | |
Bram Moolenaar | 7db25fe | 2018-05-13 00:02:36 +0200 | [diff] [blame] | 1550 | Note: this function explicitly returns non-zero when called from insert mode |
| 1551 | (which basically means, text is inserted beyond the 'textwidth' limit). This |
| 1552 | causes Vim to fall back to reformat the text by using the internal formatter. |
| 1553 | |
| 1554 | However, if the |gq| command is used to reformat the text, the function |
| 1555 | will receive the selected lines, trim trailing whitespace from those lines and |
| 1556 | put them back in place. If you are going to split single lines into multiple |
| 1557 | lines, be careful not to overwrite anything. |
| 1558 | |
| 1559 | If you want to allow reformatting of text from insert or replace mode, one has |
| 1560 | to be very careful, because the function might be called recursively. For |
| 1561 | debugging it helps to set the 'debug' option. |
| 1562 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1563 | *right-justify* |
| 1564 | There is no command in Vim to right justify text. You can do it with |
Antonio Giovanni Colombo | 41d6de2 | 2024-12-15 21:17:49 +0100 | [diff] [blame] | 1565 | an external command, like "par" (e.g.: `:.,}!par` to format until the end of the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1566 | paragraph) or set 'formatprg' to "par". |
| 1567 | |
| 1568 | *format-comments* |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1569 | An overview of comment formatting is in section |30.6| of the user manual. |
| 1570 | |
| 1571 | Vim can automatically insert and format comments in a special way. Vim |
| 1572 | recognizes a comment by a specific string at the start of the line (ignoring |
| 1573 | white space). Three types of comments can be used: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1574 | |
| 1575 | - A comment string that repeats at the start of each line. An example is the |
| 1576 | type of comment used in shell scripts, starting with "#". |
| 1577 | - A comment string that occurs only in the first line, not in the following |
| 1578 | lines. An example is this list with dashes. |
| 1579 | - Three-piece comments that have a start string, an end string, and optional |
| 1580 | lines in between. The strings for the start, middle and end are different. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1581 | An example is the C style comment: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1582 | /* |
| 1583 | * this is a C comment |
| 1584 | */ |
| 1585 | |
| 1586 | The 'comments' option is a comma-separated list of parts. Each part defines a |
| 1587 | type of comment string. A part consists of: |
| 1588 | {flags}:{string} |
| 1589 | |
| 1590 | {string} is the literal text that must appear. |
| 1591 | |
| 1592 | {flags}: |
| 1593 | n Nested comment. Nesting with mixed parts is allowed. If 'comments' |
| 1594 | is "n:),n:>" a line starting with "> ) >" is a comment. |
| 1595 | |
| 1596 | b Blank (<Space>, <Tab> or <EOL>) required after {string}. |
| 1597 | |
| 1598 | f Only the first line has the comment string. Do not repeat comment on |
| 1599 | the next line, but preserve indentation (e.g., a bullet-list). |
| 1600 | |
| 1601 | s Start of three-piece comment |
| 1602 | |
| 1603 | m Middle of a three-piece comment |
| 1604 | |
| 1605 | e End of a three-piece comment |
| 1606 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1607 | l Left align. Used together with 's' or 'e', the leftmost character of |
| 1608 | start or end will line up with the leftmost character from the middle. |
| 1609 | This is the default and can be omitted. See below for more details. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1610 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1611 | r Right align. Same as above but rightmost instead of leftmost. See |
| 1612 | below for more details. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1613 | |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1614 | O Don't consider this comment for the "O" command. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1615 | |
| 1616 | x Allows three-piece comments to be ended by just typing the last |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1617 | character of the end-comment string as the first action on a new |
| 1618 | line when the middle-comment string has been inserted automatically. |
| 1619 | See below for more details. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1620 | |
| 1621 | {digits} |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1622 | When together with 's' or 'e': add {digit} amount of offset to an |
| 1623 | automatically inserted middle or end comment leader. The offset begins |
| 1624 | from a left alignment. See below for more details. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1625 | |
| 1626 | -{digits} |
| 1627 | Like {digits} but reduce the indent. This only works when there is |
| 1628 | some indent for the start or end part that can be removed. |
| 1629 | |
| 1630 | When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the |
Antonio Giovanni Colombo | 41d6de2 | 2024-12-15 21:17:49 +0100 | [diff] [blame] | 1631 | comment string repeats at the start of each line. The {flags} field may be |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1632 | empty. |
| 1633 | |
| 1634 | Any blank space in the text before and after the {string} is part of the |
| 1635 | {string}, so do not include leading or trailing blanks unless the blanks are a |
| 1636 | required part of the comment string. |
| 1637 | |
| 1638 | When one comment leader is part of another, specify the part after the whole. |
| 1639 | For example, to include both "-" and "->", use > |
| 1640 | :set comments=f:->,f:- |
| 1641 | |
| 1642 | A three-piece comment must always be given as start,middle,end, with no other |
| 1643 | parts in between. An example of a three-piece comment is > |
| 1644 | sr:/*,mb:*,ex:*/ |
| 1645 | for C-comments. To avoid recognizing "*ptr" as a comment, the middle string |
| 1646 | includes the 'b' flag. For three-piece comments, Vim checks the text after |
| 1647 | the start and middle strings for the end string. If Vim finds the end string, |
| 1648 | the comment does not continue on the next line. Three-piece comments must |
| 1649 | have a middle string because otherwise Vim can't recognize the middle lines. |
| 1650 | |
| 1651 | Notice the use of the "x" flag in the above three-piece comment definition. |
| 1652 | When you hit Return in a C-comment, Vim will insert the middle comment leader |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1653 | for the new line: " * ". To close this comment you just have to type "/" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1654 | before typing anything else on the new line. This will replace the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1655 | middle-comment leader with the end-comment leader and apply any specified |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 1656 | alignment, leaving just " */". There is no need to hit Backspace first. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1657 | |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 1658 | When there is a match with a middle part, but there also is a matching end |
| 1659 | part which is longer, the end part is used. This makes a C style comment work |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 1660 | without requiring the middle part to end with a space. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1661 | |
| 1662 | Here is an example of alignment flags at work to make a comment stand out |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 1663 | (kind of looks like a 1 too). Consider comment string: > |
| 1664 | :set comments=sr:/***,m:**,ex-2:******/ |
| 1665 | < |
| 1666 | /*** ~ |
| 1667 | **<--right aligned from "r" flag ~ |
| 1668 | ** ~ |
| 1669 | offset 2 spaces for the "-2" flag--->** ~ |
| 1670 | ******/ ~ |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1671 | In this case, the first comment was typed, then return was pressed 4 times, |
| 1672 | then "/" was pressed to end the comment. |
| 1673 | |
| 1674 | Here are some finer points of three part comments. There are three times when |
| 1675 | alignment and offset flags are taken into consideration: opening a new line |
| 1676 | after a start-comment, opening a new line before an end-comment, and |
| 1677 | automatically ending a three-piece comment. The end alignment flag has a |
| 1678 | backwards perspective; the result is that the same alignment flag used with |
| 1679 | "s" and "e" will result in the same indent for the starting and ending pieces. |
| 1680 | Only one alignment per comment part is meant to be used, but an offset number |
| 1681 | will override the "r" and "l" flag. |
| 1682 | |
| 1683 | Enabling 'cindent' will override the alignment flags in many cases. |
| 1684 | Reindenting using a different method like |gq| or |=| will not consult |
| 1685 | alignment flags either. The same behaviour can be defined in those other |
| 1686 | formatting options. One consideration is that 'cindent' has additional options |
| 1687 | for context based indenting of comments but cannot replicate many three piece |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 1688 | indent alignments. However, 'indentexpr' has the ability to work better with |
| 1689 | three piece comments. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1690 | |
| 1691 | Other examples: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1692 | "b:*" Includes lines starting with "*", but not if the "*" is |
| 1693 | followed by a non-blank. This avoids a pointer dereference |
| 1694 | like "*str" to be recognized as a comment. |
| 1695 | "n:>" Includes a line starting with ">", ">>", ">>>", etc. |
| 1696 | "fb:-" Format a list that starts with "- ". |
| 1697 | |
| 1698 | By default, "b:#" is included. This means that a line that starts with |
| 1699 | "#include" is not recognized as a comment line. But a line that starts with |
| 1700 | "# define" is recognized. This is a compromise. |
| 1701 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1702 | *fo-table* |
| 1703 | You can use the 'formatoptions' option to influence how Vim formats text. |
| 1704 | 'formatoptions' is a string that can contain any of the letters below. The |
| 1705 | default setting is "tcq". You can separate the option letters with commas for |
| 1706 | readability. |
| 1707 | |
| 1708 | letter meaning when present in 'formatoptions' ~ |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1709 | *fo-t* |
Bram Moolenaar | 2bf875f | 2022-05-07 14:54:11 +0100 | [diff] [blame] | 1710 | t Auto-wrap text using 'textwidth' |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1711 | *fo-c* |
Bram Moolenaar | 2bf875f | 2022-05-07 14:54:11 +0100 | [diff] [blame] | 1712 | c Auto-wrap comments using 'textwidth', inserting the current comment |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1713 | leader automatically. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1714 | *fo-r* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1715 | r Automatically insert the current comment leader after hitting |
| 1716 | <Enter> in Insert mode. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1717 | *fo-o* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1718 | o Automatically insert the current comment leader after hitting 'o' or |
Bram Moolenaar | 04fb916 | 2021-12-30 20:24:12 +0000 | [diff] [blame] | 1719 | 'O' in Normal mode. In case comment is unwanted in a specific place |
| 1720 | use CTRL-U to quickly delete it. |i_CTRL-U| |
Bram Moolenaar | 2bf875f | 2022-05-07 14:54:11 +0100 | [diff] [blame] | 1721 | *fo-/* |
| 1722 | / When 'o' is included: do not insert the comment leader for a // |
| 1723 | comment after a statement, only when // is at the start of the line. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1724 | *fo-q* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1725 | q Allow formatting of comments with "gq". |
| 1726 | Note that formatting will not change blank lines or lines containing |
| 1727 | only the comment leader. A new paragraph starts after such a line, |
| 1728 | or when the comment leader changes. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1729 | *fo-w* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1730 | w Trailing white space indicates a paragraph continues in the next line. |
| 1731 | A line that ends in a non-white character ends a paragraph. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1732 | *fo-a* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1733 | a Automatic formatting of paragraphs. Every time text is inserted or |
| 1734 | deleted the paragraph will be reformatted. See |auto-format|. |
| 1735 | When the 'c' flag is present this only happens for recognized |
| 1736 | comments. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1737 | *fo-n* |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 1738 | n When formatting text, recognize numbered lists. This actually uses |
| 1739 | the 'formatlistpat' option, thus any kind of list can be used. The |
| 1740 | indent of the text after the number is used for the next line. The |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1741 | default is to find a number, optionally followed by '.', ':', ')', |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 1742 | ']' or '}'. Note that 'autoindent' must be set too. Doesn't work |
| 1743 | well together with "2". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1744 | Example: > |
| 1745 | 1. the first item |
| 1746 | wraps |
| 1747 | 2. the second item |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1748 | < *fo-2* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1749 | 2 When formatting text, use the indent of the second line of a paragraph |
| 1750 | for the rest of the paragraph, instead of the indent of the first |
| 1751 | line. This supports paragraphs in which the first line has a |
| 1752 | different indent than the rest. Note that 'autoindent' must be set |
| 1753 | too. Example: > |
| 1754 | first line of a paragraph |
| 1755 | second line of the same paragraph |
| 1756 | third line. |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 1757 | < This also works inside comments, ignoring the comment leader. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1758 | *fo-v* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1759 | v Vi-compatible auto-wrapping in insert mode: Only break a line at a |
| 1760 | blank that you have entered during the current insert command. (Note: |
| 1761 | this is not 100% Vi compatible. Vi has some "unexpected features" or |
| 1762 | bugs in this area. It uses the screen column instead of the line |
| 1763 | column.) |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1764 | *fo-b* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1765 | b Like 'v', but only auto-wrap if you enter a blank at or before |
| 1766 | the wrap margin. If the line was longer than 'textwidth' when you |
| 1767 | started the insert, or you do not enter a blank in the insert before |
| 1768 | reaching 'textwidth', Vim does not perform auto-wrapping. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1769 | *fo-l* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1770 | l Long lines are not broken in insert mode: When a line was longer than |
| 1771 | 'textwidth' when the insert command started, Vim does not |
| 1772 | automatically format it. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1773 | *fo-m* |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1774 | m Also break at a multibyte character above 255. This is useful for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1775 | Asian text where every character is a word on its own. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1776 | *fo-M* |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1777 | M When joining lines, don't insert a space before or after a multibyte |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1778 | character. Overrules the 'B' flag. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1779 | *fo-B* |
Bram Moolenaar | 207f009 | 2020-08-30 17:20:20 +0200 | [diff] [blame] | 1780 | B When joining lines, don't insert a space between two multibyte |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1781 | characters. Overruled by the 'M' flag. |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1782 | *fo-1* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1783 | 1 Don't break a line after a one-letter word. It's broken before it |
| 1784 | instead (if possible). |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1785 | *fo-]* |
Bram Moolenaar | 2bf875f | 2022-05-07 14:54:11 +0100 | [diff] [blame] | 1786 | ] Respect 'textwidth' rigorously. With this flag set, no line can be |
| 1787 | longer than 'textwidth', unless line-break-prohibition rules make this |
Bram Moolenaar | e52702f | 2020-06-04 18:22:13 +0200 | [diff] [blame] | 1788 | impossible. Mainly for CJK scripts and works only if 'encoding' is |
| 1789 | "utf-8". |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1790 | *fo-j* |
Bram Moolenaar | 8134039 | 2012-06-06 16:12:59 +0200 | [diff] [blame] | 1791 | j Where it makes sense, remove a comment leader when joining lines. For |
| 1792 | example, joining: |
| 1793 | int i; // the index ~ |
| 1794 | // in the list ~ |
| 1795 | Becomes: |
| 1796 | int i; // the index in the list ~ |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 1797 | *fo-p* |
Bram Moolenaar | c3c3158 | 2019-01-11 22:15:05 +0100 | [diff] [blame] | 1798 | p Don't break lines at single spaces that follow periods. This is |
| 1799 | intended to complement 'joinspaces' and |cpo-J|, for prose with |
| 1800 | sentences separated by two spaces. For example, with 'textwidth' set |
| 1801 | to 28: > |
| 1802 | Surely you're joking, Mr. Feynman! |
| 1803 | < Becomes: > |
| 1804 | Surely you're joking, |
| 1805 | Mr. Feynman! |
| 1806 | < Instead of: > |
| 1807 | Surely you're joking, Mr. |
| 1808 | Feynman! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1809 | |
| 1810 | |
| 1811 | With 't' and 'c' you can specify when Vim performs auto-wrapping: |
| 1812 | value action ~ |
| 1813 | "" no automatic formatting (you can use "gq" for manual formatting) |
| 1814 | "t" automatic formatting of text, but not comments |
| 1815 | "c" automatic formatting for comments, but not text (good for C code) |
| 1816 | "tc" automatic formatting for text and comments |
| 1817 | |
Bram Moolenaar | 91170f8 | 2006-05-05 21:15:17 +0000 | [diff] [blame] | 1818 | Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but |
| 1819 | does insert comment leaders according to the 'comments' option). An exception |
| 1820 | is when the 'a' flag is present. |auto-format| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1821 | |
| 1822 | Note that when 'paste' is on, Vim does no formatting at all. |
| 1823 | |
| 1824 | Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping; |
| 1825 | 'textwidth' is still useful for formatting with "gq". |
| 1826 | |
| 1827 | If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some |
| 1828 | built in stuff to treat these types of comments a bit more cleverly. |
| 1829 | Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in |
| 1830 | 'formatoptions') gives the correct start of the line automatically. The same |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 1831 | happens with formatting and auto-wrapping. Opening a line after a line |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1832 | starting with "/*" or "*" and containing "*/", will cause no comment leader to |
| 1833 | be inserted, and the indent of the new line is taken from the line containing |
| 1834 | the start of the comment. |
| 1835 | E.g.: |
| 1836 | /* ~ |
| 1837 | * Your typical comment. ~ |
| 1838 | */ ~ |
| 1839 | The indent on this line is the same as the start of the above |
| 1840 | comment. |
| 1841 | |
| 1842 | All of this should be really cool, especially in conjunction with the new |
| 1843 | :autocmd command to prepare different settings for different types of file. |
| 1844 | |
| 1845 | Some examples: |
| 1846 | for C code (only format comments): > |
| 1847 | :set fo=croq |
| 1848 | < for Mail/news (format all, don't start comment with "o" command): > |
| 1849 | :set fo=tcrq |
| 1850 | < |
| 1851 | |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1852 | Automatic formatting *auto-format* *autoformat* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1853 | |
| 1854 | When the 'a' flag is present in 'formatoptions' text is formatted |
Bram Moolenaar | 2547aa9 | 2020-07-26 17:00:44 +0200 | [diff] [blame] | 1855 | automatically when inserting text or deleting text. This works nicely for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1856 | editing text paragraphs. A few hints on how to use this: |
| 1857 | |
| 1858 | - You need to properly define paragraphs. The simplest is paragraphs that are |
| 1859 | separated by a blank line. When there is no separating blank line, consider |
| 1860 | using the 'w' flag and adding a space at the end of each line in the |
| 1861 | paragraphs except the last one. |
| 1862 | |
| 1863 | - You can set the 'formatoptions' based on the type of file |filetype| or |
| 1864 | specifically for one file with a |modeline|. |
| 1865 | |
| 1866 | - Set 'formatoptions' to "aw2tq" to make text with indents like this: |
| 1867 | |
Bram Moolenaar | dd60c36 | 2023-02-27 15:49:53 +0000 | [diff] [blame] | 1868 | bla bla foobar bla |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1869 | bla foobar bla foobar bla |
Bram Moolenaar | dd60c36 | 2023-02-27 15:49:53 +0000 | [diff] [blame] | 1870 | bla bla foobar bla |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1871 | bla foobar bla bla foobar |
| 1872 | |
| 1873 | - Add the 'c' flag to only auto-format comments. Useful in source code. |
| 1874 | |
Bram Moolenaar | 91170f8 | 2006-05-05 21:15:17 +0000 | [diff] [blame] | 1875 | - Set 'textwidth' to the desired width. If it is zero then 79 is used, or the |
| 1876 | width of the screen if this is smaller. |
| 1877 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1878 | And a few warnings: |
| 1879 | |
| 1880 | - When part of the text is not properly separated in paragraphs, making |
| 1881 | changes in this text will cause it to be formatted anyway. Consider doing > |
| 1882 | |
| 1883 | :set fo-=a |
| 1884 | |
| 1885 | - When using the 'w' flag (trailing space means paragraph continues) and |
| 1886 | deleting the last line of a paragraph with |dd|, the paragraph will be |
| 1887 | joined with the next one. |
| 1888 | |
| 1889 | - Changed text is saved for undo. Formatting is also a change. Thus each |
| 1890 | format action saves text for undo. This may consume quite a lot of memory. |
| 1891 | |
| 1892 | - Formatting a long paragraph and/or with complicated indenting may be slow. |
| 1893 | |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 1894 | ============================================================================== |
| 1895 | 7. Sorting text *sorting* |
| 1896 | |
| 1897 | Vim has a sorting function and a sorting command. The sorting function can be |
Bram Moolenaar | 327aa02 | 2014-03-25 18:24:23 +0100 | [diff] [blame] | 1898 | found here: |sort()|, |uniq()|. |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 1899 | Also see |:uniq|. |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 1900 | |
| 1901 | *:sor* *:sort* |
Bram Moolenaar | 55e2961 | 2020-11-01 13:57:44 +0100 | [diff] [blame] | 1902 | :[range]sor[t][!] [b][f][i][l][n][o][r][u][x] [/{pattern}/] |
Bram Moolenaar | e518052 | 2005-12-10 20:19:46 +0000 | [diff] [blame] | 1903 | Sort lines in [range]. When no range is given all |
| 1904 | lines are sorted. |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 1905 | |
| 1906 | With [!] the order is reversed. |
| 1907 | |
| 1908 | With [i] case is ignored. |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 1909 | *:sort-l* |
Bram Moolenaar | 3132cdd | 2020-11-05 20:41:49 +0100 | [diff] [blame] | 1910 | With [l] sort uses the current collation locale. |
| 1911 | Implementation details: strcoll() is used to compare |
| 1912 | strings. See |:language| to check or set the collation |
| 1913 | locale. Example: > |
| 1914 | :language collate en_US.UTF-8 |
| 1915 | :%sort l |
| 1916 | < |v:collate| can also used to check the current locale. |
| 1917 | Sorting using the locale typically ignores case. |
| 1918 | This does not work properly on Mac. |
Bram Moolenaar | 55e2961 | 2020-11-01 13:57:44 +0100 | [diff] [blame] | 1919 | |
Bram Moolenaar | f7edf40 | 2016-01-19 23:36:15 +0100 | [diff] [blame] | 1920 | Options [n][f][x][o][b] are mutually exclusive. |
| 1921 | |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1922 | With [n] sorting is done on the first decimal number |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1923 | in the line (after or inside a {pattern} match). |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 1924 | One leading '-' is included in the number. |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1925 | |
Bram Moolenaar | f7edf40 | 2016-01-19 23:36:15 +0100 | [diff] [blame] | 1926 | With [f] sorting is done on the Float in the line. |
| 1927 | The value of Float is determined similar to passing |
| 1928 | the text (after or inside a {pattern} match) to |
| 1929 | str2float() function. This option is available only |
| 1930 | if Vim was compiled with Floating point support. |
| 1931 | |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1932 | With [x] sorting is done on the first hexadecimal |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1933 | number in the line (after or inside a {pattern} |
| 1934 | match). A leading "0x" or "0X" is ignored. |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 1935 | One leading '-' is included in the number. |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1936 | |
| 1937 | With [o] sorting is done on the first octal number in |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1938 | the line (after or inside a {pattern} match). |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1939 | |
Bram Moolenaar | 887c1fe | 2016-01-02 17:56:35 +0100 | [diff] [blame] | 1940 | With [b] sorting is done on the first binary number in |
| 1941 | the line (after or inside a {pattern} match). |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 1942 | *:sort-u* *:sort-uniq* |
Bram Moolenaar | f7edf40 | 2016-01-19 23:36:15 +0100 | [diff] [blame] | 1943 | With [u] (u stands for unique) only keep the first of |
| 1944 | a sequence of identical lines (ignoring case when [i] |
| 1945 | is used). Without this flag, a sequence of identical |
| 1946 | lines will be kept in their original order. |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1947 | Note that leading and trailing white space may cause |
| 1948 | lines to be different. |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 1949 | When you just want to make things unique, use |:uniq|. |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 1950 | |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1951 | When /{pattern}/ is specified and there is no [r] flag |
| 1952 | the text matched with {pattern} is skipped, so that |
| 1953 | you sort on what comes after the match. |
Bram Moolenaar | 4466ad6 | 2020-11-21 13:16:30 +0100 | [diff] [blame] | 1954 | 'ignorecase' applies to the pattern, but 'smartcase' |
| 1955 | is not used. |
Bram Moolenaar | 2389c3c | 2005-05-22 22:07:59 +0000 | [diff] [blame] | 1956 | Instead of the slash any non-letter can be used. |
| 1957 | For example, to sort on the second comma-separated |
| 1958 | field: > |
| 1959 | :sort /[^,]*,/ |
| 1960 | < To sort on the text at virtual column 10 (thus |
| 1961 | ignoring the difference between tabs and spaces): > |
| 1962 | :sort /.*\%10v/ |
Bram Moolenaar | c6fe919 | 2006-04-09 21:54:49 +0000 | [diff] [blame] | 1963 | < To sort on the first number in the line, no matter |
| 1964 | what is in front of it: > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1965 | :sort /.\{-}\ze\d/ |
| 1966 | < (Explanation: ".\{-}" matches any text, "\ze" sets the |
| 1967 | end of the match and \d matches a digit.) |
| 1968 | With [r] sorting is done on the matching {pattern} |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1969 | instead of skipping past it as described above. |
| 1970 | For example, to sort on only the first three letters |
| 1971 | of each line: > |
| 1972 | :sort /\a\a\a/ r |
| 1973 | |
| 1974 | < If a {pattern} is used, any lines which don't have a |
| 1975 | match for {pattern} are kept in their current order, |
| 1976 | but separate from the lines which do match {pattern}. |
| 1977 | If you sorted in reverse, they will be in reverse |
| 1978 | order after the sorted lines, otherwise they will be |
| 1979 | in their original order, right before the sorted |
| 1980 | lines. |
| 1981 | |
Bram Moolenaar | 1256e72 | 2007-07-10 15:26:20 +0000 | [diff] [blame] | 1982 | If {pattern} is empty (e.g. // is specified), the |
| 1983 | last search pattern is used. This allows trying out |
| 1984 | a pattern first. |
| 1985 | |
Bram Moolenaar | d38b055 | 2012-04-25 19:07:41 +0200 | [diff] [blame] | 1986 | Note that using `:sort` with `:global` doesn't sort the matching lines, it's |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 1987 | quite useless. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1988 | |
Bram Moolenaar | 55e2961 | 2020-11-01 13:57:44 +0100 | [diff] [blame] | 1989 | `:sort` does not use the current locale unless the l flag is used. |
Bram Moolenaar | 8bb1c3e | 2014-07-04 16:43:17 +0200 | [diff] [blame] | 1990 | Vim does do a "stable" sort. |
Bram Moolenaar | f461c8e | 2005-06-25 23:04:51 +0000 | [diff] [blame] | 1991 | |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 1992 | The sorting can be interrupted, but if you interrupt it too late in the |
| 1993 | process you may end up with duplicated lines. This also depends on the system |
| 1994 | library function used. |
Bram Moolenaar | ae5bce1 | 2005-08-15 21:41:48 +0000 | [diff] [blame] | 1995 | |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 1996 | ============================================================================== |
| 1997 | 8. Deduplicating text *deduplicating* *unique* |
| 1998 | |
| 1999 | Vim has a deduplicating function and a deduplicating command. The |
| 2000 | deduplicating function can be found here: |uniq()|. |
| 2001 | Also see |:sort-uniq|. |
| 2002 | |
| 2003 | *:uni* *:uniq* |
| 2004 | :[range]uni[q][!] [i][l][r][u] [/{pattern}/] |
| 2005 | Remove duplicate lines that are adjacent to each other |
| 2006 | in [range]. When no range is given, all lines are |
| 2007 | processed. |
| 2008 | |
| 2009 | With [i] case is ignored when comparing lines. |
| 2010 | |
| 2011 | With [l] comparison uses the current collation locale. |
| 2012 | See |:sort-l| for more details. |
| 2013 | |
| 2014 | With [r] comparison is done on the text that matches |
| 2015 | /{pattern}/ instead of the full line. |
| 2016 | |
zeertzjq | 1c471ac | 2025-06-25 21:07:25 +0200 | [diff] [blame] | 2017 | With [u] only keep lines that do not repeat (i.e., are |
| 2018 | not immediately followed by the same line). |
| 2019 | |
| 2020 | With [!] only keep lines that are immediately followed |
| 2021 | by a duplicate. |
| 2022 | |
| 2023 | If both [!] and [u] are given, [u] is ignored and [!] |
| 2024 | takes effect. |
| 2025 | |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 2026 | When /{pattern}/ is specified and [r] is not used, the |
| 2027 | text matched with {pattern} is skipped and comparison |
| 2028 | is done on what comes after the match. |
| 2029 | 'ignorecase' applies to the pattern, but 'smartcase' |
| 2030 | is not used. |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 2031 | Instead of the slash any non-letter can be used. |
| 2032 | |
| 2033 | For example, to remove adjacent duplicate lines based |
| 2034 | on the second comma-separated field: > |
Hirohito Higashi | 26ebe21 | 2025-06-26 20:31:24 +0200 | [diff] [blame] | 2035 | :uniq /[^,]*,/ |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 2036 | < Or to keep only unique lines ignoring the first 5 |
| 2037 | characters: > |
| 2038 | :uniq u /.\{5}/ |
| 2039 | < If {pattern} is empty (e.g. // is used), the last |
| 2040 | search pattern is used. |
| 2041 | |
zeertzjq | 1c471ac | 2025-06-25 21:07:25 +0200 | [diff] [blame] | 2042 | Note that leading and trailing white space may cause |
| 2043 | lines to be considered different. |
Hirohito Higashi | 74f0a77 | 2025-06-23 21:42:36 +0200 | [diff] [blame] | 2044 | To remove all duplicates regardless of position, use |
| 2045 | |:sort-u| or external tools. |
| 2046 | |
Bram Moolenaar | 91f84f6 | 2018-07-29 15:07:52 +0200 | [diff] [blame] | 2047 | vim:tw=78:ts=8:noet:ft=help:norl: |