Fixed a overflow problem in dump (LFS)

[dump.git] / restore / restore.8.in

diff --git a/restore/restore.8.in b/restore/restore.8.in
index 89fbf401649b46cd762c743ff30a746c536bece7..96d91a8c164c969f94e42a03c63c557464f41c30 100644 (file)
--- a/restore/restore.8.in
+++ b/restore/restore.8.in
@@ -29,7 +29,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"

-.\"    $Id: restore.8.in,v 1.9 2000/03/09 13:12:31 stelian Exp $
+.\"    $Id: restore.8.in,v 1.16 2001/07/18 13:12:33 stelian Exp $

 .\"
 .Dd __DATE__
 .Dt RESTORE 8
 .\"
 .Dd __DATE__
 .Dt RESTORE 8


@@ -44,6 +44,7 @@
 .Op Fl b Ar blocksize
 .Op Fl D Ar filesystem
 .Op Fl f Ar file
 .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
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore


@@ -51,6 +52,8 @@
 .Op Fl chkmMNuvy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
 .Op Fl chkmMNuvy
 .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
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore


@@ -58,6 +61,7 @@
 .Op Fl ckMNuvy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
 .Op Fl ckMNuvy
 .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
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore


@@ -65,6 +69,7 @@
 .Op Fl ckMNuvy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
 .Op Fl ckMNuvy
 .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
 .Op Fl s Ar fileno
 .Op Fl T Ar directory
 .Nm restore


@@ -72,6 +77,8 @@
 .Op Fl chkMNuvy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
 .Op Fl chkMNuvy
 .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 Fl s Ar fileno
 .Op Fl T Ar directory
 .Op Fl X Ar filelist


@@ -81,6 +88,8 @@
 .Op Fl chkmMNuvy
 .Op Fl b Ar blocksize
 .Op Fl f Ar file
 .Op Fl chkmMNuvy
 .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 Fl s Ar fileno
 .Op Fl T Ar directory
 .Op Fl X Ar filelist


@@ -333,6 +342,21 @@ or
 reads from the named file on the remote host using
 .Xr rmt 8 .
 .Pp
 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
 .It Fl k
 Use Kerberos authentication when contacting the remote tape server.
 (Only available if this options was enabled when


@@ -364,6 +388,23 @@ The
 flag causes
 .Nm
 to only print file names. Files are not extracted.
 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
 .It Fl s Ar fileno
 Read from the specified
 .Ar fileno


@@ -481,6 +522,14 @@ After a dump read error,
 may have to resynchronize itself.
 This message lists the number of blocks that were skipped over.
 .El
 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 :
 .Sh ENVIRONMENT
 If the following environment variable exists it will be utilized by
 .Nm restore :


@@ -578,17 +627,17 @@ from the restore code - run setuid at your own risk.)
 .Sh AUTHOR
 The
 .Nm dump/restore
 .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
 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
 .Sh AVAILABILITY
 The
 .Nm dump/restore

-backup suit is available from 
+backup suite is available from 

 .br
 http://dump.sourceforge.net
 .Sh HISTORY
 .br
 http://dump.sourceforge.net
 .Sh HISTORY