]> git.wh0rd.org - dump.git/blobdiff - dump/dump.8.in
Small man page improvement regarding the dump levels specification.
[dump.git] / dump / dump.8.in
index b44970148d47214832d8053fbcc36314f49704bb..400eff20a493cc13be74367a24b576bffd34129e 100644 (file)
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
+.\" 3. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\"
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\"    $Id: dump.8.in,v 1.48 2003/01/21 10:42:27 stelian Exp $
+.\"    $Id: dump.8.in,v 1.59 2006/08/01 10:22:44 stelian Exp $
 .\"
 .TH DUMP 8 "version __VERSION__ of __DATE__" BSD "System management commands"
 .SH NAME
 dump \- ext2/3 filesystem backup
 .SH SYNOPSIS
 .B dump 
-[\fB\-0123456789ackMnqSuv\fR]
+[\fB\-\fIlevel#\fR]
+[\fB\-ackMnqSuv]
 [\fB\-A \fIfile\fR]
 [\fB\-B \fIrecords\fR]
 [\fB\-b \fIblocksize\fR]
@@ -54,14 +51,12 @@ dump \- ext2/3 filesystem backup
 [\fB\-Q \fIfile\fR]
 [\fB\-s \fIfeet\fR]
 [\fB\-T \fIdate\fR]
+[\fB\-y\fR]
 [\fB\-z\fIcompression level\fR]
 .I files-to-dump
 .PP
 .B dump 
 [\fB\-W \fR| \fB\-w\fR]
-.PP
-(The 4.3BSD option syntax is implemented for backward compatibility but is not
-documented here.)
 .SH DESCRIPTION
 .B Dump
 examines files on an ext2/3 filesystem and determines which files need to be
@@ -91,15 +86,17 @@ and all the files and directories must reside on the same filesystem.
 The following options are supported by
 .B dump:
 .TP
-.BI \-0\-9
-Dump levels. A level 0, full backup, guarantees the entire file system is
-copied (but see also the
+.BI \-level#
+The dump level (any integer). A level 0, full backup, specified by
+.B \-0
+guarantees the entire file system is copied (but see also the
 .B \-h
 option below). A level number above 0, incremental backup, tells
 .B dump
 to
 copy all files new or modified since the last dump of a lower level. The 
-default level is 9.
+default level is 9. Historically only levels 0 to 9 were usable in
+dump, this version is able to understand any integer as a dump level.
 .TP
 .BI \-a 
 \*(lqauto-size\*(rq. Bypass all tape length calculations, and write until an 
@@ -116,8 +113,11 @@ to be used by
 to determine whether a file is in the dump file that is being restored.
 .TP
 .BI \-b " blocksize"
-The number of kilobytes per dump record. The default blocksize is 10
-and the maximal value is 1024.
+The number of kilobytes per dump record. The default blocksize is 10,
+unless the
+.B \-d
+option has been used to specify a tape density of 6250BPI or more,
+in which case the default blocksize is 32. Th maximal value is 1024.
 Note however that, since the IO system slices all requests into chunks
 of 
 .B MAXBSIZE
@@ -134,7 +134,15 @@ can detect end-of-media. When the specified size is reached,
 .B dump
 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.
+size of the compressed output per volume.  Multiple values may be given
+as a single argument separated by commas.  Each value will be used for one
+dump volume in the order listed; if
+.B dump
+creates more volumes than the
+number of values given, the last value will be used for the remaining
+volumes. This is useful for filling up already partially filled media
+(and then continuing with full size volumes on empty media) or mixing media
+of different sizes.
 .TP
 .BI \-c
 Change the defaults for use with a cartridge tape drive, with a density of 8000
@@ -187,7 +195,8 @@ media changes. If the name of the file is of the form
 or
 .I user@host:file
 .B dump
-writes to the named file on the remote host using
+writes to the named file on the remote host (which should already 
+exist, dump doesn't create a new remote file) using
 .BR rmt (8).
 The default path name of the remote
 .BR rmt (8)
@@ -275,6 +284,12 @@ 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.
 .IP
+If you use this option, be aware that many programs that unpack
+files from archives (e.g. tar, rpm, unzip, dpkg) may set files'
+mtimes to dates in the past.  Files installed in this way may not be
+dumped correctly using "dump -m" if the modified mtime is earlier
+than the previous level dump.
+.IP
 Tapes written using such 'metadata only' inodes will not be compatible with the
 BSD tape format or older versions of
 .B restore.
@@ -367,7 +382,15 @@ determined from looking in
 The format of
 .I date
 is the same as that of
-.BR ctime (3).
+.BR ctime (3)
+followed by an rfc822 timezone specification: either a plus or minus sign
+followed by two digits for the number of hours and two digits for the minutes.
+For example, -0800 for eight hours west of Greenwich or +0230 for two hours
+and a half east of Greenwich. This timezone offset takes into account
+daylight savings time (if applicable to the timezone): UTC offsets
+when daylight savings time is in effect will be different than offsets
+when daylight savings time is not in effect. For backward
+compatibility, if no timezone is specified, a local time is assumed.
 This option is useful for automated dump scripts that wish to dump over a 
 specific period of time. The
 .B \-T
@@ -383,8 +406,12 @@ after a successful dump. The format of
 is readable by people, consisting of one free format record per line:
 filesystem name, increment level and
 .BR ctime (3)
-format dump date. There may be only one entry per filesystem at each level. The
-file
+format dump date followed by a rfc822 timezone specification (see the
+.B \-u
+option for details). If no timezone offset is specified, times are interpreted 
+as local. Whenever the file is written, all dates in the file are converted 
+to the local time zone, without changing the UTC times. There
+may be only one entry per filesystem at each level. The file
 .I __DUMPDATES__
 may be edited to change any of the fields, if necessary.
 .TP
@@ -409,6 +436,8 @@ option causes
 to print out, for all file systems in
 .I __DUMPDATES__ ,
 and regognized file systems in
+.I /etc/mtab
+and
 .IR /etc/fstab .
 the most recent dump date and level, and highlights those that should be 
 dumped. If the
@@ -421,9 +450,21 @@ exits immediately.
 Is like
 .BR \-W ,
 but prints only recognized filesystems in
+.I /etc/mtab
+and
 .I /etc/fstab
 which need to be dumped.
 .TP
+.BI \-y
+Compress every block to be written to the tape using the lzo library.
+This doesn't compress as well as the zlib library but it's much faster.
+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.4b34 version of
+.B restore
+in order to extract compressed tapes. Tapes written using compression will not
+be compatible with the BSD tape format.
+.TP
 .BI \-z "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,
@@ -493,6 +534,9 @@ set of tapes per dumped file system is used, also on a cyclical basis.
 .PP
 After several months or so, the daily and weekly tapes should get rotated out
 of the dump cycle and fresh tapes brought in.
+.PP
+(The 4.3BSD option syntax is implemented for backward compatibility but is not
+documented here.)
 .SH ENVIRONMENT
 .TP 
 .B TAPE
@@ -535,6 +579,9 @@ dump date records
 .I /etc/fstab
 dump table: file systems and frequency
 .TP
+.I /etc/mtab
+dump table: mounted file systems
+.TP
 .I /etc/group
 to find group
 .I operator
@@ -544,6 +591,15 @@ to find group
 .BR rmt (8)
 .SH DIAGNOSTICS
 Many, and verbose.
+.SH COMPATIBILITY
+The format of the
+.I __DUMPDATES__
+file has changed in release 0.4b34, however, the file will be read
+correctly with either pre-0.4b34 or 0.4b34 and later versions of
+.B dump
+provided that the machine on which
+.B dump
+is run did not change timezones (which should be a fairly rare occurence).
 .SH EXIT STATUS
 .B Dump
 exits with zero status on success. Startup errors are indicated with an exit