BSD 4_3_Net_2 release

[unix-history] / usr / src / sbin / restore / restore.8

diff --git a/usr/src/sbin/restore/restore.8 b/usr/src/sbin/restore/restore.8
index 3c1997b..a664eea 100644 (file)
--- a/usr/src/sbin/restore/restore.8
+++ b/usr/src/sbin/restore/restore.8
@@ -1,111 +1,136 @@
-.\" Copyright (c) 1985 The Regents of the University of California.
+.\" Copyright (c) 1985, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)restore.8   6.8 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH RESTORE 8 "June 24, 1990"
-.UC 4
-.SH NAME
-restore \- incremental file system restore
-.SH SYNOPSIS
-.B restore
-key [ name ... ]
-.SH DESCRIPTION
-.PP
-.I Restore
-reads tapes dumped with the
-.IR dump (8)
-command.
-Its actions are controlled by the
-.I key
-argument.
+.\"     @(#)restore.8  6.10 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
+.Dt RESTORE 8
+.Os BSD 4
+.Sh NAME
+.Nm restore
+.Nd "restore files or file systems from backups made with dump"
+.Sh SYNOPSIS
+.Nm restore
+.Ar key
+.Op Ar name Ar ...
+.Sh DESCRIPTION

 The
 The

-.I key
+.Nm restore
+command performs the inverse function of
+.Xr dump 8 .
+A full backup of a file system may be restored and
+subsequent incremental backups layered on top of it.
+Single files and
+directory subtrees may be restored from full or partial
+backups.
+.Nm Restore
+cannot work across a network, to do this, see the companion
+command
+.Xr rrestore .
+The actions
+of
+.Nm restore
+are controlled by the given
+.Cm key ,
+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
 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

-.B h
+.Cm h

 key is specified (see below),
 the appearance of a directory name refers to
 the files and (recursively) subdirectories of that directory.
 key is specified (see below),
 the appearance of a directory name refers to
 the files and (recursively) subdirectories of that directory.

-.PP
+.Pp

 The function portion of
 the key is specified by one of the following letters:
 The function portion of
 the key is specified by one of the following letters:

-.TP 5n
-.B  r
-The tape
-is read and loaded into the current directory.
-This should not be done lightly; the
-.B r
-key should only be used to restore
-a complete dump tape onto a clear file system
-or to restore an incremental dump tape after a full level zero restore.
-Thus
-.IP "" 5n
-       newfs /dev/rrp0g eagle
-.br
-       mount /dev/rp0g /mnt
-.br
-       cd /mnt
-.br
-       restore r
-.IP "" 5n
-is a typical sequence to restore a complete dump.
-Another
-.I restore
-can be done to get an incremental dump
-in on top of this.
+.Bl -tag -width Ds
+.It Cm r
+Restore (rebuild a file system).
+The target file system should be made pristine with
+.Xr newfs 8 ,
+mounted and the
+user
+.Xr cd Ns 'd
+into the pristine file system
+before starting the restoration of the initial level 0 backup. If the
+level 0 restores successfully, the
+.Cm r
+key may be used to restore
+any necessary incremental backups on top of the level 0.
+The
+.Cm r
+key precludes an interactive file extraction and can be
+detrimental to ones health if not used carefully (not to mention
+the disk). An example:
+.Bd -literal -offset indent
+newfs /dev/rrp0g eagle
+mount /dev/rp0g /mnt
+cd /mnt
+
+restore rf /dev/rst8
+.Ed
+.Pp

 Note that 
 Note that 

-.I restore
+.Nm restore

 leaves a file 
 leaves a file 

-.I restoresymtable
+.Pa restoresymtable

 in the root directory to pass information between incremental
 restore passes.
 in the root directory to pass information between incremental
 restore passes.

-This file should be removed when the last incremental tape has been
+This file should be removed when the last incremental has been

 restored.
 restored.

-.br
-A
-.IR dump (8)
-followed by a
-.IR newfs (8)
-and a
-.I restore
-is used to change the size of a file system.
-.TP 5n
-.B  R
-.I Restore
+.Pp
+.Nm Restore ,
+in conjunction with
+.Xr newfs 8
+and
+.Xr dump 8 ,
+may be used to modify file system parameters
+such as size or block size.
+.It Cm R
+.Nm Restore

 requests a particular tape of a multi volume set on which to restart
 a full restore
 (see the
 requests a particular tape of a multi volume set on which to restart
 a full restore
 (see the

-.B r
+.Cm r

 key above).
 key above).

