1.\" Copyright (c) 1985, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)restore.8 8.4 (Berkeley) 5/1/95 29.\" $FreeBSD$ 30.\" 31.Dd October 12, 2006 32.Dt RESTORE 8 33.Os 34.Sh NAME 35.Nm restore , 36.Nm rrestore 37.Nd "restore files or file systems from backups made with dump" 38.Sh SYNOPSIS 39.Nm 40.Fl i 41.Op Fl dDhmNuvy 42.Op Fl b Ar blocksize 43.Op Fl f Ar file | Fl P Ar pipecommand 44.Op Fl s Ar fileno 45.Nm 46.Fl R 47.Op Fl dDNuvy 48.Op Fl b Ar blocksize 49.Op Fl f Ar file | Fl P Ar pipecommand 50.Op Fl s Ar fileno 51.Nm 52.Fl r 53.Op Fl dDNuvy 54.Op Fl b Ar blocksize 55.Op Fl f Ar file | Fl P Ar pipecommand 56.Op Fl s Ar fileno 57.Nm 58.Fl t 59.Op Fl dDhNuvy 60.Op Fl b Ar blocksize 61.Op Fl f Ar file | Fl P Ar pipecommand 62.Op Fl s Ar fileno 63.Op Ar 64.Nm 65.Fl x 66.Op Fl dDhmNuvy 67.Op Fl b Ar blocksize 68.Op Fl f Ar file | Fl P Ar pipecommand 69.Op Fl s Ar fileno 70.Op Ar 71.Pp 72.Nm rrestore 73is an alternate name for 74.Nm . 75.Pp 76.in \" XXX 77(The 78.Bx 4.3 79option syntax is implemented for backward compatibility, but 80is not documented here.) 81.Sh DESCRIPTION 82The 83.Nm 84utility performs the inverse function of 85.Xr dump 8 . 86A full backup of a file system may be restored and 87subsequent incremental backups layered on top of it. 88Single files and 89directory subtrees may be restored from full or partial 90backups. 91The 92.Nm 93utility works across a network; 94to do this see the 95.Fl f 96and 97.Fl P 98flags described below. 99Other arguments to the command are file or directory 100names specifying the files that are to be restored. 101Unless the 102.Fl h 103flag is specified (see below), 104the appearance of a directory name refers to 105the files and (recursively) subdirectories of that directory. 106.Pp 107Exactly one of the following flags is required: 108.Bl -tag -width Ds 109.It Fl i 110This mode allows interactive restoration of files from a dump. 111After reading in the directory information from the dump, 112.Nm 113provides a shell like interface that allows the user to move 114around the directory tree selecting files to be extracted. 115The available commands are given below; 116for those commands that require an argument, 117the default is the current directory. 118.Bl -tag -width Fl 119.It Ic add Op Ar arg 120The current directory or specified argument is added to the list of 121files to be extracted. 122If a directory is specified, then it and all its descendents are 123added to the extraction list 124(unless the 125.Fl h 126flag is specified on the command line). 127Files that are on the extraction list are prepended with a ``*'' 128when they are listed by 129.Ic ls . 130.It Ic \&cd Ar arg 131Change the current working directory to the specified argument. 132.It Ic delete Op Ar arg 133The current directory or specified argument is deleted from the list of 134files to be extracted. 135If a directory is specified, then it and all its descendents are 136deleted from the extraction list 137(unless the 138.Fl h 139flag is specified on the command line). 140The most expedient way to extract most of the files from a directory 141is to add the directory to the extraction list and then delete 142those files that are not needed. 143.It Ic extract 144All the files that are on the extraction list are extracted 145from the dump. 146The 147.Nm 148utility will ask which volume the user wishes to mount. 149The fastest way to extract a few files is to 150start with the last volume, and work towards the first volume. 151.It Ic help 152List a summary of the available commands. 153.It Ic \&ls Op Ar arg 154List the current or specified directory. 155Entries that are directories are appended with a ``/''. 156Entries that have been marked for extraction are prepended with a ``*''. 157If the verbose 158flag is set the inode number of each entry is also listed. 159.It Ic pwd 160Print the full pathname of the current working directory. 161.It Ic quit 162Exit immediately, 163even if the extraction list is not empty. 164.It Ic setmodes 165All the directories that have been added to the extraction list 166have their owner, modes, and times set; 167nothing is extracted from the dump. 168This is useful for cleaning up after a restore has been prematurely aborted. 169.It Ic verbose 170The sense of the 171.Fl v 172flag is toggled. 173When set, the verbose flag causes the 174.Ic ls 175command to list the inode numbers of all entries. 176It also causes 177.Nm 178to print out information about each file as it is extracted. 179.It Ic what 180Display dump header information, which includes: date, 181level, label, and the file system and host dump was made 182from. 183.El 184.It Fl R 185Request a particular tape of a multi volume set on which to restart 186a full restore 187(see the 188.Fl r 189flag below). 190This is useful if the restore has been interrupted. 191.It Fl r 192Restore (rebuild a file system). 193The target file system should be made pristine with 194.Xr newfs 8 , 195mounted and the user 196.Xr cd 1 Ns 'd 197into the pristine file system 198before starting the restoration of the initial level 0 backup. 199If the 200level 0 restores successfully, the 201.Fl r 202flag may be used to restore 203any necessary incremental backups on top of the level 0. 204The 205.Fl r 206flag precludes an interactive file extraction and can be 207detrimental to one's health if not used carefully (not to mention 208the disk). 209An example: 210.Bd -literal -offset indent 211newfs /dev/da0s1a 212mount /dev/da0s1a /mnt 213cd /mnt 214 215restore rf /dev/sa0 216.Ed 217.Pp 218Note that 219.Nm 220leaves a file 221.Pa restoresymtable 222in the root directory to pass information between incremental 223restore passes. 224This file should be removed when the last incremental has been 225restored. 226.Pp 227The 228.Nm 229utility , 230in conjunction with 231.Xr newfs 8 232and 233.Xr dump 8 , 234may be used to modify file system parameters 235such as size or block size. 236.It Fl t 237The names of the specified files are listed if they occur 238on the backup. 239If no file argument is given, 240then the root directory is listed, 241which results in the entire content of the 242backup being listed, 243unless the 244.Fl h 245flag has been specified. 246Note that the 247.Fl t 248flag replaces the function of the old 249.Xr dumpdir 8 250program. 251.It Fl x 252The named files are read from the given media. 253If a named file matches a directory whose contents 254are on the backup 255and the 256.Fl h 257flag is not specified, 258the directory is recursively extracted. 259The owner, modification time, 260and mode are restored (if possible). 261If no file argument is given, 262then the root directory is extracted, 263which results in the entire content of the 264backup being extracted, 265unless the 266.Fl h 267flag has been specified. 268.El 269.Pp 270The following additional options may be specified: 271.Bl -tag -width Ds 272.It Fl b Ar blocksize 273The number of kilobytes per dump record. 274If the 275.Fl b 276option is not specified, 277.Nm 278tries to determine the media block size dynamically. 279.It Fl d 280Sends verbose debugging output to the standard error. 281.It Fl D 282This puts 283.Nm 284into degraded mode, 285causing restore to operate less efficiently 286but to try harder to read corrupted backups. 287.It Fl f Ar file 288Read the backup from 289.Ar file ; 290.Ar file 291may be a special device file 292like 293.Pa /dev/sa0 294(a tape drive), 295.Pa /dev/da1c 296(a disk drive), 297an ordinary file, 298or 299.Sq Fl 300(the standard input). 301If the name of the file is of the form 302.Dq host:file , 303or 304.Dq user@host:file , 305.Nm 306reads from the named file on the remote host using 307.Xr rmt 8 . 308.It Fl P Ar pipecommand 309Use 310.Xr popen 3 311to execute the 312.Xr sh 1 313script string defined by 314.Ar pipecommand 315as the input for every volume in the backup. 316This child pipeline's 317.Dv stdout 318.Pq Pa /dev/fd/1 319is redirected to the 320.Nm 321input stream, and the environment variable 322.Ev RESTORE_VOLUME 323is set to the current volume number being read. 324The 325.Ar pipecommand 326script is started each time a volume is loaded, as if it were a tape drive. 327.It Fl h 328Extract the actual directory, 329rather than the files that it references. 330This prevents hierarchical restoration of complete subtrees 331from the dump. 332.It Fl m 333Extract by inode numbers rather than by file name. 334This is useful if only a few files are being extracted, 335and one wants to avoid regenerating the complete pathname 336to the file. 337.It Fl N 338Do the extraction normally, but do not actually write any changes 339to disk. 340This can be used to check the integrity of dump media 341or other test purposes. 342.It Fl s Ar fileno 343Read from the specified 344.Ar fileno 345on a multi-file tape. 346File numbering starts at 1. 347.It Fl u 348When creating certain types of files, restore may generate a warning 349diagnostic if they already exist in the target directory. 350To prevent this, the 351.Fl u 352(unlink) flag causes restore to remove old entries before attempting 353to create new ones. 354.It Fl v 355Normally 356.Nm 357does its work silently. 358The 359.Fl v 360(verbose) 361flag causes it to type the name of each file it treats 362preceded by its file type. 363.It Fl y 364Do not ask the user whether to abort the restore in the event of an error. 365Always try to skip over the bad block(s) and continue. 366.El 367.Sh ENVIRONMENT 368.Bl -tag -width ".Ev TMPDIR" 369.It Ev TAPE 370Device from which to read backup. 371.It Ev TMPDIR 372Name of directory where temporary files are to be created. 373.El 374.Sh FILES 375.Bl -tag -width "./restoresymtable" -compact 376.It Pa /dev/sa0 377the default tape drive 378.It Pa /tmp/rstdir* 379file containing directories on the tape. 380.It Pa /tmp/rstmode* 381owner, mode, and time stamps for directories. 382.It Pa \&./restoresymtable 383information passed between incremental restores. 384.El 385.Sh DIAGNOSTICS 386The 387.Nm 388utility complains if it gets a read error. 389If 390.Fl y 391has been specified, or the user responds 392.Ql y , 393.Nm 394will attempt to continue the restore. 395.Pp 396If a backup was made using more than one tape volume, 397.Nm 398will notify the user when it is time to mount the next volume. 399If the 400.Fl x 401or 402.Fl i 403flag has been specified, 404.Nm 405will also ask which volume the user wishes to mount. 406The fastest way to extract a few files is to 407start with the last volume, and work towards the first volume. 408.Pp 409There are numerous consistency checks that can be listed by 410.Nm . 411Most checks are self-explanatory or can ``never happen''. 412Common errors are given below. 413.Pp 414.Bl -tag -width Ds -compact 415.It <filename>: not found on tape 416The specified file name was listed in the tape directory, 417but was not found on the tape. 418This is caused by tape read errors while looking for the file, 419and from using a dump tape created on an active file system. 420.Pp 421.It expected next file <inumber>, got <inumber> 422A file that was not listed in the directory showed up. 423This can occur when using a dump created on an active file system. 424.Pp 425.It Incremental dump too low 426When doing incremental restore, 427a dump that was written before the previous incremental dump, 428or that has too low an incremental level has been loaded. 429.Pp 430.It Incremental dump too high 431When doing incremental restore, 432a dump that does not begin its coverage where the previous incremental 433dump left off, 434or that has too high an incremental level has been loaded. 435.Pp 436.It Tape read error while restoring <filename> 437.It Tape read error while skipping over inode <inumber> 438.It Tape read error while trying to resynchronize 439A tape (or other media) read error has occurred. 440If a file name is specified, 441then its contents are probably partially wrong. 442If an inode is being skipped or the tape is trying to resynchronize, 443then no extracted files have been corrupted, 444though files may not be found on the tape. 445.Pp 446.It resync restore, skipped <num> blocks 447After a dump read error, 448.Nm 449may have to resynchronize itself. 450This message lists the number of blocks that were skipped over. 451.El 452.Sh SEE ALSO 453.Xr dump 8 , 454.Xr mount 8 , 455.Xr newfs 8 , 456.Xr rmt 8 457.Sh HISTORY 458The 459.Nm 460utility appeared in 461.Bx 4.2 . 462.Sh BUGS 463The 464.Nm 465utility can get confused when doing incremental restores from 466dumps that were made on active file systems without the 467.Fl L 468option (see 469.Xr dump 8 ) . 470.Pp 471A level zero dump must be done after a full restore. 472Because restore runs in user code, 473it has no control over inode allocation; 474thus a full dump must be done to get a new set of directories 475reflecting the new inode numbering, 476even though the contents of the files is unchanged. 477.Pp 478To do a network restore, you have to run restore as root. 479This is due 480to the previous security history of dump and restore. 481(restore is 482written to be setuid root, but we are not certain all bugs are gone 483from the restore code - run setuid at your own risk.) 484.Pp 485The temporary files 486.Pa /tmp/rstdir* 487and 488.Pa /tmp/rstmode* 489are generated with a unique name based on the date of the dump 490and the process ID (see 491.Xr mktemp 3 ) , 492except for when 493.Fl r 494or 495.Fl R 496is used. 497Because 498.Fl R 499allows you to restart a 500.Fl r 501operation that may have been interrupted, the temporary files should 502be the same across different processes. 503In all other cases, the files are unique because it is possible to 504have two different dumps started at the same time, and separate 505operations should not conflict with each other. 506