source: branches/2.2.10/mondo-doc/mondoarchive.8 @ 2850

Last change on this file since 2850 was 2850, checked in by bruno, 6 years ago

svn merge -r 2773:2849 2.2.9 in 2.2.10

  • Adds 3 binaries called potentially by udev o support USB key mount at restore time (Victor Gattegno)
  • Really support both mkisofs and genisoimage everywhere
  • Try to handle netfs_user better in all cases (NFS and SSHFS)
    • Improve logging in init script
    • Format improvement
    • Removes a warning when trying to launch udevadm and it doesn't exist (RHEL 5 e.g.)
    • Fix syntax description in mondoarchive man page for -E & -I with |
  • Adds download entries for new distro supported (Mageia, Fedora 15, Ubuntu 11.04)

-Fix mindi-get-perl-modules when perl dirs in @INC are symlinks (case on Ubuntu 11.04)

  • Fix option --findkernel in case of Xen kernel so that mondoarchive get a correct answer instead of an empty one.
  • Fix multi-media restore by umounting it before looping to ask for the next (as if already mounted, will not pass to the next alone)
  • Fix 485 by replacing a wrong call to mr_asprintf which was provoking core dumped.
  • Fix -E and -I example in man page which were lacking the '|' as separator
  • Fix #484 by adding support for the arcmsr driver (to support the Areca ARC-1220 RAID Controller)
    • Avoids error msgs if no mondo-restore.cfg file exists (when mindi used stdalone)
    • Adds the swapon feature to mindi-busybox
    • Attempt to fix Xen kernel support by avoiding to remove xen kernel fro; the possible_kernels list too early, whereas it's used afterwards to get them.
    • Fix #481 by supporting the new kbd file in latest Ubuntu 10.10+ (victor.gattegno_at_hp.com)
  • Update from Lester Wade on P2V doc including RHEL6 validation and some minor additions
  • removes telinit call in busybox o try to fix problems whn reboot at end of restore.
  • if -E option for mondoarchive was not specified, variable excp points to NULL, so string exclude_pathes contained '(null)' instead of being avoided (derived from a patch from taguchi_at_ff.iij4u.or.jp)
  • fix -maxdepth option for find command. it sould be '-maxdepth .. -name ..', not '-name .. -maxdepth ..' (patch from taguchi_at_ff.iij4u.or.jp)
  • Adds an extraversion for revision support
  • Adds support for ifconfig and ping for PXE+NFS boot for this version of mindi-busybox
  • Example of MINDI_ADDITIONAL_BOOT_PARAMS in mindi.conf added
  • fix a compilation error
  • Remove an absolute ref in the docs web page
  • Property svn:keywords set to Id
