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