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.10 2000/05/28 16:52:21 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
92 option syntax is implemented for backward compatibility but
93 is not documented here.)
97 command performs the inverse function of
99 A full backup of a file system may be restored and
100 subsequent incremental backups layered on top of it.
102 directory subtrees may be restored from full or partial
105 works across a network;
108 flag described below.
109 Other arguments to the command are file or directory
110 names specifying the files that are to be restored.
113 flag is specified (see below),
114 the appearance of a directory name refers to
115 the files and (recursively) subdirectories of that directory.
117 Exactly one of the following flags is required:
120 This mode allows comparison of files from a dump.
122 reads the backup and compares its contents with files present on the
124 It first changes its working directory to the root of the filesystem
125 that was dumped and compares the tape with the files in its new
128 This mode allows interactive restoration of files from a dump.
129 After reading in the directory information from the dump,
131 provides a shell like interface that allows the user to move
132 around the directory tree selecting files to be extracted.
133 The available commands are given below;
134 for those commands that require an argument,
135 the default is the current directory.
138 The current directory or specified argument is added to the list of
139 files to be extracted.
140 If a directory is specified, then it and all its descendents are
141 added to the extraction list
144 flag is specified on the command line).
145 Files that are on the extraction list are prepended with a
147 when they are listed by
150 Change the current working directory to the specified argument.
151 .It Ic delete Op Ar arg
152 The current directory or specified argument is deleted from the list of
153 files to be extracted.
154 If a directory is specified, then it and all its descendents are
155 deleted from the extraction list
158 flag is specified on the command line).
159 The most expedient way to extract most of the files from a directory
160 is to add the directory to the extraction list and then delete
161 those files that are not needed.
163 All files on the extraction list are extracted
166 will ask which volume the user wishes to mount.
167 The fastest way to extract a few files is to
168 start with the last volume and work towards the first volume.
170 List a summary of the available commands.
171 .It Ic \&ls Op Ar arg
172 List the current or specified directory.
173 Entries that are directories are appended with a
175 Entries that have been marked for extraction are prepended with a ``*''.
177 flag is set, the inode number of each entry is also listed.
179 Print the full pathname of the current working directory.
181 Restore immediately exits,
182 even if the extraction list is not empty.
184 All directories that have been added to the extraction list
185 have their owner, modes, and times set;
186 nothing is extracted from the dump.
187 This is useful for cleaning up after a restore has been prematurely aborted.
192 When set, the verbose flag causes the
194 command to list the inode numbers of all entries.
197 to print out information about each file as it is extracted.
201 requests a particular tape of a multi-volume set on which to restart
206 This is useful if the restore has been interrupted.
208 Restore (rebuild) a file system.
209 The target file system should be made pristine with
211 mounted, and the user
213 into the pristine file system
214 before starting the restoration of the initial level 0 backup. If the
215 level 0 restores successfully, the
217 flag may be used to restore
218 any necessary incremental backups on top of the level 0.
221 flag precludes an interactive file extraction and can be
222 detrimental to one's health (not to mention the disk) if not used carefully.
224 .Bd -literal -offset indent
236 in the root directory to pass information between incremental
238 This file should be removed when the last incremental has been
246 may be used to modify file system parameters
247 such as size or block size.
249 The names of the specified files are listed if they occur
251 If no file argument is given,
252 the root directory is listed,
253 which results in the entire content of the
257 flag has been specified.
260 flag replaces the function of the old
268 The named files are read from the given media.
269 If a named file matches a directory whose contents
273 flag is not specified,
274 the directory is recursively extracted.
275 The owner, modification time,
276 and mode are restored (if possible).
277 If no file argument is given,
278 the root directory is extracted,
279 which results in the entire content of the
280 backup being extracted,
283 flag has been specified.
289 The following additional options may be specified:
291 .It Fl b Ar blocksize
292 The number of kilobytes per dump record.
295 option is not specified,
297 tries to determine the media block size dynamically.
301 will try to determine dynamically whether the dump was made from an
302 old (pre-4.4) or new format file system. The
304 flag disables this check, and only allows reading a dump in the old
306 .It Fl D Ar filesystem
309 flag allows the user to specify the filesystem name when using
313 option to check the backup.
318 may be a special device file
327 (the standard input).
328 If the name of the file is of the form
333 reads from the named file on the remote host using
337 Use Kerberos authentication when contacting the remote tape server.
338 (Only available if this options was enabled when
343 Extract the actual directory,
344 rather than the files that it references.
345 This prevents hierarchical restoration of complete subtrees
348 Extract by inode numbers rather than by file name.
349 This is useful if only a few files are being extracted,
350 and one wants to avoid regenerating the complete pathname
353 Enables the multi-volume feature (for reading dumps made using
356 option of dump). The name specified with
358 is treated as a prefix and
360 tries to read in sequence from <prefix>001, <prefix>002 etc.
366 to only print file names. Files are not extracted.
368 Read from the specified
370 on a multi-file tape.
371 File numbering starts at 1.
372 .It Fl T Ar directory
375 flag allows the user to specify a directory to use for the storage of
376 temporary files. The default value is /tmp. This flag is most useful
377 when restoring files after having booted from a floppy. There might be little
378 or no space on the floppy filesystem, but another source of space might exist.
380 When creating certain types of files, restore may generate a warning
381 diagnostic if they already exist in the target directory.
384 (unlink) flag causes restore to remove old entries before attempting
389 does its work silently.
393 flag causes it to type the name of each file it treats
394 preceded by its file type.
396 Read list of files to be listed or extracted from the text file
398 in addition to those specified on the command line. This can be used in
405 should contain file names separated by newlines.
407 may be an ordinary file or
409 (the standard input).
411 Do not ask the user whether to abort the restore in the event of an error.
412 Always try to skip over the bad block(s) and continue.
415 Complains if it gets a read error.
418 has been specified, or the user responds
421 will attempt to continue the restore.
423 If a backup was made using more than one tape volume,
425 will notify the user when it is time to mount the next volume.
430 flag has been specified,
432 will also ask which volume the user wishes to mount.
433 The fastest way to extract a few files is to
434 start with the last volume, and work towards the first volume.
436 There are numerous consistency checks that can be listed by
438 Most checks are self-explanatory or can
440 Common errors are given below.
442 .Bl -tag -width Ds -compact
443 .It Converting to new file system format
444 A dump tape created from the old file system has been loaded.
445 It is automatically converted to the new file system format.
447 .It <filename>: not found on tape
448 The specified file name was listed in the tape directory,
449 but was not found on the tape.
450 This is caused by tape read errors while looking for the file,
451 and from using a dump tape created on an active file system.
453 .It expected next file <inumber>, got <inumber>
454 A file that was not listed in the directory showed up.
455 This can occur when using a dump created on an active file system.
457 .It Incremental dump too low
458 When doing an incremental restore,
459 a dump that was written before the previous incremental dump,
460 or that has too low an incremental level has been loaded.
462 .It Incremental dump too high
463 When doing an incremental restore,
464 a dump that does not begin its coverage where the previous incremental
466 or that has too high an incremental level has been loaded.
468 .It Tape read error while restoring <filename>
469 .It Tape read error while skipping over inode <inumber>
470 .It Tape read error while trying to resynchronize
471 A tape (or other media) read error has occurred.
472 If a file name is specified,
473 its contents are probably partially wrong.
474 If an inode is being skipped or the tape is trying to resynchronize,
475 no extracted files have been corrupted,
476 though files may not be found on the tape.
478 .It resync restore, skipped <num> blocks
479 After a dump read error,
481 may have to resynchronize itself.
482 This message lists the number of blocks that were skipped over.
486 exits with zero status on success.
487 Tape errors are indicated with an exit code of 1.
489 When doing a comparison of files from a dump, an exit code
490 of 2 indicates that some files were modified or deleted since
493 If the following environment variable exists it will be utilized by
496 .Bl -tag -width "TMPDIR" -compact
498 If no -f option was specified,
500 will use the device specified via
508 .Qq user@host:tapename .
510 The directory given in
515 to store temporary files.
517 The environment variable
519 will be used to determine the pathname of the remote
524 uses the contents of this variable to determine the name of the
525 remote shell command to use when doing a network restore (rsh, ssh etc.).
526 If this variable is not set,
528 will be used, but only root will be able to do a network restore.
530 .Bl -tag -width "./restoresymtable" -compact
532 the default tape drive
534 file containing directories on the tape
536 owner, mode, and time stamps for directories
537 .It Pa \&./restoresymtable
538 information passed between incremental restores
547 can get confused when doing incremental restores from
548 dumps that were made on active file systems.
550 A level 0 dump must be done after a full restore.
554 it has no control over inode allocation;
555 thus a full dump must be done to get a new set of directories
556 reflecting the new inode numbering,
557 even though the content of the files is unchanged.
563 are generated with a unique name based on the date of the dump
564 and the process ID (see
573 allows you to restart a
575 operation that may have been interrupted, the temporary files should
576 be the same across different processes.
577 In all other cases, the files are unique because it is possible to
578 have two different dumps started at the same time, and separate
579 operations shouldn't conflict with each other.
581 To do a network restore, you have to run restore as root or use
582 a remote shell replacement (see RSH variable). This is due
583 to the previous security history of dump and restore. (restore is
584 written to be setuid root, but we are not certain all bugs are gone
585 from the restore code - run setuid at your own risk.)
589 backup suit was ported to Linux's Second Extended File System
590 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
591 of dump (up and including 0.4b4, released in january 1997).
593 Starting with 0.4b5, the new maintainer is Stelian Pop
599 backup suit is available from
601 http://dump.sourceforge.net
projects / dump.git / blob