.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: dump.8.in,v 1.33 2001/11/10 23:50:59 stelian Exp $
+.\" $Id: dump.8.in,v 1.43 2002/07/23 12:20:35 stelian Exp $
.\"
.Dd __DATE__
.Dt DUMP 8
.Nd ext2 filesystem backup
.Sh SYNOPSIS
.Nm dump
-.Op Fl 0123456789ackMnqSu
+.Op Fl 0123456789ackMnqSuv
+.Op Fl A Ar file
.Op Fl B Ar records
.Op Fl b Ar blocksize
.Op Fl d Ar density
.Op Fl f Ar file
.Op Fl F Ar script
.Op Fl h Ar level
+.Op Fl I Ar nr errors
.Op Fl j Ar compression level
.Op Fl L Ar label
.Op Fl Q Ar file
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.
-This option overrides the end-of-media detection, and calculation
-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
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 A Ar archive_file
+Archive a dump table-of-contents in the
+specified
+.Ar archive_file
+to be used by
+.Xr restore 8
+to determine whether a file is in the dump file that is being restored.
.It Fl b Ar blocksize
The number of kilobytes per dump record.
Since the IO system slices all requests into chunks of MAXBSIZE
.Nm dump
will constrain writes to MAXBSIZE.
The default blocksize is 10.
+.It Fl B Ar records
+The number of 1 kB blocks per volume. Not normally required, as
+.Nm
+can detect end-of-media. When the specified size is reached,
+.Nm
+waits for you to change the volume. This option overrides
+the calculation of tape size based on length and density.
+If compression is on this limits the size of the compressed
+output per volume.
.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. Specifying a cartridge drive
overrides the end-of-media detection.
+.It Fl d Ar density
+Set tape density to
+.Ar density .
+The default is 1600BPI. Specifying a tape density overrides the
+end-of-media detection.
.It Fl e Ar inodes
Exclude
.Ar inodes
.Ar file
should be an ordinary file containing inode numbers separated by
newlines.
-.It Fl h Ar level
-Honor the user
-.Dq nodump
-flag
-.Dp Dv UF_NODUMP
-only for dumps at or above the given
-.Ar level .
-The default honor level is 1,
-so that incremental backups omit such files
-but full backups retain them.
-.It Fl d Ar density
-Set tape density to
-.Ar density .
-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 ;
.Nm
reverts back to the real user ID and the real group ID before
running the script.
+.It Fl h Ar level
+Honor the user
+.Dq nodump
+flag
+.Dv UF_NODUMP
+only for dumps at or above the given
+.Ar level .
+The default honor level is 1,
+so that incremental backups omit such files
+but full backups retain them.
+.It Fl I Ar nr errors
+By default,
+.Nm
+will ignore the first 32 read errors on the file
+system before asking for operator intervention. You can change this
+using this flag to any value. This is useful when running
+.Nm
+on an active filesystem where read errors simply indicate an
+inconsistency between the mapping and dumping passes.
.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
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.
+level is 2. If the optional parameter is specified, there should be no
+white space between the option letter and the parameter.
.It Fl k
Use Kerberos authentication to talk to remote tape servers. (Only
available if this option was enabled when
to be at most LBLSIZE (currently 16) characters, which must include
the terminating
.Ql \e0 .
+.It Fl m
+If this flag is specified,
+.Nm
+will optimise the output for inodes having been changed but not
+modified since the last dump ('changed' and 'modified' have the
+meaning defined in stat(2)). For those inodes,
+.Nm
+will save only the metadata, instead of saving the entire inode
+contents. Inodes which are either directories or have been modified
+since the last dump are saved in a regular way.
+Uses of this flag must be consistent, meaning that either every dump
+in an incremental dump set have the flag, or no one has it.
+.Pp
+Tapes written using such 'metadata only' inodes will not be compatible
+with the BSD tape format or older versions of
+.Nm restore.
.It Fl M
Enable the multi-volume feature. The name specified with
.Fl f
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.
+.Pp
+This option can be used when dumping to local tapes (see above)
+or to local files.
.It Fl s Ar feet
Attempt to calculate the amount of tape needed at a particular density.
If this amount is exceeded,
.Pa __DUMPDATES__
may be edited to change any of the fields,
if necessary.
+.It Fl v
+The
+.Fl v
+(verbose) makes
+.Nm dump
+to print extra information which could be helpful in debug sessions.
.It Fl W
.Nm Dump
tells the operator what file systems need to be dumped.
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.
+level is 2. If the optional parameter is specified, there should be no
+white space between the option letter and the parameter.
.El
.Pp
.Nm Dump
end of dump,
tape write error,
tape open error or
-disk read error (if there is more than a threshold of 32).
+disk read error (if there is more than a threshold of nr errors).
In addition to alerting all operators implied by the
.Fl n
key,
It might be considered a bug that this version of dump can only handle ext2
filesystems. Specifically, it does not work with FAT filesystems.
.Pp
-Fewer than 32 read errors on the filesystem are ignored. If noticing
+Fewer than 32 read errors (change this with -I)
+on the filesystem are ignored. If noticing
read errors is important, the output from dump can be parsed to look for lines
that contain the text 'read error'.
.Pp
+When a read error occurs,
+.Nm
+prints out the corresponding physical disk block and sector number and the
+ext2 logical block number.
+It doesn't print out the corresponing file name or even the inode number.
+The user has to use
+.Xr debugfs 8 ,
+commands
+.Pa ncheck
+and
+.Pa icheck
+to translate the
+.Pa ext2blk
+number printed out by dump into an inode number, then into a file name.
+.Pp
Each reel requires a new process, so parent processes for
reels already written just hang around until the entire tape
is written.
.Pp
Starting with 0.4b5, the new maintainer is Stelian Pop
.br
-<pop@noos.fr>.
+<stelian@popies.net>.
.Sh AVAILABILITY
The
.Nm dump/restore