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
39 .Nd "restore files or file systems from backups made with dump"
45 .Op Fl D Ar filesystem
90 option syntax is implemented for backward compatibility, but
91 is not documented here.)
95 command performs the inverse function of
97 A full backup of a file system may be restored and
98 subsequent incremental backups layered on top of it.
100 directory subtrees may be restored from full or partial
103 works across a network;
106 flag described below.
107 Other arguments to the command are file or directory
108 names specifying the files that are to be restored.
111 flag is specified (see below),
112 the appearance of a directory name refers to
113 the files and (recursively) subdirectories of that directory.
115 Exactly one of the following flags is required:
118 This mode allows comparison of files from a dump.
120 reads the backup and compares its contents with files present on the
122 It first changes its working directory to the root of the filesystem
123 that was dumped and compares the tape with the files in its new
126 This mode allows interactive restoration of files from a dump.
127 After reading in the directory information from the dump,
129 provides a shell like interface that allows the user to move
130 around the directory tree selecting files to be extracted.
131 The available commands are given below;
132 for those commands that require an argument,
133 the default is the current directory.
136 The current directory or specified argument is added to the list of
137 files to be extracted.
138 If a directory is specified, then it and all its descendents are
139 added to the extraction list
142 flag is specified on the command line).
143 Files that are on the extraction list are prepended with a ``*''
144 when they are listed by
147 Change the current working directory to the specified argument.
148 .It Ic delete Op Ar arg
149 The current directory or specified argument is deleted from the list of
150 files to be extracted.
151 If a directory is specified, then it and all its descendents are
152 deleted from the extraction list
155 flag is specified on the command line).
156 The most expedient way to extract most of the files from a directory
157 is to add the directory to the extraction list and then delete
158 those files that are not needed.
160 All the files that are on the extraction list are extracted
163 will ask which volume the user wishes to mount.
164 The fastest way to extract a few files is to
165 start with the last volume, and work towards the first volume.
167 List a summary of the available commands.
168 .It Ic \&ls Op Ar arg
169 List the current or specified directory.
170 Entries that are directories are appended with a ``/''.
171 Entries that have been marked for extraction are prepended with a ``*''.
173 flag is set the inode number of each entry is also listed.
175 Print the full pathname of the current working directory.
177 Restore immediately exits,
178 even if the extraction list is not empty.
180 All the directories that have been added to the extraction list
181 have their owner, modes, and times set;
182 nothing is extracted from the dump.
183 This is useful for cleaning up after a restore has been prematurely aborted.
188 When set, the verbose flag causes the
190 command to list the inode numbers of all entries.
193 to print out information about each file as it is extracted.
197 requests a particular tape of a multi volume set on which to restart
202 This is useful if the restore has been interrupted.
204 Restore (rebuild a file system).
205 The target file system should be made pristine with
209 into the pristine file system
210 before starting the restoration of the initial level 0 backup. If the
211 level 0 restores successfully, the
213 flag may be used to restore
214 any necessary incremental backups on top of the level 0.
217 flag precludes an interactive file extraction and can be
218 detrimental to one's health if not used carefully (not to mention
219 the disk). An example:
220 .Bd -literal -offset indent
221 newfs /dev/rrp0g eagle
232 in the root directory to pass information between incremental
234 This file should be removed when the last incremental has been
242 may be used to modify file system parameters
243 such as size or block size.
245 The names of the specified files are listed if they occur
247 If no file argument is given,
248 then the root directory is listed,
249 which results in the entire content of the
253 flag has been specified.
256 flag replaces the function of the old
261 The named files are read from the given media.
262 If a named file matches a directory whose contents
266 flag is not specified,
267 the directory is recursively extracted.
268 The owner, modification time,
269 and mode are restored (if possible).
270 If no file argument is given,
271 then the root directory is extracted,
272 which results in the entire content of the
273 backup being extracted,
276 flag has been specified.
279 The following additional options may be specified:
281 .It Fl b Ar blocksize
282 The number of kilobytes per dump record.
285 option is not specified,
287 tries to determine the block size dynamically.
291 will try to determine dynamically whether the dump was made from an
292 old (pre-4.4) or new format file sytem. The
294 flag disables this check, and only allows reading a dump in the old
296 .It Fl D Ar filesystem
299 flag allows the user to specify the filesystem name when using
303 option to check the backup.
308 may be a special device file
317 (the standard input).
318 If the name of the file is of the form
323 reads from the named file on the remote host using
327 Extract the actual directory,
328 rather than the files that it references.
329 This prevents hierarchical restoration of complete subtrees
332 Extract by inode numbers rather than by file name.
333 This is useful if only a few files are being extracted,
334 and one wants to avoid regenerating the complete pathname
340 .Nm restore to only print file names. Files are not extracted.
342 Read from the specified
344 on a multi-file tape.
345 File numbering starts at 1.
346 .It Fl T Ar directory
349 flag allows the user to specify a directory to use for the storage of
350 temporary files. The default value is /tmp. This flag is most useful
351 when restoring files after having booted from a floppy. There might be little
352 or no space on the floppy filesystem, but another source of space might exist.
356 does its work silently.
360 flag causes it to type the name of each file it treats
361 preceded by its file type.
363 Do not ask the user whether to abort the restore in the event of an error.
364 Always try to skip over the bad block(s) and continue.
367 Complaints if it gets a read error.
370 has been specified, or the user responds
373 will attempt to continue the restore.
375 If a backup was made using more than one tape volume,
377 will notify the user when it is time to mount the next volume.
382 flag has been specified,
384 will also ask which volume the user wishes to mount.
385 The fastest way to extract a few files is to
386 start with the last volume, and work towards the first volume.
388 There are numerous consistency checks that can be listed by
390 Most checks are self-explanatory or can ``never happen''.
391 Common errors are given below.
393 .Bl -tag -width Ds -compact
394 .It Converting to new file system format.
395 A dump tape created from the old file system has been loaded.
396 It is automatically converted to the new file system format.
398 .It <filename>: not found on tape
399 The specified file name was listed in the tape directory,
400 but was not found on the tape.
401 This is caused by tape read errors while looking for the file,
402 and from using a dump tape created on an active file system.
404 .It expected next file <inumber>, got <inumber>
405 A file that was not listed in the directory showed up.
406 This can occur when using a dump created on an active file system.
408 .It Incremental dump too low
409 When doing incremental restore,
410 a dump that was written before the previous incremental dump,
411 or that has too low an incremental level has been loaded.
413 .It Incremental dump too high
414 When doing incremental restore,
415 a dump that does not begin its coverage where the previous incremental
417 or that has too high an incremental level has been loaded.
419 .It Tape read error while restoring <filename>
420 .It Tape read error while skipping over inode <inumber>
421 .It Tape read error while trying to resynchronize
422 A tape (or other media) read error has occurred.
423 If a file name is specified,
424 then its contents are probably partially wrong.
425 If an inode is being skipped or the tape is trying to resynchronize,
426 then no extracted files have been corrupted,
427 though files may not be found on the tape.
429 .It resync restore, skipped <num> blocks
430 After a dump read error,
432 may have to resynchronize itself.
433 This message lists the number of blocks that were skipped over.
436 .Bl -tag -width "./restoresymtable" -compact
438 the default tape drive
440 file containing directories on the tape.
442 owner, mode, and time stamps for directories.
443 .It Pa \&./restoresymtable
444 information passed between incremental restores.
454 can get confused when doing incremental restores from
455 dumps that were made on active file systems.
457 A level zero dump must be done after a full restore.
458 Because restore runs in user code,
459 it has no control over inode allocation;
460 thus a full dump must be done to get a new set of directories
461 reflecting the new inode numbering,
462 even though the contents of the files is unchanged.