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.26 2002/06/05 13:29:15 stelian Exp $
36 .Os "restore __VERSION__"
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
104 .Op Fl b Ar blocksize
109 .Op Fl T Ar directory
116 option syntax is implemented for backward compatibility but
117 is not documented here.)
121 command performs the inverse function of
123 A full backup of a file system may be restored and
124 subsequent incremental backups layered on top of it.
126 directory subtrees may be restored from full or partial
129 works across a network;
132 flag described below.
133 Other arguments to the command are file or directory
134 names specifying the files that are to be restored.
137 flag is specified (see below),
138 the appearance of a directory name refers to
139 the files and (recursively) subdirectories of that directory.
141 Exactly one of the following flags is required:
144 This mode allows comparison of files from a dump.
146 reads the backup and compares its contents with files present on the
148 It first changes its working directory to the root of the filesystem
149 that was dumped and compares the tape with the files in its new
153 flag described below.
155 This mode allows interactive restoration of files from a dump.
156 After reading in the directory information from the dump,
158 provides a shell like interface that allows the user to move
159 around the directory tree selecting files to be extracted.
160 The available commands are given below;
161 for those commands that require an argument,
162 the default is the current directory.
165 The current directory or specified argument is added to the list of
166 files to be extracted.
167 If a directory is specified, then it and all its descendents are
168 added to the extraction list
171 flag is specified on the command line).
172 Files that are on the extraction list are prepended with a
174 when they are listed by
177 Change the current working directory to the specified argument.
178 .It Ic delete Op Ar arg
179 The current directory or specified argument is deleted from the list of
180 files to be extracted.
181 If a directory is specified, then it and all its descendents are
182 deleted from the extraction list
185 flag is specified on the command line).
186 The most expedient way to extract most of the files from a directory
187 is to add the directory to the extraction list and then delete
188 those files that are not needed.
190 All files on the extraction list are extracted
193 will ask which volume the user wishes to mount.
194 The fastest way to extract a few files is to
195 start with the last volume and work towards the first volume.
197 List a summary of the available commands.
198 .It Ic \&ls Op Ar arg
199 List the current or specified directory.
200 Entries that are directories are appended with a
202 Entries that have been marked for extraction are prepended with a ``*''.
204 flag is set, the inode number of each entry is also listed.
206 Print the full pathname of the current working directory.
208 Restore immediately exits,
209 even if the extraction list is not empty.
211 All directories that have been added to the extraction list
212 have their owner, modes, and times set;
213 nothing is extracted from the dump.
214 This is useful for cleaning up after a restore has been prematurely aborted.
219 When set, the verbose flag causes the
221 command to list the inode numbers of all entries.
224 to print out information about each file as it is extracted.
228 creates a new Quick File Access file
230 from an existing dump file without restoring its contents.
233 requests a particular tape of a multi-volume set on which to restart
238 This is useful if the restore has been interrupted.
240 Restore (rebuild) a file system.
241 The target file system should be made pristine with
243 mounted, and the user
245 into the pristine file system
246 before starting the restoration of the initial level 0 backup. If the
247 level 0 restores successfully, the
249 flag may be used to restore
250 any necessary incremental backups on top of the level 0.
253 flag precludes an interactive file extraction and can be
254 detrimental to one's health (not to mention the disk) if not used carefully.
256 .Bd -literal -offset indent
268 in the root directory to pass information between incremental
270 This file should be removed when the last incremental has been
278 may be used to modify file system parameters
279 such as size or block size.
281 The names of the specified files are listed if they occur
283 If no file argument is given,
284 the root directory is listed,
285 which results in the entire content of the
289 flag has been specified.
292 flag replaces the function of the old
300 The named files are read from the given media.
301 If a named file matches a directory whose contents
305 flag is not specified,
306 the directory is recursively extracted.
307 The owner, modification time,
308 and mode are restored (if possible).
309 If no file argument is given,
310 the root directory is extracted,
311 which results in the entire content of the
312 backup being extracted,
315 flag has been specified.
321 The following additional options may be specified:
330 does ask the user for the volume number on which the files to
331 be extracted are supposed to be (in order to minimise the time
332 be reading only the interesting volumes). The
334 option disables this behaviour and reads all the volumes starting
335 with 1. This option is useful when the operator does not know on which
336 volume the files to be extracted are and/or when he prefers the
337 longer unattended mode rather than the shorter interactive mode.
338 .It Fl A Ar archive_file
339 Read the table of contents from
341 instead of the media. This option can be used in combination with the
346 options, making it possible to check whether files are on the media
347 without having to mount the media.
348 .It Fl b Ar blocksize
349 The number of kilobytes per dump record.
352 option is not specified,
354 tries to determine the media block size dynamically.
358 will try to determine dynamically whether the dump was made from an
359 old (pre-4.4) or new format file system. The
361 flag disables this check, and only allows reading a dump in the old
369 to print debug information.
370 .It Fl D Ar filesystem
373 flag allows the user to specify the filesystem name when using
377 option to check the backup.
382 may be a special device file
391 (the standard input).
392 If the name of the file is of the form
397 reads from the named file on the remote host using
401 Run script at the beginning of each tape. The device name and the
402 current volume number are passed on the command line.
403 The script must return 0 if
405 should continue without asking the user to change the tape, 1 if
407 should continue but ask the user to change the tape.
408 Any other exit code will cause
411 For security reasons,
413 reverts back to the real user ID and the real group ID before
416 Extract the actual directory,
417 rather than the files that it references.
418 This prevents hierarchical restoration of complete subtrees
421 Use Kerberos authentication when contacting the remote tape server.
422 (Only available if this options was enabled when
426 When doing remote restores, assume the remote file is a
427 regular file (instead of a tape device). If you're restoring
428 a remote compressed file, you will need to specify this
431 will fail to access it correctly.
435 flag allows the user to specify a maximal number of miscompares
440 option to check the backup. If this limit is reached,
442 will abort with an error message. A value of 0 (the default value)
445 Extract by inode numbers rather than by file name.
446 This is useful if only a few files are being extracted,
447 and one wants to avoid regenerating the complete pathname
450 Enables the multi-volume feature (for reading dumps made using
453 option of dump). The name specified with
455 is treated as a prefix and
457 tries to read in sequence from <prefix>001, <prefix>002 etc.
463 to perform a full execution as requested by one of
470 command without actually writing any file on disk.
474 in order to read tape position as stored using the dump Quick File
475 Access mode, in one of
482 It is recommended to set up the st driver to return logical tape
483 positions rather than physical before calling dump/restore with
484 parameter Q. Since not all tape devices support physical tape
485 positions those tape devices return an error during dump/restore when
486 the st driver is set to the default physical setting.
487 Please see the st man page, option MTSETDRVBUFFER, or the mt man
488 page, on how to set the driver to return logical tape positions.
490 Before calling restore with parameter Q, always make sure the st
491 driver is set to return the same type of tape position used during the
492 call to dump. Otherwise restore may be confused.
494 This option can be used when restoring from local or remote tapes
495 (see above) or from local or remote files.
497 Read from the specified
499 on a multi-file tape.
500 File numbering starts at 1.
501 .It Fl T Ar directory
504 flag allows the user to specify a directory to use for the storage of
505 temporary files. The default value is /tmp. This flag is most useful
506 when restoring files after having booted from a floppy. There might be little
507 or no space on the floppy filesystem, but another source of space might exist.
509 When creating certain types of files, restore may generate a warning
510 diagnostic if they already exist in the target directory.
513 (unlink) flag causes restore to remove old entries before attempting
518 does its work silently.
522 flag causes it to type the name of each file it treats
523 preceded by its file type.
525 Enables reading multi-volume non-tape mediums like CDROMs.
527 Read list of files to be listed or extracted from the text file
529 in addition to those specified on the command line. This can be used in
536 should contain file names separated by newlines.
538 may be an ordinary file or
540 (the standard input).
542 Do not ask the user whether to abort the restore in the event of an error.
543 Always try to skip over the bad block(s) and continue.
546 Complains if it gets a read error.
549 has been specified, or the user responds
552 will attempt to continue the restore.
554 If a backup was made using more than one tape volume,
556 will notify the user when it is time to mount the next volume.
561 flag has been specified,
563 will also ask which volume the user wishes to mount.
564 The fastest way to extract a few files is to
565 start with the last volume, and work towards the first volume.
567 There are numerous consistency checks that can be listed by
569 Most checks are self-explanatory or can
571 Common errors are given below.
573 .Bl -tag -width Ds -compact
574 .It Converting to new file system format
575 A dump tape created from the old file system has been loaded.
576 It is automatically converted to the new file system format.
578 .It <filename>: not found on tape
579 The specified file name was listed in the tape directory,
580 but was not found on the tape.
581 This is caused by tape read errors while looking for the file,
582 and from using a dump tape created on an active file system.
584 .It expected next file <inumber>, got <inumber>
585 A file that was not listed in the directory showed up.
586 This can occur when using a dump created on an active file system.
588 .It Incremental dump too low
589 When doing an incremental restore,
590 a dump that was written before the previous incremental dump,
591 or that has too low an incremental level has been loaded.
593 .It Incremental dump too high
594 When doing an incremental restore,
595 a dump that does not begin its coverage where the previous incremental
597 or that has too high an incremental level has been loaded.
599 .It Tape read error while restoring <filename>
600 .It Tape read error while skipping over inode <inumber>
601 .It Tape read error while trying to resynchronize
602 A tape (or other media) read error has occurred.
603 If a file name is specified,
604 its contents are probably partially wrong.
605 If an inode is being skipped or the tape is trying to resynchronize,
606 no extracted files have been corrupted,
607 though files may not be found on the tape.
609 .It resync restore, skipped <num> blocks
610 After a dump read error,
612 may have to resynchronize itself.
613 This message lists the number of blocks that were skipped over.
617 exits with zero status on success.
618 Tape errors are indicated with an exit code of 1.
620 When doing a comparison of files from a dump, an exit code
621 of 2 indicates that some files were modified or deleted since
624 If the following environment variable exists it will be utilized by
627 .Bl -tag -width "TMPDIR" -compact
629 If no -f option was specified,
631 will use the device specified via
639 .Qq user@host:tapename .
641 The directory given in
646 to store temporary files.
648 The environment variable
650 will be used to determine the pathname of the remote
655 uses the contents of this variable to determine the name of the
656 remote shell command to use when doing a network restore (rsh, ssh etc.).
657 If this variable is not set,
659 will be used, but only root will be able to do a network restore.
662 .Bl -tag -width "./restoresymtable" -compact
664 the default tape drive
666 file containing directories on the tape
668 owner, mode, and time stamps for directories
669 .It Pa \&./restoresymtable
670 information passed between incremental restores
679 can get confused when doing incremental restores from
680 dumps that were made on active file systems.
682 A level 0 dump must be done after a full restore.
686 it has no control over inode allocation;
687 thus a full dump must be done to get a new set of directories
688 reflecting the new inode numbering,
689 even though the content of the files is unchanged.
695 are generated with a unique name based on the date of the dump
696 and the process ID (see
705 allows you to restart a
707 operation that may have been interrupted, the temporary files should
708 be the same across different processes.
709 In all other cases, the files are unique because it is possible to
710 have two different dumps started at the same time, and separate
711 operations shouldn't conflict with each other.
713 To do a network restore, you have to run restore as root or use
714 a remote shell replacement (see RSH variable). This is due
715 to the previous security history of dump and restore. (restore is
716 written to be setuid root, but we are not certain all bugs are gone
717 from the restore code - run setuid at your own risk.)
721 backup suite was ported to Linux's Second Extended File System
722 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
723 of dump (up and including 0.4b4, released in january 1997).
725 Starting with 0.4b5, the new maintainer is Stelian Pop
727 <stelian@popies.net>.
731 backup suite is available from
733 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob