1 .\" Copyright (c) 1980, 1991, 1993
2 .\" Regents of the University of California.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\" must display the following acknowledgement:
15 .\" This product includes software developed by the University of
16 .\" California, Berkeley and its contributors.
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\" may be used to endorse or promote products derived from this software
19 .\" without specific prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" $Id: dump.8.in,v 1.40 2002/04/04 08:20:23 stelian Exp $
37 .Os "dump __VERSION__"
40 .Nd ext2 filesystem backup
43 .Op Fl 0123456789ackMnqSu
48 .Op Fl e Ar inode numbers
54 .Op Fl j Ar compression level
59 .Op Fl z Ar compression level
67 option syntax is implemented for backward compatibility but
68 is not documented here.)
73 and determines which files
74 need to be backed up. These files
75 are copied to the given disk, tape or other
76 storage medium for safe keeping (see the
78 option below for doing remote backups).
79 A dump that is larger than the output medium is broken into
81 On most media the size is determined by writing until an
82 end-of-media indication is returned.
84 On media that cannot reliably return an end-of-media indication
85 (such as some cartridge tape drives), each volume is of a fixed size;
86 the actual size is determined by specifying cartridge media, or via the
87 tape size, density and/or block count options below.
88 By default, the same output file name is used for each volume
89 after prompting the operator to change media.
92 is either a mountpoint of a filesystem
93 or a list of files and directories to be backed up as a subset of a
95 In the former case, either the path to a mounted filesystem
96 or the device of an unmounted filesystem can be used.
97 In the latter case, certain restrictions are placed on the backup:
99 is not allowed, the only dump level that is supported is
101 and all the files and directories must reside on the same filesystem.
103 The following options are supported by
108 A level 0, full backup,
109 guarantees the entire file system is copied
113 A level number above 0,
118 copy all files new or modified since the
119 last dump of a lower level.
120 The default level is 9.
123 Bypass all tape length calculations, and write
124 until an end-of-media indication is returned. This works best
125 for most modern tape drives, and is the default.
126 Use of this option is particularly recommended when appending to an
127 existing tape, or using a tape drive with hardware compression
128 (where you can never be sure about the compression ratio).
129 .It Fl A Ar archive_file
130 Archive a dump table-of-contents in the
135 to determine whether a file is in the dump file that is being restored.
136 .It Fl b Ar blocksize
137 The number of kilobytes per dump record.
138 Since the IO system slices all requests into chunks of MAXBSIZE
139 (typically 64kB), it is not possible to use a larger blocksize
140 without having problems later with
144 will constrain writes to MAXBSIZE.
145 The default blocksize is 10.
147 The number of 1 kB blocks per volume. Not normally required, as
149 can detect end-of-media. When the specified size is reached,
151 waits for you to change the volume. This option overrides
152 the calculation of tape size based on length and density.
153 If compression is on this limits the size of the compressed
156 Change the defaults for use with a cartridge tape drive, with a density
157 of 8000 bpi, and a length of 1700 feet. Specifying a cartridge drive
158 overrides the end-of-media detection.
162 The default is 1600BPI. Specifying a tape density overrides the
163 end-of-media detection.
169 parameter is a comma separated list of inode numbers (you can use
171 to find the inode number for a file or directory).
173 Read list of inodes to be excluded from the dump from the text file
177 should be an ordinary file containing inode numbers separated by
183 may be a special device file
188 (a floppy disk drive),
192 (the standard output).
193 Multiple file names may be given as a single argument separated by commas.
194 Each file will be used for one dump volume in the order listed;
195 if the dump requires more volumes than the number of names given,
196 the last file name will used for all remaining volumes after prompting
198 If the name of the file is of the form
203 writes to the named file on the remote host using
205 The default path name of the remote
208 .\" rmt path, is the path on the remote host
210 this can be overridden by the environment variable
213 Run script at the end of each tape. The device name and the
214 current volume number are passed on the command line.
215 The script must return 0 if
217 should continue without asking the user to change the tape, 1 if
219 should continue but ask the user to change the tape.
220 Any other exit code will cause
223 For security reasons,
225 reverts back to the real user ID and the real group ID before
232 only for dumps at or above the given
234 The default honor level is 1,
235 so that incremental backups omit such files
236 but full backups retain them.
237 .It Fl I Ar nr errors
240 will ignore the first 32 read errors on the file
241 system before asking for operator intervention. You can change this
242 using this flag to any value. This is useful when running
244 on an active filesystem where read errors simply indicate an
245 inconsistency between the mapping and dumping passes.
246 .It Fl j Ar compression level
247 Compress every block to be written on the tape using bzlib library. This
248 option will work only when dumping to a file or pipe or, when dumping
249 to a tape drive, if the tape drive is capable of writing variable
250 length blocks. You will need at least the 0.4b24 version of restore in
251 order to extract compressed tapes. Tapes written using compression will
252 not be compatible with the BSD tape format. The (optional) parameter
253 specifies the compression level bzlib will use. The default compression
254 level is 2. If the optional parameter is specified, there should be no
255 white space between the option letter and the parameter.
257 Use Kerberos authentication to talk to remote tape servers. (Only
258 available if this option was enabled when
262 The user-supplied text string
264 is placed into the dump header, where tools like
269 Note that this label is limited
270 to be at most LBLSIZE (currently 16) characters, which must include
274 If this flag is specified,
276 will optimise the output for inodes having been changed but not
277 modified since the last dump ('changed' and 'modified' have the
278 meaning defined in stat(2)). For those inodes,
280 will save only the metadata, instead of saving the entire inode
281 contents. Inodes which are either directories or have been modified
282 since the last dump are saved in a regular way.
283 Uses of this flag must be consistent, meaning that either every dump
284 in an incremental dump set have the flag, or no one has it.
286 Tapes written using such 'metadata only' inodes will not be compatible
287 with the BSD tape format or older versions of
290 Enable the multi-volume feature. The name specified with
292 is treated as a prefix and
294 writes in sequence to <prefix>001, <prefix>002 etc. This can be
295 useful when dumping to files on an ext2 partition, in order to bypass
296 the 2GB file size limitation.
300 requires operator attention,
301 notify all operators in the group
303 by means similar to a
308 abort immediately whenever operator attention is required,
309 without prompting in case of write errors, tape changes etc.
311 Enable the Quick File Access support. Tape positions for each
312 inode are stored into the file
314 which is used by restore (if called with parameter Q and the filename)
315 to directly position the tape at the file restore is currently working
316 on. This saves hours when restoring single files from large backups,
317 saves the tapes and the drive's head.
319 It is recommended to set up the st driver to return logical tape
320 positions rather than physical before calling dump/restore with
321 parameter Q. Since not all tape devices support physical tape
322 positions those tape devices return an error during dump/restore when
323 the st driver is set to the default physical setting.
324 Please see the st man page, option MTSETDRVBUFFER, or the mt man
325 page, on how to set the driver to return logical tape positions.
327 Before calling restore with parameter Q, always make sure the st
328 driver is set to return the same type of tape position used during the
329 call to dump. Otherwise restore may be confused.
331 This option can be used when dumping to local tapes (see above)
334 Attempt to calculate the amount of tape needed at a particular density.
335 If this amount is exceeded,
337 prompts for a new tape.
338 It is recommended to be a bit conservative on this option.
339 The default tape length is 2300 feet. Specifying the tape size
340 overrides end-of-media detection.
343 Size estimate. Determine the amount of space
344 that is needed to perform the dump without
345 actually doing it, and display the estimated
346 number of bytes it will take. This is useful
347 with incremental dumps to determine how many
348 volumes of media will be needed.
350 Use the specified date as the starting time for the dump
351 instead of the time determined from looking in
355 is the same as that of
357 This option is useful for automated dump scripts that wish to
358 dump over a specific period of time.
361 option is mutually exclusive from the
367 after a successful dump.
370 is readable by people, consisting of one
371 free format record per line:
377 There may be only one entry per filesystem at each level.
380 may be edited to change any of the fields,
384 tells the operator what file systems need to be dumped.
385 This information is gleaned from the files
393 to print out, for all file systems in
395 and regognized file systems in
397 the most recent dump date and level,
398 and highlights those that should be dumped.
401 option is set, all other options are ignored, and
407 but prints only recognized filesystems in
409 which need to be dumped.
410 .It Fl z Ar compression level
411 Compress every block to be written on the tape using zlib library. This
412 option will work only when dumping to a file or pipe or, when dumping
413 to a tape drive, if the tape drive is capable of writing variable
414 length blocks. You will need at least the 0.4b22 version of restore in
415 order to extract compressed tapes. Tapes written using compression will
416 not be compatible with the BSD tape format. The (optional) parameter
417 specifies the compression level zlib will use. The default compression
418 level is 2. If the optional parameter is specified, there should be no
419 white space between the option letter and the parameter.
423 requires operator intervention on these conditions:
428 disk read error (if there is more than a threshold of nr errors).
429 In addition to alerting all operators implied by the
433 interacts with the operator on
435 control terminal at times when
437 can no longer proceed,
438 or if something is grossly wrong.
443 be answered by typing
449 Since making a dump involves a lot of time and effort for full dumps,
451 checkpoints itself at the start of each tape volume.
452 If writing that volume fails for some reason,
455 with operator permission,
456 restart itself from the checkpoint
457 after the old tape has been rewound and removed,
458 and a new tape has been mounted.
461 tells the operator what is going on at periodic intervals,
462 including usually low estimates of the number of blocks to write,
463 the number of tapes it will take, the time to completion, and
464 the time to the tape change.
465 The output is verbose,
466 so that others know that the terminal
470 and will be for some time.
472 In the event of a catastrophic disk event, the time required
473 to restore all the necessary backup tapes or files to disk
474 can be kept to a minimum by staggering the incremental dumps.
475 An efficient method of staggering incremental dumps
476 to minimize the number of tapes follows:
477 .Bl -bullet -offset indent
479 Always start with a level 0 backup, for example:
480 .Bd -literal -offset indent
481 /sbin/dump -0u -f /dev/st0 /usr/src
484 This should be done at set intervals, say once a month or once every two months,
485 and on a set of fresh tapes that is saved forever.
487 After a level 0, dumps of active file
488 systems are taken on a daily basis,
489 using a modified Tower of Hanoi algorithm,
490 with this sequence of dump levels:
491 .Bd -literal -offset indent
492 3 2 5 4 7 6 9 8 9 9 ...
495 For the daily dumps, it should be possible to use a fixed number of tapes
496 for each day, used on a weekly basis.
497 Each week, a level 1 dump is taken, and
498 the daily Hanoi sequence repeats beginning with 3.
499 For weekly dumps, another fixed set of tapes per dumped file system is
500 used, also on a cyclical basis.
503 After several months or so, the daily and weekly tapes should get
504 rotated out of the dump cycle and fresh tapes brought in.
508 If no -f option was specified,
510 will use the device specified via
518 .Qq user@host:tapename .
520 The environment variable
522 will be used to determine the pathname of the remote
527 uses the contents of this variable to determine the name of the
528 remote shell command to use when doing remote backups (rsh, ssh etc.).
529 If this variable is not set,
531 will be used, but only root will be able to do remote backups.
534 .Bl -tag -width __DUMPDATES__ -compact
536 default tape unit to dump to
540 dump table: file systems and frequency
553 exits with zero status on success.
554 Startup errors are indicated with an exit code of 1;
555 abnormal termination is indicated with an exit code of 3.
557 It might be considered a bug that this version of dump can only handle ext2
558 filesystems. Specifically, it does not work with FAT filesystems.
560 Fewer than 32 read errors (change this with -I)
561 on the filesystem are ignored. If noticing
562 read errors is important, the output from dump can be parsed to look for lines
563 that contain the text 'read error'.
565 Each reel requires a new process, so parent processes for
566 reels already written just hang around until the entire tape
569 The estimated number of tapes is not correct if compression is on.
573 knew about the dump sequence,
574 kept track of the tapes scribbled on,
575 told the operator which tape to mount when,
576 and provided more assistance
577 for the operator running
581 cannot do remote backups without being run as root, due to its
583 Presently, it works if you set it setuid (like it used to be), but this
584 might constitute a security risk. Note that you can set RSH to use
585 a remote shell program instead.
589 backup suite was ported to Linux's Second Extended File System
590 by Remy Card <card@Linux.EU.Org>. He maintained the initial versions
591 of dump (up and including 0.4b4, released in january 1997).
593 Starting with 0.4b5, the new maintainer is Stelian Pop
595 <stelian@popies.net>.
599 backup suite is available from
601 http://dump.sourceforge.net