Changeset 101164 in vbox for trunk/doc/manual

Timestamp:

Sep 19, 2023 10:01:39 AM (17 months ago)

Author:

vboxsync

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

159137

Message:

doc/manual,Frontends/VBoxManage,Main/{Global,GuestOSType,VirtualBox.xidl}:
Extend the OSType struct by including a new element named 'variant'
to provide further guest OS details and aid in guest OS categorization
for the GUI when creating VMs. Populate this field in the
Global::sOSTypes[] table for Linux using the distro name and for BSD
using the BSD flavour. Include the variant information in 'VBoxManage
list ostypes' and add a new 'VBoxManage list osvariants' subcommand.
Add new IVirtualBox methods for accessing the guest OS variant
information: getGuestOSVariantsByFamilyId() and getGuestOSDescsByVariant().
bugref:5936

File:

• trunk/doc/manual/en_US/man_VBoxManage-list.xml (modified) (2 diffs)

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

@@ -75 +75 @@
         <arg choice="plain">natnets</arg>
         <arg choice="plain">ostypes</arg>
+        <arg choice="plain">osvariants</arg>
         <arg choice="plain">runningvms</arg>
         <arg choice="plain">screenshotformats</arg>
@@ -411 +412 @@
       </para>
     </refsect2>
+    <refsect2 id="vboxmanage-list-osvariants">
+      <title>List the Guest Operating System Variants</title>
+      <cmdsynopsis id="synopsis-vboxmanage-list-osvariants">
+        <command>VBoxManage list</command>
+        <arg choice="plain">osvariants</arg>
+      </cmdsynopsis>
+      <para>
+        The <command>VBoxManage list osvariants</command> command lists
+        all guest operating system (OS) variants along with the
+        associated guest OS descriptions that are known to &product-name;.
+        Each list entry includes a guest OS family identifier, the guest
+        OS variants associated with that OS family (if any), and a
+        description the guest OSes associated with that OS variant.
+      </para>
+    </refsect2>
     <refsect2 id="vboxmanage-list-runningvms">
       <title>List the Running Virtual Machines</title>