File size: 15.4 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 pipe 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. The paths should be separated with a pipe and surrounded by quotes.
177This option is mainly used to perform tests
178in order to reduce the time taken by the archiving operation.
179The default backup path is \*(lq/\*(rq but you may specify alternatives,
180e.g. \-I \*(lq/home|/etc\*(rq to override that.
181You may also specify full disk device to this option as with \-I
182\*(lq/dev/sda|/dev/cciss/c0d0\*(rq
183N.B.: When using the
184.BR \-I
185option with the
186.BR \-E
187option, the \-E content should be subdirectories of those mentioned in
188the \-I only, as -I takes precedence.
189
190.TP
191.BI "-J " "file"
192Specify an explicit list of files and directories to include in a plain text file, one item
193(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.
194
195.TP
196.BI "-N"
197Exclude all mounted network filesystems. This currently means NFS, SMB, Coda, MVFS, AFS
198OCFS and Netware. In other words, only backup the local hard disk(s).
199
200.TP
201.BI "-d " "dev|dir"
202Specify the backup device (CD/tape/USB) or directory (NFS/ISO). For CD-R[W] drives,
203this is the SCSI node where the drive may be found, e.g. '0,1,0'. For tape
204users, this is the tape streamers /dev entry, e.g. '/dev/st0'. For USB users,
205this is the device name of your key or external disk. For ISO users,
206this is the directory where the ISO images are stored. For NFS users, this is
207the directory within the NFS mount where the backups are stored. The default
208for ISO and NFS is '/var/cache/mondo'.
209
210.TP
211.BI "-g "
212GUI mode. Without this switch, the screen output of mondoarchive is suitable
213for processing by an 'expect' wrapper, enabling the user to backup nightly via
214a cron job. However, if you want to run this program with an attractive but
215non-cron-friendly interface then use '\-g'.
216
217.TP
218.BI "-k " "path"
219Path of user's kernel. If you are a Debian (<3.0) or Gentoo (<1.4) user then specify
220.B \-k FAILSAFE
221as your kernel. Otherwise, you will rarely need this option.
222
223.TP
224.BI "-m "
225Manual (not self-retracting) CD trays are often found on laptops. If you are
226a laptop user, your CD burner has BurnProof technology or you experience
227problems with mondo then please call mondoarchive with this switch.
228
229.TP
230.BI "-o "
231Use OBDR (One Button Disaster Recovery) type of tapes.
232By default, tapes are not bootable. With this flag, tape will be made bootable
233following the OBDR format.
234
235.TP
236.BI "-s " "size"
237How much can each of your backup media hold? You may use 'm' and 'g' on the end
238of the number, e.g. '700m' for an extra-large CD-R. You no longer need to
239specify the size of your cartridges if you are backing up to tape.
240
241.TP
242.BI "-x " "'dev ...'"
243Specify non-Linux partitions which you want to backup, e.g. NTFS or BeOS.
244
245
246.SH MINOR OPTIONS
247.TP 13
248.BI "-[0-9] "
249Specify the compression level. Default is 3. No compression is 0.
250
251.TP
252.BI "-A " "command"
253This command will be called after each CD/NFS/ISO file is written. It is useful
254if you want to do something with an ISO after creating it, e.g. write it to a
255CD burner using a non-standard command.
256.B -A
257understands two tokens \- _ISO_ and _CD#_ - which will be translated into the
258ISO's filename and its index number (1, 2, ...) respectively. So, you could use
259.I \-A 'foobackup _ISO_; rm \-f _ISO_'
260to feed each ISO to some magical new backup tool.
261
262.TP
263.BI "-B " "command"
264This command will be called before each CD/NFS/ISO file is written. See
265.B \-A
266for more information.
267
268.TP
269.BI "-H "
270When you boot from the tape/CD, your hard drive will be wiped and the archives
271will be restored. Your decision to boot from the tape/CD will be taken as
272consent. No further permission will be sought.
273.B Use with caution.
274
275.TP
276.BI "-L "
277Use lzo, a fast compression engine, instead of bzip2. You may find lzo on
278Mondo's website or via FreshMeat. WARNING! Some versions of LZO are unstable.
279
280.TP
281.BI "-G "
282Use gzip, the standard and quicker Linux compression engine, instead of bzip2.
283
284.TP
285.BI "-Y "
286Use lzma, the new quicker and optimized Linux compression engine, instead of bzip2.
287
288.TP
289.BI "-R "
290EXPERIMENTAL. Do not use in mission-critical environments. Star is an
291alternative to afio. Mondo now supports POSIX ACLs and extended
292attributes, so \-R is essentially redundant for now.
293
294.TP
295.BI "-P " "tarball"
296Post-nuke tarball. If you boot into Nuke Mode and everything is restored
297successfully then the
298.I post-nuke
299script will be sought and executed if found. This is useful for post-restore
300customization. It is assumed that the tarball (.tar.gz format) will contain not
301just the
302.I post-nuke
303script (or binary, or whatever it is) but also any files it requires.
304
305.TP
306.BI "-S " "path"
307Specify the full pathname of the scratchdir, the directory where ISO
308images are built before being archived. If you have plenty of RAM and
309want to use a ramdisk for scratch space, specify its path here.
310
311.TP
312.BI "-T " "path"
313Specify the full pathname of the tempdir, the directory where temporary
314files (other than ISO images being assembled) are stored. See
315.B \-S
316
317.TP
318.BI "-W "
319Don't make your backup self-booting. This is a really bad idea, IMO. Don't do
320this unless you have really great boot disks in your hand and you are an anally
321retentive SOB who can't wait 2 minutes for Mindi to run in the background. If
322you use \-W then you'd better know what the hell you're doing, okay?
323
324.TP
325.BI "-b "
326Specify the internal block size used by the tape drive. This is usually 32K but
327some drives just don't like that. They should but they don't. That's what
328happens when tape drive vendors don't talk to kernel driver writers. Try 512 or
32916384.
330
331.TP
332.BI "-e "
333Don't eject the CD or tape when backing up...
334
335.TP
336.BI "-f " "device"
337Specify the drive on which your Master Boot Record lives. Usually, this is
338discovered automatically. A good use case may be when you have software RAID.
339
340.TP
341.BI "-l " "GRUB|LILO|ELILO|RAW"
342Specify the boot loader. By default, your Master Boot Record is examined and
343the boot loader can usually be discovered. If you specify RAW then the MBR will
344be backed up and restored byte-for-byte without any analysis. It is likely that
345you will also need to specify the boot device with \-f <dev>. ELILO is mandatory
346for IA64 machines.
347
348.TP
349.BI "-Q "
350Give more detailed information about the boot loader.
351
352.TP
353.BI "-K " "loglevel"
354Specify the loglevel. Use 99 for full debug. Standard debug level is 4.
355
356.TP
357.BI "-v "
358Gives mondoarchive version.
359
360.TP
361.BI "-z "
362Use extended attributes and acl for each file and store them in the
363backup media. Use this option if you use SElinux e.g. but it will slow
364down backup and restore time of course.
365
366
367.SH DIAGNOSTICS
368Mondo generates one additional, and extremely important file:
369.BI /var/log/mondoarchive.log.
370When seeking technical support, attach this file to your email.
371
372
373.SH FILES
374.IR /var/log/mondoarchive.log
375This log contains important information required to analyse mondoarchive
376problem reports. Did I already said that it's highly recommended to send this file with
377support questions.
378
379
380.SH NOTES
381A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren,
382Cafeole, Randy Delphs, Stan Benoit, and Hugo Rabson) may be found at
383.I http://www.mondorescue.org/docs.shtml
384\- or in
385.I /usr/share/doc/mondo-x.xx
386on your hard drive.
387
388.SH BUGS
389It is recommend that your system has more than 64 MB ram. SCSI device order
390change with nuke can have unexpected results. It is recommended you use expert
391mode with drastic hardware reconfigurations.
392
393.SH EXAMPLES
394
395.BI ISO:
396Backup to a directory; note that /mnt/foo's contents will be backed up except
397for its ISO's unless you exclude it, as follows:
398.br
399.I "mondoarchive -Oi -d /mnt/foo -E '/mnt/foo|/mnt/foo2' -p \`hostname\`-\`date +%Y-%m-%d\`"
400
401Backup to ISO's non-interactively, e.g. as a job running in /etc/cron.daily:
402.br
403.I "mkdir -p /bkp/\`date +%A\`; mondoarchive -Oi -9 -d /bkp/\`date +%A\` -E /bkp"
404
405.BI DVD:
406Backup PC using DVD Media:
407.br
408.I "mondoarchive -OVr -d /dev/scd0 -gF -s 4480m"
409
410.BI TAPE:
411Backup to tape, using lzo compression (WARNING - can be unstable):
412.br
413.I "mondoarchive -Ot -d /dev/st0 -L"
414
415Verify existing tape backup which was made with lzo compression:-
416.br
417.I "mondoarchive -Vt -d /dev/st0 -L -g"
418
419Backup to tape, using max compression:
420.br
421.I "mondoarchive -Ot -9 -d /dev/st0 "
422
423.BI CD-R:
424Backup to 700MB CD-R disks using a 16x CD burner:
425.br
426.I "mondoarchive -Oc 16 -s 700m -g"
427
428Verify existing CD-R or CD-RW backup (works for either):-
429.br
430.I "mondoarchive -Vc 16"
431
432.BI CD-RW:
433Backup to 650MB CD-RW disks using a 4x CD ReWriter:
434.br
435.I "mondoarchive -Ow 4"
436
437Backup just your /home and /etc directory to 650MB CD-RW disks using a 4x CD
438ReWriter:
439.br
440.I "mondoarchive -Ow 4 -I \*(lq/home|/etc\*(rq"
441
442.BI NFS:
443Backup to an NFS mount:
444.br
445.I "mondoarchive -On nfs://192.168.1.2:/home/nfs -d /Monday -E /mnt/nfs"
446
447Verify existing NFS backup:-
448.br
449.I "mondoarchive -Vn nfs://192.168.1.2:/home/nfs -d /Monday"
450
451.BI USB:
452Backup to your USB key, using gzip compression:
453.br
454.I "mondoarchive -OU -d /dev/sda -G"
455
456.BI RAID:
457Backup PC to a Software Raid mount point, iso size 700mb:
458.br
459.I "mondoarchive -O -s 700m -d /mnt/raid"
460
461
462.SH "SEE ALSO"
463afio(1), bzip2(1), find(1), mindi(8), mondorestore(8).
464.SH AUTHORS
465Bruno Cornec (lead-development)
466.I "bruno_at_mondorescue.org"
467.br
468Andree Leidenfrost (co-developer)
469.I "aleidenf_at_bigpond.net.au"
470.br
471.SH ORIGINAL AUTHORS
472Hugo Rabson (original author)
473.I "hugo.rabson_at_mondorescue.org"
474.br
475Jesse Keating (original RPM packager)
476.I "hosting_at_j2solutions.net"
477.br
478Stan Benoit (testing)
479.I "troff_at_nakedsoul.org"
480.br
481Mikael Hultgren (docs)
482.I "mikael_hultgren_at_gmx.net"
483.br
484See mailing list at http://www.mondorescue.org for technical support.
Note: See TracBrowser for help on using the repository browser.