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

Last change on this file since 2579 was 2543, checked in by Bruno Cornec, 11 years ago

Patch from Rogério Brito rbrito_at_ime.usp.br which fixes errors in man pages format

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