Made dump -w|-W report all recognized filesystems...

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

diff --git a/dump/dump.8.in b/dump/dump.8.in
index 262685868d0891e2808cdd0a89c350cf81bb5e76..f81cffb908d85f55a108b8ec6524e50c6dafa537 100644 (file)
--- a/dump/dump.8.in
+++ b/dump/dump.8.in
@@ -30,37 +30,28 @@
 .\" 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: dump.8.in,v 1.2 1999/10/11 13:31:10 stelian Exp $
+.\"    $Id: dump.8.in,v 1.17 2000/11/10 11:48:31 stelian Exp $

 .\"
 .Dd __DATE__
 .Dt DUMP 8
 .\"
 .Dd __DATE__
 .Dt DUMP 8

-.Os "__VERSION__"
+.Os "dump __VERSION__"

 .Sh NAME
 .Nm dump
 .Nd ext2 filesystem backup
 .Sh SYNOPSIS
 .Nm dump
 .Sh NAME
 .Nm dump
 .Nd ext2 filesystem backup
 .Sh SYNOPSIS
 .Nm dump

-.Op Fl 0123456789acknu
+.Op Fl 0123456789ackMnSu

 .Op Fl B Ar records
 .Op Fl b Ar blocksize
 .Op Fl d Ar density
 .Op Fl B Ar records
 .Op Fl b Ar blocksize
 .Op Fl d Ar density

+.Op Fl e Ar inode number

 .Op Fl f Ar file
 .Op Fl f Ar file

+.Op Fl F Ar script

 .Op Fl h Ar level
 .Op Fl L Ar label
 .Op Fl s Ar feet
 .Op Fl T Ar date
 .Op Fl h Ar level
 .Op Fl L Ar label
 .Op Fl s Ar feet
 .Op Fl T Ar date

-.Ar filesystem
-.Nm dump
-.Op Fl 0123456789acknu
-.Op Fl B Ar records
-.Op Fl b Ar blocksize
-.Op Fl d Ar density
-.Op Fl f Ar file
-.Op Fl h Ar level
-.Op Fl L Ar label
-.Op Fl s Ar feet
-.Op Fl T Ar date
-.Ar directory
+.Ar file-to-dump

 .Nm dump
 .Op Fl W Li \&| Fl w
 .Pp
 .Nm dump
 .Op Fl W Li \&| Fl w
 .Pp


@@ -95,6 +86,16 @@ block count options below.
 By default, the same output file name is used for each volume
 after prompting the operator to change media.
 .Pp
 By default, the same output file name is used for each volume
 after prompting the operator to change media.
 .Pp

+.Ar file-to-dump
+is either a mountpoint of a filesystem
+or a directory to be backed up as a subset of a filesystem.
+In the former case, either the path to a mounted filesystem
+or the device of an unmounted filesystem can be used.
+In the latter case, certain restrictions are placed on the backup:
+.Fl u
+is not allowed and the only dump level that is supported is
+.Fl 0 .
+.Pp

 The following options are supported by
 .Nm Ns :
 .Bl -tag -width Ds
 The following options are supported by
 .Nm Ns :
 .Bl -tag -width Ds


@@ -111,7 +112,7 @@ tells
 .Nm dump
 to
 copy all files new or modified since the
 .Nm dump
 to
 copy all files new or modified since the

-last dump of the same or lower level.
+last dump of a lower level.

 The default level is 9.
 .It Fl B Ar records
 The number of 1 KB blocks per volume.
 The default level is 9.
 .It Fl B Ar records
 The number of 1 KB blocks per volume.


@@ -134,9 +135,16 @@ without having problems later with
 Therefore
 .Nm dump
 will constrain writes to MAXBSIZE.
 Therefore
 .Nm dump
 will constrain writes to MAXBSIZE.

+The default blocksize is 10.

 .It Fl c
 Change the defaults for use with a cartridge tape drive, with a density
 of 8000 bpi, and a length of 1700 feet.
 .It Fl c
 Change the defaults for use with a cartridge tape drive, with a density
 of 8000 bpi, and a length of 1700 feet.

+.It Fl e Ar inode
+Exclude 
+.Ar inode
+from the dump (you can use 
+.Ar stat 
+to find the inode number for a file or directory).

 .It Fl h Ar level
 Honor the user
 .Dq nodump
 .It Fl h Ar level
 Honor the user
 .Dq nodump


@@ -184,6 +192,21 @@ program is
 .Pa /etc/rmt ;
 this can be overridden by the environment variable
 .Ev RMT .
 .Pa /etc/rmt ;
 this can be overridden by the environment variable
 .Ev RMT .

