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.7 2000/01/21 10:23:30 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
90 option syntax is implemented for backward compatibility but
91 is not documented here.)
95 command performs the inverse function of
97 A full backup of a file system may be restored and
98 subsequent incremental backups layered on top of it.
100 directory subtrees may be restored from full or partial
103 works across a network;
106 flag described below.
107 Other arguments to the command are file or directory
108 names specifying the files that are to be restored.
111 flag is specified (see below),
112 the appearance of a directory name refers to
113 the files and (recursively) subdirectories of that directory.
115 Exactly one of the following flags is required:
118 This mode allows comparison of files from a dump.
120 reads the backup and compares its contents with files present on the
122 It first changes its working directory to the root of the filesystem
123 that was dumped and compares the tape with the files in its new
126 This mode allows interactive restoration of files from a dump.
127 After reading in the directory information from the dump,
129 provides a shell like interface that allows the user to move
130 around the directory tree selecting files to be extracted.
131 The available commands are given below;
132 for those commands that require an argument,
133 the default is the current directory.
136 The current directory or specified argument is added to the list of
137 files to be extracted.
138 If a directory is specified, then it and all its descendents are
139 added to the extraction list
142 flag is specified on the command line).
143 Files that are on the extraction list are prepended with a
145 when they are listed by
148 Change the current working directory to the specified argument.
149 .It Ic delete Op Ar arg
150 The current directory or specified argument is deleted from the list of
151 files to be extracted.
152 If a directory is specified, then it and all its descendents are
153 deleted from the extraction list
156 flag is specified on the command line).
157 The most expedient way to extract most of the files from a directory
158 is to add the directory to the extraction list and then delete
159 those files that are not needed.
161 All files on the extraction list are extracted
164 will ask which volume the user wishes to mount.
165 The fastest way to extract a few files is to
166 start with the last volume and work towards the first volume.
168 List a summary of the available commands.
169 .It Ic \&ls Op Ar arg
170 List the current or specified directory.
171 Entries that are directories are appended with a
173 Entries that have been marked for extraction are prepended with a ``*''.
175 flag is set, the inode number of each entry is also listed.
177 Print the full pathname of the current working directory.
179 Restore immediately exits,
180 even if the extraction list is not empty.
182 All directories that have been added to the extraction list
183 have their owner, modes, and times set;
184 nothing is extracted from the dump.
185 This is useful for cleaning up after a restore has been prematurely aborted.
190 When set, the verbose flag causes the
192 command to list the inode numbers of all entries.
195 to print out information about each file as it is extracted.
199 requests a particular tape of a multi-volume set on which to restart
204 This is useful if the restore has been interrupted.
206 Restore (rebuild) a file system.
207 The target file system should be made pristine with
209 mounted, and the user
211 into the pristine file system
212 before starting the restoration of the initial level 0 backup. If the
213 level 0 restores successfully, the
215 flag may be used to restore
216 any necessary incremental backups on top of the level 0.
219 flag precludes an interactive file extraction and can be
220 detrimental to one's health (not to mention the disk) if not used carefully.
222 .Bd -literal -offset indent
234 in the root directory to pass information between incremental
236 This file should be removed when the last incremental has been
244 may be used to modify file system parameters
245 such as size or block size.
247 The names of the specified files are listed if they occur
249 If no file argument is given,
250 the root directory is listed,
251 which results in the entire content of the
255 flag has been specified.
258 flag replaces the function of the old
263 The named files are read from the given media.
264 If a named file matches a directory whose contents
268 flag is not specified,
269 the directory is recursively extracted.
270 The owner, modification time,
271 and mode are restored (if possible).
272 If no file argument is given,
273 the root directory is extracted,
274 which results in the entire content of the
275 backup being extracted,
278 flag has been specified.
281 The following additional options may be specified:
283 .It Fl b Ar blocksize
284 The number of kilobytes per dump record.
287 option is not specified,
289 tries to determine the media block size dynamically.
293 will try to determine dynamically whether the dump was made from an
294 old (pre-4.4) or new format file system. The
296 flag disables this check, and only allows reading a dump in the old
298 .It Fl D Ar filesystem
301 flag allows the user to specify the filesystem name when using
305 option to check the backup.
310 may be a special device file
319 (the standard input).
320 If the name of the file is of the form
325 reads from the named file on the remote host using
329 Use Kerberos authentication when contacting the remote tape server.
330 (Only available if this options was enabled when
335 Extract the actual directory,
336 rather than the files that it references.
337 This prevents hierarchical restoration of complete subtrees
340 Extract by inode numbers rather than by file name.
341 This is useful if only a few files are being extracted,
342 and one wants to avoid regenerating the complete pathname
345 Enables the multi-volume feature (for reading dumps made using
348 option of dump). The name specified with
350 is treated as a prefix and
352 tries to read in sequence from <prefix>001, <prefix>002 etc.
358 to only print file names. Files are not extracted.
360 Read from the specified
362 on a multi-file tape.
363 File numbering starts at 1.
364 .It Fl T Ar directory
367 flag allows the user to specify a directory to use for the storage of
368 temporary files. The default value is /tmp. This flag is most useful
369 when restoring files after having booted from a floppy. There might be little
370 or no space on the floppy filesystem, but another source of space might exist.
372 When creating certain types of files, restore may generate a warning
373 diagnostic if they already exist in the target directory.
376 (unlink) flag causes restore to remove old entries before attempting
381 does its work silently.
385 flag causes it to type the name of each file it treats
386 preceded by its file type.
388 Do not ask the user whether to abort the restore in the event of an error.
389 Always try to skip over the bad block(s) and continue.
392 Complains if it gets a read error.
395 has been specified, or the user responds
398 will attempt to continue the restore.
400 If a backup was made using more than one tape volume,
402 will notify the user when it is time to mount the next volume.
407 flag has been specified,
409 will also ask which volume the user wishes to mount.
410 The fastest way to extract a few files is to
411 start with the last volume, and work towards the first volume.
413 There are numerous consistency checks that can be listed by
415 Most checks are self-explanatory or can
417 Common errors are given below.
419 .Bl -tag -width Ds -compact
420 .It Converting to new file system format
421 A dump tape created from the old file system has been loaded.
422 It is automatically converted to the new file system format.
424 .It <filename>: not found on tape
425 The specified file name was listed in the tape directory,
426 but was not found on the tape.
427 This is caused by tape read errors while looking for the file,
428 and from using a dump tape created on an active file system.
430 .It expected next file <inumber>, got <inumber>
431 A file that was not listed in the directory showed up.
432 This can occur when using a dump created on an active file system.
434 .It Incremental dump too low
435 When doing an incremental restore,
436 a dump that was written before the previous incremental dump,
437 or that has too low an incremental level has been loaded.
439 .It Incremental dump too high
440 When doing an incremental restore,
441 a dump that does not begin its coverage where the previous incremental
443 or that has too high an incremental level has been loaded.
445 .It Tape read error while restoring <filename>
446 .It Tape read error while skipping over inode <inumber>
447 .It Tape read error while trying to resynchronize
448 A tape (or other media) read error has occurred.
449 If a file name is specified,
450 its contents are probably partially wrong.
451 If an inode is being skipped or the tape is trying to resynchronize,
452 no extracted files have been corrupted,
453 though files may not be found on the tape.
455 .It resync restore, skipped <num> blocks
456 After a dump read error,
458 may have to resynchronize itself.
459 This message lists the number of blocks that were skipped over.
462 If the following environment variable exists it will be utilized by
465 .Bl -tag -width "TMPDIR" -compact
467 If no -f option was specified,
469 will use the device specified via
477 .Qq user@host:tapename .
479 The directory given in
484 to store temporary files.
486 The environment variable
488 will be used to determine the pathname of the remote
493 uses the contents of this variable to determine the name of the
494 remote shell command to use when doing a network restore (rsh, ssh etc.).
495 If this variable is not set,
497 will be used, but only root will be able to do a network restore.
499 .Bl -tag -width "./restoresymtable" -compact
501 the default tape drive
503 file containing directories on the tape
505 owner, mode, and time stamps for directories
506 .It Pa \&./restoresymtable
507 information passed between incremental restores
516 can get confused when doing incremental restores from
517 dumps that were made on active file systems.
519 A level 0 dump must be done after a full restore.
523 it has no control over inode allocation;
524 thus a full dump must be done to get a new set of directories
525 reflecting the new inode numbering,
526 even though the content of the files is unchanged.
532 are generated with a unique name based on the date of the dump
533 and the process ID (see
542 allows you to restart a
544 operation that may have been interrupted, the temporary files should
545 be the same across different processes.
546 In all other cases, the files are unique because it is possible to
547 have two different dumps started at the same time, and separate
548 operations shouldn't conflict with each other.
550 To do a network restore, you have to run restore as root or use
551 a remote shell replacement (see RSH variable). This is due
552 to the previous security history of dump and restore. (restore is
553 written to be setuid root, but we are not certain all bugs are gone
554 from the restore code - run setuid at your own risk.)
558 backup suit was ported to Linux's Second Extended File System
559 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
560 of dump (up and including 0.4b4, released in january 1997).
562 Starting with 0.4b5, the new maintainer is Stelian Pop
568 backup suit is available from
570 http://dump.sourceforge.net