VBoxManageHelp.cpp revision 49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6b
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
5d39cab83ac9a6c6e4c5da4690ac53b4cfec73aavboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync *
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.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync *
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync * additional information or have any questions.
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync */
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#include <iprt/stream.h>
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#include <iprt/getopt.h>
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include "VBoxManage.h"
e0778e583cb4a0bdc9bcc48f5957e00a01108388vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid printUsage(USAGECATEGORY u64Cmd)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_LINUX
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync bool fLinux = false;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#endif
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#ifdef RT_OS_WINDOWS
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync bool fWin = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#else
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync bool fWin = false;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#endif
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#ifdef RT_OS_SOLARIS
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync bool fSolaris = true;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#else
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync bool fSolaris = false;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef RT_OS_DARWIN
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync bool fDarwin = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#else
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync bool fDarwin = false;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#endif
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#ifdef VBOX_WITH_VRDP
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = true;
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VBOXSDL
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fVRDP = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync fVBoxSDL = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync u64Cmd = USAGE_ALL;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync }
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTPrintf("Usage:\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage [-v|--version] print version number and exit\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync "\n");
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync }
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (u64Cmd & USAGE_LIST)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " bridgedifs|hostinfo|dhcpservers|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync " hddbackends|hdds|dvds|floppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbhost|usbfilters|systemproperties\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHOWVMINFO)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--machinereadable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_REGISTERVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage registervm <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_UNREGISTERVM)
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage unregistervm <uuid>|<name> [--delete]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CREATEVM)
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage createvm --name <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--ostype <ostype>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--register]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--basefolder <path> | --settingsfile <path>]\n"
66b8ee000e49b0cc08a897451350cd6927d77b60vboxsync " [--uuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTPrintf("VBoxManage modifyvm <uuid|name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--memory <memorysize in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vram <vramsize in MB>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--acpi on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ioapic on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pae on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--hwvirtex on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nestedpaging on|off]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--vtxvpid on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpus <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--monitorcount <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate3d <on|off>]\n"
7e8d44e04156d78379666f20d5daa2a79e5cbf44vboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate2dvideo <on|off>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogofadein on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogofadeout on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogodisplaytime <msec>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--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 " [--hd<a|b|d> none|<uuid>|<filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--idecontroller PIIX3|PIIX4]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_AHCI
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync " [--sata on|off]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--sataportcount <1-30>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--sataport<1-30> none|<uuid>|<filename>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--sataideemulation<1-4> <1-30>]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_SCSI
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--scsi on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--scsiport<1-16> none|<uuid>|<filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--scsitype LsiLogic|BusLogic]\n"
85bc82f92f4d7a7b95e96d133c4847b2847703dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--dvd none|<uuid>|<filename>|host:<drive>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--dvdpassthrough on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--floppy disabled|empty|<uuid>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <filename>|host:<drive>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nic<1-N> none|null|nat|bridged|intnet|hostonly]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nic<1-N> none|null|nat|bridged|intnet]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictype<1-N> Am79C970A|Am79C973"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_E1000
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n 82540EM|82543GC|82545EM"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cableconnected<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictrace<1-N> on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [--nictracefile<1-N> <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicspeed<1-N> <kbps>]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
7a29aa5ce149ccd344a2929d2815b8e212690b92vboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet<1-N> <network name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natnet<1-N> <network>|default]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--macaddress<1-N> auto|<mac>]\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"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " <devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_MEM_BALLOONING
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--gueststatisticsinterval <seconds>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf(" [--audio none|null");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fWin)
5453eb2f2719bf3895ac3daeec4c26e0b6e2eb4avboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_WINMM
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync RTPrintf( "|winmm|dsound");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#else
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync RTPrintf( "|dsound");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fSolaris)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync RTPrintf( "|solaudio"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_SOLARIS_OSS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|oss"
b604fbf16eda38d14b4999c245f032bfaa5aa85avboxsync#endif
93c114476cca834cde109c60bfb95094fcd2c995vboxsync );
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync if (fLinux)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync RTPrintf( "|oss"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_ALSA
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|alsa"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_PULSE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|pulse"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fDarwin)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf( "|coreaudio");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync RTPrintf( "]\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf(" [--audiocontroller ac97|sb16]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " bidirectional]\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fVRDP)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf(" [--vrdp on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpport default|<port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpaddress <host>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpauthtype null|external|guest]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpmulticon on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpreusecon on|off]\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf(" [--usb on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usbehci on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--snapshotfolder default|<path>]\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTPrintf("VBoxManage import <ovf> [--dry-run|-n] [more options]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " (run with -n to have options displayed for a particular OVF)\n\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage export <machines> --output|-o <ovf>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--legacy09]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--vsys <number of virtual system>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <product name>]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--producturl <product url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendor <vendor name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vendorurl <vendor url>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--version <version info>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--eula <license text>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--eulafile <filename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync if (u64Cmd & USAGE_STARTVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTPrintf("VBoxManage startvm <uuid>|<name>\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf(" [--type gui");
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync if (fVBoxSDL)
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTPrintf( "|sdl");
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync if (fVRDP)
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync RTPrintf( "|vrdp");
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync RTPrintf( "|headless]\n");
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync RTPrintf("\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync if (u64Cmd & USAGE_CONTROLVM)
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTPrintf("VBoxManage controlvm <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " pause|resume|reset|poweroff|savestate|\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " acpipowerbutton|acpisleepbutton|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " injectnmi|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " setlinkstate<1-N> on|off |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_DYNAMIC_NET_ATTACH
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " nic<1-N> null|nat|bridged|intnet|hostonly\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [<devicename>] |\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nic<1-N> null|nat|bridged|intnet\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<devicename>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync#endif /* VBOX_DYNAMIC_NET_ATTACH */
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " usbattach <uuid>|<address> |\n"
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync " usbdetach <uuid>|<address> |\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " dvdattach none|<uuid>|<filename>|host:<drive> |\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " floppyattach none|<uuid>|<filename>|host:<drive> |\n");
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync if (fVRDP)
3933885bc0c2c93436d858a14564c6179ec72872vboxsync {
6e25221ce8ef8e656d1e15eb7ec5cf8ae758ceb2vboxsync RTPrintf(" vrdp on|off] |\n");
3933885bc0c2c93436d858a14564c6179ec72872vboxsync }
3933885bc0c2c93436d858a14564c6179ec72872vboxsync RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]|\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " setcredentials <username> <password> <domain>\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--allowlocallogon <yes|no>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_DISCARDSTATE)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage discardstate <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_ADOPTSTATE)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SNAPSHOT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage snapshot <uuid>|<name>\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync " take <name> [--description <desc>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " discard <uuid>|<name> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " discardcurrent --state|--all |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " edit <uuid>|<name>|--current\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--name <name>]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--description <desc>] |\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " showvminfo <uuid>|<name>\n"
776985d1f8ee71ad78aa1067cce88766803c7b30vboxsync "\n");
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync }
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync if (u64Cmd & USAGE_OPENMEDIUM)
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync {
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync RTPrintf("VBoxManage openmedium disk|dvd|floppy <filename>\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--type normal|immutable|writethrough] (disk only)\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync "\n");
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync }
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
8ae161fca703d669e1306fafee128914f831f72bvboxsync RTPrintf("VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync "\n");
8ae161fca703d669e1306fafee128914f831f72bvboxsync }
8ae161fca703d669e1306fafee128914f831f72bvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SHOWHDINFO)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync RTPrintf("VBoxManage showhdinfo <uuid>|<filename>\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
2355157d3ea6596738c7c74e803220ad1bd6b4a8vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CREATEHD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage createhd --filename <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --size <megabytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough] (default: normal)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--comment <comment>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remember]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTPrintf("VBoxManage modifyhd <uuid>|<filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--autoreset on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--compact]\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_CLONEHD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type normal|writethrough|immutable]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--remember] [--existing]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync RTPrintf("VBoxManage convertfromraw <filename> <outputfile>\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--format VDI|VMDK|VHD]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--format VDI|VMDK|VHD]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_ADDISCSIDISK)
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync {
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync RTPrintf("VBoxManage addiscsidisk --server <name>|<ip>\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync " --target <target>\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync " [--port <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--lun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--encodedlun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--username <username>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--password <password>]\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--type normal|writethrough|immutable]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--comment <comment>]\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--intnet]\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync "\n");
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync }
3933885bc0c2c93436d858a14564c6179ec72872vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_GETEXTRADATA)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
9ce5d949e4f1572d445a5c0aecabe9de8b672c99vboxsync RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>|enumerate\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SETEXTRADATA)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [<value>] (no value deletes key)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SETPROPERTY)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage setproperty hdfolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " machinefolder default|<folder> |\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " vrdpauthlibrary default|<library> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " websrvauthlibrary default|null|<library> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " loghistorycount <value>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("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"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--manufacturer <string>] (null)\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--product <string>] (null)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync " --target <uuid>|<name>|global\n"
1568d715e75b8d2484ea3dc87f0483d4cf377838vboxsync " [--name <string>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--action ignore|hold] (global filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--active yes|no]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--vendorid <XXXX>|\"\"]\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--productid <XXXX>|\"\"]\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync " [--revision <IIFF>|\"\"]\n"
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync " [--manufacturer <string>|\"\"]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--product <string>|\"\"]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>|\"\"]\n"
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
051eba4436f9c682f7873390fb327e8eceb9e0efvboxsync "\n");
63b785c3291332a86a9bc473e68f08121368898bvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync {
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " --target <uuid>|<name>|global\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync "\n");
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync }
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " --name <name> --hostpath <hostpath>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--transient] [--readonly]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> [--transient]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
bf88068260ded16af90b7da4867240fbdd9c8017vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_VM_STATISTICS)
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync {
63b785c3291332a86a9bc473e68f08121368898bvboxsync RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync " [--pattern <pattern>] [--descriptions]\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync "\n");
63b785c3291332a86a9bc473e68f08121368898bvboxsync }
63b785c3291332a86a9bc473e68f08121368898bvboxsync
63b785c3291332a86a9bc473e68f08121368898bvboxsync#ifdef VBOX_WITH_GUEST_PROPS
63b785c3291332a86a9bc473e68f08121368898bvboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
63b785c3291332a86a9bc473e68f08121368898bvboxsync usageGuestProperty();
63b785c3291332a86a9bc473e68f08121368898bvboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_METRICS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " (comma-separated)\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics setup\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--period <seconds>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics collect\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--period <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--samples <count>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--detach]\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [*|host|<vmname> [<metric_list>]]\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
5434d84d270a73565d8c3bed826cb4f95aba317bvboxsync if (u64Cmd & USAGE_HOSTONLYIFS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage hostonlyif ipconfig <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--dhcp |\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
5d39cab83ac9a6c6e4c5da4690ac53b4cfec73aavboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync# if defined(RT_OS_WINDOWS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " create |\n"
5b298681ed3a24f71adcf7b557d3b0f850967bbfvboxsync " remove <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync# endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_DHCPSERVER)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
1a3c29d55b3cf1f6d60f53b8e3c33161ca97cd95vboxsync RTPrintf("VBoxManage dhcpserver add|modify --netname <network_name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
1a3c29d55b3cf1f6d60f53b8e3c33161ca97cd95vboxsync " [--ip <ip_address>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --netmask <network_mask>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --lowerip <lower_ip>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --upperip <upper_ip>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--enable | --disable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync}
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync/**
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync * Print a usage synopsis and the syntax error message.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync{
95a6be61815bc19c98d76c390b164600364b3e3dvboxsync va_list args;
3933885bc0c2c93436d858a14564c6179ec72872vboxsync showLogo(); // show logo even if suppressed
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifndef VBOX_ONLY_DOCS
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync if (g_fInternalMode)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync printUsageInternal(u64Cmd);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync printUsage(u64Cmd);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* !VBOX_ONLY_DOCS */
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync va_start(args, pszFormat);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "Syntax error: %N\n", pszFormat, &args);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync va_end(args);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return 1;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync}
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync/**
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync * Print an error message without the syntax stuff.
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsyncint errorArgument(const char *pszFormat, ...)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync{
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync va_list args;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync va_start(args, pszFormat);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTPrintf("error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return 1;
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync}
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync