Changeset 89923 in vbox for trunk/doc/manual

Timestamp:

Jun 25, 2021 8:54:24 PM (4 years ago)

Author:

vboxsync

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

145381

Message:

doc/man_VBoxManage-*.xml: Made 4 man pages ready for use in the manual. Eliminated some inaccuracies and improved the accuracy of some descriptions. Most was perfectly true over 10 years ago but the functionality today was not covered.

Location:

trunk/doc/manual/en_US

Files:

• man_VBoxManage-createvm.xml (modified) (5 diffs)
• man_VBoxManage-registervm.xml (modified) (2 diffs)
• man_VBoxManage-showvminfo.xml (modified) (2 diffs)
• man_VBoxManage-unregistervm.xml (modified) (1 diff)

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

@@ -20 +20 @@
 <refentry id="vboxmanage-createvm" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage createvm</title>
   </refentryinfo>
@@ -42 +42 @@
       <arg>--basefolder=<replaceable>basefolder</replaceable></arg>
       <arg>--default</arg>
-      <arg>--group=<replaceable>group-ID</replaceable>, ...</arg>
+      <arg>--group=<replaceable>group-ID</replaceable>,...</arg>
       <arg>--ostype=<replaceable>ostype</replaceable></arg>
       <arg>--register</arg>
@@ -64 +64 @@
     </para>
     <para>
-      Ensure that the VM name conforms to the host OS file name
-      requirements. If you later rename the VM, the file and folder
-      names will be updated to match the new name automatically.
+      The actual file name may not correspond directly to the VM name
+      if it violates the host OS file name requirements (such as using
+      the path separator or other reserved characters, they will be
+      substituted with a placeholder). If you later rename the VM, the
+      file and folder names will be updated to match the new name
+      automatically.
     </para>
   </refsect1>
@@ -96 +99 @@
       </varlistentry>
       <varlistentry>
-        <term><option>--group=<replaceable>group-ID</replaceable>, ...</option></term>
+        <term><option>--group=<replaceable>group-ID</replaceable>,...</option></term>
         <listitem><para>
             Assigns the VM to the specified groups. If you specify more
@@ -133 +136 @@
             &product-name; namespace of the host or of its VM group
             memberships if you decide to register the VM. By default,
-            &product-name; command provides the UUID.
+            &product-name; provides the UUID.
           </para></listitem>
       </varlistentry>

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

@@ -20 +20 @@
 <refentry id="vboxmanage-registervm" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage registervm</title>
   </refentryinfo>
@@ -48 +48 @@
       The <command>VBoxManage registervm</command> command enables you
       to create a virtual machine (VM) by importing an XML machine
-      configuration file into &product-name;. The VM cannot conflict
-      with a VM that is already registered in &product-name;. In
-      addition, the VM cannot have any hard disks or removable disks
-      attached. Ensure that the XML machine configuration file is in the
-      machines folder prior to registration.
+      configuration file into &product-name;. The VM cannot have the
+      same UUID as a VM that is already registered in &product-name;.
+      Ensure that the XML machine configuration file is in the machines
+      folder prior to registration.
     </para>
     <note>

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

@@ -20 +20 @@
 <refentry id="vboxmanage-showvminfo" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage showvminfo</title>
   </refentryinfo>
@@ -75 +75 @@
       <para>
         The <command>VBoxManage showvminfo</command> command shows the
-        same information as the <command>VBoxManage list vms
-        --long</command> command for the specified VM.
+        same information for the specified VM in the same format as the
+        <command>VBoxManage list vms --long</command> command.
       </para>
       <variablelist>

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

@@ -20 +20 @@
 <refentry id="vboxmanage-unregistervm" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage unregistervm</title>
   </refentryinfo>