]>
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. | |
13 | .\" 3. All advertising materials mentioning features or use of this software | |
ddd2ef55 | 14 | .\" must display the following acknowledgement: |
1227625a SP |
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. | |
20 | .\" | |
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 | |
31 | .\" SUCH DAMAGE. | |
32 | .\" | |
aa1b1e7f | 33 | .\" $Id: dump.8.in,v 1.42 2002/06/10 14:05:00 stelian Exp $ |
1227625a | 34 | .\" |
8d4197bb | 35 | .Dd __DATE__ |
1227625a | 36 | .Dt DUMP 8 |
df9ae507 | 37 | .Os "dump __VERSION__" |
1227625a SP |
38 | .Sh NAME |
39 | .Nm dump | |
ddd2ef55 | 40 | .Nd ext2 filesystem backup |
1227625a SP |
41 | .Sh SYNOPSIS |
42 | .Nm dump | |
fceb4f25 | 43 | .Op Fl 0123456789ackMnqSuv |
e51470bf | 44 | .Op Fl A Ar file |
1227625a SP |
45 | .Op Fl B Ar records |
46 | .Op Fl b Ar blocksize | |
47 | .Op Fl d Ar density | |
6d732772 SP |
48 | .Op Fl e Ar inode numbers |
49 | .Op Fl E Ar file | |
1227625a | 50 | .Op Fl f Ar file |
0d7af9c5 | 51 | .Op Fl F Ar script |
1227625a | 52 | .Op Fl h Ar level |
b82d31dc | 53 | .Op Fl I Ar nr errors |
88ef261e | 54 | .Op Fl j Ar compression level |
b45f51d6 | 55 | .Op Fl L Ar label |
35b24fb7 | 56 | .Op Fl Q Ar file |
1227625a SP |
57 | .Op Fl s Ar feet |
58 | .Op Fl T Ar date | |
ce7243e0 | 59 | .Op Fl z Ar compression level |
a94ecd11 | 60 | .Ar files-to-dump |
1227625a SP |
61 | .Nm dump |
62 | .Op Fl W Li \&| Fl w | |
63 | .Pp | |
8d4197bb | 64 | .in |
1227625a SP |
65 | (The |
66 | .Bx 4.3 | |
ddd2ef55 | 67 | option syntax is implemented for backward compatibility but |
1227625a SP |
68 | is not documented here.) |
69 | .Sh DESCRIPTION | |
70 | .Nm Dump | |
71 | examines files | |
ddd2ef55 | 72 | on an ext2 filesystem |
1227625a SP |
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 | |
77 | .Fl f | |
78 | option below for doing remote backups). | |
79 | A dump that is larger than the output medium is broken into | |
80 | multiple volumes. | |
81 | On most media the size is determined by writing until an | |
4f4eee3d | 82 | end-of-media indication is returned. |
b45f51d6 | 83 | .Pp |
1227625a | 84 | On media that cannot reliably return an end-of-media indication |
4f4eee3d SP |
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. | |
1227625a SP |
88 | By default, the same output file name is used for each volume |
89 | after prompting the operator to change media. | |
90 | .Pp | |
a94ecd11 | 91 | .Ar files-to-dump |
79e31865 | 92 | is either a mountpoint of a filesystem |
a94ecd11 SP |
93 | or a list of files and directories to be backed up as a subset of a |
94 | filesystem. | |
79e31865 SP |
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: | |
98 | .Fl u | |
a94ecd11 SP |
99 | is not allowed, the only dump level that is supported is |
100 | .Fl 0 | |
101 | and all the files and directories must reside on the same filesystem. | |
79e31865 | 102 | .Pp |
1227625a | 103 | The following options are supported by |
b45f51d6 | 104 | .Nm Ns : |
1227625a SP |
105 | .Bl -tag -width Ds |
106 | .It Fl 0\-9 | |
107 | Dump levels. | |
108 | A level 0, full backup, | |
109 | guarantees the entire file system is copied | |
110 | (but see also the | |
111 | .Fl h | |
112 | option below). | |
113 | A level number above 0, | |
114 | incremental backup, | |
ddd2ef55 SP |
115 | tells |
116 | .Nm dump | |
117 | to | |
1227625a | 118 | copy all files new or modified since the |
ae58c8da | 119 | last dump of a lower level. |
ddd2ef55 | 120 | The default level is 9. |
b45f51d6 SP |
121 | .It Fl a |
122 | .Dq auto-size . | |
4f4eee3d SP |
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). | |
e51470bf SP |
129 | .It Fl A Ar archive_file |
130 | Archive a dump table-of-contents in the | |
131 | specified | |
132 | .Ar archive_file | |
133 | to be used by | |
134 | .Xr restore 8 | |
135 | to determine whether a file is in the dump file that is being restored. | |
1227625a SP |
136 | .It Fl b Ar blocksize |
137 | The number of kilobytes per dump record. | |
ddd2ef55 | 138 | Since the IO system slices all requests into chunks of MAXBSIZE |
aca7d867 | 139 | (typically 64kB), it is not possible to use a larger blocksize |
ddd2ef55 SP |
140 | without having problems later with |
141 | .Xr restore 8 . | |
142 | Therefore | |
143 | .Nm dump | |
144 | will constrain writes to MAXBSIZE. | |
65bceb9b | 145 | The default blocksize is 10. |
e51470bf | 146 | .It Fl B Ar records |
27305a35 SP |
147 | The number of 1 kB blocks per volume. Not normally required, as |
148 | .Nm | |
149 | can detect end-of-media. When the specified size is reached, | |
150 | .Nm | |
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 | |
154 | output per volume. | |
1227625a | 155 | .It Fl c |
b45f51d6 | 156 | Change the defaults for use with a cartridge tape drive, with a density |
4f4eee3d SP |
157 | of 8000 bpi, and a length of 1700 feet. Specifying a cartridge drive |
158 | overrides the end-of-media detection. | |
e51470bf SP |
159 | .It Fl d Ar density |
160 | Set tape density to | |
161 | .Ar density . | |
162 | The default is 1600BPI. Specifying a tape density overrides the | |
163 | end-of-media detection. | |
6d732772 | 164 | .It Fl e Ar inodes |
20c345aa | 165 | Exclude |
6d732772 SP |
166 | .Ar inodes |
167 | from the dump. The | |
168 | .Ar inodes | |
169 | parameter is a comma separated list of inode numbers (you can use | |
20c345aa SP |
170 | .Ar stat |
171 | to find the inode number for a file or directory). | |
6d732772 SP |
172 | .It Fl E Ar file |
173 | Read list of inodes to be excluded from the dump from the text file | |
174 | .Ar file . | |
175 | The file | |
176 | .Ar file | |
177 | should be an ordinary file containing inode numbers separated by | |
178 | newlines. | |
1227625a SP |
179 | .It Fl f Ar file |
180 | Write the backup to | |
181 | .Ar file ; | |
182 | .Ar file | |
183 | may be a special device file | |
184 | like | |
ddd2ef55 | 185 | .Pa /dev/st0 |
1227625a SP |
186 | (a tape drive), |
187 | .Pa /dev/rsd1c | |
b45f51d6 | 188 | (a floppy disk drive), |
1227625a SP |
189 | an ordinary file, |
190 | or | |
191 | .Ql Fl | |
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 | |
197 | for media changes. | |
198 | If the name of the file is of the form | |
ddd2ef55 | 199 | .Dq host:file |
1227625a | 200 | or |
ddd2ef55 | 201 | .Dq user@host:file |
b45f51d6 | 202 | .Nm |
1227625a SP |
203 | writes to the named file on the remote host using |
204 | .Xr rmt 8 . | |
b45f51d6 SP |
205 | The default path name of the remote |
206 | .Xr rmt 8 | |
207 | program is | |
208 | .\" rmt path, is the path on the remote host | |
209 | .Pa /etc/rmt ; | |
210 | this can be overridden by the environment variable | |
211 | .Ev RMT . | |
0d7af9c5 | 212 | .It Fl F Ar script |
365a7c7c SP |
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 | |
ae81b200 SP |
216 | .Nm |
217 | should continue without asking the user to change the tape, 1 if | |
218 | .Nm | |
c534413c | 219 | should continue but ask the user to change the tape. |
ae81b200 SP |
220 | Any other exit code will cause |
221 | .Nm | |
222 | to abort. | |
223 | For security reasons, | |
224 | .Nm | |
225 | reverts back to the real user ID and the real group ID before | |
226 | running the script. | |
e51470bf SP |
227 | .It Fl h Ar level |
228 | Honor the user | |
229 | .Dq nodump | |
230 | flag | |
231 | .Dp Dv UF_NODUMP | |
232 | only for dumps at or above the given | |
233 | .Ar level . | |
234 | The default honor level is 1, | |
235 | so that incremental backups omit such files | |
236 | but full backups retain them. | |
b82d31dc SP |
237 | .It Fl I Ar nr errors |
238 | By default, | |
239 | .Nm | |
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 | |
243 | .Nm | |
244 | on an active filesystem where read errors simply indicate an | |
245 | inconsistency between the mapping and dumping passes. | |
88ef261e SP |
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 | |
a2caea8a SP |
254 | level is 2. If the optional parameter is specified, there should be no |
255 | white space between the option letter and the parameter. | |
b45f51d6 SP |
256 | .It Fl k |
257 | Use Kerberos authentication to talk to remote tape servers. (Only | |
258 | available if this option was enabled when | |
259 | .Nm | |
260 | was compiled.) | |
261 | .It Fl L Ar label | |
262 | The user-supplied text string | |
263 | .Ar label | |
264 | is placed into the dump header, where tools like | |
265 | .Xr restore 8 | |
266 | and | |
267 | .Xr file 1 | |
268 | can access it. | |
269 | Note that this label is limited | |
270 | to be at most LBLSIZE (currently 16) characters, which must include | |
271 | the terminating | |
272 | .Ql \e0 . | |
0cedbda5 SP |
273 | .It Fl m |
274 | If this flag is specified, | |
275 | .Nm | |
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, | |
279 | .Nm | |
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. | |
285 | .Pp | |
286 | Tapes written using such 'metadata only' inodes will not be compatible | |
287 | with the BSD tape format or older versions of | |
288 | .Nm restore. | |
dc7cb1e2 SP |
289 | .It Fl M |
290 | Enable the multi-volume feature. The name specified with | |
291 | .Fl f | |
292 | is treated as a prefix and | |
293 | .Nm | |
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. | |
1227625a SP |
297 | .It Fl n |
298 | Whenever | |
b45f51d6 | 299 | .Nm |
1227625a SP |
300 | requires operator attention, |
301 | notify all operators in the group | |
302 | .Dq operator | |
303 | by means similar to a | |
304 | .Xr wall 1 . | |
e084ba00 SP |
305 | .It Fl q |
306 | Make | |
307 | .Nm | |
308 | abort immediately whenever operator attention is required, | |
309 | without prompting in case of write errors, tape changes etc. | |
35b24fb7 SP |
310 | .It Fl Q Ar file |
311 | Enable the Quick File Access support. Tape positions for each | |
312 | inode are stored into the file | |
313 | .Ar 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. | |
b8f7cbe6 SP |
318 | .Pp |
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. | |
326 | .Pp | |
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. | |
103122b3 SP |
330 | .Pp |
331 | This option can be used when dumping to local tapes (see above) | |
332 | or to local files. | |
1227625a | 333 | .It Fl s Ar feet |
4f4eee3d | 334 | Attempt to calculate the amount of tape needed at a particular density. |
1227625a | 335 | If this amount is exceeded, |
b45f51d6 | 336 | .Nm |
1227625a SP |
337 | prompts for a new tape. |
338 | It is recommended to be a bit conservative on this option. | |
4f4eee3d SP |
339 | The default tape length is 2300 feet. Specifying the tape size |
340 | overrides end-of-media detection. | |
1227625a | 341 | .ne 1i |
144a6db1 SP |
342 | .It Fl S |
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 | |
2e682895 | 346 | number of bytes it will take. This is useful |
144a6db1 SP |
347 | with incremental dumps to determine how many |
348 | volumes of media will be needed. | |
1227625a SP |
349 | .It Fl T Ar date |
350 | Use the specified date as the starting time for the dump | |
351 | instead of the time determined from looking in | |
8d4197bb | 352 | .Pa __DUMPDATES__ . |
ddd2ef55 SP |
353 | The format of |
354 | .Ar date | |
355 | is the same as that of | |
1227625a SP |
356 | .Xr ctime 3 . |
357 | This option is useful for automated dump scripts that wish to | |
358 | dump over a specific period of time. | |
359 | The | |
360 | .Fl T | |
361 | option is mutually exclusive from the | |
362 | .Fl u | |
363 | option. | |
364 | .It Fl u | |
365 | Update the file | |
8d4197bb | 366 | .Pa __DUMPDATES__ |
1227625a SP |
367 | after a successful dump. |
368 | The format of | |
8d4197bb | 369 | .Pa __DUMPDATES__ |
1227625a SP |
370 | is readable by people, consisting of one |
371 | free format record per line: | |
372 | filesystem name, | |
373 | increment level | |
374 | and | |
375 | .Xr ctime 3 | |
376 | format dump date. | |
377 | There may be only one entry per filesystem at each level. | |
378 | The file | |
8d4197bb | 379 | .Pa __DUMPDATES__ |
1227625a SP |
380 | may be edited to change any of the fields, |
381 | if necessary. | |
fceb4f25 SP |
382 | .It Fl v |
383 | The | |
384 | .Fl v | |
385 | (verbose) makes | |
386 | .Nm dump | |
387 | to print extra information which could be helpful in debug sessions. | |
1227625a SP |
388 | .It Fl W |
389 | .Nm Dump | |
390 | tells the operator what file systems need to be dumped. | |
391 | This information is gleaned from the files | |
8d4197bb | 392 | .Pa __DUMPDATES__ |
1227625a SP |
393 | and |
394 | .Pa /etc/fstab . | |
395 | The | |
396 | .Fl W | |
397 | option causes | |
b45f51d6 | 398 | .Nm |
51b01afe | 399 | to print out, for all file systems in |
8d4197bb | 400 | .Pa __DUMPDATES__ , |
51b01afe SP |
401 | and regognized file systems in |
402 | .Pa /etc/fstab . | |
1227625a | 403 | the most recent dump date and level, |
51b01afe | 404 | and highlights those that should be dumped. |
1227625a SP |
405 | If the |
406 | .Fl W | |
407 | option is set, all other options are ignored, and | |
b45f51d6 | 408 | .Nm |
1227625a SP |
409 | exits immediately. |
410 | .It Fl w | |
ddd2ef55 SP |
411 | Is like |
412 | .Fl W , | |
51b01afe SP |
413 | but prints only recognized filesystems in |
414 | .Pa /etc/fstab | |
415 | which need to be dumped. | |
ce7243e0 | 416 | .It Fl z Ar compression level |
52ed7d6e | 417 | Compress every block to be written on the tape using zlib library. This |
2b747532 SP |
418 | option will work only when dumping to a file or pipe or, when dumping |
419 | to a tape drive, if the tape drive is capable of writing variable | |
52ed7d6e SP |
420 | length blocks. You will need at least the 0.4b22 version of restore in |
421 | order to extract compressed tapes. Tapes written using compression will | |
ce7243e0 SP |
422 | not be compatible with the BSD tape format. The (optional) parameter |
423 | specifies the compression level zlib will use. The default compression | |
a2caea8a SP |
424 | level is 2. If the optional parameter is specified, there should be no |
425 | white space between the option letter and the parameter. | |
1227625a SP |
426 | .El |
427 | .Pp | |
428 | .Nm Dump | |
429 | requires operator intervention on these conditions: | |
430 | end of tape, | |
431 | end of dump, | |
432 | tape write error, | |
433 | tape open error or | |
b82d31dc | 434 | disk read error (if there is more than a threshold of nr errors). |
1227625a SP |
435 | In addition to alerting all operators implied by the |
436 | .Fl n | |
437 | key, | |
b45f51d6 | 438 | .Nm |
1227625a SP |
439 | interacts with the operator on |
440 | .Em dump's | |
441 | control terminal at times when | |
b45f51d6 | 442 | .Nm |
1227625a SP |
443 | can no longer proceed, |
444 | or if something is grossly wrong. | |
445 | All questions | |
b45f51d6 | 446 | .Nm |
1227625a SP |
447 | poses |
448 | .Em must | |
449 | be answered by typing | |
450 | .Dq yes | |
451 | or | |
452 | .Dq no , | |
453 | appropriately. | |
454 | .Pp | |
455 | Since making a dump involves a lot of time and effort for full dumps, | |
b45f51d6 | 456 | .Nm |
1227625a SP |
457 | checkpoints itself at the start of each tape volume. |
458 | If writing that volume fails for some reason, | |
b45f51d6 | 459 | .Nm |
1227625a SP |
460 | will, |
461 | with operator permission, | |
462 | restart itself from the checkpoint | |
463 | after the old tape has been rewound and removed, | |
464 | and a new tape has been mounted. | |
465 | .Pp | |
466 | .Nm Dump | |
467 | tells the operator what is going on at periodic intervals, | |
468 | including usually low estimates of the number of blocks to write, | |
469 | the number of tapes it will take, the time to completion, and | |
470 | the time to the tape change. | |
471 | The output is verbose, | |
472 | so that others know that the terminal | |
473 | controlling | |
b45f51d6 | 474 | .Nm |
1227625a SP |
475 | is busy, |
476 | and will be for some time. | |
477 | .Pp | |
478 | In the event of a catastrophic disk event, the time required | |
479 | to restore all the necessary backup tapes or files to disk | |
480 | can be kept to a minimum by staggering the incremental dumps. | |
481 | An efficient method of staggering incremental dumps | |
482 | to minimize the number of tapes follows: | |
483 | .Bl -bullet -offset indent | |
484 | .It | |
485 | Always start with a level 0 backup, for example: | |
486 | .Bd -literal -offset indent | |
8d4197bb | 487 | /sbin/dump -0u -f /dev/st0 /usr/src |
1227625a SP |
488 | .Ed |
489 | .Pp | |
490 | This should be done at set intervals, say once a month or once every two months, | |
491 | and on a set of fresh tapes that is saved forever. | |
492 | .It | |
493 | After a level 0, dumps of active file | |
494 | systems are taken on a daily basis, | |
495 | using a modified Tower of Hanoi algorithm, | |
496 | with this sequence of dump levels: | |
497 | .Bd -literal -offset indent | |
498 | 3 2 5 4 7 6 9 8 9 9 ... | |
499 | .Ed | |
500 | .Pp | |
501 | For the daily dumps, it should be possible to use a fixed number of tapes | |
502 | for each day, used on a weekly basis. | |
503 | Each week, a level 1 dump is taken, and | |
504 | the daily Hanoi sequence repeats beginning with 3. | |
505 | For weekly dumps, another fixed set of tapes per dumped file system is | |
506 | used, also on a cyclical basis. | |
507 | .El | |
508 | .Pp | |
509 | After several months or so, the daily and weekly tapes should get | |
510 | rotated out of the dump cycle and fresh tapes brought in. | |
b45f51d6 SP |
511 | .Sh ENVIRONMENT |
512 | .Bl -tag -width Fl | |
513 | .It Ev TAPE | |
514 | If no -f option was specified, | |
515 | .Nm | |
516 | will use the device specified via | |
517 | .Ev TAPE | |
518 | as the dump device. | |
519 | .Ev TAPE | |
520 | may be of the form | |
521 | .Qq tapename , | |
522 | .Qq host:tapename , | |
523 | or | |
524 | .Qq user@host:tapename . | |
525 | .It Ev RMT | |
526 | The environment variable | |
527 | .Ev RMT | |
528 | will be used to determine the pathname of the remote | |
529 | .Xr rmt 8 | |
530 | program. | |
0c62667d SP |
531 | .It Ev RSH |
532 | .Nm Dump | |
533 | uses the contents of this variable to determine the name of the | |
534 | remote shell command to use when doing remote backups (rsh, ssh etc.). | |
535 | If this variable is not set, | |
536 | .Xr rcmd 3 | |
537 | will be used, but only root will be able to do remote backups. | |
7ae7e903 | 538 | .El |
1227625a | 539 | .Sh FILES |
8d4197bb | 540 | .Bl -tag -width __DUMPDATES__ -compact |
ddd2ef55 | 541 | .It Pa /dev/st0 |
1227625a | 542 | default tape unit to dump to |
8d4197bb | 543 | .It Pa __DUMPDATES__ |
1227625a SP |
544 | dump date records |
545 | .It Pa /etc/fstab | |
546 | dump table: file systems and frequency | |
547 | .It Pa /etc/group | |
548 | to find group | |
549 | .Em operator | |
550 | .El | |
551 | .Sh SEE ALSO | |
b45f51d6 | 552 | .Xr fstab 5 , |
1227625a | 553 | .Xr restore 8 , |
b45f51d6 | 554 | .Xr rmt 8 |
1227625a SP |
555 | .Sh DIAGNOSTICS |
556 | Many, and verbose. | |
557 | .Pp | |
ddd2ef55 SP |
558 | .Nm Dump |
559 | exits with zero status on success. | |
1227625a SP |
560 | Startup errors are indicated with an exit code of 1; |
561 | abnormal termination is indicated with an exit code of 3. | |
562 | .Sh BUGS | |
ddd2ef55 SP |
563 | It might be considered a bug that this version of dump can only handle ext2 |
564 | filesystems. Specifically, it does not work with FAT filesystems. | |
565 | .Pp | |
b82d31dc SP |
566 | Fewer than 32 read errors (change this with -I) |
567 | on the filesystem are ignored. If noticing | |
ddd2ef55 SP |
568 | read errors is important, the output from dump can be parsed to look for lines |
569 | that contain the text 'read error'. | |
1227625a | 570 | .Pp |
aa1b1e7f SP |
571 | When a read error occurs, |
572 | .Nm | |
573 | prints out the corresponding physical disk block and sector number and the | |
574 | ext2 logical block number. | |
575 | It doesn't print out the corresponing file name or even the inode number. | |
576 | The user has to use | |
577 | .Xr debugfs 8 , | |
578 | commands | |
579 | .Pa ncheck | |
580 | and | |
581 | .Pa icheck | |
582 | to translate the | |
583 | .Pa ext2blk | |
584 | number printed out by dump into an inode number, then into a file name. | |
585 | .Pp | |
1227625a SP |
586 | Each reel requires a new process, so parent processes for |
587 | reels already written just hang around until the entire tape | |
588 | is written. | |
589 | .Pp | |
e7850aac SP |
590 | The estimated number of tapes is not correct if compression is on. |
591 | .Pp | |
1227625a | 592 | It would be nice if |
b45f51d6 | 593 | .Nm |
1227625a SP |
594 | knew about the dump sequence, |
595 | kept track of the tapes scribbled on, | |
596 | told the operator which tape to mount when, | |
597 | and provided more assistance | |
598 | for the operator running | |
599 | .Xr restore . | |
b45f51d6 SP |
600 | .Pp |
601 | .Nm Dump | |
602 | cannot do remote backups without being run as root, due to its | |
0c62667d | 603 | security history. |
b45f51d6 | 604 | Presently, it works if you set it setuid (like it used to be), but this |
0c62667d SP |
605 | might constitute a security risk. Note that you can set RSH to use |
606 | a remote shell program instead. | |
8d4197bb SP |
607 | .Sh AUTHOR |
608 | The | |
609 | .Nm dump/restore | |
7422942f | 610 | backup suite was ported to Linux's Second Extended File System |
8d4197bb SP |
611 | by Remy Card <card@Linux.EU.Org>. He maintained the initial versions |
612 | of dump (up and including 0.4b4, released in january 1997). | |
613 | .Pp | |
614 | Starting with 0.4b5, the new maintainer is Stelian Pop | |
615 | .br | |
11856e77 | 616 | <stelian@popies.net>. |
8d4197bb SP |
617 | .Sh AVAILABILITY |
618 | The | |
619 | .Nm dump/restore | |
7422942f | 620 | backup suite is available from |
01fb6bd5 SP |
621 | .br |
622 | http://dump.sourceforge.net | |
1227625a SP |
623 | .Sh HISTORY |
624 | A | |
b45f51d6 SP |
625 | .Nm |
626 | command appeared in | |
627 | .At v6 . |