VBoxManageHelp.cpp revision 2355157d3ea6596738c7c74e803220ad1bd6b4a8
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync * Copyright (C) 2006-2010 Oracle Corporation
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * available from http://www.virtualbox.org. This file is free software;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * General Public License (GPL) as published by the Free Software
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync/*******************************************************************************
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync* Header Files *
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync*******************************************************************************/
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "All rights reserved.\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync bool fDumpOpts = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = false;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
3933885bc0c2c93436d858a14564c6179ec72872vboxsync bool fVRDE = true;
3933885bc0c2c93436d858a14564c6179ec72872vboxsync bool fVRDE = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = false;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage [-v|--version] print version number and exit\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " bridgedifs|dhcpservers|hostinfo|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " usbhost|usbfilters|systemproperties\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--machinereadable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage showvminfo <uuid>|<name> --log <idx>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage registervm <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage unregistervm <uuid>|<name> [--delete]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage createvm --name <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--register]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--basefolder <path> | --settingsfile <path>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage modifyvm <uuid|name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--memory <memorysize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pagefusion on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vram <vramsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--acpi on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ioapic on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pae on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hpet on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hwvirtex on|off]\n"
85bc82f92f4d7a7b95e96d133c4847b2847703dfvboxsync " [--hwvirtexexcl on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nestedpaging on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--largepages on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vtxvpid on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--synthcpu on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremove <leaf>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremoveall]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hardwareuuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpus <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuhotplug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--plugcpu <id>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--unplugcpu <id>]\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " [--cpuexecutioncap <1-100>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--rtcuseutc on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--monitorcount <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate3d on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate2dvideo on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--firmware bios|efi|efi32|efi64]\n"
7a29aa5ce149ccd344a2929d2815b8e212690b92vboxsync " [--chipset ich9|piix3]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogofadein on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogofadeout on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogodisplaytime <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogoimagepath <imagepath>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biossystemtimeoffset <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biospxedebug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|hostonly"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictype<1-N> Am79C970A|Am79C973"
5453eb2f2719bf3895ac3daeec4c26e0b6e2eb4avboxsync "|\n 82540EM|82543GC|82545EM"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n virtio"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#endif /* VBOX_WITH_VIRTIO */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cableconnected<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictrace<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictracefile<1-N> <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicspeed<1-N> <kbps>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicbootprio<1-N> <priority>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet<1-N> <network name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natnet<1-N> <network>|default]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vdenet<1-N> <network>|default]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<sockrcv>],[<tcpsnd>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<tcprcv>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <hostport>,[<guestip>],<guestport>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natpf<1-N> delete <rulename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpprefix<1-N> <prefix>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpfile<1-N> <file>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpserver<1-N> <ip>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnspassdomain<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnsproxy<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnshostresolver<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [sameports]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--macaddress<1-N> auto|<mac>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--mouse ps2|usb|usbtablet\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--keyboard ps2|usb\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uartmode<1-N> disconnected|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " server <pipe>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " client <pipe>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " file <file>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--gueststatisticsinterval <seconds>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--audio none|null");
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync /* Get the line break sorted when dumping all option variants. */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--audiocontroller ac97|hda|sb16]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " bidirectional]\n");
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrde on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdesetproperty <name=[value]>]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdeauthtype null|external|guest]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdemulticon on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdereusecon on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdevideochannel on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdevideochannelquality <percent>]\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usb on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usbehci on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--snapshotfolder default|<path>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporter on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterport <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporteraddress <address|empty>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterpassword <password>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocachesize <I/O cache size in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerance master|standby]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttoleranceaddress <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttoleranceport <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerancesyncinterval <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerancepassword <password>]\n"
2355157d3ea6596738c7c74e803220ad1bd6b4a8vboxsync "VBoxManage import <ovf/ova> [--dry-run|-n] [more options]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " (run with -n to have options displayed\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " for a particular OVF)\n\n");
2355157d3ea6596738c7c74e803220ad1bd6b4a8vboxsync "VBoxManage export <machines> --output|-o <ovf/ova>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--legacy09]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manifest]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vsys <number of virtual system>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <product name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--producturl <product url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendor <vendor name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorurl <vendor url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--version <version info>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eula <license text>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eulafile <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage startvm <uuid>|<name>\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type gui");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage controlvm <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " pause|resume|reset|poweroff|savestate|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " acpipowerbutton|acpisleepbutton|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " injectnmi|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setlinkstate<1-N> on|off |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nic<1-N> null|nat|bridged|intnet|hostonly\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<devicename>] |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nic<1-N> null|nat|bridged|intnet\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<devicename>] |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nictrace<1-N> on|off\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nictracefile<1-N> <filename>\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif /* VBOX_DYNAMIC_NET_ATTACH */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " guestmemoryballoon <balloonsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " gueststatisticsinterval <seconds>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " usbattach <uuid>|<address> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " usbdetach <uuid>|<address> |\n");
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrde on|off |\n");
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdesetproperty <name=[value]> |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdevideochannelquality <percent>\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setvideomodehint <xres> <yres> <bpp> [display] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setcredentials <username> <password> <domain>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--allowlocallogon <yes|no>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " teleport --host <name> --port <port>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maxdowntime <msec>] [--password password]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " plugcpu <id>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " unplugcpu <id>\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " cpuexecutioncap <1-100>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage discardstate <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage adoptstate <uuid>|<name> <state_file>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage snapshot <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " take <name> [--description <desc>] [--pause] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " delete <uuid>|<name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " restore <uuid>|<name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " restorecurrent |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " edit <uuid>|<name>|--current\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--description <desc>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " showvminfo <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage openmedium disk|dvd|floppy <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|immutable|writethrough|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " shareable] (disk only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--parentuuid <uuid>] (disk only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--delete]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage storageattach <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --storagectl <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --port <number>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --device <number>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type dvddrive|hdd|fdd]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--medium none|emptydrive|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <uuid>|<filename>|host:<drive>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--passthrough on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--forceunmount]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage storagectl <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--add ide|sata|scsi|floppy|sas]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--sataideemulation<1-4> <1-30>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--sataportcount <1-30>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostiocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remove]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage showhdinfo <uuid>|<filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage createhd --filename <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --size <megabytes>|--sizebyte <bytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " shareable] (default: normal)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--comment <comment>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remember]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage modifyhd <uuid>|<filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable|shareable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--autoreset on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--compact]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--resize <megabytes>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable|shareable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remember] [--existing]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage convertfromraw <filename> <outputfile>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage addiscsidisk --server <name>|<ip>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <target>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--port <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--lun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--encodedlun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--username <username>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--password <password>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable|shareable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage getextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>|enumerate\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage setextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<value>] (no value deletes key)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage setproperty hdfolder default|<folder> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " machinefolder default|<folder> |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdeauthlibrary default|<library> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " websrvauthlibrary default|null|<library> |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdelibrary null|<library> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " loghistorycount <value>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter add <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <string>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --action ignore|hold (global filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--active yes|no] (yes)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--revision <IIFF>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manufacturer <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter modify <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <string>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--action ignore|hold] (global filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--active yes|no]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--revision <IIFF>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manufacturer <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter remove <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage sharedfolder add <vmname>|<uuid>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> --hostpath <hostpath>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--transient] [--readonly] [--automount]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage sharedfolder remove <vmname>|<uuid>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> [--transient]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pattern <pattern>] [--descriptions]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
d450629f624308cb06e59a13554c697afea563d8vboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " (comma-separated)\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics setup\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics enable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics disable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics collect\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--detach]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage hostonlyif ipconfig <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--dhcp |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " create |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " remove <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage dhcpserver add|modify --netname <network_name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ip <ip_address>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --netmask <network_mask>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --lowerip <lower_ip>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --upperip <upper_ip>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--enable | --disable]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print a usage synopsis and the syntax error message.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync showLogo(g_pStdErr); // show logo even if suppressed
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* !VBOX_ONLY_DOCS */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * errorSyntax for RTGetOpt users.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @returns 1.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param fUsageCategory The usage category of the command.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param rc The RTGetOpt return code.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param pValueUnion The value union.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsyncint errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync showLogo(g_pStdErr); // show logo even if suppressed
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#endif /* !VBOX_ONLY_DOCS */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return RTMsgError("Invalid parameter '%s'", pValueUnion->psz);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return RTMsgError("Unknown option: %s", pValueUnion->psz);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return RTMsgError("%s: %Rrs", pValueUnion->pDef->pszLong, rc);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print an error message without the syntax stuff.