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