VBoxManageHelp.cpp revision 4cf22805d13f50eef86e917f2c7106fe5198a2d8
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync/* $Id$ */
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @file
af062818b47340eef15700d2f0211576ba3506eevboxsync * VBoxManage - help and other message output.
af062818b47340eef15700d2f0211576ba3506eevboxsync */
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/*
af062818b47340eef15700d2f0211576ba3506eevboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
af062818b47340eef15700d2f0211576ba3506eevboxsync * available from http://www.virtualbox.org. This file is free software;
af062818b47340eef15700d2f0211576ba3506eevboxsync * you can redistribute it and/or modify it under the terms of the GNU
af062818b47340eef15700d2f0211576ba3506eevboxsync * General Public License (GPL) as published by the Free Software
af062818b47340eef15700d2f0211576ba3506eevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
af062818b47340eef15700d2f0211576ba3506eevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
af062818b47340eef15700d2f0211576ba3506eevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
af062818b47340eef15700d2f0211576ba3506eevboxsync *
af062818b47340eef15700d2f0211576ba3506eevboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
af062818b47340eef15700d2f0211576ba3506eevboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
af062818b47340eef15700d2f0211576ba3506eevboxsync * additional information or have any questions.
af062818b47340eef15700d2f0211576ba3506eevboxsync */
af062818b47340eef15700d2f0211576ba3506eevboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#include <iprt/stream.h>
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync#include <iprt/getopt.h>
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync#include "VBoxManage.h"
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsyncvoid printUsage(USAGECATEGORY u64Cmd)
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync{
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef RT_OS_LINUX
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync bool fLinux = true;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#else
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync bool fLinux = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef RT_OS_WINDOWS
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync bool fWin = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync#else
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fWin = false;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef RT_OS_SOLARIS
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fSolaris = true;
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#else
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fSolaris = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef RT_OS_DARWIN
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fDarwin = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync#else
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync bool fDarwin = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef VBOX_WITH_VRDP
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fVRDP = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync#else
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fVRDP = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_VBOXSDL
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fVBoxSDL = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync#else
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fVBoxSDL = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd == USAGE_DUMPOPTS)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync fLinux = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync fWin = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync fSolaris = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync fDarwin = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync fVRDP = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync fVBoxSDL = true;
af062818b47340eef15700d2f0211576ba3506eevboxsync u64Cmd = USAGE_ALL;
af062818b47340eef15700d2f0211576ba3506eevboxsync }
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("Usage:\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "\n");
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if (u64Cmd == USAGE_ALL)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("VBoxManage [-v|--version] print version number and exit\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "\n");
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync }
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if (u64Cmd & USAGE_LIST)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#if defined(VBOX_WITH_NETFLT)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#else
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " bridgedifs|hostinfo|dhcpservers|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync " hddbackends|hdds|dvds|floppies|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " usbhost|usbfilters|systemproperties\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SHOWVMINFO)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--machinereadable]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_REGISTERVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage registervm <filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_UNREGISTERVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage unregistervm <uuid>|<name> [--delete]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CREATEVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage createvm --name <name>\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--ostype <ostype>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--register]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--basefolder <path> | --settingsfile <path>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--uuid <uuid>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_MODIFYVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage modifyvm <uuid|name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--name <name>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--ostype <ostype>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--memory <memorysize in MB>]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--vram <vramsize in MB>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--acpi on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--ioapic on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--pae on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--hwvirtex on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nestedpaging on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vtxvpid on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--cpus <number>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--monitorcount <number>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--accelerate3d <on|off>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--bioslogofadein on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--bioslogofadeout on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--bioslogodisplaytime <msec>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--bioslogoimagepath <imagepath>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--biossystemtimeoffset <msec>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--biospxedebug on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--hd<a|b|d> none|<uuid>|<filename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--idecontroller PIIX3|PIIX4]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_AHCI
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--sata on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--sataportcount <1-30>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--sataport<1-30> none|<uuid>|<filename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--sataideemulation<1-4> <1-30>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_SCSI
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--scsi on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--scsiport<1-16> none|<uuid>|<filename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--scsitype LsiLogic|BusLogic]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--dvd none|<uuid>|<filename>|host:<drive>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--dvdpassthrough on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--floppy disabled|empty|<uuid>|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " <filename>|host:<drive>]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nic<1-N> none|null|nat|bridged|intnet|hostonly]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nic<1-N> none|null|nat|bridged|intnet]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nictype<1-N> Am79C970A|Am79C973"
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_E1000
af062818b47340eef15700d2f0211576ba3506eevboxsync "|\n 82540EM|82543GC|82545EM"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync "]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--cableconnected<1-N> on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nictrace<1-N> on|off]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--nictracefile<1-N> <filename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--nicspeed<1-N> <kbps>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--intnet<1-N> <network name>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--natnet<1-N> <network>|default]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--macaddress<1-N> auto|<mac>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--uartmode<1-N> disconnected|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " server <pipe>|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " client <pipe>|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " file <file>|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " <devicename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_MEM_BALLOONING
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--gueststatisticsinterval <seconds>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync );
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" [--audio none|null");
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fWin)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef VBOX_WITH_WINMM
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf( "|winmm|dsound");
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#else
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf( "|dsound");
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync }
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if (fSolaris)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf( "|solaudio"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef VBOX_WITH_SOLARIS_OSS
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "|oss"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync );
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fLinux)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "|oss"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef VBOX_WITH_ALSA
af062818b47340eef15700d2f0211576ba3506eevboxsync "|alsa"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#endif
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#ifdef VBOX_WITH_PULSE
af062818b47340eef15700d2f0211576ba3506eevboxsync "|pulse"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync );
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync }
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if (fDarwin)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "|coreaudio");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "]\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" [--audiocontroller ac97|sb16]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " bidirectional]\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fVRDP)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" [--vrdp on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vrdpport default|<port>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vrdpaddress <host>]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--vrdpauthtype null|external|guest]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vrdpmulticon on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vrdpreusecon on|off]\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" [--usb on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--usbehci on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--snapshotfolder default|<path>]\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("VBoxManage import <ovf> [--dry-run|-n] [more options]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " (run with -n to have options displayed for a particular OVF)\n\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("VBoxManage export <machines> --output|-o <ovf>\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--legacy09]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--vsys <number of virtual system>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--product <product name>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--producturl <product url>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vendor <vendor name>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vendorurl <vendor url>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--version <version info>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--eula <license text>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--eulafile <filename>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_STARTVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage startvm <uuid>|<name>\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" [--type gui");
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fVBoxSDL)
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "|sdl");
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fVRDP)
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "|vrdp");
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf( "|headless]\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CONTROLVM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage controlvm <uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " pause|resume|reset|poweroff|savestate|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " acpipowerbutton|acpisleepbutton|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " injectnmi|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " setlinkstate<1-N> on|off |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_DYNAMIC_NET_ATTACH
af062818b47340eef15700d2f0211576ba3506eevboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync " nic<1-N> none|null|nat|bridged|intnet|hostonly\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [<devicename>] |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
af062818b47340eef15700d2f0211576ba3506eevboxsync " nic<1-N> none|null|nat|bridged|intnet\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [<devicename>] |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* VBOX_DYNAMIC_NET_ATTACH */
af062818b47340eef15700d2f0211576ba3506eevboxsync " usbattach <uuid>|<address> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " usbdetach <uuid>|<address> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " dvdattach none|<uuid>|<filename>|host:<drive> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " floppyattach none|<uuid>|<filename>|host:<drive> |\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync if (fVRDP)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" vrdp on|off] |\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]|\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " setcredentials <username> <password> <domain>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--allowlocallogon <yes|no>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_DISCARDSTATE)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage discardstate <uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_ADOPTSTATE)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SNAPSHOT)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage snapshot <uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " take <name> [--description <desc>] |\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " discard <uuid>|<name> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " discardcurrent --state|--all |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " edit <uuid>|<name>|--current\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--name <name>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--description <desc>] |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " showvminfo <uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_OPENMEDIUM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage openmedium disk|dvd|floppy <filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--type normal|immutable|writethrough] (disk only)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync if (u64Cmd & USAGE_SHOWHDINFO)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage showhdinfo <uuid>|<filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CREATEHD)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage createhd --filename <filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --size <megabytes>\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--type normal|writethrough] (default: normal)\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--comment <comment>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--remember]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_MODIFYHD)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync RTPrintf("VBoxManage modifyhd <uuid>|<filename>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--type normal|writethrough|immutable]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--autoreset on|off]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--compact]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CLONEHD)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--type normal|writethrough|immutable]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--remember] [--existing]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage convertfromraw <filename> <outputfile>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--format VDI|VMDK|VHD]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--format VDI|VMDK|VHD]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_ADDISCSIDISK)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage addiscsidisk --server <name>|<ip>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --target <target>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--port <port>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--lun <lun>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--encodedlun <lun>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--username <username>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--password <password>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--type normal|writethrough|immutable]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--comment <comment>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--intnet]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_GETEXTRADATA)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " <key>|enumerate\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SETEXTRADATA)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " <key>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [<value>] (no value deletes key)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SETPROPERTY)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage setproperty hdfolder default|<folder> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " machinefolder default|<folder> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " vrdpauthlibrary default|<library> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " websrvauthlibrary default|null|<library> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " loghistorycount <value>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --target <uuid>|<name>|global\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --name <string>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --action ignore|hold (global filters only)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--active yes|no] (yes)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vendorid <XXXX>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--productid <XXXX>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--revision <IIFF>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--manufacturer <string>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--product <string>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--remote yes|no] (null, VM filters only)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--serialnumber <string>] (null)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " --target <uuid>|<name>|global\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--name <string>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--action ignore|hold] (global filters only)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--active yes|no]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--vendorid <XXXX>|\"\"]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--productid <XXXX>|\"\"]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--revision <IIFF>|\"\"]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--manufacturer <string>|\"\"]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--product <string>|\"\"]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--remote yes|no] (null, VM filters only)\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--serialnumber <string>|\"\"]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --target <uuid>|<name>|global\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --name <name> --hostpath <hostpath>\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--transient] [--readonly]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --name <name> [--transient]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_VM_STATISTICS)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--pattern <pattern>] [--descriptions]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifdef VBOX_WITH_GUEST_PROPS
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
af062818b47340eef15700d2f0211576ba3506eevboxsync usageGuestProperty();
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_METRICS)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " (comma-separated)\n\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "VBoxManage metrics setup\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--period <seconds>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--samples <count>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--list]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "VBoxManage metrics collect\n"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync " [--period <seconds>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--samples <count>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--list]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--detach]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [*|host|<vmname> [<metric_list>]]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_HOSTONLYIFS)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage hostonlyif ipconfig <name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--dhcp |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync# if defined(RT_OS_WINDOWS)
af062818b47340eef15700d2f0211576ba3506eevboxsync " create |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " remove <name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync# endif
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync if (u64Cmd & USAGE_DHCPSERVER)
af062818b47340eef15700d2f0211576ba3506eevboxsync {
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("VBoxManage dhcpserver add|modify --netname <network_name> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync " --ifname <hostonly_if_name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--ip <ip_address>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --netmask <network_mask>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --lowerip <lower_ip>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " --upperip <upper_ip>]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync " [--enable | --disable]\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#if defined(VBOX_WITH_NETFLT)
af062818b47340eef15700d2f0211576ba3506eevboxsync " --ifname <hostonly_if_name>\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif
af062818b47340eef15700d2f0211576ba3506eevboxsync "\n");
af062818b47340eef15700d2f0211576ba3506eevboxsync }
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/**
af062818b47340eef15700d2f0211576ba3506eevboxsync * Print a usage synopsis and the syntax error message.
af062818b47340eef15700d2f0211576ba3506eevboxsync */
af062818b47340eef15700d2f0211576ba3506eevboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync va_list args;
af062818b47340eef15700d2f0211576ba3506eevboxsync showLogo(); // show logo even if suppressed
af062818b47340eef15700d2f0211576ba3506eevboxsync#ifndef VBOX_ONLY_DOCS
af062818b47340eef15700d2f0211576ba3506eevboxsync if (g_fInternalMode)
af062818b47340eef15700d2f0211576ba3506eevboxsync printUsageInternal(u64Cmd);
af062818b47340eef15700d2f0211576ba3506eevboxsync else
af062818b47340eef15700d2f0211576ba3506eevboxsync printUsage(u64Cmd);
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* !VBOX_ONLY_DOCS */
af062818b47340eef15700d2f0211576ba3506eevboxsync va_start(args, pszFormat);
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("\n"
af062818b47340eef15700d2f0211576ba3506eevboxsync "Syntax error: %N\n", pszFormat, &args);
af062818b47340eef15700d2f0211576ba3506eevboxsync va_end(args);
af062818b47340eef15700d2f0211576ba3506eevboxsync return 1;
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync/**
af062818b47340eef15700d2f0211576ba3506eevboxsync * Print an error message without the syntax stuff.
af062818b47340eef15700d2f0211576ba3506eevboxsync */
af062818b47340eef15700d2f0211576ba3506eevboxsyncint errorArgument(const char *pszFormat, ...)
af062818b47340eef15700d2f0211576ba3506eevboxsync{
af062818b47340eef15700d2f0211576ba3506eevboxsync va_list args;
af062818b47340eef15700d2f0211576ba3506eevboxsync va_start(args, pszFormat);
af062818b47340eef15700d2f0211576ba3506eevboxsync RTPrintf("error: %N\n", pszFormat, &args);
af062818b47340eef15700d2f0211576ba3506eevboxsync va_end(args);
af062818b47340eef15700d2f0211576ba3506eevboxsync return 1;
af062818b47340eef15700d2f0211576ba3506eevboxsync}
af062818b47340eef15700d2f0211576ba3506eevboxsync
af062818b47340eef15700d2f0211576ba3506eevboxsync