Added /etc/event.d/tty1 for upstart-based systems.
[virt-p2v.git] / virt-p2v.1.txt
index 5b33f74..22682f8 100644 (file)
@@ -24,14 +24,17 @@ DESCRIPTION
     Therefore "sshd" must be running on the virtualization host, and must be
     accessible to that host. See SERVER REQUIREMENTS section below.
 
-    The "virt-p2v" script must only be run from the live CD. 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 "virt-p2v" script must only be run from the live CD 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.
 
     Virt-p2v does not modify the physical machine, its disks, configuration
     etc.
 
+    USB key and PXE boot options are also available. See sections PXE
+    BOOTING and BOOTING FROM A USB KEY below.
+
 STANDARD USAGE
     After booting the live CD-R, you are presented with a series of
     questions. This section explains each question.
@@ -71,6 +74,11 @@ STANDARD USAGE
             should probably try this method even though occasionally it does
             not work.
 
+        Ask for fixed IP address and gateway
+            In this mode the live CD will ask you for a fixed IP address and
+            gateway address, and will configure your chosen interface with
+            these.
+
         Configure from the shell
             In this mode you will be dropped into a command shell and you
             will need to issue the correct sequence of "/sbin/ifconfig"
@@ -85,6 +93,12 @@ STANDARD USAGE
             where "AA.BB.CC.DD" is the IP address and "GG.HH.II.JJ" is the
             gateway.
 
+        QEMU user network
+            This option configures the network for use inside a QEMU user
+            network
+            (<http://fabrice.bellard.free.fr/qemu/qemu-doc.html#SEC30>). It
+            should only be used by developers.
+
     Devices
         This question lists out all local block devices (hard disk drives
         and similar) and asks you to choose which will be sent to the remote
@@ -154,6 +168,16 @@ STANDARD USAGE
         chance that they could coincide, which would leave a guest unable to
         access the virtual network.
 
+    Compression
+        Choose whether to enable or disable compression on disk images as
+        they are copied across the network.
+
+        If enabled, the "-C" option is passed to ssh(1). On fast networks
+        this can sometimes be slower.
+
+        NB: The disk image is still stored uncompressed on the remote host
+        however this option is set.
+
     Verify and proceed
         In this step you are asked to verify the settings above. If any are
         incorrect, use the *Back* button to navigate back to the setting. If
@@ -305,9 +329,27 @@ BUILDING A CUSTOM LIVE CD
          Some (LV ("VolGroup00", "LogVol00"))
 
     "network"
-        Set this to the choice for network setup. Use either "Some Auto" or
-        "Some Shell" for auto-configuration or shell (manual) configuration
-        respectively.
+        Set this to the choice for network setup. Use one of:
+
+        "Some Auto"
+            for auto-configuration
+
+        "Some Static"
+            to specify the interface, address, netmask and gateway
+            statically
+
+        "Some Shell"
+            to launch a shell
+
+        "Some QEMUUserNet"
+            to use a QEMU user network (developers only)
+
+    "static_network_config"
+        This setting only applies if "network" is set to "Some Static", in
+        which case you should set this to the static network settings, a
+        tuple of (interface, address, netmask, gateway, nameserver):
+
+         Some ("eth0", "192.168.2.5", "255.255.255.0", "192.168.2.1", "192.168.2.1")
 
     "hypervisor"
         Set this to the choice of hypervisor or virtualization system. The
@@ -339,6 +381,10 @@ BUILDING A CUSTOM LIVE CD
         uniqueness so there is a very small chance that they could coincide,
         which would leave a guest unable to access the virtual network.
 
+    "compression"
+        Set this to "Some false" to disable compression, or "Some true" to
+        enable compression, or "None" to ask the user.
+
   ISO ATTACHMENTS
     Rebuilding a custom ISO is time-consuming. You can make a "quick"
     developer ISO by updating an existing ISO image with a new custom
@@ -353,9 +399,26 @@ BUILDING A CUSTOM LIVE CD
 
      ./iso-attach virt-p2v-VERSION.iso virt-p2v
 
-BOOTING FROM A USB KEY INSTEAD OF A CD
-    If you wish to boot from a USB keydrive, use the livecd-iso-to-disk
-    tool:
+    Note that ISO attachments only work with real (and emulated) CD-Rs, not
+    with other methods of booting such as USB keys and PXE.
+
+PXE BOOTING
+    If you wish to boot over the network using PXE, use the
+    "livecd-iso-to-pxeboot" script (part of "livecd-tools").
+
+     livecd-iso-to-pxeboot virt-p2v-$VERSION.iso
+
+    then copy the generated subdirectory "tftpboot/" to the right place for
+    your PXE configuration.
+
+    Pre-built PXE boot images are also available on the website.
+
+    General configuration of DHCP, TFTP and PXE for network booting are
+    outside the scope of this document.
+
+BOOTING FROM A USB KEY
+    If you wish to boot from a USB keydrive, use the "livecd-iso-to-disk"
+    script (part of "livecd-tools"):
 
      livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1
 
@@ -379,6 +442,11 @@ TESTING AN ISO UNDER QEMU OR KVM
 
     You can also supply an "HDB" parameter to specify a second disk.
 
+MAILING LIST
+    Please direct questions to the et-mgmt-tools mailing list
+    <http://www.redhat.com/mailman/listinfo/et-mgmt-tools> <et-mgmt-tools @
+    redhat . com>
+
 SEE ALSO
     virsh(1), <http://www.libvirt.org/ocaml/>, <http://www.libvirt.org/>,
     <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>