]>
Commit | Line | Data |
---|---|---|
1227625a SP |
1 | .\" Copyright (c) 1980, 1991, 1993 |
2 | .\" Regents of the University of California. | |
3 | .\" All rights reserved. | |
4 | .\" | |
5 | .\" Redistribution and use in source and binary forms, with or without | |
6 | .\" modification, are permitted provided that the following conditions | |
7 | .\" are met: | |
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. | |
e1abc9ce | 13 | .\" 3. Neither the name of the University nor the names of its contributors |
1227625a SP |
14 | .\" may be used to endorse or promote products derived from this software |
15 | .\" without specific prior written permission. | |
16 | .\" | |
17 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
18 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
19 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
20 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
21 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
22 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
23 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
24 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
25 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
26 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
27 | .\" SUCH DAMAGE. | |
28 | .\" | |
b79d20f1 | 29 | .\" $Id: dump.8.in,v 1.57 2004/07/13 08:17:32 stelian Exp $ |
1227625a | 30 | .\" |
153f9a83 SP |
31 | .TH DUMP 8 "version __VERSION__ of __DATE__" BSD "System management commands" |
32 | .SH NAME | |
33 | dump \- ext2/3 filesystem backup | |
34 | .SH SYNOPSIS | |
35 | .B dump | |
28ba5cae SP |
36 | [\fB\-\fIlevel#\fR] |
37 | [\fB\-ackMnqSuv] | |
153f9a83 SP |
38 | [\fB\-A \fIfile\fR] |
39 | [\fB\-B \fIrecords\fR] | |
40 | [\fB\-b \fIblocksize\fR] | |
41 | [\fB\-d \fIdensity\fR] | |
c92d83ae | 42 | [\fB\-D \fIfile\fR] |
153f9a83 SP |
43 | [\fB\-e \fIinode numbers\fR] |
44 | [\fB\-E \fIfile\fR] | |
45 | [\fB\-f \fIfile\fR] | |
46 | [\fB\-F \fIscript\fR] | |
47 | [\fB\-h \fIlevel\fR] | |
48 | [\fB\-I \fInr errors\fR] | |
49 | [\fB\-j\fIcompression level\fR] | |
50 | [\fB\-L \fIlabel\fR] | |
51 | [\fB\-Q \fIfile\fR] | |
52 | [\fB\-s \fIfeet\fR] | |
53 | [\fB\-T \fIdate\fR] | |
206f768c | 54 | [\fB\-y\fR] |
153f9a83 SP |
55 | [\fB\-z\fIcompression level\fR] |
56 | .I files-to-dump | |
57 | .PP | |
58 | .B dump | |
59 | [\fB\-W \fR| \fB\-w\fR] | |
153f9a83 SP |
60 | .SH DESCRIPTION |
61 | .B Dump | |
62 | examines files on an ext2/3 filesystem and determines which files need to be | |
63 | backed up. These files are copied to the given disk, tape or other storage | |
64 | medium for safe keeping (see the | |
65 | .B \-f | |
66 | option below for doing remote backups). A dump that is larger than the output | |
67 | medium is broken into multiple volumes. On most media the size is determined by | |
68 | writing until an end-of-media indication is returned. | |
69 | .PP | |
70 | On media that cannot reliably return an end-of-media indication (such as some | |
71 | cartridge tape drives), each volume is of a fixed size; the actual size is | |
72 | determined by specifying cartridge media, or via the tape size, density and/or | |
73 | block count options below. By default, the same output file name is used for | |
74 | each volume after prompting the operator to change media. | |
75 | .PP | |
76 | .I files-to-dump | |
77 | is either a mountpoint of a filesystem or a list of files and directories to be | |
78 | backed up as a subset of a filesystem. In the former case, either the path to a | |
79 | mounted filesystem or the device of an unmounted filesystem can be used. In the | |
80 | latter case, certain restrictions are placed on the backup: | |
81 | .B \-u | |
a94ecd11 | 82 | is not allowed, the only dump level that is supported is |
153f9a83 | 83 | .B 0 |
a94ecd11 | 84 | and all the files and directories must reside on the same filesystem. |
153f9a83 | 85 | .SH OPTIONS |
1227625a | 86 | The following options are supported by |
153f9a83 SP |
87 | .B dump: |
88 | .TP | |
28ba5cae SP |
89 | .BI \-level# |
90 | The dump level (any integer). A level 0, full backup, guarantees the | |
91 | entire file system is copied (but see also the | |
153f9a83 SP |
92 | .B \-h |
93 | option below). A level number above 0, incremental backup, tells | |
94 | .B dump | |
ddd2ef55 | 95 | to |
153f9a83 | 96 | copy all files new or modified since the last dump of a lower level. The |
28ba5cae SP |
97 | default level is 9. Historically only levels 0 to 9 were usable in |
98 | dump, this version is able to understand any integer as a dump level. | |
153f9a83 SP |
99 | .TP |
100 | .BI \-a | |
101 | \*(lqauto-size\*(rq. Bypass all tape length calculations, and write until an | |
102 | end-of-media indication is returned. This works best for most modern tape | |
103 | drives, and is the default. Use of this option is particularly recommended when | |
104 | appending to an existing tape, or using a tape drive with hardware compression | |
4f4eee3d | 105 | (where you can never be sure about the compression ratio). |
153f9a83 SP |
106 | .TP |
107 | .BI \-A " archive_file" | |
108 | Archive a dump table-of-contents in the specified | |
109 | .I archive_file | |
e51470bf | 110 | to be used by |
153f9a83 | 111 | .BR restore (8) |
e51470bf | 112 | to determine whether a file is in the dump file that is being restored. |
153f9a83 SP |
113 | .TP |
114 | .BI \-b " blocksize" | |
8ad151aa SP |
115 | The number of kilobytes per dump record. The default blocksize is 10, |
116 | unless the | |
117 | .B \-d | |
118 | option has been used to specify a tape density of 6250BPI or more, | |
119 | in which case the default blocksize is 32. Th maximal value is 1024. | |
876861d2 SP |
120 | Note however that, since the IO system slices all requests into chunks |
121 | of | |
153f9a83 | 122 | .B MAXBSIZE |
876861d2 SP |
123 | (which can be as low as 64kB), you can experience problems with |
124 | .BR dump (8) | |
125 | and | |
126 | .BR restore (8) | |
127 | when using a higher value, depending on your kernel and/or libC versions. | |
153f9a83 SP |
128 | .TP |
129 | .BI \-B " records" | |
27305a35 | 130 | The number of 1 kB blocks per volume. Not normally required, as |
153f9a83 | 131 | .B dump |
27305a35 | 132 | can detect end-of-media. When the specified size is reached, |
153f9a83 SP |
133 | .B dump |
134 | waits for you to change the volume. This option overrides the calculation of | |
135 | tape size based on length and density. If compression is on this limits the | |
d435f57f SP |
136 | size of the compressed output per volume. Multiple values may be given |
137 | as a single argument separated by commas. Each value will be used for one | |
138 | dump volume in the order listed; if | |
139 | .B dump | |
140 | creates more volumes than the | |
141 | number of values given, the last value will be used for the remaining | |
142 | volumes. This is useful for filling up already partially filled media | |
143 | (and then continuing with full size volumes on empty media) or mixing media | |
144 | of different sizes. | |
153f9a83 SP |
145 | .TP |
146 | .BI \-c | |
147 | Change the defaults for use with a cartridge tape drive, with a density of 8000 | |
148 | bpi, and a length of 1700 feet. Specifying a cartridge drive overrides the | |
e51470bf | 149 | end-of-media detection. |
153f9a83 SP |
150 | .TP |
151 | .BI \-d " density" | |
152 | Set tape density to | |
153 | .IR density . | |
154 | The default is 1600BPI. Specifying a tape density overrides the end-of-media | |
155 | detection. | |
156 | .TP | |
c92d83ae SP |
157 | .BI \-D " file" |
158 | Set the path name of the file storing the information about the previous | |
159 | full and incremental dumps. The default location is | |
160 | .IR __DUMPDATES__ . | |
161 | .TP | |
153f9a83 | 162 | .BI \-e " inodes" |
20c345aa | 163 | Exclude |
153f9a83 | 164 | .I inodes |
6d732772 | 165 | from the dump. The |
153f9a83 | 166 | .I inodes |
6d732772 | 167 | parameter is a comma separated list of inode numbers (you can use |
153f9a83 | 168 | .BR stat (1) |
20c345aa | 169 | to find the inode number for a file or directory). |
153f9a83 SP |
170 | .TP |
171 | .BI \-E " file" | |
6d732772 | 172 | Read list of inodes to be excluded from the dump from the text file |
153f9a83 | 173 | .IR file . |
6d732772 | 174 | The file |
153f9a83 SP |
175 | .I file |
176 | should be an ordinary file containing inode numbers separated by newlines. | |
177 | .TP | |
178 | .BI \-f " file" | |
1227625a | 179 | Write the backup to |
153f9a83 SP |
180 | .IR file ; |
181 | .I file | |
182 | may be a special device file like | |
183 | .I /dev/st0 | |
1227625a | 184 | (a tape drive), |
153f9a83 SP |
185 | .I /dev/rsd1c |
186 | (a floppy disk drive), an ordinary file, or | |
187 | .I \- | |
188 | (the standard output). Multiple file names may be given as a single argument | |
189 | separated by commas. Each file will be used for one dump volume in the order | |
190 | listed; if the dump requires more volumes than the number of names given, | |
191 | the last file name will used for all remaining volumes after prompting for | |
192 | media changes. If the name of the file is of the form | |
193 | .I host:file | |
1227625a | 194 | or |
153f9a83 SP |
195 | .I user@host:file |
196 | .B dump | |
ae6919a7 SP |
197 | writes to the named file on the remote host (which should already |
198 | exist, dump doesn't create a new remote file) using | |
153f9a83 | 199 | .BR rmt (8). |
b45f51d6 | 200 | The default path name of the remote |
153f9a83 | 201 | .BR rmt (8) |
b45f51d6 | 202 | program is |
153f9a83 | 203 | .IR /etc/rmt ; |
b45f51d6 | 204 | this can be overridden by the environment variable |
153f9a83 SP |
205 | .BR RMT . |
206 | .TP | |
207 | .BI \-F " script" | |
172af402 SP |
208 | Run script at the end of each tape (except for the last one). |
209 | The device name and the current volume number are passed on the | |
210 | command line. The script must return 0 if | |
153f9a83 | 211 | .B dump |
ae81b200 | 212 | should continue without asking the user to change the tape, 1 if |
153f9a83 SP |
213 | .B dump |
214 | should continue but ask the user to change the tape. Any other exit code will | |
215 | cause | |
216 | .B dump | |
217 | to abort. For security reasons, | |
218 | .B dump | |
219 | reverts back to the real user ID and the real group ID before running the | |
220 | script. | |
221 | .TP | |
222 | .BI \-h " level" | |
e51470bf | 223 | Honor the user |
153f9a83 | 224 | .B nodump |
e51470bf | 225 | flag |
153f9a83 | 226 | .B UF_NODUMP |
e51470bf | 227 | only for dumps at or above the given |
153f9a83 SP |
228 | .IR level . |
229 | The default honor level is 1, so that incremental backups omit such files but | |
230 | full backups retain them. | |
231 | .TP | |
232 | .BI \-I " nr errors" | |
b82d31dc | 233 | By default, |
153f9a83 SP |
234 | .B dump |
235 | will ignore the first 32 read errors on the file system before asking for | |
236 | operator intervention. You can change this using this flag to any value. This | |
237 | is useful when running | |
238 | .B dump | |
239 | on an active filesystem where read errors simply indicate an inconsistency | |
240 | between the mapping and dumping passes. | |
3211c85b SP |
241 | .IP |
242 | A value of 0 means that all read errors will be ignored. | |
153f9a83 SP |
243 | .TP |
244 | .BI \-j "compression level" | |
245 | Compress every block to be written on the tape using bzlib library. This option | |
246 | will work only when dumping to a file or pipe or, when dumping to a tape drive, | |
247 | if the tape drive is capable of writing variable length blocks. You will need | |
248 | at least the 0.4b24 version of | |
249 | .B restore | |
250 | in order to extract compressed tapes. Tapes written using compression will not | |
251 | be compatible with the BSD tape format. The (optional) parameter specifies the | |
252 | compression level bzlib will use. The default compression level is 2. If the | |
253 | optional parameter is specified, there should be no white space between the | |
254 | option letter and the parameter. | |
255 | .TP | |
256 | .BI \-k | |
257 | Use Kerberos authentication to talk to remote tape servers. (Only available if | |
258 | this option was enabled when | |
259 | .B dump | |
b45f51d6 | 260 | was compiled.) |
153f9a83 SP |
261 | .TP |
262 | .BI \-L " label" | |
b45f51d6 | 263 | The user-supplied text string |
153f9a83 | 264 | .I label |
b45f51d6 | 265 | is placed into the dump header, where tools like |
153f9a83 | 266 | .BR restore (8) |
b45f51d6 | 267 | and |
153f9a83 SP |
268 | .BR file (8) |
269 | can access it. Note that this label is limited to be at most | |
270 | .B LBLSIZE | |
271 | (currently 16) characters, which must include the terminating \e0. | |
272 | .TP | |
273 | .BI \-m | |
0cedbda5 | 274 | If this flag is specified, |
153f9a83 SP |
275 | .B dump |
276 | will optimise the output for inodes having been changed but not modified since | |
277 | the last dump ('changed' and 'modified' have the meaning defined in | |
278 | .BR stat (2) | |
279 | ). For those inodes, | |
280 | .B dump | |
281 | will save only the metadata, instead of saving the entire inode contents. | |
282 | Inodes which are either directories or have been modified since the last dump | |
283 | are saved in a regular way. Uses of this flag must be consistent, meaning that | |
284 | either every dump in an incremental dump set have the flag, or no one has it. | |
285 | .IP | |
286 | Tapes written using such 'metadata only' inodes will not be compatible with the | |
287 | BSD tape format or older versions of | |
288 | .B restore. | |
289 | .TP | |
290 | .BI \-M | |
dc7cb1e2 | 291 | Enable the multi-volume feature. The name specified with |
153f9a83 | 292 | .B f |
dc7cb1e2 | 293 | is treated as a prefix and |
153f9a83 SP |
294 | .B dump |
295 | writes in sequence to | |
296 | .I <prefix>001, <prefix>002 | |
297 | etc. This can be useful when dumping to files on an ext2 partition, in order to | |
298 | bypass the 2GB file size limitation. | |
299 | .TP | |
300 | .BI \-n | |
1227625a | 301 | Whenever |
153f9a83 SP |
302 | .B dump |
303 | requires operator attention, notify all operators in the group | |
304 | .B operator | |
1227625a | 305 | by means similar to a |
153f9a83 SP |
306 | .BR wall (1). |
307 | .TP | |
308 | .BI \-q | |
e084ba00 | 309 | Make |
153f9a83 SP |
310 | .B dump |
311 | abort immediately whenever operator attention is required, without prompting in | |
312 | case of write errors, tape changes etc. | |
313 | .TP | |
314 | .BI \-Q " file" | |
315 | Enable the Quick File Access support. Tape positions for each inode are stored | |
316 | into the file | |
317 | .I file | |
318 | which is used by | |
319 | .B restore | |
320 | (if called with parameter | |
321 | .B \-Q | |
322 | and the filename) to directly position the tape at the file | |
323 | .B restore | |
324 | is currently working on. This saves hours when restoring single files from | |
325 | large backups, saves the tapes and the drive's head. | |
326 | .IP | |
327 | It is recommended to set up the st driver to return logical tape positions | |
328 | rather than physical before calling | |
329 | .B dump/restore | |
330 | with parameter | |
331 | .BR \-Q . | |
332 | Since not all tape devices support physical tape positions those tape devices | |
333 | return an error during | |
334 | .B dump/restore | |
335 | when the st driver is set to the default physical setting. Please see the | |
336 | .BR st (4) | |
337 | man page, option | |
338 | .B MTSETDRVBUFFER | |
339 | , or the | |
340 | .BR mt (1) | |
341 | man page, on how to set the driver to return logical tape positions. | |
342 | .IP | |
343 | Before calling | |
344 | .B restore | |
345 | with parameter | |
346 | .BR \-Q , | |
347 | always make sure the st driver is set to return the same type of tape position | |
348 | used during the call to | |
349 | .BR dump . | |
350 | Otherwise | |
351 | .B restore | |
352 | may be confused. | |
353 | .IP | |
354 | This option can be used when dumping to local tapes (see above) or to local | |
355 | files. | |
356 | .TP | |
357 | .BI \-s " feet" | |
358 | Attempt to calculate the amount of tape needed at a particular density. If this | |
359 | amount is exceeded, | |
360 | .B dump | |
361 | prompts for a new tape. It is recommended to be a bit conservative on this | |
362 | option. The default tape length is 2300 feet. Specifying the tape size | |
4f4eee3d | 363 | overrides end-of-media detection. |
153f9a83 SP |
364 | .TP |
365 | .BI \-S | |
366 | Size estimate. Determine the amount of space that is needed to perform the dump | |
367 | without actually doing it, and display the estimated number of bytes it will | |
368 | take. This is useful with incremental dumps to determine how many volumes of | |
369 | media will be needed. | |
370 | .TP | |
371 | .BI \-T " date" | |
372 | Use the specified date as the starting time for the dump instead of the time | |
373 | determined from looking in | |
374 | .I __DUMPDATES__ . | |
ddd2ef55 | 375 | The format of |
153f9a83 | 376 | .I date |
ddd2ef55 | 377 | is the same as that of |
3458b64d SP |
378 | .BR ctime (3) |
379 | followed by an rfc822 timezone specification: either a plus or minus sign | |
380 | followed by two digits for the number of hours and two digits for the minutes. | |
381 | For example, -0800 for eight hours west of Greenwich or +0230 for two hours | |
382 | and a half east of Greenwich. This timezone offset takes into account | |
383 | daylight savings time (if applicable to the timezone): UTC offsets | |
384 | when daylight savings time is in effect will be different than offsets | |
385 | when daylight savings time is not in effect. For backward | |
386 | compatibility, if no timezone is specified, a local time is assumed. | |
153f9a83 SP |
387 | This option is useful for automated dump scripts that wish to dump over a |
388 | specific period of time. The | |
389 | .B \-T | |
1227625a | 390 | option is mutually exclusive from the |
153f9a83 | 391 | .B \-u |
1227625a | 392 | option. |
153f9a83 SP |
393 | .TP |
394 | .BI \-u | |
1227625a | 395 | Update the file |
153f9a83 SP |
396 | .I __DUMPDATES__ |
397 | after a successful dump. The format of | |
398 | .I __DUMPDATES__ | |
399 | is readable by people, consisting of one free format record per line: | |
400 | filesystem name, increment level and | |
401 | .BR ctime (3) | |
3458b64d SP |
402 | format dump date followed by a rfc822 timezone specification (see the |
403 | .B \-u | |
404 | option for details). If no timezone offset is specified, times are interpreted | |
405 | as local. Whenever the file is written, all dates in the file are converted | |
406 | to the local time zone, without changing the UTC times. There | |
407 | may be only one entry per filesystem at each level. The file | |
153f9a83 SP |
408 | .I __DUMPDATES__ |
409 | may be edited to change any of the fields, if necessary. | |
410 | .TP | |
411 | .BI \-v | |
fceb4f25 | 412 | The |
153f9a83 | 413 | .B \-v |
fceb4f25 | 414 | (verbose) makes |
153f9a83 | 415 | .B dump |
fceb4f25 | 416 | to print extra information which could be helpful in debug sessions. |
153f9a83 SP |
417 | .TP |
418 | .BI \-W | |
419 | .B Dump | |
420 | tells the operator what file systems need to be dumped. This information is | |
421 | gleaned from the files | |
422 | .I __DUMPDATES__ | |
1227625a | 423 | and |
153f9a83 | 424 | .IR /etc/fstab . |
1227625a | 425 | The |
153f9a83 | 426 | .B \-W |
1227625a | 427 | option causes |
153f9a83 | 428 | .B dump |
51b01afe | 429 | to print out, for all file systems in |
153f9a83 | 430 | .I __DUMPDATES__ , |
51b01afe | 431 | and regognized file systems in |
a8a6a503 SP |
432 | .I /etc/mtab |
433 | and | |
153f9a83 SP |
434 | .IR /etc/fstab . |
435 | the most recent dump date and level, and highlights those that should be | |
436 | dumped. If the | |
437 | .B \-W | |
1227625a | 438 | option is set, all other options are ignored, and |
153f9a83 | 439 | .B dump |
1227625a | 440 | exits immediately. |
153f9a83 SP |
441 | .TP |
442 | .BI \-w | |
ddd2ef55 | 443 | Is like |
153f9a83 | 444 | .BR \-W , |
51b01afe | 445 | but prints only recognized filesystems in |
a8a6a503 SP |
446 | .I /etc/mtab |
447 | and | |
153f9a83 | 448 | .I /etc/fstab |
51b01afe | 449 | which need to be dumped. |
153f9a83 | 450 | .TP |
206f768c SP |
451 | .BI \-y |
452 | Compress every block to be written to the tape using the lzo library. | |
453 | This doesn't compress as well as the zlib library but it's much faster. | |
454 | This option will work only when dumping to a file or pipe or, when dumping to | |
455 | a tape drive, if the tape drive is capable of writing variable length blocks. | |
456 | You will need at least the 0.4b34 version of | |
457 | .B restore | |
458 | in order to extract compressed tapes. Tapes written using compression will not | |
459 | be compatible with the BSD tape format. | |
460 | .TP | |
153f9a83 SP |
461 | .BI \-z "compression level" |
462 | Compress every block to be written on the tape using zlib library. This option | |
463 | will work only when dumping to a file or pipe or, when dumping to a tape drive, | |
464 | if the tape drive is capable of writing variable length blocks. You will need | |
465 | at least the 0.4b22 version of | |
466 | .B restore | |
467 | in order to extract compressed tapes. Tapes written using compression will not | |
468 | be compatible with the BSD tape format. The (optional) parameter specifies the | |
469 | compression level zlib will use. The default compression level is 2. If the | |
470 | optional parameter is specified, there should be no white space between the | |
471 | option letter and the parameter. | |
472 | .PP | |
473 | .B Dump | |
474 | requires operator intervention on these conditions: end of tape, end of dump, | |
475 | tape write error, tape open error or disk read error (if there is more than a | |
476 | threshold of nr errors). In addition to alerting all operators implied by the | |
477 | .B \-n | |
1227625a | 478 | key, |
153f9a83 SP |
479 | .B dump |
480 | interacts with the operator on dump's control terminal at times when | |
481 | .B dump | |
482 | can no longer proceed, or if something is grossly wrong. All questions | |
483 | .B dump | |
1227625a | 484 | poses |
153f9a83 SP |
485 | .I must |
486 | be answered by typing \*(lqyes\*(rq or \*(lqno\*(rq, appropriately. | |
487 | .PP | |
1227625a | 488 | Since making a dump involves a lot of time and effort for full dumps, |
153f9a83 SP |
489 | .B dump |
490 | checkpoints itself at the start of each tape volume. If writing that volume | |
491 | fails for some reason, | |
492 | .B dump | |
493 | will, with operator permission, restart itself from the checkpoint after the | |
494 | old tape has been rewound and removed, and a new tape has been mounted. | |
495 | .PP | |
496 | .B Dump | |
497 | tells the operator what is going on at periodic intervals, including usually | |
498 | low estimates of the number of blocks to write, the number of tapes it will | |
499 | take, the time to completion, and the time to the tape change. The output is | |
500 | verbose, so that others know that the terminal controlling | |
501 | .B dump | |
502 | is busy, and will be for some time. | |
503 | .PP | |
504 | In the event of a catastrophic disk event, the time required to restore all the | |
505 | necessary backup tapes or files to disk can be kept to a minimum by staggering | |
506 | the incremental dumps. An efficient method of staggering incremental dumps to | |
507 | minimize the number of tapes follows: | |
508 | .IP \(em | |
1227625a | 509 | Always start with a level 0 backup, for example: |
153f9a83 SP |
510 | .RS 14 |
511 | .B /sbin/dump -0u -f /dev/st0 /usr/src | |
512 | .RE | |
513 | .IP | |
1227625a SP |
514 | This should be done at set intervals, say once a month or once every two months, |
515 | and on a set of fresh tapes that is saved forever. | |
153f9a83 SP |
516 | .IP \(em |
517 | After a level 0, dumps of active file systems are taken on a daily basis, using | |
518 | a modified Tower of Hanoi algorithm, with this sequence of dump levels: | |
519 | .RS 14 | |
520 | .B 3 2 5 4 7 6 9 8 9 9 ... | |
521 | .RE | |
522 | .IP | |
523 | For the daily dumps, it should be possible to use a fixed number of tapes for | |
524 | each day, used on a weekly basis. Each week, a level 1 dump is taken, and the | |
525 | daily Hanoi sequence repeats beginning with 3. For weekly dumps, another fixed | |
526 | set of tapes per dumped file system is used, also on a cyclical basis. | |
527 | .PP | |
528 | After several months or so, the daily and weekly tapes should get rotated out | |
529 | of the dump cycle and fresh tapes brought in. | |
b79d20f1 SP |
530 | .PP |
531 | (The 4.3BSD option syntax is implemented for backward compatibility but is not | |
532 | documented here.) | |
153f9a83 SP |
533 | .SH ENVIRONMENT |
534 | .TP | |
535 | .B TAPE | |
536 | If no | |
537 | .B \-f | |
538 | option was specified, | |
539 | .B dump | |
b45f51d6 | 540 | will use the device specified via |
153f9a83 | 541 | .B TAPE |
b45f51d6 | 542 | as the dump device. |
153f9a83 | 543 | .B TAPE |
b45f51d6 | 544 | may be of the form |
153f9a83 SP |
545 | .IR tapename , |
546 | .IR host:tapename , | |
b45f51d6 | 547 | or |
153f9a83 SP |
548 | .IR user@host:tapename . |
549 | .TP | |
550 | .B RMT | |
b45f51d6 | 551 | The environment variable |
153f9a83 | 552 | .B RMT |
b45f51d6 | 553 | will be used to determine the pathname of the remote |
153f9a83 | 554 | .BR rmt (8) |
b45f51d6 | 555 | program. |
153f9a83 SP |
556 | .TP |
557 | .B RSH | |
558 | .B Dump | |
559 | uses the contents of this variable to determine the name of the remote shell | |
560 | command to use when doing remote backups (rsh, ssh etc.). If this variable is | |
561 | not set, | |
562 | .BR rcmd (3) | |
0c62667d | 563 | will be used, but only root will be able to do remote backups. |
153f9a83 SP |
564 | .SH FILES |
565 | .TP | |
566 | .I /dev/st0 | |
1227625a | 567 | default tape unit to dump to |
153f9a83 SP |
568 | .TP |
569 | .I __DUMPDATES__ | |
1227625a | 570 | dump date records |
153f9a83 SP |
571 | .TP |
572 | .I /etc/fstab | |
1227625a | 573 | dump table: file systems and frequency |
153f9a83 | 574 | .TP |
a8a6a503 SP |
575 | .I /etc/mtab |
576 | dump table: mounted file systems | |
577 | .TP | |
153f9a83 | 578 | .I /etc/group |
1227625a | 579 | to find group |
153f9a83 SP |
580 | .I operator |
581 | .SH SEE ALSO | |
582 | .BR fstab (5), | |
583 | .BR restore (8), | |
584 | .BR rmt (8) | |
585 | .SH DIAGNOSTICS | |
1227625a | 586 | Many, and verbose. |
3458b64d SP |
587 | .SH COMPATIBILITY |
588 | The format of the | |
589 | .I __DUMPDATES__ | |
590 | file has changed in release 0.4b34, however, the file will be read | |
591 | correctly with either pre-0.4b34 or 0.4b34 and later versions of | |
592 | .B dump | |
593 | provided that the machine on which | |
594 | .B dump | |
595 | is run did not change timezones (which should be a fairly rare occurence). | |
153f9a83 SP |
596 | .SH EXIT STATUS |
597 | .B Dump | |
598 | exits with zero status on success. Startup errors are indicated with an exit | |
599 | code of 1; abnormal termination is indicated with an exit code of 3. | |
600 | .SH BUGS | |
601 | It might be considered a bug that this version of dump can only handle ext2/3 | |
ddd2ef55 | 602 | filesystems. Specifically, it does not work with FAT filesystems. |
153f9a83 SP |
603 | .PP |
604 | Fewer than 32 read errors (change this with | |
605 | .BR \-I ) | |
606 | on the filesystem are ignored. If noticing read errors is important, the output | |
607 | from dump can be parsed to look for lines that contain the text 'read error'. | |
608 | .PP | |
aa1b1e7f | 609 | When a read error occurs, |
153f9a83 | 610 | .B dump |
aa1b1e7f | 611 | prints out the corresponding physical disk block and sector number and the |
153f9a83 SP |
612 | ext2/3 logical block number. It doesn't print out the corresponing file name or |
613 | even the inode number. The user has to use | |
614 | .BR debugfs (8), | |
aa1b1e7f | 615 | commands |
153f9a83 | 616 | .B ncheck |
aa1b1e7f | 617 | and |
153f9a83 | 618 | .B icheck |
aa1b1e7f | 619 | to translate the |
153f9a83 SP |
620 | .B ext2blk |
621 | number printed out by | |
622 | .B dump | |
623 | into an inode number, then into a file name. | |
624 | .PP | |
625 | Each reel requires a new process, so parent processes for reels already written | |
626 | just hang around until the entire tape is written. | |
627 | .PP | |
e7850aac | 628 | The estimated number of tapes is not correct if compression is on. |
153f9a83 | 629 | .PP |
1227625a | 630 | It would be nice if |
153f9a83 SP |
631 | .B dump |
632 | knew about the dump sequence, kept track of the tapes scribbled on, told the | |
633 | operator which tape to mount when, and provided more assistance for the | |
634 | operator running | |
635 | .BR restore . | |
636 | .PP | |
637 | .B Dump | |
638 | cannot do remote backups without being run as root, due to its security history. | |
639 | Presently, it works if you set it setuid (like it used to be), but this might | |
640 | constitute a security risk. Note that you can set | |
641 | .B RSH | |
642 | to use a remote shell program instead. | |
643 | .SH AUTHOR | |
8d4197bb | 644 | The |
153f9a83 SP |
645 | .B dump/restore |
646 | backup suite was ported to Linux's Second Extended File System by Remy Card | |
647 | <card@Linux.EU.Org>. He maintained the initial versions of | |
648 | .B dump | |
649 | (up and including 0.4b4, released in january 1997). | |
650 | .PP | |
651 | Starting with 0.4b5, the new maintainer is Stelian Pop <stelian@popies.net>. | |
652 | .SH AVAILABILITY | |
8d4197bb | 653 | The |
153f9a83 SP |
654 | .B dump/restore |
655 | backup suite is available from <http://dump.sourceforge.net> | |
656 | .SH HISTORY | |
1227625a | 657 | A |
153f9a83 | 658 | .B dump |
b45f51d6 | 659 | command appeared in |
153f9a83 | 660 | .B Version 6 AT&T UNIX. |