source: MondoRescue/branches/3.1/mondo-doc/mondorestore.8@ 2937

.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.
.\"
.TH mondorestore 8 "PBDATE" "Mondo Rescue PBVER-rPBREV"

.SH NAME
mondorestore \- a restore / disaster\-recovery tool.

.SH SYNOPSIS
.B mondorestore [\-p prefix][\-K loglevel][\-i][\-U]...
: restore your PC

.SH DESCRIPTION
.PP
.I mondorestore
restores data previously backed up with
.I mondoarchive.

.
Note that mondorestore will usually automatically be called when booting a
MondoRescue medium. The only exception is booting a MondoRescue medium in
.B Expert
mode in which case mondorestore can be evoked from the command line.

.TP
.BI "\-p " prefix
Use
.B prefix
to specify the name of your ISO images.
By default, mondorestore names images mondorescue-1.iso, mondorescue-2.iso, ...
Using
.B \-p machine
.B mondorestore
will use images named machine-1.iso, machine-2.iso, ...

.TP
.BI "\-i "
Use ISO files (CD images) as restore media. This is good when having backed up your
system to a spare hard drive. The
.B \-n
switch is a wiser choice if you plan to restore from a remote filesystem.

.TP
.BI "\-n " mount
Use files residing on NFS partition as restore media.
.I mount
is the remote mount-point, e.g. nfs://192.168.1.3:/home/nfs'
for my file server. Please mount it before restoring/verifying.

.TP
.BI "\-t "
Use tape streamer as restore device and its tapes as restore media.

.TP
.BI "\-U "
Use a generic USB device as restore device. Use this if you want to read
your backup from a USB key or USB disk.
The USB device should be attached to the system in order for this to work and
its device name passed to the
.BR \-d
option.

.TP
.BI "\-u "
Use a generic streaming device as restore device. Use this if you want to read
your backup from a device that is not directly support by mondoarchive. This will
get the data directly from a raw device.
.B For experienced users only.

.TP
.BI "\-E " "\*(lqpath ...\*(rq"
Exclude path(s) from restore (future dev). The paths should be separated with a pipe.
For example, if you are restoring up
from an NFS mount but you do not want to restore some content, exclude it with that switch.

.TP
.BI "\-I " "\*(lqpath ...\*(rq"
Include paths(s) to restore (future dev).

.TP
.BI "\-J " "file"
Specify an explicit list of files and directories to restore in a plain
text file, one item (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 (future dev).

.TP
.BI "\-d " "dev|dir"
Specify the restore device (CD/tape/USB) or directory (NFS/ISO). For CD-R[W] drives,
this is the SCSI node where the drive may be found, e.g. '0,1,0'. For tape
users, this is the tape streamers /dev entry, e.g. '/dev/st0'. For USB users,
this is the device name of your key or external disk. For ISO users,
this is the directory where the ISO images are stored. For NFS users, this is
the directory within the NFS mount where the backups are stored. The default
for ISO and NFS is '/var/cache/mondo'.

.TP
.BI "\-g "
GUI mode. Without this switch, the screen output of mondorestore is text based.

.TP
.BI "\-m "
Manual (not self-retracting) CD trays are often found on laptops. If you are
a laptop user, your CD burner has BurnProof technology or you experience
problems with mondo then please call mondorestore with this switch.

.TP
.BI "\-o "
Use OBDR (One Button Disaster Recovery) type of tapes.
By default, tapes are not bootable. With this flag, tape will be read as bootable tapes
following the OBDR format.

.TP
.BI "\-x " "'dev ...'"
Specify non-Linux partitions which you want to restore (future dev).

.TP
.BI "\-T " "path"
Specify the full pathname of the tempdir, the directory where temporary files
are stored.

.TP
.BI "\-b "
Specify the internal block size used by the tape drive. This is usually 32K but
some drives just don't like that. They should but they don't. That's what
happens when tape drive vendors don't talk to kernel driver writers. Try 512 or
16384.

.TP
.BI "\-e "
Don't eject the CD or tape when restoring...

.TP
.BI "\-f " "device"
Specify the drive on which your Master Boot Record lives. Usually, this is
discovered automatically. (future dev)

.TP
.BI "\-Q "
Give more detailed information about the boot loader.

.TP
.BI "\-K " "loglevel"
Specify the loglevel. Use 99 for full debug. Standard debug level is 4.

.TP
.BI "\-z "
Use 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.

.TP
.BI "\-Z "
Specify mondorestore mode. Mode could be one of
.IR nuke:
This mode restore everything like on the original system with no/minimal questions
.IR interactive:
This mode asks all the questions to the user
.IR compare:
This mode just compares the system with the backup
.IR iso:
This mode restores from iso images, instead of real media
.IR isonuke:
This mode restores from iso images, instead of real media, with no/minimal questions
.IR mbr:
This mode just restores the MBR (Master Boot Record)


.SH DIAGNOSTICS
mondorestore generates an Extremely important file:
.BI /var/log/mondorestore.log.
When seeking technical support, attach this file to your email.

.SH FILES
.IR /var/log/mondorestore.log
This log contains important information required to analyse mondorestore
problem reports. Mondo support highly recommends sending this file with
support questions. It's located under /tmp during the restore process
and moved under /var/log at the end.

.SH ENVIRONMENT VARIABLES
.IR TMPDIR
This variable is used, if defined, as the target directory to create 
all the temporary files needed during the operation (not the scratch files)

.IR TMP
This variable is used, if defined and if TMPDIR is not defined, as the target 
directory to create all the temporary files needed during the operation 
(not the scratch files)

.IR dirimg
This variable is setup by the rcS script to store the network remote directory in PXE mode.
(managed internally)

.IR imgname
This variable is setup by the rcS script to overwrite the prefix name in PXE mode.
(managed internally)

.IR netfsmount
This variable is setup by the rcS script to store the network file system mount point in PXE mode.
(managed internally)

.IR MRUSBDEV
This variable contains the device file of the USB device to restore from.
(equivalent if the usb-dev parameter of the mondorescue config file)

.SH NOTES
A link to Mondo's HTML-based manual (by Bruno Cornec, Mikael Hultgren,
Cafeole, Randy Delphs, Stan Benoit, and Hugo Rabson) may be found at
.I http://www.mondorescue.org/docs.shtml
\- or in
.I /usr/share/doc/mondo-x.xx
on your hard drive.

.SH BUGS
It is recommend that your system has more than 64 MB ram. SCSI device order
change with nuke can have unexpected results. It is recommended you use expert
mode with drastic hardware reconfigurations.

.SH "SEE ALSO"
afio(1), bzip2(1), find(1), mindi(8), mondoarchive(8).
.SH AUTHORS
Bruno Cornec (lead-development)
.I "bruno_at_mondorescue.org"
.br
Andree Leidenfrost (co-developer)
.I "aleidenf_at_bigpond.net.au"
.br
.SH ORIGINAL AUTHORS
Hugo Rabson (original author)
.I "hugo.rabson_at_mondorescue.org"
.br
Jesse Keating (packaging)
.I "hosting_at_j2solutions.net"
.br
Stan Benoit (testing)
.I "troff_at_nakedsoul.org"
.br
Mikael Hultgren (docs)
.I "mikael_hultgren_at_gmx.net"
.br
See mailing list at http://www.mondorescue.org for technical support.