X-Git-Url: https://git.wh0rd.org/?p=dump.git;a=blobdiff_plain;f=dump%2Fdump.8.in;h=ef41382582b7473296f7f8265b177f2e630dbc62;hp=22ed34036b76f39e42ab77254a50e96930df1084;hb=aa1b1e7f1a9c7201ba1ac4eb35921e2c9df26729;hpb=103122b3455278bdf377ce24821168be90238fda

diff --git a/dump/dump.8.in b/dump/dump.8.in
index 22ed340..ef41382 100644
--- a/dump/dump.8.in
+++ b/dump/dump.8.in
@@ -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.36 2002/01/22 11:12:28 stelian Exp $
+.\"	$Id: dump.8.in,v 1.42 2002/06/10 14:05:00 stelian Exp $
 .\"
 .Dd __DATE__
 .Dt DUMP 8
@@ -40,7 +40,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
@@ -117,11 +118,6 @@ to
 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
@@ -130,6 +126,13 @@ 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 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
@@ -140,10 +143,24 @@ Therefore
 .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
@@ -159,21 +176,6 @@ 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
-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 ;
@@ -222,6 +224,16 @@ For security reasons,
 .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
+.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 I Ar nr errors
 By default,
 .Nm
@@ -239,7 +251,8 @@ 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.
+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
@@ -257,6 +270,22 @@ Note that this label is limited
 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 
@@ -350,6 +379,12 @@ The file
 .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.
@@ -386,7 +421,8 @@ 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.
+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
@@ -532,6 +568,21 @@ 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.