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.29 2002/11/19 13:39:36 stelian Exp $
34 .TH RESTORE 8 "version __VERSION__ of __DATE__" BSD "System management commands"
36 restore \- restore files or file systems from backups made with dump
40 [\fB\-b \fIblocksize\fR]
41 [\fB\-D \fIfilesystem\fR]
46 [\fB\-T \fIdirectory\fR]
49 [\fB\-acdhklmMNouvVy\fR]
51 [\fB\-b \fIblocksize\fR]
56 [\fB\-T \fIdirectory\fR]
60 [\fB\-acdhklmMNuvVy\fR]
62 [\fB\-b \fIblocksize\fR]
66 [\fB\-T \fIdirectory\fR]
67 [\fB\-X \fIfilelist\fR]
72 [\fB\-b \fIblocksize\fR]
76 [\fB\-T \fIdirectory\fR]
80 [\fB\-b \fIblocksize\fR]
84 [\fB\-T \fIdirectory\fR]
89 [\fB\-b \fIblocksize\fR]
94 [\fB\-T \fIdirectory\fR]
95 [\fB\-X \fIfilelist\fR]
99 [\fB\-adchklmMNouvVy\fR]
101 [\fB\-b \fIblocksize\fR]
103 [\fB\-F \fIscript\fR]
105 [\fB\-s \fIfileno\fR]
106 [\fB\-T \fIdirectory\fR]
107 [\fB\-X \fIfilelist\fR]
110 (The 4.3BSD option syntax is implemented for backward compatibility but is not
115 command performs the inverse function of
117 A full backup of a file system may be restored and subsequent incremental
118 backups layered on top of it. Single files and directory subtrees may be
119 restored from full or partial backups.
121 works across a network; to do this see the
123 flag described below. Other arguments to the command are file or directory
124 names specifying the files that are to be restored. Unless the
126 flag is specified (see below), the appearance of a directory name refers to
127 the files and (recursively) subdirectories of that directory.
129 Exactly one of the following flags is required:
132 This mode allows comparison of files from a dump.
134 reads the backup and compares its contents with files present on the disk. It
135 first changes its working directory to the root of the filesystem that was
136 dumped and compares the tape with the files in its new current directory. See
139 flag described below.
142 This mode allows interactive restoration of files from a dump. After reading in
143 the directory information from the dump,
145 provides a shell like interface that allows the user to move around the
146 directory tree selecting files to be extracted. The available commands are
147 given below; for those commands that require an argument, the default is the
151 .B add \fR[\fIarg\fR]
152 The current directory or specified argument is added to the list of files to be
153 extracted. If a directory is specified, then it and all its descendents are
154 added to the extraction list (unless the
156 flag is specified on the command line). Files that are on the extraction list
157 are prepended with a \*(lq*\*(rq when they are listed by
161 Change the current working directory to the specified argument.
163 .B delete \fR[\fIarg\fR]
164 The current directory or specified argument is deleted from the list of files
165 to be extracted. If a directory is specified, then it and all its descendents
166 are deleted from the extraction list (unless the
168 flag is specified on the command line). The most expedient way to extract most
169 of the files from a directory is to add the directory to the extraction list
170 and then delete those files that are not needed.
173 All files on the extraction list are extracted from the dump.
175 will ask which volume the user wishes to mount. The fastest way to extract a f
176 ew files is to start with the last volume and work towards the first volume.
179 List a summary of the available commands.
182 List the current or specified directory. Entries that are directories are
183 appended with a \*(lq/\*(rq. Entries that have been marked for extraction are
184 prepended with a \*(lq*\*(rq. If the verbose flag is set, the inode number of
185 each entry is also listed.
188 Print the full pathname of the current working directory.
192 immediately exits, even if the extraction list is not empty.
195 All directories that have been added to the extraction list have their owner,
196 modes, and times set; nothing is extracted from the dump. This is useful for
199 has been prematurely aborted.
204 flag is toggled. When set, the verbose flag causes the
206 command to list the inode numbers of all entries. It also causes
208 to print out information about each file as it is extracted.
213 creates a new Quick File Access file
215 from an existing dump file without restoring its contents.
219 requests a particular tape of a multi-volume set on which to restart a full
222 flag below). This is useful if the restore has been interrupted.
225 Restore (rebuild) a file system. The target file system should be made pristine
228 mounted, and the user
230 into the pristine file system before starting the restoration of the initial
231 level 0 backup. If the level 0 restores successfully, the
233 flag may be used to restore any necessary incremental backups on top of the
236 flag precludes an interactive file extraction and can be detrimental to one's
237 health (not to mention the disk) if not used carefully. An example:
242 .B mount /dev/sda1 /mnt
246 .B restore rf /dev/st0
253 in the root directory to pass information between incremental restore passes.
254 This file should be removed when the last incremental has been restored.
261 may be used to modify file system parameters such as size or block size.
264 The names of the specified files are listed if they occur on the backup. If no
265 file argument is given, the root directory is listed, which results in the
266 entire content of the backup being listed, unless the
268 flag has been specified. Note that the
270 flag replaces the function of the old
272 program. See also the
277 The named files are read from the given media. If a named file matches a
278 directory whose contents are on the backup and the
280 flag is not specified, the directory is recursively extracted. The owner,
281 modification time, and mode are restored (if possible). If no file argument is
282 given, the root directory is extracted, which results in the entire content of
283 the backup being extracted, unless the
285 flag has been specified. See also the
289 The following additional options may be specified:
298 does ask the user for the volume number on which the files to be extracted are
299 supposed to be (in order to minimise the time by reading only the interesting
302 option disables this behaviour and reads all the volumes starting with 1. This
303 option is useful when the operator does not know on which volume the files to
304 be extracted are and/or when he prefers the longer unattended mode rather than
305 the shorter interactive mode.
307 .BI \-A " archive_file"
308 Read the table of contents from
310 instead of the media. This option can be used in combination with the
315 options, making it possible to check whether files are on the media without
316 having to mount the media.
319 The number of kilobytes per dump record. If the
321 option is not specified,
323 tries to determine the media block size dynamically.
328 will try to determine dynamically whether the dump was made from an old
329 (pre-4.4) or new format file system. The
331 flag disables this check, and only allows reading a dump in the old format.
338 to print debug information.
340 .BI \-D " filesystem"
343 flag allows the user to specify the filesystem name when using
347 option to check the backup.
353 may be a special device file like
357 (a disk drive), an ordinary file, or
359 (the standard input). If the name of the file is of the form
364 reads from the named file on the remote host using
368 Run script at the beginning of each tape. The device name and the current
369 volume number are passed on the command line. The script must return 0 if
371 should continue without asking the user to change the tape, 1 if
373 should continue but ask the user to change the tape. Any other exit code will
376 to abort. For security reasons,
378 reverts back to the real user ID and the real group ID before running the
382 Extract the actual directory, rather than the files that it references. This
383 prevents hierarchical restoration of complete subtrees from the dump.
386 Use Kerberos authentication when contacting the remote tape server. (Only
387 available if this options was enabled when
392 When doing remote restores, assume the remote file is a regular file (instead
393 of a tape device). If you're restoring a remote compressed file, you will need
394 to specify this option or
396 will fail to access it correctly.
401 flag allows the user to specify a maximal number of miscompares when using
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) disables
411 Extract by inode numbers rather than by file name. This is useful if only a few
412 files are being extracted, and one wants to avoid regenerating the complete
413 pathname to the file.
416 Enables the multi-volume feature (for reading dumps made using the
418 option of dump). The name specified with
420 is treated as a prefix and
422 tries to read in sequence from
423 .I <prefix>001, <prefix>002
431 to perform a full execution as requested by one of
438 command without actually writing any file on disk.
445 to automatically restore the current directory permissions without asking the
446 operator whether to do so in one of
455 in order to read tape position as stored using the dump Quick File Access mode,
463 It is recommended to set up the st driver to return logical tape positions
464 rather than physical before calling
468 Since not all tape devices support physical tape positions those tape devices
469 return an error during
471 when the st driver is set to the default physical setting. Please see the
477 man page, on how to set the driver to return logical tape positions.
483 always make sure the st driver is set to return the same type of tape position
484 used during the call to
490 This option can be used when restoring from local or remote tapes (see above)
491 or from local or remote files.
494 Read from the specified
496 on a multi-file tape. File numbering starts at 1.
501 flag allows the user to specify a directory to use for the storage of temporary
502 files. The default value is
504 This flag is most useful when restoring files after having booted from a
505 floppy. There might be little or no space on the floppy filesystem, but another
506 source of space might exist.
509 When creating certain types of files,
511 may generate a warning diagnostic if they already exist in the target
512 directory. To prevent this, the
516 to remove old entries before attempting to create new ones.
521 does its work silently. The
523 (verbose) flag causes it to type the name of each file it treats preceded by
527 Enables reading multi-volume non-tape mediums like CDROMs.
530 Read list of files to be listed or extracted from the text file
532 in addition to those specified on the command line. This can be used in
539 should contain file names separated by newlines.
541 may be an ordinary file or
543 (the standard input).
546 Do not ask the user whether to abort the restore in the event of an error.
547 Always try to skip over the bad block(s) and continue.
549 Complains if it gets a read error. If
551 has been specified, or the user responds
554 will attempt to continue the restore.
556 If a backup was made using more than one tape volume,
558 will notify the user when it is time to mount the next volume. If the
562 flag has been specified,
564 will also ask which volume the user wishes to mount. The fastest way to extract
565 a few files is to start with the last volume, and work towards the first volume.
567 There are numerous consistency checks that can be listed by
569 Most checks are self-explanatory or can \*(lqnever happen\*(rq. Common errors
572 .I Converting to new file system format
573 A dump tape created from the old file system has been loaded. It is
574 automatically converted to the new file system format.
576 .I <filename>: not found on tape
577 The specified file name was listed in the tape directory, but was not found on
578 the tape. This is caused by tape read errors while looking for the file, and
579 from using a dump tape created on an active file system.
581 .I expected next file <inumber>, got <inumber>
582 A file that was not listed in the directory showed up. This can occur when
583 using a dump created on an active file system.
585 .I Incremental dump too low
586 When doing an incremental restore, a dump that was written before the previous
587 incremental dump, or that has too low an incremental level has been loaded.
589 .I Incremental dump too high
590 When doing an incremental restore, a dump that does not begin its coverage
591 where the previous incremental dump left off, or that has too high an
592 incremental level has been loaded.
594 .I Tape read error while restoring <filename>
596 .I Tape read error while skipping over inode <inumber>
598 .I Tape read error while trying to resynchronize
599 A tape (or other media) read error has occurred. If a file name is specified,
600 its contents are probably partially wrong. If an inode is being skipped or the
601 tape is trying to resynchronize, no extracted files have been corrupted, though
602 files may not be found on the tape.
604 .I resync restore, skipped <num> blocks
605 After a dump read error,
607 may have to resynchronize itself. This message lists the number of blocks that
611 exits with zero status on success. Tape errors are indicated with an exit code
614 When doing a comparison of files from a dump, an exit code of 2 indicates that
615 some files were modified or deleted since the dump was made.
617 If the following environment variable exists it will be utilized by
623 option was specified,
625 will use the device specified via
633 .IR user@host:tapename .
636 The directory given in
638 will be used instead of
640 to store temporary files.
643 The environment variable
645 will be used to determine the pathname of the remote
651 uses the contents of this variable to determine the name of the remote shell
652 command to use when doing a network restore (rsh, ssh etc.). If this variable
655 will be used, but only root will be able to do a network restore.
659 the default tape drive
662 file containing directories on the tape
665 owner, mode, and time stamps for directories
668 information passed between incremental restores
676 can get confused when doing incremental restores from dumps that were made on
679 A level 0 dump must be done after a full restore. Because
681 runs in user code, it has no control over inode allocation; thus a full dump
682 must be done to get a new set of directories reflecting the new inode
683 numbering, even though the content of the files is unchanged.
689 are generated with a unique name based on the date of the dump and the process
698 allows you to restart a
700 operation that may have been interrupted, the temporary files should be the
701 same across different processes. In all other cases, the files are unique
702 because it is possible to have two different dumps started at the same time,
703 and separate operations shouldn't conflict with each other.
705 To do a network restore, you have to run
707 as root or use a remote shell replacement (see
709 variable). This is due to the previous security history of
715 is written to be setuid root, but we are not certain all bugs are gone from the
716 code - run setuid at your own risk.)
718 At the end of restores in
726 will ask the operator whether to set the permissions on the current
727 directory. If the operator confirms this action, the permissions
728 on the directory from where
730 was launched will be replaced by the permissions on the dumped root
731 inode. Although this behaviour is not really a bug, it has proven itself
732 to be confusing for many users, so it is recommended to answer 'no',
733 unless you're performing a full restore and you do want to restore the
738 backup suite was ported to Linux's Second Extended File System by Remy Card
739 <card@Linux.EU.Org>. He maintained the initial versions of
741 (up and including 0.4b4, released in january 1997).
743 Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
747 backup suite is available from <http://dump.sourceforge.net>
751 command appeared in 4.2BSD.