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

Last change on this file since 791 was 791, checked in by bruno, 13 years ago

Fix man page for -J (reported by Moritz Rempel <m.rempel_at_bee.de>)

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