]>
Commit | Line | Data |
---|---|---|
1 | .\" Copyright (c) 1985, 1991, 1993 | |
2 | .\" The Regents of the University of California. All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms, with or without | |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
19 | .\" | |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
31 | .\" | |
32 | .\" $Id: restore.8.in,v 1.14 2001/04/24 15:04:59 stelian Exp $ | |
33 | .\" | |
34 | .Dd __DATE__ | |
35 | .Dt RESTORE 8 | |
36 | .Os "restore __VERSION__" | |
37 | .Sh NAME | |
38 | .Nm restore | |
39 | .Nd "restore files or file systems from backups made with dump" | |
40 | .Sh SYNOPSIS | |
41 | .Nm restore | |
42 | .Fl C | |
43 | .Op Fl ckMvy | |
44 | .Op Fl b Ar blocksize | |
45 | .Op Fl D Ar filesystem | |
46 | .Op Fl f Ar file | |
47 | .Op Fl s Ar fileno | |
48 | .Op Fl T Ar directory | |
49 | .Nm restore | |
50 | .Fl i | |
51 | .Op Fl chkmMNuvy | |
52 | .Op Fl b Ar blocksize | |
53 | .Op Fl f Ar file | |
54 | .Op Fl Q Ar file | |
55 | .Op Fl s Ar fileno | |
56 | .Op Fl T Ar directory | |
57 | .Nm restore | |
58 | .Fl R | |
59 | .Op Fl ckMNuvy | |
60 | .Op Fl b Ar blocksize | |
61 | .Op Fl f Ar file | |
62 | .Op Fl s Ar fileno | |
63 | .Op Fl T Ar directory | |
64 | .Nm restore | |
65 | .Fl r | |
66 | .Op Fl ckMNuvy | |
67 | .Op Fl b Ar blocksize | |
68 | .Op Fl f Ar file | |
69 | .Op Fl s Ar fileno | |
70 | .Op Fl T Ar directory | |
71 | .Nm restore | |
72 | .Fl t | |
73 | .Op Fl chkMNuvy | |
74 | .Op Fl b Ar blocksize | |
75 | .Op Fl f Ar file | |
76 | .Op Fl Q Ar file | |
77 | .Op Fl s Ar fileno | |
78 | .Op Fl T Ar directory | |
79 | .Op Fl X Ar filelist | |
80 | .Op file ... | |
81 | .Nm restore | |
82 | .Fl x | |
83 | .Op Fl chkmMNuvy | |
84 | .Op Fl b Ar blocksize | |
85 | .Op Fl f Ar file | |
86 | .Op Fl Q Ar file | |
87 | .Op Fl s Ar fileno | |
88 | .Op Fl T Ar directory | |
89 | .Op Fl X Ar filelist | |
90 | .Op file ... | |
91 | .Pp | |
92 | .in | |
93 | (The | |
94 | .Bx 4.3 | |
95 | option syntax is implemented for backward compatibility but | |
96 | is not documented here.) | |
97 | .Sh DESCRIPTION | |
98 | The | |
99 | .Nm restore | |
100 | command performs the inverse function of | |
101 | .Xr dump 8 . | |
102 | A full backup of a file system may be restored and | |
103 | subsequent incremental backups layered on top of it. | |
104 | Single files and | |
105 | directory subtrees may be restored from full or partial | |
106 | backups. | |
107 | .Nm Restore | |
108 | works across a network; | |
109 | to do this see the | |
110 | .Fl f | |
111 | flag described below. | |
112 | Other arguments to the command are file or directory | |
113 | names specifying the files that are to be restored. | |
114 | Unless the | |
115 | .Fl h | |
116 | flag is specified (see below), | |
117 | the appearance of a directory name refers to | |
118 | the files and (recursively) subdirectories of that directory. | |
119 | .Pp | |
120 | Exactly one of the following flags is required: | |
121 | .Bl -tag -width Ds | |
122 | .It Fl C | |
123 | This mode allows comparison of files from a dump. | |
124 | .Nm Restore | |
125 | reads the backup and compares its contents with files present on the | |
126 | disk. | |
127 | It first changes its working directory to the root of the filesystem | |
128 | that was dumped and compares the tape with the files in its new | |
129 | current directory. | |
130 | .It Fl i | |
131 | This mode allows interactive restoration of files from a dump. | |
132 | After reading in the directory information from the dump, | |
133 | .Nm restore | |
134 | provides a shell like interface that allows the user to move | |
135 | around the directory tree selecting files to be extracted. | |
136 | The available commands are given below; | |
137 | for those commands that require an argument, | |
138 | the default is the current directory. | |
139 | .Bl -tag -width Fl | |
140 | .It Ic add Op Ar arg | |
141 | The current directory or specified argument is added to the list of | |
142 | files to be extracted. | |
143 | If a directory is specified, then it and all its descendents are | |
144 | added to the extraction list | |
145 | (unless the | |
146 | .Fl h | |
147 | flag is specified on the command line). | |
148 | Files that are on the extraction list are prepended with a | |
149 | .Dq \&* | |
150 | when they are listed by | |
151 | .Ic ls . | |
152 | .It Ic \&cd Ar arg | |
153 | Change the current working directory to the specified argument. | |
154 | .It Ic delete Op Ar arg | |
155 | The current directory or specified argument is deleted from the list of | |
156 | files to be extracted. | |
157 | If a directory is specified, then it and all its descendents are | |
158 | deleted from the extraction list | |
159 | (unless the | |
160 | .Fl h | |
161 | flag is specified on the command line). | |
162 | The most expedient way to extract most of the files from a directory | |
163 | is to add the directory to the extraction list and then delete | |
164 | those files that are not needed. | |
165 | .It Ic extract | |
166 | All files on the extraction list are extracted | |
167 | from the dump. | |
168 | .Nm Restore | |
169 | will ask which volume the user wishes to mount. | |
170 | The fastest way to extract a few files is to | |
171 | start with the last volume and work towards the first volume. | |
172 | .It Ic help | |
173 | List a summary of the available commands. | |
174 | .It Ic \&ls Op Ar arg | |
175 | List the current or specified directory. | |
176 | Entries that are directories are appended with a | |
177 | .Dq \&* . | |
178 | Entries that have been marked for extraction are prepended with a ``*''. | |
179 | If the verbose | |
180 | flag is set, the inode number of each entry is also listed. | |
181 | .It Ic pwd | |
182 | Print the full pathname of the current working directory. | |
183 | .It Ic quit | |
184 | Restore immediately exits, | |
185 | even if the extraction list is not empty. | |
186 | .It Ic setmodes | |
187 | All directories that have been added to the extraction list | |
188 | have their owner, modes, and times set; | |
189 | nothing is extracted from the dump. | |
190 | This is useful for cleaning up after a restore has been prematurely aborted. | |
191 | .It Ic verbose | |
192 | The sense of the | |
193 | .Fl v | |
194 | flag is toggled. | |
195 | When set, the verbose flag causes the | |
196 | .Ic ls | |
197 | command to list the inode numbers of all entries. | |
198 | It also causes | |
199 | .Nm restore | |
200 | to print out information about each file as it is extracted. | |
201 | .El | |
202 | .It Fl R | |
203 | .Nm Restore | |
204 | requests a particular tape of a multi-volume set on which to restart | |
205 | a full restore | |
206 | (see the | |
207 | .Fl r | |
208 | flag below). | |
209 | This is useful if the restore has been interrupted. | |
210 | .It Fl r | |
211 | Restore (rebuild) a file system. | |
212 | The target file system should be made pristine with | |
213 | .Xr mke2fs 8 , | |
214 | mounted, and the user | |
215 | .Xr cd Ns 'd | |
216 | into the pristine file system | |
217 | before starting the restoration of the initial level 0 backup. If the | |
218 | level 0 restores successfully, the | |
219 | .Fl r | |
220 | flag may be used to restore | |
221 | any necessary incremental backups on top of the level 0. | |
222 | The | |
223 | .Fl r | |
224 | flag precludes an interactive file extraction and can be | |
225 | detrimental to one's health (not to mention the disk) if not used carefully. | |
226 | An example: | |
227 | .Bd -literal -offset indent | |
228 | mke2fs /dev/sda1 | |
229 | mount /dev/sda1 /mnt | |
230 | cd /mnt | |
231 | ||
232 | restore rf /dev/st0 | |
233 | .Ed | |
234 | .Pp | |
235 | Note that | |
236 | .Nm restore | |
237 | leaves a file | |
238 | .Pa restoresymtable | |
239 | in the root directory to pass information between incremental | |
240 | restore passes. | |
241 | This file should be removed when the last incremental has been | |
242 | restored. | |
243 | .Pp | |
244 | .Nm Restore , | |
245 | in conjunction with | |
246 | .Xr mke2fs 8 | |
247 | and | |
248 | .Xr dump 8 , | |
249 | may be used to modify file system parameters | |
250 | such as size or block size. | |
251 | .It Fl t | |
252 | The names of the specified files are listed if they occur | |
253 | on the backup. | |
254 | If no file argument is given, | |
255 | the root directory is listed, | |
256 | which results in the entire content of the | |
257 | backup being listed, | |
258 | unless the | |
259 | .Fl h | |
260 | flag has been specified. | |
261 | Note that the | |
262 | .Fl t | |
263 | flag replaces the function of the old | |
264 | .Xr dumpdir 8 | |
265 | program. | |
266 | See also the | |
267 | .Fl X | |
268 | option below. | |
269 | .ne 1i | |
270 | .It Fl x | |
271 | The named files are read from the given media. | |
272 | If a named file matches a directory whose contents | |
273 | are on the backup | |
274 | and the | |
275 | .Fl h | |
276 | flag is not specified, | |
277 | the directory is recursively extracted. | |
278 | The owner, modification time, | |
279 | and mode are restored (if possible). | |
280 | If no file argument is given, | |
281 | the root directory is extracted, | |
282 | which results in the entire content of the | |
283 | backup being extracted, | |
284 | unless the | |
285 | .Fl h | |
286 | flag has been specified. | |
287 | See also the | |
288 | .Fl X | |
289 | option below. | |
290 | .El | |
291 | .Pp | |
292 | The following additional options may be specified: | |
293 | .Bl -tag -width Ds | |
294 | .It Fl b Ar blocksize | |
295 | The number of kilobytes per dump record. | |
296 | If the | |
297 | .Fl b | |
298 | option is not specified, | |
299 | .Nm restore | |
300 | tries to determine the media block size dynamically. | |
301 | .It Fl c | |
302 | Normally, | |
303 | .Nm restore | |
304 | will try to determine dynamically whether the dump was made from an | |
305 | old (pre-4.4) or new format file system. The | |
306 | .Fl c | |
307 | flag disables this check, and only allows reading a dump in the old | |
308 | format. | |
309 | .It Fl D Ar filesystem | |
310 | The | |
311 | .Fl D | |
312 | flag allows the user to specify the filesystem name when using | |
313 | .Nm restore | |
314 | with the | |
315 | .Fl C | |
316 | option to check the backup. | |
317 | .It Fl f Ar file | |
318 | Read the backup from | |
319 | .Ar file ; | |
320 | .Ar file | |
321 | may be a special device file | |
322 | like | |
323 | .Pa /dev/st0 | |
324 | (a tape drive), | |
325 | .Pa /dev/sda1 | |
326 | (a disk drive), | |
327 | an ordinary file, | |
328 | or | |
329 | .Ql Fl | |
330 | (the standard input). | |
331 | If the name of the file is of the form | |
332 | .Dq host:file | |
333 | or | |
334 | .Dq user@host:file , | |
335 | .Nm restore | |
336 | reads from the named file on the remote host using | |
337 | .Xr rmt 8 . | |
338 | .Pp | |
339 | .It Fl k | |
340 | Use Kerberos authentication when contacting the remote tape server. | |
341 | (Only available if this options was enabled when | |
342 | .Nm restore | |
343 | was compiled.) | |
344 | .Pp | |
345 | .It Fl h | |
346 | Extract the actual directory, | |
347 | rather than the files that it references. | |
348 | This prevents hierarchical restoration of complete subtrees | |
349 | from the dump. | |
350 | .It Fl m | |
351 | Extract by inode numbers rather than by file name. | |
352 | This is useful if only a few files are being extracted, | |
353 | and one wants to avoid regenerating the complete pathname | |
354 | to the file. | |
355 | .It Fl M | |
356 | Enables the multi-volume feature (for reading dumps made using | |
357 | the | |
358 | .Fl M | |
359 | option of dump). The name specified with | |
360 | .Fl f | |
361 | is treated as a prefix and | |
362 | .Nm | |
363 | tries to read in sequence from <prefix>001, <prefix>002 etc. | |
364 | .It Fl N | |
365 | The | |
366 | .Fl N | |
367 | flag causes | |
368 | .Nm | |
369 | to only print file names. Files are not extracted. | |
370 | .It Fl Q Ar file | |
371 | Use the file | |
372 | .Ar file | |
373 | in order to read tape position as stored using the dump Quick File | |
374 | Access mode. | |
375 | .It Fl s Ar fileno | |
376 | Read from the specified | |
377 | .Ar fileno | |
378 | on a multi-file tape. | |
379 | File numbering starts at 1. | |
380 | .It Fl T Ar directory | |
381 | The | |
382 | .Fl T | |
383 | flag allows the user to specify a directory to use for the storage of | |
384 | temporary files. The default value is /tmp. This flag is most useful | |
385 | when restoring files after having booted from a floppy. There might be little | |
386 | or no space on the floppy filesystem, but another source of space might exist. | |
387 | .It Fl u | |
388 | When creating certain types of files, restore may generate a warning | |
389 | diagnostic if they already exist in the target directory. | |
390 | To prevent this, the | |
391 | .Fl u | |
392 | (unlink) flag causes restore to remove old entries before attempting | |
393 | to create new ones. | |
394 | .It Fl v | |
395 | Normally | |
396 | .Nm restore | |
397 | does its work silently. | |
398 | The | |
399 | .Fl v | |
400 | (verbose) | |
401 | flag causes it to type the name of each file it treats | |
402 | preceded by its file type. | |
403 | .It Fl X Ar filelist | |
404 | Read list of files to be listed or extracted from the text file | |
405 | .Ar filelist | |
406 | in addition to those specified on the command line. This can be used in | |
407 | conjunction with the | |
408 | .Fl t | |
409 | or | |
410 | .Fl x | |
411 | commands. The file | |
412 | .Ar filelist | |
413 | should contain file names separated by newlines. | |
414 | .Ar filelist | |
415 | may be an ordinary file or | |
416 | .Ql Fl | |
417 | (the standard input). | |
418 | .It Fl y | |
419 | Do not ask the user whether to abort the restore in the event of an error. | |
420 | Always try to skip over the bad block(s) and continue. | |
421 | .El | |
422 | .Sh DIAGNOSTICS | |
423 | Complains if it gets a read error. | |
424 | If | |
425 | .Fl y | |
426 | has been specified, or the user responds | |
427 | .Ql y , | |
428 | .Nm restore | |
429 | will attempt to continue the restore. | |
430 | .Pp | |
431 | If a backup was made using more than one tape volume, | |
432 | .Nm restore | |
433 | will notify the user when it is time to mount the next volume. | |
434 | If the | |
435 | .Fl x | |
436 | or | |
437 | .Fl i | |
438 | flag has been specified, | |
439 | .Nm restore | |
440 | will also ask which volume the user wishes to mount. | |
441 | The fastest way to extract a few files is to | |
442 | start with the last volume, and work towards the first volume. | |
443 | .Pp | |
444 | There are numerous consistency checks that can be listed by | |
445 | .Nm restore . | |
446 | Most checks are self-explanatory or can | |
447 | .Dq never happen . | |
448 | Common errors are given below. | |
449 | .Pp | |
450 | .Bl -tag -width Ds -compact | |
451 | .It Converting to new file system format | |
452 | A dump tape created from the old file system has been loaded. | |
453 | It is automatically converted to the new file system format. | |
454 | .Pp | |
455 | .It <filename>: not found on tape | |
456 | The specified file name was listed in the tape directory, | |
457 | but was not found on the tape. | |
458 | This is caused by tape read errors while looking for the file, | |
459 | and from using a dump tape created on an active file system. | |
460 | .Pp | |
461 | .It expected next file <inumber>, got <inumber> | |
462 | A file that was not listed in the directory showed up. | |
463 | This can occur when using a dump created on an active file system. | |
464 | .Pp | |
465 | .It Incremental dump too low | |
466 | When doing an incremental restore, | |
467 | a dump that was written before the previous incremental dump, | |
468 | or that has too low an incremental level has been loaded. | |
469 | .Pp | |
470 | .It Incremental dump too high | |
471 | When doing an incremental restore, | |
472 | a dump that does not begin its coverage where the previous incremental | |
473 | dump left off, | |
474 | or that has too high an incremental level has been loaded. | |
475 | .Pp | |
476 | .It Tape read error while restoring <filename> | |
477 | .It Tape read error while skipping over inode <inumber> | |
478 | .It Tape read error while trying to resynchronize | |
479 | A tape (or other media) read error has occurred. | |
480 | If a file name is specified, | |
481 | its contents are probably partially wrong. | |
482 | If an inode is being skipped or the tape is trying to resynchronize, | |
483 | no extracted files have been corrupted, | |
484 | though files may not be found on the tape. | |
485 | .Pp | |
486 | .It resync restore, skipped <num> blocks | |
487 | After a dump read error, | |
488 | .Nm restore | |
489 | may have to resynchronize itself. | |
490 | This message lists the number of blocks that were skipped over. | |
491 | .El | |
492 | .Pp | |
493 | .Nm Restore | |
494 | exits with zero status on success. | |
495 | Tape errors are indicated with an exit code of 1. | |
496 | .Pp | |
497 | When doing a comparison of files from a dump, an exit code | |
498 | of 2 indicates that some files were modified or deleted since | |
499 | the dump was made. | |
500 | .Sh ENVIRONMENT | |
501 | If the following environment variable exists it will be utilized by | |
502 | .Nm restore : | |
503 | .Pp | |
504 | .Bl -tag -width "TMPDIR" -compact | |
505 | .It Ev TAPE | |
506 | If no -f option was specified, | |
507 | .Nm | |
508 | will use the device specified via | |
509 | .Ev TAPE | |
510 | as the dump device. | |
511 | .Ev TAPE | |
512 | may be of the form | |
513 | .Qq tapename , | |
514 | .Qq host:tapename | |
515 | or | |
516 | .Qq user@host:tapename . | |
517 | .It Ev TMPDIR | |
518 | The directory given in | |
519 | .Ev TMPDIR | |
520 | will be used | |
521 | instead of | |
522 | .Pa /tmp | |
523 | to store temporary files. | |
524 | .It Ev RMT | |
525 | The environment variable | |
526 | .Ev RMT | |
527 | will be used to determine the pathname of the remote | |
528 | .Xr rmt 8 | |
529 | program. | |
530 | .It Ev RSH | |
531 | .Nm Restore | |
532 | uses the contents of this variable to determine the name of the | |
533 | remote shell command to use when doing a network restore (rsh, ssh etc.). | |
534 | If this variable is not set, | |
535 | .Xr rcmd 3 | |
536 | will be used, but only root will be able to do a network restore. | |
537 | .Sh FILES | |
538 | .Bl -tag -width "./restoresymtable" -compact | |
539 | .It Pa /dev/st0 | |
540 | the default tape drive | |
541 | .It Pa /tmp/rstdir* | |
542 | file containing directories on the tape | |
543 | .It Pa /tmp/rstmode* | |
544 | owner, mode, and time stamps for directories | |
545 | .It Pa \&./restoresymtable | |
546 | information passed between incremental restores | |
547 | .El | |
548 | .Sh SEE ALSO | |
549 | .Xr dump 8 , | |
550 | .Xr mount 8 , | |
551 | .Xr mke2fs 8 , | |
552 | .Xr rmt 8 | |
553 | .Sh BUGS | |
554 | .Nm Restore | |
555 | can get confused when doing incremental restores from | |
556 | dumps that were made on active file systems. | |
557 | .Pp | |
558 | A level 0 dump must be done after a full restore. | |
559 | Because | |
560 | .Nm restore | |
561 | runs in user code, | |
562 | it has no control over inode allocation; | |
563 | thus a full dump must be done to get a new set of directories | |
564 | reflecting the new inode numbering, | |
565 | even though the content of the files is unchanged. | |
566 | .Pp | |
567 | The temporary files | |
568 | .Pa /tmp/rstdir* | |
569 | and | |
570 | .Pa /tmp/rstmode* | |
571 | are generated with a unique name based on the date of the dump | |
572 | and the process ID (see | |
573 | .Xr mktemp 3 ), | |
574 | except when | |
575 | .Fl r | |
576 | or | |
577 | .Fl R | |
578 | is used. | |
579 | Because | |
580 | .Fl R | |
581 | allows you to restart a | |
582 | .Fl r | |
583 | operation that may have been interrupted, the temporary files should | |
584 | be the same across different processes. | |
585 | In all other cases, the files are unique because it is possible to | |
586 | have two different dumps started at the same time, and separate | |
587 | operations shouldn't conflict with each other. | |
588 | .Pp | |
589 | To do a network restore, you have to run restore as root or use | |
590 | a remote shell replacement (see RSH variable). This is due | |
591 | to the previous security history of dump and restore. (restore is | |
592 | written to be setuid root, but we are not certain all bugs are gone | |
593 | from the restore code - run setuid at your own risk.) | |
594 | .Sh AUTHOR | |
595 | The | |
596 | .Nm dump/restore | |
597 | backup suite was ported to Linux's Second Extended File System | |
598 | by Remy Card <card@Linux.EU.Org>. He maintained the initial versions | |
599 | of dump (up and including 0.4b4, released in january 1997). | |
600 | .Pp | |
601 | Starting with 0.4b5, the new maintainer is Stelian Pop | |
602 | .br | |
603 | <pop@noos.fr>. | |
604 | .Sh AVAILABILITY | |
605 | The | |
606 | .Nm dump/restore | |
607 | backup suite is available from | |
608 | .br | |
609 | http://dump.sourceforge.net | |
610 | .Sh HISTORY | |
611 | The | |
612 | .Nm restore | |
613 | command appeared in | |
614 | .Bx 4.2 . |