source: branches/stable/mondo-doc/mondoarchive.8 @ 1581

Last change on this file since 1581 was 1581, checked in by bruno, 12 years ago

Continue to remove floppy support

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