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 .\" @(#)restore.8 8.4 (Berkeley) 5/1/95
41 .Nd "restore files or filesystems from backups made with dump"
77 is an alternate name for
83 option syntax is implemented for backward compatibility, but
84 is not documented here.)
88 command performs the inverse function of
90 A full backup of a filesystem may be restored and
91 subsequent incremental backups layered on top of it.
93 directory subtrees may be restored from full or partial
96 works across a network;
100 Other arguments to the command are file or directory
101 names specifying the files that are to be restored.
104 flag is specified (see below),
105 the appearance of a directory name refers to
106 the files and (recursively) subdirectories of that directory.
108 Exactly one of the following flags is required:
111 This mode allows interactive restoration of files from a dump.
112 After reading in the directory information from the dump,
114 provides a shell like interface that allows the user to move
115 around the directory tree selecting files to be extracted.
116 The available commands are given below;
117 for those commands that require an argument,
118 the default is the current directory.
121 The current directory or specified argument is added to the list of
122 files to be extracted.
123 If a directory is specified, then it and all its descendents are
124 added to the extraction list
127 flag is specified on the command line).
128 Files that are on the extraction list are prepended with a ``*''
129 when they are listed by
132 Change the current working directory to the specified argument.
133 .It Ic delete Op Ar arg
134 The current directory or specified argument is deleted from the list of
135 files to be extracted.
136 If a directory is specified, then it and all its descendents are
137 deleted from the extraction list
140 flag is specified on the command line).
141 The most expedient way to extract most of the files from a directory
142 is to add the directory to the extraction list and then delete
143 those files that are not needed.
145 All the files that are on the extraction list are extracted
148 will ask which volume the user wishes to mount.
149 The fastest way to extract a few files is to
150 start with the last volume, and work towards the first volume.
152 List a summary of the available commands.
153 .It Ic \&ls Op Ar arg
154 List the current or specified directory.
155 Entries that are directories are appended with a ``/''.
156 Entries that have been marked for extraction are prepended with a ``*''.
158 flag is set the inode number of each entry is also listed.
160 Print the full pathname of the current working directory.
162 Restore immediately exits,
163 even if the extraction list is not empty.
165 All the directories that have been added to the extraction list
166 have their owner, modes, and times set;
167 nothing is extracted from the dump.
168 This is useful for cleaning up after a restore has been prematurely aborted.
173 When set, the verbose flag causes the
175 command to list the inode numbers of all entries.
178 to print out information about each file as it is extracted.
180 Displays dump header information, which includes: date,
181 level, label, and the filesystem and host dump was made
186 requests a particular tape of a multi volume set on which to restart
191 This is useful if the restore has been interrupted.
193 Restore (rebuild a filesystem).
194 The target filesystem should be made pristine with
198 into the pristine filesystem
199 before starting the restoration of the initial level 0 backup.
201 level 0 restores successfully, the
203 flag may be used to restore
204 any necessary incremental backups on top of the level 0.
207 flag precludes an interactive file extraction and can be
208 detrimental to one's health if not used carefully (not to mention
209 the disk). An example:
210 .Bd -literal -offset indent
212 mount /dev/da0s1a /mnt
222 in the root directory to pass information between incremental
224 This file should be removed when the last incremental has been
232 may be used to modify filesystem 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.
280 will try to determine dynamically whether the dump was made from an
281 old (pre-4.4) or new format filesystem. The
283 flag disables this check, and only allows reading a dump in the old
286 Sends verbose debugging output to the standard error.
291 may be a special device file
300 (the standard input).
301 If the name of the file is of the form
306 reads from the named file on the remote host using
310 Use Kerberos authentication when contacting the remote tape server.
311 (Only available if this options was enabled when
316 Extract the actual directory,
317 rather than the files that it references.
318 This prevents hierarchical restoration of complete subtrees
321 Extract by inode numbers rather than by file name.
322 This is useful if only a few files are being extracted,
323 and one wants to avoid regenerating the complete pathname
326 Do the extraction normally, but do not actually write any changes
328 This can be used to check the integrity of dump media
329 or other test purposes.
331 Read from the specified
333 on a multi-file tape.
334 File numbering starts at 1.
336 When creating certain types of files, restore may generate a warning
337 diagnostic if they already exist in the target directory.
340 (unlink) flag causes restore to remove old entries before attempting
345 does its work silently.
349 flag causes it to type the name of each file it treats
350 preceded by its file type.
352 Do not ask the user whether to abort the restore in the event of an error.
353 Always try to skip over the bad block(s) and continue.
357 complains if it gets a read error.
360 has been specified, or the user responds
363 will attempt to continue the restore.
365 If a backup was made using more than one tape volume,
367 will notify the user when it is time to mount the next volume.
372 flag has been specified,
374 will also ask which volume the user wishes to mount.
375 The fastest way to extract a few files is to
376 start with the last volume, and work towards the first volume.
378 There are numerous consistency checks that can be listed by
380 Most checks are self-explanatory or can ``never happen''.
381 Common errors are given below.
383 .Bl -tag -width Ds -compact
384 .It Converting to new filesystem format.
385 A dump tape created from the old filesystem has been loaded.
386 It is automatically converted to the new filesystem format.
388 .It <filename>: not found on tape
389 The specified file name was listed in the tape directory,
390 but was not found on the tape.
391 This is caused by tape read errors while looking for the file,
392 and from using a dump tape created on an active filesystem.
394 .It expected next file <inumber>, got <inumber>
395 A file that was not listed in the directory showed up.
396 This can occur when using a dump created on an active filesystem.
398 .It Incremental dump too low
399 When doing incremental restore,
400 a dump that was written before the previous incremental dump,
401 or that has too low an incremental level has been loaded.
403 .It Incremental dump too high
404 When doing incremental restore,
405 a dump that does not begin its coverage where the previous incremental
407 or that has too high an incremental level has been loaded.
409 .It Tape read error while restoring <filename>
410 .It Tape read error while skipping over inode <inumber>
411 .It Tape read error while trying to resynchronize
412 A tape (or other media) read error has occurred.
413 If a file name is specified,
414 then its contents are probably partially wrong.
415 If an inode is being skipped or the tape is trying to resynchronize,
416 then no extracted files have been corrupted,
417 though files may not be found on the tape.
419 .It resync restore, skipped <num> blocks
420 After a dump read error,
422 may have to resynchronize itself.
423 This message lists the number of blocks that were skipped over.
426 .Bl -tag -width "./restoresymtable" -compact
428 the default tape drive
430 file containing directories on the tape.
432 owner, mode, and time stamps for directories.
433 .It Pa \&./restoresymtable
434 information passed between incremental restores.
443 can get confused when doing incremental restores from
444 dumps that were made on active filesystems.
446 A level zero dump must be done after a full restore.
447 Because restore runs in user code,
448 it has no control over inode allocation;
449 thus a full dump must be done to get a new set of directories
450 reflecting the new inode numbering,
451 even though the contents of the files is unchanged.
453 To do a network restore, you have to run restore as root. This is due
454 to the previous security history of dump and restore. (restore is
455 written to be setuid root, but we are not certain all bugs are gone
456 from the restore code - run setuid at your own risk.)
462 are generated with a unique name based on the date of the dump
463 and the process ID (see
472 allows you to restart a
474 operation that may have been interrupted, the temporary files should
475 be the same across different processes.
476 In all other cases, the files are unique because it is possible to
477 have two different dumps started at the same time, and separate
478 operations shouldn't conflict with each other.