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.21 2002/01/16 09:32:14 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:
304 .It Fl b Ar blocksize
305 The number of kilobytes per dump record.
308 option is not specified,
310 tries to determine the media block size dynamically.
314 will try to determine dynamically whether the dump was made from an
315 old (pre-4.4) or new format file system. The
317 flag disables this check, and only allows reading a dump in the old
319 .It Fl D Ar filesystem
322 flag allows the user to specify the filesystem name when using
326 option to check the backup.
331 may be a special device file
340 (the standard input).
341 If the name of the file is of the form
346 reads from the named file on the remote host using
350 Run script at the beginning of each tape. The device name and the
351 current volume number are passed on the command line.
352 The script must return 0 if
354 should continue without asking the user to change the tape, 1 if
356 should continue but ask the user to change the tape.
357 Any other exit code will cause
360 For security reasons,
362 reverts back to the real user ID and the real group ID before
365 Use Kerberos authentication when contacting the remote tape server.
366 (Only available if this options was enabled when
371 Extract the actual directory,
372 rather than the files that it references.
373 This prevents hierarchical restoration of complete subtrees
376 When doing remote restores, assume the remote file is a
377 regular file (instead of a tape device). If you're restoring
378 a remote compressed file, you will need to specify this
381 will fail to access it correctly.
385 flag allows the user to specify a maximal number of miscompares
390 option to check the backup. If this limit is reached,
392 will abort with an error message. A value of 0 (the default value)
395 Extract by inode numbers rather than by file name.
396 This is useful if only a few files are being extracted,
397 and one wants to avoid regenerating the complete pathname
400 Enables the multi-volume feature (for reading dumps made using
403 option of dump). The name specified with
405 is treated as a prefix and
407 tries to read in sequence from <prefix>001, <prefix>002 etc.
413 to perform a full execution as requested by one of
420 command without actually writing any file on disk.
424 in order to read tape position as stored using the dump Quick File
427 It is recommended to set up the st driver to return logical tape
428 positions rather than physical before calling dump/restore with
429 parameter Q. Since not all tape devices support physical tape
430 positions those tape devices return an error during dump/restore when
431 the st driver is set to the default physical setting.
432 Please see the st man page, option MTSETDRVBUFFER, or the mt man
433 page, on how to set the driver to return logical tape positions.
435 Before calling restore with parameter Q, always make sure the st
436 driver is set to return the same type of tape position used during the
437 call to dump. Otherwise restore may be confused.
439 Read from the specified
441 on a multi-file tape.
442 File numbering starts at 1.
443 .It Fl T Ar directory
446 flag allows the user to specify a directory to use for the storage of
447 temporary files. The default value is /tmp. This flag is most useful
448 when restoring files after having booted from a floppy. There might be little
449 or no space on the floppy filesystem, but another source of space might exist.
451 When creating certain types of files, restore may generate a warning
452 diagnostic if they already exist in the target directory.
455 (unlink) flag causes restore to remove old entries before attempting
460 does its work silently.
464 flag causes it to type the name of each file it treats
465 preceded by its file type.
467 Enables reading multi-volume non-tape mediums like CDROMs.
469 Read list of files to be listed or extracted from the text file
471 in addition to those specified on the command line. This can be used in
478 should contain file names separated by newlines.
480 may be an ordinary file or
482 (the standard input).
484 Do not ask the user whether to abort the restore in the event of an error.
485 Always try to skip over the bad block(s) and continue.
488 Complains if it gets a read error.
491 has been specified, or the user responds
494 will attempt to continue the restore.
496 If a backup was made using more than one tape volume,
498 will notify the user when it is time to mount the next volume.
503 flag has been specified,
505 will also ask which volume the user wishes to mount.
506 The fastest way to extract a few files is to
507 start with the last volume, and work towards the first volume.
509 There are numerous consistency checks that can be listed by
511 Most checks are self-explanatory or can
513 Common errors are given below.
515 .Bl -tag -width Ds -compact
516 .It Converting to new file system format
517 A dump tape created from the old file system has been loaded.
518 It is automatically converted to the new file system format.
520 .It <filename>: not found on tape
521 The specified file name was listed in the tape directory,
522 but was not found on the tape.
523 This is caused by tape read errors while looking for the file,
524 and from using a dump tape created on an active file system.
526 .It expected next file <inumber>, got <inumber>
527 A file that was not listed in the directory showed up.
528 This can occur when using a dump created on an active file system.
530 .It Incremental dump too low
531 When doing an incremental restore,
532 a dump that was written before the previous incremental dump,
533 or that has too low an incremental level has been loaded.
535 .It Incremental dump too high
536 When doing an incremental restore,
537 a dump that does not begin its coverage where the previous incremental
539 or that has too high an incremental level has been loaded.
541 .It Tape read error while restoring <filename>
542 .It Tape read error while skipping over inode <inumber>
543 .It Tape read error while trying to resynchronize
544 A tape (or other media) read error has occurred.
545 If a file name is specified,
546 its contents are probably partially wrong.
547 If an inode is being skipped or the tape is trying to resynchronize,
548 no extracted files have been corrupted,
549 though files may not be found on the tape.
551 .It resync restore, skipped <num> blocks
552 After a dump read error,
554 may have to resynchronize itself.
555 This message lists the number of blocks that were skipped over.
559 exits with zero status on success.
560 Tape errors are indicated with an exit code of 1.
562 When doing a comparison of files from a dump, an exit code
563 of 2 indicates that some files were modified or deleted since
566 If the following environment variable exists it will be utilized by
569 .Bl -tag -width "TMPDIR" -compact
571 If no -f option was specified,
573 will use the device specified via
581 .Qq user@host:tapename .
583 The directory given in
588 to store temporary files.
590 The environment variable
592 will be used to determine the pathname of the remote
597 uses the contents of this variable to determine the name of the
598 remote shell command to use when doing a network restore (rsh, ssh etc.).
599 If this variable is not set,
601 will be used, but only root will be able to do a network restore.
604 .Bl -tag -width "./restoresymtable" -compact
606 the default tape drive
608 file containing directories on the tape
610 owner, mode, and time stamps for directories
611 .It Pa \&./restoresymtable
612 information passed between incremental restores
621 can get confused when doing incremental restores from
622 dumps that were made on active file systems.
624 A level 0 dump must be done after a full restore.
628 it has no control over inode allocation;
629 thus a full dump must be done to get a new set of directories
630 reflecting the new inode numbering,
631 even though the content of the files is unchanged.
637 are generated with a unique name based on the date of the dump
638 and the process ID (see
647 allows you to restart a
649 operation that may have been interrupted, the temporary files should
650 be the same across different processes.
651 In all other cases, the files are unique because it is possible to
652 have two different dumps started at the same time, and separate
653 operations shouldn't conflict with each other.
655 To do a network restore, you have to run restore as root or use
656 a remote shell replacement (see RSH variable). This is due
657 to the previous security history of dump and restore. (restore is
658 written to be setuid root, but we are not certain all bugs are gone
659 from the restore code - run setuid at your own risk.)
663 backup suite was ported to Linux's Second Extended File System
664 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
665 of dump (up and including 0.4b4, released in january 1997).
667 Starting with 0.4b5, the new maintainer is Stelian Pop
669 <stelian@popies.net>.
673 backup suite is available from
675 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob