VBoxManageHelp.cpp@ 37602

Last change on this file since 37602 was 37543, checked in by vboxsync, 13 years ago
FE/CLI: add --options to clonevm
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 38.5 KB

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

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

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

Download in other formats: