source: branches/2.2.9/mondo-doc/mondoarchive.8 @ 2336

Last change on this file since 2336 was 2336, checked in by Bruno Cornec, 11 years ago
  • Precise the combined usage of -E and -I in mondoarchive (Case 4601017223)
  • Property svn:keywords set to Id
File size: 14.9 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-rPBREV"
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. If not mounted, mondoarchive will do it for you. So nice ;-)
125If your NFS server only accept write from a backup user, you may specify it with the syntax:
126.B user@machine:/mount/path
127and mondoarchive will try to do its best to support it.
128
129.TP
130.BI "-t "
131Use tape streamer as backup device and its tapes as backup media.
132
133.TP
134.BI "-U "
135Use a generic USB device as backup device. Use this if you want to write
136your backup to a USB key or USB disk, which will be make bootable.
137The USB device should be attached to the system in order for this to work and
138its device name passed to the
139.BR \-d
140option. Do not use the partition name, but the raw device name (/dev/sda e.g.)
141.B WARNING: All the data on the related device will be removed.
142
143.TP
144.BI "-u "
145Use a generic streaming device as backup device. Use this if you want to write
146your backup to a device that is not directly support by mondoarchive. This will
147send the data directly to a raw device.
148.B For experienced users only.
149
150.SH MAJOR OPTIONS
151.TP 13
152.BI "-D "
153Make a differential backup: examine the filesystem and find which files have
154changed since the last full backup was carried out. Backup only those files.
155
156.TP
157.BI "-E " "\*(lqpath ...\*(rq"
158Exclude path(s) from backup. The paths should be separated with a whitespace and surrounded by quotes.
159This is the prefered and recommended option when doing partial archiving.
160Note that mondo automatically excludes removable media (/mnt/floppy,
161/mnt/cdrom, /proc, /sys, /tmp). For example, if you are backing up to an NFS mount but you
162do not want to include the contents of the mount in a backup, exclude your
163local mount-point with this switch. It will also work with partitions, e.g.
164/dev/sdd4 if you have a peculiar SCSI zip drive which insists on showing up in
165the mountlist. NB: If you exclude /dev/sdd4 then the /dev entry itself will
166still be backed up, even though the mountlist entry will be suppressed.
167N.B.: If you specify a directory with a final / its content will be archived so it won't do what you expect.
168You may also specify full disk device to this option as with -E \*(lq/dev/sda /dev/cciss/c0d0\*(rq
169
170.TP
171.BI "-I " "\*(lqpath ...\*(rq"
172Include paths(s) in backup. This option is mainly use to erform tests in order to reduce the time taken by the archiving operation.
173The default backup path is \*(lq/\*(rq but you may specify alternatives, e.g. -I \*(lq/home /etc\*(rq to override that.
174You may also specify full disk device to this option as with -I \*(lq/dev/sda /dev/cciss/c0d0\*(rq
175N.B.: When using the
176.BR \-I
177option with the
178.BR \-E
179option, the -E content should be subdirectories of those mentioned in the -I only, as -I takes precedence.
180
181.TP
182.BI "-J " "file"
183Specify an explicit list of files and directories to include in a plain text file, one item
184(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.
185
186.TP
187.BI "-N"
188Exclude all mounted network filesystems. This currently means NFS, SMB, Coda, MVFS, AFS
189OCFS and Netware. In other words, only backup the local hard disk(s).
190
191.TP
192.BI "-d " "dev|dir"
193Specify the backup device (CD/tape/USB) or directory (NFS/ISO). For CD-R[W] drives,
194this is the SCSI node where the drive may be found, e.g. '0,1,0'. For tape
195users, this is the tape streamers /dev entry, e.g. '/dev/st0'. For USB users,
196this is the device name of your key or external disk. For ISO users,
197this is the directory where the ISO images are stored. For NFS users, this is
198the directory within the NFS mount where the backups are stored. The default
199for ISO and NFS is '/var/cache/mondo'.
200
201.TP
202.BI "-g "
203GUI mode. Without this switch, the screen output of mondoarchive is suitable
204for processing by an 'expect' wrapper, enabling the user to backup nightly via
205a cron job. However, if you want to run this program with an attractive but
206non-cron-friendly interface then use '-g'.
207
208.TP
209.BI "-k " "path"
210Path of user's kernel. If you are a Debian (<3.0) or Gentoo (<1.4) user then specify
211.B -k FAILSAFE
212as your kernel. Otherwise, you will rarely need this option.
213
214.TP
215.BI "-m "
216Manual (not self-retracting) CD trays are often found on laptops. If you are
217a laptop user, your CD burner has BurnProof technology or you experience
218problems with mondo then please call mondoarchive with this switch.
219
220.TP
221.BI "-o "
222Use OBDR (One Button Disaster Recovery) type of tapes.
223By default, tapes are not bootable. With this flag, tape will be made bootable
224following the OBDR format.
225
226.TP
227.BI "-s " "size"
228How much can each of your backup media hold? You may use 'm' and 'g' on the end
229of the number, e.g. '700m' for an extra-large CD-R. You no longer need to
230specify the size of your cartridges if you are backing up to tape.
231
232.TP
233.BI "-x " "'dev ...'"
234Specify non-Linux partitions which you want to backup, e.g. NTFS or BeOS.
235
236
237.SH MINOR OPTIONS
238.TP 13
239.BI "-[0-9] "
240Specify the compression level. Default is 3. No compression is 0.
241
242.TP
243.BI "-A " "command"
244This command will be called after each CD/NFS/ISO file is written. It is useful
245if you want to do something with an ISO after creating it, e.g. write it to a
246CD burner using a non-standard command.
247.B -A
248understands two tokens - _ISO_ and _CD#_ - which will be translated into the
249ISO's filename and its index number (1, 2, ...) respectively. So, you could use
250.I -A 'foobackup _ISO_; rm -f _ISO_'
251to feed each ISO to some magical new backup tool.
252
253.TP
254.BI "-B " "command"
255This command will be called before each CD/NFS/ISO file is written. See
256.B -A
257for more information.
258
259.TP
260.BI "-H "
261When you boot from the tape/CD, your hard drive will be wiped and the archives
262will be restored. Your decision to boot from the tape/CD will be taken as
263consent. No further permission will be sought.
264.B Use with caution.
265
266.TP
267.BI "-L "
268Use lzo, a fast compression engine, instead of bzip2. You may find lzo on
269Mondo's website or via FreshMeat. WARNING! Some versions of LZO are unstable.
270
271.TP
272.BI "-G "
273Use gzip, the standard and quicker Linux compression engine, instead of bzip2.
274
275.TP
276.BI "-R "
277EXPERIMENTAL. 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.
278
279.TP
280.BI "-P " "tarball"
281Post-nuke tarball. If you boot into Nuke Mode and everything is restored
282successfully then the
283.I post-nuke
284script will be sought and executed if found. This is useful for post-restore
285customization. It is assumed that the tarball (.tar.gz format) will contain not
286just the
287.I post-nuke
288script (or binary, or whatever it is) but also any files it requires.
289
290.TP
291.BI "-S " "path"
292Specify the full pathname of the scratchdir, the directory where ISO images are built before being
293archived. If you have plenty of RAM and want to use a ramdisk for scratch
294space, specify its path here.
295
296.TP
297.BI "-T " "path"
298Specify the full pathname of the tempdir, the directory where temporary files (other than ISO images
299being assembled) are stored. See
300.B -S
301
302.TP
303.BI "-W "
304Don't make your backup self-booting. This is a really bad idea, IMO. Don't do
305this unless you have really great boot disks in your hand and you are an anally
306retentive SOB who can't wait 2 minutes for Mindi to run in the background. If
307you use -W then you'd better know what the hell you're doing, okay?
308
309.TP
310.BI "-b "
311Specify the internal block size used by the tape drive. This is usually 32K but
312some drives just don't like that. They should but they don't. That's what
313happens when tape drive vendors don't talk to kernel driver writers. Try 512 or
31416384.
315
316.TP
317.BI "-e "
318Don't eject the CD or tape when backing up...
319
320.TP
321.BI "-f " "device"
322Specify the drive on which your Master Boot Record lives. Usually, this is
323discovered automatically.
324
325.TP
326.BI "-l " "GRUB|LILO|ELILO|RAW"
327Specify the boot loader. By default, your Master Boot Record is examined and
328the boot loader can usually be discovered. If you specify RAW then the MBR will
329be backed up and restored byte-for-byte without any analysis. It is likely that
330you will also need to specify the boot device with -f <dev>. ELILO is mandatory
331for IA64 machines.
332
333.TP
334.BI "-Q "
335Give more detailed information about the boot loader.
336
337.TP
338.BI "-K " "loglevel"
339Specify the loglevel. Use 99 for full debug. Standard debug level is 4.
340
341.TP
342.BI "-z "
343Use 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.
344
345
346.SH DIAGNOSTICS
347Mondo generates one additional, and extremely important file:
348.BI /var/log/mondoarchive.log.
349When seeking technical support, attach this file to your email.
350
351
352
353.SH FILES
354.IR /var/log/mondoarchive.log
355This log contains important information required to analyse mondoarchive
356problem reports. Did I already said that it's highly recommended to send this file with
357support questions.
358
359.SH NOTES
360A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren, Cafeole, Randy Delphs,
361Stan Benoit, and Hugo Rabson) may be found at
362.I http://www.mondorescue.org/docs.shtml
363- or in
364.I /usr/share/doc/mondo-x.xx
365on your hard drive.
366
367.SH BUGS
368It is recommend that your system has more than 64 MB ram. SCSI device order
369change with nuke can have unexpected results. It is recommended you use expert
370mode with drastic hardware reconfigurations.
371
372.SH EXAMPLES
373
374.BI ISO:
375Backup to a directory; note that /mnt/foo's contents will be backed up except
376for its ISO's unless you exclude it, as follows:-
377.br
378.I "mondoarchive -Oi -d /mnt/foo -E '/mnt/foo /mnt/foo2' -p \`hostname\`-\`date +%Y-%m-%d\`"
379
380Backup to ISO's non-interactively, e.g. as a job running in /etc/cron.daily:
381.br
382.I "mkdir -p /bkp/\`date +%A\`; mondoarchive -Oi -9 -d /bkp/\`date +%A\` -E /bkp"
383
384.BI DVD:
385Backup PC using DVD Media:
386.br
387.I "mondoarchive -OVr -d /dev/scd0 -gF -s 4480m"
388
389.BI TAPE:
390Backup to tape, using lzo compression (WARNING - can be unstable):
391.br
392.I "mondoarchive -Ot -d /dev/st0 -L"
393
394Verify existing tape backup which was made with lzo compression:-
395.br
396.I "mondoarchive -Vt -d /dev/st0 -L -g"
397
398Backup to tape, using max compression:
399.br
400.I "mondoarchive -Ot -9 -d /dev/st0 "
401
402.BI CD-R:
403Backup to 700MB CD-R disks using a 16x CD burner:
404.br
405.I "mondoarchive -Oc 16 -s 700m -g"
406
407Verify existing CD-R or CD-RW backup (works for either):-
408.br
409.I "mondoarchive -Vc 16"
410
411.BI CD-RW:
412Backup to 650MB CD-RW disks using a 4x CD ReWriter:
413.br
414.I "mondoarchive -Ow 4"
415
416Backup just your /home and /etc directory to 650MB CD-RW disks using a 4x CD
417ReWriter:
418.br
419.I "mondoarchive -Ow 4 -I \*(lq/home /etc\*(rq"
420
421.BI NFS:
422Backup to an NFS mount:
423.br
424.I "mondoarchive -On 192.168.1.2:/home/nfs -d /Monday -E /mnt/nfs"
425
426Verify existing NFS backup:-
427.br
428.I "mondoarchive -Vn 192.168.1.2:/home/nfs -d /Monday"
429
430.BI USB:
431Backup to your USB key, using gzip compression:
432.br
433.I "mondoarchive -OU -d /dev/sda -G"
434
435.BI RAID:
436Backup PC to a Software Raid mount point, iso size 700mb:
437.br
438.I "mondoarchive -O -s 700m -d /mnt/raid"
439
440
441.SH "SEE ALSO"
442afio(1), bzip2(1), find(1), mindi(8), mondorestore(8).
443.SH AUTHORS
444Bruno Cornec (lead-development)
445.I "bruno_at_mondorescue.org"
446.br
447Andree Leidenfrost (co-developer)
448.I "aleidenf_at_bigpond.net.au"
449.br
450.SH ORIGINAL AUTHORS
451Hugo Rabson (original author)
452.I "hugo.rabson_at_mondorescue.org"
453.br
454Jesse Keating (original RPM packager)
455.I "hosting_at_j2solutions.net"
456.br
457Stan Benoit (testing)
458.I "troff_at_nakedsoul.org"
459.br
460Mikael Hultgren (docs)
461.I "mikael_hultgren_at_gmx.net"
462.br
463See mailing list at http://www.mondorescue.org for technical support.
464.
Note: See TracBrowser for help on using the repository browser.