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.31 2003/06/11 13:01:36 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\-acdhklmMNouvVy\fR]
47 [\fB\-b \fIblocksize\fR]
52 [\fB\-T \fIdirectory\fR]
56 [\fB\-acdhklmMNuvVy\fR]
58 [\fB\-b \fIblocksize\fR]
62 [\fB\-T \fIdirectory\fR]
63 [\fB\-X \fIfilelist\fR]
68 [\fB\-b \fIblocksize\fR]
72 [\fB\-T \fIdirectory\fR]
76 [\fB\-b \fIblocksize\fR]
80 [\fB\-T \fIdirectory\fR]
85 [\fB\-b \fIblocksize\fR]
90 [\fB\-T \fIdirectory\fR]
91 [\fB\-X \fIfilelist\fR]
95 [\fB\-adchklmMNouvVy\fR]
97 [\fB\-b \fIblocksize\fR]
101 [\fB\-s \fIfileno\fR]
102 [\fB\-T \fIdirectory\fR]
103 [\fB\-X \fIfilelist\fR]
106 (The 4.3BSD option syntax is implemented for backward compatibility but is not
111 command performs the inverse function of
113 A full backup of a file system may be restored and subsequent incremental
114 backups layered on top of it. Single files and directory subtrees may be
115 restored from full or partial backups.
117 works across a network; to do this see the
119 flag described below. Other arguments to the command are file or directory
120 names specifying the files that are to be restored. Unless the
122 flag is specified (see below), the appearance of a directory name refers to
123 the files and (recursively) subdirectories of that directory.
125 Exactly one of the following flags is required:
128 This mode allows comparison of files from a dump.
130 reads the backup and compares its contents with files present on the disk. It
131 first changes its working directory to the root of the filesystem that was
132 dumped and compares the tape with the files in its new current directory. See
135 flag described below.
138 This mode allows interactive restoration of files from a dump. After reading in
139 the directory information from the dump,
141 provides a shell like interface that allows the user to move around the
142 directory tree selecting files to be extracted. The available commands are
143 given below; for those commands that require an argument, the default is the
147 .B add \fR[\fIarg\fR]
148 The current directory or specified argument is added to the list of files to be
149 extracted. If a directory is specified, then it and all its descendents are
150 added to the extraction list (unless the
152 flag is specified on the command line). Files that are on the extraction list
153 are prepended with a \*(lq*\*(rq when they are listed by
157 Change the current working directory to the specified argument.
159 .B delete \fR[\fIarg\fR]
160 The current directory or specified argument is deleted from the list of files
161 to be extracted. If a directory is specified, then it and all its descendents
162 are deleted from the extraction list (unless the
164 flag is specified on the command line). The most expedient way to extract most
165 of the files from a directory is to add the directory to the extraction list
166 and then delete those files that are not needed.
169 All files on the extraction list are extracted from the dump.
171 will ask which volume the user wishes to mount. The fastest way to extract a f
172 ew files is to start with the last volume and work towards the first volume.
175 List a summary of the available commands.
178 List the current or specified directory. Entries that are directories are
179 appended with a \*(lq/\*(rq. Entries that have been marked for extraction are
180 prepended with a \*(lq*\*(rq. If the verbose flag is set, the inode number of
181 each entry is also listed.
184 Print the full pathname of the current working directory.
188 immediately exits, even if the extraction list is not empty.
191 All directories that have been added to the extraction list have their owner,
192 modes, and times set; nothing is extracted from the dump. This is useful for
195 has been prematurely aborted.
200 flag is toggled. When set, the verbose flag causes the
202 command to list the inode numbers of all entries. It also causes
204 to print out information about each file as it is extracted.
209 creates a new Quick File Access file
211 from an existing dump file without restoring its contents.
215 requests a particular tape of a multi-volume set on which to restart a full
218 flag below). This is useful if the restore has been interrupted.
221 Restore (rebuild) a file system. The target file system should be made pristine
224 mounted, and the user
226 into the pristine file system before starting the restoration of the initial
227 level 0 backup. If the level 0 restores successfully, the
229 flag may be used to restore any necessary incremental backups on top of the
232 flag precludes an interactive file extraction and can be detrimental to one's
233 health (not to mention the disk) if not used carefully. An example:
238 .B mount /dev/sda1 /mnt
242 .B restore rf /dev/st0
249 in the root directory to pass information between incremental restore passes.
250 This file should be removed when the last incremental has been restored.
257 may be used to modify file system parameters such as size or block size.
260 The names of the specified files are listed if they occur on the backup. If no
261 file argument is given, the root directory is listed, which results in the
262 entire content of the backup being listed, unless the
264 flag has been specified. Note that the
266 flag replaces the function of the old
268 program. See also the
273 The named files are read from the given media. If a named file matches a
274 directory whose contents are on the backup and the
276 flag is not specified, the directory is recursively extracted. The owner,
277 modification time, and mode are restored (if possible). If no file argument is
278 given, the root directory is extracted, which results in the entire content of
279 the backup being extracted, unless the
281 flag has been specified. See also the
285 The following additional options may be specified:
294 does ask the user for the volume number on which the files to be extracted are
295 supposed to be (in order to minimise the time by reading only the interesting
298 option disables this behaviour and reads all the volumes starting with 1. This
299 option is useful when the operator does not know on which volume the files to
300 be extracted are and/or when he prefers the longer unattended mode rather than
301 the shorter interactive mode.
303 .BI \-A " archive_file"
304 Read the table of contents from
306 instead of the media. This option can be used in combination with the
311 options, making it possible to check whether files are on the media without
312 having to mount the media.
315 The number of kilobytes per dump record. If the
317 option is not specified,
319 tries to determine the media block size dynamically.
324 will try to determine dynamically whether the dump was made from an old
325 (pre-4.4) or new format file system. The
327 flag disables this check, and only allows reading a dump in the old format.
334 to print debug information.
336 .BI \-D " filesystem"
339 flag allows the user to specify the filesystem name when using
343 option to check the backup.
349 may be a special device file like
353 (a disk drive), an ordinary file, or
355 (the standard input). If the name of the file is of the form
360 reads from the named file on the remote host using
364 Run script at the beginning of each tape. The device name and the current
365 volume number are passed on the command line. The script must return 0 if
367 should continue without asking the user to change the tape, 1 if
369 should continue but ask the user to change the tape. Any other exit code will
372 to abort. For security reasons,
374 reverts back to the real user ID and the real group ID before running the
378 Extract the actual directory, rather than the files that it references. This
379 prevents hierarchical restoration of complete subtrees from the dump.
382 Use Kerberos authentication when contacting the remote tape server. (Only
383 available if this options was enabled when
388 When doing remote restores, assume the remote file is a regular file (instead
389 of a tape device). If you're restoring a remote compressed file, you will need
390 to specify this option or
392 will fail to access it correctly.
397 flag allows the user to specify a maximal number of miscompares when using
401 option to check the backup. If this limit is reached,
403 will abort with an error message. A value of 0 (the default value) disables
407 Extract by inode numbers rather than by file name. This is useful if only a few
408 files are being extracted, and one wants to avoid regenerating the complete
409 pathname to the file.
412 Enables the multi-volume feature (for reading dumps made using the
414 option of dump). The name specified with
416 is treated as a prefix and
418 tries to read in sequence from
419 .I <prefix>001, <prefix>002
427 to perform a full execution as requested by one of
434 command without actually writing any file on disk.
441 to automatically restore the current directory permissions without asking the
442 operator whether to do so in one of
451 in order to read tape position as stored using the dump Quick File Access mode,
459 It is recommended to set up the st driver to return logical tape positions
460 rather than physical before calling
464 Since not all tape devices support physical tape positions those tape devices
465 return an error during
467 when the st driver is set to the default physical setting. Please see the
473 man page, on how to set the driver to return logical tape positions.
479 always make sure the st driver is set to return the same type of tape position
480 used during the call to
486 This option can be used when restoring from local or remote tapes (see above)
487 or from local or remote files.
490 Read from the specified
492 on a multi-file tape. File numbering starts at 1.
497 flag allows the user to specify a directory to use for the storage of temporary
498 files. The default value is
500 This flag is most useful when restoring files after having booted from a
501 floppy. There might be little or no space on the floppy filesystem, but another
502 source of space might exist.
505 When creating certain types of files,
507 may generate a warning diagnostic if they already exist in the target
508 directory. To prevent this, the
512 to remove old entries before attempting to create new ones.
517 does its work silently. The
519 (verbose) flag causes it to type the name of each file it treats preceded by
523 Enables reading multi-volume non-tape mediums like CDROMs.
526 Read list of files to be listed or extracted from the text file
528 in addition to those specified on the command line. This can be used in
535 should contain file names separated by newlines.
537 may be an ordinary file or
539 (the standard input).
542 Do not ask the user whether to abort the restore in the event of an error.
543 Always try to skip over the bad block(s) and continue.
545 Complains if it gets a read error. If
547 has been specified, or the user responds
550 will attempt to continue the restore.
552 If a backup was made using more than one tape volume,
554 will notify the user when it is time to mount the next volume. If the
558 flag has been specified,
560 will also ask which volume the user wishes to mount. The fastest way to extract
561 a few files is to start with the last volume, and work towards the first volume.
563 There are numerous consistency checks that can be listed by
565 Most checks are self-explanatory or can \*(lqnever happen\*(rq. Common errors
568 .I Converting to new file system format
569 A dump tape created from the old file system has been loaded. It is
570 automatically converted to the new file system format.
572 .I <filename>: not found on tape
573 The specified file name was listed in the tape directory, but was not found on
574 the tape. This is caused by tape read errors while looking for the file, and
575 from using a dump tape created on an active file system.
577 .I expected next file <inumber>, got <inumber>
578 A file that was not listed in the directory showed up. This can occur when
579 using a dump created on an active file system.
581 .I Incremental dump too low
582 When doing an incremental restore, a dump that was written before the previous
583 incremental dump, or that has too low an incremental level has been loaded.
585 .I Incremental dump too high
586 When doing an incremental restore, a dump that does not begin its coverage
587 where the previous incremental dump left off, or that has too high an
588 incremental level has been loaded.
590 .I Tape read error while restoring <filename>
592 .I Tape read error while skipping over inode <inumber>
594 .I Tape read error while trying to resynchronize
595 A tape (or other media) read error has occurred. If a file name is specified,
596 its contents are probably partially wrong. If an inode is being skipped or the
597 tape is trying to resynchronize, no extracted files have been corrupted, though
598 files may not be found on the tape.
600 .I resync restore, skipped <num> blocks
601 After a dump read error,
603 may have to resynchronize itself. This message lists the number of blocks that
607 exits with zero status on success. Tape errors are indicated with an exit code
610 When doing a comparison of files from a dump, an exit code of 2 indicates that
611 some files were modified or deleted since the dump was made.
613 If the following environment variable exists it will be utilized by
619 option was specified,
621 will use the device specified via
629 .IR user@host:tapename .
632 The directory given in
634 will be used instead of
636 to store temporary files.
639 The environment variable
641 will be used to determine the pathname of the remote
647 uses the contents of this variable to determine the name of the remote shell
648 command to use when doing a network restore (rsh, ssh etc.). If this variable
651 will be used, but only root will be able to do a network restore.
655 the default tape drive
658 file containing directories on the tape
661 owner, mode, and time stamps for directories
664 information passed between incremental restores
672 can get confused when doing incremental restores from dumps that were made on
675 A level 0 dump must be done after a full restore. Because
677 runs in user code, it has no control over inode allocation; thus a full dump
678 must be done to get a new set of directories reflecting the new inode
679 numbering, even though the content of the files is unchanged.
685 are generated with a unique name based on the date of the dump and the process
694 allows you to restart a
696 operation that may have been interrupted, the temporary files should be the
697 same across different processes. In all other cases, the files are unique
698 because it is possible to have two different dumps started at the same time,
699 and separate operations shouldn't conflict with each other.
701 To do a network restore, you have to run
703 as root or use a remote shell replacement (see
705 variable). This is due to the previous security history of
711 is written to be setuid root, but we are not certain all bugs are gone from the
712 code - run setuid at your own risk.)
714 At the end of restores in
722 will ask the operator whether to set the permissions on the current
723 directory. If the operator confirms this action, the permissions
724 on the directory from where
726 was launched will be replaced by the permissions on the dumped root
727 inode. Although this behaviour is not really a bug, it has proven itself
728 to be confusing for many users, so it is recommended to answer 'no',
729 unless you're performing a full restore and you do want to restore the
732 It should be underlined that because it runs in user code,
736 option, sees the files as the kernel presents them, whereas
738 sees all the files on a given filesystem. In particular, this
739 can cause some confusion when comparing a dumped filesystem a part
740 of which is hidden by a filesystem mounted on top of it.
744 backup suite was ported to Linux's Second Extended File System by Remy Card
745 <card@Linux.EU.Org>. He maintained the initial versions of
747 (up and including 0.4b4, released in january 1997).
749 Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>.
753 backup suite is available from <http://dump.sourceforge.net>
757 command appeared in 4.2BSD.