Dump EOM detection is now a default.

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

diff --git a/dump/dump.8.in b/dump/dump.8.in
index 46121c1275dc5ff876dc0b361411c38cb6d886e7..38ba0846747dad975eda10313fa4a78e0c23c5b1 100644 (file)
--- 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.14 2000/03/10 10:03:09 stelian Exp $
+.\"    $Id: dump.8.in,v 1.18 2000/11/10 13:22:10 stelian Exp $
 .\"
 .Dd __DATE__
 .Dt DUMP 8
@@ -51,20 +51,7 @@
 .Op Fl L Ar label
 .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 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 s Ar feet
-.Op Fl T Ar date
-.Ar directory
+.Ar file-to-dump
 .Nm dump
 .Op Fl W Li \&| Fl w
 .Pp
@@ -86,19 +73,25 @@ option below for doing remote backups).
 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 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
@@ -119,16 +112,16 @@ 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.
+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
@@ -138,9 +131,11 @@ without having problems later with
 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
@@ -160,7 +155,8 @@ but full backups retain them.
 .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 ;
@@ -243,13 +239,13 @@ notify all operators in the group
 by means similar to a
 .Xr wall 1 .
 .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
@@ -302,10 +298,12 @@ The
 .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
@@ -314,7 +312,9 @@ exits immediately.
 .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
@@ -462,17 +462,6 @@ Each reel requires a new process, so parent processes for
 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,