VBoxManageHelp.cpp@ 80585

Last change on this file since 80585 was 80074, checked in by vboxsync, 5 years ago
VMM,Main,++: Retired the unfinished FTM component.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 66.5 KB

Line
1	/* $Id: VBoxManageHelp.cpp 80074 2019-07-31 14:18:34Z vboxsync $ */
2	/** @file
3	* VBoxManage - help and other message output.
4	*/
5
6	/*
7	* Copyright (C) 2006-2019 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 \n"
451	"General Options:\n \n"
452	" [-v\|--version] print version number and exit\n"
453	" [-q\|--nologo] suppress the logo\n"
454	" [--settingspw <pw>] provide the settings password\n"
455	" [--settingspwfile <file>] provide a file containing the settings password\n"
456	" [@<response-file>] load arguments from the given response file (bourne style)\n"
457	" \n \n"
458	"Commands:\n \n");
459
460	const char *pcszSep1 = " ";
461	const char *pcszSep2 = " ";
462	if (enmCommand != USAGE_S_ALL)
463	{
464	pcszSep1 = "VBoxManage";
465	pcszSep2 = "";
466	}
467
468	#define SEP pcszSep1, pcszSep2
469
470	if (enmCommand == USAGE_LIST \|\| enmCommand == USAGE_S_ALL)
471	RTStrmPrintf(pStrm,
472	"%s list [--long\|-l] [--sorted\|-s]%s vms\|runningvms\|ostypes\|hostdvds\|hostfloppies\|\n"
473	#if defined(VBOX_WITH_NETFLT)
474	" intnets\|bridgedifs\|hostonlyifs\|natnets\|dhcpservers\|\n"
475	#else
476	" intnets\|bridgedifs\|natnets\|dhcpservers\|hostinfo\|\n"
477	#endif
478	" hostinfo\|hostcpuids\|hddbackends\|hdds\|dvds\|floppies\|\n"
479	" usbhost\|usbfilters\|systemproperties\|extpacks\|\n"
480	" groups\|webcams\|screenshotformats\|cloudproviders\|\n"
481	" cloudprofiles\n"
482	"\n", SEP);
483
484	if (enmCommand == USAGE_SHOWVMINFO \|\| enmCommand == USAGE_S_ALL)
485	RTStrmPrintf(pStrm,
486	"%s showvminfo %s <uuid\|vmname> [--details]\n"
487	" [--machinereadable]\n"
488	"%s showvminfo %s <uuid\|vmname> --log <idx>\n"
489	"\n", SEP, SEP);
490
491	if (enmCommand == USAGE_REGISTERVM \|\| enmCommand == USAGE_S_ALL)
492	RTStrmPrintf(pStrm,
493	"%s registervm %s <filename>\n"
494	"\n", SEP);
495
496	if (enmCommand == USAGE_UNREGISTERVM \|\| enmCommand == USAGE_S_ALL)
497	RTStrmPrintf(pStrm,
498	"%s unregistervm %s <uuid\|vmname> [--delete]\n"
499	"\n", SEP);
500
501	if (enmCommand == USAGE_CREATEVM \|\| enmCommand == USAGE_S_ALL)
502	RTStrmPrintf(pStrm,
503	"%s createvm %s --name <name>\n"
504	" [--groups <group>, ...]\n"
505	" [--ostype <ostype>]\n"
506	" [--register]\n"
507	" [--basefolder <path>]\n"
508	" [--uuid <uuid>]\n"
509	" [--default]\n"
510	"\n", SEP);
511
512	if (enmCommand == USAGE_MODIFYVM \|\| enmCommand == USAGE_S_ALL)
513	{
514	RTStrmPrintf(pStrm,
515	"%s modifyvm %s <uuid\|vmname>\n"
516	" [--name <name>]\n"
517	" [--groups <group>, ...]\n"
518	" [--description <desc>]\n"
519	" [--ostype <ostype>]\n"
520	" [--iconfile <filename>]\n"
521	" [--memory <memorysize in MB>]\n"
522	" [--pagefusion on\|off]\n"
523	" [--vram <vramsize in MB>]\n"
524	" [--acpi on\|off]\n"
525	#ifdef VBOX_WITH_PCI_PASSTHROUGH
526	" [--pciattach 03:04.0]\n"
527	" [--pciattach 03:04.0@02:01.0]\n"
528	" [--pcidetach 03:04.0]\n"
529	#endif
530	" [--ioapic on\|off]\n"
531	" [--hpet on\|off]\n"
532	" [--triplefaultreset on\|off]\n"
533	" [--apic on\|off]\n"
534	" [--x2apic on\|off]\n"
535	" [--paravirtprovider none\|default\|legacy\|minimal\|\n"
536	" hyperv\|kvm]\n"
537	" [--paravirtdebug <key=value> [,<key=value> ...]]\n"
538	" [--hwvirtex on\|off]\n"
539	" [--nestedpaging on\|off]\n"
540	" [--largepages on\|off]\n"
541	" [--vtxvpid on\|off]\n"
542	" [--vtxux on\|off]\n"
543	" [--pae on\|off]\n"
544	" [--longmode on\|off]\n"
545	" [--ibpb-on-vm-exit on\|off]\n"
546	" [--ibpb-on-vm-entry on\|off]\n"
547	" [--spec-ctrl on\|off]\n"
548	" [--l1d-flush-on-sched on\|off]\n"
549	" [--l1d-flush-on-vm-entry on\|off]\n"
550	" [--mds-clear-on-sched on\|off]\n"
551	" [--mds-clear-on-vm-entry on\|off]\n"
552	" [--nested-hw-virt on\|off]\n"
553	" [--cpu-profile \"host\|Intel 80[86\|286\|386]\"]\n"
554	" [--cpuid-portability-level <0..3>]\n"
555	" [--cpuid-set <leaf[:subleaf]> <eax> <ebx> <ecx> <edx>]\n"
556	" [--cpuid-remove <leaf[:subleaf]>]\n"
557	" [--cpuidremoveall]\n"
558	" [--hardwareuuid <uuid>]\n"
559	" [--cpus <number>]\n"
560	" [--cpuhotplug on\|off]\n"
561	" [--plugcpu <id>]\n"
562	" [--unplugcpu <id>]\n"
563	" [--cpuexecutioncap <1-100>]\n"
564	" [--rtcuseutc on\|off]\n"
565	#ifdef VBOX_WITH_VMSVGA
566	" [--graphicscontroller none\|vboxvga\|vmsvga\|vboxsvga]\n"
567	#else
568	" [--graphicscontroller none\|vboxvga]\n"
569	#endif
570	" [--monitorcount <number>]\n"
571	" [--accelerate3d on\|off]\n"
572	#ifdef VBOX_WITH_VIDEOHWACCEL
573	" [--accelerate2dvideo on\|off]\n"
574	#endif
575	" [--firmware bios\|efi\|efi32\|efi64]\n"
576	" [--chipset ich9\|piix3]\n"
577	" [--bioslogofadein on\|off]\n"
578	" [--bioslogofadeout on\|off]\n"
579	" [--bioslogodisplaytime <msec>]\n"
580	" [--bioslogoimagepath <imagepath>]\n"
581	" [--biosbootmenu disabled\|menuonly\|messageandmenu]\n"
582	" [--biosapic disabled\|apic\|x2apic]\n"
583	" [--biossystemtimeoffset <msec>]\n"
584	" [--biospxedebug on\|off]\n"
585	" [--boot<1-4> none\|floppy\|dvd\|disk\|net>]\n"
586	" [--nic<1-N> none\|null\|nat\|bridged\|intnet"
587	#if defined(VBOX_WITH_NETFLT)
588	"\|hostonly"
589	#endif
590	"\|\n"
591	" generic\|natnetwork"
592	"]\n"
593	" [--nictype<1-N> Am79C970A\|Am79C973"
594	#ifdef VBOX_WITH_E1000
595	"\|\n 82540EM\|82543GC\|82545EM"
596	#endif
597	#ifdef VBOX_WITH_VIRTIO
598	"\|\n virtio"
599	#endif /* VBOX_WITH_VIRTIO */
600	"]\n"
601	" [--cableconnected<1-N> on\|off]\n"
602	" [--nictrace<1-N> on\|off]\n"
603	" [--nictracefile<1-N> <filename>]\n"
604	" [--nicproperty<1-N> name=[value]]\n"
605	" [--nicspeed<1-N> <kbps>]\n"
606	" [--nicbootprio<1-N> <priority>]\n"
607	" [--nicpromisc<1-N> deny\|allow-vms\|allow-all]\n"
608	" [--nicbandwidthgroup<1-N> none\|<name>]\n"
609	" [--bridgeadapter<1-N> none\|<devicename>]\n"
610	#if defined(VBOX_WITH_NETFLT)
611	" [--hostonlyadapter<1-N> none\|<devicename>]\n"
612	#endif
613	" [--intnet<1-N> <network name>]\n"
614	" [--nat-network<1-N> <network name>]\n"
615	" [--nicgenericdrv<1-N> <driver>]\n"
616	" [--natnet<1-N> <network>\|default]\n"
617	" [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
618	" [<sockrcv>],[<tcpsnd>],\n"
619	" [<tcprcv>]]\n"
620	" [--natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
621	" <hostport>,[<guestip>],<guestport>]\n"
622	" [--natpf<1-N> delete <rulename>]\n"
623	" [--nattftpprefix<1-N> <prefix>]\n"
624	" [--nattftpfile<1-N> <file>]\n"
625	" [--nattftpserver<1-N> <ip>]\n"
626	" [--natbindip<1-N> <ip>]\n"
627	" [--natdnspassdomain<1-N> on\|off]\n"
628	" [--natdnsproxy<1-N> on\|off]\n"
629	" [--natdnshostresolver<1-N> on\|off]\n"
630	" [--nataliasmode<1-N> default\|[log],[proxyonly],\n"
631	" [sameports]]\n"
632	" [--macaddress<1-N> auto\|<mac>]\n"
633	" [--mouse ps2\|usb\|usbtablet\|usbmultitouch]\n"
634	" [--keyboard ps2\|usb]\n"
635	" [--uart<1-N> off\|<I/O base> <IRQ>]\n"
636	" [--uartmode<1-N> disconnected\|\n"
637	" server <pipe>\|\n"
638	" client <pipe>\|\n"
639	" tcpserver <port>\|\n"
640	" tcpclient <hostname:port>\|\n"
641	" file <file>\|\n"
642	" <devicename>]\n"
643	" [--uarttype<1-N> 16450\|16550A\|16750]\n"
644	#if defined(RT_OS_LINUX) \|\| defined(RT_OS_WINDOWS)
645	" [--lpt<1-N> off\|<I/O base> <IRQ>]\n"
646	" [--lptmode<1-N> <devicename>]\n"
647	#endif
648	" [--guestmemoryballoon <balloonsize in MB>]\n"
649	" [--vm-process-priority default\|flat\|low\|normal\|high]\n"
650	" [--audio none\|null", SEP);
651	if (fWin)
652	{
653	#ifdef VBOX_WITH_WINMM
654	RTStrmPrintf(pStrm, "\|winmm\|dsound");
655	#else
656	RTStrmPrintf(pStrm, "\|dsound");
657	#endif
658	}
659	if (fLinux \|\| fSolaris)
660	{
661	RTStrmPrintf(pStrm, ""
662	#ifdef VBOX_WITH_AUDIO_OSS
663	"\|oss"
664	#endif
665	#ifdef VBOX_WITH_AUDIO_ALSA
666	"\|alsa"
667	#endif
668	#ifdef VBOX_WITH_AUDIO_PULSE
669	"\|pulse"
670	#endif
671	);
672	}
673	if (fFreeBSD)
674	{
675	#ifdef VBOX_WITH_AUDIO_OSS
676	/* Get the line break sorted when dumping all option variants. */
677	if (fDumpOpts)
678	{
679	RTStrmPrintf(pStrm, "\|\n"
680	" oss");
681	}
682	else
683	RTStrmPrintf(pStrm, "\|oss");
684	#endif
685	#ifdef VBOX_WITH_AUDIO_PULSE
686	RTStrmPrintf(pStrm, "\|pulse");
687	#endif
688	}
689	if (fDarwin)
690	{
691	RTStrmPrintf(pStrm, "\|coreaudio");
692	}
693	RTStrmPrintf(pStrm, "]\n");
694	RTStrmPrintf(pStrm,
695	" [--audioin on\|off]\n"
696	" [--audioout on\|off]\n"
697	" [--audiocontroller ac97\|hda\|sb16]\n"
698	" [--audiocodec stac9700\|ad1980\|stac9221\|sb16]\n"
699	" [--clipboard disabled\|hosttoguest\|guesttohost\|\n"
700	" bidirectional]\n"
701	" [--draganddrop disabled\|hosttoguest\|guesttohost\|\n"
702	" bidirectional]\n");
703	RTStrmPrintf(pStrm,
704	" [--vrde on\|off]\n"
705	" [--vrdeextpack default\|<name>]\n"
706	" [--vrdeproperty <name=[value]>]\n"
707	" [--vrdeport <hostport>]\n"
708	" [--vrdeaddress <hostip>]\n"
709	" [--vrdeauthtype null\|external\|guest]\n"
710	" [--vrdeauthlibrary default\|<name>]\n"
711	" [--vrdemulticon on\|off]\n"
712	" [--vrdereusecon on\|off]\n"
713	" [--vrdevideochannel on\|off]\n"
714	" [--vrdevideochannelquality <percent>]\n");
715	RTStrmPrintf(pStrm,
716	" [--usbohci on\|off]\n"
717	" [--usbehci on\|off]\n"
718	" [--usbxhci on\|off]\n"
719	" [--usbrename <oldname> <newname>]\n"
720	" [--snapshotfolder default\|<path>]\n"
721	" [--teleporter on\|off]\n"
722	" [--teleporterport <port>]\n"
723	" [--teleporteraddress <address\|empty>]\n"
724	" [--teleporterpassword <password>]\n"
725	" [--teleporterpasswordfile <file>\|stdin]\n"
726	" [--tracing-enabled on\|off]\n"
727	" [--tracing-config <config-string>]\n"
728	" [--tracing-allow-vm-access on\|off]\n"
729	#if 0
730	" [--iocache on\|off]\n"
731	" [--iocachesize <I/O cache size in MB>]\n"
732	#endif
733	#ifdef VBOX_WITH_USB_CARDREADER
734	" [--usbcardreader on\|off]\n"
735	#endif
736	" [--autostart-enabled on\|off]\n"
737	" [--autostart-delay <seconds>]\n"
738	#if 0
739	" [--autostop-type disabled\|savestate\|poweroff\|\n"
740	" acpishutdown]\n"
741	#endif
742	#ifdef VBOX_WITH_RECORDING
743	" [--recording on\|off]\n"
744	" [--recordingscreens all\|<screen ID> [<screen ID> ...]]\n"
745	" [--recordingfile <filename>]\n"
746	" [--recordingvideores <width> <height>]\n"
747	" [--recordingvideorate <rate>]\n"
748	" [--recordingvideofps <fps>]\n"
749	" [--recordingmaxtime <s>]\n"
750	" [--recordingmaxsize <MB>]\n"
751	" [--recordingopts <key=value> [,<key=value> ...]]\n"
752	#endif
753	" [--defaultfrontend default\|<name>]\n"
754	"\n");
755	}
756
757	if (enmCommand == USAGE_MOVEVM \|\| enmCommand == USAGE_S_ALL)
758	RTStrmPrintf(pStrm,
759	"%s movevm %s <uuid\|vmname>\n"
760	" --type basic\n"
761	" [--folder <path>]\n"
762	"\n", SEP);
763
764	if (enmCommand == USAGE_IMPORTAPPLIANCE \|\| enmCommand == USAGE_S_ALL)
765	RTStrmPrintf(pStrm,
766	"%s import %s <ovfname/ovaname>\n"
767	" [--dry-run\|-n]\n"
768	" [--options keepallmacs\|keepnatmacs\|importtovdi]\n"
769	" [more options]\n"
770	" (run with -n to have options displayed\n"
771	" for a particular OVF)\n\n", SEP);
772
773	if (enmCommand == USAGE_EXPORTAPPLIANCE \|\| enmCommand == USAGE_S_ALL)
774	RTStrmPrintf(pStrm,
775	"%s export %s <machines> --output\|-o <name>.<ovf/ova/tar.gz>\n"
776	" [--legacy09\|--ovf09\|--ovf10\|--ovf20\|--opc10]\n"
777	" [--manifest]\n"
778	" [--iso]\n"
779	" [--options manifest\|iso\|nomacs\|nomacsbutnat]\n"
780	" [--vsys <number of virtual system>]\n"
781	" [--vmname <name>]\n"
782	" [--product <product name>]\n"
783	" [--producturl <product url>]\n"
784	" [--vendor <vendor name>]\n"
785	" [--vendorurl <vendor url>]\n"
786	" [--version <version info>]\n"
787	" [--description <description info>]\n"
788	" [--eula <license text>]\n"
789	" [--eulafile <filename>]\n"
790	" [--cloud <number of virtual system>]\n"
791	" [--vmname <name>]\n"
792	" [--cloudprofile <cloud profile name>]\n"
793	" [--cloudshape <shape>]\n"
794	" [--clouddomain <domain>]\n"
795	" [--clouddisksize <disk size in GB>]\n"
796	" [--cloudbucket <bucket name>]\n"
797	" [--cloudocivcn <OCI vcn id>]\n"
798	" [--cloudocisubnet <OCI subnet id>]\n"
799	" [--cloudkeepobject <true/false>]\n"
800	" [--cloudlaunchinstance <true/false>]\n"
801	" [--cloudpublicip <true/false>]\n"
802	"\n", SEP);
803
804	if (enmCommand == USAGE_STARTVM \|\| enmCommand == USAGE_S_ALL)
805	{
806	RTStrmPrintf(pStrm,
807	"%s startvm %s <uuid\|vmname>...\n"
808	" [--type gui", SEP);
809	if (fVBoxSDL)
810	RTStrmPrintf(pStrm, "\|sdl");
811	RTStrmPrintf(pStrm, "\|headless\|separate]\n");
812	RTStrmPrintf(pStrm,
813	" [-E\|--putenv <NAME>[=<VALUE>]]\n"
814	"\n");
815	}
816
817	if (enmCommand == USAGE_CONTROLVM \|\| enmCommand == USAGE_S_ALL)
818	{
819	RTStrmPrintf(pStrm,
820	"%s controlvm %s <uuid\|vmname>\n"
821	" pause\|resume\|reset\|poweroff\|savestate\|\n"
822	" acpipowerbutton\|acpisleepbutton\|\n"
823	" keyboardputscancode <hex> [<hex> ...]\|\n"
824	" keyboardputstring <string1> [<string2> ...]\|\n"
825	" keyboardputfile <filename>\|\n"
826	" setlinkstate<1-N> on\|off \|\n"
827	#if defined(VBOX_WITH_NETFLT)
828	" nic<1-N> null\|nat\|bridged\|intnet\|hostonly\|generic\|\n"
829	" natnetwork [<devicename>] \|\n"
830	#else /* !VBOX_WITH_NETFLT */
831	" nic<1-N> null\|nat\|bridged\|intnet\|generic\|natnetwork\n"
832	" [<devicename>] \|\n"
833	#endif /* !VBOX_WITH_NETFLT */
834	" nictrace<1-N> on\|off \|\n"
835	" nictracefile<1-N> <filename> \|\n"
836	" nicproperty<1-N> name=[value] \|\n"
837	" nicpromisc<1-N> deny\|allow-vms\|allow-all \|\n"
838	" natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
839	" <hostport>,[<guestip>],<guestport> \|\n"
840	" natpf<1-N> delete <rulename> \|\n"
841	" guestmemoryballoon <balloonsize in MB> \|\n"
842	" usbattach <uuid>\|<address>\n"
843	" [--capturefile <filename>] \|\n"
844	" usbdetach <uuid>\|<address> \|\n"
845	" audioin on\|off \|\n"
846	" audioout on\|off \|\n"
847	" clipboard disabled\|hosttoguest\|guesttohost\|\n"
848	" bidirectional \|\n"
849	" draganddrop disabled\|hosttoguest\|guesttohost\|\n"
850	" bidirectional \|\n"
851	" vrde on\|off \|\n"
852	" vrdeport <port> \|\n"
853	" vrdeproperty <name=[value]> \|\n"
854	" vrdevideochannelquality <percent> \|\n"
855	" setvideomodehint <xres> <yres> <bpp>\n"
856	" [[<display>] [<enabled:yes\|no> \|\n"
857	" [<xorigin> <yorigin>]]] \|\n"
858	" setscreenlayout <display> on\|primary <xorigin> <yorigin> <xres> <yres> <bpp> \| off\n"
859	" screenshotpng <file> [display] \|\n"
860	#ifdef VBOX_WITH_RECORDING
861	" recording on\|off \|\n"
862	" recording screens all\|none\|<screen>,[<screen>...] \|\n"
863	" recording filename <file> \|\n"
864	" recording videores <width>x<height> \|\n"
865	" recording videorate <rate> \|\n"
866	" recording videofps <fps> \|\n"
867	" recording maxtime <s> \|\n"
868	" recording maxfilesize <MB> \|\n"
869	#endif /* VBOX_WITH_RECORDING */
870	" setcredentials <username>\n"
871	" --passwordfile <file> \| <password>\n"
872	" <domain>\n"
873	" [--allowlocallogon <yes\|no>] \|\n"
874	" teleport --host <name> --port <port>\n"
875	" [--maxdowntime <msec>]\n"
876	" [--passwordfile <file> \|\n"
877	" --password <password>] \|\n"
878	" plugcpu <id> \|\n"
879	" unplugcpu <id> \|\n"
880	" cpuexecutioncap <1-100>\n"
881	" webcam <attach [path [settings]]> \| <detach [path]> \| <list>\n"
882	" addencpassword <id>\n"
883	" <password file>\|-\n"
884	" [--removeonsuspend <yes\|no>]\n"
885	" removeencpassword <id>\n"
886	" removeallencpasswords\n"
887	" changeuartmode<1-N> disconnected\|\n"
888	" server <pipe>\|\n"
889	" client <pipe>\|\n"
890	" tcpserver <port>\|\n"
891	" tcpclient <hostname:port>\|\n"
892	" file <file>\|\n"
893	" <devicename>\n"
894	" vm-process-priority default\|flat\|low\|normal\|high\n"
895	"\n", SEP);
896	}
897
898	if (enmCommand == USAGE_DISCARDSTATE \|\| enmCommand == USAGE_S_ALL)
899	RTStrmPrintf(pStrm,
900	"%s discardstate %s <uuid\|vmname>\n"
901	"\n", SEP);
902
903	if (enmCommand == USAGE_ADOPTSTATE \|\| enmCommand == USAGE_S_ALL)
904	RTStrmPrintf(pStrm,
905	"%s adoptstate %s <uuid\|vmname> <state_file>\n"
906	"\n", SEP);
907
908	if (enmCommand == USAGE_CLOSEMEDIUM \|\| enmCommand == USAGE_S_ALL)
909	RTStrmPrintf(pStrm,
910	"%s closemedium %s [disk\|dvd\|floppy] <uuid\|filename>\n"
911	" [--delete]\n"
912	"\n", SEP);
913
914	if (enmCommand == USAGE_STORAGEATTACH \|\| enmCommand == USAGE_S_ALL)
915	RTStrmPrintf(pStrm,
916	"%s storageattach %s <uuid\|vmname>\n"
917	" --storagectl <name>\n"
918	" [--port <number>]\n"
919	" [--device <number>]\n"
920	" [--type dvddrive\|hdd\|fdd]\n"
921	" [--medium none\|emptydrive\|additions\|\n"
922	" <uuid\|filename>\|host:<drive>\|iscsi]\n"
923	" [--mtype normal\|writethrough\|immutable\|shareable\|\n"
924	" readonly\|multiattach]\n"
925	" [--comment <text>]\n"
926	" [--setuuid <uuid>]\n"
927	" [--setparentuuid <uuid>]\n"
928	" [--passthrough on\|off]\n"
929	" [--tempeject on\|off]\n"
930	" [--nonrotational on\|off]\n"
931	" [--discard on\|off]\n"
932	" [--hotpluggable on\|off]\n"
933	" [--bandwidthgroup <name>]\n"
934	" [--forceunmount]\n"
935	" [--server <name>\|<ip>]\n"
936	" [--target <target>]\n"
937	" [--tport <port>]\n"
938	" [--lun <lun>]\n"
939	" [--encodedlun <lun>]\n"
940	" [--username <username>]\n"
941	" [--password <password>]\n"
942	" [--passwordfile <file>]\n"
943	" [--initiator <initiator>]\n"
944	" [--intnet]\n"
945	"\n", SEP);
946
947	if (enmCommand == USAGE_STORAGECONTROLLER \|\| enmCommand == USAGE_S_ALL)
948	RTStrmPrintf(pStrm,
949	"%s storagectl %s <uuid\|vmname>\n"
950	" --name <name>\n"
951	" [--add ide\|sata\|scsi\|floppy\|sas\|usb\|pcie\|virtio]\n"
952	" [--controller LSILogic\|LSILogicSAS\|BusLogic\|\n"
953	" IntelAHCI\|PIIX3\|PIIX4\|ICH6\|I82078\|\n"
954	" [ USB\|NVMe\|VirtIO]\n"
955	" [--portcount <1-n>]\n"
956	" [--hostiocache on\|off]\n"
957	" [--bootable on\|off]\n"
958	" [--rename <name>]\n"
959	" [--remove]\n"
960	"\n", SEP);
961
962	if (enmCommand == USAGE_BANDWIDTHCONTROL \|\| enmCommand == USAGE_S_ALL)
963	RTStrmPrintf(pStrm,
964	"%s bandwidthctl %s <uuid\|vmname>\n"
965	" add <name> --type disk\|network\n"
966	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
967	" set <name>\n"
968	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
969	" remove <name> \|\n"
970	" list [--machinereadable]\n"
971	" (limit units: k=kilobit, m=megabit, g=gigabit,\n"
972	" K=kilobyte, M=megabyte, G=gigabyte)\n"
973	"\n", SEP);
974
975	if (enmCommand == USAGE_SHOWMEDIUMINFO \|\| enmCommand == USAGE_S_ALL)
976	RTStrmPrintf(pStrm,
977	"%s showmediuminfo %s [disk\|dvd\|floppy] <uuid\|filename>\n"
978	"\n", SEP);
979
980	if (enmCommand == USAGE_CREATEMEDIUM \|\| enmCommand == USAGE_S_ALL)
981	RTStrmPrintf(pStrm,
982	"%s createmedium %s [disk\|dvd\|floppy] --filename <filename>\n"
983	" [--size <megabytes>\|--sizebyte <bytes>]\n"
984	" [--diffparent <uuid>\|<filename>]\n"
985	" [--format VDI\|VMDK\|VHD] (default: VDI)]\n"
986	" [--variant Standard,Fixed,Split2G,Stream,ESX,\n"
987	" Formatted]\n"
988	" [[--property <name>=<value>] --property <name>=<value]...\n"
989	"\n", SEP);
990
991	if (enmCommand == USAGE_MODIFYMEDIUM \|\| enmCommand == USAGE_S_ALL)
992	RTStrmPrintf(pStrm,
993	"%s modifymedium %s [disk\|dvd\|floppy] <uuid\|filename>\n"
994	" [--type normal\|writethrough\|immutable\|shareable\|\n"
995	" readonly\|multiattach]\n"
996	" [--autoreset on\|off]\n"
997	" [--property <name=[value]>]\n"
998	" [--compact]\n"
999	" [--resize <megabytes>\|--resizebyte <bytes>]\n"
1000	" [--move <path>]\n"
1001	" [--setlocation <path>]\n"
1002	" [--description <description string>]"
1003	"\n", SEP);
1004
1005	if (enmCommand == USAGE_CLONEMEDIUM \|\| enmCommand == USAGE_S_ALL)
1006	RTStrmPrintf(pStrm,
1007	"%s clonemedium %s [disk\|dvd\|floppy] <uuid\|inputfile> <uuid\|outputfile>\n"
1008	" [--format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
1009	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1010	" [--existing]\n"
1011	"\n", SEP);
1012
1013	if (enmCommand == USAGE_MEDIUMPROPERTY \|\| enmCommand == USAGE_S_ALL)
1014	RTStrmPrintf(pStrm,
1015	"%s mediumproperty %s [disk\|dvd\|floppy] set <uuid\|filename>\n"
1016	" <property> <value>\n"
1017	"\n"
1018	" [disk\|dvd\|floppy] get <uuid\|filename>\n"
1019	" <property>\n"
1020	"\n"
1021	" [disk\|dvd\|floppy] delete <uuid\|filename>\n"
1022	" <property>\n"
1023	"\n", SEP);
1024
1025	if (enmCommand == USAGE_ENCRYPTMEDIUM \|\| enmCommand == USAGE_S_ALL)
1026	RTStrmPrintf(pStrm,
1027	"%s encryptmedium %s <uuid\|filename>\n"
1028	" [--newpassword <file>\|-]\n"
1029	" [--oldpassword <file>\|-]\n"
1030	" [--cipher <cipher identifier>]\n"
1031	" [--newpasswordid <password identifier>]\n"
1032	"\n", SEP);
1033
1034	if (enmCommand == USAGE_MEDIUMENCCHKPWD \|\| enmCommand == USAGE_S_ALL)
1035	RTStrmPrintf(pStrm,
1036	"%s checkmediumpwd %s <uuid\|filename>\n"
1037	" <pwd file>\|-\n"
1038	"\n", SEP);
1039
1040	if (enmCommand == USAGE_CONVERTFROMRAW \|\| enmCommand == USAGE_S_ALL)
1041	RTStrmPrintf(pStrm,
1042	"%s convertfromraw %s <filename> <outputfile>\n"
1043	" [--format VDI\|VMDK\|VHD]\n"
1044	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1045	" [--uuid <uuid>]\n"
1046	"%s convertfromraw %s stdin <outputfile> <bytes>\n"
1047	" [--format VDI\|VMDK\|VHD]\n"
1048	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1049	" [--uuid <uuid>]\n"
1050	"\n", SEP, SEP);
1051
1052	if (enmCommand == USAGE_GETEXTRADATA \|\| enmCommand == USAGE_S_ALL)
1053	RTStrmPrintf(pStrm,
1054	"%s getextradata %s global\|<uuid\|vmname>\n"
1055	" <key>\|[enumerate]\n"
1056	"\n", SEP);
1057
1058	if (enmCommand == USAGE_SETEXTRADATA \|\| enmCommand == USAGE_S_ALL)
1059	RTStrmPrintf(pStrm,
1060	"%s setextradata %s global\|<uuid\|vmname>\n"
1061	" <key>\n"
1062	" [<value>] (no value deletes key)\n"
1063	"\n", SEP);
1064
1065	if (enmCommand == USAGE_SETPROPERTY \|\| enmCommand == USAGE_S_ALL)
1066	RTStrmPrintf(pStrm,
1067	"%s setproperty %s machinefolder default\|<folder> \|\n"
1068	" hwvirtexclusive on\|off \|\n"
1069	" vrdeauthlibrary default\|<library> \|\n"
1070	" websrvauthlibrary default\|null\|<library> \|\n"
1071	" vrdeextpack null\|<library> \|\n"
1072	" autostartdbpath null\|<folder> \|\n"
1073	" loghistorycount <value>\n"
1074	" defaultfrontend default\|<name>\n"
1075	" logginglevel <log setting>\n"
1076	" proxymode system\|noproxy\|manual\n"
1077	" proxyurl <url>\n"
1078	"\n", SEP);
1079
1080	if (enmCommand == USAGE_USBFILTER \|\| enmCommand == USAGE_S_ALL)
1081	{
1082	if (fSubcommandScope & HELP_SCOPE_USBFILTER_ADD)
1083	RTStrmPrintf(pStrm,
1084	"%s usbfilter %s add <index,0-N>\n"
1085	" --target <uuid\|vmname>\|global\n"
1086	" --name <string>\n"
1087	" --action ignore\|hold (global filters only)\n"
1088	" [--active yes\|no] (yes)\n"
1089	" [--vendorid <XXXX>] (null)\n"
1090	" [--productid <XXXX>] (null)\n"
1091	" [--revision <IIFF>] (null)\n"
1092	" [--manufacturer <string>] (null)\n"
1093	" [--product <string>] (null)\n"
1094	" [--remote yes\|no] (null, VM filters only)\n"
1095	" [--serialnumber <string>] (null)\n"
1096	" [--maskedinterfaces <XXXXXXXX>]\n"
1097	"\n", SEP);
1098
1099	if (fSubcommandScope & HELP_SCOPE_USBFILTER_MODIFY)
1100	RTStrmPrintf(pStrm,
1101	"%s usbfilter %s modify <index,0-N>\n"
1102	" --target <uuid\|vmname>\|global\n"
1103	" [--name <string>]\n"
1104	" [--action ignore\|hold] (global filters only)\n"
1105	" [--active yes\|no]\n"
1106	" [--vendorid <XXXX>\|\"\"]\n"
1107	" [--productid <XXXX>\|\"\"]\n"
1108	" [--revision <IIFF>\|\"\"]\n"
1109	" [--manufacturer <string>\|\"\"]\n"
1110	" [--product <string>\|\"\"]\n"
1111	" [--remote yes\|no] (null, VM filters only)\n"
1112	" [--serialnumber <string>\|\"\"]\n"
1113	" [--maskedinterfaces <XXXXXXXX>]\n"
1114	"\n", SEP);
1115
1116	if (fSubcommandScope & HELP_SCOPE_USBFILTER_REMOVE)
1117	RTStrmPrintf(pStrm,
1118	"%s usbfilter %s remove <index,0-N>\n"
1119	" --target <uuid\|vmname>\|global\n"
1120	"\n", SEP);
1121	}
1122
1123	if (enmCommand == USAGE_SHAREDFOLDER \|\| enmCommand == USAGE_S_ALL)
1124	{
1125	if (fSubcommandScope & HELP_SCOPE_SHAREDFOLDER_ADD)
1126	RTStrmPrintf(pStrm,
1127	"%s sharedfolder %s add <uuid\|vmname>\n"
1128	" --name <name> --hostpath <hostpath>\n"
1129	" [--transient] [--readonly] [--automount]\n"
1130	"\n", SEP);
1131
1132	if (fSubcommandScope & HELP_SCOPE_SHAREDFOLDER_REMOVE)
1133	RTStrmPrintf(pStrm,
1134	"%s sharedfolder %s remove <uuid\|vmname>\n"
1135	" --name <name> [--transient]\n"
1136	"\n", SEP);
1137	}
1138
1139	#ifdef VBOX_WITH_GUEST_PROPS
1140	if (enmCommand == USAGE_GUESTPROPERTY \|\| enmCommand == USAGE_S_ALL)
1141	usageGuestProperty(pStrm, SEP);
1142	#endif /* VBOX_WITH_GUEST_PROPS defined */
1143
1144	#ifdef VBOX_WITH_GUEST_CONTROL
1145	if (enmCommand == USAGE_GUESTCONTROL \|\| enmCommand == USAGE_S_ALL)
1146	usageGuestControl(pStrm, SEP, fSubcommandScope);
1147	#endif /* VBOX_WITH_GUEST_CONTROL defined */
1148
1149	if (enmCommand == USAGE_METRICS \|\| enmCommand == USAGE_S_ALL)
1150	RTStrmPrintf(pStrm,
1151	"%s metrics %s list [*\|host\|<vmname> [<metric_list>]]\n"
1152	" (comma-separated)\n\n"
1153	"%s metrics %s setup\n"
1154	" [--period <seconds>] (default: 1)\n"
1155	" [--samples <count>] (default: 1)\n"
1156	" [--list]\n"
1157	" [*\|host\|<vmname> [<metric_list>]]\n\n"
1158	"%s metrics %s query [*\|host\|<vmname> [<metric_list>]]\n\n"
1159	"%s metrics %s enable\n"
1160	" [--list]\n"
1161	" [*\|host\|<vmname> [<metric_list>]]\n\n"
1162	"%s metrics %s disable\n"
1163	" [--list]\n"
1164	" [*\|host\|<vmname> [<metric_list>]]\n\n"
1165	"%s metrics %s collect\n"
1166	" [--period <seconds>] (default: 1)\n"
1167	" [--samples <count>] (default: 1)\n"
1168	" [--list]\n"
1169	" [--detach]\n"
1170	" [*\|host\|<vmname> [<metric_list>]]\n"
1171	"\n", SEP, SEP, SEP, SEP, SEP, SEP);
1172
1173	#if defined(VBOX_WITH_NAT_SERVICE)
1174	if (enmCommand == USAGE_NATNETWORK \|\| enmCommand == USAGE_S_ALL)
1175	{
1176	RTStrmPrintf(pStrm,
1177	"%s natnetwork %s add --netname <name>\n"
1178	" --network <network>\n"
1179	" [--enable\|--disable]\n"
1180	" [--dhcp on\|off]\n"
1181	" [--port-forward-4 <rule>]\n"
1182	" [--loopback-4 <rule>]\n"
1183	" [--ipv6 on\|off]\n"
1184	" [--port-forward-6 <rule>]\n"
1185	" [--loopback-6 <rule>]\n\n"
1186	"%s natnetwork %s remove --netname <name>\n\n"
1187	"%s natnetwork %s modify --netname <name>\n"
1188	" [--network <network>]\n"
1189	" [--enable\|--disable]\n"
1190	" [--dhcp on\|off]\n"
1191	" [--port-forward-4 <rule>]\n"
1192	" [--loopback-4 <rule>]\n"
1193	" [--ipv6 on\|off]\n"
1194	" [--port-forward-6 <rule>]\n"
1195	" [--loopback-6 <rule>]\n\n"
1196	"%s natnetwork %s start --netname <name>\n\n"
1197	"%s natnetwork %s stop --netname <name>\n\n"
1198	"%s natnetwork %s list [<pattern>]\n"
1199	"\n", SEP, SEP, SEP, SEP, SEP, SEP);
1200
1201
1202	}
1203	#endif
1204
1205	#if defined(VBOX_WITH_NETFLT)
1206	if (enmCommand == USAGE_HOSTONLYIFS \|\| enmCommand == USAGE_S_ALL)
1207	{
1208	RTStrmPrintf(pStrm,
1209	"%s hostonlyif %s ipconfig <name>\n"
1210	" [--dhcp \|\n"
1211	" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] \|\n"
1212	" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
1213	# if !defined(RT_OS_SOLARIS) \|\| defined(VBOX_ONLY_DOCS)
1214	" create \|\n"
1215	" remove <name>\n"
1216	# endif
1217	"\n", SEP);
1218	}
1219	#endif
1220
1221	if (enmCommand == USAGE_USBDEVSOURCE \|\| enmCommand == USAGE_S_ALL)
1222	{
1223	RTStrmPrintf(pStrm,
1224	"%s usbdevsource %s add <source name>\n"
1225	" --backend <backend>\n"
1226	" --address <address>\n"
1227	"%s usbdevsource %s remove <source name>\n"
1228	"\n", SEP, SEP);
1229	}
1230
1231	#ifndef VBOX_ONLY_DOCS /* Converted to man page, not needed. */
1232	if (enmCommand == USAGE_S_ALL)
1233	{
1234	uint32_t cPendingBlankLines = 0;
1235	for (uint32_t i = 0; i < g_cHelpEntries; i++)
1236	{
1237	PCRTMSGREFENTRY pHelp = g_apHelpEntries[i];
1238	while (cPendingBlankLines-- > 0)
1239	RTStrmPutCh(pStrm, '\n');
1240	RTStrmPrintf(pStrm, " %c%s:\n", RT_C_TO_UPPER(pHelp->pszBrief[0]), pHelp->pszBrief + 1);
1241	cPendingBlankLines = 0;
1242	RTMsgRefEntryPrintStringTable(pStrm, &pHelp->Synopsis, RTMSGREFENTRYSTR_SCOPE_GLOBAL,
1243	&cPendingBlankLines, NULL /pcLinesWritten/);
1244	cPendingBlankLines = RT_MAX(cPendingBlankLines, 1);
1245	}
1246	}
1247	#endif
1248	}
1249
1250	/**
1251	* Print a usage synopsis and the syntax error message.
1252	* @returns RTEXITCODE_SYNTAX.
1253	*/
1254	RTEXITCODE errorSyntax(USAGECATEGORY enmCommand, const char *pszFormat, ...)
1255	{
1256	va_list args;
1257	showLogo(g_pStdErr); // show logo even if suppressed
1258	#ifndef VBOX_ONLY_DOCS
1259	if (g_fInternalMode)
1260	printUsageInternal(enmCommand, g_pStdErr);
1261	else
1262	printUsage(enmCommand, RTMSGREFENTRYSTR_SCOPE_GLOBAL, g_pStdErr);
1263	#else
1264	RT_NOREF_PV(enmCommand);
1265	#endif
1266	va_start(args, pszFormat);
1267	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1268	va_end(args);
1269	return RTEXITCODE_SYNTAX;
1270	}
1271
1272	/**
1273	* Print a usage synopsis and the syntax error message.
1274	* @returns RTEXITCODE_SYNTAX.
1275	*/
1276	RTEXITCODE errorSyntaxEx(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, const char *pszFormat, ...)
1277	{
1278	va_list args;
1279	showLogo(g_pStdErr); // show logo even if suppressed
1280	#ifndef VBOX_ONLY_DOCS
1281	if (g_fInternalMode)
1282	printUsageInternal(enmCommand, g_pStdErr);
1283	else
1284	printUsage(enmCommand, fSubcommandScope, g_pStdErr);
1285	#else
1286	RT_NOREF2(enmCommand, fSubcommandScope);
1287	#endif
1288	va_start(args, pszFormat);
1289	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1290	va_end(args);
1291	return RTEXITCODE_SYNTAX;
1292	}
1293
1294	/**
1295	* errorSyntax for RTGetOpt users.
1296	*
1297	* @returns RTEXITCODE_SYNTAX.
1298	*
1299	* @param enmCommand The command.
1300	* @param fSubcommandScope The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
1301	* for all.
1302	* @param rc The RTGetOpt return code.
1303	* @param pValueUnion The value union.
1304	*/
1305	RTEXITCODE errorGetOptEx(USAGECATEGORY enmCommand, uint64_t fSubcommandScope, int rc, union RTGETOPTUNION const *pValueUnion)
1306	{
1307	/*
1308	* Check if it is an unhandled standard option.
1309	*/
1310	#ifndef VBOX_ONLY_DOCS
1311	if (rc == 'V')
1312	{
1313	RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
1314	return RTEXITCODE_SUCCESS;
1315	}
1316	#endif
1317
1318	if (rc == 'h')
1319	{
1320	showLogo(g_pStdErr);
1321	#ifndef VBOX_ONLY_DOCS
1322	if (g_fInternalMode)
1323	printUsageInternal(enmCommand, g_pStdOut);
1324	else
1325	printUsage(enmCommand, fSubcommandScope, g_pStdOut);
1326	#endif
1327	return RTEXITCODE_SUCCESS;
1328	}
1329
1330	/*
1331	* General failure.
1332	*/
1333	showLogo(g_pStdErr); // show logo even if suppressed
1334	#ifndef VBOX_ONLY_DOCS
1335	if (g_fInternalMode)
1336	printUsageInternal(enmCommand, g_pStdErr);
1337	else
1338	printUsage(enmCommand, fSubcommandScope, g_pStdErr);
1339	#else
1340	RT_NOREF2(enmCommand, fSubcommandScope);
1341	#endif
1342
1343	if (rc == VINF_GETOPT_NOT_OPTION)
1344	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
1345	if (rc > 0)
1346	{
1347	if (RT_C_IS_PRINT(rc))
1348	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
1349	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
1350	}
1351	if (rc == VERR_GETOPT_UNKNOWN_OPTION)
1352	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
1353	if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
1354	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
1355	if (pValueUnion->pDef)
1356	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
1357	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
1358	}
1359
1360	/**
1361	* errorSyntax for RTGetOpt users.
1362	*
1363	* @returns RTEXITCODE_SYNTAX.
1364	*
1365	* @param enmCommand The command.
1366	* @param rc The RTGetOpt return code.
1367	* @param pValueUnion The value union.
1368	*/
1369	RTEXITCODE errorGetOpt(USAGECATEGORY enmCommand, int rc, union RTGETOPTUNION const *pValueUnion)
1370	{
1371	return errorGetOptEx(enmCommand, RTMSGREFENTRYSTR_SCOPE_GLOBAL, rc, pValueUnion);
1372	}
1373
1374	/**
1375	* Print an error message without the syntax stuff.
1376	*
1377	* @returns RTEXITCODE_SYNTAX.
1378	*/
1379	RTEXITCODE errorArgument(const char *pszFormat, ...)
1380	{
1381	va_list args;
1382	va_start(args, pszFormat);
1383	RTMsgErrorV(pszFormat, args);
1384	va_end(args);
1385	return RTEXITCODE_SYNTAX;
1386	}
1387

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

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

Download in other formats: