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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" $Id: restore.8.in,v 1.35 2009/06/18 09:42:12 stelian Exp $
30 .TH RESTORE 8 "version __VERSION__ of __DATE__" BSD "System management commands"
32 restore \- restore files or file systems from backups made with dump
36 [\fB\-b \fIblocksize\fR]
37 [\fB\-D \fIfilesystem\fR]
42 [\fB\-T \fIdirectory\fR]
45 [\fB\-acdhHklmMNouvVy\fR]
47 [\fB\-b \fIblocksize\fR]
52 [\fB\-T \fIdirectory\fR]
56 [\fB\-acdhHklmMNuvVy\fR]
57 [\fB\-b \fIblocksize\fR]
61 [\fB\-T \fIdirectory\fR]
62 [\fB\-X \fIfilelist\fR]
67 [\fB\-b \fIblocksize\fR]
71 [\fB\-T \fIdirectory\fR]
75 [\fB\-b \fIblocksize\fR]
79 [\fB\-T \fIdirectory\fR]
82 [\fB\-cdhHklMNuvVy\fR]
84 [\fB\-b \fIblocksize\fR]
89 [\fB\-T \fIdirectory\fR]
90 [\fB\-X \fIfilelist\fR]
94 [\fB\-adchHklmMNouvVy\fR]
96 [\fB\-b \fIblocksize\fR]
100 [\fB\-s \fIfileno\fR]
101 [\fB\-T \fIdirectory\fR]
102 [\fB\-X \fIfilelist\fR]
107 command performs the inverse function of
109 A full backup of a file system may be restored and subsequent incremental
110 backups layered on top of it. Single files and directory subtrees may be
111 restored from full or partial backups.
113 works across a network; to do this see the
115 flag described below. Other arguments to the command are file or directory
116 names specifying the files that are to be restored. Unless the
118 flag is specified (see below), the appearance of a directory name refers to
119 the files and (recursively) subdirectories of that directory.
121 Exactly one of the following flags is required:
124 This mode allows comparison of files from a dump.
126 reads the backup and compares its contents with files present on the disk. It
127 first changes its working directory to the root of the filesystem that was
128 dumped and compares the tape with the files in its new current directory. See
131 flag described below.
134 This mode allows interactive restoration of files from a dump. After reading in
135 the directory information from the dump,
137 provides a shell like interface that allows the user to move around the
138 directory tree selecting files to be extracted. The available commands are
139 given below; for those commands that require an argument, the default is the
143 .B add \fR[\fIarg\fR]
144 The current directory or specified argument is added to the list of files to be
145 extracted. If a directory is specified, then it and all its descendents are
146 added to the extraction list (unless the
148 flag is specified on the command line). Files that are on the extraction list
149 are prepended with a \*(lq*\*(rq when they are listed by
153 Change the current working directory to the specified argument.
155 .B delete \fR[\fIarg\fR]
156 The current directory or specified argument is deleted from the list of files
157 to be extracted. If a directory is specified, then it and all its descendents
158 are deleted from the extraction list (unless the
160 flag is specified on the command line). The most expedient way to extract most
161 of the files from a directory is to add the directory to the extraction list
162 and then delete those files that are not needed.
165 All files on the extraction list are extracted from the dump.
167 will ask which volume the user wishes to mount. The fastest way to extract a f
168 ew files is to start with the last volume and work towards the first volume.
171 List a summary of the available commands.
174 List the current or specified directory. Entries that are directories are
175 appended with a \*(lq/\*(rq. Entries that have been marked for extraction are
176 prepended with a \*(lq*\*(rq. If the verbose flag is set, the inode number of
177 each entry is also listed.
180 Print the full pathname of the current working directory.
184 immediately exits, even if the extraction list is not empty.
187 All directories that have been added to the extraction list have their owner,
188 modes, and times set; nothing is extracted from the dump. This is useful for
191 has been prematurely aborted.
196 flag is toggled. When set, the verbose flag causes the
198 command to list the inode numbers of all entries. It also causes
200 to print out information about each file as it is extracted.
205 creates a new Quick File Access file
207 from an existing dump file without restoring its contents.
211 requests a particular tape of a multi-volume set on which to restart a full
214 flag below). This is useful if the restore has been interrupted.
217 Restore (rebuild) a file system. The target file system should be made pristine
220 mounted, and the user
222 into the pristine file system before starting the restoration of the initial
223 level 0 backup. If the level 0 restores successfully, the
225 flag may be used to restore any necessary incremental backups on top of the
228 flag precludes an interactive file extraction and can be detrimental to one's
229 health (not to mention the disk) if not used carefully. An example:
234 .B mount /dev/sda1 /mnt
238 .B restore rf /dev/st0
245 in the root directory to pass information between incremental restore passes.
246 This file should be removed when the last incremental has been restored.
253 may be used to modify file system parameters such as size or block size.
256 The names of the specified files are listed if they occur on the backup. If no
257 file argument is given, the root directory is listed, which results in the
258 entire content of the backup being listed, unless the
260 flag has been specified. Note that the
262 flag replaces the function of the old
264 program. See also the
269 The named files are read from the given media. If a named file matches a
270 directory whose contents are on the backup and the
272 flag is not specified, the directory is recursively extracted. The owner,
273 modification time, and mode are restored (if possible). If no file argument is
274 given, the root directory is extracted, which results in the entire content of
275 the backup being extracted, unless the
277 flag has been specified. See also the
281 The following additional options may be specified:
290 does ask the user for the volume number on which the files to be extracted are
291 supposed to be (in order to minimise the time by reading only the interesting
294 option disables this behaviour and reads all the volumes starting with 1. This
295 option is useful when the operator does not know on which volume the files to
296 be extracted are and/or when he prefers the longer unattended mode rather than
297 the shorter interactive mode.
299 .BI \-A " archive_file"
300 Read the table of contents from
302 instead of the media. This option can be used in combination with the
307 options, making it possible to check whether files are on the media without
308 having to mount the media.
311 The number of kilobytes per dump record. If the
313 option is not specified,
315 tries to determine the media block size dynamically.
320 will try to determine dynamically whether the dump was made from an old
321 (pre-4.4) or new format file system. The
323 flag disables this check, and only allows reading a dump in the old format.
330 to print debug information.
332 .BI \-D " filesystem"
335 flag allows the user to specify the filesystem name when using
339 option to check the backup.
345 may be a special device file like
349 (a disk drive), an ordinary file, or
351 (the standard input). If the name of the file is of the form
356 reads from the named file on the remote host using
360 Run script at the beginning of each tape. The device name and the current
361 volume number are passed on the command line. The script must return 0 if
363 should continue without asking the user to change the tape, 1 if
365 should continue but ask the user to change the tape. Any other exit code will
368 to abort. For security reasons,
370 reverts back to the real user ID and the real group ID before running the
374 Extract the actual directory, rather than the files that it references. This
375 prevents hierarchical restoration of complete subtrees from the dump.
378 Use a hashtable having the specified number of entries for storing the
379 directories entries instead of a linked list. This hashtable will
380 considerably speed up inode lookups (visible especially in interactive
381 mode when adding/removing files from the restore list), but at the
382 price of much more memory usage. The default value is 1, meaning no
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 (The 4.3BSD option syntax is implemented for backward compatibility but is not
552 Complains if it gets a read error. If
554 has been specified, or the user responds
557 will attempt to continue the restore.
559 If a backup was made using more than one tape volume,
561 will notify the user when it is time to mount the next volume. If the
565 flag has been specified,
567 will also ask which volume the user wishes to mount. The fastest way to extract
568 a few files is to start with the last volume, and work towards the first volume.
570 There are numerous consistency checks that can be listed by
572 Most checks are self-explanatory or can \*(lqnever happen\*(rq. Common errors
575 .I Converting to new file system format
576 A dump tape created from the old file system has been loaded. It is
577 automatically converted to the new file system format.
579 .I <filename>: not found on tape
580 The specified file name was listed in the tape directory, but was not found on
581 the tape. This is caused by tape read errors while looking for the file, and
582 from using a dump tape created on an active file system.
584 .I expected next file <inumber>, got <inumber>
585 A file that was not listed in the directory showed up. This can occur when
586 using a dump created on an active file system.
588 .I Incremental dump too low
589 When doing an incremental restore, a dump that was written before the previous
590 incremental dump, or that has too low an incremental level has been loaded.
592 .I Incremental dump too high
593 When doing an incremental restore, a dump that does not begin its coverage
594 where the previous incremental dump left off, or that has too high an
595 incremental level has been loaded.
597 .I Tape read error while restoring <filename>
599 .I Tape read error while skipping over inode <inumber>
601 .I Tape read error while trying to resynchronize
602 A tape (or other media) read error has occurred. If a file name is specified,
603 its contents are probably partially wrong. If an inode is being skipped or the
604 tape is trying to resynchronize, no extracted files have been corrupted, though
605 files may not be found on the tape.
607 .I resync restore, skipped <num> blocks
608 After a dump read error,
610 may have to resynchronize itself. This message lists the number of blocks that
614 exits with zero status on success. Tape errors are indicated with an exit code
617 When doing a comparison of files from a dump, an exit code of 2 indicates that
618 some files were modified or deleted since the dump was made.
620 If the following environment variable exists it will be utilized by
626 option was specified,
628 will use the device specified via
636 .IR user@host:tapename .
639 The directory given in
641 will be used instead of
643 to store temporary files.
646 The environment variable
648 will be used to determine the pathname of the remote
654 uses the contents of this variable to determine the name of the remote shell
655 command to use when doing a network restore (rsh, ssh etc.). If this variable
658 will be used, but only root will be able to do a network restore.
662 the default tape drive
665 file containing directories on the tape
668 owner, mode, and time stamps for directories
671 information passed between incremental restores
679 can get confused when doing incremental restores from dumps that were made on
682 A level 0 dump must be done after a full restore. Because
684 runs in user code, it has no control over inode allocation; thus a full dump
685 must be done to get a new set of directories reflecting the new inode
686 numbering, even though the content of the files is unchanged.
692 are generated with a unique name based on the date of the dump and the process
701 allows you to restart a
703 operation that may have been interrupted, the temporary files should be the
704 same across different processes. In all other cases, the files are unique
705 because it is possible to have two different dumps started at the same time,
706 and separate operations shouldn't conflict with each other.
708 To do a network restore, you have to run
710 as root or use a remote shell replacement (see
712 variable). This is due to the previous security history of
718 is written to be setuid root, but we are not certain all bugs are gone from the
719 code - run setuid at your own risk.)
721 At the end of restores in
729 will ask the operator whether to set the permissions on the current
730 directory. If the operator confirms this action, the permissions
731 on the directory from where
733 was launched will be replaced by the permissions on the dumped root
734 inode. Although this behaviour is not really a bug, it has proven itself
735 to be confusing for many users, so it is recommended to answer 'no',
736 unless you're performing a full restore and you do want to restore the
739 It should be underlined that because it runs in user code,
743 option, sees the files as the kernel presents them, whereas
745 sees all the files on a given filesystem. In particular, this
746 can cause some confusion when comparing a dumped filesystem a part
747 of which is hidden by a filesystem mounted on top of it.
751 backup suite was ported to Linux's Second Extended File System by Remy Card
752 <card@Linux.EU.Org>. He maintained the initial versions of
754 (up and including 0.4b4, released in January 1997).
756 Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
760 backup suite is available from <http://dump.sourceforge.net>
764 command appeared in 4.2BSD.