-This allows
-.I restore
-to be interrupted and then restarted.
-.TP 5n
-.B  x
-The named files are extracted from the tape.
-If the named file matches a directory whose contents 
-had been written onto the tape,
+This is useful if the restore has been interrupted.
+.It Cm x
+The named files are read from the given media.
+If a named file matches a directory whose contents 
+are on the backup

 and the
 and the

-.B h
+.Cm h

 key is not specified,
 the directory is recursively extracted.
 The owner, modification time,
 key is not specified,
 the directory is recursively extracted.
 The owner, modification time,


@@ -113,281 +138,262 @@ and mode are restored (if possible).
 If no file argument is given,
 then the root directory is extracted,
 which results in the entire content of the
 If no file argument is given,
 then the root directory is extracted,
 which results in the entire content of the

-tape being extracted,
+backup being extracted,

 unless the
 unless the

-.B h
+.Cm h

 key has been specified.
 key has been specified.

-.TP 5n
-.B  t
+.It Cm t

 The names of the specified files are listed if they occur
 The names of the specified files are listed if they occur

-on the tape.
+on the backup.

 If no file argument is given,
 then the root directory is listed,
 which results in the entire content of the
 If no file argument is given,
 then the root directory is listed,
 which results in the entire content of the

-tape being listed,
+backup being listed,

 unless the
 unless the

-.B h
+.Cm h

 key has been specified.
 Note that the
 key has been specified.
 Note that the

-.B t
+.Cm t

 key replaces the function of the old
 key replaces the function of the old

-.I dumpdir
+.Xr dumpdir 8

 program.
 program.

-.TP 5n
-.B  i
-This mode allows interactive restoration of files from a dump tape.
-After reading in the directory information from the tape,
-.I restore
+.It Cm i
+This mode allows interactive restoration of files from a dump.
+After reading in the directory information from the dump,
+.Nm restore

 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 require an argument,
 the default is the current directory.
 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 require an argument,
 the default is the current directory.

-.IP "" 10n
-.ti -5n
-.br
-.B ls
-[arg] \-
-List the current or specified directory.
-Entries that are directories are appended with a ``/''.
-Entries 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.
-.ti -5n
-.sp
-.B cd
-arg \-
-Change the current working directory to the specified argument.
-.ti -5n
-.sp
-.B pwd
-\-
-Print the full pathname of the current working directory.
-.ti -5n
-.sp
-.B add
-[arg] \-
+.Bl -tag -width Fl
+.It Ic add Op Ar arg

 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
 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

-.B h
+.Cm h

 key is specified on the command line).
 Files that are on the extraction list are prepended with a ``*''
 when they are listed by 
 key is specified on the command line).
 Files that are on the extraction list are prepended with a ``*''
 when they are listed by 

-.BR ls .
-.ti -5n
-.sp
-.B delete
-[arg] \-
+.Ic ls .
+.It Ic \&cd Ar arg
+Change the current working directory to the specified argument.
+.It Ic delete Op Ar arg

 The current directory or specified argument is deleted from the list of
 files to be extracted.
 If a directory is specified, then it and all its descendents are
 deleted from the extraction list
 (unless the
 The current directory or specified argument is deleted from the list of
 files to be extracted.
 If a directory is specified, then it and all its descendents are
 deleted from the extraction list
 (unless the

-.B h
+.Cm h

 key is specified on the command line).
 The most expedient way to extract most of the files from a directory 
 is to add the directory to the extraction list and then delete
 those files that are not needed.
 key is specified on the command line).
 The most expedient way to extract most of the files from a directory 
 is to add the directory to the extraction list and then delete
 those files that are not needed.

-.ti -5n
-.sp
-.B extract
-\-
+.It Ic extract

 All the files that are on the extraction list are extracted
 All the files that are on the extraction list are extracted

-from the dump tape.
-.I Restore
+from the dump.
+.Nm Restore

 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.
 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.

-.ti -5n
-.sp
-.B setmodes
-\-
+.It Ic help
+List a summary of the available commands.
+.It Ic \&ls Op Ar arg
+List the current or specified directory.
+Entries that are directories are appended with a ``/''.
+Entries 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.
+.It Ic pwd
+Print the full pathname of the current working directory.
+.It Ic quit
+Restore immediately exits,
+even if the extraction list is not empty.
+.It Ic setmodes

 All the directories that have been added to the extraction list
 have their owner, modes, and times set;
 All the directories that have been added to the extraction list
 have their owner, modes, and times set;

