sbin/restore/restore.8

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