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.24 2002/01/25 14:59: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
105 option syntax is implemented for backward compatibility but
106 is not documented here.)
110 command performs the inverse function of
112 A full backup of a file system may be restored and
113 subsequent incremental backups layered on top of it.
115 directory subtrees may be restored from full or partial
118 works across a network;
121 flag described below.
122 Other arguments to the command are file or directory
123 names specifying the files that are to be restored.
126 flag is specified (see below),
127 the appearance of a directory name refers to
128 the files and (recursively) subdirectories of that directory.
130 Exactly one of the following flags is required:
133 This mode allows comparison of files from a dump.
135 reads the backup and compares its contents with files present on the
137 It first changes its working directory to the root of the filesystem
138 that was dumped and compares the tape with the files in its new
142 flag described below.
144 This mode allows interactive restoration of files from a dump.
145 After reading in the directory information from the dump,
147 provides a shell like interface that allows the user to move
148 around the directory tree selecting files to be extracted.
149 The available commands are given below;
150 for those commands that require an argument,
151 the default is the current directory.
154 The current directory or specified argument is added to the list of
155 files to be extracted.
156 If a directory is specified, then it and all its descendents are
157 added to the extraction list
160 flag is specified on the command line).
161 Files that are on the extraction list are prepended with a
163 when they are listed by
166 Change the current working directory to the specified argument.
167 .It Ic delete Op Ar arg
168 The current directory or specified argument is deleted from the list of
169 files to be extracted.
170 If a directory is specified, then it and all its descendents are
171 deleted from the extraction list
174 flag is specified on the command line).
175 The most expedient way to extract most of the files from a directory
176 is to add the directory to the extraction list and then delete
177 those files that are not needed.
179 All files on the extraction list are extracted
182 will ask which volume the user wishes to mount.
183 The fastest way to extract a few files is to
184 start with the last volume and work towards the first volume.
186 List a summary of the available commands.
187 .It Ic \&ls Op Ar arg
188 List the current or specified directory.
189 Entries that are directories are appended with a
191 Entries that have been marked for extraction are prepended with a ``*''.
193 flag is set, the inode number of each entry is also listed.
195 Print the full pathname of the current working directory.
197 Restore immediately exits,
198 even if the extraction list is not empty.
200 All directories that have been added to the extraction list
201 have their owner, modes, and times set;
202 nothing is extracted from the dump.
203 This is useful for cleaning up after a restore has been prematurely aborted.
208 When set, the verbose flag causes the
210 command to list the inode numbers of all entries.
213 to print out information about each file as it is extracted.
217 requests a particular tape of a multi-volume set on which to restart
222 This is useful if the restore has been interrupted.
224 Restore (rebuild) a file system.
225 The target file system should be made pristine with
227 mounted, and the user
229 into the pristine file system
230 before starting the restoration of the initial level 0 backup. If the
231 level 0 restores successfully, the
233 flag may be used to restore
234 any necessary incremental backups on top of the level 0.
237 flag precludes an interactive file extraction and can be
238 detrimental to one's health (not to mention the disk) if not used carefully.
240 .Bd -literal -offset indent
252 in the root directory to pass information between incremental
254 This file should be removed when the last incremental has been
262 may be used to modify file system parameters
263 such as size or block size.
265 The names of the specified files are listed if they occur
267 If no file argument is given,
268 the root directory is listed,
269 which results in the entire content of the
273 flag has been specified.
276 flag replaces the function of the old
284 The named files are read from the given media.
285 If a named file matches a directory whose contents
289 flag is not specified,
290 the directory is recursively extracted.
291 The owner, modification time,
292 and mode are restored (if possible).
293 If no file argument is given,
294 the root directory is extracted,
295 which results in the entire content of the
296 backup being extracted,
299 flag has been specified.
305 The following additional options may be specified:
314 does ask the user for the volume number on which the files to
315 be extracted are supposed to be (in order to minimise the time
316 be reading only the interesting volumes). The
318 option disables this behaviour and reads all the volumes starting
319 with 1. This option is useful when the operator does not know on which
320 volume the files to be extracted are and/or when he prefers the
321 longer unattended mode rather than the shorter interactive mode.
322 .It Fl A Ar archive_file
323 Read the table of contents from
325 instead of the media. This option can be used in combination with the
330 options, making it possible to check whether files are on the media
331 without having to mount the media.
332 .It Fl b Ar blocksize
333 The number of kilobytes per dump record.
336 option is not specified,
338 tries to determine the media block size dynamically.
342 will try to determine dynamically whether the dump was made from an
343 old (pre-4.4) or new format file system. The
345 flag disables this check, and only allows reading a dump in the old
347 .It Fl D Ar filesystem
350 flag allows the user to specify the filesystem name when using
354 option to check the backup.
359 may be a special device file
368 (the standard input).
369 If the name of the file is of the form
374 reads from the named file on the remote host using
378 Run script at the beginning of each tape. The device name and the
379 current volume number are passed on the command line.
380 The script must return 0 if
382 should continue without asking the user to change the tape, 1 if
384 should continue but ask the user to change the tape.
385 Any other exit code will cause
388 For security reasons,
390 reverts back to the real user ID and the real group ID before
393 Extract the actual directory,
394 rather than the files that it references.
395 This prevents hierarchical restoration of complete subtrees
398 Use Kerberos authentication when contacting the remote tape server.
399 (Only available if this options was enabled when
403 When doing remote restores, assume the remote file is a
404 regular file (instead of a tape device). If you're restoring
405 a remote compressed file, you will need to specify this
408 will fail to access it correctly.
412 flag allows the user to specify a maximal number of miscompares
417 option to check the backup. If this limit is reached,
419 will abort with an error message. A value of 0 (the default value)
422 Extract by inode numbers rather than by file name.
423 This is useful if only a few files are being extracted,
424 and one wants to avoid regenerating the complete pathname
427 Enables the multi-volume feature (for reading dumps made using
430 option of dump). The name specified with
432 is treated as a prefix and
434 tries to read in sequence from <prefix>001, <prefix>002 etc.
440 to perform a full execution as requested by one of
447 command without actually writing any file on disk.
451 in order to read tape position as stored using the dump Quick File
452 Access mode, in one of
459 It is recommended to set up the st driver to return logical tape
460 positions rather than physical before calling dump/restore with
461 parameter Q. Since not all tape devices support physical tape
462 positions those tape devices return an error during dump/restore when
463 the st driver is set to the default physical setting.
464 Please see the st man page, option MTSETDRVBUFFER, or the mt man
465 page, on how to set the driver to return logical tape positions.
467 Before calling restore with parameter Q, always make sure the st
468 driver is set to return the same type of tape position used during the
469 call to dump. Otherwise restore may be confused.
471 This option can be used when restoring from local or remote tapes
472 (see above) or from local or remote files.
474 Read from the specified
476 on a multi-file tape.
477 File numbering starts at 1.
478 .It Fl T Ar directory
481 flag allows the user to specify a directory to use for the storage of
482 temporary files. The default value is /tmp. This flag is most useful
483 when restoring files after having booted from a floppy. There might be little
484 or no space on the floppy filesystem, but another source of space might exist.
486 When creating certain types of files, restore may generate a warning
487 diagnostic if they already exist in the target directory.
490 (unlink) flag causes restore to remove old entries before attempting
495 does its work silently.
499 flag causes it to type the name of each file it treats
500 preceded by its file type.
502 Enables reading multi-volume non-tape mediums like CDROMs.
504 Read list of files to be listed or extracted from the text file
506 in addition to those specified on the command line. This can be used in
513 should contain file names separated by newlines.
515 may be an ordinary file or
517 (the standard input).
519 Do not ask the user whether to abort the restore in the event of an error.
520 Always try to skip over the bad block(s) and continue.
523 Complains if it gets a read error.
526 has been specified, or the user responds
529 will attempt to continue the restore.
531 If a backup was made using more than one tape volume,
533 will notify the user when it is time to mount the next volume.
538 flag has been specified,
540 will also ask which volume the user wishes to mount.
541 The fastest way to extract a few files is to
542 start with the last volume, and work towards the first volume.
544 There are numerous consistency checks that can be listed by
546 Most checks are self-explanatory or can
548 Common errors are given below.
550 .Bl -tag -width Ds -compact
551 .It Converting to new file system format
552 A dump tape created from the old file system has been loaded.
553 It is automatically converted to the new file system format.
555 .It <filename>: not found on tape
556 The specified file name was listed in the tape directory,
557 but was not found on the tape.
558 This is caused by tape read errors while looking for the file,
559 and from using a dump tape created on an active file system.
561 .It expected next file <inumber>, got <inumber>
562 A file that was not listed in the directory showed up.
563 This can occur when using a dump created on an active file system.
565 .It Incremental dump too low
566 When doing an incremental restore,
567 a dump that was written before the previous incremental dump,
568 or that has too low an incremental level has been loaded.
570 .It Incremental dump too high
571 When doing an incremental restore,
572 a dump that does not begin its coverage where the previous incremental
574 or that has too high an incremental level has been loaded.
576 .It Tape read error while restoring <filename>
577 .It Tape read error while skipping over inode <inumber>
578 .It Tape read error while trying to resynchronize
579 A tape (or other media) read error has occurred.
580 If a file name is specified,
581 its contents are probably partially wrong.
582 If an inode is being skipped or the tape is trying to resynchronize,
583 no extracted files have been corrupted,
584 though files may not be found on the tape.
586 .It resync restore, skipped <num> blocks
587 After a dump read error,
589 may have to resynchronize itself.
590 This message lists the number of blocks that were skipped over.
594 exits with zero status on success.
595 Tape errors are indicated with an exit code of 1.
597 When doing a comparison of files from a dump, an exit code
598 of 2 indicates that some files were modified or deleted since
601 If the following environment variable exists it will be utilized by
604 .Bl -tag -width "TMPDIR" -compact
606 If no -f option was specified,
608 will use the device specified via
616 .Qq user@host:tapename .
618 The directory given in
623 to store temporary files.
625 The environment variable
627 will be used to determine the pathname of the remote
632 uses the contents of this variable to determine the name of the
633 remote shell command to use when doing a network restore (rsh, ssh etc.).
634 If this variable is not set,
636 will be used, but only root will be able to do a network restore.
639 .Bl -tag -width "./restoresymtable" -compact
641 the default tape drive
643 file containing directories on the tape
645 owner, mode, and time stamps for directories
646 .It Pa \&./restoresymtable
647 information passed between incremental restores
656 can get confused when doing incremental restores from
657 dumps that were made on active file systems.
659 A level 0 dump must be done after a full restore.
663 it has no control over inode allocation;
664 thus a full dump must be done to get a new set of directories
665 reflecting the new inode numbering,
666 even though the content of the files is unchanged.
672 are generated with a unique name based on the date of the dump
673 and the process ID (see
682 allows you to restart a
684 operation that may have been interrupted, the temporary files should
685 be the same across different processes.
686 In all other cases, the files are unique because it is possible to
687 have two different dumps started at the same time, and separate
688 operations shouldn't conflict with each other.
690 To do a network restore, you have to run restore as root or use
691 a remote shell replacement (see RSH variable). This is due
692 to the previous security history of dump and restore. (restore is
693 written to be setuid root, but we are not certain all bugs are gone
694 from the restore code - run setuid at your own risk.)
698 backup suite was ported to Linux's Second Extended File System
699 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
700 of dump (up and including 0.4b4, released in january 1997).
702 Starting with 0.4b5, the new maintainer is Stelian Pop
704 <stelian@popies.net>.
708 backup suite is available from
710 http://dump.sourceforge.net
git.wh0rd.org / dump.git / blob