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

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