]> git.wh0rd.org - dump.git/blobdiff - dump/dump.8.in
Added bzip2 compression to dump.
[dump.git] / dump / dump.8.in
index 1ee3c48be94c67ec44c3892d346493a3cf0674df..129001ce549870db4fdccc73d7db7fec978c0f68 100644 (file)
@@ -30,7 +30,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"    $Id: dump.8.in,v 1.20 2001/02/21 16:31:47 stelian Exp $
+.\"    $Id: dump.8.in,v 1.32 2001/08/16 15:24:21 stelian Exp $
 .\"
 .Dd __DATE__
 .Dt DUMP 8
 .Nd ext2 filesystem backup
 .Sh SYNOPSIS
 .Nm dump
-.Op Fl 0123456789ackMnSuz
+.Op Fl 0123456789ackMnqSu
 .Op Fl B Ar records
 .Op Fl b Ar blocksize
 .Op Fl d Ar density
-.Op Fl e Ar inode number
+.Op Fl e Ar inode numbers
+.Op Fl E Ar file
 .Op Fl f Ar file
 .Op Fl F Ar script
 .Op Fl h Ar level
+.Op Fl j Ar compression level
 .Op Fl L Ar label
+.Op Fl Q Ar file
 .Op Fl s Ar feet
 .Op Fl T Ar date
-.Ar file-to-dump
+.Op Fl z Ar compression level
+.Ar files-to-dump
 .Nm dump
 .Op Fl W Li \&| Fl w
 .Pp
@@ -82,15 +86,17 @@ 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 file-to-dump
+.Ar files-to-dump
 is either a mountpoint of a filesystem
-or a directory to be backed up as a subset 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 and the only dump level that is supported is
-.Fl 0 .
+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 :
@@ -111,9 +117,10 @@ copy all files new or modified since the
 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 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.
+of tape size based on length and density. If compression is on this
+limits the size of the compressed output per volume.
 .It Fl a
 .Dq auto-size .
 Bypass all tape length calculations, and write
@@ -125,7 +132,7 @@ existing tape, or using a tape drive with hardware compression
 .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
@@ -136,12 +143,21 @@ The default blocksize is 10.
 Change the defaults for use with a cartridge tape drive, with a density
 of 8000 bpi, and a length of 1700 feet. Specifying a cartridge drive
 overrides the end-of-media detection.
-.It Fl e Ar inode
+.It Fl e Ar inodes
 Exclude 
-.Ar inode
-from the dump (you can use 
+.Ar inodes
+from the dump. The
+.Ar inodes
+parameter is a comma separated list of inode numbers (you can use
 .Ar stat 
 to find the inode number for a file or directory).
+.It Fl E Ar file
+Read list of inodes to be excluded from the dump from the text file
+.Ar file .
+The file 
+.Ar file
+should be an ordinary file containing inode numbers separated by
+newlines.
 .It Fl h Ar level
 Honor the user
 .Dq nodump
@@ -197,7 +213,7 @@ 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. 
+should continue but ask the user to change the tape. 
 Any other exit code will cause
 .Nm
 to abort.
@@ -205,6 +221,15 @@ For security reasons,
 .Nm
 reverts back to the real user ID and the real group ID before 
 running the script.
+.It Fl j Ar compression level
+Compress every block to be written on the tape using bzlib 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.4b24 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 bzlib will use. The default compression
+level is 2.
 .It Fl k
 Use Kerberos authentication to talk to remote tape servers.  (Only
 available if this option was enabled when
@@ -238,6 +263,31 @@ notify all operators in the group
 .Dq operator
 by means similar to a
 .Xr wall 1 .
+.It Fl q
+Make
+.Nm
+abort immediately whenever operator attention is required,
+without prompting in case of write errors, tape changes etc.
+.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.
+.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 feet
 Attempt to calculate the amount of tape needed at a particular density.
 If this amount is exceeded,
@@ -315,12 +365,15 @@ Is like
 but prints only recognized filesystems in
 .Pa /etc/fstab
 which need to be dumped.
-.It Fl z
+.It Fl z Ar compression level
 Compress every block to be written on the tape using zlib library. This
-option will work only if the tape drive is capable of writing variable 
+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.
+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
@@ -468,6 +521,8 @@ Each reel requires a new process, so parent processes for
 reels already written just hang around until the entire tape
 is written.
 .Pp
+The estimated number of tapes is not correct if compression is on.
+.Pp
 It would be nice if
 .Nm
 knew about the dump sequence,
@@ -486,7 +541,7 @@ a remote shell program instead.
 .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
@@ -496,7 +551,7 @@ Starting with 0.4b5, the new maintainer is Stelian Pop
 .Sh AVAILABILITY
 The
 .Nm dump/restore
-backup suit is available from 
+backup suite is available from 
 .br
 http://dump.sourceforge.net
 .Sh HISTORY