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