Mercurial > vim
annotate runtime/doc/undo.txt @ 16553:0e473e9e70c2 v8.1.1280
patch 8.1.1280: remarks about functionality not in Vi clutters the help
commit https://github.com/vim/vim/commit/25c9c680ec4dfbb51f4ef21c3460a48d3c67ffc8
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun May 5 18:13:34 2019 +0200
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Problem: Remarks about functionality not in Vi clutters the help.
Solution: Move all info about what is new in Vim or already existed in Vi to
vi_diff.txt. Remove {not in Vi} remarks. (closes #4268) Add
"noet" to the help files modeline. Also include many other help
file improvements.
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sun, 05 May 2019 18:15:06 +0200 |
| parents | f0f06837a699 |
| children | 1eaf34420bb3 |
| rev | line source |
|---|---|
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
1 *undo.txt* For Vim version 8.1. Last change: 2019 May 05 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 Undo and redo *undo-redo* | |
| 8 | |
| 9 The basics are explained in section |02.5| of the user manual. | |
| 10 | |
| 11 1. Undo and redo commands |undo-commands| | |
| 12 2. Two ways of undo |undo-two-ways| | |
| 697 | 13 3. Undo blocks |undo-blocks| |
| 758 | 14 4. Undo branches |undo-branches| |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
15 5. Undo persistence |undo-persistence| |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
16 6. Remarks about undo |undo-remarks| |
| 7 | 17 |
| 18 ============================================================================== | |
| 19 1. Undo and redo commands *undo-commands* | |
| 20 | |
| 21 <Undo> or *undo* *<Undo>* *u* | |
| 22 u Undo [count] changes. {Vi: only one level} | |
| 23 | |
| 24 *:u* *:un* *:undo* | |
| 25 :u[ndo] Undo one change. {Vi: only one level} | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
26 *E830* |
| 772 | 27 :u[ndo] {N} Jump to after change number {N}. See |undo-branches| |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
28 for the meaning of {N}. |
| 772 | 29 |
| 7 | 30 *CTRL-R* |
| 31 CTRL-R Redo [count] changes which were undone. {Vi: redraw | |
| 32 screen} | |
| 33 | |
| 34 *:red* *:redo* *redo* | |
| 35 :red[o] Redo one change which was undone. {Vi: no redo} | |
| 36 | |
| 37 *U* | |
| 3082 | 38 U Undo all latest changes on one line, the line where |
| 39 the latest change was made. |U| itself also counts as | |
| 40 a change, and thus |U| undoes a previous |U|. | |
| 41 {Vi: while not moved off of the last modified line} | |
| 7 | 42 |
| 43 The last changes are remembered. You can use the undo and redo commands above | |
| 44 to revert the text to how it was before each change. You can also apply the | |
| 45 changes again, getting back the text before the undo. | |
| 46 | |
| 47 The "U" command is treated by undo/redo just like any other command. Thus a | |
| 48 "u" command undoes a "U" command and a 'CTRL-R' command redoes it again. When | |
| 49 mixing "U", "u" and 'CTRL-R' you will notice that the "U" command will | |
| 50 restore the situation of a line to before the previous "U" command. This may | |
| 51 be confusing. Try it out to get used to it. | |
| 52 The "U" command will always mark the buffer as changed. When "U" changes the | |
| 53 buffer back to how it was without changes, it is still considered changed. | |
| 54 Use "u" to undo changes until the buffer becomes unchanged. | |
| 55 | |
| 56 ============================================================================== | |
| 57 2. Two ways of undo *undo-two-ways* | |
| 58 | |
| 59 How undo and redo commands work depends on the 'u' flag in 'cpoptions'. | |
| 5340 | 60 There is the Vim way ('u' excluded) and the Vi-compatible way ('u' included). |
| 7 | 61 In the Vim way, "uu" undoes two changes. In the Vi-compatible way, "uu" does |
| 62 nothing (undoes an undo). | |
| 63 | |
| 64 'u' excluded, the Vim way: | |
| 65 You can go back in time with the undo command. You can then go forward again | |
| 66 with the redo command. If you make a new change after the undo command, | |
| 67 the redo will not be possible anymore. | |
| 68 | |
| 69 'u' included, the Vi-compatible way: | |
| 70 The undo command undoes the previous change, and also the previous undo command. | |
| 71 The redo command repeats the previous undo command. It does NOT repeat a | |
| 72 change command, use "." for that. | |
| 73 | |
| 74 Examples Vim way Vi-compatible way ~ | |
| 75 "uu" two times undo no-op | |
| 76 "u CTRL-R" no-op two times undo | |
| 77 | |
| 78 Rationale: Nvi uses the "." command instead of CTRL-R. Unfortunately, this | |
| 79 is not Vi compatible. For example "dwdwu." in Vi deletes two | |
| 80 words, in Nvi it does nothing. | |
| 81 | |
| 82 ============================================================================== | |
| 697 | 83 3. Undo blocks *undo-blocks* |
| 84 | |
| 85 One undo command normally undoes a typed command, no matter how many changes | |
| 86 that command makes. This sequence of undo-able changes forms an undo block. | |
| 87 Thus if the typed key(s) call a function, all the commands in the function are | |
| 88 undone together. | |
| 89 | |
| 90 If you want to write a function or script that doesn't create a new undoable | |
| 91 change but joins in with the previous change use this command: | |
| 92 | |
| 839 | 93 *:undoj* *:undojoin* *E790* |
| 697 | 94 :undoj[oin] Join further changes with the previous undo block. |
| 95 Warning: Use with care, it may prevent the user from | |
| 839 | 96 properly undoing changes. Don't use this after undo |
| 97 or redo. | |
| 697 | 98 |
| 5968 | 99 This is most useful when you need to prompt the user halfway through a change. |
| 100 For example in a function that calls |getchar()|. Do make sure that there was | |
| 101 a related change before this that you must join with. | |
| 697 | 102 |
| 103 This doesn't work by itself, because the next key press will start a new | |
| 104 change again. But you can do something like this: > | |
| 105 | |
| 106 :undojoin | delete | |
| 107 | |
| 108 After this an "u" command will undo the delete command and the previous | |
| 109 change. | |
| 110 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
111 To do the opposite, break a change into two undo blocks, in Insert mode use |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
112 CTRL-G u. This is useful if you want an insert command to be undoable in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
113 parts. E.g., for each sentence. |i_CTRL-G_u| |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
114 Setting the value of 'undolevels' also breaks undo. Even when the new value |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
115 is equal to the old value. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
116 |
| 697 | 117 ============================================================================== |
| 827 | 118 4. Undo branches *undo-branches* *undo-tree* |
| 758 | 119 |
| 793 | 120 Above we only discussed one line of undo/redo. But it is also possible to |
| 121 branch off. This happens when you undo a few changes and then make a new | |
| 122 change. The undone changes become a branch. You can go to that branch with | |
| 123 the following commands. | |
| 758 | 124 |
| 799 | 125 This is explained in the user manual: |usr_32.txt|. |
| 758 | 126 |
| 772 | 127 *:undol* *:undolist* |
| 128 :undol[ist] List the leafs in the tree of changes. Example: | |
| 2681 | 129 number changes when saved ~ |
| 130 88 88 2010/01/04 14:25:53 | |
| 131 108 107 08/07 12:47:51 | |
| 132 136 46 13:33:01 7 | |
| 133 166 164 3 seconds ago | |
| 772 | 134 |
| 135 The "number" column is the change number. This number | |
| 136 continuously increases and can be used to identify a | |
| 137 specific undo-able change, see |:undo|. | |
| 138 The "changes" column is the number of changes to this | |
| 139 leaf from the root of the tree. | |
| 2681 | 140 The "when" column is the date and time when this |
| 141 change was made. The four possible formats are: | |
| 142 N seconds ago | |
| 143 HH:MM:SS hour, minute, seconds | |
| 144 MM/DD HH:MM:SS idem, with month and day | |
| 145 YYYY/MM/DD HH:MM:SS idem, with year | |
| 2581 | 146 The "saved" column specifies, if this change was |
| 147 written to disk and which file write it was. This can | |
| 2596 | 148 be used with the |:later| and |:earlier| commands. |
|
2280
941ff1cd317a
Add file save counter to undo information. Add undotree() function.
Bram Moolenaar <bram@vim.org>
parents:
2251
diff
changeset
|
149 For more details use the |undotree()| function. |
| 772 | 150 |
| 758 | 151 *g-* |
| 152 g- Go to older text state. With a count repeat that many | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
153 times. |
| 758 | 154 *:ea* *:earlier* |
| 155 :earlier {count} Go to older text state {count} times. | |
| 156 :earlier {N}s Go to older text state about {N} seconds before. | |
| 157 :earlier {N}m Go to older text state about {N} minutes before. | |
| 158 :earlier {N}h Go to older text state about {N} hours before. | |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
159 :earlier {N}d Go to older text state about {N} days before. |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
160 |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
161 :earlier {N}f Go to older text state {N} file writes before. |
| 2581 | 162 When changes were made since the last write |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
163 ":earlier 1f" will revert the text to the state when |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
164 it was written. Otherwise it will go to the write |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
165 before that. |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
166 When at the state of the first file write, or when |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
167 the file was not written, ":earlier 1f" will go to |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
168 before the first change. |
| 758 | 169 |
| 170 *g+* | |
| 171 g+ Go to newer text state. With a count repeat that many | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
172 times. |
| 758 | 173 *:lat* *:later* |
| 174 :later {count} Go to newer text state {count} times. | |
| 175 :later {N}s Go to newer text state about {N} seconds later. | |
| 176 :later {N}m Go to newer text state about {N} minutes later. | |
| 177 :later {N}h Go to newer text state about {N} hours later. | |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
178 :later {N}d Go to newer text state about {N} days later. |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
179 |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
180 :later {N}f Go to newer text state {N} file writes later. |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
181 When at the state of the last file write, ":later 1f" |
|
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2280
diff
changeset
|
182 will go to the newest text state. |
| 758 | 183 |
| 772 | 184 |
| 758 | 185 Note that text states will become unreachable when undo information is cleared |
| 186 for 'undolevels'. | |
| 187 | |
| 188 Don't be surprised when moving through time shows multiple changes to take | |
| 189 place at a time. This happens when moving through the undo tree and then | |
| 190 making a new change. | |
| 191 | |
| 192 EXAMPLE | |
| 193 | |
| 194 Start with this text: | |
| 195 one two three ~ | |
| 196 | |
| 197 Delete the first word by pressing "x" three times: | |
| 198 ne two three ~ | |
| 199 e two three ~ | |
| 200 two three ~ | |
| 201 | |
| 202 Now undo that by pressing "u" three times: | |
| 203 e two three ~ | |
| 204 ne two three ~ | |
| 205 one two three ~ | |
| 206 | |
| 207 Delete the second word by pressing "x" three times: | |
| 208 one wo three ~ | |
| 209 one o three ~ | |
| 210 one three ~ | |
| 211 | |
| 212 Now undo that by using "g-" three times: | |
| 213 one o three ~ | |
| 214 one wo three ~ | |
| 215 two three ~ | |
| 216 | |
| 217 You are now back in the first undo branch, after deleting "one". Repeating | |
| 218 "g-" will now bring you back to the original text: | |
| 219 e two three ~ | |
| 220 ne two three ~ | |
| 221 one two three ~ | |
| 222 | |
| 223 Jump to the last change with ":later 1h": | |
| 224 one three ~ | |
| 225 | |
| 226 And back to the start again with ":earlier 1h": | |
| 227 one two three ~ | |
| 228 | |
| 229 | |
| 230 Note that using "u" and CTRL-R will not get you to all possible text states | |
| 231 while repeating "g-" and "g+" does. | |
| 232 | |
| 233 ============================================================================== | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
234 5. Undo persistence *undo-persistence* *persistent-undo* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
235 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
236 When unloading a buffer Vim normally destroys the tree of undos created for |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
237 that buffer. By setting the 'undofile' option, Vim will automatically save |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
238 your undo history when you write a file and restore undo history when you edit |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
239 the file again. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
240 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
241 The 'undofile' option is checked after writing a file, before the BufWritePost |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
242 autocommands. If you want to control what files to write undo information |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
243 for, you can use a BufWritePre autocommand: > |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
244 au BufWritePre /tmp/* setlocal noundofile |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
245 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
246 Vim saves undo trees in a separate undo file, one for each edited file, using |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
247 a simple scheme that maps filesystem paths directly to undo files. Vim will |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
248 detect if an undo file is no longer synchronized with the file it was written |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
249 for (with a hash of the file contents) and ignore it when the file was changed |
| 2625 | 250 after the undo file was written, to prevent corruption. An undo file is also |
|
5362
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5340
diff
changeset
|
251 ignored if its owner differs from the owner of the edited file, except when |
|
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5340
diff
changeset
|
252 the owner of the undo file is the current user. Set 'verbose' to get a |
|
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5340
diff
changeset
|
253 message about that when opening a file. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
254 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
255 Undo files are normally saved in the same directory as the file. This can be |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
256 changed with the 'undodir' option. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
257 |
|
2239
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2238
diff
changeset
|
258 When the file is encrypted, the text in the undo file is also crypted. The |
|
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2238
diff
changeset
|
259 same key and method is used. |encryption| |
|
732cb7b31956
Crypt the text in the undo file if the file itself is crypted.
Bram Moolenaar <bram@vim.org>
parents:
2238
diff
changeset
|
260 |
| 15512 | 261 Note that text properties are not stored in the undo file. You can restore |
| 262 text properties so long as a buffer is loaded, but you cannot restore them | |
| 263 from an undo file. Rationale: It would require the associated text property | |
| 264 types to be defined in exactly the same was as before, which cannot be | |
| 265 guaranteed. | |
| 266 | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
267 You can also save and restore undo histories by using ":wundo" and ":rundo" |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
268 respectively: |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
269 *:wundo* *:rundo* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
270 :wundo[!] {file} |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
271 Write undo history to {file}. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
272 When {file} exists and it does not look like an undo file |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
273 (the magic number at the start of the file is wrong), then |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
274 this fails, unless the ! was added. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
275 If it exists and does look like an undo file it is |
| 3312 | 276 overwritten. If there is no undo-history, nothing will be |
| 277 written. | |
| 278 Implementation detail: Overwriting happens by first deleting | |
| 279 the existing file and then creating a new file with the same | |
| 280 name. So it is not possible to overwrite an existing undofile | |
| 281 in a write-protected directory. | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
282 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
283 :rundo {file} Read undo history from {file}. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
284 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
285 You can use these in autocommands to explicitly specify the name of the |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
286 history file. E.g.: > |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
287 |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
288 au BufReadPost * call ReadUndo() |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
289 au BufWritePost * call WriteUndo() |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
290 func ReadUndo() |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
291 if filereadable(expand('%:h'). '/UNDO/' . expand('%:t')) |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
292 rundo %:h/UNDO/%:t |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
293 endif |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
294 endfunc |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
295 func WriteUndo() |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
296 let dirname = expand('%:h') . '/UNDO' |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
297 if !isdirectory(dirname) |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
298 call mkdir(dirname) |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
299 endif |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
300 wundo %:h/UNDO/%:t |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
301 endfunc |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
302 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
303 You should keep 'undofile' off, otherwise you end up with two undo files for |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
304 every write. |
|
2236
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
305 |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
306 You can use the |undofile()| function to find out the file name that Vim would |
|
dc2e5ec0500d
Added the undofile() function. Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents:
2231
diff
changeset
|
307 use. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
308 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
309 Note that while reading/writing files and 'undofile' is set most errors will |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
310 be silent, unless 'verbose' is set. With :wundo and :rundo you will get more |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
311 error messages, e.g., when the file cannot be read or written. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
312 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
313 NOTE: undo files are never deleted by Vim. You need to delete them yourself. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
314 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
315 Reading an existing undo file may fail for several reasons: |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
316 *E822* It cannot be opened, because the file permissions don't allow it. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
317 *E823* The magic number at the start of the file doesn't match. This usually |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
318 means it is not an undo file. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
319 *E824* The version number of the undo file indicates that it's written by a |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
320 newer version of Vim. You need that newer version to open it. Don't |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
321 write the buffer if you want to keep the undo info in the file. |
|
2215
cccb71c2c5c1
Fix uninit memory read in undo code. Fix uint32_t in proto file.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
322 "File contents changed, cannot use undo info" |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
323 The file text differs from when the undo file was written. This means |
|
2215
cccb71c2c5c1
Fix uninit memory read in undo code. Fix uint32_t in proto file.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
324 the undo file cannot be used, it would corrupt the text. This also |
|
cccb71c2c5c1
Fix uninit memory read in undo code. Fix uint32_t in proto file.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
325 happens when 'encoding' differs from when the undo file was written. |
|
2231
aa6412cab544
Various improvements to undo file code to make it more robust.
Bram Moolenaar <bram@vim.org>
parents:
2223
diff
changeset
|
326 *E825* The undo file does not contain valid contents and cannot be used. |
|
2251
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
327 *E826* The undo file is encrypted but decryption failed. |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
328 *E827* The undo file is encrypted but this version of Vim does not support |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
329 encryption. Open the file with another Vim. |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
330 *E832* The undo file is encrypted but 'key' is not set, the text file is not |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
331 encrypted. This would happen if the text file was written by Vim |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
332 encrypted at first, and later overwritten by not encrypted text. |
|
646d34788036
Fix a few compiler warnings. Fix crash with encrypted undo file.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
333 You probably want to delete this undo file. |
|
2238
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
334 "Not reading undo file, owner differs" |
|
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
335 The undo file is owned by someone else than the owner of the text |
|
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
336 file. For safety the undo file is not used. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
337 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
338 Writing an undo file may fail for these reasons: |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
339 *E828* The file to be written cannot be created. Perhaps you do not have |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
340 write permissions in the directory. |
|
2238
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
341 "Cannot write undo file in any directory in 'undodir'" |
|
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
342 None of the directories in 'undodir' can be used. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
343 "Will not overwrite with undo file, cannot read" |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
344 A file exists with the name of the undo file to be written, but it |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
345 cannot be read. You may want to delete this file or rename it. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
346 "Will not overwrite, this is not an undo file" |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
347 A file exists with the name of the undo file to be written, but it |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
348 does not start with the right magic number. You may want to delete |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
349 this file or rename it. |
| 2581 | 350 "Skipping undo file write, nothing to undo" |
| 351 There is no undo information to be written, nothing has been changed | |
|
2238
3d0a7beb0d75
Made reading/writing undo info a bit more robust.
Bram Moolenaar <bram@vim.org>
parents:
2236
diff
changeset
|
352 or 'undolevels' is negative. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
353 *E829* An error occurred while writing the undo file. You may want to try |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
354 again. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
355 |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
356 ============================================================================== |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
357 6. Remarks about undo *undo-remarks* |
| 7 | 358 |
| 359 The number of changes that are remembered is set with the 'undolevels' option. | |
| 360 If it is zero, the Vi-compatible way is always used. If it is negative no | |
| 361 undo is possible. Use this if you are running out of memory. | |
| 362 | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
363 *clear-undo* |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
364 When you set 'undolevels' to -1 the undo information is not immediately |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
365 cleared, this happens at the next change. To force clearing the undo |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
366 information you can use these commands: > |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
367 :let old_undolevels = &undolevels |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
368 :set undolevels=-1 |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
369 :exe "normal a \<BS>\<Esc>" |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
370 :let &undolevels = old_undolevels |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
371 :unlet old_undolevels |
|
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2239
diff
changeset
|
372 |
| 7 | 373 Marks for the buffer ('a to 'z) are also saved and restored, together with the |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
374 text. |
| 7 | 375 |
| 376 When all changes have been undone, the buffer is not considered to be changed. | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
377 It is then possible to exit Vim with ":q" instead of ":q!". Note |
| 7 | 378 that this is relative to the last write of the file. Typing "u" after ":w" |
| 379 actually changes the buffer, compared to what was written, so the buffer is | |
| 380 considered changed then. | |
| 381 | |
| 382 When manual |folding| is being used, the folds are not saved and restored. | |
| 383 Only changes completely within a fold will keep the fold as it was, because | |
| 384 the first and last line of the fold don't change. | |
| 385 | |
| 386 The numbered registers can also be used for undoing deletes. Each time you | |
| 387 delete text, it is put into register "1. The contents of register "1 are | |
| 388 shifted to "2, etc. The contents of register "9 are lost. You can now get | |
| 389 back the most recent deleted text with the put command: '"1P'. (also, if the | |
| 390 deleted text was the result of the last delete or copy operation, 'P' or 'p' | |
| 391 also works as this puts the contents of the unnamed register). You can get | |
| 392 back the text of three deletes ago with '"3P'. | |
| 393 | |
| 394 *redo-register* | |
| 395 If you want to get back more than one part of deleted text, you can use a | |
| 396 special feature of the repeat command ".". It will increase the number of the | |
| 397 register used. So if you first do ""1P", the following "." will result in a | |
| 398 '"2P'. Repeating this will result in all numbered registers being inserted. | |
| 399 | |
| 400 Example: If you deleted text with 'dd....' it can be restored with | |
| 401 '"1P....'. | |
| 402 | |
| 403 If you don't know in which register the deleted text is, you can use the | |
| 404 :display command. An alternative is to try the first register with '"1P', and | |
| 405 if it is not what you want do 'u.'. This will remove the contents of the | |
| 406 first put, and repeat the put command for the second register. Repeat the | |
| 407 'u.' until you got what you want. | |
| 408 | |
| 14519 | 409 vim:tw=78:ts=8:noet:ft=help:norl: |