source: trunk/documentation/mondoarchive.8 @ 408

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

merge -r397:402 $SVN_M/branches/stable (end)

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