VBoxManageHelp.cpp@ 86708

Last change on this file since 86708 was 86435, checked in by vboxsync, 4 years ago
VBoxManage: Added --dump-build-type so valkit/vbox.py has a better chance of detecting the build type. bugref:9841
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 67.5 KB

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: