VBoxManageHelp.cpp@ 85121

Last change on this file since 85121 was 84814, checked in by vboxsync, 5 years ago
Guest Control: Also implemented a "force" flag for the reboot/shutdown command. bugref:9320
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 67.7 KB

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

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

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

Download in other formats: