VirtualBox

source: vbox/trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp@ 75500

Last change on this file since 75500 was 75365, checked in by vboxsync, 6 years ago

Recording: Also adapted the VBoxManage commands to the "recording" prefix.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 65.0 KB
Line 
1/* $Id: VBoxManageHelp.cpp 75365 2018-11-09 13:55:30Z vboxsync $ */
2/** @file
3 * VBoxManage - help and other message output.
4 */
5
6/*
7 * Copyright (C) 2006-2017 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/*********************************************************************************************************************************
20* Header Files *
21*********************************************************************************************************************************/
22#include <VBox/version.h>
23
24#include <iprt/buildconfig.h>
25#include <iprt/ctype.h>
26#include <iprt/env.h>
27#include <iprt/err.h>
28#include <iprt/getopt.h>
29#include <iprt/stream.h>
30#include <iprt/message.h>
31
32#include "VBoxManage.h"
33
34
35/*********************************************************************************************************************************
36* Defined Constants And Macros *
37*********************************************************************************************************************************/
38/** If the usage is the given number of length long or longer, the error is
39 * repeated so the user can actually see it. */
40#define ERROR_REPEAT_AFTER_USAGE_LENGTH 16
41
42
43/*********************************************************************************************************************************
44* Global Variables *
45*********************************************************************************************************************************/
46#ifndef VBOX_ONLY_DOCS
47enum HELP_CMD_VBOXMANAGE g_enmCurCommand = HELP_CMD_VBOXMANAGE_INVALID;
48/** The scope maskt for the current subcommand. */
49uint64_t g_fCurSubcommandScope = RTMSGREFENTRYSTR_SCOPE_GLOBAL;
50
51/**
52 * Sets the current command.
53 *
54 * This affects future calls to error and help functions.
55 *
56 * @param enmCommand The command.
57 */
58void setCurrentCommand(enum HELP_CMD_VBOXMANAGE enmCommand)
59{
60 Assert(g_enmCurCommand == HELP_CMD_VBOXMANAGE_INVALID);
61 g_enmCurCommand = enmCommand;
62 g_fCurSubcommandScope = RTMSGREFENTRYSTR_SCOPE_GLOBAL;
63}
64
65
66/**
67 * Sets the current subcommand.
68 *
69 * This affects future calls to error and help functions.
70 *
71 * @param fSubcommandScope The subcommand scope.
72 */
73void setCurrentSubcommand(uint64_t fSubcommandScope)
74{
75 g_fCurSubcommandScope = fSubcommandScope;
76}
77
78
79
80
81/**
82 * Prints brief help for a command or subcommand.
83 *
84 * @returns Number of lines written.
85 * @param enmCommand The command.
86 * @param fSubcommandScope The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
87 * for all.
88 * @param pStrm The output stream.
89 */
90static uint32_t printBriefCommandOrSubcommandHelp(enum HELP_CMD_VBOXMANAGE enmCommand, uint64_t fSubcommandScope, PRTSTREAM pStrm)
91{
92 uint32_t cLinesWritten = 0;
93 uint32_t cPendingBlankLines = 0;
94 uint32_t cFound = 0;
95 for (uint32_t i = 0; i < g_cHelpEntries; i++)
96 {
97 PCRTMSGREFENTRY pHelp = g_apHelpEntries[i];
98 if (pHelp->idInternal == (int64_t)enmCommand)
99 {
100 cFound++;
101 if (cFound == 1)
102 {
103 if (fSubcommandScope == RTMSGREFENTRYSTR_SCOPE_GLOBAL)
104 RTStrmPrintf(pStrm, "Usage - %c%s:\n", RT_C_TO_UPPER(pHelp->pszBrief[0]), pHelp->pszBrief + 1);
105 else
106 RTStrmPrintf(pStrm, "Usage:\n");
107 }
108 RTMsgRefEntryPrintStringTable(pStrm, &pHelp->Synopsis, fSubcommandScope, &cPendingBlankLines, &cLinesWritten);
109 if (!cPendingBlankLines)
110 cPendingBlankLines = 1;
111 }
112 }
113 Assert(cFound > 0);
114 return cLinesWritten;
115}
116
117
118/**
119 * Prints the brief usage information for the current (sub)command.
120 *
121 * @param pStrm The output stream.
122 */
123void printUsage(PRTSTREAM pStrm)
124{
125 printBriefCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, pStrm);
126}
127
128
129/**
130 * Prints full help for a command or subcommand.
131 *
132 * @param enmCommand The command.
133 * @param fSubcommandScope The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
134 * for all.
135 * @param pStrm The output stream.
136 */
137static void printFullCommandOrSubcommandHelp(enum HELP_CMD_VBOXMANAGE enmCommand, uint64_t fSubcommandScope, PRTSTREAM pStrm)
138{
139 uint32_t cPendingBlankLines = 0;
140 uint32_t cFound = 0;
141 for (uint32_t i = 0; i < g_cHelpEntries; i++)
142 {
143 PCRTMSGREFENTRY pHelp = g_apHelpEntries[i];
144 if ( pHelp->idInternal == (int64_t)enmCommand
145 || enmCommand == HELP_CMD_VBOXMANAGE_INVALID)
146 {
147 cFound++;
148 RTMsgRefEntryPrintStringTable(pStrm, &pHelp->Help, fSubcommandScope, &cPendingBlankLines, NULL /*pcLinesWritten*/);
149 if (cPendingBlankLines < 2)
150 cPendingBlankLines = 2;
151 }
152 }
153 Assert(cFound > 0);
154}
155
156
157/**
158 * Prints the full help for the current (sub)command.
159 *
160 * @param pStrm The output stream.
161 */
162void printHelp(PRTSTREAM pStrm)
163{
164 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, pStrm);
165}
166
167
168/**
169 * Display no subcommand error message and current command usage.
170 *
171 * @returns RTEXITCODE_SYNTAX.
172 */
173RTEXITCODE errorNoSubcommand(void)
174{
175 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
176 Assert(g_fCurSubcommandScope == RTMSGREFENTRYSTR_SCOPE_GLOBAL);
177
178 return errorSyntax("No subcommand specified");
179}
180
181
182/**
183 * Display unknown subcommand error message and current command usage.
184 *
185 * May show full command help instead if the subcommand is a common help option.
186 *
187 * @returns RTEXITCODE_SYNTAX, or RTEXITCODE_SUCCESS if common help option.
188 * @param pszSubcommand The name of the alleged subcommand.
189 */
190RTEXITCODE errorUnknownSubcommand(const char *pszSubcommand)
191{
192 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
193 Assert(g_fCurSubcommandScope == RTMSGREFENTRYSTR_SCOPE_GLOBAL);
194
195 /* check if help was requested. */
196 if ( strcmp(pszSubcommand, "--help") == 0
197 || strcmp(pszSubcommand, "-h") == 0
198 || strcmp(pszSubcommand, "-?") == 0)
199 {
200 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdOut);
201 return RTEXITCODE_SUCCESS;
202 }
203
204 return errorSyntax("Unknown subcommand: %s", pszSubcommand);
205}
206
207
208/**
209 * Display too many parameters error message and current command usage.
210 *
211 * May show full command help instead if the subcommand is a common help option.
212 *
213 * @returns RTEXITCODE_SYNTAX, or RTEXITCODE_SUCCESS if common help option.
214 * @param papszArgs The first unwanted parameter. Terminated by
215 * NULL entry.
216 */
217RTEXITCODE errorTooManyParameters(char **papszArgs)
218{
219 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
220 Assert(g_fCurSubcommandScope != RTMSGREFENTRYSTR_SCOPE_GLOBAL);
221
222 /* check if help was requested. */
223 if (papszArgs)
224 {
225 for (uint32_t i = 0; papszArgs[i]; i++)
226 if ( strcmp(papszArgs[i], "--help") == 0
227 || strcmp(papszArgs[i], "-h") == 0
228 || strcmp(papszArgs[i], "-?") == 0)
229 {
230 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdOut);
231 return RTEXITCODE_SUCCESS;
232 }
233 else if (!strcmp(papszArgs[i], "--"))
234 break;
235 }
236
237 return errorSyntax("Too many parameters");
238}
239
240
241/**
242 * Display current (sub)command usage and the custom error message.
243 *
244 * @returns RTEXITCODE_SYNTAX.
245 * @param pszFormat Custom error message format string.
246 * @param ... Format arguments.
247 */
248RTEXITCODE errorSyntax(const char *pszFormat, ...)
249{
250 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
251
252 showLogo(g_pStdErr);
253
254 va_list va;
255 va_start(va, pszFormat);
256 RTMsgErrorV(pszFormat, va);
257 va_end(va);
258
259 RTStrmPutCh(g_pStdErr, '\n');
260 if ( printBriefCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdErr)
261 >= ERROR_REPEAT_AFTER_USAGE_LENGTH)
262 {
263 /* Usage was very long, repeat the error message. */
264 RTStrmPutCh(g_pStdErr, '\n');
265 va_start(va, pszFormat);
266 RTMsgErrorV(pszFormat, va);
267 va_end(va);
268 }
269 return RTEXITCODE_SYNTAX;
270}
271
272
273/**
274 * Worker for errorGetOpt.
275 *
276 * @param rcGetOpt The RTGetOpt return value.
277 * @param pValueUnion The value union returned by RTGetOpt.
278 */
279static void errorGetOptWorker(int rcGetOpt, union RTGETOPTUNION const *pValueUnion)
280{
281 if (rcGetOpt == VINF_GETOPT_NOT_OPTION)
282 RTMsgError("Invalid parameter '%s'", pValueUnion->psz);
283 else if (rcGetOpt > 0)
284 {
285 if (RT_C_IS_PRINT(rcGetOpt))
286 RTMsgError("Invalid option -%c", rcGetOpt);
287 else
288 RTMsgError("Invalid option case %i", rcGetOpt);
289 }
290 else if (rcGetOpt == VERR_GETOPT_UNKNOWN_OPTION)
291 RTMsgError("Unknown option: %s", pValueUnion->psz);
292 else if (rcGetOpt == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
293 RTMsgError("Invalid argument format: %s", pValueUnion->psz);
294 else if (pValueUnion->pDef)
295 RTMsgError("%s: %Rrs", pValueUnion->pDef->pszLong, rcGetOpt);
296 else
297 RTMsgError("%Rrs", rcGetOpt);
298}
299
300
301/**
302 * Handled an RTGetOpt error or common option.
303 *
304 * This implements the 'V' and 'h' cases. It reports appropriate syntax errors
305 * for other @a rcGetOpt values.
306 *
307 * @retval RTEXITCODE_SUCCESS if help or version request.
308 * @retval RTEXITCODE_SYNTAX if not help or version request.
309 * @param rcGetOpt The RTGetOpt return value.
310 * @param pValueUnion The value union returned by RTGetOpt.
311 */
312RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion)
313{
314 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
315
316 /*
317 * Check if it is an unhandled standard option.
318 */
319 if (rcGetOpt == 'V')
320 {
321 RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
322 return RTEXITCODE_SUCCESS;
323 }
324
325 if (rcGetOpt == 'h')
326 {
327 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdOut);
328 return RTEXITCODE_SUCCESS;
329 }
330
331 /*
332 * We failed.
333 */
334 showLogo(g_pStdErr);
335 errorGetOptWorker(rcGetOpt, pValueUnion);
336 if ( printBriefCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdErr)
337 >= ERROR_REPEAT_AFTER_USAGE_LENGTH)
338 {
339 /* Usage was very long, repeat the error message. */
340 RTStrmPutCh(g_pStdErr, '\n');
341 errorGetOptWorker(rcGetOpt, pValueUnion);
342 }
343 return RTEXITCODE_SYNTAX;
344}
345
346#endif /* !VBOX_ONLY_DOCS */
347
348
349
350void showLogo(PRTSTREAM pStrm)
351{
352 static bool s_fShown; /* show only once */
353
354 if (!s_fShown)
355 {
356 RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
357 VBOX_VERSION_STRING "\n"
358 "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
359 "All rights reserved.\n"
360 "\n");
361 s_fShown = true;
362 }
363}
364
365
366
367
368void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm)
369{
370 bool fDumpOpts = false;
371#ifdef RT_OS_LINUX
372 bool fLinux = true;
373#else
374 bool fLinux = false;
375#endif
376#ifdef RT_OS_WINDOWS
377 bool fWin = true;
378#else
379 bool fWin = false;
380#endif
381#ifdef RT_OS_SOLARIS
382 bool fSolaris = true;
383#else
384 bool fSolaris = false;
385#endif
386#ifdef RT_OS_FREEBSD
387 bool fFreeBSD = true;
388#else
389 bool fFreeBSD = false;
390#endif
391#ifdef RT_OS_DARWIN
392 bool fDarwin = true;
393#else
394 bool fDarwin = false;
395#endif
396#ifdef VBOX_WITH_VBOXSDL
397 bool fVBoxSDL = true;
398#else
399 bool fVBoxSDL = false;
400#endif
401
402 if (fCategory == USAGE_DUMPOPTS)
403 {
404 fDumpOpts = true;
405 fLinux = true;
406 fWin = true;
407 fSolaris = true;
408 fFreeBSD = true;
409 fDarwin = true;
410 fVBoxSDL = true;
411 fCategory = USAGE_ALL;
412 }
413
414 RTStrmPrintf(pStrm,
415 "Usage:\n"
416 "\n");
417
418 if (fCategory == USAGE_ALL)
419 RTStrmPrintf(pStrm,
420 " VBoxManage [<general option>] <command>\n"
421 " \n \n"
422 "General Options:\n \n"
423 " [-v|--version] print version number and exit\n"
424 " [-q|--nologo] suppress the logo\n"
425 " [--settingspw <pw>] provide the settings password\n"
426 " [--settingspwfile <file>] provide a file containing the settings password\n"
427 " [@<response-file>] load arguments from the given response file (bourne style)\n"
428 " \n \n"
429 "Commands:\n \n");
430
431 const char *pcszSep1 = " ";
432 const char *pcszSep2 = " ";
433 if (fCategory != USAGE_ALL)
434 {
435 pcszSep1 = "VBoxManage";
436 pcszSep2 = "";
437 }
438
439#define SEP pcszSep1, pcszSep2
440
441 if (fCategory & USAGE_LIST)
442 RTStrmPrintf(pStrm,
443 "%s list [--long|-l] [--sorted|-s]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
444#if defined(VBOX_WITH_NETFLT)
445 " intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|\n"
446#else
447 " intnets|bridgedifs|natnets|dhcpservers|hostinfo|\n"
448#endif
449 " hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|\n"
450 " usbhost|usbfilters|systemproperties|extpacks|\n"
451 " groups|webcams|screenshotformats|cloudproviders|\n"
452 " cloudprofiles\n"
453 "\n", SEP);
454
455 if (fCategory & USAGE_SHOWVMINFO)
456 RTStrmPrintf(pStrm,
457 "%s showvminfo %s <uuid|vmname> [--details]\n"
458 " [--machinereadable]\n"
459 "%s showvminfo %s <uuid|vmname> --log <idx>\n"
460 "\n", SEP, SEP);
461
462 if (fCategory & USAGE_REGISTERVM)
463 RTStrmPrintf(pStrm,
464 "%s registervm %s <filename>\n"
465 "\n", SEP);
466
467 if (fCategory & USAGE_UNREGISTERVM)
468 RTStrmPrintf(pStrm,
469 "%s unregistervm %s <uuid|vmname> [--delete]\n"
470 "\n", SEP);
471
472 if (fCategory & USAGE_CREATEVM)
473 RTStrmPrintf(pStrm,
474 "%s createvm %s --name <name>\n"
475 " [--groups <group>, ...]\n"
476 " [--ostype <ostype>]\n"
477 " [--register]\n"
478 " [--basefolder <path>]\n"
479 " [--uuid <uuid>]\n"
480 " [--default]\n"
481 "\n", SEP);
482
483 if (fCategory & USAGE_MODIFYVM)
484 {
485 RTStrmPrintf(pStrm,
486 "%s modifyvm %s <uuid|vmname>\n"
487 " [--name <name>]\n"
488 " [--groups <group>, ...]\n"
489 " [--description <desc>]\n"
490 " [--ostype <ostype>]\n"
491 " [--iconfile <filename>]\n"
492 " [--memory <memorysize in MB>]\n"
493 " [--pagefusion on|off]\n"
494 " [--vram <vramsize in MB>]\n"
495 " [--acpi on|off]\n"
496#ifdef VBOX_WITH_PCI_PASSTHROUGH
497 " [--pciattach 03:04.0]\n"
498 " [--pciattach 03:04.0@02:01.0]\n"
499 " [--pcidetach 03:04.0]\n"
500#endif
501 " [--ioapic on|off]\n"
502 " [--hpet on|off]\n"
503 " [--triplefaultreset on|off]\n"
504 " [--apic on|off]\n"
505 " [--x2apic on|off]\n"
506 " [--paravirtprovider none|default|legacy|minimal|\n"
507 " hyperv|kvm]\n"
508 " [--paravirtdebug <key=value> [,<key=value> ...]]\n"
509 " [--hwvirtex on|off]\n"
510 " [--nestedpaging on|off]\n"
511 " [--largepages on|off]\n"
512 " [--vtxvpid on|off]\n"
513 " [--vtxux on|off]\n"
514 " [--pae on|off]\n"
515 " [--longmode on|off]\n"
516 " [--ibpb-on-vm-exit on|off]\n"
517 " [--ibpb-on-vm-entry on|off]\n"
518 " [--spec-ctrl on|off]\n"
519 " [--nested-hw-virt on|off]\n"
520 " [--cpu-profile \"host|Intel 80[86|286|386]\"]\n"
521 " [--cpuid-portability-level <0..3>\n"
522 " [--cpuid-set <leaf[:subleaf]> <eax> <ebx> <ecx> <edx>]\n"
523 " [--cpuid-remove <leaf[:subleaf]>]\n"
524 " [--cpuidremoveall]\n"
525 " [--hardwareuuid <uuid>]\n"
526 " [--cpus <number>]\n"
527 " [--cpuhotplug on|off]\n"
528 " [--plugcpu <id>]\n"
529 " [--unplugcpu <id>]\n"
530 " [--cpuexecutioncap <1-100>]\n"
531 " [--rtcuseutc on|off]\n"
532#ifdef VBOX_WITH_VMSVGA
533 " [--graphicscontroller none|vboxvga|vmsvga|vboxsvga]\n"
534#else
535 " [--graphicscontroller none|vboxvga]\n"
536#endif
537 " [--monitorcount <number>]\n"
538 " [--accelerate3d on|off]\n"
539#ifdef VBOX_WITH_VIDEOHWACCEL
540 " [--accelerate2dvideo on|off]\n"
541#endif
542 " [--firmware bios|efi|efi32|efi64]\n"
543 " [--chipset ich9|piix3]\n"
544 " [--bioslogofadein on|off]\n"
545 " [--bioslogofadeout on|off]\n"
546 " [--bioslogodisplaytime <msec>]\n"
547 " [--bioslogoimagepath <imagepath>]\n"
548 " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
549 " [--biosapic disabled|apic|x2apic]\n"
550 " [--biossystemtimeoffset <msec>]\n"
551 " [--biospxedebug on|off]\n"
552 " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
553 " [--nic<1-N> none|null|nat|bridged|intnet"
554#if defined(VBOX_WITH_NETFLT)
555 "|hostonly"
556#endif
557 "|\n"
558 " generic|natnetwork"
559 "]\n"
560 " [--nictype<1-N> Am79C970A|Am79C973"
561#ifdef VBOX_WITH_E1000
562 "|\n 82540EM|82543GC|82545EM"
563#endif
564#ifdef VBOX_WITH_VIRTIO
565 "|\n virtio"
566#endif /* VBOX_WITH_VIRTIO */
567 "]\n"
568 " [--cableconnected<1-N> on|off]\n"
569 " [--nictrace<1-N> on|off]\n"
570 " [--nictracefile<1-N> <filename>]\n"
571 " [--nicproperty<1-N> name=[value]]\n"
572 " [--nicspeed<1-N> <kbps>]\n"
573 " [--nicbootprio<1-N> <priority>]\n"
574 " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
575 " [--nicbandwidthgroup<1-N> none|<name>]\n"
576 " [--bridgeadapter<1-N> none|<devicename>]\n"
577#if defined(VBOX_WITH_NETFLT)
578 " [--hostonlyadapter<1-N> none|<devicename>]\n"
579#endif
580 " [--intnet<1-N> <network name>]\n"
581 " [--nat-network<1-N> <network name>]\n"
582 " [--nicgenericdrv<1-N> <driver>\n"
583 " [--natnet<1-N> <network>|default]\n"
584 " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
585 " [<sockrcv>],[<tcpsnd>],\n"
586 " [<tcprcv>]]\n"
587 " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
588 " <hostport>,[<guestip>],<guestport>]\n"
589 " [--natpf<1-N> delete <rulename>]\n"
590 " [--nattftpprefix<1-N> <prefix>]\n"
591 " [--nattftpfile<1-N> <file>]\n"
592 " [--nattftpserver<1-N> <ip>]\n"
593 " [--natbindip<1-N> <ip>\n"
594 " [--natdnspassdomain<1-N> on|off]\n"
595 " [--natdnsproxy<1-N> on|off]\n"
596 " [--natdnshostresolver<1-N> on|off]\n"
597 " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
598 " [sameports]]\n"
599 " [--macaddress<1-N> auto|<mac>]\n"
600 " [--mouse ps2|usb|usbtablet|usbmultitouch]\n"
601 " [--keyboard ps2|usb\n"
602 " [--uart<1-N> off|<I/O base> <IRQ>]\n"
603 " [--uartmode<1-N> disconnected|\n"
604 " server <pipe>|\n"
605 " client <pipe>|\n"
606 " tcpserver <port>|\n"
607 " tcpclient <hostname:port>|\n"
608 " file <file>|\n"
609 " <devicename>]\n"
610 " [--uarttype<1-N> 16450|16550A|16750\n"
611#if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
612 " [--lpt<1-N> off|<I/O base> <IRQ>]\n"
613 " [--lptmode<1-N> <devicename>]\n"
614#endif
615 " [--guestmemoryballoon <balloonsize in MB>]\n"
616 " [--audio none|null", SEP);
617 if (fWin)
618 {
619#ifdef VBOX_WITH_WINMM
620 RTStrmPrintf(pStrm, "|winmm|dsound");
621#else
622 RTStrmPrintf(pStrm, "|dsound");
623#endif
624 }
625 if (fLinux || fSolaris)
626 {
627 RTStrmPrintf(pStrm, ""
628#ifdef VBOX_WITH_AUDIO_OSS
629 "|oss"
630#endif
631#ifdef VBOX_WITH_AUDIO_ALSA
632 "|alsa"
633#endif
634#ifdef VBOX_WITH_AUDIO_PULSE
635 "|pulse"
636#endif
637 );
638 }
639 if (fFreeBSD)
640 {
641#ifdef VBOX_WITH_AUDIO_OSS
642 /* Get the line break sorted when dumping all option variants. */
643 if (fDumpOpts)
644 {
645 RTStrmPrintf(pStrm, "|\n"
646 " oss");
647 }
648 else
649 RTStrmPrintf(pStrm, "|oss");
650#endif
651#ifdef VBOX_WITH_AUDIO_PULSE
652 RTStrmPrintf(pStrm, "|pulse");
653#endif
654 }
655 if (fDarwin)
656 {
657 RTStrmPrintf(pStrm, "|coreaudio");
658 }
659 RTStrmPrintf(pStrm, "]\n");
660 RTStrmPrintf(pStrm,
661 " [--audioin on|off]\n"
662 " [--audioout on|off]\n"
663 " [--audiocontroller ac97|hda|sb16]\n"
664 " [--audiocodec stac9700|ad1980|stac9221|sb16]\n"
665 " [--clipboard disabled|hosttoguest|guesttohost|\n"
666 " bidirectional]\n"
667 " [--draganddrop disabled|hosttoguest]\n");
668 RTStrmPrintf(pStrm,
669 " [--vrde on|off]\n"
670 " [--vrdeextpack default|<name>\n"
671 " [--vrdeproperty <name=[value]>]\n"
672 " [--vrdeport <hostport>]\n"
673 " [--vrdeaddress <hostip>]\n"
674 " [--vrdeauthtype null|external|guest]\n"
675 " [--vrdeauthlibrary default|<name>\n"
676 " [--vrdemulticon on|off]\n"
677 " [--vrdereusecon on|off]\n"
678 " [--vrdevideochannel on|off]\n"
679 " [--vrdevideochannelquality <percent>]\n");
680 RTStrmPrintf(pStrm,
681 " [--usbohci on|off]\n"
682 " [--usbehci on|off]\n"
683 " [--usbxhci on|off]\n"
684 " [--usbrename <oldname> <newname>]\n"
685 " [--snapshotfolder default|<path>]\n"
686 " [--teleporter on|off]\n"
687 " [--teleporterport <port>]\n"
688 " [--teleporteraddress <address|empty>\n"
689 " [--teleporterpassword <password>]\n"
690 " [--teleporterpasswordfile <file>|stdin]\n"
691 " [--tracing-enabled on|off]\n"
692 " [--tracing-config <config-string>]\n"
693 " [--tracing-allow-vm-access on|off]\n"
694#if 0
695 " [--iocache on|off]\n"
696 " [--iocachesize <I/O cache size in MB>]\n"
697#endif
698#if 0
699 " [--faulttolerance master|standby]\n"
700 " [--faulttoleranceaddress <name>]\n"
701 " [--faulttoleranceport <port>]\n"
702 " [--faulttolerancesyncinterval <msec>]\n"
703 " [--faulttolerancepassword <password>]\n"
704#endif
705#ifdef VBOX_WITH_USB_CARDREADER
706 " [--usbcardreader on|off]\n"
707#endif
708 " [--autostart-enabled on|off]\n"
709 " [--autostart-delay <seconds>]\n"
710#if 0
711 " [--autostop-type disabled|savestate|poweroff|\n"
712 " acpishutdown]\n"
713#endif
714#ifdef VBOX_WITH_RECORDING
715 " [--recording on|off]\n"
716 " [--recording screens all|<screen ID> [<screen ID> ...]]\n"
717 " [--recording filename <filename>]\n"
718 " [--recording videores <width> <height>]\n"
719 " [--recording videorate <rate>]\n"
720 " [--recording videofps <fps>]\n"
721 " [--recording maxtime <s>]\n"
722 " [--recording maxfilesize <MB>]\n"
723 " [--recording opts <key=value> [,<key=value> ...]]\n"
724#endif
725 " [--defaultfrontend default|<name>]\n"
726 "\n");
727 }
728
729 if (fCategory & USAGE_CLONEVM)
730 RTStrmPrintf(pStrm,
731 "%s clonevm %s <uuid|vmname>\n"
732 " [--snapshot <uuid>|<name>]\n"
733 " [--mode machine|machineandchildren|all]\n"
734 " [--options link|keepallmacs|keepnatmacs|\n"
735 " keepdisknames|keephwuuids]\n"
736 " [--name <name>]\n"
737 " [--groups <group>, ...]\n"
738 " [--basefolder <basefolder>]\n"
739 " [--uuid <uuid>]\n"
740 " [--register]\n"
741 "\n", SEP);
742
743 if (fCategory & USAGE_MOVEVM)
744 RTStrmPrintf(pStrm,
745 "%s movevm %s <uuid|vmname>\n"
746 " --type basic\n"
747 " [--folder <path>]\n"
748 "\n", SEP);
749
750 if (fCategory & USAGE_IMPORTAPPLIANCE)
751 RTStrmPrintf(pStrm,
752 "%s import %s <ovfname/ovaname>\n"
753 " [--dry-run|-n]\n"
754 " [--options keepallmacs|keepnatmacs|importtovdi]\n"
755 " [more options]\n"
756 " (run with -n to have options displayed\n"
757 " for a particular OVF)\n\n", SEP);
758
759 if (fCategory & USAGE_EXPORTAPPLIANCE)
760 RTStrmPrintf(pStrm,
761 "%s export %s <machines> --output|-o <name>.<ovf/ova/tar.gz>\n"
762 " [--legacy09|--ovf09|--ovf10|--ovf20|--opc10]\n"
763 " [--manifest]\n"
764 " [--iso]\n"
765 " [--options manifest|iso|nomacs|nomacsbutnat]\n"
766 " [--vsys <number of virtual system>]\n"
767 " [--vmname <name>]\n"
768 " [--product <product name>]\n"
769 " [--producturl <product url>]\n"
770 " [--vendor <vendor name>]\n"
771 " [--vendorurl <vendor url>]\n"
772 " [--version <version info>]\n"
773 " [--description <description info>]\n"
774 " [--eula <license text>]\n"
775 " [--eulafile <filename>]\n"
776 "\n", SEP);
777
778 if (fCategory & USAGE_STARTVM)
779 {
780 RTStrmPrintf(pStrm,
781 "%s startvm %s <uuid|vmname>...\n"
782 " [--type gui", SEP);
783 if (fVBoxSDL)
784 RTStrmPrintf(pStrm, "|sdl");
785 RTStrmPrintf(pStrm, "|headless|separate]\n");
786 RTStrmPrintf(pStrm,
787 " [-E|--putenv <NAME>[=<VALUE>]]\n"
788 "\n");
789 }
790
791 if (fCategory & USAGE_CONTROLVM)
792 {
793 RTStrmPrintf(pStrm,
794 "%s controlvm %s <uuid|vmname>\n"
795 " pause|resume|reset|poweroff|savestate|\n"
796 " acpipowerbutton|acpisleepbutton|\n"
797 " keyboardputscancode <hex> [<hex> ...]|\n"
798 " keyboardputstring <string1> [<string2> ...]|\n"
799 " keyboardputfile <filename>|\n"
800 " setlinkstate<1-N> on|off |\n"
801#if defined(VBOX_WITH_NETFLT)
802 " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n"
803 " natnetwork [<devicename>] |\n"
804#else /* !VBOX_WITH_NETFLT */
805 " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n"
806 " [<devicename>] |\n"
807#endif /* !VBOX_WITH_NETFLT */
808 " nictrace<1-N> on|off |\n"
809 " nictracefile<1-N> <filename> |\n"
810 " nicproperty<1-N> name=[value] |\n"
811 " nicpromisc<1-N> deny|allow-vms|allow-all |\n"
812 " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
813 " <hostport>,[<guestip>],<guestport> |\n"
814 " natpf<1-N> delete <rulename> |\n"
815 " guestmemoryballoon <balloonsize in MB> |\n"
816 " usbattach <uuid>|<address>\n"
817 " [--capturefile <filename>] |\n"
818 " usbdetach <uuid>|<address> |\n"
819 " audioin on|off |\n"
820 " audioout on|off |\n"
821 " clipboard disabled|hosttoguest|guesttohost|\n"
822 " bidirectional |\n"
823 " draganddrop disabled|hosttoguest |\n"
824 " vrde on|off |\n"
825 " vrdeport <port> |\n"
826 " vrdeproperty <name=[value]> |\n"
827 " vrdevideochannelquality <percent> |\n"
828 " setvideomodehint <xres> <yres> <bpp>\n"
829 " [[<display>] [<enabled:yes|no> |\n"
830 " [<xorigin> <yorigin>]]] |\n"
831 " setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off\n"
832 " screenshotpng <file> [display] |\n"
833#ifdef VBOX_WITH_RECORDING
834 " recording on|off |\n"
835 " recording screens all|none|<screen>,[<screen>...] |\n"
836 " recording filename <file> |\n"
837 " recording videores <width>x<height> |\n"
838 " recording videorate <rate> |\n"
839 " recording videofps <fps> |\n"
840 " recording maxtime <s> |\n"
841 " recording maxfilesize <MB> |\n"
842#endif /* VBOX_WITH_RECORDING */
843 " setcredentials <username>\n"
844 " --passwordfile <file> | <password>\n"
845 " <domain>\n"
846 " [--allowlocallogon <yes|no>] |\n"
847 " teleport --host <name> --port <port>\n"
848 " [--maxdowntime <msec>]\n"
849 " [--passwordfile <file> |\n"
850 " --password <password>] |\n"
851 " plugcpu <id> |\n"
852 " unplugcpu <id> |\n"
853 " cpuexecutioncap <1-100>\n"
854 " webcam <attach [path [settings]]> | <detach [path]> | <list>\n"
855 " addencpassword <id>\n"
856 " <password file>|-\n"
857 " [--removeonsuspend <yes|no>]\n"
858 " removeencpassword <id>\n"
859 " removeallencpasswords\n"
860 " changeuartmode<1-N> disconnected|\n"
861 " server <pipe>|\n"
862 " client <pipe>|\n"
863 " tcpserver <port>|\n"
864 " tcpclient <hostname:port>|\n"
865 " file <file>|\n"
866 " <devicename>]\n"
867 "\n", SEP);
868 }
869
870 if (fCategory & USAGE_DISCARDSTATE)
871 RTStrmPrintf(pStrm,
872 "%s discardstate %s <uuid|vmname>\n"
873 "\n", SEP);
874
875 if (fCategory & USAGE_ADOPTSTATE)
876 RTStrmPrintf(pStrm,
877 "%s adoptstate %s <uuid|vmname> <state_file>\n"
878 "\n", SEP);
879
880 if (fCategory & USAGE_SNAPSHOT)
881 RTStrmPrintf(pStrm,
882 "%s snapshot %s <uuid|vmname>\n"
883 " take <name> [--description <desc>] [--live]\n"
884 " [--uniquename Number,Timestamp,Space,Force] |\n"
885 " delete <uuid|snapname> |\n"
886 " restore <uuid|snapname> |\n"
887 " restorecurrent |\n"
888 " edit <uuid|snapname>|--current\n"
889 " [--name <name>]\n"
890 " [--description <desc>] |\n"
891 " list [--details|--machinereadable] |\n"
892 " showvminfo <uuid|snapname>\n"
893 "\n", SEP);
894
895 if (fCategory & USAGE_CLOSEMEDIUM)
896 RTStrmPrintf(pStrm,
897 "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n"
898 " [--delete]\n"
899 "\n", SEP);
900
901 if (fCategory & USAGE_STORAGEATTACH)
902 RTStrmPrintf(pStrm,
903 "%s storageattach %s <uuid|vmname>\n"
904 " --storagectl <name>\n"
905 " [--port <number>]\n"
906 " [--device <number>]\n"
907 " [--type dvddrive|hdd|fdd]\n"
908 " [--medium none|emptydrive|additions|\n"
909 " <uuid|filename>|host:<drive>|iscsi]\n"
910 " [--mtype normal|writethrough|immutable|shareable|\n"
911 " readonly|multiattach]\n"
912 " [--comment <text>]\n"
913 " [--setuuid <uuid>]\n"
914 " [--setparentuuid <uuid>]\n"
915 " [--passthrough on|off]\n"
916 " [--tempeject on|off]\n"
917 " [--nonrotational on|off]\n"
918 " [--discard on|off]\n"
919 " [--hotpluggable on|off]\n"
920 " [--bandwidthgroup <name>]\n"
921 " [--forceunmount]\n"
922 " [--server <name>|<ip>]\n"
923 " [--target <target>]\n"
924 " [--tport <port>]\n"
925 " [--lun <lun>]\n"
926 " [--encodedlun <lun>]\n"
927 " [--username <username>]\n"
928 " [--password <password>]\n"
929 " [--passwordfile <file>]\n"
930 " [--initiator <initiator>]\n"
931 " [--intnet]\n"
932 "\n", SEP);
933
934 if (fCategory & USAGE_STORAGECONTROLLER)
935 RTStrmPrintf(pStrm,
936 "%s storagectl %s <uuid|vmname>\n"
937 " --name <name>\n"
938 " [--add ide|sata|scsi|floppy|sas|usb|pcie]\n"
939 " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
940 " IntelAHCI|PIIX3|PIIX4|ICH6|I82078|\n"
941 " [ USB|NVMe]\n"
942 " [--portcount <1-n>]\n"
943 " [--hostiocache on|off]\n"
944 " [--bootable on|off]\n"
945 " [--rename <name>]\n"
946 " [--remove]\n"
947 "\n", SEP);
948
949 if (fCategory & USAGE_BANDWIDTHCONTROL)
950 RTStrmPrintf(pStrm,
951 "%s bandwidthctl %s <uuid|vmname>\n"
952 " add <name> --type disk|network\n"
953 " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
954 " set <name>\n"
955 " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
956 " remove <name> |\n"
957 " list [--machinereadable]\n"
958 " (limit units: k=kilobit, m=megabit, g=gigabit,\n"
959 " K=kilobyte, M=megabyte, G=gigabyte)\n"
960 "\n", SEP);
961
962 if (fCategory & USAGE_SHOWMEDIUMINFO)
963 RTStrmPrintf(pStrm,
964 "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n"
965 "\n", SEP);
966
967 if (fCategory & USAGE_CREATEMEDIUM)
968 RTStrmPrintf(pStrm,
969 "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n"
970 " [--size <megabytes>|--sizebyte <bytes>]\n"
971 " [--diffparent <uuid>|<filename>\n"
972 " [--format VDI|VMDK|VHD] (default: VDI)\n"
973 " [--variant Standard,Fixed,Split2G,Stream,ESX,\n"
974 " Formatted]\n"
975 "\n", SEP);
976
977 if (fCategory & USAGE_MODIFYMEDIUM)
978 RTStrmPrintf(pStrm,
979 "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n"
980 " [--type normal|writethrough|immutable|shareable|\n"
981 " readonly|multiattach]\n"
982 " [--autoreset on|off]\n"
983 " [--property <name=[value]>]\n"
984 " [--compact]\n"
985 " [--resize <megabytes>|--resizebyte <bytes>]\n"
986 " [--move <path>]\n"
987 " [--setlocation <path>]\n"
988 " [--description <description string>]"
989 "\n", SEP);
990
991 if (fCategory & USAGE_CLONEMEDIUM)
992 RTStrmPrintf(pStrm,
993 "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n"
994 " [--format VDI|VMDK|VHD|RAW|<other>]\n"
995 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
996 " [--existing]\n"
997 "\n", SEP);
998
999 if (fCategory & USAGE_MEDIUMPROPERTY)
1000 RTStrmPrintf(pStrm,
1001 "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n"
1002 " <property> <value>\n"
1003 "\n"
1004 " [disk|dvd|floppy] get <uuid|filename>\n"
1005 " <property>\n"
1006 "\n"
1007 " [disk|dvd|floppy] delete <uuid|filename>\n"
1008 " <property>\n"
1009 "\n", SEP);
1010
1011 if (fCategory & USAGE_ENCRYPTMEDIUM)
1012 RTStrmPrintf(pStrm,
1013 "%s encryptmedium %s <uuid|filename>\n"
1014 " [--newpassword <file>|-]\n"
1015 " [--oldpassword <file>|-]\n"
1016 " [--cipher <cipher identifier>]\n"
1017 " [--newpasswordid <password identifier>]\n"
1018 "\n", SEP);
1019
1020 if (fCategory & USAGE_MEDIUMENCCHKPWD)
1021 RTStrmPrintf(pStrm,
1022 "%s checkmediumpwd %s <uuid|filename>\n"
1023 " <pwd file>|-\n"
1024 "\n", SEP);
1025
1026 if (fCategory & USAGE_CONVERTFROMRAW)
1027 RTStrmPrintf(pStrm,
1028 "%s convertfromraw %s <filename> <outputfile>\n"
1029 " [--format VDI|VMDK|VHD]\n"
1030 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1031 " [--uuid <uuid>]\n"
1032 "%s convertfromraw %s stdin <outputfile> <bytes>\n"
1033 " [--format VDI|VMDK|VHD]\n"
1034 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1035 " [--uuid <uuid>]\n"
1036 "\n", SEP, SEP);
1037
1038 if (fCategory & USAGE_GETEXTRADATA)
1039 RTStrmPrintf(pStrm,
1040 "%s getextradata %s global|<uuid|vmname>\n"
1041 " <key>|[enumerate]\n"
1042 "\n", SEP);
1043
1044 if (fCategory & USAGE_SETEXTRADATA)
1045 RTStrmPrintf(pStrm,
1046 "%s setextradata %s global|<uuid|vmname>\n"
1047 " <key>\n"
1048 " [<value>] (no value deletes key)\n"
1049 "\n", SEP);
1050
1051 if (fCategory & USAGE_SETPROPERTY)
1052 RTStrmPrintf(pStrm,
1053 "%s setproperty %s machinefolder default|<folder> |\n"
1054 " hwvirtexclusive on|off |\n"
1055 " vrdeauthlibrary default|<library> |\n"
1056 " websrvauthlibrary default|null|<library> |\n"
1057 " vrdeextpack null|<library> |\n"
1058 " autostartdbpath null|<folder> |\n"
1059 " loghistorycount <value>\n"
1060 " defaultfrontend default|<name>\n"
1061 " logginglevel <log setting>\n"
1062 " proxymode system|noproxy|manual\n"
1063 " proxyurl <url>\n"
1064 "\n", SEP);
1065
1066 if (fCategory & USAGE_USBFILTER_ADD)
1067 RTStrmPrintf(pStrm,
1068 "%s usbfilter %s add <index,0-N>\n"
1069 " --target <uuid|vmname>|global\n"
1070 " --name <string>\n"
1071 " --action ignore|hold (global filters only)\n"
1072 " [--active yes|no] (yes)\n"
1073 " [--vendorid <XXXX>] (null)\n"
1074 " [--productid <XXXX>] (null)\n"
1075 " [--revision <IIFF>] (null)\n"
1076 " [--manufacturer <string>] (null)\n"
1077 " [--product <string>] (null)\n"
1078 " [--remote yes|no] (null, VM filters only)\n"
1079 " [--serialnumber <string>] (null)\n"
1080 " [--maskedinterfaces <XXXXXXXX>]\n"
1081 "\n", SEP);
1082
1083 if (fCategory & USAGE_USBFILTER_MODIFY)
1084 RTStrmPrintf(pStrm,
1085 "%s usbfilter %s modify <index,0-N>\n"
1086 " --target <uuid|vmname>|global\n"
1087 " [--name <string>]\n"
1088 " [--action ignore|hold] (global filters only)\n"
1089 " [--active yes|no]\n"
1090 " [--vendorid <XXXX>|\"\"]\n"
1091 " [--productid <XXXX>|\"\"]\n"
1092 " [--revision <IIFF>|\"\"]\n"
1093 " [--manufacturer <string>|\"\"]\n"
1094 " [--product <string>|\"\"]\n"
1095 " [--remote yes|no] (null, VM filters only)\n"
1096 " [--serialnumber <string>|\"\"]\n"
1097 " [--maskedinterfaces <XXXXXXXX>]\n"
1098 "\n", SEP);
1099
1100 if (fCategory & USAGE_USBFILTER_REMOVE)
1101 RTStrmPrintf(pStrm,
1102 "%s usbfilter %s remove <index,0-N>\n"
1103 " --target <uuid|vmname>|global\n"
1104 "\n", SEP);
1105
1106 if (fCategory & USAGE_SHAREDFOLDER_ADD)
1107 RTStrmPrintf(pStrm,
1108 "%s sharedfolder %s add <uuid|vmname>\n"
1109 " --name <name> --hostpath <hostpath>\n"
1110 " [--transient] [--readonly] [--automount]\n"
1111 "\n", SEP);
1112
1113 if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
1114 RTStrmPrintf(pStrm,
1115 "%s sharedfolder %s remove <uuid|vmname>\n"
1116 " --name <name> [--transient]\n"
1117 "\n", SEP);
1118
1119#ifdef VBOX_WITH_GUEST_PROPS
1120 if (fCategory & USAGE_GUESTPROPERTY)
1121 usageGuestProperty(pStrm, SEP);
1122#endif /* VBOX_WITH_GUEST_PROPS defined */
1123
1124#ifdef VBOX_WITH_GUEST_CONTROL
1125 if (fCategory & USAGE_GUESTCONTROL)
1126 usageGuestControl(pStrm, SEP, fSubCategory);
1127#endif /* VBOX_WITH_GUEST_CONTROL defined */
1128
1129 if (fCategory & USAGE_METRICS)
1130 RTStrmPrintf(pStrm,
1131 "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n"
1132 " (comma-separated)\n\n"
1133 "%s metrics %s setup\n"
1134 " [--period <seconds>] (default: 1)\n"
1135 " [--samples <count>] (default: 1)\n"
1136 " [--list]\n"
1137 " [*|host|<vmname> [<metric_list>]]\n\n"
1138 "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n"
1139 "%s metrics %s enable\n"
1140 " [--list]\n"
1141 " [*|host|<vmname> [<metric_list>]]\n\n"
1142 "%s metrics %s disable\n"
1143 " [--list]\n"
1144 " [*|host|<vmname> [<metric_list>]]\n\n"
1145 "%s metrics %s collect\n"
1146 " [--period <seconds>] (default: 1)\n"
1147 " [--samples <count>] (default: 1)\n"
1148 " [--list]\n"
1149 " [--detach]\n"
1150 " [*|host|<vmname> [<metric_list>]]\n"
1151 "\n", SEP, SEP, SEP, SEP, SEP, SEP);
1152
1153#if defined(VBOX_WITH_NAT_SERVICE)
1154 if (fCategory & USAGE_NATNETWORK)
1155 {
1156 RTStrmPrintf(pStrm,
1157 "%s natnetwork %s add --netname <name>\n"
1158 " --network <network>\n"
1159 " [--enable|--disable]\n"
1160 " [--dhcp on|off]\n"
1161 " [--port-forward-4 <rule>]\n"
1162 " [--loopback-4 <rule>]\n"
1163 " [--ipv6 on|off]\n"
1164 " [--port-forward-6 <rule>]\n"
1165 " [--loopback-6 <rule>]\n\n"
1166 "%s natnetwork %s remove --netname <name>\n\n"
1167 "%s natnetwork %s modify --netname <name>\n"
1168 " [--network <network>]\n"
1169 " [--enable|--disable]\n"
1170 " [--dhcp on|off]\n"
1171 " [--port-forward-4 <rule>]\n"
1172 " [--loopback-4 <rule>]\n"
1173 " [--ipv6 on|off]\n"
1174 " [--port-forward-6 <rule>]\n"
1175 " [--loopback-6 <rule>]\n\n"
1176 "%s natnetwork %s start --netname <name>\n\n"
1177 "%s natnetwork %s stop --netname <name>\n\n"
1178 "%s natnetwork %s list [<pattern>]\n"
1179 "\n", SEP, SEP, SEP, SEP, SEP, SEP);
1180
1181
1182 }
1183#endif
1184
1185#if defined(VBOX_WITH_NETFLT)
1186 if (fCategory & USAGE_HOSTONLYIFS)
1187 {
1188 RTStrmPrintf(pStrm,
1189 "%s hostonlyif %s ipconfig <name>\n"
1190 " [--dhcp |\n"
1191 " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
1192 " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
1193# if !defined(RT_OS_SOLARIS) || defined(VBOX_ONLY_DOCS)
1194 " create |\n"
1195 " remove <name>\n"
1196# endif
1197 "\n", SEP);
1198 }
1199#endif
1200
1201 if (fCategory & USAGE_DHCPSERVER)
1202 {
1203 RTStrmPrintf(pStrm,
1204 "%s dhcpserver %s add|modify --netname <network_name> |\n"
1205#if defined(VBOX_WITH_NETFLT)
1206 " --ifname <hostonly_if_name>\n"
1207#endif
1208 " [--ip <ip_address>\n"
1209 " --netmask <network_mask>\n"
1210 " --lowerip <lower_ip>\n"
1211 " --upperip <upper_ip>]\n"
1212 " [--enable | --disable]\n\n"
1213 "%s dhcpserver %s remove --netname <network_name> |\n"
1214#if defined(VBOX_WITH_NETFLT)
1215 " --ifname <hostonly_if_name>\n"
1216#endif
1217 "\n", SEP, SEP);
1218 }
1219
1220 if (fCategory & USAGE_USBDEVSOURCE)
1221 {
1222 RTStrmPrintf(pStrm,
1223 "%s usbdevsource %s add <source name>\n"
1224 " --backend <backend>\n"
1225 " --address <address>\n"
1226 "%s usbdevsource %s remove <source name>\n"
1227 "\n", SEP, SEP);
1228 }
1229
1230#ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
1231 if (fCategory == USAGE_ALL)
1232 {
1233 uint32_t cPendingBlankLines = 0;
1234 for (uint32_t i = 0; i < g_cHelpEntries; i++)
1235 {
1236 PCRTMSGREFENTRY pHelp = g_apHelpEntries[i];
1237 while (cPendingBlankLines-- > 0)
1238 RTStrmPutCh(pStrm, '\n');
1239 RTStrmPrintf(pStrm, " %c%s:\n", RT_C_TO_UPPER(pHelp->pszBrief[0]), pHelp->pszBrief + 1);
1240 cPendingBlankLines = 0;
1241 RTMsgRefEntryPrintStringTable(pStrm, &pHelp->Synopsis, RTMSGREFENTRYSTR_SCOPE_GLOBAL,
1242 &cPendingBlankLines, NULL /*pcLinesWritten*/);
1243 cPendingBlankLines = RT_MAX(cPendingBlankLines, 1);
1244 }
1245 }
1246#endif
1247}
1248
1249/**
1250 * Print a usage synopsis and the syntax error message.
1251 * @returns RTEXITCODE_SYNTAX.
1252 */
1253RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
1254{
1255 va_list args;
1256 showLogo(g_pStdErr); // show logo even if suppressed
1257#ifndef VBOX_ONLY_DOCS
1258 if (g_fInternalMode)
1259 printUsageInternal(fCategory, g_pStdErr);
1260 else
1261 printUsage(fCategory, ~0U, g_pStdErr);
1262#else
1263 RT_NOREF_PV(fCategory);
1264#endif
1265 va_start(args, pszFormat);
1266 RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1267 va_end(args);
1268 return RTEXITCODE_SYNTAX;
1269}
1270
1271/**
1272 * Print a usage synopsis and the syntax error message.
1273 * @returns RTEXITCODE_SYNTAX.
1274 */
1275RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
1276{
1277 va_list args;
1278 showLogo(g_pStdErr); // show logo even if suppressed
1279#ifndef VBOX_ONLY_DOCS
1280 if (g_fInternalMode)
1281 printUsageInternal(fCategory, g_pStdErr);
1282 else
1283 printUsage(fCategory, fSubCategory, g_pStdErr);
1284#else
1285 RT_NOREF2(fCategory, fSubCategory);
1286#endif
1287 va_start(args, pszFormat);
1288 RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1289 va_end(args);
1290 return RTEXITCODE_SYNTAX;
1291}
1292
1293/**
1294 * errorSyntax for RTGetOpt users.
1295 *
1296 * @returns RTEXITCODE_SYNTAX.
1297 *
1298 * @param fCategory The usage category of the command.
1299 * @param fSubCategory The usage sub-category of the command.
1300 * @param rc The RTGetOpt return code.
1301 * @param pValueUnion The value union.
1302 */
1303RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
1304{
1305 /*
1306 * Check if it is an unhandled standard option.
1307 */
1308#ifndef VBOX_ONLY_DOCS
1309 if (rc == 'V')
1310 {
1311 RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
1312 return RTEXITCODE_SUCCESS;
1313 }
1314#endif
1315
1316 if (rc == 'h')
1317 {
1318 showLogo(g_pStdErr);
1319#ifndef VBOX_ONLY_DOCS
1320 if (g_fInternalMode)
1321 printUsageInternal(fCategory, g_pStdOut);
1322 else
1323 printUsage(fCategory, fSubCategory, g_pStdOut);
1324#endif
1325 return RTEXITCODE_SUCCESS;
1326 }
1327
1328 /*
1329 * General failure.
1330 */
1331 showLogo(g_pStdErr); // show logo even if suppressed
1332#ifndef VBOX_ONLY_DOCS
1333 if (g_fInternalMode)
1334 printUsageInternal(fCategory, g_pStdErr);
1335 else
1336 printUsage(fCategory, fSubCategory, g_pStdErr);
1337#else
1338 RT_NOREF2(fCategory, fSubCategory);
1339#endif
1340
1341 if (rc == VINF_GETOPT_NOT_OPTION)
1342 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
1343 if (rc > 0)
1344 {
1345 if (RT_C_IS_PRINT(rc))
1346 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
1347 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
1348 }
1349 if (rc == VERR_GETOPT_UNKNOWN_OPTION)
1350 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
1351 if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
1352 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
1353 if (pValueUnion->pDef)
1354 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
1355 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
1356}
1357
1358/**
1359 * errorSyntax for RTGetOpt users.
1360 *
1361 * @returns RTEXITCODE_SYNTAX.
1362 *
1363 * @param fUsageCategory The usage category of the command.
1364 * @param rc The RTGetOpt return code.
1365 * @param pValueUnion The value union.
1366 */
1367RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
1368{
1369 return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
1370}
1371
1372/**
1373 * Print an error message without the syntax stuff.
1374 *
1375 * @returns RTEXITCODE_SYNTAX.
1376 */
1377RTEXITCODE errorArgument(const char *pszFormat, ...)
1378{
1379 va_list args;
1380 va_start(args, pszFormat);
1381 RTMsgErrorV(pszFormat, args);
1382 va_end(args);
1383 return RTEXITCODE_SYNTAX;
1384}
1385
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette