]> git.wh0rd.org - dump.git/blobdiff - restore/restore.8.in
Added Helmut Jarausch patch for restoring from multiple CD + examples.
[dump.git] / restore / restore.8.in
index f853fefca748347581282c78f28aaa078017057a..b13346acefeb872713c0b441de642023b89328d2 100644 (file)
@@ -29,7 +29,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"    $Id: restore.8.in,v 1.7 2000/01/21 10:23:30 stelian Exp $
+.\"    $Id: restore.8.in,v 1.17 2001/09/12 10:21:49 stelian Exp $
 .\"
 .Dd __DATE__
 .Dt RESTORE 8
 .Sh SYNOPSIS
 .Nm restore
 .Fl C
-.Op Fl ckMvy
+.Op Fl ckMvVy
 .Op Fl b Ar blocksize
 .Op Fl D Ar filesystem
 .Op Fl f Ar file
+.Op Fl F Ar script
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore
 .Fl i
-.Op Fl chkmMNuvy
+.Op Fl chkmMNuvVy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
+.Op Fl F Ar script
+.Op Fl Q Ar file
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore
 .Fl R
-.Op Fl ckMNuvy
+.Op Fl ckMNuvVy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
+.Op Fl F Ar script
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore
 .Fl r
-.Op Fl ckMNuvy
+.Op Fl ckMNuvVy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
+.Op Fl F Ar script
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore
 .Fl t
-.Op Fl chkMNuvy
+.Op Fl chkMNuvVy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
+.Op Fl F Ar script
+.Op Fl Q Ar file
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
+.Op Fl X Ar filelist
 .Op file ...
 .Nm restore
 .Fl x
-.Op Fl chkmMNuvy
+.Op Fl chkmMNuvVy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
+.Op Fl F Ar script
+.Op Fl Q Ar file
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
+.Op Fl X Ar filelist
 .Op file ...
 .Pp
 .in
@@ -258,6 +269,9 @@ Note that the
 flag replaces the function of the old
 .Xr dumpdir 8
 program.
+See also the
+.Fl X
+option below.
 .ne 1i
 .It Fl x
 The named files are read from the given media.
@@ -276,6 +290,9 @@ backup being extracted,
 unless the
 .Fl h
 flag has been specified.
+See also the
+.Fl X
+option below.
 .El
 .Pp
 The following additional options may be specified:
@@ -325,6 +342,21 @@ or
 reads from the named file on the remote host using
 .Xr rmt 8 .
 .Pp
+.It Fl F Ar script
+Run script at the beginning of each tape. The device name and the
+current volume number are passed on the command line.
+The script must return 0 if 
+.Nm
+should continue without asking the user to change the tape, 1 if 
+.Nm
+should continue but ask the user to change the tape. 
+Any other exit code will cause
+.Nm
+to abort.
+For security reasons,
+.Nm
+reverts back to the real user ID and the real group ID before 
+running the script.
 .It Fl k
 Use Kerberos authentication when contacting the remote tape server.
 (Only available if this options was enabled when
@@ -356,6 +388,23 @@ The
 flag causes
 .Nm
 to only print file names. Files are not extracted.
+.It Fl Q Ar file
+Use the file
+.Ar file
+in order to read tape position as stored using the dump Quick File
+Access mode.
+.Pp
+It is recommended to set up the st driver to return logical tape 
+positions rather than physical before calling dump/restore with 
+parameter Q.  Since not all tape devices support physical tape 
+positions those tape devices return an error during dump/restore when
+the st driver is set to the default physical setting.
+Please see the st man page, option MTSETDRVBUFFER, or the mt man
+page, on how to set the driver to return logical tape positions.
+.Pp
+Before calling restore with parameter Q, always make sure the st
+driver is set to return the same type of tape position used during the 
+call to dump. Otherwise restore may be confused.
 .It Fl s Ar fileno
 Read from the specified
 .Ar fileno
@@ -384,6 +433,23 @@ The
 (verbose)
 flag causes it to type the name of each file it treats
 preceded by its file type.
+.It Fl V
+Enables reading multi-volume non-tape mediums like CDROMs.
+.It Fl X Ar filelist
+Read list of files to be listed or extracted from the text file
+.Ar filelist
+in addition to those specified on the command line. This can be used in 
+conjunction with the
+.Fl t
+or
+.Fl x
+commands. The file
+.Ar filelist
+should contain file names separated by newlines.
+.Ar filelist
+may be an ordinary file or
+.Ql Fl
+(the standard input).
 .It Fl y
 Do not ask the user whether to abort the restore in the event of an error.
 Always try to skip over the bad block(s) and continue.
@@ -458,6 +524,14 @@ After a dump read error,
 may have to resynchronize itself.
 This message lists the number of blocks that were skipped over.
 .El
+.Pp
+.Nm Restore
+exits with zero status on success.
+Tape errors are indicated with an exit code of 1.
+.Pp
+When doing a comparison of files from a dump, an exit code
+of 2 indicates that some files were modified or deleted since
+the dump was made.
 .Sh ENVIRONMENT
 If the following environment variable exists it will be utilized by
 .Nm restore :
@@ -555,17 +629,17 @@ from the restore code - run setuid at your own risk.)
 .Sh AUTHOR
 The
 .Nm dump/restore
-backup suit was ported to Linux's Second Extended File System
+backup suite was ported to Linux's Second Extended File System
 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
 of dump (up and including 0.4b4, released in january 1997).
 .Pp
 Starting with 0.4b5, the new maintainer is Stelian Pop
 .br
-<pop@cybercable.fr>.
+<pop@noos.fr>.
 .Sh AVAILABILITY
 The
 .Nm dump/restore
-backup suit is available from 
+backup suite is available from 
 .br
 http://dump.sourceforge.net
 .Sh HISTORY