source: branches/2.05/mondo/mondo/mondoarchive/mondoarchive.8 @ 175

Last change on this file since 175 was 175, checked in by bcornec, 13 years ago

contributers review in mondoarchive.8

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