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 .\" @(#)restore.8 8.4 (Berkeley) 5/1/95
33 .\" $Id: restore.8.in,v 1.1 1999/10/11 13:08:09 stelian Exp $
40 .Nd "restore files or file systems from backups made with dump"
46 .Op Fl D Ar filesystem
91 option syntax is implemented for backward compatibility but
92 is not documented here.)
96 command performs the inverse function of
98 A full backup of a file system may be restored and
99 subsequent incremental backups layered on top of it.
101 directory subtrees may be restored from full or partial
104 works across a network;
107 flag described below.
108 Other arguments to the command are file or directory
109 names specifying the files that are to be restored.
112 flag is specified (see below),
113 the appearance of a directory name refers to
114 the files and (recursively) subdirectories of that directory.
116 Exactly one of the following flags is required:
119 This mode allows comparison of files from a dump.
121 reads the backup and compares its contents with files present on the
123 It first changes its working directory to the root of the filesystem
124 that was dumped and compares the tape with the files in its new
127 This mode allows interactive restoration of files from a dump.
128 After reading in the directory information from the dump,
130 provides a shell like interface that allows the user to move
131 around the directory tree selecting files to be extracted.
132 The available commands are given below;
133 for those commands that require an argument,
134 the default is the current directory.
137 The current directory or specified argument is added to the list of
138 files to be extracted.
139 If a directory is specified, then it and all its descendents are
140 added to the extraction list
143 flag is specified on the command line).
144 Files that are on the extraction list are prepended with a
146 when they are listed by
149 Change the current working directory to the specified argument.
150 .It Ic delete Op Ar arg
151 The current directory or specified argument is deleted from the list of
152 files to be extracted.
153 If a directory is specified, then it and all its descendents are
154 deleted from the extraction list
157 flag is specified on the command line).
158 The most expedient way to extract most of the files from a directory
159 is to add the directory to the extraction list and then delete
160 those files that are not needed.
162 All files on the extraction list are extracted
165 will ask which volume the user wishes to mount.
166 The fastest way to extract a few files is to
167 start with the last volume and work towards the first volume.
169 List a summary of the available commands.
170 .It Ic \&ls Op Ar arg
171 List the current or specified directory.
172 Entries that are directories are appended with a
174 Entries that have been marked for extraction are prepended with a ``*''.
176 flag is set, the inode number of each entry is also listed.
178 Print the full pathname of the current working directory.
180 Restore immediately exits,
181 even if the extraction list is not empty.
183 All directories that have been added to the extraction list
184 have their owner, modes, and times set;
185 nothing is extracted from the dump.
186 This is useful for cleaning up after a restore has been prematurely aborted.
191 When set, the verbose flag causes the
193 command to list the inode numbers of all entries.
196 to print out information about each file as it is extracted.
200 requests a particular tape of a multi-volume set on which to restart
205 This is useful if the restore has been interrupted.
207 Restore (rebuild) a file system.
208 The target file system should be made pristine with
210 mounted, and the user
212 into the pristine file system
213 before starting the restoration of the initial level 0 backup. If the
214 level 0 restores successfully, the
216 flag may be used to restore
217 any necessary incremental backups on top of the level 0.
220 flag precludes an interactive file extraction and can be
221 detrimental to one's health (not to mention the disk) if not used carefully.
223 .Bd -literal -offset indent
235 in the root directory to pass information between incremental
237 This file should be removed when the last incremental has been
245 may be used to modify file system parameters
246 such as size or block size.
248 The names of the specified files are listed if they occur
250 If no file argument is given,
251 the root directory is listed,
252 which results in the entire content of the
256 flag has been specified.
259 flag replaces the function of the old
264 The named files are read from the given media.
265 If a named file matches a directory whose contents
269 flag is not specified,
270 the directory is recursively extracted.
271 The owner, modification time,
272 and mode are restored (if possible).
273 If no file argument is given,
274 the root directory is extracted,
275 which results in the entire content of the
276 backup being extracted,
279 flag has been specified.
282 The following additional options may be specified:
284 .It Fl b Ar blocksize
285 The number of kilobytes per dump record.
288 option is not specified,
290 tries to determine the media block size dynamically.
294 will try to determine dynamically whether the dump was made from an
295 old (pre-4.4) or new format file system. The
297 flag disables this check, and only allows reading a dump in the old
299 .It Fl D Ar filesystem
302 flag allows the user to specify the filesystem name when using
306 option to check the backup.
311 may be a special device file
320 (the standard input).
321 If the name of the file is of the form
326 reads from the named file on the remote host using
330 Use Kerberos authentication when contacting the remote tape server.
331 (Only available if this options was enabled when
336 Extract the actual directory,
337 rather than the files that it references.
338 This prevents hierarchical restoration of complete subtrees
341 Extract by inode numbers rather than by file name.
342 This is useful if only a few files are being extracted,
343 and one wants to avoid regenerating the complete pathname
349 .Nm restore to only print file names. Files are not extracted.
351 Read from the specified
353 on a multi-file tape.
354 File numbering starts at 1.
355 .It Fl T Ar directory
358 flag allows the user to specify a directory to use for the storage of
359 temporary files. The default value is /tmp. This flag is most useful
360 when restoring files after having booted from a floppy. There might be little
361 or no space on the floppy filesystem, but another source of space might exist.
363 When creating certain types of files, restore may generate a warning
364 diagnostic if they already exist in the target directory.
367 (unlink) flag causes restore to remove old entries before attempting
372 does its work silently.
376 flag causes it to type the name of each file it treats
377 preceded by its file type.
379 Do not ask the user whether to abort the restore in the event of an error.
380 Always try to skip over the bad block(s) and continue.
383 Complains if it gets a read error.
386 has been specified, or the user responds
389 will attempt to continue the restore.
391 If a backup was made using more than one tape volume,
393 will notify the user when it is time to mount the next volume.
398 flag has been specified,
400 will also ask which volume the user wishes to mount.
401 The fastest way to extract a few files is to
402 start with the last volume, and work towards the first volume.
404 There are numerous consistency checks that can be listed by
406 Most checks are self-explanatory or can
408 Common errors are given below.
410 .Bl -tag -width Ds -compact
411 .It Converting to new file system format
412 A dump tape created from the old file system has been loaded.
413 It is automatically converted to the new file system format.
415 .It <filename>: not found on tape
416 The specified file name was listed in the tape directory,
417 but was not found on the tape.
418 This is caused by tape read errors while looking for the file,
419 and from using a dump tape created on an active file system.
421 .It expected next file <inumber>, got <inumber>
422 A file that was not listed in the directory showed up.
423 This can occur when using a dump created on an active file system.
425 .It Incremental dump too low
426 When doing an incremental restore,
427 a dump that was written before the previous incremental dump,
428 or that has too low an incremental level has been loaded.
430 .It Incremental dump too high
431 When doing an incremental restore,
432 a dump that does not begin its coverage where the previous incremental
434 or that has too high an incremental level has been loaded.
436 .It Tape read error while restoring <filename>
437 .It Tape read error while skipping over inode <inumber>
438 .It Tape read error while trying to resynchronize
439 A tape (or other media) read error has occurred.
440 If a file name is specified,
441 its contents are probably partially wrong.
442 If an inode is being skipped or the tape is trying to resynchronize,
443 no extracted files have been corrupted,
444 though files may not be found on the tape.
446 .It resync restore, skipped <num> blocks
447 After a dump read error,
449 may have to resynchronize itself.
450 This message lists the number of blocks that were skipped over.
453 If the following environment variable exists it will be utilized by
456 .Bl -tag -width "TMPDIR" -compact
458 If no -f option was specified,
460 will use the device specified via
468 .Qq user@host:tapename .
470 The directory given in
475 to store temporary files.
477 The environment variable
479 will be used to determine the pathname of the remote
483 .Bl -tag -width "./restoresymtable" -compact
485 the default tape drive
487 file containing directories on the tape
489 owner, mode, and time stamps for directories
490 .It Pa \&./restoresymtable
491 information passed between incremental restores
500 can get confused when doing incremental restores from
501 dumps that were made on active file systems.
503 A level 0 dump must be done after a full restore.
507 it has no control over inode allocation;
508 thus a full dump must be done to get a new set of directories
509 reflecting the new inode numbering,
510 even though the content of the files is unchanged.
516 are generated with a unique name based on the date of the dump
517 and the process ID (see
526 allows you to restart a
528 operation that may have been interrupted, the temporary files should
529 be the same across different processes.
530 In all other cases, the files are unique because it is possible to
531 have two different dumps started at the same time, and separate
532 operations shouldn't conflict with each other.
534 To do a network restore, you have to run restore as root. This is due
535 to the previous security history of dump and restore. (restore is
536 written to be setuid root, but we are not certain all bugs are gone
537 from the restore code - run setuid at your own risk.)
541 backup suit was ported to Linux's Second Extended File System
542 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
543 of dump (up and including 0.4b4, released in january 1997).
545 Starting with 0.4b5, the new maintainer is Stelian Pop
551 backup suit is available for anonymous ftp from tsx-11.mit.edu
552 in /pub/linux/ALPHA/ext2fs (development versions) or
553 /pub/linux/packages/ext2fs (stable versions).
555 An alternate downloading location is http://perso.cybercable.fr/pop/dump.