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