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.15 2001/07/18 12:54:06 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
101 option syntax is implemented for backward compatibility but
102 is not documented here.)
106 command performs the inverse function of
108 A full backup of a file system may be restored and
109 subsequent incremental backups layered on top of it.
111 directory subtrees may be restored from full or partial
114 works across a network;
117 flag described below.
118 Other arguments to the command are file or directory
119 names specifying the files that are to be restored.
122 flag is specified (see below),
123 the appearance of a directory name refers to
124 the files and (recursively) subdirectories of that directory.
126 Exactly one of the following flags is required:
129 This mode allows comparison of files from a dump.
131 reads the backup and compares its contents with files present on the
133 It first changes its working directory to the root of the filesystem
134 that was dumped and compares the tape with the files in its new
137 This mode allows interactive restoration of files from a dump.
138 After reading in the directory information from the dump,
140 provides a shell like interface that allows the user to move
141 around the directory tree selecting files to be extracted.
142 The available commands are given below;
143 for those commands that require an argument,
144 the default is the current directory.
147 The current directory or specified argument is added to the list of
148 files to be extracted.
149 If a directory is specified, then it and all its descendents are
150 added to the extraction list
153 flag is specified on the command line).
154 Files that are on the extraction list are prepended with a
156 when they are listed by
159 Change the current working directory to the specified argument.
160 .It Ic delete Op Ar arg
161 The current directory or specified argument is deleted from the list of
162 files to be extracted.
163 If a directory is specified, then it and all its descendents are
164 deleted from the extraction list
167 flag is specified on the command line).
168 The most expedient way to extract most of the files from a directory
169 is to add the directory to the extraction list and then delete
170 those files that are not needed.
172 All files on the extraction list are extracted
175 will ask which volume the user wishes to mount.
176 The fastest way to extract a few files is to
177 start with the last volume and work towards the first volume.
179 List a summary of the available commands.
180 .It Ic \&ls Op Ar arg
181 List the current or specified directory.
182 Entries that are directories are appended with a
184 Entries that have been marked for extraction are prepended with a ``*''.
186 flag is set, the inode number of each entry is also listed.
188 Print the full pathname of the current working directory.
190 Restore immediately exits,
191 even if the extraction list is not empty.
193 All directories that have been added to the extraction list
194 have their owner, modes, and times set;
195 nothing is extracted from the dump.
196 This is useful for cleaning up after a restore has been prematurely aborted.
201 When set, the verbose flag causes the
203 command to list the inode numbers of all entries.
206 to print out information about each file as it is extracted.
210 requests a particular tape of a multi-volume set on which to restart
215 This is useful if the restore has been interrupted.
217 Restore (rebuild) a file system.
218 The target file system should be made pristine with
220 mounted, and the user
222 into the pristine file system
223 before starting the restoration of the initial level 0 backup. If the
224 level 0 restores successfully, the
226 flag may be used to restore
227 any necessary incremental backups on top of the level 0.
230 flag precludes an interactive file extraction and can be
231 detrimental to one's health (not to mention the disk) if not used carefully.
233 .Bd -literal -offset indent
245 in the root directory to pass information between incremental
247 This file should be removed when the last incremental has been
255 may be used to modify file system parameters
256 such as size or block size.
258 The names of the specified files are listed if they occur
260 If no file argument is given,
261 the root directory is listed,
262 which results in the entire content of the
266 flag has been specified.
269 flag replaces the function of the old
277 The named files are read from the given media.
278 If a named file matches a directory whose contents
282 flag is not specified,
283 the directory is recursively extracted.
284 The owner, modification time,
285 and mode are restored (if possible).
286 If no file argument is given,
287 the root directory is extracted,
288 which results in the entire content of the
289 backup being extracted,
292 flag has been specified.
298 The following additional options may be specified:
300 .It Fl b Ar blocksize
301 The number of kilobytes per dump record.
304 option is not specified,
306 tries to determine the media block size dynamically.
310 will try to determine dynamically whether the dump was made from an
311 old (pre-4.4) or new format file system. The
313 flag disables this check, and only allows reading a dump in the old
315 .It Fl D Ar filesystem
318 flag allows the user to specify the filesystem name when using
322 option to check the backup.
327 may be a special device file
336 (the standard input).
337 If the name of the file is of the form
342 reads from the named file on the remote host using
346 Run script at the beginning of each tape. The device name and the
347 current volume number are passed on the command line.
348 The script must return 0 if
350 should continue without asking the user to change the tape, 1 if
352 should continue but ask the user to change the tape.
353 Any other exit code will cause
356 For security reasons,
358 reverts back to the real user ID and the real group ID before
361 Use Kerberos authentication when contacting the remote tape server.
362 (Only available if this options was enabled when
367 Extract the actual directory,
368 rather than the files that it references.
369 This prevents hierarchical restoration of complete subtrees
372 Extract by inode numbers rather than by file name.
373 This is useful if only a few files are being extracted,
374 and one wants to avoid regenerating the complete pathname
377 Enables the multi-volume feature (for reading dumps made using
380 option of dump). The name specified with
382 is treated as a prefix and
384 tries to read in sequence from <prefix>001, <prefix>002 etc.
390 to only print file names. Files are not extracted.
394 in order to read tape position as stored using the dump Quick File
397 Read from the specified
399 on a multi-file tape.
400 File numbering starts at 1.
401 .It Fl T Ar directory
404 flag allows the user to specify a directory to use for the storage of
405 temporary files. The default value is /tmp. This flag is most useful
406 when restoring files after having booted from a floppy. There might be little
407 or no space on the floppy filesystem, but another source of space might exist.
409 When creating certain types of files, restore may generate a warning
410 diagnostic if they already exist in the target directory.
413 (unlink) flag causes restore to remove old entries before attempting
418 does its work silently.
422 flag causes it to type the name of each file it treats
423 preceded by its file type.
425 Read list of files to be listed or extracted from the text file
427 in addition to those specified on the command line. This can be used in
434 should contain file names separated by newlines.
436 may be an ordinary file or
438 (the standard input).
440 Do not ask the user whether to abort the restore in the event of an error.
441 Always try to skip over the bad block(s) and continue.
444 Complains if it gets a read error.
447 has been specified, or the user responds
450 will attempt to continue the restore.
452 If a backup was made using more than one tape volume,
454 will notify the user when it is time to mount the next volume.
459 flag has been specified,
461 will also ask which volume the user wishes to mount.
462 The fastest way to extract a few files is to
463 start with the last volume, and work towards the first volume.
465 There are numerous consistency checks that can be listed by
467 Most checks are self-explanatory or can
469 Common errors are given below.
471 .Bl -tag -width Ds -compact
472 .It Converting to new file system format
473 A dump tape created from the old file system has been loaded.
474 It is automatically converted to the new file system format.
476 .It <filename>: not found on tape
477 The specified file name was listed in the tape directory,
478 but was not found on the tape.
479 This is caused by tape read errors while looking for the file,
480 and from using a dump tape created on an active file system.
482 .It expected next file <inumber>, got <inumber>
483 A file that was not listed in the directory showed up.
484 This can occur when using a dump created on an active file system.
486 .It Incremental dump too low
487 When doing an incremental restore,
488 a dump that was written before the previous incremental dump,
489 or that has too low an incremental level has been loaded.
491 .It Incremental dump too high
492 When doing an incremental restore,
493 a dump that does not begin its coverage where the previous incremental
495 or that has too high an incremental level has been loaded.
497 .It Tape read error while restoring <filename>
498 .It Tape read error while skipping over inode <inumber>
499 .It Tape read error while trying to resynchronize
500 A tape (or other media) read error has occurred.
501 If a file name is specified,
502 its contents are probably partially wrong.
503 If an inode is being skipped or the tape is trying to resynchronize,
504 no extracted files have been corrupted,
505 though files may not be found on the tape.
507 .It resync restore, skipped <num> blocks
508 After a dump read error,
510 may have to resynchronize itself.
511 This message lists the number of blocks that were skipped over.
515 exits with zero status on success.
516 Tape errors are indicated with an exit code of 1.
518 When doing a comparison of files from a dump, an exit code
519 of 2 indicates that some files were modified or deleted since
522 If the following environment variable exists it will be utilized by
525 .Bl -tag -width "TMPDIR" -compact
527 If no -f option was specified,
529 will use the device specified via
537 .Qq user@host:tapename .
539 The directory given in
544 to store temporary files.
546 The environment variable
548 will be used to determine the pathname of the remote
553 uses the contents of this variable to determine the name of the
554 remote shell command to use when doing a network restore (rsh, ssh etc.).
555 If this variable is not set,
557 will be used, but only root will be able to do a network restore.
559 .Bl -tag -width "./restoresymtable" -compact
561 the default tape drive
563 file containing directories on the tape
565 owner, mode, and time stamps for directories
566 .It Pa \&./restoresymtable
567 information passed between incremental restores
576 can get confused when doing incremental restores from
577 dumps that were made on active file systems.
579 A level 0 dump must be done after a full restore.
583 it has no control over inode allocation;
584 thus a full dump must be done to get a new set of directories
585 reflecting the new inode numbering,
586 even though the content of the files is unchanged.
592 are generated with a unique name based on the date of the dump
593 and the process ID (see
602 allows you to restart a
604 operation that may have been interrupted, the temporary files should
605 be the same across different processes.
606 In all other cases, the files are unique because it is possible to
607 have two different dumps started at the same time, and separate
608 operations shouldn't conflict with each other.
610 To do a network restore, you have to run restore as root or use
611 a remote shell replacement (see RSH variable). This is due
612 to the previous security history of dump and restore. (restore is
613 written to be setuid root, but we are not certain all bugs are gone
614 from the restore code - run setuid at your own risk.)
618 backup suite was ported to Linux's Second Extended File System
619 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
620 of dump (up and including 0.4b4, released in january 1997).
622 Starting with 0.4b5, the new maintainer is Stelian Pop
628 backup suite is available from
630 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob