VBoxManageHelp.cpp@ 54487

Last change on this file since 54487 was 54487, checked in by vboxsync, 10 years ago
FE/VBoxManage: Add support for medium encryption
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 50.0 KB

Line
1	/* $Id: VBoxManageHelp.cpp 54487 2015-02-25 12:50:45Z vboxsync $ */
2	/** @file
3	* VBoxManage - help and other message output.
4	*/
5
6	/*
7	* Copyright (C) 2006-2015 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 fCategory, uint32_t fSubCategory, 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 (fCategory == 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	fCategory = USAGE_ALL;
93	}
94
95	RTStrmPrintf(pStrm,
96	"Usage:\n"
97	"\n");
98
99	if (fCategory == USAGE_ALL)
100	RTStrmPrintf(pStrm,
101	" VBoxManage [<general option>] <command>\n"
102	" \n \n"
103	"General Options:\n \n"
104	" [-v\|--version] print version number and exit\n"
105	" [-q\|--nologo] suppress the logo\n"
106	" [--settingspw <pw>] provide the settings password\n"
107	" [--settingspwfile <file>] provide a file containing the settings password\n"
108	" \n \n"
109	"Commands:\n \n");
110
111	const char *pcszSep1 = " ";
112	const char *pcszSep2 = " ";
113	if (fCategory != USAGE_ALL)
114	{
115	pcszSep1 = "VBoxManage";
116	pcszSep2 = "";
117	}
118
119	#define SEP pcszSep1, pcszSep2
120
121	if (fCategory & USAGE_LIST)
122	RTStrmPrintf(pStrm,
123	"%s list [--long\|-l]%s vms\|runningvms\|ostypes\|hostdvds\|hostfloppies\|\n"
124	#if defined(VBOX_WITH_NETFLT)
125	" intnets\|bridgedifs\|hostonlyifs\|natnets\|dhcpservers\|\n"
126	#else
127	" intnets\|bridgedifs\|natnets\|dhcpservers\|hostinfo\|\n"
128	#endif
129	" hostinfo\|hostcpuids\|hddbackends\|hdds\|dvds\|floppies\|\n"
130	" usbhost\|usbfilters\|systemproperties\|extpacks\|\n"
131	" groups\|webcams\|screenshotformats\n"
132	"\n", SEP);
133
134	if (fCategory & USAGE_SHOWVMINFO)
135	RTStrmPrintf(pStrm,
136	"%s showvminfo %s <uuid\|vmname> [--details]\n"
137	" [--machinereadable]\n"
138	"%s showvminfo %s <uuid\|vmname> --log <idx>\n"
139	"\n", SEP, SEP);
140
141	if (fCategory & USAGE_REGISTERVM)
142	RTStrmPrintf(pStrm,
143	"%s registervm %s <filename>\n"
144	"\n", SEP);
145
146	if (fCategory & USAGE_UNREGISTERVM)
147	RTStrmPrintf(pStrm,
148	"%s unregistervm %s <uuid\|vmname> [--delete]\n"
149	"\n", SEP);
150
151	if (fCategory & USAGE_CREATEVM)
152	RTStrmPrintf(pStrm,
153	"%s createvm %s --name <name>\n"
154	" [--groups <group>, ...]\n"
155	" [--ostype <ostype>]\n"
156	" [--register]\n"
157	" [--basefolder <path>]\n"
158	" [--uuid <uuid>]\n"
159	"\n", SEP);
160
161	if (fCategory & USAGE_MODIFYVM)
162	{
163	RTStrmPrintf(pStrm,
164	"%s modifyvm %s <uuid\|vmname>\n"
165	" [--name <name>]\n"
166	" [--groups <group>, ...]\n"
167	" [--description <desc>]\n"
168	" [--ostype <ostype>]\n"
169	" [--iconfile <filename>]\n"
170	" [--memory <memorysize in MB>]\n"
171	" [--pagefusion on\|off]\n"
172	" [--vram <vramsize in MB>]\n"
173	" [--acpi on\|off]\n"
174	#ifdef VBOX_WITH_PCI_PASSTHROUGH
175	" [--pciattach 03:04.0]\n"
176	" [--pciattach 03:04.0@02:01.0]\n"
177	" [--pcidetach 03:04.0]\n"
178	#endif
179	" [--ioapic on\|off]\n"
180	" [--hpet on\|off]\n"
181	" [--triplefaultreset on\|off]\n"
182	" [--paravirtprovider none\|default\|legacy\|minimal\|\n"
183	" hyperv]\n"
184	" [--hwvirtex on\|off]\n"
185	" [--nestedpaging on\|off]\n"
186	" [--largepages on\|off]\n"
187	" [--vtxvpid on\|off]\n"
188	" [--vtxux on\|off]\n"
189	" [--pae on\|off]\n"
190	" [--longmode on\|off]\n"
191	" [--synthcpu on\|off]\n"
192	" [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
193	" [--cpuidremove <leaf>]\n"
194	" [--cpuidremoveall]\n"
195	" [--hardwareuuid <uuid>]\n"
196	" [--cpus <number>]\n"
197	" [--cpuhotplug on\|off]\n"
198	" [--plugcpu <id>]\n"
199	" [--unplugcpu <id>]\n"
200	" [--cpuexecutioncap <1-100>]\n"
201	" [--rtcuseutc on\|off]\n"
202	#ifdef VBOX_WITH_VMSVGA
203	" [--graphicscontroller none\|vboxvga\|vmsvga]\n"
204	#else
205	" [--graphicscontroller none\|vboxvga]\n"
206	#endif
207	" [--monitorcount <number>]\n"
208	" [--accelerate3d on\|off]\n"
209	#ifdef VBOX_WITH_VIDEOHWACCEL
210	" [--accelerate2dvideo on\|off]\n"
211	#endif
212	" [--firmware bios\|efi\|efi32\|efi64]\n"
213	" [--chipset ich9\|piix3]\n"
214	" [--bioslogofadein on\|off]\n"
215	" [--bioslogofadeout on\|off]\n"
216	" [--bioslogodisplaytime <msec>]\n"
217	" [--bioslogoimagepath <imagepath>]\n"
218	" [--biosbootmenu disabled\|menuonly\|messageandmenu]\n"
219	" [--biossystemtimeoffset <msec>]\n"
220	" [--biospxedebug on\|off]\n"
221	" [--boot<1-4> none\|floppy\|dvd\|disk\|net>]\n"
222	" [--nic<1-N> none\|null\|nat\|bridged\|intnet"
223	#if defined(VBOX_WITH_NETFLT)
224	"\|hostonly"
225	#endif
226	"\|\n"
227	" generic\|natnetwork"
228	"]\n"
229	" [--nictype<1-N> Am79C970A\|Am79C973"
230	#ifdef VBOX_WITH_E1000
231	"\|\n 82540EM\|82543GC\|82545EM"
232	#endif
233	#ifdef VBOX_WITH_VIRTIO
234	"\|\n virtio"
235	#endif /* VBOX_WITH_VIRTIO */
236	"]\n"
237	" [--cableconnected<1-N> on\|off]\n"
238	" [--nictrace<1-N> on\|off]\n"
239	" [--nictracefile<1-N> <filename>]\n"
240	" [--nicproperty<1-N> name=[value]]\n"
241	" [--nicspeed<1-N> <kbps>]\n"
242	" [--nicbootprio<1-N> <priority>]\n"
243	" [--nicpromisc<1-N> deny\|allow-vms\|allow-all]\n"
244	" [--nicbandwidthgroup<1-N> none\|<name>]\n"
245	" [--bridgeadapter<1-N> none\|<devicename>]\n"
246	#if defined(VBOX_WITH_NETFLT)
247	" [--hostonlyadapter<1-N> none\|<devicename>]\n"
248	#endif
249	" [--intnet<1-N> <network name>]\n"
250	" [--nat-network<1-N> <network name>]\n"
251	" [--nicgenericdrv<1-N> <driver>\n"
252	" [--natnet<1-N> <network>\|default]\n"
253	" [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
254	" [<sockrcv>],[<tcpsnd>],\n"
255	" [<tcprcv>]]\n"
256	" [--natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
257	" <hostport>,[<guestip>],<guestport>]\n"
258	" [--natpf<1-N> delete <rulename>]\n"
259	" [--nattftpprefix<1-N> <prefix>]\n"
260	" [--nattftpfile<1-N> <file>]\n"
261	" [--nattftpserver<1-N> <ip>]\n"
262	" [--natbindip<1-N> <ip>\n"
263	" [--natdnspassdomain<1-N> on\|off]\n"
264	" [--natdnsproxy<1-N> on\|off]\n"
265	" [--natdnshostresolver<1-N> on\|off]\n"
266	" [--nataliasmode<1-N> default\|[log],[proxyonly],\n"
267	" [sameports]]\n"
268	" [--macaddress<1-N> auto\|<mac>]\n"
269	" [--mouse ps2\|usb\|usbtablet\|usbmultitouch]\n"
270	" [--keyboard ps2\|usb\n"
271	" [--uart<1-N> off\|<I/O base> <IRQ>]\n"
272	" [--uartmode<1-N> disconnected\|\n"
273	" server <pipe>\|\n"
274	" client <pipe>\|\n"
275	" file <file>\|\n"
276	" <devicename>]\n"
277	#if defined(RT_OS_LINUX) \|\| defined(RT_OS_WINDOWS)
278	" [--lpt<1-N> off\|<I/O base> <IRQ>]\n"
279	" [--lptmode<1-N> <devicename>]\n"
280	#endif
281	" [--guestmemoryballoon <balloonsize in MB>]\n"
282	" [--audio none\|null", SEP);
283	if (fWin)
284	{
285	#ifdef VBOX_WITH_WINMM
286	RTStrmPrintf(pStrm, "\|winmm\|dsound");
287	#else
288	RTStrmPrintf(pStrm, "\|dsound");
289	#endif
290	}
291	if (fSolaris)
292	{
293	RTStrmPrintf(pStrm, "\|solaudio"
294	#ifdef VBOX_WITH_SOLARIS_OSS
295	"\|oss"
296	#endif
297	);
298	}
299	if (fLinux)
300	{
301	RTStrmPrintf(pStrm, "\|oss"
302	#ifdef VBOX_WITH_ALSA
303	"\|alsa"
304	#endif
305	#ifdef VBOX_WITH_PULSE
306	"\|pulse"
307	#endif
308	);
309	}
310	if (fFreeBSD)
311	{
312	/* Get the line break sorted when dumping all option variants. */
313	if (fDumpOpts)
314	{
315	RTStrmPrintf(pStrm, "\|\n"
316	" oss");
317	}
318	else
319	RTStrmPrintf(pStrm, "\|oss");
320	#ifdef VBOX_WITH_PULSE
321	RTStrmPrintf(pStrm, "\|pulse");
322	#endif
323	}
324	if (fDarwin)
325	{
326	RTStrmPrintf(pStrm, "\|coreaudio");
327	}
328	RTStrmPrintf(pStrm, "]\n");
329	RTStrmPrintf(pStrm,
330	" [--audiocontroller ac97\|hda\|sb16]\n"
331	" [--clipboard disabled\|hosttoguest\|guesttohost\|\n"
332	" bidirectional]\n"
333	" [--draganddrop disabled\|hosttoguest]\n");
334	RTStrmPrintf(pStrm,
335	" [--vrde on\|off]\n"
336	" [--vrdeextpack default\|<name>\n"
337	" [--vrdeproperty <name=[value]>]\n"
338	" [--vrdeport <hostport>]\n"
339	" [--vrdeaddress <hostip>]\n"
340	" [--vrdeauthtype null\|external\|guest]\n"
341	" [--vrdeauthlibrary default\|<name>\n"
342	" [--vrdemulticon on\|off]\n"
343	" [--vrdereusecon on\|off]\n"
344	" [--vrdevideochannel on\|off]\n"
345	" [--vrdevideochannelquality <percent>]\n");
346	RTStrmPrintf(pStrm,
347	" [--usb on\|off]\n"
348	" [--usbehci on\|off]\n"
349	" [--snapshotfolder default\|<path>]\n"
350	" [--teleporter on\|off]\n"
351	" [--teleporterport <port>]\n"
352	" [--teleporteraddress <address\|empty>\n"
353	" [--teleporterpassword <password>]\n"
354	" [--teleporterpasswordfile <file>\|stdin]\n"
355	" [--tracing-enabled on\|off]\n"
356	" [--tracing-config <config-string>]\n"
357	" [--tracing-allow-vm-access on\|off]\n"
358	#if 0
359	" [--iocache on\|off]\n"
360	" [--iocachesize <I/O cache size in MB>]\n"
361	#endif
362	#if 0
363	" [--faulttolerance master\|standby]\n"
364	" [--faulttoleranceaddress <name>]\n"
365	" [--faulttoleranceport <port>]\n"
366	" [--faulttolerancesyncinterval <msec>]\n"
367	" [--faulttolerancepassword <password>]\n"
368	#endif
369	#ifdef VBOX_WITH_USB_CARDREADER
370	" [--usbcardreader on\|off]\n"
371	#endif
372	" [--autostart-enabled on\|off]\n"
373	" [--autostart-delay <seconds>]\n"
374	#if 0
375	" [--autostop-type disabled\|savestate\|poweroff\|\n"
376	" acpishutdown]\n"
377	#endif
378	#ifdef VBOX_WITH_VPX
379	" [--videocap on\|off]\n"
380	" [--videocapscreens all\|<screen ID> [<screen ID> ...]]\n"
381	" [--videocapfile <filename>]\n"
382	" [--videocapres <width> <height>]\n"
383	" [--videocaprate <rate>]\n"
384	" [--videocapfps <fps>]\n"
385	" [--videocapmaxtime <time>]\n"
386	" [--videocapmaxsize <MB>]\n"
387	" [--videocapopts <key=value> [<key=value> ...]]\n"
388	#endif
389	" [--defaultfrontend default\|<name>]\n"
390	"\n");
391	}
392
393	if (fCategory & USAGE_CLONEVM)
394	RTStrmPrintf(pStrm,
395	"%s clonevm %s <uuid\|vmname>\n"
396	" [--snapshot <uuid>\|<name>]\n"
397	" [--mode machine\|machineandchildren\|all]\n"
398	" [--options link\|keepallmacs\|keepnatmacs\|\n"
399	" keepdisknames]\n"
400	" [--name <name>]\n"
401	" [--groups <group>, ...]\n"
402	" [--basefolder <basefolder>]\n"
403	" [--uuid <uuid>]\n"
404	" [--register]\n"
405	"\n", SEP);
406
407	if (fCategory & USAGE_IMPORTAPPLIANCE)
408	RTStrmPrintf(pStrm,
409	"%s import %s <ovfname/ovaname>\n"
410	" [--dry-run\|-n]\n"
411	" [--options keepallmacs\|keepnatmacs]\n"
412	" [more options]\n"
413	" (run with -n to have options displayed\n"
414	" for a particular OVF)\n\n", SEP);
415
416	if (fCategory & USAGE_EXPORTAPPLIANCE)
417	RTStrmPrintf(pStrm,
418	"%s export %s <machines> --output\|-o <name>.<ovf/ova>\n"
419	" [--legacy09\|--ovf09\|--ovf10\|--ovf20]\n"
420	" [--manifest]\n"
421	" [--iso]\n"
422	" [--options manifest\|iso\|nomacs\|nomacsbutnat]\n"
423	" [--vsys <number of virtual system>]\n"
424	" [--product <product name>]\n"
425	" [--producturl <product url>]\n"
426	" [--vendor <vendor name>]\n"
427	" [--vendorurl <vendor url>]\n"
428	" [--version <version info>]\n"
429	" [--description <description info>]\n"
430	" [--eula <license text>]\n"
431	" [--eulafile <filename>]\n"
432	"\n", SEP);
433
434	if (fCategory & USAGE_STARTVM)
435	{
436	RTStrmPrintf(pStrm,
437	"%s startvm %s <uuid\|vmname>...\n"
438	" [--type gui", SEP);
439	if (fVBoxSDL)
440	RTStrmPrintf(pStrm, "\|sdl");
441	RTStrmPrintf(pStrm, "\|headless]\n");
442	RTStrmPrintf(pStrm,
443	"\n");
444	}
445
446	if (fCategory & USAGE_CONTROLVM)
447	{
448	RTStrmPrintf(pStrm,
449	"%s controlvm %s <uuid\|vmname>\n"
450	" pause\|resume\|reset\|poweroff\|savestate\|\n"
451	" acpipowerbutton\|acpisleepbutton\|\n"
452	" keyboardputscancode <hex> [<hex> ...]\|\n"
453	" setlinkstate<1-N> on\|off \|\n"
454	#if defined(VBOX_WITH_NETFLT)
455	" nic<1-N> null\|nat\|bridged\|intnet\|hostonly\|generic\|\n"
456	" natnetwork [<devicename>] \|\n"
457	#else /* !VBOX_WITH_NETFLT */
458	" nic<1-N> null\|nat\|bridged\|intnet\|generic\|natnetwork\n"
459	" [<devicename>] \|\n"
460	#endif /* !VBOX_WITH_NETFLT */
461	" nictrace<1-N> on\|off \|\n"
462	" nictracefile<1-N> <filename> \|\n"
463	" nicproperty<1-N> name=[value] \|\n"
464	" nicpromisc<1-N> deny\|allow-vms\|allow-all \|\n"
465	" natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
466	" <hostport>,[<guestip>],<guestport> \|\n"
467	" natpf<1-N> delete <rulename> \|\n"
468	" guestmemoryballoon <balloonsize in MB> \|\n"
469	" usbattach <uuid>\|<address>\n"
470	" [--capturefile <filename>] \|\n"
471	" usbdetach <uuid>\|<address> \|\n"
472	" clipboard disabled\|hosttoguest\|guesttohost\|\n"
473	" bidirectional \|\n"
474	" draganddrop disabled\|hosttoguest \|\n"
475	" vrde on\|off \|\n"
476	" vrdeport <port> \|\n"
477	" vrdeproperty <name=[value]> \|\n"
478	" vrdevideochannelquality <percent> \|\n"
479	" setvideomodehint <xres> <yres> <bpp>\n"
480	" [[<display>] [<enabled:yes\|no> \|\n"
481	" [<xorigin> <yorigin>]]] \|\n"
482	" screenshotpng <file> [display] \|\n"
483	" vcpenabled on\|off \|\n"
484	" vcpscreens all\|none\|<screen>,[<screen>...] \|\n"
485	" setcredentials <username>\n"
486	" --passwordfile <file> \| <password>\n"
487	" <domain>\n"
488	" [--allowlocallogon <yes\|no>] \|\n"
489	" teleport --host <name> --port <port>\n"
490	" [--maxdowntime <msec>]\n"
491	" [--passwordfile <file> \|\n"
492	" --password <password>] \|\n"
493	" plugcpu <id> \|\n"
494	" unplugcpu <id> \|\n"
495	" cpuexecutioncap <1-100>\n"
496	" webcam <attach [path [settings]]> \| <detach [path]> \| <list>\n"
497	"\n", SEP);
498	}
499
500	if (fCategory & USAGE_DISCARDSTATE)
501	RTStrmPrintf(pStrm,
502	"%s discardstate %s <uuid\|vmname>\n"
503	"\n", SEP);
504
505	if (fCategory & USAGE_ADOPTSTATE)
506	RTStrmPrintf(pStrm,
507	"%s adoptstate %s <uuid\|vmname> <state_file>\n"
508	"\n", SEP);
509
510	if (fCategory & USAGE_SNAPSHOT)
511	RTStrmPrintf(pStrm,
512	"%s snapshot %s <uuid\|vmname>\n"
513	" take <name> [--description <desc>] [--live] \|\n"
514	" delete <uuid\|snapname> \|\n"
515	" restore <uuid\|snapname> \|\n"
516	" restorecurrent \|\n"
517	" edit <uuid\|snapname>\|--current\n"
518	" [--name <name>]\n"
519	" [--description <desc>] \|\n"
520	" list [--details\|--machinereadable]\n"
521	" showvminfo <uuid\|snapname>\n"
522	"\n", SEP);
523
524	if (fCategory & USAGE_CLOSEMEDIUM)
525	RTStrmPrintf(pStrm,
526	"%s closemedium %s [disk\|dvd\|floppy] <uuid\|filename>\n"
527	" [--delete]\n"
528	"\n", SEP);
529
530	if (fCategory & USAGE_STORAGEATTACH)
531	RTStrmPrintf(pStrm,
532	"%s storageattach %s <uuid\|vmname>\n"
533	" --storagectl <name>\n"
534	" [--port <number>]\n"
535	" [--device <number>]\n"
536	" [--type dvddrive\|hdd\|fdd]\n"
537	" [--medium none\|emptydrive\|additions\|\n"
538	" <uuid\|filename>\|host:<drive>\|iscsi]\n"
539	" [--mtype normal\|writethrough\|immutable\|shareable\|\n"
540	" readonly\|multiattach]\n"
541	" [--comment <text>]\n"
542	" [--setuuid <uuid>]\n"
543	" [--setparentuuid <uuid>]\n"
544	" [--passthrough on\|off]\n"
545	" [--tempeject on\|off]\n"
546	" [--nonrotational on\|off]\n"
547	" [--discard on\|off]\n"
548	" [--hotpluggable on\|off]\n"
549	" [--bandwidthgroup <name>]\n"
550	" [--forceunmount]\n"
551	" [--server <name>\|<ip>]\n"
552	" [--target <target>]\n"
553	" [--tport <port>]\n"
554	" [--lun <lun>]\n"
555	" [--encodedlun <lun>]\n"
556	" [--username <username>]\n"
557	" [--password <password>]\n"
558	" [--initiator <initiator>]\n"
559	" [--intnet]\n"
560	"\n", SEP);
561
562	if (fCategory & USAGE_STORAGECONTROLLER)
563	RTStrmPrintf(pStrm,
564	"%s storagectl %s <uuid\|vmname>\n"
565	" --name <name>\n"
566	" [--add ide\|sata\|scsi\|floppy\|sas]\n"
567	" [--controller LSILogic\|LSILogicSAS\|BusLogic\|\n"
568	" IntelAHCI\|PIIX3\|PIIX4\|ICH6\|I82078]\n"
569	" [--portcount <1-n>]\n"
570	" [--hostiocache on\|off]\n"
571	" [--bootable on\|off]\n"
572	" [--remove]\n"
573	"\n", SEP);
574
575	if (fCategory & USAGE_BANDWIDTHCONTROL)
576	RTStrmPrintf(pStrm,
577	"%s bandwidthctl %s <uuid\|vmname>\n"
578	" add <name> --type disk\|network\n"
579	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
580	" set <name>\n"
581	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
582	" remove <name> \|\n"
583	" list [--machinereadable]\n"
584	" (limit units: k=kilobit, m=megabit, g=gigabit,\n"
585	" K=kilobyte, M=megabyte, G=gigabyte)\n"
586	"\n", SEP);
587
588	if (fCategory & USAGE_SHOWMEDIUMINFO)
589	RTStrmPrintf(pStrm,
590	"%s showmediuminfo %s [disk\|dvd\|floppy] <uuid\|filename>\n"
591	"\n", SEP);
592
593	if (fCategory & USAGE_CREATEMEDIUM)
594	RTStrmPrintf(pStrm,
595	"%s createmedium %s [disk\|dvd\|floppy] --filename <filename>\n"
596	" [--size <megabytes>\|--sizebyte <bytes>]\n"
597	" [--diffparent <uuid>\|<filename>\n"
598	" [--format VDI\|VMDK\|VHD] (default: VDI)\n"
599	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
600	"\n", SEP);
601
602	if (fCategory & USAGE_MODIFYMEDIUM)
603	RTStrmPrintf(pStrm,
604	"%s modifymedium %s [disk\|dvd\|floppy] <uuid\|filename>\n"
605	" [--type normal\|writethrough\|immutable\|shareable\|\n"
606	" readonly\|multiattach]\n"
607	" [--autoreset on\|off]\n"
608	" [--property <name=[value]>]\n"
609	" [--compact]\n"
610	" [--resize <megabytes>\|--resizebyte <bytes>]\n"
611	"\n", SEP);
612
613	if (fCategory & USAGE_CLONEMEDIUM)
614	RTStrmPrintf(pStrm,
615	"%s clonemedium %s [disk\|dvd\|floppy] <uuid\|inputfile> <uuid\|outputfile>\n"
616	" [--format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
617	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
618	" [--existing]\n"
619	"\n", SEP);
620
621	if (fCategory & USAGE_MEDIUMPROPERTY)
622	RTStrmPrintf(pStrm,
623	"%s mediumproperty %s [disk\|dvd\|floppy] set <uuid\|filename>\n"
624	" <property> <value>\n"
625	"\n"
626	" [disk\|dvd\|floppy] get <uuid\|filename>\n"
627	" <property>\n"
628	"\n"
629	" [disk\|dvd\|floppy] delete <uuid\|filename>\n"
630	" <property>\n"
631	"\n", SEP);
632
633	if (fCategory & USAGE_ENCRYPTMEDIUM)
634	RTStrmPrintf(pStrm,
635	"%s encryptmedium %s <uuid\|filename>\n"
636	" [--newpassword <new password>]\n"
637	" [--oldpassword <old password>]\n"
638	" [--cipher <cipher identifier>]\n"
639	"\n", SEP);
640
641	if (fCategory & USAGE_CONVERTFROMRAW)
642	RTStrmPrintf(pStrm,
643	"%s convertfromraw %s <filename> <outputfile>\n"
644	" [--format VDI\|VMDK\|VHD]\n"
645	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
646	" [--uuid <uuid>]\n"
647	"%s convertfromraw %s stdin <outputfile> <bytes>\n"
648	" [--format VDI\|VMDK\|VHD]\n"
649	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
650	" [--uuid <uuid>]\n"
651	"\n", SEP, SEP);
652
653	if (fCategory & USAGE_GETEXTRADATA)
654	RTStrmPrintf(pStrm,
655	"%s getextradata %s global\|<uuid\|vmname>\n"
656	" <key>\|enumerate\n"
657	"\n", SEP);
658
659	if (fCategory & USAGE_SETEXTRADATA)
660	RTStrmPrintf(pStrm,
661	"%s setextradata %s global\|<uuid\|vmname>\n"
662	" <key>\n"
663	" [<value>] (no value deletes key)\n"
664	"\n", SEP);
665
666	if (fCategory & USAGE_SETPROPERTY)
667	RTStrmPrintf(pStrm,
668	"%s setproperty %s machinefolder default\|<folder> \|\n"
669	" hwvirtexclusive on\|off \|\n"
670	" vrdeauthlibrary default\|<library> \|\n"
671	" websrvauthlibrary default\|null\|<library> \|\n"
672	" vrdeextpack null\|<library> \|\n"
673	" autostartdbpath null\|<folder> \|\n"
674	" loghistorycount <value>\n"
675	" defaultfrontend default\|<name>\n"
676	"\n", SEP);
677
678	if (fCategory & USAGE_USBFILTER_ADD)
679	RTStrmPrintf(pStrm,
680	"%s usbfilter %s add <index,0-N>\n"
681	" --target <uuid\|vmname>\|global\n"
682	" --name <string>\n"
683	" --action ignore\|hold (global filters only)\n"
684	" [--active yes\|no] (yes)\n"
685	" [--vendorid <XXXX>] (null)\n"
686	" [--productid <XXXX>] (null)\n"
687	" [--revision <IIFF>] (null)\n"
688	" [--manufacturer <string>] (null)\n"
689	" [--product <string>] (null)\n"
690	" [--remote yes\|no] (null, VM filters only)\n"
691	" [--serialnumber <string>] (null)\n"
692	" [--maskedinterfaces <XXXXXXXX>]\n"
693	"\n", SEP);
694
695	if (fCategory & USAGE_USBFILTER_MODIFY)
696	RTStrmPrintf(pStrm,
697	"%s usbfilter %s modify <index,0-N>\n"
698	" --target <uuid\|vmname>\|global\n"
699	" [--name <string>]\n"
700	" [--action ignore\|hold] (global filters only)\n"
701	" [--active yes\|no]\n"
702	" [--vendorid <XXXX>\|\"\"]\n"
703	" [--productid <XXXX>\|\"\"]\n"
704	" [--revision <IIFF>\|\"\"]\n"
705	" [--manufacturer <string>\|\"\"]\n"
706	" [--product <string>\|\"\"]\n"
707	" [--remote yes\|no] (null, VM filters only)\n"
708	" [--serialnumber <string>\|\"\"]\n"
709	" [--maskedinterfaces <XXXXXXXX>]\n"
710	"\n", SEP);
711
712	if (fCategory & USAGE_USBFILTER_REMOVE)
713	RTStrmPrintf(pStrm,
714	"%s usbfilter %s remove <index,0-N>\n"
715	" --target <uuid\|vmname>\|global\n"
716	"\n", SEP);
717
718	if (fCategory & USAGE_SHAREDFOLDER_ADD)
719	RTStrmPrintf(pStrm,
720	"%s sharedfolder %s add <uuid\|vmname>\n"
721	" --name <name> --hostpath <hostpath>\n"
722	" [--transient] [--readonly] [--automount]\n"
723	"\n", SEP);
724
725	if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
726	RTStrmPrintf(pStrm,
727	"%s sharedfolder %s remove <uuid\|vmname>\n"
728	" --name <name> [--transient]\n"
729	"\n", SEP);
730
731	#ifdef VBOX_WITH_GUEST_PROPS
732	if (fCategory & USAGE_GUESTPROPERTY)
733	usageGuestProperty(pStrm, SEP);
734	#endif /* VBOX_WITH_GUEST_PROPS defined */
735
736	#ifdef VBOX_WITH_GUEST_CONTROL
737	if (fCategory & USAGE_GUESTCONTROL)
738	usageGuestControl(pStrm, SEP, fSubCategory);
739	#endif /* VBOX_WITH_GUEST_CONTROL defined */
740
741	if (fCategory & USAGE_DEBUGVM)
742	{
743	RTStrmPrintf(pStrm,
744	"%s debugvm %s <uuid\|vmname>\n"
745	" dumpguestcore --filename <name> \|\n"
746	" info <item> [args] \|\n"
747	" injectnmi \|\n"
748	" log [--release\|--debug] <settings> ...\|\n"
749	" logdest [--release\|--debug] <settings> ...\|\n"
750	" logflags [--release\|--debug] <settings> ...\|\n"
751	" osdetect \|\n"
752	" osinfo \|\n"
753	" getregisters [--cpu <id>] <reg>\|all ... \|\n"
754	" setregisters [--cpu <id>] <reg>=<value> ... \|\n"
755	" show [--human-readable\|--sh-export\|--sh-eval\|\n"
756	" --cmd-set] \n"
757	" <logdbg-settings\|logrel-settings>\n"
758	" [[opt] what ...] \|\n"
759	" statistics [--reset] [--pattern <pattern>]\n"
760	" [--descriptions]\n"
761	"\n", SEP);
762	}
763	if (fCategory & USAGE_METRICS)
764	RTStrmPrintf(pStrm,
765	"%s metrics %s list [*\|host\|<vmname> [<metric_list>]]\n"
766	" (comma-separated)\n\n"
767	"%s metrics %s setup\n"
768	" [--period <seconds>] (default: 1)\n"
769	" [--samples <count>] (default: 1)\n"
770	" [--list]\n"
771	" [*\|host\|<vmname> [<metric_list>]]\n\n"
772	"%s metrics %s query [*\|host\|<vmname> [<metric_list>]]\n\n"
773	"%s metrics %s enable\n"
774	" [--list]\n"
775	" [*\|host\|<vmname> [<metric_list>]]\n\n"
776	"%s metrics %s disable\n"
777	" [--list]\n"
778	" [*\|host\|<vmname> [<metric_list>]]\n\n"
779	"%s metrics %s collect\n"
780	" [--period <seconds>] (default: 1)\n"
781	" [--samples <count>] (default: 1)\n"
782	" [--list]\n"
783	" [--detach]\n"
784	" [*\|host\|<vmname> [<metric_list>]]\n"
785	"\n", SEP, SEP, SEP, SEP, SEP, SEP);
786
787	#if defined(VBOX_WITH_NAT_SERVICE)
788	if (fCategory & USAGE_NATNETWORK)
789	{
790	RTStrmPrintf(pStrm,
791	"%s natnetwork %s add --netname <name>\n"
792	" --network <network>\n"
793	" [--enable\|--disable]\n"
794	" [--dhcp on\|off]\n"
795	" [--port-forward-4 <rule>]\n"
796	" [--loopback-4 <rule>]\n"
797	" [--ipv6 on\|off]\n"
798	" [--port-forward-6 <rule>]\n"
799	" [--loopback-6 <rule>]\n\n"
800	"%s natnetwork %s remove --netname <name>\n\n"
801	"%s natnetwork %s modify --netname <name>\n"
802	" [--network <network>]\n"
803	" [--enable\|--disable]\n"
804	" [--dhcp on\|off]\n"
805	" [--port-forward-4 <rule>]\n"
806	" [--loopback-4 <rule>]\n"
807	" [--ipv6 on\|off]\n"
808	" [--port-forward-6 <rule>]\n"
809	" [--loopback-6 <rule>]\n\n"
810	"%s natnetwork %s start --netname <name>\n\n"
811	"%s natnetwork %s stop --netname <name>\n"
812	"\n", SEP, SEP, SEP, SEP, SEP);
813
814
815	}
816	#endif
817
818	#if defined(VBOX_WITH_NETFLT)
819	if (fCategory & USAGE_HOSTONLYIFS)
820	{
821	RTStrmPrintf(pStrm,
822	"%s hostonlyif %s ipconfig <name>\n"
823	" [--dhcp \|\n"
824	" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] \|\n"
825	" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
826	# if !defined(RT_OS_SOLARIS)
827	" create \|\n"
828	" remove <name>\n"
829	# endif
830	"\n", SEP);
831	}
832	#endif
833
834	if (fCategory & USAGE_DHCPSERVER)
835	{
836	RTStrmPrintf(pStrm,
837	"%s dhcpserver %s add\|modify --netname <network_name> \|\n"
838	#if defined(VBOX_WITH_NETFLT)
839	" --ifname <hostonly_if_name>\n"
840	#endif
841	" [--ip <ip_address>\n"
842	" --netmask <network_mask>\n"
843	" --lowerip <lower_ip>\n"
844	" --upperip <upper_ip>]\n"
845	" [--enable \| --disable]\n\n"
846	"%s dhcpserver %s remove --netname <network_name> \|\n"
847	#if defined(VBOX_WITH_NETFLT)
848	" --ifname <hostonly_if_name>\n"
849	#endif
850	"\n", SEP, SEP);
851	}
852	if (fCategory & USAGE_EXTPACK)
853	{
854	RTStrmPrintf(pStrm,
855	"%s extpack %s install [--replace] <tarball> \|\n"
856	" uninstall [--force] <name> \|\n"
857	" cleanup\n"
858	"\n", SEP);
859	}
860	}
861
862	/**
863	* Print a usage synopsis and the syntax error message.
864	* @returns RTEXITCODE_SYNTAX.
865	*/
866	RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
867	{
868	va_list args;
869	showLogo(g_pStdErr); // show logo even if suppressed
870	#ifndef VBOX_ONLY_DOCS
871	if (g_fInternalMode)
872	printUsageInternal(fCategory, g_pStdErr);
873	else
874	printUsage(fCategory, ~0U, g_pStdErr);
875	#endif /* !VBOX_ONLY_DOCS */
876	va_start(args, pszFormat);
877	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
878	va_end(args);
879	return RTEXITCODE_SYNTAX;
880	}
881
882	/**
883	* Print a usage synopsis and the syntax error message.
884	* @returns RTEXITCODE_SYNTAX.
885	*/
886	RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
887	{
888	va_list args;
889	showLogo(g_pStdErr); // show logo even if suppressed
890	#ifndef VBOX_ONLY_DOCS
891	if (g_fInternalMode)
892	printUsageInternal(fCategory, g_pStdErr);
893	else
894	printUsage(fCategory, fSubCategory, g_pStdErr);
895	#endif /* !VBOX_ONLY_DOCS */
896	va_start(args, pszFormat);
897	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
898	va_end(args);
899	return RTEXITCODE_SYNTAX;
900	}
901
902	/**
903	* errorSyntax for RTGetOpt users.
904	*
905	* @returns RTEXITCODE_SYNTAX.
906	*
907	* @param fCategory The usage category of the command.
908	* @param fSubCategory The usage sub-category of the command.
909	* @param rc The RTGetOpt return code.
910	* @param pValueUnion The value union.
911	*/
912	RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
913	{
914	/*
915	* Check if it is an unhandled standard option.
916	*/
917	if (rc == 'V')
918	{
919	RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
920	return RTEXITCODE_SUCCESS;
921	}
922
923	if (rc == 'h')
924	{
925	showLogo(g_pStdErr);
926	#ifndef VBOX_ONLY_DOCS
927	if (g_fInternalMode)
928	printUsageInternal(fCategory, g_pStdOut);
929	else
930	printUsage(fCategory, fSubCategory, g_pStdOut);
931	#endif
932	return RTEXITCODE_SUCCESS;
933	}
934
935	/*
936	* General failure.
937	*/
938	showLogo(g_pStdErr); // show logo even if suppressed
939	#ifndef VBOX_ONLY_DOCS
940	if (g_fInternalMode)
941	printUsageInternal(fCategory, g_pStdErr);
942	else
943	printUsage(fCategory, fSubCategory, g_pStdErr);
944	#endif /* !VBOX_ONLY_DOCS */
945
946	if (rc == VINF_GETOPT_NOT_OPTION)
947	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
948	if (rc > 0)
949	{
950	if (RT_C_IS_PRINT(rc))
951	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
952	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
953	}
954	if (rc == VERR_GETOPT_UNKNOWN_OPTION)
955	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
956	if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
957	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
958	if (pValueUnion->pDef)
959	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
960	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
961	}
962
963	/**
964	* errorSyntax for RTGetOpt users.
965	*
966	* @returns RTEXITCODE_SYNTAX.
967	*
968	* @param fUsageCategory The usage category of the command.
969	* @param rc The RTGetOpt return code.
970	* @param pValueUnion The value union.
971	*/
972	RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
973	{
974	return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
975	}
976
977	/**
978	* Print an error message without the syntax stuff.
979	*
980	* @returns RTEXITCODE_SYNTAX.
981	*/
982	RTEXITCODE errorArgument(const char *pszFormat, ...)
983	{
984	va_list args;
985	va_start(args, pszFormat);
986	RTMsgErrorV(pszFormat, args);
987	va_end(args);
988	return RTEXITCODE_SYNTAX;
989	}

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

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

Download in other formats: