4.4BSD/usr/share/man/cat8/rrestore.0

Compare this file to the similar file:
Show the results in this format:

RESTORE(8)                BSD System Manager's Manual               RESTORE(8)

NNAAMMEE
     rreessttoorree - restore files or file systems from backups made with dump

SSYYNNOOPPSSIISS
     rreessttoorree _k_e_y [_n_a_m_e _._._.]

DDEESSCCRRIIPPTTIIOONN
     The rreessttoorree command performs the inverse function of dump(8).  A full
     backup of a file system may be restored and subsequent incremental back-
     ups layered on top of it.  Single files and directory subtrees may be re-
     stored from full or partial backups.  RReessttoorree works across a network; to
     do this see the --ff flag described below.  The actions of rreessttoorree are con-
     trolled by the given kkeeyy, which is a string of characters containing at
     most one function letter and possibly one or more function modifiers.
     Other arguments to the command are file or directory names specifying the
     files that are to be restored.  Unless the hh key is specified (see be-
     low), the appearance of a directory name refers to the files and (recur-
     sively) subdirectories of that directory.

     The function portion of the key is specified by one of the following let-
     ters:

     rr       Restore (rebuild a file system).  The target file system should
             be made pristine with newfs(8),  mounted and the user cd'd  into
             the pristine file system before starting the restoration of the
             initial level 0 backup. If the level 0 restores successfully, the
             rr key may be used to restore any necessary incremental backups on
             top of the level 0.  The rr key precludes an interactive file ex-
             traction and can be detrimental to ones health if not used care-
             fully (not to mention the disk). An example:

                   newfs /dev/rrp0g eagle
                   mount /dev/rp0g /mnt
                   cd /mnt

                   restore rf /dev/rst8

             Note that rreessttoorree leaves a file _r_e_s_t_o_r_e_s_y_m_t_a_b_l_e in the root di-
             rectory to pass information between incremental restore passes.
             This file should be removed when the last incremental has been
             restored.

             RReessttoorree, in conjunction with newfs(8) and dump(8),  may be used
             to modify file system parameters such as size or block size.

     RR       RReessttoorree requests a particular tape of a multi volume set on which
             to restart a full restore (see the rr key above).  This is useful
             if the restore has been interrupted.

     xx       The named files are read from the given media.  If a named file
             matches a directory whose contents are on the backup and the hh
             key is not specified, the directory is recursively extracted.
             The owner, modification time, and mode are restored (if possi-
             ble).  If no file argument is given, then the root directory is
             extracted, which results in the entire content of the backup be-
             ing extracted, unless the hh key has been specified.

     tt       The names of the specified files are listed if they occur on the
             backup.  If no file argument is given, then the root directory is
             listed, which results in the entire content of the backup being
             listed, unless the hh key has been specified.  Note that the tt key


             replaces the function of the old dumpdir(8) program.

     ii       This mode allows interactive restoration of files from a dump.
             After reading in the directory information from the dump, rreessttoorree
             provides a shell like interface that allows the user to move
             around the directory tree selecting files to be extracted.  The
             available commands are given below; for those commands that re-
             quire an argument, the default is the current directory.

             aadddd [_a_r_g]   The current directory or specified argument is added
                         to the list of files to be extracted.  If a directory
                         is specified, then it and all its descendents are
                         added to the extraction list (unless the hh key is
                         specified on the command line).  Files that are on
                         the extraction list are prepended with a ``*'' when
                         they are listed by llss.

             ccdd _a_r_g      Change the current working directory to the specified
                         argument.

             ddeelleettee [_a_r_g]
                         The current directory or specified argument is delet-
                         ed from the list of files to be extracted.  If a di-
                         rectory is specified, then it and all its descendents
                         are deleted from the extraction list (unless the hh
                         key is specified on the command line).  The most ex-
                         pedient way to extract most of the files from a di-
                         rectory is to add the directory to the extraction
                         list and then delete those files that are not needed.

             eexxttrraacctt     All the files that are on the extraction list are ex-
                         tracted from the dump.  RReessttoorree will ask which volume
                         the user wishes to mount.  The fastest way to extract
                         a few files is to start with the last volume, and
                         work towards the first volume.

             hheellpp        List a summary of the available commands.

             llss [_a_r_g]    List the current or specified directory.  Entries
                         that are directories are appended with a ``/''.  En-
                         tries that have been marked for extraction are
                         prepended with a ``*''.  If the verbose key is set
                         the inode number of each entry is also listed.

             ppwwdd         Print the full pathname of the current working direc-
                         tory.

             qquuiitt        Restore immediately exits, even if the extraction
                         list is not empty.

             sseettmmooddeess    All the directories that have been added to the ex-
                         traction list have their owner, modes, and times set;
                         nothing is extracted from the dump.  This is useful
                         for cleaning up after a restore has been prematurely
                         aborted.

             vveerrbboossee     The sense of the vv key is toggled.  When set, the
                         verbose key causes the llss command to list the inode
                         numbers of all entries.  It also causes rreessttoorree to
                         print out information about each file as it is ex-
                         tracted.

     The following characters may be used in addition to the letter that se-
     lects the function desired.

     bb       The next argument to rreessttoorree is used as the block size of the me-
             dia (in kilobytes).  If the --bb option is not specified, rreessttoorree
             tries to determine the media block size dynamically.

     ff       The next argument to rreessttoorree is used as the name of the archive
             instead of _/_d_e_v_/_r_m_t_?. If the name of the file is of the form
             ``host:file'', rreessttoorree reads from the named file on the remote
             host using rmt(8).  If the name of the file is `--', rreessttoorree reads
             from standard input.  Thus, dump(8) and rreessttoorree can be used in a
             pipeline to dump and restore a file system with the command

                   dump 0f - /usr | (cd /mnt; restore xf -)

     hh       RReessttoorree extracts the actual directory, rather than the files that
             it references.  This prevents hierarchical restoration of com-
             plete subtrees from the dump.

     mm       RReessttoorree will extract by inode numbers rather than by file name.
             This is useful if only a few files are being extracted, and one
             wants to avoid regenerating the complete pathname to the file.

     ss       The next argument to rreessttoorree is a number which selects the file
             on a multi-file dump tape.  File numbering starts at 1.

     vv       Normally rreessttoorree does its work silently.  The vv (verbose) key
             causes it to type the name of each file it treats preceded by its
             file type.

     yy       RReessttoorree will not ask whether it should abort the restore if gets
             an error.  It will always try to skip over the bad block(s) and
             continue as best it can.

DDIIAAGGNNOOSSTTIICCSS
     Complaints about bad key characters.

     Complaints if it gets a read error.  If yy has been specified, or the user
     responds `y', rreessttoorree will attempt to continue the restore.

     If a backup was made using more than one tape volume, rreessttoorree will notify
     the user when it is time to mount the next volume.  If the xx or ii key has
     been specified, rreessttoorree will also ask which volume the user wishes to
     mount.  The fastest way to extract a few files is to start with the last
     volume, and work towards the first volume.

     There are numerous consistency checks that can be listed by rreessttoorree. Most
     checks are self-explanatory or can ``never happen''.  Common errors are
     given below.

     Converting to new file system format.
             A dump tape created from the old file system has been loaded.  It
             is automatically converted to the new file system format.

     <filename>: not found on tape
             The specified file name was listed in the tape directory, but was
             not found on the tape.  This is caused by tape read errors while
             looking for the file, and from using a dump tape created on an
             active file system.

     expected next file <inumber>, got <inumber>
             A file that was not listed in the directory showed up.  This can
             occur when using a dump created on an active file system.

     Incremental dump too low
             When doing incremental restore, a dump that was written before
             the previous incremental dump, or that has too low an incremental
             level has been loaded.


     Incremental dump too high
             When doing incremental restore, a dump that does not begin its
             coverage where the previous incremental dump left off, or that
             has too high an incremental level has been loaded.

     Tape read error while restoring <filename>
     Tape read error while skipping over inode <inumber>
     Tape read error while trying to resynchronize
             A tape (or other media) read error has occurred.  If a file name
             is specified, then its contents are probably partially wrong.  If
             an inode is being skipped or the tape is trying to resynchronize,
             then no extracted files have been corrupted, though files may not
             be found on the tape.

     resync restore, skipped <num> blocks
             After a dump read error, rreessttoorree may have to resynchronize it-
             self.  This message lists the number of blocks that were skipped
             over.

FFIILLEESS
     /dev/rmt?          the default tape drive
     /tmp/rstdir*       file containing directories on the tape.
     /tmp/rstmode*      owner, mode, and time stamps for directories.
     ./restoresymtable  information passed between incremental restores.

SSEEEE AALLSSOO
     dump(8),  newfs(8),  mount(8),  mkfs(8),  rmt(8)

BBUUGGSS
     RReessttoorree can get confused when doing incremental restores from dump that
     were made on active file systems.

     A level zero dump must be done after a full restore.  Because restore
     runs in user code, it has no control over inode allocation; thus a full
     restore must be done to get a new set of directories reflecting the new
     inode numbering, even though the contents of the files is unchanged.

HHIISSTTOORRYY
     The rreessttoorree command appeared in 4.2BSD.

4th Berkeley Distribution        June 5, 1993                                4