VirtualBox

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

Last change on this file since 61864 was 61673, checked in by vboxsync, 9 years ago

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