VBoxManageHelp.cpp@ 23569

Last change on this file since 23569 was 23569, checked in by vboxsync, 15 years ago
VBoxManage: added a '--pause' option to the 'snapshot take' command.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 26.4 KB

Line
1	/* $Id: VBoxManageHelp.cpp 23569 2009-10-06 00:31:40Z vboxsync $ */
2	/** @file
3	* VBoxManage - help and other message output.
4	*/
5
6	/*
7	* Copyright (C) 2006-2009 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22	#include <iprt/ctype.h>
23	#include <iprt/getopt.h>
24	#include <iprt/stream.h>
25
26	#include "VBoxManage.h"
27
28	void printUsage(USAGECATEGORY u64Cmd)
29	{
30	#ifdef RT_OS_LINUX
31	bool fLinux = true;
32	#else
33	bool fLinux = false;
34	#endif
35	#ifdef RT_OS_WINDOWS
36	bool fWin = true;
37	#else
38	bool fWin = false;
39	#endif
40	#ifdef RT_OS_SOLARIS
41	bool fSolaris = true;
42	#else
43	bool fSolaris = false;
44	#endif
45	#ifdef RT_OS_DARWIN
46	bool fDarwin = true;
47	#else
48	bool fDarwin = false;
49	#endif
50	#ifdef VBOX_WITH_VRDP
51	bool fVRDP = true;
52	#else
53	bool fVRDP = false;
54	#endif
55	#ifdef VBOX_WITH_VBOXSDL
56	bool fVBoxSDL = true;
57	#else
58	bool fVBoxSDL = false;
59	#endif
60
61	if (u64Cmd == USAGE_DUMPOPTS)
62	{
63	fLinux = true;
64	fWin = true;
65	fSolaris = true;
66	fDarwin = true;
67	fVRDP = true;
68	fVBoxSDL = true;
69	u64Cmd = USAGE_ALL;
70	}
71
72	RTPrintf("Usage:\n"
73	"\n");
74
75	if (u64Cmd == USAGE_ALL)
76	{
77	RTPrintf("VBoxManage [-v\|--version] print version number and exit\n"
78	"VBoxManage [-q\|--nologo] ... suppress the logo\n"
79	"\n");
80	}
81
82	if (u64Cmd & USAGE_LIST)
83	{
84	RTPrintf("VBoxManage list [--long\|-l] vms\|runningvms\|ostypes\|hostdvds\|hostfloppies\|\n"
85	#if defined(VBOX_WITH_NETFLT)
86	" bridgedifs\|hostonlyifs\|dhcpservers\|hostinfo\|\n"
87	#else
88	" bridgedifs\|hostinfo\|dhcpservers\|\n"
89	#endif
90	" hddbackends\|hdds\|dvds\|floppies\|\n"
91	" usbhost\|usbfilters\|systemproperties\n"
92	"\n");
93	}
94
95	if (u64Cmd & USAGE_SHOWVMINFO)
96	{
97	RTPrintf("VBoxManage showvminfo <uuid>\|<name> [--details] [--statistics]\n"
98	" [--machinereadable]\n"
99	"\n");
100	}
101
102	if (u64Cmd & USAGE_REGISTERVM)
103	{
104	RTPrintf("VBoxManage registervm <filename>\n"
105	"\n");
106	}
107
108	if (u64Cmd & USAGE_UNREGISTERVM)
109	{
110	RTPrintf("VBoxManage unregistervm <uuid>\|<name> [--delete]\n"
111	"\n");
112	}
113
114	if (u64Cmd & USAGE_CREATEVM)
115	{
116	RTPrintf("VBoxManage createvm --name <name>\n"
117	" [--ostype <ostype>]\n"
118	" [--register]\n"
119	" [--basefolder <path> \| --settingsfile <path>]\n"
120	" [--uuid <uuid>]\n"
121	"\n");
122	}
123
124	if (u64Cmd & USAGE_MODIFYVM)
125	{
126	RTPrintf("VBoxManage modifyvm <uuid\|name>\n"
127	" [--name <name>]\n"
128	" [--ostype <ostype>]\n"
129	" [--memory <memorysize in MB>]\n"
130	" [--vram <vramsize in MB>]\n"
131	" [--firmware bios\|efi]\n"
132	" [--acpi on\|off]\n"
133	" [--ioapic on\|off]\n"
134	" [--pae on\|off]\n"
135	" [--hwvirtex on\|off]\n"
136	" [--nestedpaging on\|off]\n"
137	" [--vtxvpid on\|off]\n"
138	" [--cpus <number>]\n"
139	" [--monitorcount <number>]\n"
140	" [--accelerate3d <on\|off>]\n"
141	#ifdef VBOX_WITH_VIDEOHWACCEL
142	" [--accelerate2dvideo <on\|off>]\n"
143	#endif
144	" [--bioslogofadein on\|off]\n"
145	" [--bioslogofadeout on\|off]\n"
146	" [--bioslogodisplaytime <msec>]\n"
147	" [--bioslogoimagepath <imagepath>]\n"
148	" [--biosbootmenu disabled\|menuonly\|messageandmenu]\n"
149	" [--biossystemtimeoffset <msec>]\n"
150	" [--biospxedebug on\|off]\n"
151	" [--boot<1-4> none\|floppy\|dvd\|disk\|net>]\n"
152	" [--hd<a\|b\|d> none\|<uuid>\|<filename>]\n"
153	" [--idecontroller PIIX3\|PIIX4]\n"
154	#ifdef VBOX_WITH_AHCI
155	" [--sata on\|off]\n"
156	" [--sataportcount <1-30>]\n"
157	" [--sataport<1-30> none\|<uuid>\|<filename>]\n"
158	" [--sataideemulation<1-4> <1-30>]\n"
159	#endif
160	#ifdef VBOX_WITH_SCSI
161	" [--scsi on\|off]\n"
162	" [--scsiport<1-16> none\|<uuid>\|<filename>]\n"
163	" [--scsitype LsiLogic\|BusLogic]\n"
164	#endif
165	" [--dvd none\|<uuid>\|<filename>\|host:<drive>]\n"
166	" [--dvdpassthrough on\|off]\n"
167	" [--floppy disabled\|none\|<uuid>\|\n"
168	" <filename>\|host:<drive>]\n"
169	#if defined(VBOX_WITH_NETFLT)
170	" [--nic<1-N> none\|null\|nat\|bridged\|intnet\|hostonly]\n"
171	#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
172	" [--nic<1-N> none\|null\|nat\|bridged\|intnet]\n"
173	#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
174	" [--nictype<1-N> Am79C970A\|Am79C973"
175	#ifdef VBOX_WITH_E1000
176	"\|\n 82540EM\|82543GC\|82545EM"
177	#endif
178	#ifdef VBOX_WITH_VIRTIO
179	"\|\n virtio"
180	#endif /* VBOX_WITH_VIRTIO */
181	"]\n"
182	" [--cableconnected<1-N> on\|off]\n"
183	" [--nictrace<1-N> on\|off]\n"
184	" [--nictracefile<1-N> <filename>]\n"
185	" [--nicspeed<1-N> <kbps>]\n"
186	" [--bridgeadapter<1-N> none\|<devicename>]\n"
187	#if defined(VBOX_WITH_NETFLT)
188	" [--hostonlyadapter<1-N> none\|<devicename>]\n"
189	#endif
190	" [--intnet<1-N> <network name>]\n"
191	" [--natnet<1-N> <network>\|default]\n"
192	" [--macaddress<1-N> auto\|<mac>]\n"
193	" [--uart<1-N> off\|<I/O base> <IRQ>]\n"
194	" [--uartmode<1-N> disconnected\|\n"
195	" server <pipe>\|\n"
196	" client <pipe>\|\n"
197	" file <file>\|\n"
198	" <devicename>]\n"
199	#ifdef VBOX_WITH_MEM_BALLOONING
200	" [--guestmemoryballoon <balloonsize in MB>]\n"
201	#endif
202	" [--gueststatisticsinterval <seconds>]\n"
203	);
204	RTPrintf(" [--audio none\|null");
205	if (fWin)
206	{
207	#ifdef VBOX_WITH_WINMM
208	RTPrintf( "\|winmm\|dsound");
209	#else
210	RTPrintf( "\|dsound");
211	#endif
212	}
213	if (fSolaris)
214	{
215	RTPrintf( "\|solaudio"
216	#ifdef VBOX_WITH_SOLARIS_OSS
217	"\|oss"
218	#endif
219	);
220	}
221	if (fLinux)
222	{
223	RTPrintf( "\|oss"
224	#ifdef VBOX_WITH_ALSA
225	"\|alsa"
226	#endif
227	#ifdef VBOX_WITH_PULSE
228	"\|pulse"
229	#endif
230	);
231	}
232	if (fDarwin)
233	{
234	RTPrintf( "\|coreaudio");
235	}
236	RTPrintf( "]\n");
237	RTPrintf(" [--audiocontroller ac97\|sb16]\n"
238	" [--clipboard disabled\|hosttoguest\|guesttohost\|\n"
239	" bidirectional]\n");
240	if (fVRDP)
241	{
242	RTPrintf(" [--vrdp on\|off]\n"
243	" [--vrdpport default\|<port>]\n"
244	" [--vrdpaddress <host>]\n"
245	" [--vrdpauthtype null\|external\|guest]\n"
246	" [--vrdpmulticon on\|off]\n"
247	" [--vrdpreusecon on\|off]\n");
248	}
249	RTPrintf(" [--usb on\|off]\n"
250	" [--usbehci on\|off]\n"
251	" [--snapshotfolder default\|<path>]\n");
252	RTPrintf("\n");
253	}
254
255	if (u64Cmd & USAGE_IMPORTAPPLIANCE)
256	{
257	RTPrintf("VBoxManage import <ovf> [--dry-run\|-n] [more options]\n"
258	" (run with -n to have options displayed\n"
259	" for a particular OVF)\n\n");
260	}
261
262	if (u64Cmd & USAGE_EXPORTAPPLIANCE)
263	{
264	RTPrintf("VBoxManage export <machines> --output\|-o <ovf>\n"
265	" [--legacy09]\n"
266	" [--vsys <number of virtual system>]\n"
267	" [--product <product name>]\n"
268	" [--producturl <product url>]\n"
269	" [--vendor <vendor name>]\n"
270	" [--vendorurl <vendor url>]\n"
271	" [--version <version info>]\n"
272	" [--eula <license text>]\n"
273	" [--eulafile <filename>]\n"
274	"\n");
275	}
276
277	if (u64Cmd & USAGE_STARTVM)
278	{
279	RTPrintf("VBoxManage startvm <uuid>\|<name>\n");
280	RTPrintf(" [--type gui");
281	if (fVBoxSDL)
282	RTPrintf( "\|sdl");
283	if (fVRDP)
284	RTPrintf( "\|vrdp");
285	RTPrintf( "\|headless]\n");
286	RTPrintf("\n");
287	}
288
289	if (u64Cmd & USAGE_CONTROLVM)
290	{
291	RTPrintf("VBoxManage controlvm <uuid>\|<name>\n"
292	" pause\|resume\|reset\|poweroff\|savestate\|\n"
293	" acpipowerbutton\|acpisleepbutton\|\n"
294	" keyboardputscancode <hex> [<hex> ...]\|\n"
295	" injectnmi\|\n"
296	" setlinkstate<1-N> on\|off \|\n"
297	#ifdef VBOX_DYNAMIC_NET_ATTACH
298	#if defined(VBOX_WITH_NETFLT)
299	" nic<1-N> null\|nat\|bridged\|intnet\|hostonly\n"
300	" [<devicename>] \|\n"
301	#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
302	" nic<1-N> null\|nat\|bridged\|intnet\n"
303	" [<devicename>] \|\n"
304	#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
305	" nictrace<1-N> on\|off\n"
306	" nictracefile<1-N> <filename>\n"
307	#endif /* VBOX_DYNAMIC_NET_ATTACH */
308	" usbattach <uuid>\|<address> \|\n"
309	" usbdetach <uuid>\|<address> \|\n"
310	" dvdattach none\|<uuid>\|<filename>\|host:<drive> \|\n"
311	" floppyattach none\|<uuid>\|<filename>\|host:<drive> \|\n");
312	if (fVRDP)
313	{
314	RTPrintf(" vrdp on\|off] \|\n");
315	RTPrintf(" vrdpport default\|<port>] \|\n");
316	}
317	RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]\|\n"
318	" setcredentials <username> <password> <domain>\n"
319	" [--allowlocallogon <yes\|no>]\n"
320	"\n");
321	}
322
323	if (u64Cmd & USAGE_DISCARDSTATE)
324	{
325	RTPrintf("VBoxManage discardstate <uuid>\|<name>\n"
326	"\n");
327	}
328
329	if (u64Cmd & USAGE_ADOPTSTATE)
330	{
331	RTPrintf("VBoxManage adoptstate <uuid>\|<name> <state_file>\n"
332	"\n");
333	}
334
335	if (u64Cmd & USAGE_SNAPSHOT)
336	{
337	RTPrintf("VBoxManage snapshot <uuid>\|<name>\n"
338	" take <name> [--description <desc>] [--pause] \|\n"
339	" discard <uuid>\|<name> \|\n"
340	" discardcurrent --state\|--all \|\n"
341	" edit <uuid>\|<name>\|--current\n"
342	" [--name <name>]\n"
343	" [--description <desc>] \|\n"
344	" showvminfo <uuid>\|<name>\n"
345	"\n");
346	}
347
348	if (u64Cmd & USAGE_OPENMEDIUM)
349	{
350	RTPrintf("VBoxManage openmedium disk\|dvd\|floppy <filename>\n"
351	" [--type normal\|immutable\|writethrough] (disk only)\n"
352	"\n");
353	}
354
355	if (u64Cmd & USAGE_CLOSEMEDIUM)
356	{
357	RTPrintf("VBoxManage closemedium disk\|dvd\|floppy <uuid>\|<filename>\n"
358	"\n");
359	}
360
361	if (u64Cmd & USAGE_SHOWHDINFO)
362	{
363	RTPrintf("VBoxManage showhdinfo <uuid>\|<filename>\n"
364	"\n");
365	}
366
367	if (u64Cmd & USAGE_CREATEHD)
368	{
369	RTPrintf("VBoxManage createhd --filename <filename>\n"
370	" --size <megabytes>\n"
371	" [--format VDI\|VMDK\|VHD] (default: VDI)\n"
372	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
373	" [--type normal\|writethrough] (default: normal)\n"
374	" [--comment <comment>]\n"
375	" [--remember]\n"
376	"\n");
377	}
378
379	if (u64Cmd & USAGE_MODIFYHD)
380	{
381	RTPrintf("VBoxManage modifyhd <uuid>\|<filename>\n"
382	" [--type normal\|writethrough\|immutable]\n"
383	" [--autoreset on\|off]\n"
384	" [--compact]\n"
385	"\n");
386	}
387
388	if (u64Cmd & USAGE_CLONEHD)
389	{
390	RTPrintf("VBoxManage clonehd <uuid>\|<filename> <outputfile>\n"
391	" [--format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
392	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
393	" [--type normal\|writethrough\|immutable]\n"
394	" [--remember] [--existing]\n"
395	"\n");
396	}
397
398	if (u64Cmd & USAGE_CONVERTFROMRAW)
399	{
400	RTPrintf("VBoxManage convertfromraw <filename> <outputfile>\n"
401	" [--format VDI\|VMDK\|VHD]\n"
402	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
403	"VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
404	" [--format VDI\|VMDK\|VHD]\n"
405	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
406	"\n");
407	}
408
409	if (u64Cmd & USAGE_ADDISCSIDISK)
410	{
411	RTPrintf("VBoxManage addiscsidisk --server <name>\|<ip>\n"
412	" --target <target>\n"
413	" [--port <port>]\n"
414	" [--lun <lun>]\n"
415	" [--encodedlun <lun>]\n"
416	" [--username <username>]\n"
417	" [--password <password>]\n"
418	" [--type normal\|writethrough\|immutable]\n"
419	" [--comment <comment>]\n"
420	" [--intnet]\n"
421	"\n");
422	}
423
424	if (u64Cmd & USAGE_GETEXTRADATA)
425	{
426	RTPrintf("VBoxManage getextradata global\|<uuid>\|<name>\n"
427	" <key>\|enumerate\n"
428	"\n");
429	}
430
431	if (u64Cmd & USAGE_SETEXTRADATA)
432	{
433	RTPrintf("VBoxManage setextradata global\|<uuid>\|<name>\n"
434	" <key>\n"
435	" [<value>] (no value deletes key)\n"
436	"\n");
437	}
438
439	if (u64Cmd & USAGE_SETPROPERTY)
440	{
441	RTPrintf("VBoxManage setproperty hdfolder default\|<folder> \|\n"
442	" machinefolder default\|<folder> \|\n"
443	" vrdpauthlibrary default\|<library> \|\n"
444	" websrvauthlibrary default\|null\|<library> \|\n"
445	" loghistorycount <value>\n"
446	"\n");
447	}
448
449	if (u64Cmd & USAGE_USBFILTER_ADD)
450	{
451	RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
452	" --target <uuid>\|<name>\|global\n"
453	" --name <string>\n"
454	" --action ignore\|hold (global filters only)\n"
455	" [--active yes\|no] (yes)\n"
456	" [--vendorid <XXXX>] (null)\n"
457	" [--productid <XXXX>] (null)\n"
458	" [--revision <IIFF>] (null)\n"
459	" [--manufacturer <string>] (null)\n"
460	" [--product <string>] (null)\n"
461	" [--remote yes\|no] (null, VM filters only)\n"
462	" [--serialnumber <string>] (null)\n"
463	" [--maskedinterfaces <XXXXXXXX>]\n"
464	"\n");
465	}
466
467	if (u64Cmd & USAGE_USBFILTER_MODIFY)
468	{
469	RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
470	" --target <uuid>\|<name>\|global\n"
471	" [--name <string>]\n"
472	" [--action ignore\|hold] (global filters only)\n"
473	" [--active yes\|no]\n"
474	" [--vendorid <XXXX>\|\"\"]\n"
475	" [--productid <XXXX>\|\"\"]\n"
476	" [--revision <IIFF>\|\"\"]\n"
477	" [--manufacturer <string>\|\"\"]\n"
478	" [--product <string>\|\"\"]\n"
479	" [--remote yes\|no] (null, VM filters only)\n"
480	" [--serialnumber <string>\|\"\"]\n"
481	" [--maskedinterfaces <XXXXXXXX>]\n"
482	"\n");
483	}
484
485	if (u64Cmd & USAGE_USBFILTER_REMOVE)
486	{
487	RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
488	" --target <uuid>\|<name>\|global\n"
489	"\n");
490	}
491
492	if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
493	{
494	RTPrintf("VBoxManage sharedfolder add <vmname>\|<uuid>\n"
495	" --name <name> --hostpath <hostpath>\n"
496	" [--transient] [--readonly]\n"
497	"\n");
498	}
499
500	if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
501	{
502	RTPrintf("VBoxManage sharedfolder remove <vmname>\|<uuid>\n"
503	" --name <name> [--transient]\n"
504	"\n");
505	}
506
507	if (u64Cmd & USAGE_VM_STATISTICS)
508	{
509	RTPrintf("VBoxManage vmstatistics <vmname>\|<uuid> [--reset]\n"
510	" [--pattern <pattern>] [--descriptions]\n"
511	"\n");
512	}
513
514	#ifdef VBOX_WITH_GUEST_PROPS
515	if (u64Cmd & USAGE_GUESTPROPERTY)
516	usageGuestProperty();
517	#endif /* VBOX_WITH_GUEST_PROPS defined */
518
519	if (u64Cmd & USAGE_METRICS)
520	{
521	RTPrintf("VBoxManage metrics list [*\|host\|<vmname> [<metric_list>]]\n"
522	" (comma-separated)\n\n"
523	"VBoxManage metrics setup\n"
524	" [--period <seconds>]\n"
525	" [--samples <count>]\n"
526	" [--list]\n"
527	" [*\|host\|<vmname> [<metric_list>]]\n\n"
528	"VBoxManage metrics query [*\|host\|<vmname> [<metric_list>]]\n\n"
529	"VBoxManage metrics collect\n"
530	" [--period <seconds>]\n"
531	" [--samples <count>]\n"
532	" [--list]\n"
533	" [--detach]\n"
534	" [*\|host\|<vmname> [<metric_list>]]\n"
535	"\n");
536	}
537	#if defined(VBOX_WITH_NETFLT)
538	if (u64Cmd & USAGE_HOSTONLYIFS)
539	{
540	RTPrintf("VBoxManage hostonlyif ipconfig <name>\n"
541	" [--dhcp \|\n"
542	" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] \|\n"
543	" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
544	# if defined(RT_OS_WINDOWS)
545	" create \|\n"
546	" remove <name>\n"
547	# endif
548	"\n");
549	}
550	#endif
551
552	if (u64Cmd & USAGE_DHCPSERVER)
553	{
554	RTPrintf("VBoxManage dhcpserver add\|modify --netname <network_name> \|\n"
555	#if defined(VBOX_WITH_NETFLT)
556	" --ifname <hostonly_if_name>\n"
557	#endif
558	" [--ip <ip_address>\n"
559	" --netmask <network_mask>\n"
560	" --lowerip <lower_ip>\n"
561	" --upperip <upper_ip>]\n"
562	" [--enable \| --disable]\n"
563	"VBoxManage dhcpserver remove --netname <network_name> \|\n"
564	#if defined(VBOX_WITH_NETFLT)
565	" --ifname <hostonly_if_name>\n"
566	#endif
567	"\n");
568	}
569	}
570
571	/**
572	* Print a usage synopsis and the syntax error message.
573	*/
574	int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
575	{
576	va_list args;
577	showLogo(); // show logo even if suppressed
578	#ifndef VBOX_ONLY_DOCS
579	if (g_fInternalMode)
580	printUsageInternal(u64Cmd);
581	else
582	printUsage(u64Cmd);
583	#endif /* !VBOX_ONLY_DOCS */
584	va_start(args, pszFormat);
585	RTPrintf("\n"
586	"Syntax error: %N\n", pszFormat, &args);
587	va_end(args);
588	return 1;
589	}
590
591	/**
592	* errorSyntax for RTGetOpt users.
593	*
594	* @returns 1.
595	*
596	* @param fUsageCategory The usage category of the command.
597	* @param rc The RTGetOpt return code.
598	* @param pValueUnion The value union.
599	*/
600	int errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
601	{
602	showLogo(); // show logo even if suppressed
603	#ifndef VBOX_ONLY_DOCS
604	if (g_fInternalMode)
605	printUsageInternal(fUsageCategory);
606	else
607	printUsage(fUsageCategory);
608	#endif /* !VBOX_ONLY_DOCS */
609
610	if (rc == VINF_GETOPT_NOT_OPTION)
611	return RTPrintf("error: Invalid parameter '%s'", pValueUnion->psz);
612	if (rc > 0)
613	{
614	if (RT_C_IS_PRINT(rc))
615	return RTPrintf("error: Invalid option -%c", rc);
616	return RTPrintf("error: Invalid option case %i", rc);
617	}
618	if (rc == VERR_GETOPT_UNKNOWN_OPTION)
619	return RTPrintf("error: unknown option: %s\n", pValueUnion->psz);
620	if (pValueUnion->pDef)
621	return RTPrintf("error: %s: %Rrs", pValueUnion->pDef->pszLong, rc);
622	return RTPrintf("error: %Rrs", rc);
623	}
624
625	/**
626	* Print an error message without the syntax stuff.
627	*/
628	int errorArgument(const char *pszFormat, ...)
629	{
630	va_list args;
631	va_start(args, pszFormat);
632	RTPrintf("error: %N\n", pszFormat, &args);
633	va_end(args);
634	return 1;
635	}
636

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

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

Download in other formats: