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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)restore.8 8.4 (Berkeley) 5/1/95
37 .Nd "restore files or file systems from backups made with dump"
43 .Op Fl f Ar file | Fl P Ar pipecommand
49 .Op Fl f Ar file | Fl P Ar pipecommand
55 .Op Fl f Ar file | Fl P Ar pipecommand
61 .Op Fl f Ar file | Fl P Ar pipecommand
68 .Op Fl f Ar file | Fl P Ar pipecommand
74 utility performs the inverse function of
76 A full backup of a file system may be restored and
77 subsequent incremental backups layered on top of it.
79 directory subtrees may be restored from full or partial
83 utility works across a network;
88 flags described below.
89 Other arguments to the command are file or directory
90 names specifying the files that are to be restored.
93 flag is specified (see below),
94 the appearance of a directory name refers to
95 the files and (recursively) subdirectories of that directory.
98 may also be invoked as
102 option syntax is implemented for backward compatibility, but
103 is not documented here.
105 Exactly one of the following flags is required:
108 This mode allows interactive restoration of files from a dump.
109 After reading in the directory information from the dump,
111 provides a shell like interface that allows the user to move
112 around the directory tree selecting files to be extracted.
113 The available commands are given below;
114 for those commands that require an argument,
115 the default is the current directory.
118 The current directory or specified argument is added to the list of
119 files to be extracted.
120 If a directory is specified, then it and all its descendents are
121 added to the extraction list
124 flag is specified on the command line).
125 Files that are on the extraction list are prepended with a ``*''
126 when they are listed by
129 Change the current working directory to the specified argument.
130 .It Ic delete Op Ar arg
131 The current directory or specified argument is deleted from the list of
132 files to be extracted.
133 If a directory is specified, then it and all its descendents are
134 deleted from the extraction list
137 flag is specified on the command line).
138 The most expedient way to extract most of the files from a directory
139 is to add the directory to the extraction list and then delete
140 those files that are not needed.
142 All the files that are on the extraction list are extracted
146 utility will ask which volume the user wishes to mount.
147 The fastest way to extract a few files is to
148 start with the last volume, and work towards the first volume.
150 List a summary of the available commands.
151 .It Ic \&ls Op Ar arg
152 List the current or specified directory.
153 Entries that are directories are appended with a ``/''.
154 Entries that have been marked for extraction are prepended with a ``*''.
156 flag is set the inode number of each entry is also listed.
158 Print the full pathname of the current working directory.
161 even if the extraction list is not empty.
163 All the directories that have been added to the extraction list
164 have their owner, modes, and times set;
165 nothing is extracted from the dump.
166 This is useful for cleaning up after a restore has been prematurely aborted.
171 When set, the verbose flag causes the
173 command to list the inode numbers of all entries.
176 to print out information about each file as it is extracted.
178 Display dump header information, which includes: date,
179 level, label, and the file system and host dump was made
183 Request a particular tape of a multi volume set on which to restart
188 This is useful if the restore has been interrupted.
190 Restore (rebuild a file system).
191 The target file system should be made pristine with
195 into the pristine file system
196 before starting the restoration of the initial level 0 backup.
198 level 0 restores successfully, the
200 flag may be used to restore
201 any necessary incremental backups on top of the level 0.
204 flag precludes an interactive file extraction and can be
205 detrimental to one's health if not used carefully (not to mention
208 .Bd -literal -offset indent
210 mount /dev/da0s1a /mnt
220 in the root directory to pass information between incremental
222 This file should be removed when the last incremental has been
232 may be used to modify file system parameters
233 such as size or block size.
235 The names of the specified files are listed if they occur
237 If no file argument is given,
238 then the root directory is listed,
239 which results in the entire content of the
243 flag has been specified.
246 flag replaces the function of the old
250 The named files are read from the given media.
251 If a named file matches a directory whose contents
255 flag is not specified,
256 the directory is recursively extracted.
257 The owner, modification time,
258 and mode are restored (if possible).
259 If no file argument is given,
260 then the root directory is extracted,
261 which results in the entire content of the
262 backup being extracted,
265 flag has been specified.
268 The following additional options may be specified:
270 .It Fl b Ar blocksize
271 The number of kilobytes per dump record.
274 option is not specified,
276 tries to determine the media block size dynamically.
278 Sends verbose debugging output to the standard error.
283 causing restore to operate less efficiently
284 but to try harder to read corrupted backups.
289 may be a special device file
298 (the standard input).
299 If the name of the file is of the form
304 reads from the named file on the remote host using
306 .It Fl P Ar pipecommand
311 script string defined by
313 as the input for every volume in the backup.
314 This child pipeline's
319 input stream, and the environment variable
321 is set to the current volume number being read.
324 script is started each time a volume is loaded, as if it were a tape drive.
326 Extract the actual directory,
327 rather than the files that it references.
328 This prevents hierarchical restoration of complete subtrees
331 Extract by inode numbers rather than by file name.
332 This is useful if only a few files are being extracted,
333 and one wants to avoid regenerating the complete pathname
336 Do the extraction normally, but do not actually write any changes
338 This can be used to check the integrity of dump media
339 or other test purposes.
341 Read from the specified
343 on a multi-file tape.
344 File numbering starts at 1.
346 When creating certain types of files, restore may generate a warning
347 diagnostic if they already exist in the target directory.
350 (unlink) flag causes restore to remove old entries before attempting
355 does its work silently.
359 flag causes it to type the name of each file it treats
360 preceded by its file type.
362 Do not ask the user whether to abort the restore in the event of an error.
363 Always try to skip over the bad block(s) and continue.
366 .Bl -tag -width ".Ev TMPDIR"
368 Device from which to read backup.
370 Name of directory where temporary files are to be created.
373 .Bl -tag -width "./restoresymtable" -compact
375 the default tape drive
377 file containing directories on the tape.
379 owner, mode, and time stamps for directories.
380 .It Pa \&./restoresymtable
381 information passed between incremental restores.
386 utility complains if it gets a read error.
389 has been specified, or the user responds
392 will attempt to continue the restore.
394 If a backup was made using more than one tape volume,
396 will notify the user when it is time to mount the next volume.
401 flag has been specified,
403 will also ask which volume the user wishes to mount.
404 The fastest way to extract a few files is to
405 start with the last volume, and work towards the first volume.
407 There are numerous consistency checks that can be listed by
409 Most checks are self-explanatory or can ``never happen''.
410 Common errors are given below.
412 .Bl -tag -width Ds -compact
413 .It <filename>: not found on tape
414 The specified file name was listed in the tape directory,
415 but was not found on the tape.
416 This is caused by tape read errors while looking for the file,
417 and from using a dump tape created on an active file system.
419 .It expected next file <inumber>, got <inumber>
420 A file that was not listed in the directory showed up.
421 This can occur when using a dump created on an active file system.
423 .It Incremental dump too low
424 When doing incremental restore,
425 a dump that was written before the previous incremental dump,
426 or that has too low an incremental level has been loaded.
428 .It Incremental dump too high
429 When doing incremental restore,
430 a dump that does not begin its coverage where the previous incremental
432 or that has too high an incremental level has been loaded.
434 .It Tape read error while restoring <filename>
435 .It Tape read error while skipping over inode <inumber>
436 .It Tape read error while trying to resynchronize
437 A tape (or other media) read error has occurred.
438 If a file name is specified,
439 then its contents are probably partially wrong.
440 If an inode is being skipped or the tape is trying to resynchronize,
441 then no extracted files have been corrupted,
442 though files may not be found on the tape.
444 .It resync restore, skipped <num> blocks
445 After a dump read error,
447 may have to resynchronize itself.
448 This message lists the number of blocks that were skipped over.
463 utility can get confused when doing incremental restores from
464 dumps that were made on active file systems without the
469 A level zero dump must be done after a full restore.
470 Because restore runs in user code,
471 it has no control over inode allocation;
472 thus a full dump must be done to get a new set of directories
473 reflecting the new inode numbering,
474 even though the contents of the files is unchanged.
476 To do a network restore, you have to run restore as root.
478 to the previous security history of dump and restore.
480 written to be setuid root, but we are not certain all bugs are gone
481 from the restore code - run setuid at your own risk.)
487 are generated with a unique name based on the date of the dump
488 and the process ID (see
497 allows you to restart a
499 operation that may have been interrupted, the temporary files should
500 be the same across different processes.
501 In all other cases, the files are unique because it is possible to
502 have two different dumps started at the same time, and separate
503 operations should not conflict with each other.