source: branches/2.2.6/mondo-doc/mondoarchive.8 @ 1948

Last change on this file since 1948 was 1948, checked in by bruno, 10 years ago
  • Adds OBDR support (use_obdr field in bkpinfo added, -o option changed to mean OBDR - LILO not usable anyway as a bootloader for ISO images)
  • Property svn:keywords set to Id
File size: 14.2 KB
Line 
1.\" This is free documentation; you can redistribute it and/or
2.\" modify it under the terms of the GNU General Public License as
3.\" published by the Free Software Foundation; either version 2 of
4.\" the License, or (at your option) any later version.
5.\"
6.\" The GNU General Public License's references to "object code"
7.\" and "executables" are to be interpreted as the output of any
8.\" document formatting or typesetting system, including
9.\" intermediate and printed output.
10.\"
11.\" This manual is distributed in the hope that it will be useful,
12.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
13.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14.\" GNU General Public License for more details.
15.\"
16.\" You should have received a copy of the GNU General Public
17.\" License along with this manual; if not, write to the Free
18.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
19.\" USA.
20.\"
21.TH mondoarchive 8 "PBDATE" "Mondo Rescue PBVER-rPBVER"
22
23.SH NAME
24mondoarchive \- a backup / disaster\-recovery tool.
25
26.SH SYNOPSIS
27.B mondoarchive -O
28[
29.I options
30] : backup your PC
31.br
32.B mondoarchive -V
33[
34.I options
35] : verify your backup
36
37.SH DESCRIPTION
38.PP
39.I mondoarchive
40backs up a subset of your files, your entire filesystem, or even images of
41non-Linux filesystems to CD's, tape, ISO images or an NFS mount. In the event of
42catastrophic data loss, you will be able to restore everything, taking a PC from
43bare metal to its original state if necessary.
44
45.pp
46With
47.BR \-O ,
48it backs up your filesystem to CD, tape, ISO images or NFS share. Boot media
49or a special boot CD will be created to allow you to restore from bare metal if
50necessary.
51
52.pp
53With
54.BR \-V ,
55it verifies the backup against the live filesystem. This option may be used in
56combination with
57.BR \-O
58to verify a backup after its creation, or on its own to see how much the live
59filesystem has changed since the backup was made.
60
61.pp
62Call mondoarchive
63.BR without
64.BR flags
65to make it auto-detect as many settings as possible, ask you politely for the
66rest, and then backup and verify your OS or a subset thereof.
67
68.pp
69To restore data, either run
70.I mondorestore
71from the command line or boot from the emergency media generated during
72the backup process. The latter will come in handy if a gremlin wipes your hard
73disk.
74
75.SH BACKUP MEDIA
76.TP 13
77You must specify one of the following:-
78
79.TP
80.BI "-c " speed
81Use CD-R drive as backup device and its (write-once) disks as backup media.
82
83.TP
84.BI "-w " speed
85Use CD-RW drive as backup device and its (write/rewrite) disks as backup media.
86Mondo will wipe media before writing to them.
87
88.TP
89.BI "-r "
90Use DVD drive as backup device and its disks as backup media. Growisofs decides
91on the best speed for your drive. Note that calling mondoarchive
92.B using sudo when writing to DVDs will fail
93because growisofs does not support this - see the growisofs manpage for
94details.
95
96.TP
97.BI "-C " speed
98Use CD-R drive as a streaming device, almost like a tape streamer. Use
99write-once disks as backup media.
100.B Experimental.
101
102.TP
103.BI "-p " prefix
104Use
105.B prefix
106to generate the name of your ISO images.
107By default, mondoarchive names images mondorescue-1.iso, mondorescue-2.iso, ...
108Using
109.B -p machine
110will name your images machine-1.iso, machine-2.iso, ...
111
112.TP
113.BI "-i "
114Use ISO files (CD images) as backup media. This is good for backing up your
115system to a spare hard drive. The
116.B -n
117switch is a wiser choice if you plan to restore from a remote filesystem.
118
119.TP
120.BI "-n " mount
121Use files residing on NFS partition as backup media.
122.I mount
123is the remote mount-point, e.g. '192.168.1.3:/home/nfs'
124for my file server. Please mount it before backing up/verifying.
125
126.TP
127.BI "-t "
128Use tape streamer as backup device and its tapes as backup media.
129
130.TP
131.BI "-U "
132Use a generic USB device as backup device. Use this if you want to write
133your backup to a USB key or USB disk, which will be make bootable.
134The USB device should be attached to the system ir order for this to work and
135its device name passed to the
136.BR \-d
137option.
138.B WARNING: All the data on the related device will be removed.
139
140.TP
141.BI "-u "
142Use a generic streaming device as backup device. Use this if you want to write
143your backup to a device that is not directly support by mondoarchive. This will
144send the data directly to a raw device.
145.B For experienced users only.
146
147.SH MAJOR OPTIONS
148.TP 13
149.BI "-D "
150Make a differential backup: examine the filesystem and find which files have
151changed since the last full backup was carried out. Backup only those files.
152
153.TP
154.BI "-E " "\*(lqpath ...\*(rq"
155Exclude path(s) from backup. The paths should be separated with a whitespace.
156Note that mondo automatically excludes removable media (/mnt/floppy,
157/mnt/cdrom, /proc, /sys, /tmp). For example, if you are backing up to an NFS mount but you
158do not want to include the contents of the mount in a backup, exclude your
159local mount-point with this switch. It will also work with partitions, e.g.
160/dev/sdd4 if you have a peculiar SCSI zip drive which insists on showing up in
161the mountlist. NB: If you exclude /dev/sdd4 then the /dev entry itself will
162still be backed up, even though the mountlist entry will be suppressed.
163N.B.: If you specify a directory with a final / its content will be archived so it won't do what you expect.
164
165.TP
166.BI "-I " "\*(lqpath ...\*(rq"
167Include paths(s) in backup. The default backup path is \*(lq/\*(rq but you may
168specify alternatives, e.g. -I \*(lq/home /etc\*(rq to override that.
169
170.TP
171.BI "-J " "file"
172Specify an explicit list of files and directories to include in a plain text file, one item
173(file or directory) per line. Beware that directories placed in that file are not managed recursively contrary to what is done with the -I option.
174
175.TP
176.BI "-N"
177Exclude all mounted network filesystems. This currently means NFS, SMB, Coda, MVFS, AFS
178OCFS and Netware. In other words, only backup the local hard disk(s).
179
180.TP
181.BI "-d " "dev|dir"
182Specify the backup device (CD/tape/USB) or directory (NFS/ISO). For CD-R[W] drives,
183this is the SCSI node where the drive may be found, e.g. '0,1,0'. For tape
184users, this is the tape streamers /dev entry, e.g. '/dev/st0'. For USB users,
185this is the device name of your key or external disk. For ISO users,
186this is the directory where the ISO images are stored. For NFS users, this is
187the directory within the NFS mount where the backups are stored. The default
188for ISO and NFS is '/root/images/mondo'.
189
190.TP
191.BI "-g "
192GUI mode. Without this switch, the screen output of mondoarchive is suitable
193for processing by an 'expect' wrapper, enabling the user to backup nightly via
194a cron job. However, if you want to run this program with an attractive but
195non-cron-friendly interface then use '-g'.
196
197.TP
198.BI "-k " "path"
199Path of user's kernel. If you are a Debian or Gentoo user then specify
200.B -k FAILSAFE
201as your kernel. Otherwise, you will rarely need this option.
202
203.TP
204.BI "-m "
205Manual (not self-retracting) CD trays are often found on laptops. If you are
206a laptop user, your CD burner has BurnProof technology or you experience
207problems with mondo then please call mondoarchive with this switch.
208
209.TP
210.BI "-o "
211Use OBDR (One Button Disaster Recovery) type of tapes.
212By default, tapes are not bootable. With this flag, tape will be made bootable
213following the OBDR format.
214
215.TP
216.BI "-s " "size"
217How much can each of your backup media hold? You may use 'm' and 'g' on the end
218of the number, e.g. '700m' for an extra-large CD-R. You no longer need to
219specify the size of your cartridges if you are backing up to tape.
220
221.TP
222.BI "-x " "'dev ...'"
223Specify non-Linux partitions which you want to backup, e.g. NTFS or BeOS.
224
225
226.SH MINOR OPTIONS
227.TP 13
228.BI "-[0-9] "
229Specify the compression level. Default is 3. No compression is 0.
230
231.TP
232.BI "-A " "command"
233This command will be called after each CD/NFS/ISO file is written. It is useful
234if you want to do something with an ISO after creating it, e.g. write it to a
235CD burner using a non-standard command.
236.B -A
237understands two tokens - _ISO_ and _CD#_ - which will be translated into the
238ISO's filename and its index number (1, 2, ...) respectively. So, you could use
239.I -A 'foobackup _ISO_; rm -f _ISO_'
240to feed each ISO to some magical new backup tool.
241
242.TP
243.BI "-B " "command"
244This command will be called before each CD/NFS/ISO file is written. See
245.B -A
246for more information.
247
248.TP
249.BI "-H "
250When you boot from the tape/CD, your hard drive will be wiped and the archives
251will be restored. Your decision to boot from the tape/CD will be taken as
252consent. No further permission will be sought.
253.B Use with caution.
254
255.TP
256.BI "-L "
257Use lzo, a fast compression engine, instead of bzip2. You may find lzo on
258Mondo's website or via FreshMeat. WARNING! Some versions of LZO are unstable.
259
260.TP
261.BI "-G "
262Use gzip, the standard and quicker Linux compression engine, instead of bzip2.
263
264.TP
265.BI "-R "
266EXPERIMENTAL. Do not use in mission-critical environments. Star is an alternative to afio. Mondo now supports POSIX ACLs and extended attributes, so -R is essentially redundant for now.
267
268.TP
269.BI "-P " "tarball"
270Post-nuke tarball. If you boot into Nuke Mode and everything is restored
271successfully then the
272.I post-nuke
273script will be sought and executed if found. This is useful for post-restore
274customization. It is assumed that the tarball (.tar.gz format) will contain not
275just the
276.I post-nuke
277script (or binary, or whatever it is) but also any files it requires.
278
279.TP
280.BI "-S " "path"
281Specify the full pathname of the scratchdir, the directory where ISO images are built before being
282archived. If you have plenty of RAM and want to use a ramdisk for scratch
283space, specify its path here.
284
285.TP
286.BI "-T " "path"
287Specify the full pathname of the tempdir, the directory where temporary files (other than ISO images
288being assembled) are stored. See
289.B -S
290
291.TP
292.BI "-W "
293Don't make your backup self-booting. This is a really bad idea, IMO. Don't do
294this unless you have really great boot disks in your hand and you are an anally
295retentive SOB who can't wait 2 minutes for Mindi to run in the background. If
296you use -W then you'd better know what the hell you're doing, okay?
297
298.TP
299.BI "-b "
300Specify the internal block size used by the tape drive. This is usually 32K but
301some drives just don't like that. They should but they don't. That's what
302happens when tape drive vendors don't talk to kernel driver writers. Try 512 or
30316384.
304
305.TP
306.BI "-e "
307Don't eject the CD or tape when backing up or restoring... unless cdrecord
308insists on it. If it does, well, tough. Sorry. :)
309
310.TP
311.BI "-f " "device"
312Specify the drive on which your Master Boot Record lives. Usually, this is
313discovered automatically.
314
315.TP
316.BI "-l " "GRUB|LILO|ELILO|RAW"
317Specify the boot loader. By default, your Master Boot Record is examined and
318the boot loader can usually be discovered. If you specify RAW then the MBR will
319be backed up and restored byte-for-byte without any analysis. It is likely that
320you will also need to specify the boot device with -f <dev>. ELILO is mandatory
321for IA64 machines.
322
323.TP
324.BI "-Q "
325Give more detailed information about the boot loader.
326
327.TP
328.BI "-K " "loglevel"
329Specify the loglevel. Use 99 for full debug. Standard debug level is 4.
330
331.TP
332.BI "-z "
333Use extended attributes and acl for each file and store them in the backup media. Use this option if you use SElinux e.g. but it will slow down backup and restore time of course.
334
335
336.SH DIAGNOSTICS
337Mondo generates one additional, and extremely important file:
338.BI /var/log/mondoarchive.log.
339When seeking technical support, attach this file to your email.
340
341
342
343.SH FILES
344.IR /var/log/mondoarchive.log
345This log contains important information required to analyse mondoarchive
346problem reports. Did I already said that it's highly recommended to send this file with
347support questions.
348
349.SH NOTES
350A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren, Cafeole, Randy Delphs,
351Stan Benoit, and Hugo Rabson) may be found at
352.I http://www.mondorescue.org/docs.shtml
353- or in
354.I /usr/share/doc/mondo-x.xx
355on your hard drive.
356
357.SH BUGS
358It is recommend that your system has more than 64 MB ram. SCSI device order
359change with nuke can have unexpected results. It is recommended you use expert
360mode with drastic hardware reconfigurations.
361
362.SH EXAMPLES
363
364.BI ISO:
365Backup to a directory; note that /mnt/foo's contents will be backed up except
366for its ISO's unless you exclude it, as follows:-
367.br
368.I "mondoarchive -Oi -d /mnt/foo -E '/mnt/foo /mnt/foo2' -p \`hostname\`-\`date +%Y-%m-%d\`"
369
370Backup to ISO's non-interactively, e.g. as a job running in /etc/cron.daily:
371.br
372.I "mkdir -p /bkp/\`date +%A\`; mondoarchive -Oi -9 -d /bkp/\`date +%A\` -E /bkp"
373
374.BI DVD:
375Backup PC using DVD Media:
376.br
377.I "mondoarchive -OVr -d /dev/scd0 -gF -s 4480m"
378
379.BI TAPE:
380Backup to tape, using lzo compression (WARNING - can be unstable):
381.br
382.I "mondoarchive -Ot -d /dev/st0 -L"
383
384Verify existing tape backup which was made with lzo compression:-
385.br
386.I "mondoarchive -Vt -d /dev/st0 -L -g"
387
388Backup to tape, using max compression:
389.br
390.I "mondoarchive -Ot -9 -d /dev/st0 "
391
392.BI CD-R:
393Backup to 700MB CD-R disks using a 16x CD burner:
394.br
395.I "mondoarchive -Oc 16 -s 700m -g"
396
397Verify existing CD-R or CD-RW backup (works for either):-
398.br
399.I "mondoarchive -Vc 16"
400
401.BI CD-RW:
402Backup to 650MB CD-RW disks using a 4x CD ReWriter:
403.br
404.I "mondoarchive -Ow 4"
405
406Backup just your /home and /etc directory to 650MB CD-RW disks using a 4x CD
407ReWriter:
408.br
409.I "mondoarchive -Ow 4 -I \*(lq/home /etc\*(rq"
410
411.BI NFS:
412Backup to an NFS mount:
413.br
414.I "mondoarchive -On 192.168.1.2:/home/nfs -d /Monday -E /mnt/nfs"
415
416Verify existing NFS backup:-
417.br
418.I "mondoarchive -Vn 192.168.1.2:/home/nfs -d /Monday"
419
420.BI USB:
421Backup to your USB key, using gzip compression:
422.br
423.I "mondoarchive -OU -d /dev/sda -G"
424
425.BI RAID:
426Backup PC to a Software Raid mount point, iso size 700mb:
427.br
428.I "mondoarchive -O -s 700m -d /mnt/raid"
429
430
431.SH "SEE ALSO"
432afio(1), bzip2(1), find(1), mindi(8), mondorestore(8).
433.SH AUTHORS
434Bruno Cornec (lead-development)
435.I "bruno_at_mondorescue.org"
436.br
437Andree Leidenfrost (co-developper)
438.I "aleidenf_at_bigpond.net.au"
439.br
440.SH ORIGINAL AUTHORS
441Hugo Rabson (original author)
442.I "hugo.rabson_at_mondorescue.org"
443.br
444Jesse Keating (original RPM packager)
445.I "hosting_at_j2solutions.net"
446.br
447Stan Benoit (testing)
448.I "troff_at_nakedsoul.org"
449.br
450Mikael Hultgren (docs)
451.I "mikael_hultgren_at_gmx.net"
452.br
453See mailing list at http://www.mondorescue.org for technical support.
454.
Note: See TracBrowser for help on using the repository browser.