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