Fix new path to RPM.

[virt-p2v.git] / virt-p2v.1.html

diff --git a/virt-p2v.1.html b/virt-p2v.1.html
index 89e6f69..579808f 100644 (file)
--- a/virt-p2v.1.html
+++ b/virt-p2v.1.html
@@ -38,7 +38,8 @@
                <li><a href="#iso_attachments">ISO ATTACHMENTS</a></li>
        </ul>
 
-       <li><a href="#booting_from_a_usb_key_instead_of_a_cd">BOOTING FROM A USB KEY INSTEAD OF A CD</a></li>
+       <li><a href="#pxe_booting">PXE BOOTING</a></li>
+       <li><a href="#booting_from_a_usb_key">BOOTING FROM A USB KEY</a></li>
        <li><a href="#testing_an_iso_under_qemu_or_kvm">TESTING AN ISO UNDER QEMU OR KVM</a></li>
        <li><a href="#mailing_list">MAILING LIST</a></li>
        <li><a href="#see_also">SEE ALSO</a></li>
@@ -77,12 +78,15 @@ CUSTOM LIVE CD</strong> section below.</p>
 machine over the network to the virtualization host machine over ssh.
 Therefore <code>sshd</code> must be running on the virtualization host, and must
 be accessible to that host.  See <strong>SERVER REQUIREMENTS</strong> section below.</p>
-<p>The <code>virt-p2v</code> 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.</p>
+<p>The <code>virt-p2v</code> 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.</p>
 <p>Virt-p2v does not modify the physical machine, its disks,
 configuration etc.</p>
+<p>USB key and PXE boot options are also available.  See sections
+<strong>PXE BOOTING</strong> and <strong>BOOTING FROM A USB KEY</strong>
+below.</p>
 <p>
 </p>
 <hr />
@@ -278,6 +282,21 @@ chance that they could coincide, which would leave a guest unable to
 access the virtual network.</p>
 </dd>
 </li>
+<dt><strong><a name="item_compression">Compression</a></strong>
+
+<dd>
+<p>Choose whether to enable or disable compression on disk images as they
+are copied across the network.</p>
+</dd>
+<dd>
+<p>If enabled, the <code>-C</code> option is passed to <em>ssh(1)</em>.  On fast networks
+this can sometimes be slower.</p>
+</dd>
+<dd>
+<p>NB: The disk image is still stored uncompressed on the remote host
+however this option is set.</p>
+</dd>
+</li>
 <dt><strong><a name="item_verify_and_proceed">Verify and proceed</a></strong>
 
 <dd>
@@ -565,6 +584,13 @@ uniqueness so there is a very small chance that they could coincide,
 which would leave a guest unable to access the virtual network.</p>
 </dd>
 </li>
+<dt><strong><a name="item_compression"><code>compression</code></a></strong>
+
+<dd>
+<p>Set this to <code>Some false</code> to disable compression, or <code>Some true</code> to
+enable compression, or <code>None</code> to ask the user.</p>
+</dd>
+</li>
 </dl>
 <p>
 </p>
@@ -579,12 +605,27 @@ built an existing <code>virt-p2v-*.iso</code>, you can just do:</p>
 <p>or the equivalent manual command:</p>
 <pre>
  ./iso-attach virt-p2v-VERSION.iso virt-p2v</pre>
+<p>Note that ISO attachments only work with real (and emulated) CD-Rs,
+not with other methods of booting such as USB keys and PXE.</p>
+<p>
+</p>
+<hr />
+<h1><a name="pxe_booting">PXE BOOTING</a></h1>
+<p>If you wish to boot over the network using PXE, use the
+<code>livecd-iso-to-pxeboot</code> script (part of <code>livecd-tools</code>).</p>
+<pre>
+ livecd-iso-to-pxeboot virt-p2v-$VERSION.iso</pre>
+<p>then copy the generated subdirectory <code>tftpboot/</code> to the
+right place for your PXE configuration.</p>
+<p>Pre-built PXE boot images are also available on the website.</p>
+<p>General configuration of DHCP, TFTP and PXE for network booting are
+outside the scope of this document.</p>
 <p>
 </p>
 <hr />
-<h1><a name="booting_from_a_usb_key_instead_of_a_cd">BOOTING FROM A USB KEY INSTEAD OF A CD</a></h1>
-<p>If you wish to boot from a USB keydrive, use the livecd-iso-to-disk
-tool:</p>
+<h1><a name="booting_from_a_usb_key">BOOTING FROM A USB KEY</a></h1>
+<p>If you wish to boot from a USB keydrive, use the <code>livecd-iso-to-disk</code>
+script (part of <code>livecd-tools</code>):</p>
 <pre>
  livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1</pre>
 <p>(Replace /dev/sdX1 with the actual USB device).</p>