+.It Fl F Ar script
+Run script at the end 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
+dump 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 to talk to remote tape servers.  (Only
 available if this option was enabled when
 .It Fl k
 Use Kerberos authentication to talk to remote tape servers.  (Only
 available if this option was enabled when


@@ -201,6 +224,14 @@ Note that this label is limited
 to be at most LBLSIZE (currently 16) characters, which must include
 the terminating
 .Ql \e0 .
 to be at most LBLSIZE (currently 16) characters, which must include
 the terminating
 .Ql \e0 .

+.It Fl M
+Enable the multi-volume feature. The name specified with 
+.Fl f 
+is treated as a prefix and 
+.Nm
+writes in sequence to <prefix>001, <prefix>002 etc. This can be
+useful when dumping to files on an ext2 partition, in order to bypass
+the 2GB file size limitation.

 .It Fl n
 Whenever
 .Nm
 .It Fl n
 Whenever
 .Nm


@@ -218,6 +249,13 @@ prompts for a new tape.
 It is recommended to be a bit conservative on this option.
 The default tape length is 2300 feet.
 .ne 1i
 It is recommended to be a bit conservative on this option.
 The default tape length is 2300 feet.
 .ne 1i

+.It Fl S
+Size estimate. Determine the amount of space
+that is needed to perform the dump without
+actually doing it, and display the estimated
+number of bytes it will take. This is useful
+with incremental dumps to determine how many
+volumes of media will be needed.

 .It Fl T Ar date
 Use the specified date as the starting time for the dump
 instead of the time determined from looking in
 .It Fl T Ar date
 Use the specified date as the starting time for the dump
 instead of the time determined from looking in


@@ -262,10 +300,12 @@ The
 .Fl W
 option causes
 .Nm
 .Fl W
 option causes
 .Nm

-to print out, for each file system in
+to print out, for all file systems in

 .Pa __DUMPDATES__ ,
 .Pa __DUMPDATES__ ,

+and regognized file systems in
+.Pa /etc/fstab .

 the most recent dump date and level,
 the most recent dump date and level,

-and highlights those file systems that should be dumped.
+and highlights those that should be dumped.

 If the
 .Fl W
 option is set, all other options are ignored, and
 If the
 .Fl W
 option is set, all other options are ignored, and


@@ -274,7 +314,9 @@ exits immediately.
 .It Fl w
 Is like
 .Fl W ,
 .It Fl w
 Is like
 .Fl W ,

-but prints only those filesystems which need to be dumped.
+but prints only recognized filesystems in
+.Pa /etc/fstab
+which need to be dumped.

 .El
 .Pp
 .Nm Dump
 .El
 .Pp
 .Nm Dump


@@ -380,6 +422,13 @@ The environment variable
 will be used to determine the pathname of the remote
 .Xr rmt 8
 program.
 will be used to determine the pathname of the remote
 .Xr rmt 8
 program.

+.It Ev RSH
+.Nm Dump
+uses the contents of this variable to determine the name of the
+remote shell command to use when doing remote backups (rsh, ssh etc.). 
+If this variable is not set, 
+.Xr rcmd 3
+will be used, but only root will be able to do remote backups.

 .Sh FILES
 .Bl -tag -width __DUMPDATES__ -compact
 .It Pa /dev/st0
 .Sh FILES
 .Bl -tag -width __DUMPDATES__ -compact
 .It Pa /dev/st0


@@ -415,17 +464,6 @@ Each reel requires a new process, so parent processes for
 reels already written just hang around until the entire tape
 is written.
 .Pp
 reels already written just hang around until the entire tape
 is written.
 .Pp

-.Nm Dump
-with the
-.Fl W
-or
-.Fl w
-option does not report filesystems that have never been recorded
-in
-.Pa __DUMPDATES__ ,
-even if listed in
-.Pa /etc/fstab .
-.Pp

 It would be nice if
 .Nm
 knew about the dump sequence,
 It would be nice if
 .Nm
 knew about the dump sequence,


@@ -437,10 +475,10 @@ for the operator running
 .Pp
 .Nm Dump
 cannot do remote backups without being run as root, due to its
 .Pp
 .Nm Dump
 cannot do remote backups without being run as root, due to its

-security history.  This will be fixed in a later version of
-.Bx Free .
+security history.

 Presently, it works if you set it setuid (like it used to be), but this
 Presently, it works if you set it setuid (like it used to be), but this

-might constitute a security risk.
+might constitute a security risk. Note that you can set RSH to use
+a remote shell program instead.

 .Sh AUTHOR
 The 
 .Nm dump/restore
 .Sh AUTHOR
 The 
 .Nm dump/restore


@@ -454,11 +492,9 @@ Starting with 0.4b5, the new maintainer is Stelian Pop
 .Sh AVAILABILITY
 The
 .Nm dump/restore
 .Sh AVAILABILITY
 The
 .Nm dump/restore

-backup suit is available for anonymous ftp from tsx-11.mit.edu
-in /pub/linux/ALPHA/ext2fs (development versions) or 
-/pub/linux/packages/ext2fs (stable versions).
-.Pp
-An alternate downloading location is http://perso.cybercable.fr/pop/dump.
+backup suit is available from 
+.br
+http://dump.sourceforge.net

 .Sh HISTORY
 A
 .Nm
 .Sh HISTORY
 A
 .Nm