VirtualBox

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

Last change on this file since 59074 was 58447, checked in by vboxsync, 9 years ago

VBoxManage: fix help text.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 68.5 KB
Line 
1/* $Id: VBoxManageHelp.cpp 58447 2015-10-28 14:52:32Z vboxsync $ */
2/** @file
3 * VBoxManage - help and other message output.
4 */
5
6/*
7 * Copyright (C) 2006-2015 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 for (uint32_t i = 0; papszArgs[i]; i++)
409 if ( strcmp(papszArgs[i], "--help") == 0
410 || strcmp(papszArgs[i], "-h") == 0
411 || strcmp(papszArgs[i], "-?") == 0)
412 {
413 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdOut);
414 return RTEXITCODE_SUCCESS;
415 }
416 else if (!strcmp(papszArgs[i], "--"))
417 break;
418
419 return errorSyntax("Too many parameters");
420}
421
422
423/**
424 * Display current (sub)command usage and the custom error message.
425 *
426 * @returns RTEXITCODE_SYNTAX.
427 * @param pszFormat Custom error message format string.
428 * @param ... Format arguments.
429 */
430RTEXITCODE errorSyntax(const char *pszFormat, ...)
431{
432 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
433
434 showLogo(g_pStdErr);
435
436 va_list va;
437 va_start(va, pszFormat);
438 RTMsgErrorV(pszFormat, va);
439 va_end(va);
440
441 RTStrmPutCh(g_pStdErr, '\n');
442 if ( printBriefCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdErr)
443 >= ERROR_REPEAT_AFTER_USAGE_LENGTH)
444 {
445 /* Usage was very long, repeat the error message. */
446 RTStrmPutCh(g_pStdErr, '\n');
447 va_start(va, pszFormat);
448 RTMsgErrorV(pszFormat, va);
449 va_end(va);
450 }
451 return RTEXITCODE_SYNTAX;
452}
453
454
455/**
456 * Worker for errorGetOpt.
457 *
458 * @param rcGetOpt The RTGetOpt return value.
459 * @param pValueUnion The value union returned by RTGetOpt.
460 */
461static void errorGetOptWorker(int rcGetOpt, union RTGETOPTUNION const *pValueUnion)
462{
463 if (rcGetOpt == VINF_GETOPT_NOT_OPTION)
464 RTMsgError("Invalid parameter '%s'", pValueUnion->psz);
465 else if (rcGetOpt > 0)
466 {
467 if (RT_C_IS_PRINT(rcGetOpt))
468 RTMsgError("Invalid option -%c", rcGetOpt);
469 else
470 RTMsgError("Invalid option case %i", rcGetOpt);
471 }
472 else if (rcGetOpt == VERR_GETOPT_UNKNOWN_OPTION)
473 RTMsgError("Unknown option: %s", pValueUnion->psz);
474 else if (rcGetOpt == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
475 RTMsgError("Invalid argument format: %s", pValueUnion->psz);
476 else if (pValueUnion->pDef)
477 RTMsgError("%s: %Rrs", pValueUnion->pDef->pszLong, rcGetOpt);
478 else
479 RTMsgError("%Rrs", rcGetOpt);
480}
481
482
483/**
484 * Handled an RTGetOpt error or common option.
485 *
486 * This implements the 'V' and 'h' cases. It reports appropriate syntax errors
487 * for other @a rcGetOpt values.
488 *
489 * @retval RTEXITCODE_SUCCESS if help or version request.
490 * @retval RTEXITCODE_SYNTAX if not help or version request.
491 * @param rcGetOpt The RTGetOpt return value.
492 * @param pValueUnion The value union returned by RTGetOpt.
493 */
494RTEXITCODE errorGetOpt(int rcGetOpt, union RTGETOPTUNION const *pValueUnion)
495{
496 Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
497
498 /*
499 * Check if it is an unhandled standard option.
500 */
501 if (rcGetOpt == 'V')
502 {
503 RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
504 return RTEXITCODE_SUCCESS;
505 }
506
507 if (rcGetOpt == 'h')
508 {
509 printFullCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdOut);
510 return RTEXITCODE_SUCCESS;
511 }
512
513 /*
514 * We failed.
515 */
516 showLogo(g_pStdErr);
517 errorGetOptWorker(rcGetOpt, pValueUnion);
518 if ( printBriefCommandOrSubcommandHelp(g_enmCurCommand, g_fCurSubcommandScope, g_pStdErr)
519 >= ERROR_REPEAT_AFTER_USAGE_LENGTH)
520 {
521 /* Usage was very long, repeat the error message. */
522 RTStrmPutCh(g_pStdErr, '\n');
523 errorGetOptWorker(rcGetOpt, pValueUnion);
524 }
525 return RTEXITCODE_SYNTAX;
526}
527
528#endif /* VBOX_ONLY_DOCS */
529
530
531
532void showLogo(PRTSTREAM pStrm)
533{
534 static bool s_fShown; /* show only once */
535
536 if (!s_fShown)
537 {
538 RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
539 VBOX_VERSION_STRING "\n"
540 "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
541 "All rights reserved.\n"
542 "\n");
543 s_fShown = true;
544 }
545}
546
547
548
549
550void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm)
551{
552 bool fDumpOpts = false;
553#ifdef RT_OS_LINUX
554 bool fLinux = true;
555#else
556 bool fLinux = false;
557#endif
558#ifdef RT_OS_WINDOWS
559 bool fWin = true;
560#else
561 bool fWin = false;
562#endif
563#ifdef RT_OS_SOLARIS
564 bool fSolaris = true;
565#else
566 bool fSolaris = false;
567#endif
568#ifdef RT_OS_FREEBSD
569 bool fFreeBSD = true;
570#else
571 bool fFreeBSD = false;
572#endif
573#ifdef RT_OS_DARWIN
574 bool fDarwin = true;
575#else
576 bool fDarwin = false;
577#endif
578#ifdef VBOX_WITH_VBOXSDL
579 bool fVBoxSDL = true;
580#else
581 bool fVBoxSDL = false;
582#endif
583
584 if (fCategory == USAGE_DUMPOPTS)
585 {
586 fDumpOpts = true;
587 fLinux = true;
588 fWin = true;
589 fSolaris = true;
590 fFreeBSD = true;
591 fDarwin = true;
592 fVBoxSDL = true;
593 fCategory = USAGE_ALL;
594 }
595
596 RTStrmPrintf(pStrm,
597 "Usage:\n"
598 "\n");
599
600 if (fCategory == USAGE_ALL)
601 RTStrmPrintf(pStrm,
602 " VBoxManage [<general option>] <command>\n"
603 " \n \n"
604 "General Options:\n \n"
605 " [-v|--version] print version number and exit\n"
606 " [-q|--nologo] suppress the logo\n"
607 " [--settingspw <pw>] provide the settings password\n"
608 " [--settingspwfile <file>] provide a file containing the settings password\n"
609 " \n \n"
610 "Commands:\n \n");
611
612 const char *pcszSep1 = " ";
613 const char *pcszSep2 = " ";
614 if (fCategory != USAGE_ALL)
615 {
616 pcszSep1 = "VBoxManage";
617 pcszSep2 = "";
618 }
619
620#define SEP pcszSep1, pcszSep2
621
622 if (fCategory & USAGE_LIST)
623 RTStrmPrintf(pStrm,
624 "%s list [--long|-l]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
625#if defined(VBOX_WITH_NETFLT)
626 " intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|\n"
627#else
628 " intnets|bridgedifs|natnets|dhcpservers|hostinfo|\n"
629#endif
630 " hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|\n"
631 " usbhost|usbfilters|systemproperties|extpacks|\n"
632 " groups|webcams|screenshotformats\n"
633 "\n", SEP);
634
635 if (fCategory & USAGE_SHOWVMINFO)
636 RTStrmPrintf(pStrm,
637 "%s showvminfo %s <uuid|vmname> [--details]\n"
638 " [--machinereadable]\n"
639 "%s showvminfo %s <uuid|vmname> --log <idx>\n"
640 "\n", SEP, SEP);
641
642 if (fCategory & USAGE_REGISTERVM)
643 RTStrmPrintf(pStrm,
644 "%s registervm %s <filename>\n"
645 "\n", SEP);
646
647 if (fCategory & USAGE_UNREGISTERVM)
648 RTStrmPrintf(pStrm,
649 "%s unregistervm %s <uuid|vmname> [--delete]\n"
650 "\n", SEP);
651
652 if (fCategory & USAGE_CREATEVM)
653 RTStrmPrintf(pStrm,
654 "%s createvm %s --name <name>\n"
655 " [--groups <group>, ...]\n"
656 " [--ostype <ostype>]\n"
657 " [--register]\n"
658 " [--basefolder <path>]\n"
659 " [--uuid <uuid>]\n"
660 "\n", SEP);
661
662 if (fCategory & USAGE_MODIFYVM)
663 {
664 RTStrmPrintf(pStrm,
665 "%s modifyvm %s <uuid|vmname>\n"
666 " [--name <name>]\n"
667 " [--groups <group>, ...]\n"
668 " [--description <desc>]\n"
669 " [--ostype <ostype>]\n"
670 " [--iconfile <filename>]\n"
671 " [--memory <memorysize in MB>]\n"
672 " [--pagefusion on|off]\n"
673 " [--vram <vramsize in MB>]\n"
674 " [--acpi on|off]\n"
675#ifdef VBOX_WITH_PCI_PASSTHROUGH
676 " [--pciattach 03:04.0]\n"
677 " [--pciattach 03:04.0@02:01.0]\n"
678 " [--pcidetach 03:04.0]\n"
679#endif
680 " [--ioapic on|off]\n"
681 " [--hpet on|off]\n"
682 " [--triplefaultreset on|off]\n"
683 " [--paravirtprovider none|default|legacy|minimal|\n"
684 " hyperv|kvm]\n"
685 " [--paravirtdebug <key=value> [,<key=value> ...]]\n"
686 " [--hwvirtex on|off]\n"
687 " [--nestedpaging on|off]\n"
688 " [--largepages on|off]\n"
689 " [--vtxvpid on|off]\n"
690 " [--vtxux on|off]\n"
691 " [--pae on|off]\n"
692 " [--longmode on|off]\n"
693 " [--cpuid-portability-level <0..3>\n"
694 " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
695 " [--cpuidremove <leaf>]\n"
696 " [--cpuidremoveall]\n"
697 " [--hardwareuuid <uuid>]\n"
698 " [--cpus <number>]\n"
699 " [--cpuhotplug on|off]\n"
700 " [--plugcpu <id>]\n"
701 " [--unplugcpu <id>]\n"
702 " [--cpuexecutioncap <1-100>]\n"
703 " [--rtcuseutc on|off]\n"
704#ifdef VBOX_WITH_VMSVGA
705 " [--graphicscontroller none|vboxvga|vmsvga]\n"
706#else
707 " [--graphicscontroller none|vboxvga]\n"
708#endif
709 " [--monitorcount <number>]\n"
710 " [--accelerate3d on|off]\n"
711#ifdef VBOX_WITH_VIDEOHWACCEL
712 " [--accelerate2dvideo on|off]\n"
713#endif
714 " [--firmware bios|efi|efi32|efi64]\n"
715 " [--chipset ich9|piix3]\n"
716 " [--bioslogofadein on|off]\n"
717 " [--bioslogofadeout on|off]\n"
718 " [--bioslogodisplaytime <msec>]\n"
719 " [--bioslogoimagepath <imagepath>]\n"
720 " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
721 " [--biossystemtimeoffset <msec>]\n"
722 " [--biospxedebug on|off]\n"
723 " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
724 " [--nic<1-N> none|null|nat|bridged|intnet"
725#if defined(VBOX_WITH_NETFLT)
726 "|hostonly"
727#endif
728 "|\n"
729 " generic|natnetwork"
730 "]\n"
731 " [--nictype<1-N> Am79C970A|Am79C973"
732#ifdef VBOX_WITH_E1000
733 "|\n 82540EM|82543GC|82545EM"
734#endif
735#ifdef VBOX_WITH_VIRTIO
736 "|\n virtio"
737#endif /* VBOX_WITH_VIRTIO */
738 "]\n"
739 " [--cableconnected<1-N> on|off]\n"
740 " [--nictrace<1-N> on|off]\n"
741 " [--nictracefile<1-N> <filename>]\n"
742 " [--nicproperty<1-N> name=[value]]\n"
743 " [--nicspeed<1-N> <kbps>]\n"
744 " [--nicbootprio<1-N> <priority>]\n"
745 " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
746 " [--nicbandwidthgroup<1-N> none|<name>]\n"
747 " [--bridgeadapter<1-N> none|<devicename>]\n"
748#if defined(VBOX_WITH_NETFLT)
749 " [--hostonlyadapter<1-N> none|<devicename>]\n"
750#endif
751 " [--intnet<1-N> <network name>]\n"
752 " [--nat-network<1-N> <network name>]\n"
753 " [--nicgenericdrv<1-N> <driver>\n"
754 " [--natnet<1-N> <network>|default]\n"
755 " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
756 " [<sockrcv>],[<tcpsnd>],\n"
757 " [<tcprcv>]]\n"
758 " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
759 " <hostport>,[<guestip>],<guestport>]\n"
760 " [--natpf<1-N> delete <rulename>]\n"
761 " [--nattftpprefix<1-N> <prefix>]\n"
762 " [--nattftpfile<1-N> <file>]\n"
763 " [--nattftpserver<1-N> <ip>]\n"
764 " [--natbindip<1-N> <ip>\n"
765 " [--natdnspassdomain<1-N> on|off]\n"
766 " [--natdnsproxy<1-N> on|off]\n"
767 " [--natdnshostresolver<1-N> on|off]\n"
768 " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
769 " [sameports]]\n"
770 " [--macaddress<1-N> auto|<mac>]\n"
771 " [--mouse ps2|usb|usbtablet|usbmultitouch]\n"
772 " [--keyboard ps2|usb\n"
773 " [--uart<1-N> off|<I/O base> <IRQ>]\n"
774 " [--uartmode<1-N> disconnected|\n"
775 " server <pipe>|\n"
776 " client <pipe>|\n"
777 " tcpserver <port>|\n"
778 " tcpclient <hostname:port>|\n"
779 " file <file>|\n"
780 " <devicename>]\n"
781#if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
782 " [--lpt<1-N> off|<I/O base> <IRQ>]\n"
783 " [--lptmode<1-N> <devicename>]\n"
784#endif
785 " [--guestmemoryballoon <balloonsize in MB>]\n"
786 " [--audio none|null", SEP);
787 if (fWin)
788 {
789#ifdef VBOX_WITH_WINMM
790 RTStrmPrintf(pStrm, "|winmm|dsound");
791#else
792 RTStrmPrintf(pStrm, "|dsound");
793#endif
794 }
795 if (fSolaris)
796 {
797 RTStrmPrintf(pStrm, "|solaudio"
798#ifdef VBOX_WITH_SOLARIS_OSS
799 "|oss"
800#endif
801 );
802 }
803 if (fLinux)
804 {
805 RTStrmPrintf(pStrm, "|oss"
806#ifdef VBOX_WITH_ALSA
807 "|alsa"
808#endif
809#ifdef VBOX_WITH_PULSE
810 "|pulse"
811#endif
812 );
813 }
814 if (fFreeBSD)
815 {
816 /* Get the line break sorted when dumping all option variants. */
817 if (fDumpOpts)
818 {
819 RTStrmPrintf(pStrm, "|\n"
820 " oss");
821 }
822 else
823 RTStrmPrintf(pStrm, "|oss");
824#ifdef VBOX_WITH_PULSE
825 RTStrmPrintf(pStrm, "|pulse");
826#endif
827 }
828 if (fDarwin)
829 {
830 RTStrmPrintf(pStrm, "|coreaudio");
831 }
832 RTStrmPrintf(pStrm, "]\n");
833 RTStrmPrintf(pStrm,
834 " [--audiocontroller ac97|hda|sb16]\n"
835 " [--audiocodec stac9700|ad1980|stac9221|sb16]\n"
836 " [--clipboard disabled|hosttoguest|guesttohost|\n"
837 " bidirectional]\n"
838 " [--draganddrop disabled|hosttoguest]\n");
839 RTStrmPrintf(pStrm,
840 " [--vrde on|off]\n"
841 " [--vrdeextpack default|<name>\n"
842 " [--vrdeproperty <name=[value]>]\n"
843 " [--vrdeport <hostport>]\n"
844 " [--vrdeaddress <hostip>]\n"
845 " [--vrdeauthtype null|external|guest]\n"
846 " [--vrdeauthlibrary default|<name>\n"
847 " [--vrdemulticon on|off]\n"
848 " [--vrdereusecon on|off]\n"
849 " [--vrdevideochannel on|off]\n"
850 " [--vrdevideochannelquality <percent>]\n");
851 RTStrmPrintf(pStrm,
852 " [--usb on|off]\n"
853 " [--usbehci on|off]\n"
854 " [--usbxhci on|off]\n"
855 " [--usbrename <oldname> <newname>]\n"
856 " [--snapshotfolder default|<path>]\n"
857 " [--teleporter on|off]\n"
858 " [--teleporterport <port>]\n"
859 " [--teleporteraddress <address|empty>\n"
860 " [--teleporterpassword <password>]\n"
861 " [--teleporterpasswordfile <file>|stdin]\n"
862 " [--tracing-enabled on|off]\n"
863 " [--tracing-config <config-string>]\n"
864 " [--tracing-allow-vm-access on|off]\n"
865#if 0
866 " [--iocache on|off]\n"
867 " [--iocachesize <I/O cache size in MB>]\n"
868#endif
869#if 0
870 " [--faulttolerance master|standby]\n"
871 " [--faulttoleranceaddress <name>]\n"
872 " [--faulttoleranceport <port>]\n"
873 " [--faulttolerancesyncinterval <msec>]\n"
874 " [--faulttolerancepassword <password>]\n"
875#endif
876#ifdef VBOX_WITH_USB_CARDREADER
877 " [--usbcardreader on|off]\n"
878#endif
879 " [--autostart-enabled on|off]\n"
880 " [--autostart-delay <seconds>]\n"
881#if 0
882 " [--autostop-type disabled|savestate|poweroff|\n"
883 " acpishutdown]\n"
884#endif
885#ifdef VBOX_WITH_VPX
886 " [--videocap on|off]\n"
887 " [--videocapscreens all|<screen ID> [<screen ID> ...]]\n"
888 " [--videocapfile <filename>]\n"
889 " [--videocapres <width> <height>]\n"
890 " [--videocaprate <rate>]\n"
891 " [--videocapfps <fps>]\n"
892 " [--videocapmaxtime <ms>]\n"
893 " [--videocapmaxsize <MB>]\n"
894 " [--videocapopts <key=value> [,<key=value> ...]]\n"
895#endif
896 " [--defaultfrontend default|<name>]\n"
897 "\n");
898 }
899
900 if (fCategory & USAGE_CLONEVM)
901 RTStrmPrintf(pStrm,
902 "%s clonevm %s <uuid|vmname>\n"
903 " [--snapshot <uuid>|<name>]\n"
904 " [--mode machine|machineandchildren|all]\n"
905 " [--options link|keepallmacs|keepnatmacs|\n"
906 " keepdisknames]\n"
907 " [--name <name>]\n"
908 " [--groups <group>, ...]\n"
909 " [--basefolder <basefolder>]\n"
910 " [--uuid <uuid>]\n"
911 " [--register]\n"
912 "\n", SEP);
913
914 if (fCategory & USAGE_IMPORTAPPLIANCE)
915 RTStrmPrintf(pStrm,
916 "%s import %s <ovfname/ovaname>\n"
917 " [--dry-run|-n]\n"
918 " [--options keepallmacs|keepnatmacs|importtovdi]\n"
919 " [more options]\n"
920 " (run with -n to have options displayed\n"
921 " for a particular OVF)\n\n", SEP);
922
923 if (fCategory & USAGE_EXPORTAPPLIANCE)
924 RTStrmPrintf(pStrm,
925 "%s export %s <machines> --output|-o <name>.<ovf/ova>\n"
926 " [--legacy09|--ovf09|--ovf10|--ovf20]\n"
927 " [--manifest]\n"
928 " [--iso]\n"
929 " [--options manifest|iso|nomacs|nomacsbutnat]\n"
930 " [--vsys <number of virtual system>]\n"
931 " [--product <product name>]\n"
932 " [--producturl <product url>]\n"
933 " [--vendor <vendor name>]\n"
934 " [--vendorurl <vendor url>]\n"
935 " [--version <version info>]\n"
936 " [--description <description info>]\n"
937 " [--eula <license text>]\n"
938 " [--eulafile <filename>]\n"
939 "\n", SEP);
940
941 if (fCategory & USAGE_STARTVM)
942 {
943 RTStrmPrintf(pStrm,
944 "%s startvm %s <uuid|vmname>...\n"
945 " [--type gui", SEP);
946 if (fVBoxSDL)
947 RTStrmPrintf(pStrm, "|sdl");
948 RTStrmPrintf(pStrm, "|headless|separate]\n");
949 RTStrmPrintf(pStrm,
950 "\n");
951 }
952
953 if (fCategory & USAGE_CONTROLVM)
954 {
955 RTStrmPrintf(pStrm,
956 "%s controlvm %s <uuid|vmname>\n"
957 " pause|resume|reset|poweroff|savestate|\n"
958 " acpipowerbutton|acpisleepbutton|\n"
959 " keyboardputscancode <hex> [<hex> ...]|\n"
960 " setlinkstate<1-N> on|off |\n"
961#if defined(VBOX_WITH_NETFLT)
962 " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n"
963 " natnetwork [<devicename>] |\n"
964#else /* !VBOX_WITH_NETFLT */
965 " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n"
966 " [<devicename>] |\n"
967#endif /* !VBOX_WITH_NETFLT */
968 " nictrace<1-N> on|off |\n"
969 " nictracefile<1-N> <filename> |\n"
970 " nicproperty<1-N> name=[value] |\n"
971 " nicpromisc<1-N> deny|allow-vms|allow-all |\n"
972 " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
973 " <hostport>,[<guestip>],<guestport> |\n"
974 " natpf<1-N> delete <rulename> |\n"
975 " guestmemoryballoon <balloonsize in MB> |\n"
976 " usbattach <uuid>|<address>\n"
977 " [--capturefile <filename>] |\n"
978 " usbdetach <uuid>|<address> |\n"
979 " clipboard disabled|hosttoguest|guesttohost|\n"
980 " bidirectional |\n"
981 " draganddrop disabled|hosttoguest |\n"
982 " vrde on|off |\n"
983 " vrdeport <port> |\n"
984 " vrdeproperty <name=[value]> |\n"
985 " vrdevideochannelquality <percent> |\n"
986 " setvideomodehint <xres> <yres> <bpp>\n"
987 " [[<display>] [<enabled:yes|no> |\n"
988 " [<xorigin> <yorigin>]]] |\n"
989 " screenshotpng <file> [display] |\n"
990 " videocap on|off |\n"
991 " videocapscreens all|none|<screen>,[<screen>...] |\n"
992 " videocapfile <file>\n"
993 " videocapres <width>x<height>\n"
994 " videocaprate <rate>\n"
995 " videocapfps <fps>\n"
996 " videocapmaxtime <ms>\n"
997 " videocapmaxsize <MB>\n"
998 " setcredentials <username>\n"
999 " --passwordfile <file> | <password>\n"
1000 " <domain>\n"
1001 " [--allowlocallogon <yes|no>] |\n"
1002 " teleport --host <name> --port <port>\n"
1003 " [--maxdowntime <msec>]\n"
1004 " [--passwordfile <file> |\n"
1005 " --password <password>] |\n"
1006 " plugcpu <id> |\n"
1007 " unplugcpu <id> |\n"
1008 " cpuexecutioncap <1-100>\n"
1009 " webcam <attach [path [settings]]> | <detach [path]> | <list>\n"
1010 " addencpassword <id>\n"
1011 " <password file>|-\n"
1012 " [--removeonsuspend <yes|no>]\n"
1013 " removeencpassword <id>\n"
1014 " removeallencpasswords\n"
1015 "\n", SEP);
1016 }
1017
1018 if (fCategory & USAGE_DISCARDSTATE)
1019 RTStrmPrintf(pStrm,
1020 "%s discardstate %s <uuid|vmname>\n"
1021 "\n", SEP);
1022
1023 if (fCategory & USAGE_ADOPTSTATE)
1024 RTStrmPrintf(pStrm,
1025 "%s adoptstate %s <uuid|vmname> <state_file>\n"
1026 "\n", SEP);
1027
1028 if (fCategory & USAGE_SNAPSHOT)
1029 RTStrmPrintf(pStrm,
1030 "%s snapshot %s <uuid|vmname>\n"
1031 " take <name> [--description <desc>] [--live]\n"
1032 " [--uniquename Number,Timestamp,Space,Force] |\n"
1033 " delete <uuid|snapname> |\n"
1034 " restore <uuid|snapname> |\n"
1035 " restorecurrent |\n"
1036 " edit <uuid|snapname>|--current\n"
1037 " [--name <name>]\n"
1038 " [--description <desc>] |\n"
1039 " list [--details|--machinereadable]\n"
1040 " showvminfo <uuid|snapname>\n"
1041 "\n", SEP);
1042
1043 if (fCategory & USAGE_CLOSEMEDIUM)
1044 RTStrmPrintf(pStrm,
1045 "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n"
1046 " [--delete]\n"
1047 "\n", SEP);
1048
1049 if (fCategory & USAGE_STORAGEATTACH)
1050 RTStrmPrintf(pStrm,
1051 "%s storageattach %s <uuid|vmname>\n"
1052 " --storagectl <name>\n"
1053 " [--port <number>]\n"
1054 " [--device <number>]\n"
1055 " [--type dvddrive|hdd|fdd]\n"
1056 " [--medium none|emptydrive|additions|\n"
1057 " <uuid|filename>|host:<drive>|iscsi]\n"
1058 " [--mtype normal|writethrough|immutable|shareable|\n"
1059 " readonly|multiattach]\n"
1060 " [--comment <text>]\n"
1061 " [--setuuid <uuid>]\n"
1062 " [--setparentuuid <uuid>]\n"
1063 " [--passthrough on|off]\n"
1064 " [--tempeject on|off]\n"
1065 " [--nonrotational on|off]\n"
1066 " [--discard on|off]\n"
1067 " [--hotpluggable on|off]\n"
1068 " [--bandwidthgroup <name>]\n"
1069 " [--forceunmount]\n"
1070 " [--server <name>|<ip>]\n"
1071 " [--target <target>]\n"
1072 " [--tport <port>]\n"
1073 " [--lun <lun>]\n"
1074 " [--encodedlun <lun>]\n"
1075 " [--username <username>]\n"
1076 " [--password <password>]\n"
1077 " [--initiator <initiator>]\n"
1078 " [--intnet]\n"
1079 "\n", SEP);
1080
1081 if (fCategory & USAGE_STORAGECONTROLLER)
1082 RTStrmPrintf(pStrm,
1083 "%s storagectl %s <uuid|vmname>\n"
1084 " --name <name>\n"
1085 " [--add ide|sata|scsi|floppy|sas|pcie]\n"
1086 " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
1087 " IntelAHCI|PIIX3|PIIX4|ICH6|I82078|NVMe]\n"
1088 " [--portcount <1-n>]\n"
1089 " [--hostiocache on|off]\n"
1090 " [--bootable on|off]\n"
1091 " [--rename <name>]\n"
1092 " [--remove]\n"
1093 "\n", SEP);
1094
1095 if (fCategory & USAGE_BANDWIDTHCONTROL)
1096 RTStrmPrintf(pStrm,
1097 "%s bandwidthctl %s <uuid|vmname>\n"
1098 " add <name> --type disk|network\n"
1099 " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
1100 " set <name>\n"
1101 " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
1102 " remove <name> |\n"
1103 " list [--machinereadable]\n"
1104 " (limit units: k=kilobit, m=megabit, g=gigabit,\n"
1105 " K=kilobyte, M=megabyte, G=gigabyte)\n"
1106 "\n", SEP);
1107
1108 if (fCategory & USAGE_SHOWMEDIUMINFO)
1109 RTStrmPrintf(pStrm,
1110 "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n"
1111 "\n", SEP);
1112
1113 if (fCategory & USAGE_CREATEMEDIUM)
1114 RTStrmPrintf(pStrm,
1115 "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n"
1116 " [--size <megabytes>|--sizebyte <bytes>]\n"
1117 " [--diffparent <uuid>|<filename>\n"
1118 " [--format VDI|VMDK|VHD] (default: VDI)\n"
1119 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1120 "\n", SEP);
1121
1122 if (fCategory & USAGE_MODIFYMEDIUM)
1123 RTStrmPrintf(pStrm,
1124 "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n"
1125 " [--type normal|writethrough|immutable|shareable|\n"
1126 " readonly|multiattach]\n"
1127 " [--autoreset on|off]\n"
1128 " [--property <name=[value]>]\n"
1129 " [--compact]\n"
1130 " [--resize <megabytes>|--resizebyte <bytes>]\n"
1131 "\n", SEP);
1132
1133 if (fCategory & USAGE_CLONEMEDIUM)
1134 RTStrmPrintf(pStrm,
1135 "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n"
1136 " [--format VDI|VMDK|VHD|RAW|<other>]\n"
1137 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1138 " [--existing]\n"
1139 "\n", SEP);
1140
1141 if (fCategory & USAGE_MEDIUMPROPERTY)
1142 RTStrmPrintf(pStrm,
1143 "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n"
1144 " <property> <value>\n"
1145 "\n"
1146 " [disk|dvd|floppy] get <uuid|filename>\n"
1147 " <property>\n"
1148 "\n"
1149 " [disk|dvd|floppy] delete <uuid|filename>\n"
1150 " <property>\n"
1151 "\n", SEP);
1152
1153 if (fCategory & USAGE_ENCRYPTMEDIUM)
1154 RTStrmPrintf(pStrm,
1155 "%s encryptmedium %s <uuid|filename>\n"
1156 " [--newpassword <file>|-]\n"
1157 " [--oldpassword <file>|-]\n"
1158 " [--cipher <cipher identifier>]\n"
1159 " [--newpasswordid <password identifier>]\n"
1160 "\n", SEP);
1161
1162 if (fCategory & USAGE_MEDIUMENCCHKPWD)
1163 RTStrmPrintf(pStrm,
1164 "%s checkmediumpwd %s <uuid|filename>\n"
1165 " <pwd file>|-\n"
1166 "\n", SEP);
1167
1168 if (fCategory & USAGE_CONVERTFROMRAW)
1169 RTStrmPrintf(pStrm,
1170 "%s convertfromraw %s <filename> <outputfile>\n"
1171 " [--format VDI|VMDK|VHD]\n"
1172 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1173 " [--uuid <uuid>]\n"
1174 "%s convertfromraw %s stdin <outputfile> <bytes>\n"
1175 " [--format VDI|VMDK|VHD]\n"
1176 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1177 " [--uuid <uuid>]\n"
1178 "\n", SEP, SEP);
1179
1180 if (fCategory & USAGE_GETEXTRADATA)
1181 RTStrmPrintf(pStrm,
1182 "%s getextradata %s global|<uuid|vmname>\n"
1183 " <key>|enumerate\n"
1184 "\n", SEP);
1185
1186 if (fCategory & USAGE_SETEXTRADATA)
1187 RTStrmPrintf(pStrm,
1188 "%s setextradata %s global|<uuid|vmname>\n"
1189 " <key>\n"
1190 " [<value>] (no value deletes key)\n"
1191 "\n", SEP);
1192
1193 if (fCategory & USAGE_SETPROPERTY)
1194 RTStrmPrintf(pStrm,
1195 "%s setproperty %s machinefolder default|<folder> |\n"
1196 " hwvirtexclusive on|off |\n"
1197 " vrdeauthlibrary default|<library> |\n"
1198 " websrvauthlibrary default|null|<library> |\n"
1199 " vrdeextpack null|<library> |\n"
1200 " autostartdbpath null|<folder> |\n"
1201 " loghistorycount <value>\n"
1202 " defaultfrontend default|<name>\n"
1203 " logginglevel <log setting>\n"
1204 "\n", SEP);
1205
1206 if (fCategory & USAGE_USBFILTER_ADD)
1207 RTStrmPrintf(pStrm,
1208 "%s usbfilter %s add <index,0-N>\n"
1209 " --target <uuid|vmname>|global\n"
1210 " --name <string>\n"
1211 " --action ignore|hold (global filters only)\n"
1212 " [--active yes|no] (yes)\n"
1213 " [--vendorid <XXXX>] (null)\n"
1214 " [--productid <XXXX>] (null)\n"
1215 " [--revision <IIFF>] (null)\n"
1216 " [--manufacturer <string>] (null)\n"
1217 " [--product <string>] (null)\n"
1218 " [--remote yes|no] (null, VM filters only)\n"
1219 " [--serialnumber <string>] (null)\n"
1220 " [--maskedinterfaces <XXXXXXXX>]\n"
1221 "\n", SEP);
1222
1223 if (fCategory & USAGE_USBFILTER_MODIFY)
1224 RTStrmPrintf(pStrm,
1225 "%s usbfilter %s modify <index,0-N>\n"
1226 " --target <uuid|vmname>|global\n"
1227 " [--name <string>]\n"
1228 " [--action ignore|hold] (global filters only)\n"
1229 " [--active yes|no]\n"
1230 " [--vendorid <XXXX>|\"\"]\n"
1231 " [--productid <XXXX>|\"\"]\n"
1232 " [--revision <IIFF>|\"\"]\n"
1233 " [--manufacturer <string>|\"\"]\n"
1234 " [--product <string>|\"\"]\n"
1235 " [--remote yes|no] (null, VM filters only)\n"
1236 " [--serialnumber <string>|\"\"]\n"
1237 " [--maskedinterfaces <XXXXXXXX>]\n"
1238 "\n", SEP);
1239
1240 if (fCategory & USAGE_USBFILTER_REMOVE)
1241 RTStrmPrintf(pStrm,
1242 "%s usbfilter %s remove <index,0-N>\n"
1243 " --target <uuid|vmname>|global\n"
1244 "\n", SEP);
1245
1246 if (fCategory & USAGE_SHAREDFOLDER_ADD)
1247 RTStrmPrintf(pStrm,
1248 "%s sharedfolder %s add <uuid|vmname>\n"
1249 " --name <name> --hostpath <hostpath>\n"
1250 " [--transient] [--readonly] [--automount]\n"
1251 "\n", SEP);
1252
1253 if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
1254 RTStrmPrintf(pStrm,
1255 "%s sharedfolder %s remove <uuid|vmname>\n"
1256 " --name <name> [--transient]\n"
1257 "\n", SEP);
1258
1259#ifdef VBOX_WITH_GUEST_PROPS
1260 if (fCategory & USAGE_GUESTPROPERTY)
1261 usageGuestProperty(pStrm, SEP);
1262#endif /* VBOX_WITH_GUEST_PROPS defined */
1263
1264#ifdef VBOX_WITH_GUEST_CONTROL
1265 if (fCategory & USAGE_GUESTCONTROL)
1266 usageGuestControl(pStrm, SEP, fSubCategory);
1267#endif /* VBOX_WITH_GUEST_CONTROL defined */
1268
1269 if (fCategory & USAGE_DEBUGVM)
1270 {
1271 RTStrmPrintf(pStrm,
1272 "%s debugvm %s <uuid|vmname>\n"
1273 " dumpguestcore --filename <name> |\n"
1274 " info <item> [args] |\n"
1275 " injectnmi |\n"
1276 " log [--release|--debug] <settings> ...|\n"
1277 " logdest [--release|--debug] <settings> ...|\n"
1278 " logflags [--release|--debug] <settings> ...|\n"
1279 " osdetect |\n"
1280 " osinfo |\n"
1281 " osdmesg [--lines|-n <N>] |\n"
1282 " getregisters [--cpu <id>] <reg>|all ... |\n"
1283 " setregisters [--cpu <id>] <reg>=<value> ... |\n"
1284 " show [--human-readable|--sh-export|--sh-eval|\n"
1285 " --cmd-set] \n"
1286 " <logdbg-settings|logrel-settings>\n"
1287 " [[opt] what ...] |\n"
1288 " statistics [--reset] [--pattern <pattern>]\n"
1289 " [--descriptions]\n"
1290 "\n", SEP);
1291 }
1292 if (fCategory & USAGE_METRICS)
1293 RTStrmPrintf(pStrm,
1294 "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n"
1295 " (comma-separated)\n\n"
1296 "%s metrics %s setup\n"
1297 " [--period <seconds>] (default: 1)\n"
1298 " [--samples <count>] (default: 1)\n"
1299 " [--list]\n"
1300 " [*|host|<vmname> [<metric_list>]]\n\n"
1301 "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n"
1302 "%s metrics %s enable\n"
1303 " [--list]\n"
1304 " [*|host|<vmname> [<metric_list>]]\n\n"
1305 "%s metrics %s disable\n"
1306 " [--list]\n"
1307 " [*|host|<vmname> [<metric_list>]]\n\n"
1308 "%s metrics %s collect\n"
1309 " [--period <seconds>] (default: 1)\n"
1310 " [--samples <count>] (default: 1)\n"
1311 " [--list]\n"
1312 " [--detach]\n"
1313 " [*|host|<vmname> [<metric_list>]]\n"
1314 "\n", SEP, SEP, SEP, SEP, SEP, SEP);
1315
1316#if defined(VBOX_WITH_NAT_SERVICE)
1317 if (fCategory & USAGE_NATNETWORK)
1318 {
1319 RTStrmPrintf(pStrm,
1320 "%s natnetwork %s add --netname <name>\n"
1321 " --network <network>\n"
1322 " [--enable|--disable]\n"
1323 " [--dhcp on|off]\n"
1324 " [--port-forward-4 <rule>]\n"
1325 " [--loopback-4 <rule>]\n"
1326 " [--ipv6 on|off]\n"
1327 " [--port-forward-6 <rule>]\n"
1328 " [--loopback-6 <rule>]\n\n"
1329 "%s natnetwork %s remove --netname <name>\n\n"
1330 "%s natnetwork %s modify --netname <name>\n"
1331 " [--network <network>]\n"
1332 " [--enable|--disable]\n"
1333 " [--dhcp on|off]\n"
1334 " [--port-forward-4 <rule>]\n"
1335 " [--loopback-4 <rule>]\n"
1336 " [--ipv6 on|off]\n"
1337 " [--port-forward-6 <rule>]\n"
1338 " [--loopback-6 <rule>]\n\n"
1339 "%s natnetwork %s start --netname <name>\n\n"
1340 "%s natnetwork %s stop --netname <name>\n"
1341 "\n", SEP, SEP, SEP, SEP, SEP);
1342
1343
1344 }
1345#endif
1346
1347#if defined(VBOX_WITH_NETFLT)
1348 if (fCategory & USAGE_HOSTONLYIFS)
1349 {
1350 RTStrmPrintf(pStrm,
1351 "%s hostonlyif %s ipconfig <name>\n"
1352 " [--dhcp |\n"
1353 " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
1354 " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
1355# if !defined(RT_OS_SOLARIS) || defined(VBOX_ONLY_DOCS)
1356 " create |\n"
1357 " remove <name>\n"
1358# endif
1359 "\n", SEP);
1360 }
1361#endif
1362
1363 if (fCategory & USAGE_DHCPSERVER)
1364 {
1365 RTStrmPrintf(pStrm,
1366 "%s dhcpserver %s add|modify --netname <network_name> |\n"
1367#if defined(VBOX_WITH_NETFLT)
1368 " --ifname <hostonly_if_name>\n"
1369#endif
1370 " [--ip <ip_address>\n"
1371 " --netmask <network_mask>\n"
1372 " --lowerip <lower_ip>\n"
1373 " --upperip <upper_ip>]\n"
1374 " [--enable | --disable]\n\n"
1375 "%s dhcpserver %s remove --netname <network_name> |\n"
1376#if defined(VBOX_WITH_NETFLT)
1377 " --ifname <hostonly_if_name>\n"
1378#endif
1379 "\n", SEP, SEP);
1380 }
1381
1382#ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
1383 if (fCategory == USAGE_ALL)
1384 {
1385 uint32_t cPendingBlankLines = 0;
1386 for (uint32_t i = 0; i < g_cHelpEntries; i++)
1387 {
1388 PCREFENTRY pHelp = g_apHelpEntries[i];
1389 RTStrmPrintf(pStrm, " %c%s:\n", RT_C_TO_UPPER(pHelp->pszBrief[0]), pHelp->pszBrief + 1);
1390 cPendingBlankLines = printStringTable(pStrm, &pHelp->Synopsis, REFENTRYSTR_SCOPE_GLOBAL, cPendingBlankLines);
1391 if (!cPendingBlankLines)
1392 cPendingBlankLines = 1;
1393 }
1394 }
1395
1396#endif
1397}
1398
1399/**
1400 * Print a usage synopsis and the syntax error message.
1401 * @returns RTEXITCODE_SYNTAX.
1402 */
1403RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
1404{
1405 va_list args;
1406 showLogo(g_pStdErr); // show logo even if suppressed
1407#ifndef VBOX_ONLY_DOCS
1408 if (g_fInternalMode)
1409 printUsageInternal(fCategory, g_pStdErr);
1410 else
1411 printUsage(fCategory, ~0U, g_pStdErr);
1412#endif /* !VBOX_ONLY_DOCS */
1413 va_start(args, pszFormat);
1414 RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1415 va_end(args);
1416 return RTEXITCODE_SYNTAX;
1417}
1418
1419/**
1420 * Print a usage synopsis and the syntax error message.
1421 * @returns RTEXITCODE_SYNTAX.
1422 */
1423RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
1424{
1425 va_list args;
1426 showLogo(g_pStdErr); // show logo even if suppressed
1427#ifndef VBOX_ONLY_DOCS
1428 if (g_fInternalMode)
1429 printUsageInternal(fCategory, g_pStdErr);
1430 else
1431 printUsage(fCategory, fSubCategory, g_pStdErr);
1432#endif /* !VBOX_ONLY_DOCS */
1433 va_start(args, pszFormat);
1434 RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1435 va_end(args);
1436 return RTEXITCODE_SYNTAX;
1437}
1438
1439/**
1440 * errorSyntax for RTGetOpt users.
1441 *
1442 * @returns RTEXITCODE_SYNTAX.
1443 *
1444 * @param fCategory The usage category of the command.
1445 * @param fSubCategory The usage sub-category of the command.
1446 * @param rc The RTGetOpt return code.
1447 * @param pValueUnion The value union.
1448 */
1449RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
1450{
1451 /*
1452 * Check if it is an unhandled standard option.
1453 */
1454 if (rc == 'V')
1455 {
1456 RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
1457 return RTEXITCODE_SUCCESS;
1458 }
1459
1460 if (rc == 'h')
1461 {
1462 showLogo(g_pStdErr);
1463#ifndef VBOX_ONLY_DOCS
1464 if (g_fInternalMode)
1465 printUsageInternal(fCategory, g_pStdOut);
1466 else
1467 printUsage(fCategory, fSubCategory, g_pStdOut);
1468#endif
1469 return RTEXITCODE_SUCCESS;
1470 }
1471
1472 /*
1473 * General failure.
1474 */
1475 showLogo(g_pStdErr); // show logo even if suppressed
1476#ifndef VBOX_ONLY_DOCS
1477 if (g_fInternalMode)
1478 printUsageInternal(fCategory, g_pStdErr);
1479 else
1480 printUsage(fCategory, fSubCategory, g_pStdErr);
1481#endif /* !VBOX_ONLY_DOCS */
1482
1483 if (rc == VINF_GETOPT_NOT_OPTION)
1484 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
1485 if (rc > 0)
1486 {
1487 if (RT_C_IS_PRINT(rc))
1488 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
1489 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
1490 }
1491 if (rc == VERR_GETOPT_UNKNOWN_OPTION)
1492 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
1493 if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
1494 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
1495 if (pValueUnion->pDef)
1496 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
1497 return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
1498}
1499
1500/**
1501 * errorSyntax for RTGetOpt users.
1502 *
1503 * @returns RTEXITCODE_SYNTAX.
1504 *
1505 * @param fUsageCategory The usage category of the command.
1506 * @param rc The RTGetOpt return code.
1507 * @param pValueUnion The value union.
1508 */
1509RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
1510{
1511 return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
1512}
1513
1514/**
1515 * Print an error message without the syntax stuff.
1516 *
1517 * @returns RTEXITCODE_SYNTAX.
1518 */
1519RTEXITCODE errorArgument(const char *pszFormat, ...)
1520{
1521 va_list args;
1522 va_start(args, pszFormat);
1523 RTMsgErrorV(pszFormat, args);
1524 va_end(args);
1525 return RTEXITCODE_SYNTAX;
1526}
1527
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