VBoxManageHelp.cpp@ 52037

Last change on this file since 52037 was 52037, checked in by vboxsync, 10 years ago
Frontends/VBoxManage: add the forgotten "modifyvm --description" option to the help output and fix a minor VRDP port info glitch
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 49.2 KB

Line
1	/* $Id: VBoxManageHelp.cpp 52037 2014-07-15 13:07:29Z vboxsync $ */
2	/** @file
3	* VBoxManage - help and other message output.
4	*/
5
6	/*
7	* Copyright (C) 2006-2014 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\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 /* Disabled until the feature is implemented. */
375	" [--autostop-type disabled\|savestate\|poweroff\|\n"
376	" acpishutdown]\n"
377	#endif
378	#ifdef VBOX_WITH_VPX
379	" [--vcpenabled on\|off]\n"
380	" [--vcpscreens [<display>],...\n"
381	" [--vcpfile <filename>]\n"
382	" [--vcpwidth <width>]\n"
383	" [--vcpheight <height>]\n"
384	" [--vcprate <rate>]\n"
385	" [--vcpfps <fps>]\n"
386	#endif
387	" [--defaultfrontend default\|<name>]\n"
388	"\n");
389	}
390
391	if (fCategory & USAGE_CLONEVM)
392	RTStrmPrintf(pStrm,
393	"%s clonevm %s <uuid\|vmname>\n"
394	" [--snapshot <uuid>\|<name>]\n"
395	" [--mode machine\|machineandchildren\|all]\n"
396	" [--options link\|keepallmacs\|keepnatmacs\|\n"
397	" keepdisknames]\n"
398	" [--name <name>]\n"
399	" [--groups <group>, ...]\n"
400	" [--basefolder <basefolder>]\n"
401	" [--uuid <uuid>]\n"
402	" [--register]\n"
403	"\n", SEP);
404
405	if (fCategory & USAGE_IMPORTAPPLIANCE)
406	RTStrmPrintf(pStrm,
407	"%s import %s <ovfname/ovaname>\n"
408	" [--dry-run\|-n]\n"
409	" [--options keepallmacs\|keepnatmacs]\n"
410	" [more options]\n"
411	" (run with -n to have options displayed\n"
412	" for a particular OVF)\n\n", SEP);
413
414	if (fCategory & USAGE_EXPORTAPPLIANCE)
415	RTStrmPrintf(pStrm,
416	"%s export %s <machines> --output\|-o <name>.<ovf/ova>\n"
417	" [--legacy09\|--ovf09\|--ovf10\|--ovf20]\n"
418	" [--manifest]\n"
419	" [--iso]\n"
420	" [--options manifest\|iso\|nomacs\|nomacsbutnat]\n"
421	" [--vsys <number of virtual system>]\n"
422	" [--product <product name>]\n"
423	" [--producturl <product url>]\n"
424	" [--vendor <vendor name>]\n"
425	" [--vendorurl <vendor url>]\n"
426	" [--version <version info>]\n"
427	" [--description <description info>]\n"
428	" [--eula <license text>]\n"
429	" [--eulafile <filename>]\n"
430	"\n", SEP);
431
432	if (fCategory & USAGE_STARTVM)
433	{
434	RTStrmPrintf(pStrm,
435	"%s startvm %s <uuid\|vmname>...\n"
436	" [--type gui", SEP);
437	if (fVBoxSDL)
438	RTStrmPrintf(pStrm, "\|sdl");
439	RTStrmPrintf(pStrm, "\|headless]\n");
440	RTStrmPrintf(pStrm,
441	"\n");
442	}
443
444	if (fCategory & USAGE_CONTROLVM)
445	{
446	RTStrmPrintf(pStrm,
447	"%s controlvm %s <uuid\|vmname>\n"
448	" pause\|resume\|reset\|poweroff\|savestate\|\n"
449	" acpipowerbutton\|acpisleepbutton\|\n"
450	" keyboardputscancode <hex> [<hex> ...]\|\n"
451	" setlinkstate<1-N> on\|off \|\n"
452	#if defined(VBOX_WITH_NETFLT)
453	" nic<1-N> null\|nat\|bridged\|intnet\|hostonly\|generic\|\n"
454	" natnetwork [<devicename>] \|\n"
455	#else /* !VBOX_WITH_NETFLT */
456	" nic<1-N> null\|nat\|bridged\|intnet\|generic\|natnetwork\n"
457	" [<devicename>] \|\n"
458	#endif /* !VBOX_WITH_NETFLT */
459	" nictrace<1-N> on\|off \|\n"
460	" nictracefile<1-N> <filename> \|\n"
461	" nicproperty<1-N> name=[value] \|\n"
462	" nicpromisc<1-N> deny\|allow-vms\|allow-all \|\n"
463	" natpf<1-N> [<rulename>],tcp\|udp,[<hostip>],\n"
464	" <hostport>,[<guestip>],<guestport> \|\n"
465	" natpf<1-N> delete <rulename> \|\n"
466	" guestmemoryballoon <balloonsize in MB> \|\n"
467	" usbattach <uuid>\|<address> \|\n"
468	" usbdetach <uuid>\|<address> \|\n"
469	" clipboard disabled\|hosttoguest\|guesttohost\|\n"
470	" bidirectional \|\n"
471	" draganddrop disabled\|hosttoguest \|\n"
472	" vrde on\|off \|\n"
473	" vrdeport <port> \|\n"
474	" vrdeproperty <name=[value]> \|\n"
475	" vrdevideochannelquality <percent> \|\n"
476	" setvideomodehint <xres> <yres> <bpp>\n"
477	" [[<display>] [<enabled:yes\|no> \|\n"
478	" [<xorigin> <yorigin>]]] \|\n"
479	" screenshotpng <file> [display] \|\n"
480	" vcpenabled on\|off \|\n"
481	" vcpscreens all\|none\|<screen>,[<screen>...] \|\n"
482	" setcredentials <username>\n"
483	" --passwordfile <file> \| <password>\n"
484	" <domain>\n"
485	" [--allowlocallogon <yes\|no>] \|\n"
486	" teleport --host <name> --port <port>\n"
487	" [--maxdowntime <msec>]\n"
488	" [--passwordfile <file> \|\n"
489	" --password <password>] \|\n"
490	" plugcpu <id> \|\n"
491	" unplugcpu <id> \|\n"
492	" cpuexecutioncap <1-100>\n"
493	" webcam <attach [path [settings]]> \| <detach [path]> \| <list>\n"
494	"\n", SEP);
495	}
496
497	if (fCategory & USAGE_DISCARDSTATE)
498	RTStrmPrintf(pStrm,
499	"%s discardstate %s <uuid\|vmname>\n"
500	"\n", SEP);
501
502	if (fCategory & USAGE_ADOPTSTATE)
503	RTStrmPrintf(pStrm,
504	"%s adoptstate %s <uuid\|vmname> <state_file>\n"
505	"\n", SEP);
506
507	if (fCategory & USAGE_SNAPSHOT)
508	RTStrmPrintf(pStrm,
509	"%s snapshot %s <uuid\|vmname>\n"
510	" take <name> [--description <desc>] [--live] \|\n"
511	" delete <uuid\|snapname> \|\n"
512	" restore <uuid\|snapname> \|\n"
513	" restorecurrent \|\n"
514	" edit <uuid\|snapname>\|--current\n"
515	" [--name <name>]\n"
516	" [--description <desc>] \|\n"
517	" list [--details\|--machinereadable]\n"
518	" showvminfo <uuid\|snapname>\n"
519	"\n", SEP);
520
521	if (fCategory & USAGE_CLOSEMEDIUM)
522	RTStrmPrintf(pStrm,
523	"%s closemedium %s disk\|dvd\|floppy <uuid\|filename>\n"
524	" [--delete]\n"
525	"\n", SEP);
526
527	if (fCategory & USAGE_STORAGEATTACH)
528	RTStrmPrintf(pStrm,
529	"%s storageattach %s <uuid\|vmname>\n"
530	" --storagectl <name>\n"
531	" [--port <number>]\n"
532	" [--device <number>]\n"
533	" [--type dvddrive\|hdd\|fdd]\n"
534	" [--medium none\|emptydrive\|additions\|\n"
535	" <uuid\|filename>\|host:<drive>\|iscsi]\n"
536	" [--mtype normal\|writethrough\|immutable\|shareable\|\n"
537	" readonly\|multiattach]\n"
538	" [--comment <text>]\n"
539	" [--setuuid <uuid>]\n"
540	" [--setparentuuid <uuid>]\n"
541	" [--passthrough on\|off]\n"
542	" [--tempeject on\|off]\n"
543	" [--nonrotational on\|off]\n"
544	" [--discard on\|off]\n"
545	" [--hotpluggable on\|off]\n"
546	" [--bandwidthgroup <name>]\n"
547	" [--forceunmount]\n"
548	" [--server <name>\|<ip>]\n"
549	" [--target <target>]\n"
550	" [--tport <port>]\n"
551	" [--lun <lun>]\n"
552	" [--encodedlun <lun>]\n"
553	" [--username <username>]\n"
554	" [--password <password>]\n"
555	" [--initiator <initiator>]\n"
556	" [--intnet]\n"
557	"\n", SEP);
558
559	if (fCategory & USAGE_STORAGECONTROLLER)
560	RTStrmPrintf(pStrm,
561	"%s storagectl %s <uuid\|vmname>\n"
562	" --name <name>\n"
563	" [--add ide\|sata\|scsi\|floppy\|sas]\n"
564	" [--controller LSILogic\|LSILogicSAS\|BusLogic\|\n"
565	" IntelAHCI\|PIIX3\|PIIX4\|ICH6\|I82078]\n"
566	" [--portcount <1-n>]\n"
567	" [--hostiocache on\|off]\n"
568	" [--bootable on\|off]\n"
569	" [--remove]\n"
570	"\n", SEP);
571
572	if (fCategory & USAGE_BANDWIDTHCONTROL)
573	RTStrmPrintf(pStrm,
574	"%s bandwidthctl %s <uuid\|vmname>\n"
575	" add <name> --type disk\|network\n"
576	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
577	" set <name>\n"
578	" --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|\n"
579	" remove <name> \|\n"
580	" list [--machinereadable]\n"
581	" (limit units: k=kilobit, m=megabit, g=gigabit,\n"
582	" K=kilobyte, M=megabyte, G=gigabyte)\n"
583	"\n", SEP);
584
585	if (fCategory & USAGE_SHOWHDINFO)
586	RTStrmPrintf(pStrm,
587	"%s showhdinfo %s <uuid\|filename>\n"
588	"\n", SEP);
589
590	if (fCategory & USAGE_CREATEHD)
591	RTStrmPrintf(pStrm,
592	"%s createhd %s --filename <filename>\n"
593	" [--size <megabytes>\|--sizebyte <bytes>]\n"
594	" [--diffparent <uuid>\|<filename>\n"
595	" [--format VDI\|VMDK\|VHD] (default: VDI)\n"
596	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
597	"\n", SEP);
598
599	if (fCategory & USAGE_MODIFYHD)
600	RTStrmPrintf(pStrm,
601	"%s modifyhd %s <uuid\|filename>\n"
602	" [--type normal\|writethrough\|immutable\|shareable\|\n"
603	" readonly\|multiattach]\n"
604	" [--autoreset on\|off]\n"
605	" [--property <name=[value]>]\n"
606	" [--compact]\n"
607	" [--resize <megabytes>\|--resizebyte <bytes>]\n"
608	"\n", SEP);
609
610	if (fCategory & USAGE_CLONEHD)
611	RTStrmPrintf(pStrm,
612	"%s clonehd %s <uuid\|inputfile> <uuid\|outputfile>\n"
613	" [--format VDI\|VMDK\|VHD\|RAW\|<other>]\n"
614	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
615	" [--existing]\n"
616	"\n", SEP);
617
618	if (fCategory & USAGE_HDPROPERTY)
619	RTStrmPrintf(pStrm,
620	"%s hdproperty %s set <uuid\|filename>\n"
621	" <property> <value>\n"
622	"\n"
623	" get <uuid\|filename>\n"
624	" <property>\n"
625	"\n"
626	" delete <uuid\|filename>\n"
627	" <property>\n"
628	"\n", SEP);
629
630	if (fCategory & USAGE_CONVERTFROMRAW)
631	RTStrmPrintf(pStrm,
632	"%s convertfromraw %s <filename> <outputfile>\n"
633	" [--format VDI\|VMDK\|VHD]\n"
634	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
635	" [--uuid <uuid>]\n"
636	"%s convertfromraw %s stdin <outputfile> <bytes>\n"
637	" [--format VDI\|VMDK\|VHD]\n"
638	" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
639	" [--uuid <uuid>]\n"
640	"\n", SEP, SEP);
641
642	if (fCategory & USAGE_GETEXTRADATA)
643	RTStrmPrintf(pStrm,
644	"%s getextradata %s global\|<uuid\|vmname>\n"
645	" <key>\|enumerate\n"
646	"\n", SEP);
647
648	if (fCategory & USAGE_SETEXTRADATA)
649	RTStrmPrintf(pStrm,
650	"%s setextradata %s global\|<uuid\|vmname>\n"
651	" <key>\n"
652	" [<value>] (no value deletes key)\n"
653	"\n", SEP);
654
655	if (fCategory & USAGE_SETPROPERTY)
656	RTStrmPrintf(pStrm,
657	"%s setproperty %s machinefolder default\|<folder> \|\n"
658	" hwvirtexclusive on\|off \|\n"
659	" vrdeauthlibrary default\|<library> \|\n"
660	" websrvauthlibrary default\|null\|<library> \|\n"
661	" vrdeextpack null\|<library> \|\n"
662	" autostartdbpath null\|<folder> \|\n"
663	" loghistorycount <value>\n"
664	" defaultfrontend default\|<name>\n"
665	"\n", SEP);
666
667	if (fCategory & USAGE_USBFILTER_ADD)
668	RTStrmPrintf(pStrm,
669	"%s usbfilter %s add <index,0-N>\n"
670	" --target <uuid\|vmname>\|global\n"
671	" --name <string>\n"
672	" --action ignore\|hold (global filters only)\n"
673	" [--active yes\|no] (yes)\n"
674	" [--vendorid <XXXX>] (null)\n"
675	" [--productid <XXXX>] (null)\n"
676	" [--revision <IIFF>] (null)\n"
677	" [--manufacturer <string>] (null)\n"
678	" [--product <string>] (null)\n"
679	" [--remote yes\|no] (null, VM filters only)\n"
680	" [--serialnumber <string>] (null)\n"
681	" [--maskedinterfaces <XXXXXXXX>]\n"
682	"\n", SEP);
683
684	if (fCategory & USAGE_USBFILTER_MODIFY)
685	RTStrmPrintf(pStrm,
686	"%s usbfilter %s modify <index,0-N>\n"
687	" --target <uuid\|vmname>\|global\n"
688	" [--name <string>]\n"
689	" [--action ignore\|hold] (global filters only)\n"
690	" [--active yes\|no]\n"
691	" [--vendorid <XXXX>\|\"\"]\n"
692	" [--productid <XXXX>\|\"\"]\n"
693	" [--revision <IIFF>\|\"\"]\n"
694	" [--manufacturer <string>\|\"\"]\n"
695	" [--product <string>\|\"\"]\n"
696	" [--remote yes\|no] (null, VM filters only)\n"
697	" [--serialnumber <string>\|\"\"]\n"
698	" [--maskedinterfaces <XXXXXXXX>]\n"
699	"\n", SEP);
700
701	if (fCategory & USAGE_USBFILTER_REMOVE)
702	RTStrmPrintf(pStrm,
703	"%s usbfilter %s remove <index,0-N>\n"
704	" --target <uuid\|vmname>\|global\n"
705	"\n", SEP);
706
707	if (fCategory & USAGE_SHAREDFOLDER_ADD)
708	RTStrmPrintf(pStrm,
709	"%s sharedfolder %s add <uuid\|vmname>\n"
710	" --name <name> --hostpath <hostpath>\n"
711	" [--transient] [--readonly] [--automount]\n"
712	"\n", SEP);
713
714	if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
715	RTStrmPrintf(pStrm,
716	"%s sharedfolder %s remove <uuid\|vmname>\n"
717	" --name <name> [--transient]\n"
718	"\n", SEP);
719
720	#ifdef VBOX_WITH_GUEST_PROPS
721	if (fCategory & USAGE_GUESTPROPERTY)
722	usageGuestProperty(pStrm, SEP);
723	#endif /* VBOX_WITH_GUEST_PROPS defined */
724
725	#ifdef VBOX_WITH_GUEST_CONTROL
726	if (fCategory & USAGE_GUESTCONTROL)
727	usageGuestControl(pStrm, SEP, fSubCategory);
728	#endif /* VBOX_WITH_GUEST_CONTROL defined */
729
730	if (fCategory & USAGE_DEBUGVM)
731	{
732	RTStrmPrintf(pStrm,
733	"%s debugvm %s <uuid\|vmname>\n"
734	" dumpguestcore --filename <name> \|\n"
735	" info <item> [args] \|\n"
736	" injectnmi \|\n"
737	" log [--release\|--debug] <settings> ...\|\n"
738	" logdest [--release\|--debug] <settings> ...\|\n"
739	" logflags [--release\|--debug] <settings> ...\|\n"
740	" osdetect \|\n"
741	" osinfo \|\n"
742	" getregisters [--cpu <id>] <reg>\|all ... \|\n"
743	" setregisters [--cpu <id>] <reg>=<value> ... \|\n"
744	" show [--human-readable\|--sh-export\|--sh-eval\|\n"
745	" --cmd-set] \n"
746	" <logdbg-settings\|logrel-settings>\n"
747	" [[opt] what ...] \|\n"
748	" statistics [--reset] [--pattern <pattern>]\n"
749	" [--descriptions]\n"
750	"\n", SEP);
751	}
752	if (fCategory & USAGE_METRICS)
753	RTStrmPrintf(pStrm,
754	"%s metrics %s list [*\|host\|<vmname> [<metric_list>]]\n"
755	" (comma-separated)\n\n"
756	"%s metrics %s setup\n"
757	" [--period <seconds>] (default: 1)\n"
758	" [--samples <count>] (default: 1)\n"
759	" [--list]\n"
760	" [*\|host\|<vmname> [<metric_list>]]\n\n"
761	"%s metrics %s query [*\|host\|<vmname> [<metric_list>]]\n\n"
762	"%s metrics %s enable\n"
763	" [--list]\n"
764	" [*\|host\|<vmname> [<metric_list>]]\n\n"
765	"%s metrics %s disable\n"
766	" [--list]\n"
767	" [*\|host\|<vmname> [<metric_list>]]\n\n"
768	"%s metrics %s collect\n"
769	" [--period <seconds>] (default: 1)\n"
770	" [--samples <count>] (default: 1)\n"
771	" [--list]\n"
772	" [--detach]\n"
773	" [*\|host\|<vmname> [<metric_list>]]\n"
774	"\n", SEP, SEP, SEP, SEP, SEP, SEP);
775
776	#if defined(VBOX_WITH_NAT_SERVICE)
777	if (fCategory & USAGE_NATNETWORK)
778	{
779	RTStrmPrintf(pStrm,
780	"%s natnetwork %s add --netname <name>\n"
781	" --network <network>\n"
782	" [--enable\|--disable]\n"
783	" [--dhcp on\|off]\n"
784	" [--port-forward-4 <rule>]\n"
785	" [--loopback-4 <rule>]\n"
786	" [--ipv6 on\|off]\n"
787	" [--port-forward-6 <rule>]\n"
788	" [--loopback-6 <rule>]\n\n"
789	"%s natnetwork %s remove --netname <name>\n\n"
790	"%s natnetwork %s modify --netname <name>\n"
791	" [--network <network>]\n"
792	" [--enable\|--disable]\n"
793	" [--dhcp on\|off]\n"
794	" [--port-forward-4 <rule>]\n"
795	" [--loopback-4 <rule>]\n"
796	" [--ipv6 on\|off]\n"
797	" [--port-forward-6 <rule>]\n"
798	" [--loopback-6 <rule>]\n\n"
799	"%s natnetwork %s start --netname <name>\n\n"
800	"%s natnetwork %s stop --netname <name>\n"
801	"\n", SEP, SEP, SEP, SEP, SEP);
802
803
804	}
805	#endif
806
807	#if defined(VBOX_WITH_NETFLT)
808	if (fCategory & USAGE_HOSTONLYIFS)
809	{
810	RTStrmPrintf(pStrm,
811	"%s hostonlyif %s ipconfig <name>\n"
812	" [--dhcp \|\n"
813	" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] \|\n"
814	" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
815	# if !defined(RT_OS_SOLARIS)
816	" create \|\n"
817	" remove <name>\n"
818	# endif
819	"\n", SEP);
820	}
821	#endif
822
823	if (fCategory & USAGE_DHCPSERVER)
824	{
825	RTStrmPrintf(pStrm,
826	"%s dhcpserver %s add\|modify --netname <network_name> \|\n"
827	#if defined(VBOX_WITH_NETFLT)
828	" --ifname <hostonly_if_name>\n"
829	#endif
830	" [--ip <ip_address>\n"
831	" --netmask <network_mask>\n"
832	" --lowerip <lower_ip>\n"
833	" --upperip <upper_ip>]\n"
834	" [--enable \| --disable]\n\n"
835	"%s dhcpserver %s remove --netname <network_name> \|\n"
836	#if defined(VBOX_WITH_NETFLT)
837	" --ifname <hostonly_if_name>\n"
838	#endif
839	"\n", SEP, SEP);
840	}
841	if (fCategory & USAGE_EXTPACK)
842	{
843	RTStrmPrintf(pStrm,
844	"%s extpack %s install [--replace] <tarball> \|\n"
845	" uninstall [--force] <name> \|\n"
846	" cleanup\n"
847	"\n", SEP);
848	}
849	}
850
851	/**
852	* Print a usage synopsis and the syntax error message.
853	* @returns RTEXITCODE_SYNTAX.
854	*/
855	RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
856	{
857	va_list args;
858	showLogo(g_pStdErr); // show logo even if suppressed
859	#ifndef VBOX_ONLY_DOCS
860	if (g_fInternalMode)
861	printUsageInternal(fCategory, g_pStdErr);
862	else
863	printUsage(fCategory, ~0U, g_pStdErr);
864	#endif /* !VBOX_ONLY_DOCS */
865	va_start(args, pszFormat);
866	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
867	va_end(args);
868	return RTEXITCODE_SYNTAX;
869	}
870
871	/**
872	* Print a usage synopsis and the syntax error message.
873	* @returns RTEXITCODE_SYNTAX.
874	*/
875	RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
876	{
877	va_list args;
878	showLogo(g_pStdErr); // show logo even if suppressed
879	#ifndef VBOX_ONLY_DOCS
880	if (g_fInternalMode)
881	printUsageInternal(fCategory, g_pStdErr);
882	else
883	printUsage(fCategory, fSubCategory, g_pStdErr);
884	#endif /* !VBOX_ONLY_DOCS */
885	va_start(args, pszFormat);
886	RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
887	va_end(args);
888	return RTEXITCODE_SYNTAX;
889	}
890
891	/**
892	* errorSyntax for RTGetOpt users.
893	*
894	* @returns RTEXITCODE_SYNTAX.
895	*
896	* @param fCategory The usage category of the command.
897	* @param fSubCategory The usage sub-category of the command.
898	* @param rc The RTGetOpt return code.
899	* @param pValueUnion The value union.
900	*/
901	RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
902	{
903	/*
904	* Check if it is an unhandled standard option.
905	*/
906	if (rc == 'V')
907	{
908	RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
909	return RTEXITCODE_SUCCESS;
910	}
911
912	if (rc == 'h')
913	{
914	showLogo(g_pStdErr);
915	#ifndef VBOX_ONLY_DOCS
916	if (g_fInternalMode)
917	printUsageInternal(fCategory, g_pStdOut);
918	else
919	printUsage(fCategory, fSubCategory, g_pStdOut);
920	#endif
921	return RTEXITCODE_SUCCESS;
922	}
923
924	/*
925	* General failure.
926	*/
927	showLogo(g_pStdErr); // show logo even if suppressed
928	#ifndef VBOX_ONLY_DOCS
929	if (g_fInternalMode)
930	printUsageInternal(fCategory, g_pStdErr);
931	else
932	printUsage(fCategory, fSubCategory, g_pStdErr);
933	#endif /* !VBOX_ONLY_DOCS */
934
935	if (rc == VINF_GETOPT_NOT_OPTION)
936	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
937	if (rc > 0)
938	{
939	if (RT_C_IS_PRINT(rc))
940	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
941	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
942	}
943	if (rc == VERR_GETOPT_UNKNOWN_OPTION)
944	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
945	if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
946	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
947	if (pValueUnion->pDef)
948	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
949	return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
950	}
951
952	/**
953	* errorSyntax for RTGetOpt users.
954	*
955	* @returns RTEXITCODE_SYNTAX.
956	*
957	* @param fUsageCategory The usage category of the command.
958	* @param rc The RTGetOpt return code.
959	* @param pValueUnion The value union.
960	*/
961	RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
962	{
963	return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
964	}
965
966	/**
967	* Print an error message without the syntax stuff.
968	*
969	* @returns RTEXITCODE_SYNTAX.
970	*/
971	RTEXITCODE errorArgument(const char *pszFormat, ...)
972	{
973	va_list args;
974	va_start(args, pszFormat);
975	RTMsgErrorV(pszFormat, args);
976	va_end(args);
977	return RTEXITCODE_SYNTAX;
978	}

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

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

Download in other formats: