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.\" 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. 19.\" 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 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)restore.8 8.4 (Berkeley) 5/1/95 33.\" $FreeBSD$ 34.\" 35.Dd May 1, 1995 36.Dt RESTORE 8 37.Os 38.Sh NAME 39.Nm restore , 40.Nm rrestore 41.Nd "restore files or file systems from backups made with dump" 42.Sh SYNOPSIS 43.Nm 44.Fl i 45.Op Fl cdhkmNuvy 46.Op Fl b Ar blocksize 47.Op Fl f Ar file 48.Op Fl s Ar fileno 49.Nm 50.Fl R 51.Op Fl cdkNuvy 52.Op Fl b Ar blocksize 53.Op Fl f Ar file 54.Op Fl s Ar fileno 55.Nm 56.Fl r 57.Op Fl cdkNuvy 58.Op Fl b Ar blocksize 59.Op Fl f Ar file 60.Op Fl s Ar fileno 61.Nm 62.Fl t 63.Op Fl cdhkNuvy 64.Op Fl b Ar blocksize 65.Op Fl f Ar file 66.Op Fl s Ar fileno 67.Op Ar 68.Nm 69.Fl x 70.Op Fl cdhkmNuvy 71.Op Fl b Ar blocksize 72.Op Fl f Ar file 73.Op Fl s Ar fileno 74.Op Ar 75.Pp 76.Nm rrestore 77is an alternate name for 78.Nm . 79.Pp 80.in \" XXX 81(The 82.Bx 4.3 83option syntax is implemented for backward compatibility, but 84is not documented here.) 85.Sh DESCRIPTION 86The 87.Nm 88command performs the inverse function of 89.Xr dump 8 . 90A full backup of a file system may be restored and 91subsequent incremental backups layered on top of it. 92Single files and 93directory subtrees may be restored from full or partial 94backups. 95.Nm Restore 96works across a network; 97to do this see the 98.Fl f 99flag described below. 100Other arguments to the command are file or directory 101names specifying the files that are to be restored. 102Unless the 103.Fl h 104flag is specified (see below), 105the appearance of a directory name refers to 106the files and (recursively) subdirectories of that directory. 107.Pp 108Exactly one of the following flags is required: 109.Bl -tag -width Ds 110.It Fl i 111This mode allows interactive restoration of files from a dump. 112After reading in the directory information from the dump, 113.Nm 114provides a shell like interface that allows the user to move 115around the directory tree selecting files to be extracted. 116The available commands are given below; 117for those commands that require an argument, 118the default is the current directory. 119.Bl -tag -width Fl 120.It Ic add Op Ar arg 121The current directory or specified argument is added to the list of 122files to be extracted. 123If a directory is specified, then it and all its descendents are 124added to the extraction list 125(unless the 126.Fl h 127flag is specified on the command line). 128Files that are on the extraction list are prepended with a ``*'' 129when they are listed by 130.Ic ls . 131.It Ic \&cd Ar arg 132Change the current working directory to the specified argument. 133.It Ic delete Op Ar arg 134The current directory or specified argument is deleted from the list of 135files to be extracted. 136If a directory is specified, then it and all its descendents are 137deleted from the extraction list 138(unless the 139.Fl h 140flag is specified on the command line). 141The most expedient way to extract most of the files from a directory 142is to add the directory to the extraction list and then delete 143those files that are not needed. 144.It Ic extract 145All the files that are on the extraction list are extracted 146from the dump. 147.Nm Restore 148will 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 162Restore immediately exits, 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 180Displays dump header information, which includes: date, 181level, label, and the filesystem and host dump was made 182from. 183.El 184.It Fl R 185.Nm Restore 186requests a particular tape of a multi volume set on which to restart 187a full restore 188(see the 189.Fl r 190flag below). 191This is useful if the restore has been interrupted. 192.It Fl r 193Restore (rebuild a file system). 194The target file system should be made pristine with 195.Xr newfs 8 , 196mounted and the user 197.Xr cd Ns 'd 198into the pristine file system 199before starting the restoration of the initial level 0 backup. 200If the 201level 0 restores successfully, the 202.Fl r 203flag may be used to restore 204any necessary incremental backups on top of the level 0. 205The 206.Fl r 207flag precludes an interactive file extraction and can be 208detrimental to one's health if not used carefully (not to mention 209the disk). An 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 227.Nm Restore , 228in conjunction with 229.Xr newfs 8 230and 231.Xr dump 8 , 232may be used to modify file system parameters 233such as size or block size. 234.It Fl t 235The names of the specified files are listed if they occur 236on the backup. 237If no file argument is given, 238then the root directory is listed, 239which results in the entire content of the 240backup being listed, 241unless the 242.Fl h 243flag has been specified. 244Note that the 245.Fl t 246flag replaces the function of the old 247.Xr dumpdir 8 248program. 249.It Fl x 250The named files are read from the given media. 251If a named file matches a directory whose contents 252are on the backup 253and the 254.Fl h 255flag is not specified, 256the directory is recursively extracted. 257The owner, modification time, 258and mode are restored (if possible). 259If no file argument is given, 260then the root directory is extracted, 261which results in the entire content of the 262backup being extracted, 263unless the 264.Fl h 265flag has been specified. 266.El 267.Pp 268The following additional options may be specified: 269.Bl -tag -width Ds 270.It Fl b Ar blocksize 271The number of kilobytes per dump record. 272If the 273.Fl b 274option is not specified, 275.Nm 276tries to determine the media block size dynamically. 277.It Fl c 278Normally, 279.Nm 280will try to determine dynamically whether the dump was made from an 281old (pre-4.4) or new format file system. The 282.Fl c 283flag disables this check, and only allows reading a dump in the old 284format. 285.It Fl d 286Sends verbose debugging output to the standard error. 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.Ql 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.Pp 309.It Fl k 310Use Kerberos authentication when contacting the remote tape server. 311(Only available if this options was enabled when 312.Nm 313was compiled.) 314.Pp 315.It Fl h 316Extract the actual directory, 317rather than the files that it references. 318This prevents hierarchical restoration of complete subtrees 319from the dump. 320.It Fl m 321Extract by inode numbers rather than by file name. 322This is useful if only a few files are being extracted, 323and one wants to avoid regenerating the complete pathname 324to the file. 325.It Fl N 326Do the extraction normally, but do not actually write any changes 327to disk. 328This can be used to check the integrity of dump media 329or other test purposes. 330.It Fl s Ar fileno 331Read from the specified 332.Ar fileno 333on a multi-file tape. 334File numbering starts at 1. 335.It Fl u 336When creating certain types of files, restore may generate a warning 337diagnostic if they already exist in the target directory. 338To prevent this, the 339.Fl u 340(unlink) flag causes restore to remove old entries before attempting 341to create new ones. 342.It Fl v 343Normally 344.Nm 345does its work silently. 346The 347.Fl v 348(verbose) 349flag causes it to type the name of each file it treats 350preceded by its file type. 351.It Fl y 352Do not ask the user whether to abort the restore in the event of an error. 353Always try to skip over the bad block(s) and continue. 354.El 355.Sh DIAGNOSTICS 356.Nm 357complains if it gets a read error. 358If 359.Fl y 360has been specified, or the user responds 361.Ql y , 362.Nm 363will attempt to continue the restore. 364.Pp 365If a backup was made using more than one tape volume, 366.Nm 367will notify the user when it is time to mount the next volume. 368If the 369.Fl x 370or 371.Fl i 372flag has been specified, 373.Nm 374will also ask which volume the user wishes to mount. 375The fastest way to extract a few files is to 376start with the last volume, and work towards the first volume. 377.Pp 378There are numerous consistency checks that can be listed by 379.Nm . 380Most checks are self-explanatory or can ``never happen''. 381Common errors are given below. 382.Pp 383.Bl -tag -width Ds -compact 384.It Converting to new file system format. 385A dump tape created from the old file system has been loaded. 386It is automatically converted to the new file system format. 387.Pp 388.It <filename>: not found on tape 389The specified file name was listed in the tape directory, 390but was not found on the tape. 391This is caused by tape read errors while looking for the file, 392and from using a dump tape created on an active file system. 393.Pp 394.It expected next file <inumber>, got <inumber> 395A file that was not listed in the directory showed up. 396This can occur when using a dump created on an active file system. 397.Pp 398.It Incremental dump too low 399When doing incremental restore, 400a dump that was written before the previous incremental dump, 401or that has too low an incremental level has been loaded. 402.Pp 403.It Incremental dump too high 404When doing incremental restore, 405a dump that does not begin its coverage where the previous incremental 406dump left off, 407or that has too high an incremental level has been loaded. 408.Pp 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 412A tape (or other media) read error has occurred. 413If a file name is specified, 414then its contents are probably partially wrong. 415If an inode is being skipped or the tape is trying to resynchronize, 416then no extracted files have been corrupted, 417though files may not be found on the tape. 418.Pp 419.It resync restore, skipped <num> blocks 420After a dump read error, 421.Nm 422may have to resynchronize itself. 423This message lists the number of blocks that were skipped over. 424.El 425.Sh FILES 426.Bl -tag -width "./restoresymtable" -compact 427.It Pa /dev/sa0 428the default tape drive 429.It Pa /tmp/rstdir* 430file containing directories on the tape. 431.It Pa /tmp/rstmode* 432owner, mode, and time stamps for directories. 433.It Pa \&./restoresymtable 434information passed between incremental restores. 435.El 436.Sh SEE ALSO 437.Xr dump 8 , 438.Xr mount 8 , 439.Xr newfs 8 , 440.Xr rmt 8 441.Sh BUGS 442.Nm Restore 443can get confused when doing incremental restores from 444dumps that were made on active file systems. 445.Pp 446A level zero dump must be done after a full restore. 447Because restore runs in user code, 448it has no control over inode allocation; 449thus a full dump must be done to get a new set of directories 450reflecting the new inode numbering, 451even though the contents of the files is unchanged. 452.Pp 453To do a network restore, you have to run restore as root. This is due 454to the previous security history of dump and restore. (restore is 455written to be setuid root, but we are not certain all bugs are gone 456from the restore code - run setuid at your own risk.) 457.Pp 458The temporary files 459.Pa /tmp/rstdir* 460and 461.Pa /tmp/rstmode* 462are generated with a unique name based on the date of the dump 463and the process ID (see 464.Xr mktemp 3 ) , 465except for when 466.Fl r 467or 468.Fl R 469is used. 470Because 471.Fl R 472allows you to restart a 473.Fl r 474operation that may have been interrupted, the temporary files should 475be the same across different processes. 476In all other cases, the files are unique because it is possible to 477have two different dumps started at the same time, and separate 478operations shouldn't conflict with each other. 479.Sh HISTORY 480The 481.Nm 482command appeared in 483.Bx 4.2 . 484