Changeset 94212 in vbox for trunk

Timestamp:

Mar 13, 2022 8:47:36 PM (3 years ago)

Author:

vboxsync

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

150468

Message:

doc/manual,FE/VBoxManage: Convert hostonlyif command to refentry documentation, ​bugref:9186

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-hostonlyif.xml (modified) (2 diffs)
• doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.h (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHostonly.cpp (modified) (6 diffs)

trunk/doc/manual/Config.kmk

@@ -81 +81 @@
         man_VBoxManage-guestcontrol.xml \
         man_VBoxManage-metrics.xml \
-        man_VBoxManage-natnetwork.xml
+        man_VBoxManage-natnetwork.xml \
+        man_VBoxManage-hostonlyif.xml
 
 ## List of user manual XML files.

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

@@ -20 +20 @@
 <refentry id="vboxmanage-hostonlyif" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage hostonlyif</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-hostonlyif</refname>
     <refpurpose>manage host-only network interfaces</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1121 +1121 @@
   <xi:include href="user_man_VBoxManage-natnetwork.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-hostonlyif">
-
-    <title>VBoxManage hostonlyif</title>
-
-    <para>
-      The <command>hostonlyif</command> command enables you to change
-      the IP configuration of a host-only network interface. For a
-      description of host-only networking, see
-      <xref linkend="network_hostonly" />. Each host-only interface is
-      identified by a name and can either use the internal DHCP server
-      or a manual IP configuration, both IP4 and IP6.
-    </para>
-
-    <para>
-      The following list summarizes the available subcommands:
-    </para>
-
-    <variablelist>
-
-      <varlistentry>
-        <term>
-          <computeroutput>ipconfig "&lt;name&gt;"</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Configures a host-only interface.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>create</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Creates a new vboxnet&lt;N&gt; interface on the host OS.
-            This command is essential before you can attach VMs to a
-            host-only network.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>remove vboxnet&lt;N&gt;</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Removes a vboxnet&lt;N&gt; interface from the host OS.
-          </para>
-        </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-hostonlyif.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-hostonlynet.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ -242 +242 @@
     { "signova",            USAGE_S_NEWCMD,      HELP_CMD_SIGNOVA, handleSignAppliance,        VBMG_CMD_F_NO_COM },
 #ifdef VBOX_WITH_NETFLT
-    { "hostonlyif",         USAGE_HOSTONLYIFS,      VBMG_CMD_TODO, handleHostonlyIf,           0 },
+    { "hostonlyif",         USAGE_S_NEWCMD,   HELP_CMD_HOSTONLYIF, handleHostonlyIf,           0 },
 #endif
 #ifdef VBOX_WITH_VMNET

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -111 +111 @@
     USAGE_I_CONVERTTORAW,
     USAGE_I_CONVERTHD,
-    USAGE_HOSTONLYIFS,
     USAGE_I_DUMPHDINFO,
     USAGE_STORAGEATTACH,

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

@@ -641 +641 @@
                      "\n", SEP);
 
-#if defined(VBOX_WITH_NETFLT)
-    if (enmCommand == USAGE_HOSTONLYIFS || enmCommand == USAGE_S_ALL)
-    {
-        RTStrmPrintf(pStrm,
-                           "%s hostonlyif %s      ipconfig <name>\n"
-                     "                            [--dhcp |\n"
-                     "                            --ip <ipv4> [--netmask <ipv4> (def:255.255.255.0)]|\n"
-                     "                            --ipv6 <ipv6> [--netmasklengthv6 <N> (def:64)]]", SEP);
-# if !defined(RT_OS_SOLARIS) || defined(VBOX_ONLY_DOCS)
-        RTStrmPrintf(pStrm,
-                     " |\n"
-                     "                            create |\n"
-                     "                            remove <name>\n");
-# else
-        RTStrmPrintf(pStrm,
-                     "\n");
-# endif
-        RTStrmPrintf(pStrm,
-                     "\n");
-    }
-#endif
-
     if (enmCommand == USAGE_USBDEVSOURCE || enmCommand == USAGE_S_ALL)
     {

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHostonly.cpp

@@ -72 +72 @@
 
             default:
-                return errorGetOpt(USAGE_HOSTONLYIFS, c, &ValueUnion);
+                return errorGetOpt(c, &ValueUnion);
         }
     }
@@ -123 +123 @@
             case VINF_GETOPT_NOT_OPTION:
                 if (pszName)
-                    return errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("Only one interface name can be specified"));
+                    return errorSyntax(HostOnly::tr("Only one interface name can be specified"));
                 pszName = ValueUnion.psz;
                 break;
 
             default:
-                return errorGetOpt(USAGE_HOSTONLYIFS, ch, &ValueUnion);
+                return errorGetOpt(ch, &ValueUnion);
         }
     if (!pszName)
-        return errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("No interface name was specified"));
+        return errorSyntax(HostOnly::tr("No interface name was specified"));
 
     /*
@@ -214 +214 @@
             case VINF_GETOPT_NOT_OPTION:
                 if (pszName)
-                    return errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("Only one interface name can be specified"));
+                    return errorSyntax(HostOnly::tr("Only one interface name can be specified"));
                 pszName = ValueUnion.psz;
                 break;
             default:
-                return errorGetOpt(USAGE_HOSTONLYIFS, c, &ValueUnion);
+                return errorGetOpt(c, &ValueUnion);
         }
     }
@@ -224 +224 @@
     /* parameter sanity check */
     if (fDhcp && (fNetmasklengthv6 || pszIpv6 || pszIp || pszNetmask))
-        return errorSyntax(USAGE_HOSTONLYIFS,
-                           HostOnly::tr("You can not use --dhcp with static ip configuration parameters: --ip, --netmask, --ipv6 and --netmasklengthv6."));
+        return errorSyntax(HostOnly::tr("You can not use --dhcp with static ip configuration parameters: --ip, --netmask, --ipv6 and --netmasklengthv6."));
     if ((pszIp || pszNetmask) && (fNetmasklengthv6 || pszIpv6))
-        return errorSyntax(USAGE_HOSTONLYIFS,
-                           HostOnly::tr("You can not use ipv4 configuration (--ip and --netmask) with ipv6 (--ipv6 and --netmasklengthv6) simultaneously."));
+        return errorSyntax(HostOnly::tr("You can not use ipv4 configuration (--ip and --netmask) with ipv6 (--ipv6 and --netmasklengthv6) simultaneously."));
 
     ComPtr<IHost> host;
@@ -261 +259 @@
     }
     else
-        return errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("Neither -dhcp nor -ip nor -ipv6 was specfified"));
+        return errorSyntax(HostOnly::tr("Neither -dhcp nor -ip nor -ipv6 was specfified"));
 
     return RTEXITCODE_SUCCESS;
@@ -270 +268 @@
 {
     if (a->argc < 1)
-        return errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("No sub-command specified"));
+        return errorSyntax(HostOnly::tr("No sub-command specified"));
 
     RTEXITCODE rcExit;
     if (!strcmp(a->argv[0], "ipconfig"))
+    {
+        setCurrentSubcommand(HELP_SCOPE_HOSTONLYIF_IPCONFIG);
         rcExit = handleIpConfig(a);
+    }
 #if defined(VBOX_WITH_NETFLT) && !defined(RT_OS_SOLARIS)
     else if (!strcmp(a->argv[0], "create"))
+    {
+        setCurrentSubcommand(HELP_SCOPE_HOSTONLYIF_CREATE);
         rcExit = handleCreate(a);
+    }
     else if (!strcmp(a->argv[0], "remove"))
+    {
+        setCurrentSubcommand(HELP_SCOPE_HOSTONLYIF_REMOVE);
         rcExit = handleRemove(a);
+    }
 #endif
     else
-        rcExit = errorSyntax(USAGE_HOSTONLYIFS, HostOnly::tr("Unknown sub-command '%s'"), a->argv[0]);
+        rcExit = errorSyntax(HostOnly::tr("Unknown sub-command '%s'"), a->argv[0]);
     return rcExit;
 }