.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: dump.8.in,v 1.11 2000/02/04 20:22:21 stelian Exp $
+.\" $Id: dump.8.in,v 1.26 2001/04/10 13:42:22 stelian Exp $
.\"
.Dd __DATE__
.Dt DUMP 8
.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 script
.Op Fl h Ar level
.Op Fl L Ar label
+.Op Fl Q Ar file
.Op Fl s Ar feet
.Op Fl T Ar date
-.Ar filesystem
-.Nm dump
-.Op Fl 0123456789ackMnSu
-.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
+.Op Fl z Ar compression level
+.Ar files-to-dump
.Nm dump
.Op Fl W Li \&| Fl w
.Pp
A dump that is larger than the output medium is broken into
multiple volumes.
On most media the size is determined by writing until an
-end-of-media indication is returned. This can be enforced
-by using the
-.Fl a
-option.
+end-of-media indication is returned.
.Pp
On media that cannot reliably return an end-of-media indication
-(such as some cartridge tape drives),
-each volume is of a fixed size;
-the actual size is determined by the tape size, density and/or
-block count options below.
+(such as some cartridge tape drives), each volume is of a fixed size;
+the actual size is determined by specifying cartridge media, or via the
+tape size, density and/or block count options below.
By default, the same output file name is used for each volume
after prompting the operator to change media.
.Pp
+.Ar files-to-dump
+is either a mountpoint of a filesystem
+or a list of files and directories 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, the only dump level that is supported is
+.Fl 0
+and all the files and directories must reside on the same filesystem.
+.Pp
The following options are supported by
.Nm Ns :
.Bl -tag -width Ds
last dump of a lower level.
The default level is 9.
.It Fl B Ar records
-The number of 1 KB blocks per volume.
-This option overrides the calculation of tape size
-based on length and density.
+The number of 1 kB blocks per volume.
+This option overrides the end-of-media detection, and calculation
+of tape size based on length and density.
.It Fl a
.Dq auto-size .
-Bypass all tape length considerations, and enforce writing
-until an end-of-media indication is returned. This fits best
-for most modern tape drives. Use of this option is particularly
-recommended when appending to an existing tape, or using a tape
-drive with hardware compression (where you can never be sure about
-the compression ratio).
+Bypass all tape length calculations, and write
+until an end-of-media indication is returned. This works best
+for most modern tape drives, and is the default.
+Use of this option is particularly recommended when appending to an
+existing tape, or using a tape drive with hardware compression
+(where you can never be sure about the compression ratio).
.It Fl b Ar blocksize
The number of kilobytes per dump record.
Since the IO system slices all requests into chunks of MAXBSIZE
-(typically 64KB), it is not possible to use a larger blocksize
+(typically 64kB), it is not possible to use a larger blocksize
without having problems later with
.Xr restore 8 .
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.
+of 8000 bpi, and a length of 1700 feet. Specifying a cartridge drive
+overrides the end-of-media detection.
.It Fl e Ar inode
Exclude
.Ar inode
.It Fl d Ar density
Set tape density to
.Ar density .
-The default is 1600BPI.
+The default is 1600BPI. Specifying a tape density overrides the
+end-of-media detection.
.It Fl f Ar file
Write the backup to
.Ar file ;
.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
.Dq operator
by means similar to a
.Xr wall 1 .
+.It Fl Q Ar file
+Enable the Quick File Access support. Tape positions for each
+inode are stored into the file
+.Ar file
+which is used by restore (if called with parameter Q and the filename)
+to directly position the tape at the file restore is currently working
+on. This saves hours when restoring single files from large backups,
+saves the tapes and the drive's head.
.It Fl s Ar feet
-Attempt to calculate the amount of tape needed
-at a particular density.
+Attempt to calculate the amount of tape needed at a particular density.
If this amount is exceeded,
.Nm
prompts for a new tape.
It is recommended to be a bit conservative on this option.
-The default tape length is 2300 feet.
+The default tape length is 2300 feet. Specifying the tape size
+overrides end-of-media detection.
.ne 1i
.It Fl S
Size estimate. Determine the amount of space
.Fl W
option causes
.Nm
-to print out, for each file system in
+to print out, for all file systems in
.Pa __DUMPDATES__ ,
+and regognized file systems in
+.Pa /etc/fstab .
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
.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.
+.It Fl z Ar compression level
+Compress every block to be written on the tape using zlib library. This
+option will work only when dumping to a file or pipe or, when dumping
+to a tape drive, if the tape drive is capable of writing variable
+length blocks. You will need at least the 0.4b22 version of restore in
+order to extract compressed tapes. Tapes written using compression will
+not be compatible with the BSD tape format. The (optional) parameter
+specifies the compression level zlib will use. The default compression
+level is 2.
.El
.Pp
.Nm Dump
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,
.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