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 July 5, 2012
  36 .Dt RESTORE 8
  37 .Os
  38 .Sh NAME
  39 .Nm restore ,
  40 .Nm rrestore
  41 .Nd "restore UFS file systems or files 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 .Sh DESCRIPTION
  76 The
  77 .Nm
  78 utility performs the inverse function of
  79 .Xr dump 8 .
  80 A full backup of a file system may be restored and
  81 subsequent incremental backups layered on top of it.
  82 Single files and
  83 directory subtrees may be restored from full or partial
  84 backups.
  85 The
  86 .Nm
  87 utility works across a network;
  88 to do this see the
  89 .Fl f
  90 flag described below.
  91 Other arguments to the command are file or directory
  92 names specifying the files that are to be restored.
  93 Unless the
  94 .Fl h
  95 flag is specified (see below),
  96 the appearance of a directory name refers to
  97 the files and (recursively) subdirectories of that directory.
  98 .Pp
  99 .Nm
 100 may also be invoked as
 101 .Nm rrestore .
 102 The
 103 .Bx 4.3
 104 option syntax is implemented for backward compatibility, but
 105 is not documented here.
 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 descendants 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 descendants 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). An example:
 209 .Bd -literal -offset indent
 210 newfs /dev/da0s1a
 211 mount /dev/da0s1a /mnt
 212 cd /mnt
 213
 214 restore rf /dev/sa0
 215 .Ed
 216 .Pp
 217 Note that
 218 .Nm
 219 leaves a file
 220 .Pa restoresymtable
 221 in the root directory to pass information between incremental
 222 restore passes.
 223 This file should be removed when the last incremental has been
 224 restored.
 225 .Pp
 226 The
 227 .Nm
 228 utility ,
 229 in conjunction with
 230 .Xr newfs 8
 231 and
 232 .Xr dump 8 ,
 233 may be used to modify file system parameters
 234 such as size or block size.
 235 .It Fl t
 236 The names of the specified files are listed if they occur
 237 on the backup.
 238 If no file argument is given,
 239 then the root directory is listed,
 240 which results in the entire content of the
 241 backup being listed,
 242 unless the
 243 .Fl h
 244 flag has been specified.
 245 Note that the
 246 .Fl t
 247 flag replaces the function of the old
 248 .Xr dumpdir 8
 249 program.
 250 .It Fl x
 251 The named files are read from the given media.
 252 If a named file matches a directory whose contents
 253 are on the backup
 254 and the
 255 .Fl h
 256 flag is not specified,
 257 the directory is recursively extracted.
 258 The owner, modification time,
 259 and mode are restored (if possible).
 260 If no file argument is given,
 261 then the root directory is extracted,
 262 which results in the entire content of the
 263 backup being extracted,
 264 unless the
 265 .Fl h
 266 flag has been specified.
 267 .El
 268 .Pp
 269 The following additional options may be specified:
 270 .Bl -tag -width Ds
 271 .It Fl b Ar blocksize
 272 The number of kilobytes per dump record.
 273 If the
 274 .Fl b
 275 option is not specified,
 276 .Nm
 277 tries to determine the media block size dynamically.
 278 .It Fl c
 279 Normally,
 280 .Nm
 281 will try to determine dynamically whether the dump was made from an
 282 old (pre-4.4) or new format file system.  The
 283 .Fl c
 284 flag disables this check, and only allows reading a dump in the old
 285 format.
 286 .It Fl d
 287 Sends verbose debugging output to the standard error.
 288 .It Fl f Ar file
 289 Read the backup from
 290 .Ar file ;
 291 .Ar file
 292 may be a special device file
 293 like
 294 .Pa /dev/sa0
 295 (a tape drive),
 296 .Pa /dev/da1c
 297 (a disk drive),
 298 an ordinary file,
 299 or
 300 .Sq Fl
 301 (the standard input).
 302 If the name of the file is of the form
 303 .Dq host:file ,
 304 or
 305 .Dq user@host:file ,
 306 .Nm
 307 reads from the named file on the remote host using
 308 .Xr rmt 8 .
 309 .Pp
 310 .It Fl k
 311 Use Kerberos authentication when contacting the remote tape server.
 312 (Only available if this options was enabled when
 313 .Nm
 314 was compiled.)
 315 .Pp
 316 .It Fl h
 317 Extract the actual directory,
 318 rather than the files that it references.
 319 This prevents hierarchical restoration of complete subtrees
 320 from the dump.
 321 .It Fl m
 322 Extract by inode numbers rather than by file name.
 323 This is useful if only a few files are being extracted,
 324 and one wants to avoid regenerating the complete pathname
 325 to the file.
 326 .It Fl N
 327 Do the extraction normally, but do not actually write any changes
 328 to disk.
 329 This can be used to check the integrity of dump media
 330 or other test purposes.
 331 .It Fl s Ar fileno
 332 Read from the specified
 333 .Ar fileno
 334 on a multi-file tape.
 335 File numbering starts at 1.
 336 .It Fl u
 337 When creating certain types of files, restore may generate a warning
 338 diagnostic if they already exist in the target directory.
 339 To prevent this, the
 340 .Fl u
 341 (unlink) flag causes restore to remove old entries before attempting
 342 to create new ones.
 343 .It Fl v
 344 Normally
 345 .Nm
 346 does its work silently.
 347 The
 348 .Fl v
 349 (verbose)
 350 flag causes it to type the name of each file it treats
 351 preceded by its file type.
 352 .It Fl y
 353 Do not ask the user whether to abort the restore in the event of an error.
 354 Always try to skip over the bad block(s) and continue.
 355 .El
 356 .Sh ENVIRONMENT
 357 .Bl -tag -width ".Ev TMPDIR"
 358 .It Ev TAPE
 359 Device from which to read backup.
 360 .It Ev TMPDIR
 361 Name of directory where temporary files are to be created.
 362 .El
 363 .Sh FILES
 364 .Bl -tag -width "./restoresymtable" -compact
 365 .It Pa /dev/sa0
 366 the default tape drive
 367 .It Pa /tmp/rstdir*
 368 file containing directories on the tape.
 369 .It Pa /tmp/rstmode*
 370 owner, mode, and time stamps for directories.
 371 .It Pa \&./restoresymtable
 372 information passed between incremental restores.
 373 .El
 374 .Sh DIAGNOSTICS
 375 The
 376 .Nm
 377 utility complains if it gets a read error.
 378 If
 379 .Fl y
 380 has been specified, or the user responds
 381 .Ql y ,
 382 .Nm
 383 will attempt to continue the restore.
 384 .Pp
 385 If a backup was made using more than one tape volume,
 386 .Nm
 387 will notify the user when it is time to mount the next volume.
 388 If the
 389 .Fl x
 390 or
 391 .Fl i
 392 flag has been specified,
 393 .Nm
 394 will also ask which volume the user wishes to mount.
 395 The fastest way to extract a few files is to
 396 start with the last volume, and work towards the first volume.
 397 .Pp
 398 There are numerous consistency checks that can be listed by
 399 .Nm .
 400 Most checks are self-explanatory or can ``never happen''.
 401 Common errors are given below.
 402 .Pp
 403 .Bl -tag -width Ds -compact
 404 .It Converting to new file system format.
 405 A dump tape created from the old file system has been loaded.
 406 It is automatically converted to the new file system format.
 407 .Pp
 408 .It <filename>: not found on tape
 409 The specified file name was listed in the tape directory,
 410 but was not found on the tape.
 411 This is caused by tape read errors while looking for the file,
 412 and from using a dump tape created on an active file system.
 413 .Pp
 414 .It expected next file <inumber>, got <inumber>
 415 A file that was not listed in the directory showed up.
 416 This can occur when using a dump created on an active file system.
 417 .Pp
 418 .It Incremental dump too low
 419 When doing incremental restore,
 420 a dump that was written before the previous incremental dump,
 421 or that has too low an incremental level has been loaded.
 422 .Pp
 423 .It Incremental dump too high
 424 When doing incremental restore,
 425 a dump that does not begin its coverage where the previous incremental
 426 dump left off,
 427 or that has too high an incremental level has been loaded.
 428 .Pp
 429 .It Tape read error while restoring <filename>
 430 .It Tape read error while skipping over inode <inumber>
 431 .It Tape read error while trying to resynchronize
 432 A tape (or other media) read error has occurred.
 433 If a file name is specified,
 434 then its contents are probably partially wrong.
 435 If an inode is being skipped or the tape is trying to resynchronize,
 436 then no extracted files have been corrupted,
 437 though files may not be found on the tape.
 438 .Pp
 439 .It resync restore, skipped <num> blocks
 440 After a dump read error,
 441 .Nm
 442 may have to resynchronize itself.
 443 This message lists the number of blocks that were skipped over.
 444 .El
 445 .Sh SEE ALSO
 446 .Xr UFS 5 ,
 447 .Xr dump 8 ,
 448 .Xr mount 8 ,
 449 .Xr newfs 8 ,
 450 .Xr rmt 8
 451 .Sh HISTORY
 452 The
 453 .Nm
 454 utility appeared in
 455 .Bx 4.2 .
 456 .Sh BUGS
 457 The
 458 .Nm
 459 utility can get confused when doing incremental restores from
 460 dumps that were made on active file systems.
 461 .Pp
 462 A level zero dump must be done after a full restore.
 463 Because restore runs in user code,
 464 it has no control over inode allocation;
 465 thus a full dump must be done to get a new set of directories
 466 reflecting the new inode numbering,
 467 even though the contents of the files is unchanged.
 468 .Pp
 469 To do a network restore, you have to run restore as root.  This is due
 470 to the previous security history of dump and restore.  (restore is
 471 written to be setuid root, but we are not certain all bugs are gone
 472 from the restore code - run setuid at your own risk.)
 473 .Pp
 474 The temporary files
 475 .Pa /tmp/rstdir*
 476 and
 477 .Pa /tmp/rstmode*
 478 are generated with a unique name based on the date of the dump
 479 and the process ID (see
 480 .Xr mktemp 3 ) ,
 481 except for when
 482 .Fl r
 483 or
 484 .Fl R
 485 is used.
 486 Because
 487 .Fl R
 488 allows you to restart a
 489 .Fl r
 490 operation that may have been interrupted, the temporary files should
 491 be the same across different processes.
 492 In all other cases, the files are unique because it is possible to
 493 have two different dumps started at the same time, and separate
 494 operations shouldn't conflict with each other.