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

Last change on this file since 2493 was 1977, checked in by Bruno Cornec, 12 years ago

svn merge -r 1938:1976 $SVN_M/branches/2.2.6

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