-nothing is extracted from the tape.
+nothing is extracted from the dump.

 This is useful for cleaning up after a restore has been prematurely aborted.
 This is useful for cleaning up after a restore has been prematurely aborted.

-.ti -5n
-.sp
-.B verbose
-\-
+.It Ic verbose

 The sense of the 
 The sense of the 

-.B v
+.Cm v

 key is toggled.
 When set, the verbose key causes the 
 key is toggled.
 When set, the verbose key causes the 

-.B ls
+.Ic ls

 command to list the inode numbers of all entries.
 It also causes
 command to list the inode numbers of all entries.
 It also causes

-.I restore
+.Nm restore

 to print out information about each file as it is extracted.
 to print out information about each file as it is extracted.

-.ti -5n
-.sp
-.B help
-\-
-List a summary of the available commands.
-.ti -5n
-.sp
-.B quit
-\-
-Restore immediately exits,
-even if the extraction list is not empty.
-.sp
-.PP
+.El
+.El
+.Pp

 The following characters may be used in addition to the letter
 that selects the function desired.
 The following characters may be used in addition to the letter
 that selects the function desired.

-.TP 5n
-.B b
+.Bl -tag -width Ds
+.It Cm b

 The next argument to 
 The next argument to 

-.I restore
-is used as the block size of the tape (in kilobytes).
-If the \fB-b\fP option is not specified,
-.I restore
-tries to determine the tape block size dynamically.
-.TP 5n
-.B f
+.Nm restore
+is used as the block size of the media (in kilobytes).
+If the
+.Fl b
+option is not specified,
+.Nm restore
+tries to determine the media block size dynamically.
+.It Cm f

 The next argument to 
 The next argument to 

-.I restore
+.Nm restore

 is used as the name of the archive instead
 is used as the name of the archive instead

-of /dev/rmt?. 
-If the name of the file is ``\-'',
-.I restore 
+of
+.Pa /dev/rmt? . 
+If the name of the file is
+.Ql Fl ,
+.Nm restore

 reads from standard input.
 Thus,
 reads from standard input.
 Thus,

-.IR dump (8)
+.Xr dump 8

 and
 and

-.I restore
+.Nm restore

 can be used in a pipeline to dump and restore a file system
 with the command
 can be used in a pipeline to dump and restore a file system
 with the command

-.IP "" 5n
-       dump 0f - /usr | (cd /mnt; restore xf -)
-.TP 5n
-.B  v
-Normally
-.I restore
-does its work silently.
-The
-.B v
-(verbose)
-key causes it to type the name of each file it treats
-preceded by its file type.
-.TP 5n
-.B y
-.I Restore
-will not ask whether it should abort the restore if gets a tape error.
-It will always try to skip over the bad tape block(s) and continue as
-best it can.
-.TP 5n
-.B m
-.I Restore
+.Bd -literal -offset indent
+dump 0f - /usr | (cd /mnt; restore xf -)
+.Ed
+.Pp
+.It Cm h
+.Nm Restore
+extracts the actual directory, 
+rather than the files that it references.
+This prevents hierarchical restoration of complete subtrees
+from the dump.
+.It Cm m
+.Nm Restore

 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.
 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.

-.TP 5n
-.B h
-.I Restore
-extracts the actual directory, 
-rather than the files that it references.
-This prevents hierarchical restoration of complete subtrees
-from the tape.
-.TP 5n
-.B s
+.It Cm s

 The next argument to
 The next argument to

-.I restore
+.Nm restore

 is a number which
 selects the file on a multi-file dump tape.  File numbering
 starts at 1.
 is a number which
 selects the file on a multi-file dump tape.  File numbering
 starts at 1.

-.SH DIAGNOSTICS
+.It Cm v
+Normally
+.Nm restore
+does its work silently.
+The
+.Cm v
+(verbose)
+key causes it to type the name of each file it treats
+preceded by its file type.
+.It Cm y
+.Nm Restore
+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.
+.El
+.Sh DIAGNOSTICS

 Complaints about bad key characters.
 Complaints about bad key characters.

-.PP
+.Pp

 Complaints if it gets a read error.
 If 
 Complaints if it gets a read error.
 If 

