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