Changeset 77800 in vbox for trunk/doc

Timestamp:

Mar 19, 2019 5:34:04 PM (6 years ago)

Author:

vboxsync

Message:

manual/man_VBoxManage-snapshot.xml: The 'vm' argument must be 'req' not 'plain' and is more descriptive if given as 'vmname|uuid'. This is the convention used in existing manpages and existing --help output. The 'snapshot' argument should likewise be 'req' rather than 'plain'.

File:

• trunk/doc/manual/en_US/man_VBoxManage-snapshot.xml (modified) (6 diffs)

trunk/doc/manual/en_US/man_VBoxManage-snapshot.xml

@@ -39 +39 @@
 <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
     </cmdsynopsis>
 
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-take">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">take</arg>
 
-      <arg choice="plain"><replaceable>snapshot-name</replaceable></arg>
+      <arg choice="req"><replaceable>snapshot-name</replaceable></arg>
 
       <arg>--description=<replaceable>description</replaceable></arg>
@@ -59 +59 @@
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-delete">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">delete</arg>
 
-      <arg choice="plain"><replaceable>snapshot-name</replaceable></arg>
+      <arg choice="req"><replaceable>snapshot-name</replaceable></arg>
     </cmdsynopsis>
 
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-restore">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">restore</arg>
 
-      <arg choice="plain"><replaceable>snapshot-name</replaceable></arg>
+      <arg choice="req"><replaceable>snapshot-name</replaceable></arg>
     </cmdsynopsis>
 
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-restorecurrent">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">restorecurrent</arg>
@@ -84 +84 @@
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-edit">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">edit</arg>
@@ -100 +100 @@
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-list">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">list</arg>
@@ -109 +109 @@
     <cmdsynopsis id="synopsis-vboxmanage-snapshot-showvminfo">
       <command>VBoxManage snapshot</command>
-      <arg choice="plain"><replaceable>vm</replaceable></arg>
+      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
 
       <arg choice="plain">showvminfo</arg>
 
-      <arg choice="plain"><replaceable>snapshot-name</replaceable></arg>
+      <arg choice="req"><replaceable>snapshot-name</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -149 +149 @@
       <variablelist>
         <varlistentry>
-          <term><replaceable>vm</replaceable></term>
+          <term><replaceable>uuid|vmname</replaceable></term>
           <listitem><para>
               Specifies the UUID or name of the VM.