Japanese translation.
[virt-p2v.git] / virt-p2v.pod
index cf9cc0a..5b57631 100644 (file)
@@ -27,14 +27,18 @@ machine over the network to the virtualization host machine over ssh.
 Therefore C<sshd> must be running on the virtualization host, and must
 be accessible to that host.  See B<SERVER REQUIREMENTS> section below.
 
 Therefore C<sshd> must be running on the virtualization host, and must
 be accessible to that host.  See B<SERVER REQUIREMENTS> section below.
 
-The C<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 C<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.
 
 
 Virt-p2v does not modify the physical machine, its disks,
 configuration etc.
 
+USB key and PXE boot options are also available.  See sections
+B<PXE BOOTING> and B<BOOTING FROM A USB KEY>
+below.
+
 =head1 STANDARD USAGE
 
 After booting the live CD-R, you are presented with a series of
 =head1 STANDARD USAGE
 
 After booting the live CD-R, you are presented with a series of
@@ -84,6 +88,11 @@ In this mode, the live CD 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.
 
 from the physical machine's root filesystem.  You should probably try
 this method even though occasionally it does not work.
 
+=item 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.
+
 =item Configure from the shell
 
 In this mode you will be dropped into a command shell and you will
 =item Configure from the shell
 
 In this mode you will be dropped into a command shell and you will
@@ -99,6 +108,12 @@ interface would be:
 where C<AA.BB.CC.DD> is the IP address and C<GG.HH.II.JJ> is the
 gateway.
 
 where C<AA.BB.CC.DD> is the IP address and C<GG.HH.II.JJ> is the
 gateway.
 
+=item QEMU user network
+
+This option configures the network for use inside a QEMU user network
+(L<http://fabrice.bellard.free.fr/qemu/qemu-doc.html#SEC30>).  It
+should only be used by developers.
+
 =back
 
 =item Devices
 =back
 
 =item Devices
@@ -176,6 +191,17 @@ 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.
 
 chance that they could coincide, which would leave a guest unable to
 access the virtual network.
 
+=item Compression
+
+Choose whether to enable or disable compression on disk images as they
+are copied across the network.
+
+If enabled, the C<-C> option is passed to L<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.
+
 =item Verify and proceed
 
 In this step you are asked to verify the settings above.  If any are
 =item Verify and proceed
 
 In this step you are asked to verify the settings above.  If any are
@@ -356,9 +382,35 @@ For a logical volume (eg. C</dev/VolGroup00/LogVol00>), use:
 
 =item C<network>
 
 
 =item C<network>
 
-Set this to the choice for network setup.  Use either C<Some Auto> or
-C<Some Shell> for auto-configuration or shell (manual) configuration
-respectively.
+Set this to the choice for network setup.  Use one of:
+
+=over 4
+
+=item C<Some Auto>
+
+for auto-configuration
+
+=item C<Some Static>
+
+to specify the interface, address, netmask and gateway statically
+
+=item C<Some Shell>
+
+to launch a shell
+
+=item C<Some QEMUUserNet>
+
+to use a QEMU user network (developers only)
+
+=back
+
+=item C<static_network_config>
+
+This setting only applies if C<network> is set to C<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")
 
 =item C<hypervisor>
 
 
 =item C<hypervisor>
 
@@ -399,6 +451,11 @@ reserved for Xen guests.  These MAC 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.
 
 uniqueness so there is a very small chance that they could coincide,
 which would leave a guest unable to access the virtual network.
 
+=item C<compression>
+
+Set this to C<Some false> to disable compression, or C<Some true> to
+enable compression, or C<None> to ask the user.
+
 =back
 
 =head2 ISO ATTACHMENTS
 =back
 
 =head2 ISO ATTACHMENTS
@@ -416,10 +473,28 @@ or the equivalent manual command:
 
  ./iso-attach virt-p2v-VERSION.iso virt-p2v
 
 
  ./iso-attach virt-p2v-VERSION.iso virt-p2v
 
-=head1 BOOTING FROM A USB KEY INSTEAD OF A CD
+Note that ISO attachments only work with real (and emulated) CD-Rs,
+not with other methods of booting such as USB keys and PXE.
+
+=head1 PXE BOOTING
+
+If you wish to boot over the network using PXE, use the
+C<livecd-iso-to-pxeboot> script (part of C<livecd-tools>).
+
+ livecd-iso-to-pxeboot virt-p2v-$VERSION.iso
+
+then copy the generated subdirectory C<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.
+
+=head1 BOOTING FROM A USB KEY
 
 
-If you wish to boot from a USB keydrive, use the livecd-iso-to-disk
-tool:
+If you wish to boot from a USB keydrive, use the C<livecd-iso-to-disk>
+script (part of C<livecd-tools>):
 
  livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1
 
 
  livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1