annotate runtime/doc/recover.txt @ 138:451ae9ddfa22

updated for version 7.0045
author vimboss
date Thu, 27 Jan 2005 14:31:44 +0000
parents 4102fb4ea781
children 8b0ee9d57d7f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
1 *recover.txt* For Vim version 7.0aa. Last change: 2004 Jun 16
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4 VIM REFERENCE MANUAL by Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 Recovery after a crash *crash-recovery*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 You have spent several hours typing in that text that has to be finished
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 next morning, and then disaster strikes: Your computer crashes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 DON'T PANIC!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 You can recover most of your changes from the files that Vim uses to store
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 the contents of the file. Mostly you can recover your work with one command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 vim -r filename
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 1. The swap file |swap-file|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 2. Recovery |recovery|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 1. The swap file *swap-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 Vim stores the things you changed in a swap file. Using the original file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 you started from plus the swap file you can mostly recover your work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 You can see the name of the current swap file being used with the command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 :sw[apname] *:sw* *:swapname*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 The name of the swap file is normally the same as the file you are editing,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 with the extension ".swp".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 - On Unix, a '.' is prepended to swap file names in the same directory as the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 edited file. This avoids that the swap file shows up in a directory
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 listing.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 - On MS-DOS machines and when the 'shortname' option is on, any '.' in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 original file name is replaced with '_'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 - If this file already exists (e.g., when you are recovering from a crash) a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 warning is given and another extension is used, ".swo", ".swn", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 - An existing file will never be overwritten.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 - The swap file is deleted as soon as Vim stops editing the file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 Technical: The replacement of '.' with '_' is done to avoid problems with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 MS-DOS compatible filesystems (e.g., crossdos, multidos). If Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 is able to detect that the file is on an MS-DOS-like filesystem, a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 flag is set that has the same effect as the 'shortname' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 This flag is reset when you start editing another file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 *E326*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 If the ".swp" file name already exists, the last character is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 decremented until there is no file with that name or ".saa" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 reached. In the last case, no swap file is created.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 By setting the 'directory' option you can place the swap file in another place
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 than where the edited file is.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 Advantages:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 - You will not pollute the directories with ".swp" files.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57 - When the 'directory' is on another partition, reduce the risk of damaging
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 the file system where the file is (in a crash).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 Disadvantages:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 - You can get name collisions from files with the same name but in different
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 directories (although Vim tries to avoid that by comparing the path name).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 This will result in bogus ATTENTION warning messages.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 - When you use your home directory, and somebody else tries to edit the same
9
4102fb4ea781 updated for version 7.0002
vimboss
parents: 7
diff changeset
64 file, he will not see your swap file and will not get the ATTENTION warning
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65 message.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 On the Amiga you can also use a recoverable ram disk, but there is no 100%
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 guarantee that this works. Putting swap files in a normal ram disk (like RAM:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 on the Amiga) or in a place that is cleared when rebooting (like /tmp on Unix)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 makes no sense, you will lose the swap file in a crash.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 If you want to put swap files in a fixed place, put a command resembling the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 following ones in your .vimrc:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 :set dir=dh2:tmp (for Amiga)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 :set dir=~/tmp (for Unix)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 :set dir=c:\\tmp (for MS-DOS and Win32)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 This is also very handy when editing files on floppy. Of course you will have
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 to create that "tmp" directory for this to work!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 For read-only files, a swap file is not used. Unless the file is big, causing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 the amount of memory used to be higher than given with 'maxmem' or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 'maxmemtot'. And when making a change to a read-only file, the swap file is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 created anyway.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 The 'swapfile' option can be reset to avoid creating a swapfile.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 Detecting an existing swap file ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 You can find this in the user manual, section |11.3|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 Updating the swapfile ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 The swap file is updated after typing 200 characters or when you have not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95 typed anything for four seconds. This only happens if the buffer was
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 changed, not when you only moved around. The reason why it is not kept up to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 date all the time is that this would slow down normal work too much. You can
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 change the 200 character count with the 'updatecount' option. You can set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 the time with the 'updatetime' option. The time is given in milliseconds.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 After writing to the swap file Vim syncs the file to disk. This takes some
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 time, especially on busy Unix systems. If you don't want this you can set the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 'swapsync' option to an empty string. The risk of losing work becomes bigger
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 though. On some non-Unix systems (MS-DOS, Amiga) the swap file won't be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 written at all.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 If the writing to the swap file is not wanted, it can be switched off by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 setting the 'updatecount' option to 0. The same is done when starting Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 with the "-n" option. Writing can be switched back on by setting the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 'updatecount' option to non-zero. Swap files will be created for all buffers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 when doing this. But when setting 'updatecount' to zero, the existing swap
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 files will not be removed, it will only affect files that will be opened
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 after this.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 If you want to make sure that your changes are in the swap file use this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 *:pre* *:preserve* *E313* *E314*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 :pre[serve] Write all text for all buffers into swap file. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 original file is no longer needed for recovery. {Vi:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 emergency exit}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 A Vim swap file can be recognized by the first six characters: "b0VIM ".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
123 After that comes the version number, e.g., "3.0".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
125 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
126 2. Recovery *recovery* *E308* *E311*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
128 Basic file recovery is explained in the user manual: |usr_11.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 Another way to do recovery is to start Vim and use the ":recover" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 This is easy when you start Vim to edit a file and you get the "ATTENTION:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 Found a swap file ..." message. In this case the single command ":recover"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 will do the work. You can also give the name of the file or the swap file to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 the recover command:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 *:rec* *:recover* *E305* *E306* *E307*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 :rec[over] [file] Try to recover [file] from the swap file. If [file]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 is not given use the file name for the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 buffer. The current contents of the buffer are lost.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 This command fails if the buffer was modified.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 :rec[over]! [file] Like ":recover", but any changes in the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 buffer are lost.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 *E312* *E309* *E310*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 Vim has some intelligence about what to do if the swap file is corrupt in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 some way. If Vim has doubt about what it found, it will give an error
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 message and insert lines with "???" in the text. If you see an error message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 while recovering, search in the file for "???" to see what is wrong. You may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 want to cut and paste to get the text you need.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 The most common remark is "???LINES MISSING". This means that Vim cannot read
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 the text from the original file. This can happen if the system crashed and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 parts of the original file were not written to disk.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155 Be sure that the recovery was successful before overwriting the original
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 file or deleting the swap file. It is good practice to write the recovered
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 file elsewhere and run 'diff' to find out if the changes you want are in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 recovered file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 Once you are sure the recovery is ok delete the swap file. Otherwise, you
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161 will continue to get warning messages that the ".swp" file already exists.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 {Vi: recovers in another way and sends mail if there is something to recover}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 vim:tw=78:ts=8:ft=help:norl: