VBoxManageHelp.cpp revision 5434d84d270a73565d8c3bed826cb4f95aba317b
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * VBoxManage - help and other message output.
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * Copyright (C) 2006-2010 Oracle Corporation
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * available from http://www.virtualbox.org. This file is free software;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * General Public License (GPL) as published by the Free Software
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync/*******************************************************************************
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync* Header Files *
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync*******************************************************************************/
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "All rights reserved.\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fDumpOpts = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fLinux = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fLinux = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fWin = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fWin = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fSolaris = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fSolaris = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fFreeBSD = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fFreeBSD = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fDarwin = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fDarwin = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fVBoxSDL = true;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync bool fVBoxSDL = false;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage [-v|--version] print version number and exit\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " bridgedifs|dhcpservers|hostinfo|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " usbhost|usbfilters|systemproperties|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " extpacks\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--machinereadable]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage showvminfo <uuid>|<name> --log <idx>\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage registervm <filename>\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage unregistervm <uuid>|<name> [--delete]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage createvm --name <name>\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--ostype <ostype>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--register]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--basefolder <path> | --settingsfile <path>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--uuid <uuid>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "VBoxManage modifyvm <uuid|name>\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--name <name>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--ostype <ostype>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--memory <memorysize in MB>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--pagefusion on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--vram <vramsize in MB>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--acpi on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--ioapic on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--pae on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--hpet on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--hwvirtex on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--hwvirtexexcl on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nestedpaging on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--largepages on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--vtxvpid on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--synthcpu on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpuidremove <leaf>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpuidremoveall]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--hardwareuuid <uuid>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpus <number>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpuhotplug on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--plugcpu <id>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--unplugcpu <id>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cpuexecutioncap <1-100>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--rtcuseutc on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--monitorcount <number>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--accelerate3d on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--accelerate2dvideo on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--firmware bios|efi|efi32|efi64]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--chipset ich9|piix3]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--bioslogofadein on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--bioslogofadeout on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--bioslogodisplaytime <msec>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--bioslogoimagepath <imagepath>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--biossystemtimeoffset <msec>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--biospxedebug on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "|hostonly"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nictype<1-N> Am79C970A|Am79C973"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "|\n 82540EM|82543GC|82545EM"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "|\n virtio"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync#endif /* VBOX_WITH_VIRTIO */
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--cableconnected<1-N> on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nictrace<1-N> on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nictracefile<1-N> <filename>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nicspeed<1-N> <kbps>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nicbootprio<1-N> <priority>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--intnet<1-N> <network name>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natnet<1-N> <network>|default]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--vdenet<1-N> <network>|default]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [<sockrcv>],[<tcpsnd>],\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [<tcprcv>]]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " <hostport>,[<guestip>],<guestport>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natpf<1-N> delete <rulename>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nattftpprefix<1-N> <prefix>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nattftpfile<1-N> <file>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nattftpserver<1-N> <ip>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natdnspassdomain<1-N> on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natdnsproxy<1-N> on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--natdnshostresolver<1-N> on|off]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [sameports]]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--macaddress<1-N> auto|<mac>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--mouse ps2|usb|usbtablet\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--keyboard ps2|usb\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--uartmode<1-N> disconnected|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " server <pipe>|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " client <pipe>|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " file <file>|\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " <devicename>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--gueststatisticsinterval <seconds>]\n"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync " [--audio none|null");
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync /* Get the line break sorted when dumping all option variants. */
if (fVBoxSDL)
#if defined(VBOX_WITH_NETFLT)
#ifndef RT_OS_WINDOWS
#ifdef VBOX_WITH_GUEST_PROPS
#ifdef VBOX_WITH_GUEST_CONTROL
#if defined(VBOX_WITH_NETFLT)
# if defined(RT_OS_WINDOWS)
#if defined(VBOX_WITH_NETFLT)
#if defined(VBOX_WITH_NETFLT)
#ifndef VBOX_ONLY_DOCS
if (g_fInternalMode)
return RTEXITCODE_SYNTAX;
RTEXITCODE errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
#ifndef VBOX_ONLY_DOCS
if (g_fInternalMode)
if (rc > 0)
return RTEXITCODE_SYNTAX;