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.13 2001/04/10 12:46:53 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
98 option syntax is implemented for backward compatibility but
99 is not documented here.)
103 command performs the inverse function of
105 A full backup of a file system may be restored and
106 subsequent incremental backups layered on top of it.
108 directory subtrees may be restored from full or partial
111 works across a network;
114 flag described below.
115 Other arguments to the command are file or directory
116 names specifying the files that are to be restored.
119 flag is specified (see below),
120 the appearance of a directory name refers to
121 the files and (recursively) subdirectories of that directory.
123 Exactly one of the following flags is required:
126 This mode allows comparison of files from a dump.
128 reads the backup and compares its contents with files present on the
130 It first changes its working directory to the root of the filesystem
131 that was dumped and compares the tape with the files in its new
134 This mode allows interactive restoration of files from a dump.
135 After reading in the directory information from the dump,
137 provides a shell like interface that allows the user to move
138 around the directory tree selecting files to be extracted.
139 The available commands are given below;
140 for those commands that require an argument,
141 the default is the current directory.
144 The current directory or specified argument is added to the list of
145 files to be extracted.
146 If a directory is specified, then it and all its descendents are
147 added to the extraction list
150 flag is specified on the command line).
151 Files that are on the extraction list are prepended with a
153 when they are listed by
156 Change the current working directory to the specified argument.
157 .It Ic delete Op Ar arg
158 The current directory or specified argument is deleted from the list of
159 files to be extracted.
160 If a directory is specified, then it and all its descendents are
161 deleted from the extraction list
164 flag is specified on the command line).
165 The most expedient way to extract most of the files from a directory
166 is to add the directory to the extraction list and then delete
167 those files that are not needed.
169 All files on the extraction list are extracted
172 will ask which volume the user wishes to mount.
173 The fastest way to extract a few files is to
174 start with the last volume and work towards the first volume.
176 List a summary of the available commands.
177 .It Ic \&ls Op Ar arg
178 List the current or specified directory.
179 Entries that are directories are appended with a
181 Entries that have been marked for extraction are prepended with a ``*''.
183 flag is set, the inode number of each entry is also listed.
185 Print the full pathname of the current working directory.
187 Restore immediately exits,
188 even if the extraction list is not empty.
190 All directories that have been added to the extraction list
191 have their owner, modes, and times set;
192 nothing is extracted from the dump.
193 This is useful for cleaning up after a restore has been prematurely aborted.
198 When set, the verbose flag causes the
200 command to list the inode numbers of all entries.
203 to print out information about each file as it is extracted.
207 requests a particular tape of a multi-volume set on which to restart
212 This is useful if the restore has been interrupted.
214 Restore (rebuild) a file system.
215 The target file system should be made pristine with
217 mounted, and the user
219 into the pristine file system
220 before starting the restoration of the initial level 0 backup. If the
221 level 0 restores successfully, the
223 flag may be used to restore
224 any necessary incremental backups on top of the level 0.
227 flag precludes an interactive file extraction and can be
228 detrimental to one's health (not to mention the disk) if not used carefully.
230 .Bd -literal -offset indent
242 in the root directory to pass information between incremental
244 This file should be removed when the last incremental has been
252 may be used to modify file system parameters
253 such as size or block size.
255 The names of the specified files are listed if they occur
257 If no file argument is given,
258 the root directory is listed,
259 which results in the entire content of the
263 flag has been specified.
266 flag replaces the function of the old
274 The named files are read from the given media.
275 If a named file matches a directory whose contents
279 flag is not specified,
280 the directory is recursively extracted.
281 The owner, modification time,
282 and mode are restored (if possible).
283 If no file argument is given,
284 the root directory is extracted,
285 which results in the entire content of the
286 backup being extracted,
289 flag has been specified.
295 The following additional options may be specified:
297 .It Fl b Ar blocksize
298 The number of kilobytes per dump record.
301 option is not specified,
303 tries to determine the media block size dynamically.
307 will try to determine dynamically whether the dump was made from an
308 old (pre-4.4) or new format file system. The
310 flag disables this check, and only allows reading a dump in the old
312 .It Fl D Ar filesystem
315 flag allows the user to specify the filesystem name when using
319 option to check the backup.
324 may be a special device file
333 (the standard input).
334 If the name of the file is of the form
339 reads from the named file on the remote host using
343 Use Kerberos authentication when contacting the remote tape server.
344 (Only available if this options was enabled when
349 Extract the actual directory,
350 rather than the files that it references.
351 This prevents hierarchical restoration of complete subtrees
354 Extract by inode numbers rather than by file name.
355 This is useful if only a few files are being extracted,
356 and one wants to avoid regenerating the complete pathname
359 Enables the multi-volume feature (for reading dumps made using
362 option of dump). The name specified with
364 is treated as a prefix and
366 tries to read in sequence from <prefix>001, <prefix>002 etc.
372 to only print file names. Files are not extracted.
376 in order to read tape position as stored using the dump Quick File
379 Read from the specified
381 on a multi-file tape.
382 File numbering starts at 1.
383 .It Fl T Ar directory
386 flag allows the user to specify a directory to use for the storage of
387 temporary files. The default value is /tmp. This flag is most useful
388 when restoring files after having booted from a floppy. There might be little
389 or no space on the floppy filesystem, but another source of space might exist.
391 When creating certain types of files, restore may generate a warning
392 diagnostic if they already exist in the target directory.
395 (unlink) flag causes restore to remove old entries before attempting
400 does its work silently.
404 flag causes it to type the name of each file it treats
405 preceded by its file type.
407 Read list of files to be listed or extracted from the text file
409 in addition to those specified on the command line. This can be used in
416 should contain file names separated by newlines.
418 may be an ordinary file or
420 (the standard input).
422 Do not ask the user whether to abort the restore in the event of an error.
423 Always try to skip over the bad block(s) and continue.
426 Complains if it gets a read error.
429 has been specified, or the user responds
432 will attempt to continue the restore.
434 If a backup was made using more than one tape volume,
436 will notify the user when it is time to mount the next volume.
441 flag has been specified,
443 will also ask which volume the user wishes to mount.
444 The fastest way to extract a few files is to
445 start with the last volume, and work towards the first volume.
447 There are numerous consistency checks that can be listed by
449 Most checks are self-explanatory or can
451 Common errors are given below.
453 .Bl -tag -width Ds -compact
454 .It Converting to new file system format
455 A dump tape created from the old file system has been loaded.
456 It is automatically converted to the new file system format.
458 .It <filename>: not found on tape
459 The specified file name was listed in the tape directory,
460 but was not found on the tape.
461 This is caused by tape read errors while looking for the file,
462 and from using a dump tape created on an active file system.
464 .It expected next file <inumber>, got <inumber>
465 A file that was not listed in the directory showed up.
466 This can occur when using a dump created on an active file system.
468 .It Incremental dump too low
469 When doing an incremental restore,
470 a dump that was written before the previous incremental dump,
471 or that has too low an incremental level has been loaded.
473 .It Incremental dump too high
474 When doing an incremental restore,
475 a dump that does not begin its coverage where the previous incremental
477 or that has too high an incremental level has been loaded.
479 .It Tape read error while restoring <filename>
480 .It Tape read error while skipping over inode <inumber>
481 .It Tape read error while trying to resynchronize
482 A tape (or other media) read error has occurred.
483 If a file name is specified,
484 its contents are probably partially wrong.
485 If an inode is being skipped or the tape is trying to resynchronize,
486 no extracted files have been corrupted,
487 though files may not be found on the tape.
489 .It resync restore, skipped <num> blocks
490 After a dump read error,
492 may have to resynchronize itself.
493 This message lists the number of blocks that were skipped over.
497 exits with zero status on success.
498 Tape errors are indicated with an exit code of 1.
500 When doing a comparison of files from a dump, an exit code
501 of 2 indicates that some files were modified or deleted since
504 If the following environment variable exists it will be utilized by
507 .Bl -tag -width "TMPDIR" -compact
509 If no -f option was specified,
511 will use the device specified via
519 .Qq user@host:tapename .
521 The directory given in
526 to store temporary files.
528 The environment variable
530 will be used to determine the pathname of the remote
535 uses the contents of this variable to determine the name of the
536 remote shell command to use when doing a network restore (rsh, ssh etc.).
537 If this variable is not set,
539 will be used, but only root will be able to do a network restore.
541 .Bl -tag -width "./restoresymtable" -compact
543 the default tape drive
545 file containing directories on the tape
547 owner, mode, and time stamps for directories
548 .It Pa \&./restoresymtable
549 information passed between incremental restores
558 can get confused when doing incremental restores from
559 dumps that were made on active file systems.
561 A level 0 dump must be done after a full restore.
565 it has no control over inode allocation;
566 thus a full dump must be done to get a new set of directories
567 reflecting the new inode numbering,
568 even though the content of the files is unchanged.
574 are generated with a unique name based on the date of the dump
575 and the process ID (see
584 allows you to restart a
586 operation that may have been interrupted, the temporary files should
587 be the same across different processes.
588 In all other cases, the files are unique because it is possible to
589 have two different dumps started at the same time, and separate
590 operations shouldn't conflict with each other.
592 To do a network restore, you have to run restore as root or use
593 a remote shell replacement (see RSH variable). This is due
594 to the previous security history of dump and restore. (restore is
595 written to be setuid root, but we are not certain all bugs are gone
596 from the restore code - run setuid at your own risk.)
600 backup suite was ported to Linux's Second Extended File System
601 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
602 of dump (up and including 0.4b4, released in january 1997).
604 Starting with 0.4b5, the new maintainer is Stelian Pop
610 backup suite is available from
612 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob