VBoxManageHelp.cpp@ 33253

Last change on this file since 33253 was 33202, checked in by vboxsync, 14 years ago
VBoxManage: error reporting
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 35.5 KB

Line
1	/* $Id: VBoxManageHelp.cpp 33202 2010-10-18 14:43:09Z vboxsync $ */
2	/** @file
3	* VBoxManage - help and other message output.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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/ctype.h>
25	#include <iprt/err.h>
26	#include <iprt/getopt.h>
27	#include <iprt/stream.h>
28
29	#include "VBoxManage.h"
30
31
32
33	void showLogo(PRTSTREAM pStrm)
34	{
35	static bool s_fShown; /* show only once */
36
37	if (!s_fShown)
38	{
39	RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
40	VBOX_VERSION_STRING "\n"
41	"(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
42	"All rights reserved.\n"
43	"\n");
44	s_fShown = true;
45	}
46	}
47
48	void printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
49	{
50	bool fDumpOpts = false;
51	#ifdef RT_OS_LINUX
52	bool fLinux = true;
53	#else
54	bool fLinux = false;
55	#endif
56	#ifdef RT_OS_WINDOWS
57	bool fWin = true;
58	#else
59	bool fWin = false;
60	#endif
61	#ifdef RT_OS_SOLARIS
62	bool fSolaris = true;
63	#else
64	bool fSolaris = false;
65	#endif
66	#ifdef RT_OS_FREEBSD
67	bool fFreeBSD = true;
68	#else
69	bool fFreeBSD = false;
70	#endif
71	#ifdef RT_OS_DARWIN
72	bool fDarwin = true;
73	#else
74	bool fDarwin = false;
75	#endif
76	#ifdef VBOX_WITH_VRDP
77	bool fVRDP = true;
78	#else
79	bool fVRDP = false;
80	#endif
81	#ifdef VBOX_WITH_VBOXSDL
82	bool fVBoxSDL = true;
83	#else
84	bool fVBoxSDL = false;
85	#endif
86
87	if (u64Cmd == USAGE_DUMPOPTS)
88	{
89	fDumpOpts = true;
90	fLinux = true;
91	fWin = true;
92	fSolaris = true;
93	fFreeBSD = true;
94	fDarwin = true;
95	fVRDP = true;
96	fVBoxSDL = true;
97	u64Cmd = USAGE_ALL;
98	}
99
100	RTStrmPrintf(pStrm,
101	"Usage:\n"
102	"\n");
103
104	if (u64Cmd == USAGE_ALL)
105	{
106	RTStrmPrintf(pStrm,
107	"VBoxManage [-v\|--version] print version number and exit\n"
108	"VBoxManage [-q\|--nologo] ... suppress the logo\n"
109	"\n");
110	}
111
112	if (u64Cmd & USAGE_LIST)
113	{
114	RTStrmPrintf(pStrm,
115	"VBoxManage list [--long\|-l] vms\|runningvms\|ostypes\|hostdvds\|hostfloppies\|\n"
116	#if defined(VBOX_WITH_NETFLT)
117	" bridgedifs\|hostonlyifs\|dhcpservers\|hostinfo\|\n"
118	#else
119	" bridgedifs\|dhcpservers\|hostinfo\|\n"
120	#endif
121	" hostcpuids\|hddbackends\|hdds\|dvds\|floppies\|\n"
122	" usbhost\|usbfilters\|systemproperties\n"
123	"\n");
124	}
125
126	if (u64Cmd & USAGE_SHOWVMINFO)
127	{
128	RTStrmPrintf(pStrm,
129	"VBoxManage showvminfo <uuid>\|<name> [--details] [--statistics]\n"
130	" [--machinereadable]\n"
131	"VBoxManage showvminfo <uuid>\|<name> --log <idx>\n"
132	"\n");
133	}
134
135	if (u64Cmd & USAGE_REGISTERVM)
136	{
137	RTStrmPrintf(pStrm,
138	"VBoxManage registervm <filename>\n"
139	"\n");
140	}
141
142	if (u64Cmd & USAGE_UNREGISTERVM)
143	{
144	RTStrmPrintf(pStrm,
145	"VBoxManage unregistervm <uuid>\|<name> [--delete]\n"
146	"\n");
147	}
148
149	if (u64Cmd & USAGE_CREATEVM)
150	{
151	RTStrmPrintf(pStrm,
152	"VBoxManage createvm --name <name>\n"
153	" [--ostype <ostype>]\n"
154	" [--register]\n"
155	" [--basefolder <path> \| --settingsfile <path>]\n"
156	" [--uuid <uuid>]\n"
157	"\n");
158	}
159
160	if (u64Cmd & USAGE_MODIFYVM)
161	{
162	RTStrmPrintf(pStrm,
163	"VBoxManage modifyvm <uuid\|name>\n"
164	" [--name <name>]\n"
165	" [--ostype <ostype>]\n"
166	" [--memory <memorysize in MB>]\n"
167	" [--pagefusion on\|off]\n"
168	" [--vram <vramsize in MB>]\n"
169	" [--acpi on\|off]\n"
170	" [--ioapic on\|off]\n"
171	" [--pae on\|off]\n"
172	" [--hpet on\|off]\n"
173	" [--hwvirtex on\|off]\n"
174	" [--hwvirtexexcl on\|off]\n"
175	" [--nestedpaging on\|off]\n"
176	" [--largepages on\|off]\n"
177	" [--vtxvpid on\|off]\n"
178	" [--synthcpu on\|off]\n"
179	" [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
180	" [--cpuidremove <leaf>]\n"
181	" [--cpuidremoveall]\n"
182	" [--hardwareuuid <uuid>]\n"
183	" [--cpus <number>]\n"
184	" [--cpuhotplug on\|off]\n"
185	" [--plugcpu <id>]\n"
186	" [--unplugcpu <id>]\n"
187	" [--cpuexecutioncap <1-100>]\n"
188	" [--rtcuseutc on\|off]\n"
189	" [--monitorcount <number>]\n"
190	" [--accelerate3d on\|off]\n"
191	#ifdef VBOX_WITH_VIDEOHWACCEL
192	" [--accelerate2dvideo on\|off]\n"
193	#endif
194	" [--firmware bios\|efi\|efi32\|efi64]\n"
195	" [--chipset ich9\|piix3]\n"
196	" [--bioslogofadein on\|off]\n"
197	" [--bioslogofadeout on\|off]\n"
198	" [--bioslogodisplaytime <msec>]\n"
199	" [--bioslogoimagepath <imagepath>]\n"
200	" [--biosbootmenu disabled\|menuonly\|messageandmenu]\n"
201	" [--biossystemtimeoffset <msec>]\n"
202	" [--biospxedebug on\|off]\n"
203	" [--boot<1-4> none\|floppy\|dvd\|disk\|net>]\n"
204	" [--nic<1-N> none\|null\|nat\|bridged\|intnet"
205	#if defined(VBOX_WITH_NETFLT)
206	"\|hostonly"
207	#endif
208	#ifdef VBOX_WITH_VDE
209	"\|\n"
210	" vde"
211	#endif
212	"]\n"
213	" [--nictype<1-N> Am79C970A\|Am79C973"
214	#ifdef VBOX_WITH_E1000
215	"\|\n 82540EM\|82543GC\|82545EM"
216	#endif
217	#ifdef VBOX_WITH_VIRTIO
218	"\|\n virtio"
219	#endif /* VBOX_WITH_VIRTIO */
220	"]\n"
221	" [--cableconnected<1-N> on\|off]\n"
222	" [--nictrace<1-N> on\|off]\n"
223	" [--nictracefile<1-N> <filename>]\n"
224	" [--nicspeed<1-N> <kbps>]\n"
225	" [--nicbootprio<1-N> <priority>]\n"
226	" [--bridgeadapter<1-N> none\|<devicename>]\n"
227	#if defined(VBOX_WITH_NETFLT)
228	" [--hostonlyadapter<1-N> none\|<devicename>]\n"
229	#endif
230	" [--intnet<1-N> <network name>]\n"
231	" [--natnet<1-N> <network>\|default]\n"
232	#ifdef VBOX_WITH_VDE
233	" [--vdenet<1-N> <network>\|default]\n"
234	#endif
235	" [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
236	" [<sockrcv>],[<tcpsnd>],\n"
237	" [<tcprcv>]]\n"
238	" [--natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
239	" <hostport>,[<guestip>],<guestport>]\n"
240	" [--natpf<1-N> delete <rulename>]\n"
241	" [--nattftpprefix<1-N> <prefix>]\n"
242	" [--nattftpfile<1-N> <file>]\n"
243	" [--nattftpserver<1-N> <ip>]\n"
244	" [--natdnspassdomain<1-N> on\|off]\n"
245	" [--natdnsproxy<1-N> on\|off]\n"
246	" [--natdnshostresolver<1-N> on\|off]\n"
247	" [--nataliasmode<1-N> default\|[log],[proxyonly],\n"
248	" [sameports]]\n"
249	" [--macaddress<1-N> auto\|<mac>]\n"
250	" [--mouse ps2\|usb\|usbtablet\n"
251	" [--keyboard ps2\|usb\n"
252	" [--uart<1-N> off\|<I/O base> <IRQ>]\n"
253	" [--uartmode<1-N> disconnected\|\n"
254	" server <pipe>\|\n"
255	" client <pipe>\|\n"
256	" file <file>\|\n"
257	" <devicename>]\n"
258	" [--guestmemoryballoon <balloonsize in MB>]\n"
259	" [--gueststatisticsinterval <seconds>]\n"
260	" [--audio none\|null");
261	if (fWin)
262	{
263	#ifdef VBOX_WITH_WINMM
264	RTStrmPrintf(pStrm, "\|winmm\|dsound");
265	#else
266	RTStrmPrintf(pStrm, "\|dsound");
267	#endif
268	}
269	if (fSolaris)
270	{
271	RTStrmPrintf(pStrm, "\|solaudio"
272	#ifdef VBOX_WITH_SOLARIS_OSS
273	"\|oss"
274	#endif
275	);
276	}
277	if (fLinux)
278	{
279	RTStrmPrintf(pStrm, "\|oss"
280	#ifdef VBOX_WITH_ALSA
281	"\|alsa"
282	#endif
283	#ifdef VBOX_WITH_PULSE
284	"\|pulse"
285	#endif
286	);
287	}
288	if (fFreeBSD)
289	{
290	/* Get the line break sorted when dumping all option variants. */
291	if (fDumpOpts)
292	{
293	RTStrmPrintf(pStrm, "\|\n"
294	" oss");
295	}
296	else
297	RTStrmPrintf(pStrm, "\|oss");
298	#ifdef VBOX_WITH_PULSE
299	RTStrmPrintf(pStrm, "\|pulse");
300	#endif
301	}
302	if (fDarwin)
303	{
304	RTStrmPrintf(pStrm, "\|coreaudio");
305	}
306	RTStrmPrintf(pStrm, "]\n");
307	RTStrmPrintf(pStrm,
308	" [--audiocontroller ac97\|hda\|sb16]\n"
309	" [--clipboard disabled\|hosttoguest\|guesttohost\|\n"
310	" bidirectional]\n");
311	if (fVRDP)
312	{
313	RTStrmPrintf(pStrm,
314	" [--vrdp on\|off]\n"
315	" [--vrdpport default\|<ports>]\n"
316	" [--vrdpaddress <host>]\n"
317	" [--vrdpauthtype null\|external\|guest]\n"
318	" [--vrdpmulticon on\|off]\n"
319	" [--vrdpreusecon on\|off]\n"
320	" [--vrdpvideochannel on\|off]\n"
321	" [--vrdpvideochannelquality <percent>]\n");
322	}
323	RTStrmPrintf(pStrm,
324	" [--usb on\|off]\n"
325	" [--usbehci on\|off]\n"
326	" [--snapshotfolder default\|<path>]\n"
327	" [--teleporter on\|off]\n"
328	" [--teleporterport <port>]\n"
329	" [--teleporteraddress <address\|empty>\n"
330	" [--teleporterpassword <password>]\n"
331	#if 0
332	" [--iocache on\|off]\n"
333	" [--iocachesize <I/O cache size in MB>]\n"
334	#endif
335	#if 0
336	" [--faulttolerance master\|standby]\n"
337	" [--faulttoleranceaddress <name>]\n"
338	" [--faulttoleranceport <port>]\n"
339	" [--faulttolerancesyncinterval <msec>]\n"
340	" [--faulttolerancepassword <password>]\n"
341	#endif
342	"\n");
343	}
344
345	if (u64Cmd & USAGE_IMPORTAPPLIANCE)
346	{
347	RTStrmPrintf(pStrm,
348	"VBoxManage import <ovf> [--dry-run\|-n] [more options]\n"
349	" (run with -n to have options displayed\n"
350	" for a particular OVF)\n\n");
351	}
352
353	if (u64Cmd & USAGE_EXPORTAPPLIANCE)
354	{
355	RTStrmPrintf(pStrm,
356	"VBoxManage export <machines> --output\|-o <ovf>\n"
357	" [--legacy09]\n"
358	" [--manifest]\n"
359	" [--vsys <number of virtual system>]\n"
360	" [--product <product name>]\n"
361	" [--producturl <product url>]\n"
362	" [--vendor <vendor name>]\n"
363	" [--vendorurl <vendor url>]\n"
364	" [--version <version info>]\n"
365	" [--eula <license text>]\n"
366	" [--eulafile <filename>]\n"
367	"\n");
368	}
369
370	if (u64Cmd & USAGE_STARTVM)
371	{
372	RTStrmPrintf(pStrm,
373	"VBoxManage startvm <uuid>\|<name>\n");
374	RTStrmPrintf(pStrm,
375	" [--type gui");
376	if (fVBoxSDL)
377	RTStrmPrintf(pStrm, "\|sdl");
378	if (fVRDP)
379	RTStrmPrintf(pStrm, "\|vrdp");
380	RTStrmPrintf(pStrm, "\|headless]\n");
381	RTStrmPrintf(pStrm,
382	"\n");
383	}
384
385	if (u64Cmd & USAGE_CONTROLVM)
386	{
387	RTStrmPrintf(pStrm,
388	"VBoxManage controlvm <uuid>\|<name>\n"
389	" pause\|resume\|reset\|poweroff\|savestate\|\n"
390	" acpipowerbutton\|acpisleepbutton\|\n"
391	" keyboardputscancode <hex> [<hex> ...]\|\n"
392	" injectnmi\|\n"
393	" setlinkstate<1-N> on\|off \|\n"
394	#ifdef VBOX_DYNAMIC_NET_ATTACH
395	#if defined(VBOX_WITH_NETFLT)
396	" nic<1-N> null\|nat\|bridged\|intnet\|hostonly\n"
397	" [<devicename>] \|\n"
398	#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
399	" nic<1-N> null\|nat\|bridged\|intnet\n"
400	" [<devicename>] \|\n"
401	#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
402	" nictrace<1-N> on\|off\n"
403	" nictracefile<1-N> <filename>\n"
404	#endif /* VBOX_DYNAMIC_NET_ATTACH */
405	" guestmemoryballoon <balloonsize in MB>]\n"
406	" gueststatisticsinterval <seconds>]\n"
407	" usbattach <uuid>\|<address> \|\n"
408	" usbdetach <uuid>\|<address> \|\n");
409	if (fVRDP)
410	{
411	RTStrmPrintf(pStrm,
412	" vrdp on\|off \|\n");
413	RTStrmPrintf(pStrm,
414	" vrdpport default\|<ports> \|\n"
415	" vrdpvideochannelquality <percent>\n");
416	}
417	RTStrmPrintf(pStrm,
418	" setvideomodehint <xres> <yres> <bpp> [display] \|\n"
419	" setcredentials <username> <password> <domain>\n"
420	" [--allowlocallogon <yes\|no>] \|\n"
421	" teleport --host <name> --port <port>\n"
422	" [--maxdowntime <msec>] [--password password]\n"
423	" plugcpu <id>\n"
424	" unplugcpu <id>\n"
425	" cpuexecutioncap <1-100>\n"
426	"\n");
427	}
428
429	if (u64Cmd & USAGE_DISCARDSTATE)
430	{
431	RTStrmPrintf(pStrm,
432	"VBoxManage discardstate <uuid>\|<name>\n"
433	"\n");
434	}
435
436	if (u64Cmd & USAGE_ADOPTSTATE)
437	{
438	RTStrmPrintf(pStrm,
439	"VBoxManage adoptstate <uuid>\|<name> <state_file>\n"
440	"\n");
441	}
442
443	if (u64Cmd & USAGE_SNAPSHOT)
444	{
445	RTStrmPrintf(pStrm,
446	"VBoxManage snapshot <uuid>\|<name>\n"
447	" take <name> [--description <desc>] [--pause] \|\n"
448	" delete <uuid>\|<name> \|\n"
449	" restore <uuid>\|<name> \|\n"
450	" restorecurrent \|\n"
451	" edit <uuid>\|<name>\|--current\n"
452	" [--name <name>]\n"
453	" [--description <desc>] \|\n"
454	" showvminfo <uuid>\|<name>\n"
455	"\n");
456	}
457
458	if (u64Cmd & USAGE_OPENMEDIUM)
459	{
460	RTStrmPrintf(pStrm,
461	"VBoxManage openmedium disk\|dvd\|floppy <filename>\n"
462	" [--type normal\|immutable\|writethrough\|\n"
463	" shareable] (disk only)\n"
464	" [--uuid <uuid>]\n"
465	" [--parentuuid <uuid>] (disk only)\n"
466	"\n");
467	}
468
469	if (u64Cmd & USAGE_CLOSEMEDIUM)
470	{
471	RTStrmPrintf(pStrm,
472	"VBoxManage closemedium disk\|dvd\|floppy <uuid>\|<filename>\n"
473	" [--delete]\n"
474	"\n");
475	}
476
477	if (u64Cmd & USAGE_STORAGEATTACH)
478	{
479	RTStrmPrintf(pStrm,
480	"VBoxManage storageattach <uuid\|vmname>\n"
481	" --storagectl <name>\n"
482	" --port <number>\n"
483	" --device <number>\n"
484	" [--type dvddrive\|hdd\|fdd]\n"
485	" [--medium none\|emptydrive\|\n"
486	" <uuid>\|<filename>\|host:<drive>]\n"
487	" [--passthrough on\|off]\n"
488	" [--forceunmount]\n"
489	"\n");
490	}
491
492	if (u64Cmd & USAGE_STORAGECONTROLLER)
493	{
494	RTStrmPrintf(pStrm,
495	"VBoxManage storagectl <uuid\|vmname>\n"
496	" --name <name>\n"
497	" [--add ide\|sata\|scsi\|floppy\|sas]\n"
498	" [--controller LSILogic\|LSILogicSAS\|BusLogic\|\n"
499	" IntelAHCI\|PIIX3\|PIIX4\|ICH6\|I82078]\n"
500	" [--sataideemulation<1-4> <1-30>]\n"
501	" [--sataportcount <1-30>]\n"
502	" [--hostiocache on\|off]\n"
503	" [--remove]\n"
504	"\n");
505	}
506
507	if (u64Cmd & USAGE_SHOWHDINFO)
508	{
509	RTStrmPrintf(pStrm,
510	"VBoxManage showhdinfo <uuid>\|<filename>\n"
511	"\n");
512	}
513
514	if (u64Cmd & USAGE_CREATEHD)
515	{
516	RTStrmPrintf(pStrm,
517	"VBoxManage createhd --filename <filename>\n"
518	" --size <megabytes>\|--sizebyte <bytes>\n"
519	" [--format VDI\|VMDK\|VHD] (default: VDI)\n"
520	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
521	" [--type normal\|writethrough\|\n"
522	" shareable] (default: normal)\n"
523	" [--comment <comment>]\n"
524	" [--remember]\n"
525	"\n");
526	}
527
528	if (u64Cmd & USAGE_MODIFYHD)
529	{
530	RTStrmPrintf(pStrm,
531	"VBoxManage modifyhd <uuid>\|<filename>\n"
532	" [--type normal\|writethrough\|immutable\|shareable]\n"
533	" [--autoreset on\|off]\n"
534	" [--compact]\n"
535	" [--resize <megabytes>]\n"
536	"\n");
537	}
538
539	if (u64Cmd & USAGE_CLONEHD)
540	{
541	RTStrmPrintf(pStrm,
542	"VBoxManage clonehd <uuid>\|<filename> <outputfile>\n"
543	" [--format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
544	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
545	" [--type normal\|writethrough\|immutable\|shareable]\n"
546	" [--remember] [--existing]\n"
547	"\n");
548	}
549
550	if (u64Cmd & USAGE_CONVERTFROMRAW)
551	{
552	RTStrmPrintf(pStrm,
553	"VBoxManage convertfromraw <filename> <outputfile>\n"
554	" [--format VDI\|VMDK\|VHD]\n"
555	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
556	#ifndef RT_OS_WINDOWS
557	"VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
558	" [--format VDI\|VMDK\|VHD]\n"
559	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
560	#endif
561	"\n");
562	}
563
564	if (u64Cmd & USAGE_ADDISCSIDISK)
565	{
566	RTStrmPrintf(pStrm,
567	"VBoxManage addiscsidisk --server <name>\|<ip>\n"
568	" --target <target>\n"
569	" [--port <port>]\n"
570	" [--lun <lun>]\n"
571	" [--encodedlun <lun>]\n"
572	" [--username <username>]\n"
573	" [--password <password>]\n"
574	" [--type normal\|writethrough\|immutable\|shareable]\n"
575	" [--intnet]\n"
576	"\n");
577	}
578
579	if (u64Cmd & USAGE_GETEXTRADATA)
580	{
581	RTStrmPrintf(pStrm,
582	"VBoxManage getextradata global\|<uuid>\|<name>\n"
583	" <key>\|enumerate\n"
584	"\n");
585	}
586
587	if (u64Cmd & USAGE_SETEXTRADATA)
588	{
589	RTStrmPrintf(pStrm,
590	"VBoxManage setextradata global\|<uuid>\|<name>\n"
591	" <key>\n"
592	" [<value>] (no value deletes key)\n"
593	"\n");
594	}
595
596	if (u64Cmd & USAGE_SETPROPERTY)
597	{
598	RTStrmPrintf(pStrm,
599	"VBoxManage setproperty hdfolder default\|<folder> \|\n"
600	" machinefolder default\|<folder> \|\n"
601	" vrdpauthlibrary default\|<library> \|\n"
602	" websrvauthlibrary default\|null\|<library> \|\n"
603	" loghistorycount <value>\n"
604	"\n");
605	}
606
607	if (u64Cmd & USAGE_USBFILTER_ADD)
608	{
609	RTStrmPrintf(pStrm,
610	"VBoxManage usbfilter add <index,0-N>\n"
611	" --target <uuid>\|<name>\|global\n"
612	" --name <string>\n"
613	" --action ignore\|hold (global filters only)\n"
614	" [--active yes\|no] (yes)\n"
615	" [--vendorid <XXXX>] (null)\n"
616	" [--productid <XXXX>] (null)\n"
617	" [--revision <IIFF>] (null)\n"
618	" [--manufacturer <string>] (null)\n"
619	" [--product <string>] (null)\n"
620	" [--remote yes\|no] (null, VM filters only)\n"
621	" [--serialnumber <string>] (null)\n"
622	" [--maskedinterfaces <XXXXXXXX>]\n"
623	"\n");
624	}
625
626	if (u64Cmd & USAGE_USBFILTER_MODIFY)
627	{
628	RTStrmPrintf(pStrm,
629	"VBoxManage usbfilter modify <index,0-N>\n"
630	" --target <uuid>\|<name>\|global\n"
631	" [--name <string>]\n"
632	" [--action ignore\|hold] (global filters only)\n"
633	" [--active yes\|no]\n"
634	" [--vendorid <XXXX>\|\"\"]\n"
635	" [--productid <XXXX>\|\"\"]\n"
636	" [--revision <IIFF>\|\"\"]\n"
637	" [--manufacturer <string>\|\"\"]\n"
638	" [--product <string>\|\"\"]\n"
639	" [--remote yes\|no] (null, VM filters only)\n"
640	" [--serialnumber <string>\|\"\"]\n"
641	" [--maskedinterfaces <XXXXXXXX>]\n"
642	"\n");
643	}
644
645	if (u64Cmd & USAGE_USBFILTER_REMOVE)
646	{
647	RTStrmPrintf(pStrm,
648	"VBoxManage usbfilter remove <index,0-N>\n"
649	" --target <uuid>\|<name>\|global\n"
650	"\n");
651	}
652
653	if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
654	{
655	RTStrmPrintf(pStrm,
656	"VBoxManage sharedfolder add <vmname>\|<uuid>\n"
657	" --name <name> --hostpath <hostpath>\n"
658	" [--transient] [--readonly] [--automount]\n"
659	"\n");
660	}
661
662	if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
663	{
664	RTStrmPrintf(pStrm,
665	"VBoxManage sharedfolder remove <vmname>\|<uuid>\n"
666	" --name <name> [--transient]\n"
667	"\n");
668	}
669
670	if (u64Cmd & USAGE_VM_STATISTICS)
671	{
672	RTStrmPrintf(pStrm,
673	"VBoxManage vmstatistics <vmname>\|<uuid> [--reset]\n"
674	" [--pattern <pattern>] [--descriptions]\n"
675	"\n");
676	}
677
678	#ifdef VBOX_WITH_GUEST_PROPS
679	if (u64Cmd & USAGE_GUESTPROPERTY)
680	usageGuestProperty(pStrm);
681	#endif /* VBOX_WITH_GUEST_PROPS defined */
682
683	#ifdef VBOX_WITH_GUEST_CONTROL
684	if (u64Cmd & USAGE_GUESTCONTROL)
685	usageGuestControl(pStrm);
686	#endif /* VBOX_WITH_GUEST_CONTROL defined */
687
688	if (u64Cmd & USAGE_METRICS)
689	{
690	RTStrmPrintf(pStrm,
691	"VBoxManage metrics list [*\|host\|<vmname> [<metric_list>]]\n"
692	" (comma-separated)\n\n"
693	"VBoxManage metrics setup\n"
694	" [--period <seconds>] (default: 1)\n"
695	" [--samples <count>] (default: 1)\n"
696	" [--list]\n"
697	" [*\|host\|<vmname> [<metric_list>]]\n\n"
698	"VBoxManage metrics query [*\|host\|<vmname> [<metric_list>]]\n\n"
699	"VBoxManage metrics enable\n"
700	" [--list]\n"
701	" [*\|host\|<vmname> [<metric_list>]]\n\n"
702	"VBoxManage metrics disable\n"
703	" [--list]\n"
704	" [*\|host\|<vmname> [<metric_list>]]\n\n"
705	"VBoxManage metrics collect\n"
706	" [--period <seconds>] (default: 1)\n"
707	" [--samples <count>] (default: 1)\n"
708	" [--list]\n"
709	" [--detach]\n"
710	" [*\|host\|<vmname> [<metric_list>]]\n"
711	"\n");
712	}
713	#if defined(VBOX_WITH_NETFLT)
714	if (u64Cmd & USAGE_HOSTONLYIFS)
715	{
716	RTStrmPrintf(pStrm,
717	"VBoxManage hostonlyif ipconfig <name>\n"
718	" [--dhcp \|\n"
719	" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] \|\n"
720	" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
721	# if defined(RT_OS_WINDOWS)
722	" create \|\n"
723	" remove <name>\n"
724	# endif
725	"\n");
726	}
727	#endif
728
729	if (u64Cmd & USAGE_DHCPSERVER)
730	{
731	RTStrmPrintf(pStrm,
732	"VBoxManage dhcpserver add\|modify --netname <network_name> \|\n"
733	#if defined(VBOX_WITH_NETFLT)
734	" --ifname <hostonly_if_name>\n"
735	#endif
736	" [--ip <ip_address>\n"
737	" --netmask <network_mask>\n"
738	" --lowerip <lower_ip>\n"
739	" --upperip <upper_ip>]\n"
740	" [--enable \| --disable]\n\n"
741	"VBoxManage dhcpserver remove --netname <network_name> \|\n"
742	#if defined(VBOX_WITH_NETFLT)
743	" --ifname <hostonly_if_name>\n"
744	#endif
745	"\n");
746	}
747	}
748
749	/**
750	* Print a usage synopsis and the syntax error message.
751	*/
752	int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
753	{
754	va_list args;
755	showLogo(g_pStdErr); // show logo even if suppressed
756	#ifndef VBOX_ONLY_DOCS
757	if (g_fInternalMode)
758	printUsageInternal(u64Cmd, g_pStdErr);
759	else
760	printUsage(u64Cmd, g_pStdErr);
761	#endif /* !VBOX_ONLY_DOCS */
762	va_start(args, pszFormat);
763	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
764	va_end(args);
765	return 1;
766	}
767
768	/**
769	* errorSyntax for RTGetOpt users.
770	*
771	* @returns 1.
772	*
773	* @param fUsageCategory The usage category of the command.
774	* @param rc The RTGetOpt return code.
775	* @param pValueUnion The value union.
776	*/
777	int errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
778	{
779	showLogo(g_pStdErr); // show logo even if suppressed
780	#ifndef VBOX_ONLY_DOCS
781	if (g_fInternalMode)
782	printUsageInternal(fUsageCategory, g_pStdErr);
783	else
784	printUsage(fUsageCategory, g_pStdErr);
785	#endif /* !VBOX_ONLY_DOCS */
786
787	if (rc == VINF_GETOPT_NOT_OPTION)
788	return RTMsgError("Invalid parameter '%s'", pValueUnion->psz);
789	if (rc > 0)
790	{
791	if (RT_C_IS_PRINT(rc))
792	return RTMsgError("Invalid option -%c", rc);
793	return RTMsgError("Invalid option case %i", rc);
794	}
795	if (rc == VERR_GETOPT_UNKNOWN_OPTION)
796	return RTMsgError("Unknown option: %s", pValueUnion->psz);
797	if (pValueUnion->pDef)
798	return RTMsgError("%s: %Rrs", pValueUnion->pDef->pszLong, rc);
799	return RTMsgError("%Rrs", rc);
800	}
801
802	/**
803	* Print an error message without the syntax stuff.
804	*/
805	int errorArgument(const char *pszFormat, ...)
806	{
807	va_list args;
808	va_start(args, pszFormat);
809	RTMsgErrorV(pszFormat, args);
810	va_end(args);
811	return 1;
812	}

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

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

Download in other formats: