VirtualBox

Ignore:
Timestamp:
Mar 13, 2022 8:40:25 PM (3 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
150467
Message:

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

Location:
trunk/src/VBox/Frontends/VBoxManage
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

    r94210 r94211  
    249249    { "dhcpserver",         USAGE_S_NEWCMD,   HELP_CMD_DHCPSERVER, handleDHCPServer,           0 },
    250250#ifdef VBOX_WITH_NAT_SERVICE
    251     { "natnetwork",         USAGE_NATNETWORK,       VBMG_CMD_TODO, handleNATNetwork,           0 },
     251    { "natnetwork",         USAGE_S_NEWCMD,   HELP_CMD_NATNETWORK, handleNATNetwork,           0 },
    252252#endif
    253253    { "extpack",            USAGE_S_NEWCMD,      HELP_CMD_EXTPACK, handleExtPack,              0 },
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

    r94210 r94211  
    119119    USAGE_I_GUESTSTATS,
    120120    USAGE_I_REPAIRHD,
    121     USAGE_NATNETWORK,
    122121    USAGE_USBDEVSOURCE,
    123122    /* Insert new entries before this line, but only if it is not an option
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

    r94210 r94211  
    641641                     "\n", SEP);
    642642
    643 #if defined(VBOX_WITH_NAT_SERVICE)
    644     if (enmCommand == USAGE_NATNETWORK || enmCommand == USAGE_S_ALL)
    645     {
    646         RTStrmPrintf(pStrm,
    647                            "%s natnetwork %s      add --netname <name>\n"
    648                      "                            --network <network>\n"
    649                      "                            [--enable|--disable]\n"
    650                      "                            [--dhcp on|off]\n"
    651                      "                            [--port-forward-4 <rule>]\n"
    652                      "                            [--loopback-4 <rule>]\n"
    653                      "                            [--ipv6 on|off]\n"
    654                      "                            [--port-forward-6 <rule>]\n"
    655                      "                            [--loopback-6 <rule>]\n\n"
    656                            "%s natnetwork %s      remove --netname <name>\n\n"
    657                            "%s natnetwork %s      modify --netname <name>\n"
    658                      "                            [--network <network>]\n"
    659                      "                            [--enable|--disable]\n"
    660                      "                            [--dhcp on|off]\n"
    661                      "                            [--port-forward-4 <rule>]\n"
    662                      "                            [--loopback-4 <rule>]\n"
    663                      "                            [--ipv6 on|off]\n"
    664                      "                            [--port-forward-6 <rule>]\n"
    665                      "                            [--loopback-6 <rule>]\n\n"
    666                            "%s natnetwork %s      start --netname <name>\n\n"
    667                            "%s natnetwork %s      stop --netname <name>\n\n"
    668                            "%s natnetwork %s      list [<pattern>]\n"
    669                      "\n", SEP, SEP, SEP, SEP, SEP, SEP);
    670 
    671 
    672     }
    673 #endif
    674 
    675643#if defined(VBOX_WITH_NETFLT)
    676644    if (enmCommand == USAGE_HOSTONLYIFS || enmCommand == USAGE_S_ALL)
  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageNATNetwork.cpp

    r93701 r94211  
    208208{
    209209    if (a->argc - 1 <= 1)
    210         return errorSyntax(USAGE_NATNETWORK, Nat::tr("Not enough parameters"));
     210        return errorSyntax(Nat::tr("Not enough parameters"));
    211211
    212212    const char *pNetName = NULL;
     
    263263            case 't':   // --netname
    264264                if (pNetName)
    265                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can only specify --netname only once."));
     265                    return errorSyntax(Nat::tr("You can only specify --netname only once."));
    266266                pNetName = ValueUnion.psz;
    267267                break;
     
    269269            case 'n':   // --network
    270270                if (pPrefixIPv4)
    271                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can only specify --network only once."));
     271                    return errorSyntax(Nat::tr("You can only specify --network only once."));
    272272                pPrefixIPv4 = ValueUnion.psz;
    273273                break;
     
    275275            case 'e':   // --enable
    276276                if (enable >= 0)
    277                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify either --enable or --disable once."));
     277                    return errorSyntax(Nat::tr("You can specify either --enable or --disable once."));
    278278                enable = 1;
    279279                break;
     
    281281            case 'd':   // --disable
    282282                if (enable >= 0)
    283                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify either --enable or --disable once."));
     283                    return errorSyntax(Nat::tr("You can specify either --enable or --disable once."));
    284284                enable = 0;
    285285                break;
     
    287287            case 'h':
    288288                if (dhcp != -1)
    289                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify --dhcp only once."));
     289                    return errorSyntax(Nat::tr("You can specify --dhcp only once."));
    290290                dhcp = ValueUnion.f;
    291291                break;
     
    293293            case '6':
    294294                if (ipv6 != -1)
    295                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify --ipv6 only once."));
     295                    return errorSyntax(Nat::tr("You can specify --ipv6 only once."));
    296296                ipv6 = ValueUnion.f;
    297297                break;
     
    299299            case kNATNetwork_IPv6Prefix:
    300300                if (pPrefixIPv6)
    301                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify --ipv6-prefix only once."));
     301                    return errorSyntax(Nat::tr("You can specify --ipv6-prefix only once."));
    302302                pPrefixIPv6 = ValueUnion.psz;
    303303                break;
     
    305305            case kNATNetwork_IPv6Default: // XXX: uwe
    306306                if (ipv6_default != -1)
    307                     return errorSyntax(USAGE_NATNETWORK, Nat::tr("You can specify --ipv6-default only once."));
     307                    return errorSyntax(Nat::tr("You can specify --ipv6-default only once."));
    308308                ipv6_default = ValueUnion.f;
    309309                break;
     
    315315                    /* deletion */
    316316                    if (enmCode != OP_MODIFY)
    317                       errorSyntax(USAGE_NATNETWORK,
    318                                   Nat::tr("loopback couldn't be deleted on modified\n"));
     317                      errorSyntax(Nat::tr("loopback couldn't be deleted on modified\n"));
    319318                    if (c == 'L')
    320319                        loopback6Offset = -1;
     
    327326                                                 RTGETOPT_REQ_STRING);
    328327                        if (RT_FAILURE(vrc))
    329                           return errorSyntax(USAGE_NATNETWORK,
    330                                              Nat::tr("Not enough parаmeters\n"));
     328                          return errorSyntax(Nat::tr("Not enough parаmeters\n"));
    331329
    332330                        vLoopback2Delete.push_back(std::string(Addr2Delete.psz));
     
    353351                    int irc = netPfStrToPf(ValueUnion.psz, (c == 'P'), &Pfr);
    354352                    if (RT_FAILURE(irc))
    355                         return errorSyntax(USAGE_NATNETWORK, Nat::tr("Invalid port-forward rule %s\n"), ValueUnion.psz);
     353                        return errorSyntax(Nat::tr("Invalid port-forward rule %s\n"), ValueUnion.psz);
    356354
    357355                    vPf2Add.push_back(Pfr);
     
    361359                    /* deletion */
    362360                    if (enmCode != OP_MODIFY)
    363                         return errorSyntax(USAGE_NATNETWORK,
    364                                            Nat::tr("Port-forward could be deleted on modify\n"));
     361                        return errorSyntax(Nat::tr("Port-forward could be deleted on modify\n"));
    365362
    366363                    RTGETOPTUNION NamePf2DeleteUnion;
    367364                    int vrc = RTGetOptFetchValue(&GetState, &NamePf2DeleteUnion, RTGETOPT_REQ_STRING);
    368365                    if (RT_FAILURE(vrc))
    369                         return errorSyntax(USAGE_NATNETWORK, Nat::tr("Not enough parаmeters\n"));
     366                        return errorSyntax(Nat::tr("Not enough parаmeters\n"));
    370367
    371368                    if (strlen(NamePf2DeleteUnion.psz) > PF_NAMELEN)
    372                         return errorSyntax(USAGE_NATNETWORK, Nat::tr("Port-forward rule name is too long\n"));
     369                        return errorSyntax(Nat::tr("Port-forward rule name is too long\n"));
    373370
    374371                    PFNAME2DELETE Name2Delete;
     
    382379
    383380            default:
    384                 return errorGetOpt(USAGE_NATNETWORK, c, &ValueUnion);
     381                return errorGetOpt(c, &ValueUnion);
    385382        }
    386383    }
    387384
    388385    if (!pNetName)
    389         return errorSyntax(USAGE_NATNETWORK, Nat::tr("You need to specify the --netname option"));
     386        return errorSyntax(Nat::tr("You need to specify the --netname option"));
    390387    /* verification */
    391388    switch (enmCode)
     
    393390        case OP_ADD:
    394391            if (!pPrefixIPv4)
    395                 return errorSyntax(USAGE_NATNETWORK, Nat::tr("You need to specify the --network option"));
     392                return errorSyntax(Nat::tr("You need to specify the --network option"));
    396393            break;
    397394        case OP_MODIFY:
     
    607604{
    608605    if (a->argc < 1)
    609         return errorSyntax(USAGE_NATNETWORK, Nat::tr("Not enough parameters"));
     606        return errorSyntax(Nat::tr("Not enough parameters"));
    610607
    611608    RTEXITCODE rcExit;
    612609    if (strcmp(a->argv[0], "modify") == 0)
     610    {
     611        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_MODIFY);
    613612        rcExit = handleOp(a, OP_MODIFY);
     613    }
    614614    else if (strcmp(a->argv[0], "add") == 0)
     615    {
     616        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_ADD);
    615617        rcExit = handleOp(a, OP_ADD);
     618    }
    616619    else if (strcmp(a->argv[0], "remove") == 0)
     620    {
     621        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_REMOVE);
    617622        rcExit = handleOp(a, OP_REMOVE);
     623    }
    618624    else if (strcmp(a->argv[0], "start") == 0)
     625    {
     626        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_START);
    619627        rcExit = handleOp(a, OP_START);
     628    }
    620629    else if (strcmp(a->argv[0], "stop") == 0)
     630    {
     631        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_STOP);
    621632        rcExit = handleOp(a, OP_STOP);
     633    }
    622634    else if (strcmp(a->argv[0], "list") == 0)
     635    {
     636        setCurrentSubcommand(HELP_SCOPE_NATNETWORK_LIST);
    623637        rcExit = handleNATList(a);
     638    }
    624639    else
    625         rcExit = errorSyntax(USAGE_NATNETWORK, Nat::tr("Invalid parameter '%s'"), a->argv[0]);
     640        rcExit = errorSyntax(Nat::tr("Invalid parameter '%s'"), a->argv[0]);
    626641    return rcExit;
    627642}
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