-.B y
-has been specified, or the user responds ``y'',
-.I restore
+.Cm y
+has been specified, or the user responds
+.Ql y ,
+.Nm restore

 will attempt to continue the restore.
 will attempt to continue the restore.

-.PP
-If the dump extends over more than one tape,
-.I restore
-will ask the user to change tapes.
+.Pp
+If a backup was made using more than one tape volume,
+.Nm restore
+will notify the user when it is time to mount the next volume.

 If the
 If the

-.B x
+.Cm x

 or
 or

-.B i
+.Cm i

 key has been specified,
 key has been specified,

-.I restore
+.Nm restore

 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.
 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.

-.PP
+.Pp

 There are numerous consistency checks that can be listed by
 There are numerous consistency checks that can be listed by

-.IR restore .
+.Nm restore .

 Most checks are self-explanatory or can ``never happen''.
 Common errors are given below.
 Most checks are self-explanatory or can ``never happen''.
 Common errors are given below.

-.IP "Converting to new file system format." 5n
-.br
+.Pp
+.Bl -tag -width Ds -compact
+.It 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.
 A dump tape created from the old file system has been loaded.
 It is automatically converted to the new file system format.

-.IP "<filename>: not found on tape" 5n
-.br
+.Pp
+.It <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.
 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.

-.IP "expected next file <inumber>, got <inumber>" 5n
-.br
+.Pp
+.It expected next file <inumber>, got <inumber>

 A file that was not listed in the directory showed up.
 A file that was not listed in the directory showed up.

-This can occur when using a dump tape created on an active file system.
-.IP "Incremental tape too low" 5n
-.br
+This can occur when using a dump created on an active file system.
+.Pp
+.It Incremental dump too low

 When doing incremental restore,
 When doing incremental restore,

-a tape that was written before the previous incremental tape,
+a dump that was written before the previous incremental dump,

 or that has too low an incremental level has been loaded.
 or that has too low an incremental level has been loaded.

-.IP "Incremental tape too high" 5n
-.br
+.Pp
+.It Incremental dump too high

 When doing incremental restore,
 When doing incremental restore,

-a tape that does not begin its coverage where the previous incremental 
-tape left off,
+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.
 or that has too high an incremental level has been loaded.

-.IP "Tape read error while restoring <filename>" 5n
-.ti -5n
-.br
-Tape read error while skipping over inode <inumber>
-.ti -5n
-.br
-Tape read error while trying to resynchronize
-.br
-A tape read error has occurred.
+.Pp
+.It Tape read error while restoring <filename>
+.It Tape read error while skipping over inode <inumber>
+.It 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.
 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.

-.IP "resync restore, skipped <num> blocks" 5n
-.br
-After a tape read error, 
-.I restore
+.Pp
+.It resync restore, skipped <num> blocks
+After a dump read error, 
+.Nm restore

 may have to resynchronize itself.
 This message lists the number of blocks that were skipped over.
 may have to resynchronize itself.
 This message lists the number of blocks that were skipped over.

-.SH FILES
-/dev/rmt?      the default tape drive
-.br
-/tmp/rstdir*   file containing directories on the tape.
-.br
-/tmp/rstmode*  owner, mode, and time stamps for directories.
-.br
-\&./restoresymtable    information passed between incremental restores.
-.SH SEE ALSO
-rrestore(8C) dump(8), newfs(8), mount(8), mkfs(8)
-.SH BUGS
-.I Restore
+.El
+.Sh FILES
+.Bl -tag -width "./restoresymtable" -compact
+.It Pa /dev/rmt?
+the default tape drive
+.It Pa /tmp/rstdir*
+file containing directories on the tape.
+.It Pa /tmp/rstmode*
+owner, mode, and time stamps for directories.
+.It Pa \&./restoresymtable
+information passed between incremental restores.
+.El
+.Sh SEE ALSO
+.Xr rrestore 8
+.Xr dump 8 ,
+.Xr newfs 8 ,
+.Xr mount 8 ,
+.Xr mkfs 8
+.Sh BUGS
+.Nm Restore

 can get confused when doing incremental restores from
 can get confused when doing incremental restores from

-dump tapes that were made on active file systems.
-.PP
+dump that were made on active file systems.
+.Pp

 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.
 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.

+.Sh HISTORY
+The
+.Nm restore
+command appeared in
+.Bx 4.2 .