source: branches/3.0/mondo-doc/mondoarchive.8 @ 3138

Last change on this file since 3138 was 3138, checked in by Bruno Cornec, 7 years ago

r5337@localhost: bruno | 2013-06-13 01:56:06 +0200

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