1 .\" Copyright (c) 1985, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" $Id: restore.8.in,v 1.23 2002/01/22 11:12:28 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
102 option syntax is implemented for backward compatibility but
103 is not documented here.)
107 command performs the inverse function of
109 A full backup of a file system may be restored and
110 subsequent incremental backups layered on top of it.
112 directory subtrees may be restored from full or partial
115 works across a network;
118 flag described below.
119 Other arguments to the command are file or directory
120 names specifying the files that are to be restored.
123 flag is specified (see below),
124 the appearance of a directory name refers to
125 the files and (recursively) subdirectories of that directory.
127 Exactly one of the following flags is required:
130 This mode allows comparison of files from a dump.
132 reads the backup and compares its contents with files present on the
134 It first changes its working directory to the root of the filesystem
135 that was dumped and compares the tape with the files in its new
139 flag described below.
141 This mode allows interactive restoration of files from a dump.
142 After reading in the directory information from the dump,
144 provides a shell like interface that allows the user to move
145 around the directory tree selecting files to be extracted.
146 The available commands are given below;
147 for those commands that require an argument,
148 the default is the current directory.
151 The current directory or specified argument is added to the list of
152 files to be extracted.
153 If a directory is specified, then it and all its descendents are
154 added to the extraction list
157 flag is specified on the command line).
158 Files that are on the extraction list are prepended with a
160 when they are listed by
163 Change the current working directory to the specified argument.
164 .It Ic delete Op Ar arg
165 The current directory or specified argument is deleted from the list of
166 files to be extracted.
167 If a directory is specified, then it and all its descendents are
168 deleted from the extraction list
171 flag is specified on the command line).
172 The most expedient way to extract most of the files from a directory
173 is to add the directory to the extraction list and then delete
174 those files that are not needed.
176 All files on the extraction list are extracted
179 will ask which volume the user wishes to mount.
180 The fastest way to extract a few files is to
181 start with the last volume and work towards the first volume.
183 List a summary of the available commands.
184 .It Ic \&ls Op Ar arg
185 List the current or specified directory.
186 Entries that are directories are appended with a
188 Entries that have been marked for extraction are prepended with a ``*''.
190 flag is set, the inode number of each entry is also listed.
192 Print the full pathname of the current working directory.
194 Restore immediately exits,
195 even if the extraction list is not empty.
197 All directories that have been added to the extraction list
198 have their owner, modes, and times set;
199 nothing is extracted from the dump.
200 This is useful for cleaning up after a restore has been prematurely aborted.
205 When set, the verbose flag causes the
207 command to list the inode numbers of all entries.
210 to print out information about each file as it is extracted.
214 requests a particular tape of a multi-volume set on which to restart
219 This is useful if the restore has been interrupted.
221 Restore (rebuild) a file system.
222 The target file system should be made pristine with
224 mounted, and the user
226 into the pristine file system
227 before starting the restoration of the initial level 0 backup. If the
228 level 0 restores successfully, the
230 flag may be used to restore
231 any necessary incremental backups on top of the level 0.
234 flag precludes an interactive file extraction and can be
235 detrimental to one's health (not to mention the disk) if not used carefully.
237 .Bd -literal -offset indent
249 in the root directory to pass information between incremental
251 This file should be removed when the last incremental has been
259 may be used to modify file system parameters
260 such as size or block size.
262 The names of the specified files are listed if they occur
264 If no file argument is given,
265 the root directory is listed,
266 which results in the entire content of the
270 flag has been specified.
273 flag replaces the function of the old
281 The named files are read from the given media.
282 If a named file matches a directory whose contents
286 flag is not specified,
287 the directory is recursively extracted.
288 The owner, modification time,
289 and mode are restored (if possible).
290 If no file argument is given,
291 the root directory is extracted,
292 which results in the entire content of the
293 backup being extracted,
296 flag has been specified.
302 The following additional options may be specified:
311 does ask the user for the volume number on which the files to
312 be extracted are supposed to be (in order to minimise the time
313 be reading only the interesting volumes). The
315 option disables this behaviour and reads all the volumes starting
316 with 1. This option is useful when the operator does not know on which
317 volume the files to be extracted are and/or when he prefers the
318 longer unattended mode rather than the shorter interactive mode.
319 .It Fl b Ar blocksize
320 The number of kilobytes per dump record.
323 option is not specified,
325 tries to determine the media block size dynamically.
329 will try to determine dynamically whether the dump was made from an
330 old (pre-4.4) or new format file system. The
332 flag disables this check, and only allows reading a dump in the old
334 .It Fl D Ar filesystem
337 flag allows the user to specify the filesystem name when using
341 option to check the backup.
346 may be a special device file
355 (the standard input).
356 If the name of the file is of the form
361 reads from the named file on the remote host using
365 Run script at the beginning of each tape. The device name and the
366 current volume number are passed on the command line.
367 The script must return 0 if
369 should continue without asking the user to change the tape, 1 if
371 should continue but ask the user to change the tape.
372 Any other exit code will cause
375 For security reasons,
377 reverts back to the real user ID and the real group ID before
380 Use Kerberos authentication when contacting the remote tape server.
381 (Only available if this options was enabled when
386 Extract the actual directory,
387 rather than the files that it references.
388 This prevents hierarchical restoration of complete subtrees
391 When doing remote restores, assume the remote file is a
392 regular file (instead of a tape device). If you're restoring
393 a remote compressed file, you will need to specify this
396 will fail to access it correctly.
400 flag allows the user to specify a maximal number of miscompares
405 option to check the backup. If this limit is reached,
407 will abort with an error message. A value of 0 (the default value)
410 Extract by inode numbers rather than by file name.
411 This is useful if only a few files are being extracted,
412 and one wants to avoid regenerating the complete pathname
415 Enables the multi-volume feature (for reading dumps made using
418 option of dump). The name specified with
420 is treated as a prefix and
422 tries to read in sequence from <prefix>001, <prefix>002 etc.
428 to perform a full execution as requested by one of
435 command without actually writing any file on disk.
439 in order to read tape position as stored using the dump Quick File
442 It is recommended to set up the st driver to return logical tape
443 positions rather than physical before calling dump/restore with
444 parameter Q. Since not all tape devices support physical tape
445 positions those tape devices return an error during dump/restore when
446 the st driver is set to the default physical setting.
447 Please see the st man page, option MTSETDRVBUFFER, or the mt man
448 page, on how to set the driver to return logical tape positions.
450 Before calling restore with parameter Q, always make sure the st
451 driver is set to return the same type of tape position used during the
452 call to dump. Otherwise restore may be confused.
454 This option can be used when restoring from local tapes (see above)
457 Read from the specified
459 on a multi-file tape.
460 File numbering starts at 1.
461 .It Fl T Ar directory
464 flag allows the user to specify a directory to use for the storage of
465 temporary files. The default value is /tmp. This flag is most useful
466 when restoring files after having booted from a floppy. There might be little
467 or no space on the floppy filesystem, but another source of space might exist.
469 When creating certain types of files, restore may generate a warning
470 diagnostic if they already exist in the target directory.
473 (unlink) flag causes restore to remove old entries before attempting
478 does its work silently.
482 flag causes it to type the name of each file it treats
483 preceded by its file type.
485 Enables reading multi-volume non-tape mediums like CDROMs.
487 Read list of files to be listed or extracted from the text file
489 in addition to those specified on the command line. This can be used in
496 should contain file names separated by newlines.
498 may be an ordinary file or
500 (the standard input).
502 Do not ask the user whether to abort the restore in the event of an error.
503 Always try to skip over the bad block(s) and continue.
506 Complains if it gets a read error.
509 has been specified, or the user responds
512 will attempt to continue the restore.
514 If a backup was made using more than one tape volume,
516 will notify the user when it is time to mount the next volume.
521 flag has been specified,
523 will also ask which volume the user wishes to mount.
524 The fastest way to extract a few files is to
525 start with the last volume, and work towards the first volume.
527 There are numerous consistency checks that can be listed by
529 Most checks are self-explanatory or can
531 Common errors are given below.
533 .Bl -tag -width Ds -compact
534 .It Converting to new file system format
535 A dump tape created from the old file system has been loaded.
536 It is automatically converted to the new file system format.
538 .It <filename>: not found on tape
539 The specified file name was listed in the tape directory,
540 but was not found on the tape.
541 This is caused by tape read errors while looking for the file,
542 and from using a dump tape created on an active file system.
544 .It expected next file <inumber>, got <inumber>
545 A file that was not listed in the directory showed up.
546 This can occur when using a dump created on an active file system.
548 .It Incremental dump too low
549 When doing an incremental restore,
550 a dump that was written before the previous incremental dump,
551 or that has too low an incremental level has been loaded.
553 .It Incremental dump too high
554 When doing an incremental restore,
555 a dump that does not begin its coverage where the previous incremental
557 or that has too high an incremental level has been loaded.
559 .It Tape read error while restoring <filename>
560 .It Tape read error while skipping over inode <inumber>
561 .It Tape read error while trying to resynchronize
562 A tape (or other media) read error has occurred.
563 If a file name is specified,
564 its contents are probably partially wrong.
565 If an inode is being skipped or the tape is trying to resynchronize,
566 no extracted files have been corrupted,
567 though files may not be found on the tape.
569 .It resync restore, skipped <num> blocks
570 After a dump read error,
572 may have to resynchronize itself.
573 This message lists the number of blocks that were skipped over.
577 exits with zero status on success.
578 Tape errors are indicated with an exit code of 1.
580 When doing a comparison of files from a dump, an exit code
581 of 2 indicates that some files were modified or deleted since
584 If the following environment variable exists it will be utilized by
587 .Bl -tag -width "TMPDIR" -compact
589 If no -f option was specified,
591 will use the device specified via
599 .Qq user@host:tapename .
601 The directory given in
606 to store temporary files.
608 The environment variable
610 will be used to determine the pathname of the remote
615 uses the contents of this variable to determine the name of the
616 remote shell command to use when doing a network restore (rsh, ssh etc.).
617 If this variable is not set,
619 will be used, but only root will be able to do a network restore.
622 .Bl -tag -width "./restoresymtable" -compact
624 the default tape drive
626 file containing directories on the tape
628 owner, mode, and time stamps for directories
629 .It Pa \&./restoresymtable
630 information passed between incremental restores
639 can get confused when doing incremental restores from
640 dumps that were made on active file systems.
642 A level 0 dump must be done after a full restore.
646 it has no control over inode allocation;
647 thus a full dump must be done to get a new set of directories
648 reflecting the new inode numbering,
649 even though the content of the files is unchanged.
655 are generated with a unique name based on the date of the dump
656 and the process ID (see
665 allows you to restart a
667 operation that may have been interrupted, the temporary files should
668 be the same across different processes.
669 In all other cases, the files are unique because it is possible to
670 have two different dumps started at the same time, and separate
671 operations shouldn't conflict with each other.
673 To do a network restore, you have to run restore as root or use
674 a remote shell replacement (see RSH variable). This is due
675 to the previous security history of dump and restore. (restore is
676 written to be setuid root, but we are not certain all bugs are gone
677 from the restore code - run setuid at your own risk.)
681 backup suite was ported to Linux's Second Extended File System
682 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
683 of dump (up and including 0.4b4, released in january 1997).
685 Starting with 0.4b5, the new maintainer is Stelian Pop
687 <stelian@popies.net>.
691 backup suite is available from
693 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob