VBoxManageHelp.cpp revision 2711c80499bbd95e3da4a6cd2dffd9f81a5dce98
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * 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
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * additional information or have any questions.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/stream.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/getopt.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include "VBoxManage.h"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid printUsage(USAGECATEGORY u64Cmd)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_LINUX
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_WINDOWS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_SOLARIS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_DARWIN
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VRDP
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (u64Cmd == USAGE_DUMPOPTS)
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync {
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fLinux = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fWin = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fVRDP = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("Usage:\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage [-v|-version] print version number and exit\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage -nologo ... suppress the logo\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_LIST)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " hostifs|hostinfo|hddbackends|hdds|dvds|floppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbhost|usbfilters|systemproperties\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHOWVMINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync RTPrintf("VBoxManage showvminfo <uuid>|<name> [-details] [-statistics]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [-machinereadable]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync "\n");
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync }
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync if (u64Cmd & USAGE_REGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage registervm <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_UNREGISTERVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage unregistervm <uuid>|<name> [-delete]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage createvm -name <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-ostype <ostype>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-register]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-basefolder <path> | -settingsfile <path>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-uuid <uuid>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage import <ovf>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n"); // @todo
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage export <machines> [--output|-o] <ovf>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage modifyvm <uuid|name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-name <name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-ostype <ostype>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-memory <memorysize in MB>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-vram <vramsize in MB>]\n"
91f8453d16b48876deddaba298c211071d0ca3a5vboxsync " [-acpi on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-ioapic on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-pae on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-hwvirtex on|off|default]\n"
4cf22805d13f50eef86e917f2c7106fe5198a2d8vboxsync " [-nestedpaging on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-vtxvpid on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-monitorcount <number>]\n"
9dfcf62b7a5a289684d46ee55f6042d49509daecvboxsync " [-accelerate3d <on|off>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-bioslogofadein on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-bioslogofadeout on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [-bioslogodisplaytime <msec>]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [-bioslogoimagepath <imagepath>]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [-biosbootmenu disabled|menuonly|messageandmenu]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-biossystemtimeoffset <msec>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-biospxedebug on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-boot<1-4> none|floppy|dvd|disk|net>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-hd<a|b|d> none|<uuid>|<filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-idecontroller PIIX3|PIIX4]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#ifdef VBOX_WITH_AHCI
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-sata on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-sataportcount <1-30>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-sataport<1-30> none|<uuid>|<filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-sataideemulation<1-4> <1-30>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-dvd none|<uuid>|<filename>|host:<drive>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-dvdpassthrough on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-floppy disabled|empty|<uuid>|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <filename>|host:<drive>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(RT_OS_LINUX) || defined(RT_OS_DARWIN)
a59528c40bbfdcee2e315756333f8c66f35b5accvboxsync " [-nic<1-N> none|null|nat|hostif|intnet|hostonly]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-nic<1-N> none|null|nat|hostif|intnet]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
e214bb78026c1d64078b34ca9504d3f5abbc52efvboxsync " [-nictype<1-N> Am79C970A|Am79C973"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#ifdef VBOX_WITH_E1000
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "|82540EM|82543GC"
fc148a6b23d25a87561beaffe0ba06c3ba93bf5avboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "]\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [-cableconnected<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-nictrace<1-N> on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-nictracefile<1-N> <filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-nicspeed<1-N> <kbps>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-hostifdev<1-N> none|<devicename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-intnet<1-N> <network name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-natnet<1-N> <network>|default]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-macaddress<1-N> auto|<mac>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-uart<1-N> off|<I/O base> <IRQ>]\n"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync " [-uartmode<1-N> disconnected|\n"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync " server <pipe>|\n"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync " client <pipe>|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " <devicename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#ifdef VBOX_WITH_MEM_BALLOONING
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-guestmemoryballoon <balloonsize in MB>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-gueststatisticsinterval <seconds>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync );
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync RTPrintf(" [-audio none|null");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (fWin)
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#ifdef VBOX_WITH_WINMM
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf( "|winmm|dsound");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#else
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf( "|dsound");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (fSolaris)
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf( "|solaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (fLinux)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf( "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_ALSA
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "|alsa"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PULSE
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|pulse"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDarwin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "|coreaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync RTPrintf( "]\n");
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync RTPrintf(" [-audiocontroller ac97|sb16]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [-clipboard disabled|hosttoguest|guesttohost|\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " bidirectional]\n");
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync if (fVRDP)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf(" [-vrdp on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-vrdpport default|<port>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-vrdpaddress <host>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-vrdpauthtype null|external|guest]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-vrdpmulticon on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-vrdpreusecon on|off]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf(" [-usb on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-usbehci on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-snapshotfolder default|<path>]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_STARTVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage startvm <uuid>|<name>\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (fVRDP)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf(" [-type gui|vrdp]\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_CONTROLVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage controlvm <uuid>|<name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " pause|resume|reset|poweroff|savestate|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " acpipowerbutton|acpisleepbutton|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " injectnmi|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " setlinkstate<1-4> on|off |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " usbattach <uuid>|<address> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " usbdetach <uuid>|<address> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " dvdattach none|<uuid>|<filename>|host:<drive> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " floppyattach none|<uuid>|<filename>|host:<drive> |\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVRDP)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync {
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync RTPrintf(" vrdp on|off] |\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]|\n"
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync " setcredentials <username> <password> <domain>\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [-allowlocallogon <yes|no>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync "\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync if (u64Cmd & USAGE_DISCARDSTATE)
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync {
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync RTPrintf("VBoxManage discardstate <uuid>|<name>\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync "\n");
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync }
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync if (u64Cmd & USAGE_ADOPTSTATE)
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync {
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync "\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync if (u64Cmd & USAGE_SNAPSHOT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage snapshot <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " take <name> [-desc <desc>] |\n"
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync " discard <uuid>|<name> |\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync " discardcurrent -state|-all |\n"
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync " edit <uuid>|<name>|-current\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-newname <name>]\n"
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync " [-newdesc <desc>] |\n"
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync " showvminfo <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_REGISTERIMAGE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage openmedium disk|dvd|floppy <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-type normal|immutable|writethrough] (disk only)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
000d3a358f1072f58336eaea956b19888b123e49vboxsync if (u64Cmd & USAGE_UNREGISTERIMAGE)
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync {
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync RTPrintf("VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
b6957a412c94dd85c0e5f9e201bb715c4b685f2fvboxsync "\n");
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync }
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync
b6957a412c94dd85c0e5f9e201bb715c4b685f2fvboxsync if (u64Cmd & USAGE_SHOWHDINFO)
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync {
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync RTPrintf("VBoxManage showhdinfo <uuid>|<filename>\n"
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync "\n");
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync }
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync /// @todo NEWMEDIA add -format to specify the hard disk backend
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage createhd -filename <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -size <megabytes>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-format VDI|VMDK|VHD]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-static]\n"
028cf251b334848ebf6ab5afa7081e4721d994f5vboxsync " [-comment <comment>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-register]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-type normal|writethrough] (default: normal)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage modifyhd <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " settype normal|writethrough|immutable |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " compact\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CLONEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-format VDI|VMDK|VHD|RAW|<other>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-remember]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage convertfromraw [-static] [-format VDI|VMDK|VHD]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <filename> <outputfile>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "VBoxManage convertfromraw [-static] [-format VDI|VMDK|VHD]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " stdin <outputfile> <bytes>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_ADDISCSIDISK)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync RTPrintf("VBoxManage addiscsidisk -server <name>|<ip>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -target <target>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-port <port>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-lun <lun>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-encodedlun <lun>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-username <username>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-password <password>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-comment <comment>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-intnet]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_GETEXTRADATA)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " <key>|enumerate\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SETEXTRADATA)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " <key>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [<value>] (no value deletes key)\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync "\n");
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync }
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync if (u64Cmd & USAGE_SETPROPERTY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage setproperty hdfolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " machinefolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " vrdpauthlibrary default|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " websrvauthlibrary default|null|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " hwvirtexenabled yes|no\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " loghistorycount <value>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync "\n");
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -name <string>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " -action ignore|hold (global filters only)\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [-active yes|no] (yes)\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [-vendorid <XXXX>] (null)\n"
70f7b6ff8dc13303a70e552dd7003aa672e985a2vboxsync " [-productid <XXXX>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-revision <IIFF>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-manufacturer <string>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-product <string>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-remote yes|no] (null, VM filters only)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-serialnumber <string>] (null)\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [-maskedinterfaces <XXXXXXXX>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync "\n");
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync }
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-name <string>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-action ignore|hold] (global filters only)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-active yes|no]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-vendorid <XXXX>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-productid <XXXX>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-revision <IIFF>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-manufacturer <string>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-product <string>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-remote yes|no] (null, VM filters only)\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-serialnumber <string>|\"\"]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [-maskedinterfaces <XXXXXXXX>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync "\n");
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -name <name> -hostpath <hostpath>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-transient] [-readonly]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " -name <name> [-transient]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_VM_STATISTICS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [-reset]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-pattern <pattern>] [-descriptions]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_GUEST_PROPS
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync usageGuestProperty();
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_METRICS)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage metrics list [*|host|<vmname> [<metric_list>]] (comma-separated)\n\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "VBoxManage metrics setup\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-period <seconds>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-samples <count>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [-list]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics collect\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-period <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-samples <count>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-list]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-detach]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [*|host|<vmname> [<metric_list>]]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync}
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync/**
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync * Print a usage synopsis and the syntax error message.
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync{
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync showLogo(); // show logo even if suppressed
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifndef VBOX_ONLY_DOCS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (g_fInternalMode)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync printUsageInternal(u64Cmd);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync printUsage(u64Cmd);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif /* !VBOX_ONLY_DOCS */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "Syntax error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return 1;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print an error message without the syntax stuff.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorArgument(const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return 1;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifndef VBOX_ONLY_DOCS
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync/**
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync * Print out progress on the console
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid showProgress(ComPtr<IProgress> progress)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync BOOL fCompleted;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync LONG currentPercent;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync LONG lastPercent = 0;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("0%%...");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmFlush(g_pStdOut);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync {
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync progress->COMGETTER(Percent(&currentPercent));
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync /* did we cross a 10% mark? */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (((currentPercent / 10) > (lastPercent / 10)))
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync /* make sure to also print out missed steps */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync for (LONG curVal = (lastPercent / 10) * 10 + 10; curVal <= (currentPercent / 10) * 10; curVal += 10)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (curVal < 100)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("%ld%%...", curVal);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmFlush(g_pStdOut);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync lastPercent = (currentPercent / 10) * 10;
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync if (fCompleted)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync break;
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync /* make sure the loop is not too tight */
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync progress->WaitForCompletion(100);
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync
410216171f7f7033678589acb6e342303978c918vboxsync /* complete the line. */
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync HRESULT rc;
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync if (SUCCEEDED(progress->COMGETTER(ResultCode)(&rc)))
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync {
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync if (SUCCEEDED(rc))
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync RTPrintf("100%%\n");
d1fcf24d24368926be13484524a9e378070a9157vboxsync else
d1fcf24d24368926be13484524a9e378070a9157vboxsync RTPrintf("FAILED\n");
d1fcf24d24368926be13484524a9e378070a9157vboxsync }
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync else
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync RTPrintf("\n");
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync RTStrmFlush(g_pStdOut);
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync}
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync#endif /* !VBOX_ONLY_DOCS */
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync