VirtualBox

Changeset 77887 in vbox for trunk/doc/manual/en_US


Ignore:
Timestamp:
Mar 26, 2019 4:41:15 PM (6 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
129592
Message:

manual/VBoxManage: Made the new clonevm build. Again, there must be '=' between an option name and its value. The help-scope in the example section is not needed for commands without sub-commands. Use 'vmname|uuid' rather than just 'vm' as it's easier to grasp when just seeing the command synopsis.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/man_VBoxManage-clonevm.xml

    r77787 r77887  
    3939<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
    4040      <command>VBoxManage clonevm</command>
    41       <arg choice="plain"><replaceable>vm</replaceable></arg>
    42 
    43       <arg>--basefolder <replaceable>basefolder</replaceable></arg>
    44 
    45       <arg>--group <replaceable>group</replaceable>, ...</arg>
    46 
    47       <arg>--mode machine | machinechildren | all</arg>
    48 
    49       <arg>--name <replaceable>name</replaceable></arg>
    50 
    51       <arg>--options link | keepallmacs | keepnatmacs | keepdisknames | keephwuuids</arg>
     41      <arg choice="req"><replaceable>vmname|uuid</replaceable></arg>
     42
     43      <arg>--basefolder=<replaceable>basefolder</replaceable></arg>
     44
     45      <arg>--group=<replaceable>group</replaceable>, ...</arg>
     46
     47      <arg>--mode=<group choice='plain'><arg choice='plain'>machine</arg><arg choice='plain'>machinechildren</arg><arg choice='plain'>all</arg></group></arg>
     48
     49      <arg>--name=<replaceable>name</replaceable></arg>
     50
     51      <arg>--options=<group choice='plain'><arg choice='plain'>link</arg><arg choice='plain'>keepallmacs</arg><arg choice='plain'>keepnatmacs</arg><arg choice='plain'>keepdisknames</arg><arg choice='plain'>keephwuuids</arg></group></arg>
    5252
    5353      <arg>--register</arg>
    5454
    55       <arg>--snapshot <replaceable>snapshot-name</replaceable></arg>
    56 
    57       <arg>--uuid <replaceable>uuid</replaceable></arg>
     55      <arg>--snapshot=<replaceable>snapshot-name</replaceable></arg>
     56
     57      <arg>--uuid=<replaceable>uuid</replaceable></arg>
    5858    </cmdsynopsis>
    5959  </refsynopsisdiv>
     
    8080    <variablelist>
    8181      <varlistentry>
    82         <term><replaceable>vm</replaceable></term>
     82        <term><replaceable>vmname|uuid</replaceable></term>
    8383        <listitem><para>
    8484            Specifies the name or UUID of the VM to clone.
     
    8686      </varlistentry>
    8787      <varlistentry>
    88         <term><option>--basefolder <replaceable>basefolder</replaceable></option></term>
     88        <term><option>--basefolder=<replaceable>basefolder</replaceable></option></term>
    8989        <listitem><para>
    9090            Specifies the name of the folder in which to save the
     
    9393      </varlistentry>
    9494      <varlistentry>
    95         <term><option>--groups <replaceable>group</replaceable>, ...</option></term>
     95        <term><option>--groups=<replaceable>group</replaceable>, ...</option></term>
    9696        <listitem><para>
    9797            Assigns the clone to the specified group or groups. If you
     
    107107      </varlistentry>
    108108      <varlistentry>
    109         <term><option>--mode machine|machineandchildren|all</option></term>
     109        <term><option>--mode=machine|machineandchildren|all</option></term>
    110110        <listitem><para>
    111111            Specifies which of the following cloning modes to use:
     
    129129      </varlistentry>
    130130      <varlistentry>
    131         <term><option>--name <replaceable>name</replaceable></option></term>
     131        <term><option>--name=<replaceable>name</replaceable></option></term>
    132132        <listitem><para>
    133133            Specifies a new name for the new VM. The default value is
     
    139139      </varlistentry>
    140140      <varlistentry>
    141         <term><option>--options</option></term>
     141        <term><option>--options=option</option></term>
    142142        <listitem><para>
    143143            Specifies how to create a new clone.
    144144          </para><variablelist>
    145145            <varlistentry>
    146               <term><option>--options link</option></term>
     146              <term><option>--options=link</option></term>
    147147              <listitem><para>
    148148                  Creates a linked clone from a snapshot only.
     
    150150            </varlistentry>
    151151            <varlistentry>
    152               <term><option>--options keepallmacs</option></term>
     152              <term><option>--options=keepallmacs</option></term>
    153153              <listitem><para>
    154154                  Specifies that the new clone reuses the MAC addresses
     
    156156                </para><para>
    157157                  If you do not specify this option or the
    158                   <option>--options keepnatmacs</option> option, the
     158                  <option>--options=keepnatmacs</option> option, the
    159159                  default behavior is to reinitialize the MAC addresses
    160160                  of each virtual network card.
     
    162162            </varlistentry>
    163163            <varlistentry>
    164               <term><option>--options keepnatmacs</option></term>
     164              <term><option>--options=keepnatmacs</option></term>
    165165              <listitem><para>
    166166                  Specifies that the new clone reuses the MAC addresses
     
    169169                </para><para>
    170170                  If you do not specify this option or the
    171                   <option>--options keepallmacs</option> option, the
     171                  <option>--options=keepallmacs</option> option, the
    172172                  default behavior is to reinitialize the MAC addresses
    173173                  of each virtual network card.
     
    175175            </varlistentry>
    176176            <varlistentry>
    177               <term><option>--option keepdisknames</option></term>
     177              <term><option>--option=keepdisknames</option></term>
    178178              <listitem><para>
    179179                  Specifies that the new clone reuses the disk image
     
    183183            </varlistentry>
    184184            <varlistentry>
    185               <term><option>--option keephwuuids</option></term>
     185              <term><option>--option=keephwuuids</option></term>
    186186              <listitem><para>
    187187                  Specifies that the new clone reuses the hardware IDs
     
    201201      </varlistentry>
    202202      <varlistentry>
    203         <term><option>--snapshot <replaceable>snapshot-name</replaceable></option></term>
     203        <term><option>--snapshot=<replaceable>snapshot-name</replaceable></option></term>
    204204        <listitem><para>
    205205            Specifies the snapshot on which to base the new VM. By
     
    209209      </varlistentry>
    210210      <varlistentry>
    211         <term><option>--uuid <replaceable>uuid</replaceable></option></term>
     211        <term><option>--uuid=<replaceable>uuid</replaceable></option></term>
    212212        <listitem><para>
    213213            Specifies the UUID for the new VM. Ensure that this ID is
     
    222222  <refsect1>
    223223    <title>Examples</title>
    224     <remark role="help-scope"/>
    225224    <para>
    226225      The following command creates and registers an exact clone of the
     
    234233    </para>
    235234<screen>
    236 $ VBoxManage clonevm ol7 --name "ol7-dev-001" --register --mode all \
    237 --options keepallmacs --options keepdisknames --options keephwuuids
     235$ VBoxManage clonevm ol7 --name="ol7-dev-001" --register --mode=all \
     236    --options=keepallmacs --options=keepdisknames --options=keephwuuids
    238237</screen>
    239238    <para>
     
    244243    </para>
    245244<screen>
    246 $ VBoxManage clonevm ol7 --name "ol7-dev-002" --register --snapshot "Snapshot 1"
     245$ VBoxManage clonevm ol7 --name="ol7-dev-002" --register --snapshot="Snapshot 1"
    247246</screen>
    248247  </refsect1>
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette