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 May 1, 1995 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 cdhmNuvy 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 cdNuvy 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 cdNuvy 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 cdhNuvy 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 cdhmNuvy 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). An example: 209.Bd -literal -offset indent 210newfs /dev/da0s1a 211mount /dev/da0s1a /mnt 212cd /mnt 213 214restore rf /dev/sa0 215.Ed 216.Pp 217Note that 218.Nm 219leaves a file 220.Pa restoresymtable 221in the root directory to pass information between incremental 222restore passes. 223This file should be removed when the last incremental has been 224restored. 225.Pp 226The 227.Nm 228utility , 229in conjunction with 230.Xr newfs 8 231and 232.Xr dump 8 , 233may be used to modify file system parameters 234such as size or block size. 235.It Fl t 236The names of the specified files are listed if they occur 237on the backup. 238If no file argument is given, 239then the root directory is listed, 240which results in the entire content of the 241backup being listed, 242unless the 243.Fl h 244flag has been specified. 245Note that the 246.Fl t 247flag replaces the function of the old 248.Xr dumpdir 8 249program. 250.It Fl x 251The named files are read from the given media. 252If a named file matches a directory whose contents 253are on the backup 254and the 255.Fl h 256flag is not specified, 257the directory is recursively extracted. 258The owner, modification time, 259and mode are restored (if possible). 260If no file argument is given, 261then the root directory is extracted, 262which results in the entire content of the 263backup being extracted, 264unless the 265.Fl h 266flag has been specified. 267.El 268.Pp 269The following additional options may be specified: 270.Bl -tag -width Ds 271.It Fl b Ar blocksize 272The number of kilobytes per dump record. 273If the 274.Fl b 275option is not specified, 276.Nm 277tries to determine the media block size dynamically. 278.It Fl c 279Normally, 280.Nm 281will try to determine dynamically whether the dump was made from an 282old (pre-4.4) or new format file system. The 283.Fl c 284flag disables this check, and only allows reading a dump in the old 285format. 286.It Fl d 287Sends verbose debugging output to the standard error. 288.It Fl f Ar file 289Read the backup from 290.Ar file ; 291.Ar file 292may be a special device file 293like 294.Pa /dev/sa0 295(a tape drive), 296.Pa /dev/da1c 297(a disk drive), 298an ordinary file, 299or 300.Sq Fl 301(the standard input). 302If the name of the file is of the form 303.Dq host:file , 304or 305.Dq user@host:file , 306.Nm 307reads from the named file on the remote host using 308.Xr rmt 8 . 309.It Fl P Ar pipecommand 310Use 311.Xr popen 3 312to execute the 313.Xr sh 1 314script string defined by 315.Ar pipecommand 316as the input for every volume in the backup. 317This child pipeline's 318.Dv stdout 319.Pq Pa /dev/fd/1 320is redirected to the 321.Nm 322input stream, and the environment variable 323.Ev RESTORE_VOLUME 324is set to the current volume number being read. 325The 326.Ar pipecommand 327script is started each time a volume is loaded, as if it were a tape drive. 328.It Fl h 329Extract the actual directory, 330rather than the files that it references. 331This prevents hierarchical restoration of complete subtrees 332from the dump. 333.It Fl m 334Extract by inode numbers rather than by file name. 335This is useful if only a few files are being extracted, 336and one wants to avoid regenerating the complete pathname 337to the file. 338.It Fl N 339Do the extraction normally, but do not actually write any changes 340to disk. 341This can be used to check the integrity of dump media 342or other test purposes. 343.It Fl s Ar fileno 344Read from the specified 345.Ar fileno 346on a multi-file tape. 347File numbering starts at 1. 348.It Fl u 349When creating certain types of files, restore may generate a warning 350diagnostic if they already exist in the target directory. 351To prevent this, the 352.Fl u 353(unlink) flag causes restore to remove old entries before attempting 354to create new ones. 355.It Fl v 356Normally 357.Nm 358does its work silently. 359The 360.Fl v 361(verbose) 362flag causes it to type the name of each file it treats 363preceded by its file type. 364.It Fl y 365Do not ask the user whether to abort the restore in the event of an error. 366Always try to skip over the bad block(s) and continue. 367.El 368.Sh DIAGNOSTICS 369The 370.Nm 371utility complains if it gets a read error. 372If 373.Fl y 374has been specified, or the user responds 375.Ql y , 376.Nm 377will attempt to continue the restore. 378.Pp 379If a backup was made using more than one tape volume, 380.Nm 381will notify the user when it is time to mount the next volume. 382If the 383.Fl x 384or 385.Fl i 386flag has been specified, 387.Nm 388will also ask which volume the user wishes to mount. 389The fastest way to extract a few files is to 390start with the last volume, and work towards the first volume. 391.Pp 392There are numerous consistency checks that can be listed by 393.Nm . 394Most checks are self-explanatory or can ``never happen''. 395Common errors are given below. 396.Pp 397.Bl -tag -width Ds -compact 398.It Converting to new file system format. 399A dump tape created from the old file system has been loaded. 400It is automatically converted to the new file system format. 401.Pp 402.It <filename>: not found on tape 403The specified file name was listed in the tape directory, 404but was not found on the tape. 405This is caused by tape read errors while looking for the file, 406and from using a dump tape created on an active file system. 407.Pp 408.It expected next file <inumber>, got <inumber> 409A file that was not listed in the directory showed up. 410This can occur when using a dump created on an active file system. 411.Pp 412.It Incremental dump too low 413When doing incremental restore, 414a dump that was written before the previous incremental dump, 415or that has too low an incremental level has been loaded. 416.Pp 417.It Incremental dump too high 418When doing incremental restore, 419a dump that does not begin its coverage where the previous incremental 420dump left off, 421or that has too high an incremental level has been loaded. 422.Pp 423.It Tape read error while restoring <filename> 424.It Tape read error while skipping over inode <inumber> 425.It Tape read error while trying to resynchronize 426A tape (or other media) read error has occurred. 427If a file name is specified, 428then its contents are probably partially wrong. 429If an inode is being skipped or the tape is trying to resynchronize, 430then no extracted files have been corrupted, 431though files may not be found on the tape. 432.Pp 433.It resync restore, skipped <num> blocks 434After a dump read error, 435.Nm 436may have to resynchronize itself. 437This message lists the number of blocks that were skipped over. 438.El 439.Sh FILES 440.Bl -tag -width "./restoresymtable" -compact 441.It Pa /dev/sa0 442the default tape drive 443.It Pa /tmp/rstdir* 444file containing directories on the tape. 445.It Pa /tmp/rstmode* 446owner, mode, and time stamps for directories. 447.It Pa \&./restoresymtable 448information passed between incremental restores. 449.El 450.Sh ENVIRONMENT 451.Bl -tag -width ".Ev TMPDIR" 452.It Ev TAPE 453Device from which to read backup. 454.It Ev TMPDIR 455Name of directory where temporary files are to be created. 456.El 457.Sh SEE ALSO 458.Xr dump 8 , 459.Xr mount 8 , 460.Xr newfs 8 , 461.Xr rmt 8 462.Sh BUGS 463The 464.Nm 465utility can get confused when doing incremental restores from 466dumps that were made on active file systems. 467.Pp 468A level zero dump must be done after a full restore. 469Because restore runs in user code, 470it has no control over inode allocation; 471thus a full dump must be done to get a new set of directories 472reflecting the new inode numbering, 473even though the contents of the files is unchanged. 474.Pp 475To do a network restore, you have to run restore as root. This is due 476to the previous security history of dump and restore. (restore is 477written to be setuid root, but we are not certain all bugs are gone 478from the restore code - run setuid at your own risk.) 479.Pp 480The temporary files 481.Pa /tmp/rstdir* 482and 483.Pa /tmp/rstmode* 484are generated with a unique name based on the date of the dump 485and the process ID (see 486.Xr mktemp 3 ) , 487except for when 488.Fl r 489or 490.Fl R 491is used. 492Because 493.Fl R 494allows you to restart a 495.Fl r 496operation that may have been interrupted, the temporary files should 497be the same across different processes. 498In all other cases, the files are unique because it is possible to 499have two different dumps started at the same time, and separate 500operations shouldn't conflict with each other. 501.Sh HISTORY 502The 503.Nm 504utility appeared in 505.Bx 4.2 . 506