Changeset 37872 in vbox for trunk/doc

Timestamp:

Jul 11, 2011 2:13:57 PM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

72770

Message:

manual: clonevm docu

Location:

trunk/doc/manual/en_US

Files:

• user_Introduction.xml (modified) (1 diff, 1 prop)
• user_VBoxManage.xml (modified) (2 diffs)

trunk/doc/manual/en_US/user_Introduction.xml

@@ -1447 +1447 @@
     <para>The "Remove" menu item is disabled while a machine is
     running.</para>
+  </sect1>
+
+  <sect1 id="clone">
+    <title>Cloning virtual machines</title>
+
+    <para>To experiment with a VM configuration, test different guest OS levels
+    or to simply backup a VM, VirtualBox can create a full copy of an existing
+    VM.<footnote>Cloning support was introduced with VirtualBox
+    4.1.</footnote></para>
+    
+    <para>A wizard will guide you through the clone process. This wizard can be
+    invoked from the context menu of the Manager's VM list (select "Clone") or
+    the "Snapshots" view of the selected VM. If you start from the former you
+    have the choice to create a exact copy of the current state without any
+    snapshots or with all snapshots included. If you invoke the clone VM wizard
+    from the later place and have selected a specific snapshot you can
+    additional decide if you want to clone that snapshot including all child's,
+    but without any independent snapshots in the tree.</para>
+    
+    <para>The clone operation itself can be a lengthy operation depending on
+    the size and count of the attached disk images. Also keep in mind that
+    every snapshot has differencing disk images attached, which need to be cloned
+    as well.</para>
+
+    <para>The "Clone" menu item is disabled while a machine is running.</para>
+
+    <para>For how to clone a VM at the command line, please see <xref
+    linkend="vboxmanage-clonevm" />.</para>
   </sect1>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -336 +336 @@
   </sect1>
 
-  <sect1>
+  <sect1 id="vboxmanage-registervm">
     <title>VBoxManage registervm / unregistervm</title>
 
@@ -1087 +1087 @@
         </itemizedlist></para>
     </sect2>
+  </sect1>
+
+  <sect1 id="vboxmanage-clonevm">
+    <title>VBoxManage clonevm</title>
+
+    <para>This command creates a full copy of an existing virtual
+    machine.</para>
+
+    <para>The <computeroutput>clonevm</computeroutput> subcommand takes at
+    least the name of the virtual machine which should be cloned. The following
+    additional settings can be used to further configure the clone VM
+    operation:</para>
+
+    <itemizedlist>
+       <listitem>
+           <para><computeroutput>--snapshot &lt;uuid&gt;|&lt;name&gt;</computeroutput>: 
+            Select a specific snapshot where the clone operation should refer
+            to. Default is referring to the current state.</para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--mode machine|machineandchilds|all</computeroutput>: 
+           Selects the cloning mode of the operation. If
+           <computeroutput>machine</computeroutput> is selected (the default),
+           the current state of the VM without any snapshots is cloned. In the
+           <computeroutput>machineandchilds</computeroutput> mode the snapshot
+           provided by <computeroutput>--snapshot</computeroutput> and all
+           child snapshots are cloned. If <computeroutput>all</computeroutput>
+           is the selected mode all snapshots and the current state are cloned.
+           </para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--options keepallmacs|keepnatmacs</computeroutput>: 
+           With this option you define how the MAC addresses of every virtual
+           network card should be handled. They can either be reinitialized
+           (the default), leaved unchanged
+           (<computeroutput>keepallmacs</computeroutput>) or leaved unchanged
+           when the network type is NAT (<computeroutput>keepnatmacs</computeroutput>).
+           </para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--name &lt;name&gt;</computeroutput>: Select a
+           new name for the new virtual machine. Default is "Original Name
+           Clone".</para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--basefolder &lt;basefolder&gt;</computeroutput>: 
+           Select the folder where the new virtual machine configuration should
+           be saved in.</para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--uuid &lt;uuid&gt;</computeroutput>: 
+           Select the UUID the new VM should have. This id has to be unique in
+           the VirtualBox instance this clone should be registered. Default is
+           creating a new UUID.</para>
+       </listitem>
+       <listitem>
+           <para><computeroutput>--register</computeroutput>: 
+           Automatically register the new clone in this VirtualBox
+           installation. If you manually want register the new VM later, see
+           <xref linkend="vboxmanage-registervm" /> for instructions how to do
+           so.</para>
+       </listitem>
+    </itemizedlist>
   </sect1>