VBoxManageHelp.cpp@ 60756

Last change on this file since 60756 was 60734, checked in by vboxsync, 9 years ago
VBoxManageHelp: Avoid dragging in RTBldCfgRevision, no need to rebuild the manual for each svn update.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 69.1 KB

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

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

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

Download in other formats: