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.14 2001/04/24 15:04:59 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
95 option syntax is implemented for backward compatibility but
96 is not documented here.)
100 command performs the inverse function of
102 A full backup of a file system may be restored and
103 subsequent incremental backups layered on top of it.
105 directory subtrees may be restored from full or partial
108 works across a network;
111 flag described below.
112 Other arguments to the command are file or directory
113 names specifying the files that are to be restored.
116 flag is specified (see below),
117 the appearance of a directory name refers to
118 the files and (recursively) subdirectories of that directory.
120 Exactly one of the following flags is required:
123 This mode allows comparison of files from a dump.
125 reads the backup and compares its contents with files present on the
127 It first changes its working directory to the root of the filesystem
128 that was dumped and compares the tape with the files in its new
131 This mode allows interactive restoration of files from a dump.
132 After reading in the directory information from the dump,
134 provides a shell like interface that allows the user to move
135 around the directory tree selecting files to be extracted.
136 The available commands are given below;
137 for those commands that require an argument,
138 the default is the current directory.
141 The current directory or specified argument is added to the list of
142 files to be extracted.
143 If a directory is specified, then it and all its descendents are
144 added to the extraction list
147 flag is specified on the command line).
148 Files that are on the extraction list are prepended with a
150 when they are listed by
153 Change the current working directory to the specified argument.
154 .It Ic delete Op Ar arg
155 The current directory or specified argument is deleted from the list of
156 files to be extracted.
157 If a directory is specified, then it and all its descendents are
158 deleted from the extraction list
161 flag is specified on the command line).
162 The most expedient way to extract most of the files from a directory
163 is to add the directory to the extraction list and then delete
164 those files that are not needed.
166 All files on the extraction list are extracted
169 will ask which volume the user wishes to mount.
170 The fastest way to extract a few files is to
171 start with the last volume and work towards the first volume.
173 List a summary of the available commands.
174 .It Ic \&ls Op Ar arg
175 List the current or specified directory.
176 Entries that are directories are appended with a
178 Entries that have been marked for extraction are prepended with a ``*''.
180 flag is set, the inode number of each entry is also listed.
182 Print the full pathname of the current working directory.
184 Restore immediately exits,
185 even if the extraction list is not empty.
187 All directories that have been added to the extraction list
188 have their owner, modes, and times set;
189 nothing is extracted from the dump.
190 This is useful for cleaning up after a restore has been prematurely aborted.
195 When set, the verbose flag causes the
197 command to list the inode numbers of all entries.
200 to print out information about each file as it is extracted.
204 requests a particular tape of a multi-volume set on which to restart
209 This is useful if the restore has been interrupted.
211 Restore (rebuild) a file system.
212 The target file system should be made pristine with
214 mounted, and the user
216 into the pristine file system
217 before starting the restoration of the initial level 0 backup. If the
218 level 0 restores successfully, the
220 flag may be used to restore
221 any necessary incremental backups on top of the level 0.
224 flag precludes an interactive file extraction and can be
225 detrimental to one's health (not to mention the disk) if not used carefully.
227 .Bd -literal -offset indent
239 in the root directory to pass information between incremental
241 This file should be removed when the last incremental has been
249 may be used to modify file system parameters
250 such as size or block size.
252 The names of the specified files are listed if they occur
254 If no file argument is given,
255 the root directory is listed,
256 which results in the entire content of the
260 flag has been specified.
263 flag replaces the function of the old
271 The named files are read from the given media.
272 If a named file matches a directory whose contents
276 flag is not specified,
277 the directory is recursively extracted.
278 The owner, modification time,
279 and mode are restored (if possible).
280 If no file argument is given,
281 the root directory is extracted,
282 which results in the entire content of the
283 backup being extracted,
286 flag has been specified.
292 The following additional options may be specified:
294 .It Fl b Ar blocksize
295 The number of kilobytes per dump record.
298 option is not specified,
300 tries to determine the media block size dynamically.
304 will try to determine dynamically whether the dump was made from an
305 old (pre-4.4) or new format file system. The
307 flag disables this check, and only allows reading a dump in the old
309 .It Fl D Ar filesystem
312 flag allows the user to specify the filesystem name when using
316 option to check the backup.
321 may be a special device file
330 (the standard input).
331 If the name of the file is of the form
336 reads from the named file on the remote host using
340 Use Kerberos authentication when contacting the remote tape server.
341 (Only available if this options was enabled when
346 Extract the actual directory,
347 rather than the files that it references.
348 This prevents hierarchical restoration of complete subtrees
351 Extract by inode numbers rather than by file name.
352 This is useful if only a few files are being extracted,
353 and one wants to avoid regenerating the complete pathname
356 Enables the multi-volume feature (for reading dumps made using
359 option of dump). The name specified with
361 is treated as a prefix and
363 tries to read in sequence from <prefix>001, <prefix>002 etc.
369 to only print file names. Files are not extracted.
373 in order to read tape position as stored using the dump Quick File
376 Read from the specified
378 on a multi-file tape.
379 File numbering starts at 1.
380 .It Fl T Ar directory
383 flag allows the user to specify a directory to use for the storage of
384 temporary files. The default value is /tmp. This flag is most useful
385 when restoring files after having booted from a floppy. There might be little
386 or no space on the floppy filesystem, but another source of space might exist.
388 When creating certain types of files, restore may generate a warning
389 diagnostic if they already exist in the target directory.
392 (unlink) flag causes restore to remove old entries before attempting
397 does its work silently.
401 flag causes it to type the name of each file it treats
402 preceded by its file type.
404 Read list of files to be listed or extracted from the text file
406 in addition to those specified on the command line. This can be used in
413 should contain file names separated by newlines.
415 may be an ordinary file or
417 (the standard input).
419 Do not ask the user whether to abort the restore in the event of an error.
420 Always try to skip over the bad block(s) and continue.
423 Complains if it gets a read error.
426 has been specified, or the user responds
429 will attempt to continue the restore.
431 If a backup was made using more than one tape volume,
433 will notify the user when it is time to mount the next volume.
438 flag has been specified,
440 will also ask which volume the user wishes to mount.
441 The fastest way to extract a few files is to
442 start with the last volume, and work towards the first volume.
444 There are numerous consistency checks that can be listed by
446 Most checks are self-explanatory or can
448 Common errors are given below.
450 .Bl -tag -width Ds -compact
451 .It Converting to new file system format
452 A dump tape created from the old file system has been loaded.
453 It is automatically converted to the new file system format.
455 .It <filename>: not found on tape
456 The specified file name was listed in the tape directory,
457 but was not found on the tape.
458 This is caused by tape read errors while looking for the file,
459 and from using a dump tape created on an active file system.
461 .It expected next file <inumber>, got <inumber>
462 A file that was not listed in the directory showed up.
463 This can occur when using a dump created on an active file system.
465 .It Incremental dump too low
466 When doing an incremental restore,
467 a dump that was written before the previous incremental dump,
468 or that has too low an incremental level has been loaded.
470 .It Incremental dump too high
471 When doing an incremental restore,
472 a dump that does not begin its coverage where the previous incremental
474 or that has too high an incremental level has been loaded.
476 .It Tape read error while restoring <filename>
477 .It Tape read error while skipping over inode <inumber>
478 .It Tape read error while trying to resynchronize
479 A tape (or other media) read error has occurred.
480 If a file name is specified,
481 its contents are probably partially wrong.
482 If an inode is being skipped or the tape is trying to resynchronize,
483 no extracted files have been corrupted,
484 though files may not be found on the tape.
486 .It resync restore, skipped <num> blocks
487 After a dump read error,
489 may have to resynchronize itself.
490 This message lists the number of blocks that were skipped over.
494 exits with zero status on success.
495 Tape errors are indicated with an exit code of 1.
497 When doing a comparison of files from a dump, an exit code
498 of 2 indicates that some files were modified or deleted since
501 If the following environment variable exists it will be utilized by
504 .Bl -tag -width "TMPDIR" -compact
506 If no -f option was specified,
508 will use the device specified via
516 .Qq user@host:tapename .
518 The directory given in
523 to store temporary files.
525 The environment variable
527 will be used to determine the pathname of the remote
532 uses the contents of this variable to determine the name of the
533 remote shell command to use when doing a network restore (rsh, ssh etc.).
534 If this variable is not set,
536 will be used, but only root will be able to do a network restore.
538 .Bl -tag -width "./restoresymtable" -compact
540 the default tape drive
542 file containing directories on the tape
544 owner, mode, and time stamps for directories
545 .It Pa \&./restoresymtable
546 information passed between incremental restores
555 can get confused when doing incremental restores from
556 dumps that were made on active file systems.
558 A level 0 dump must be done after a full restore.
562 it has no control over inode allocation;
563 thus a full dump must be done to get a new set of directories
564 reflecting the new inode numbering,
565 even though the content of the files is unchanged.
571 are generated with a unique name based on the date of the dump
572 and the process ID (see
581 allows you to restart a
583 operation that may have been interrupted, the temporary files should
584 be the same across different processes.
585 In all other cases, the files are unique because it is possible to
586 have two different dumps started at the same time, and separate
587 operations shouldn't conflict with each other.
589 To do a network restore, you have to run restore as root or use
590 a remote shell replacement (see RSH variable). This is due
591 to the previous security history of dump and restore. (restore is
592 written to be setuid root, but we are not certain all bugs are gone
593 from the restore code - run setuid at your own risk.)
597 backup suite was ported to Linux's Second Extended File System
598 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
599 of dump (up and including 0.4b4, released in january 1997).
601 Starting with 0.4b5, the new maintainer is Stelian Pop
607 backup suite is available from
609 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob