Add .gitignore file for git.
[virt-p2v.git] / virt-p2v.1
index d7db2ab..67c5e15 100644 (file)
 .\" ========================================================================
 .\"
 .IX Title "VIRT-P2V 1"
-.TH VIRT-P2V 1 "2008-02-04" "virt-p2v-0.9.1" "Virtualization Support"
+.TH VIRT-P2V 1 "2008-02-12" "virt-p2v-0.9.6" "Virtualization Support"
 .SH "NAME"
 virt\-p2v \- P2V (physical to virtual machine) migration tool
 .SH "SUMMARY"
@@ -156,13 +156,17 @@ machine over the network to the virtualization host machine over ssh.
 Therefore \f(CW\*(C`sshd\*(C'\fR must be running on the virtualization host, and must
 be accessible to that host.  See \fB\s-1SERVER\s0 \s-1REQUIREMENTS\s0\fR section below.
 .PP
-The \f(CW\*(C`virt\-p2v\*(C'\fR script must only be run from the live \s-1CD\s0.  It isn't
-designed to run outside this environment and could do Bad Things to
-your machine if you try it.  The script contains some checks to try to
-stop you from doing this.
+The \f(CW\*(C`virt\-p2v\*(C'\fR script must only be run from the live \s-1CD\s0 environment.
+It isn't designed to run outside this environment and could do Bad
+Things to your machine if you try it.  The script contains some checks
+to try to stop you from doing this.
 .PP
 Virt\-p2v does not modify the physical machine, its disks,
 configuration etc.
+.PP
+\&\s-1USB\s0 key and \s-1PXE\s0 boot options are also available.  See sections
+\&\fB\s-1PXE\s0 \s-1BOOTING\s0\fR and \fB\s-1BOOTING\s0 \s-1FROM\s0 A \s-1USB\s0 \s-1KEY\s0\fR
+below.
 .SH "STANDARD USAGE"
 .IX Header "STANDARD USAGE"
 After booting the live \s-1CD\-R\s0, you are presented with a series of
@@ -202,6 +206,10 @@ current options are:
 In this mode, the live \s-1CD\s0 attempts to reuse the network configuration
 from the physical machine's root filesystem.  You should probably try
 this method even though occasionally it does not work.
+.IP "Ask for fixed \s-1IP\s0 address and gateway" 4
+.IX Item "Ask for fixed IP address and gateway"
+In this mode the live \s-1CD\s0 will ask you for a fixed \s-1IP\s0 address and
+gateway address, and will configure your chosen interface with these.
 .IP "Configure from the shell" 4
 .IX Item "Configure from the shell"
 In this mode you will be dropped into a command shell and you will
@@ -218,6 +226,11 @@ interface would be:
 .Sp
 where \f(CW\*(C`AA.BB.CC.DD\*(C'\fR is the \s-1IP\s0 address and \f(CW\*(C`GG.HH.II.JJ\*(C'\fR is the
 gateway.
+.IP "\s-1QEMU\s0 user network" 4
+.IX Item "QEMU user network"
+This option configures the network for use inside a \s-1QEMU\s0 user network
+(<http://fabrice.bellard.free.fr/qemu/qemu\-doc.html#SEC30>).  It
+should only be used by developers.
 .RE
 .RS 4
 .RE
@@ -289,6 +302,16 @@ within the \f(CW\*(C`00:16:3e:..\*(C'\fR space reserved for Xen guests.  These \
 addresses are not tested for uniqueness so there is a very small
 chance that they could coincide, which would leave a guest unable to
 access the virtual network.
+.IP "Compression" 4
+.IX Item "Compression"
+Choose whether to enable or disable compression on disk images as they
+are copied across the network.
+.Sp
+If enabled, the \f(CW\*(C`\-C\*(C'\fR option is passed to \fIssh\fR\|(1).  On fast networks
+this can sometimes be slower.
+.Sp
+\&\s-1NB:\s0 The disk image is still stored uncompressed on the remote host
+however this option is set.
 .IP "Verify and proceed" 4
 .IX Item "Verify and proceed"
 In this step you are asked to verify the settings above.  If any are
@@ -462,9 +485,37 @@ For a logical volume (eg. \f(CW\*(C`/dev/VolGroup00/LogVol00\*(C'\fR), use:
 .ie n .IP """network""" 4
 .el .IP "\f(CWnetwork\fR" 4
 .IX Item "network"
-Set this to the choice for network setup.  Use either \f(CW\*(C`Some Auto\*(C'\fR or
-\&\f(CW\*(C`Some Shell\*(C'\fR for auto-configuration or shell (manual) configuration
-respectively.
+Set this to the choice for network setup.  Use one of:
+.RS 4
+.ie n .IP """Some Auto""" 4
+.el .IP "\f(CWSome Auto\fR" 4
+.IX Item "Some Auto"
+for auto-configuration
+.ie n .IP """Some Static""" 4
+.el .IP "\f(CWSome Static\fR" 4
+.IX Item "Some Static"
+to specify the interface, address, netmask and gateway statically
+.ie n .IP """Some Shell""" 4
+.el .IP "\f(CWSome Shell\fR" 4
+.IX Item "Some Shell"
+to launch a shell
+.ie n .IP """Some QEMUUserNet""" 4
+.el .IP "\f(CWSome QEMUUserNet\fR" 4
+.IX Item "Some QEMUUserNet"
+to use a \s-1QEMU\s0 user network (developers only)
+.RE
+.RS 4
+.RE
+.ie n .IP """static_network_config""" 4
+.el .IP "\f(CWstatic_network_config\fR" 4
+.IX Item "static_network_config"
+This setting only applies if \f(CW\*(C`network\*(C'\fR is set to \f(CW\*(C`Some Static\*(C'\fR,
+in which case you should set this to the static network settings,
+a tuple of (interface, address, netmask, gateway, nameserver):
+.Sp
+.Vb 1
+\& Some ("eth0", "192.168.2.5", "255.255.255.0", "192.168.2.1", "192.168.2.1")
+.Ve
 .ie n .IP """hypervisor""" 4
 .el .IP "\f(CWhypervisor\fR" 4
 .IX Item "hypervisor"
@@ -504,6 +555,11 @@ will choose a random \s-1MAC\s0 address within the \f(CW\*(C`00:16:3e:..\*(C'\fR
 reserved for Xen guests.  These \s-1MAC\s0 addresses are not tested for
 uniqueness so there is a very small chance that they could coincide,
 which would leave a guest unable to access the virtual network.
+.ie n .IP """compression""" 4
+.el .IP "\f(CWcompression\fR" 4
+.IX Item "compression"
+Set this to \f(CW\*(C`Some false\*(C'\fR to disable compression, or \f(CW\*(C`Some true\*(C'\fR to
+enable compression, or \f(CW\*(C`None\*(C'\fR to ask the user.
 .Sh "\s-1ISO\s0 \s-1ATTACHMENTS\s0"
 .IX Subsection "ISO ATTACHMENTS"
 Rebuilding a custom \s-1ISO\s0 is time\-consuming.  You can make a \*(L"quick\*(R"
@@ -522,10 +578,29 @@ or the equivalent manual command:
 .Vb 1
 \& ./iso-attach virt-p2v-VERSION.iso virt-p2v
 .Ve
-.SH "BOOTING FROM A USB KEY INSTEAD OF A CD"
-.IX Header "BOOTING FROM A USB KEY INSTEAD OF A CD"
-If you wish to boot from a \s-1USB\s0 keydrive, use the livecd-iso-to-disk
-tool:
+.PP
+Note that \s-1ISO\s0 attachments only work with real (and emulated) CD\-Rs,
+not with other methods of booting such as \s-1USB\s0 keys and \s-1PXE\s0.
+.SH "PXE BOOTING"
+.IX Header "PXE BOOTING"
+If you wish to boot over the network using \s-1PXE\s0, use the
+\&\f(CW\*(C`livecd\-iso\-to\-pxeboot\*(C'\fR script (part of \f(CW\*(C`livecd\-tools\*(C'\fR).
+.PP
+.Vb 1
+\& livecd-iso-to-pxeboot virt-p2v-$VERSION.iso
+.Ve
+.PP
+then copy the generated subdirectory \f(CW\*(C`tftpboot/\*(C'\fR to the
+right place for your \s-1PXE\s0 configuration.
+.PP
+Pre-built \s-1PXE\s0 boot images are also available on the website.
+.PP
+General configuration of \s-1DHCP\s0, \s-1TFTP\s0 and \s-1PXE\s0 for network booting are
+outside the scope of this document.
+.SH "BOOTING FROM A USB KEY"
+.IX Header "BOOTING FROM A USB KEY"
+If you wish to boot from a \s-1USB\s0 keydrive, use the \f(CW\*(C`livecd\-iso\-to\-disk\*(C'\fR
+script (part of \f(CW\*(C`livecd\-tools\*(C'\fR):
 .PP
 .Vb 1
 \& livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1