#include <iprt/stream.h>

#include <iprt/getopt.h>

#include "VBoxManage.h"

void printUsage(USAGECATEGORY u64Cmd)

{

#ifdef RT_OS_LINUX

bool fLinux = true;

#else

bool fLinux = false;

#endif

#ifdef RT_OS_WINDOWS

bool fWin = true;

#else

bool fWin = false;

#endif

#ifdef RT_OS_SOLARIS

bool fSolaris = true;

#else

bool fSolaris = false;

#endif

#ifdef RT_OS_DARWIN

bool fDarwin = true;

#else

bool fDarwin = false;

#endif

#ifdef VBOX_WITH_VRDP

bool fVRDP = true;

#else

bool fVRDP = false;

#endif

if (u64Cmd == USAGE_DUMPOPTS)

{

fLinux = true;

fWin = true;

fSolaris = true;

fDarwin = true;

fVRDP = true;

u64Cmd = USAGE_ALL;

}

RTPrintf("Usage:\n"

"\n");

if (u64Cmd == USAGE_ALL)

{

RTPrintf("VBoxManage [-v|-version] print version number and exit\n"

"VBoxManage -nologo ... suppress the logo\n"

"\n");

}

if (u64Cmd & USAGE_LIST)

{

RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"

#if (defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT))

" bridgedifs|hostonlyifs|hostinfo|hddbackends|hdds|dvds|floppies|\n"

#else

" bridgedifs|hostinfo|hddbackends|hdds|dvds|floppies|\n"

#endif

" usbhost|usbfilters|systemproperties\n"

"\n");

}

if (u64Cmd & USAGE_SHOWVMINFO)

{

RTPrintf("VBoxManage showvminfo <uuid>|<name> [-details] [-statistics]\n"

" [-machinereadable]\n"

"\n");

}

if (u64Cmd & USAGE_REGISTERVM)

{

RTPrintf("VBoxManage registervm <filename>\n"

"\n");

}

if (u64Cmd & USAGE_UNREGISTERVM)

{

RTPrintf("VBoxManage unregistervm <uuid>|<name> [-delete]\n"

"\n");

}

if (u64Cmd & USAGE_CREATEVM)

{

RTPrintf("VBoxManage createvm -name <name>\n"

" [-ostype <ostype>]\n"

" [-register]\n"

" [-basefolder <path> | -settingsfile <path>]\n"

" [-uuid <uuid>]\n"

"\n");

}

if (u64Cmd & USAGE_IMPORTAPPLIANCE)

{

RTPrintf("VBoxManage import <ovf>\n"

"\n"); // @todo

}

if (u64Cmd & USAGE_EXPORTAPPLIANCE)

{

RTPrintf("VBoxManage export <machines> [--output|-o] <ovf>\n"

"\n");

}

if (u64Cmd & USAGE_MODIFYVM)

{

RTPrintf("VBoxManage modifyvm <uuid|name>\n"

" [-name <name>]\n"

" [-ostype <ostype>]\n"

" [-memory <memorysize in MB>]\n"

" [-vram <vramsize in MB>]\n"

" [-acpi on|off]\n"

" [-ioapic on|off]\n"

" [-pae on|off]\n"

" [-hwvirtex on|off|default]\n"

" [-nestedpaging on|off]\n"

" [-vtxvpid on|off]\n"

" [-monitorcount <number>]\n"

" [-accelerate3d <on|off>]\n"

" [-bioslogofadein on|off]\n"

" [-bioslogofadeout on|off]\n"

" [-bioslogodisplaytime <msec>]\n"

" [-bioslogoimagepath <imagepath>]\n"

" [-biosbootmenu disabled|menuonly|messageandmenu]\n"

" [-biossystemtimeoffset <msec>]\n"

" [-biospxedebug on|off]\n"

" [-boot<1-4> none|floppy|dvd|disk|net>]\n"

" [-hd<a|b|d> none|<uuid>|<filename>]\n"

" [-idecontroller PIIX3|PIIX4]\n"

#ifdef VBOX_WITH_AHCI

" [-sata on|off]\n"

" [-sataportcount <1-30>]\n"

" [-sataport<1-30> none|<uuid>|<filename>]\n"

" [-sataideemulation<1-4> <1-30>]\n"

#endif

" [-dvd none|<uuid>|<filename>|host:<drive>]\n"

" [-dvdpassthrough on|off]\n"

" [-floppy disabled|empty|<uuid>|\n"

" <filename>|host:<drive>]\n"

#if defined(RT_OS_LINUX) || defined(RT_OS_DARWIN) || (defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT))

" [-nic<1-N> none|null|nat|bridged|intnet|hostonly]\n"

#else /* !RT_OS_LINUX && !RT_OS_DARWIN */

" [-nic<1-N> none|null|nat|bridged|intnet]\n"

#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */

" [-nictype<1-N> Am79C970A|Am79C973"

#ifdef VBOX_WITH_E1000

"|82540EM|82543GC"

#endif

"]\n"

" [-cableconnected<1-N> on|off]\n"

" [-nictrace<1-N> on|off]\n"

" [-nictracefile<1-N> <filename>]\n"

" [-nicspeed<1-N> <kbps>]\n"

" [-bridgeddev<1-N> none|<devicename>]\n"

#if (defined(RT_OS_WINDOWS) && defined(VBOX_WITH_NETFLT))

" [-hostonlydev<1-N> none|<devicename>]\n"

#endif

" [-intnet<1-N> <network name>]\n"

" [-natnet<1-N> <network>|default]\n"

" [-macaddress<1-N> auto|<mac>]\n"

" [-uart<1-N> off|<I/O base> <IRQ>]\n"

" [-uartmode<1-N> disconnected|\n"

" server <pipe>|\n"

" client <pipe>|\n"

" <devicename>]\n"

#ifdef VBOX_WITH_MEM_BALLOONING

" [-guestmemoryballoon <balloonsize in MB>]\n"

#endif

" [-gueststatisticsinterval <seconds>]\n"

);

RTPrintf(" [-audio none|null");

if (fWin)

{

#ifdef VBOX_WITH_WINMM

RTPrintf( "|winmm|dsound");

#else

RTPrintf( "|dsound");

#endif

}

if (fSolaris)

{

RTPrintf( "|solaudio");

}

if (fLinux)

{

RTPrintf( "|oss"

#ifdef VBOX_WITH_ALSA

"|alsa"

#endif

#ifdef VBOX_WITH_PULSE

"|pulse"

#endif

);

}

if (fDarwin)

{

RTPrintf( "|coreaudio");

}

RTPrintf( "]\n");

RTPrintf(" [-audiocontroller ac97|sb16]\n"

" [-clipboard disabled|hosttoguest|guesttohost|\n"

" bidirectional]\n");

if (fVRDP)

{

RTPrintf(" [-vrdp on|off]\n"

" [-vrdpport default|<port>]\n"

" [-vrdpaddress <host>]\n"

" [-vrdpauthtype null|external|guest]\n"

" [-vrdpmulticon on|off]\n"

" [-vrdpreusecon on|off]\n");

}

RTPrintf(" [-usb on|off]\n"

" [-usbehci on|off]\n"

" [-snapshotfolder default|<path>]\n");

RTPrintf("\n");

}

if (u64Cmd & USAGE_STARTVM)

{

RTPrintf("VBoxManage startvm <uuid>|<name>\n");

if (fVRDP)

RTPrintf(" [-type gui|vrdp]\n");

RTPrintf("\n");

}

if (u64Cmd & USAGE_CONTROLVM)

{

RTPrintf("VBoxManage controlvm <uuid>|<name>\n"

" pause|resume|reset|poweroff|savestate|\n"

" acpipowerbutton|acpisleepbutton|\n"

" keyboardputscancode <hex> [<hex> ...]|\n"

" injectnmi|\n"

" setlinkstate<1-4> on|off |\n"

" usbattach <uuid>|<address> |\n"

" usbdetach <uuid>|<address> |\n"

" dvdattach none|<uuid>|<filename>|host:<drive> |\n"

" floppyattach none|<uuid>|<filename>|host:<drive> |\n");

if (fVRDP)

{

RTPrintf(" vrdp on|off] |\n");

}

RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display]|\n"

" setcredentials <username> <password> <domain>\n"

" [-allowlocallogon <yes|no>]\n"

"\n");

}

if (u64Cmd & USAGE_DISCARDSTATE)

{

RTPrintf("VBoxManage discardstate <uuid>|<name>\n"

"\n");

}

if (u64Cmd & USAGE_ADOPTSTATE)

{

RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"

"\n");

}

if (u64Cmd & USAGE_SNAPSHOT)

{

RTPrintf("VBoxManage snapshot <uuid>|<name>\n"

" take <name> [-desc <desc>] |\n"

" discard <uuid>|<name> |\n"

" discardcurrent -state|-all |\n"

" edit <uuid>|<name>|-current\n"

" [-newname <name>]\n"

" [-newdesc <desc>] |\n"

" showvminfo <uuid>|<name>\n"

"\n");

}

if (u64Cmd & USAGE_REGISTERIMAGE)

{

RTPrintf("VBoxManage openmedium disk|dvd|floppy <filename>\n"

" [-type normal|immutable|writethrough] (disk only)\n"

"\n");

}

if (u64Cmd & USAGE_UNREGISTERIMAGE)

{

RTPrintf("VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"

"\n");

}

if (u64Cmd & USAGE_SHOWHDINFO)

{

RTPrintf("VBoxManage showhdinfo <uuid>|<filename>\n"

"\n");

}

if (u64Cmd & USAGE_CREATEHD)

{

/// @todo NEWMEDIA add -format to specify the hard disk backend

RTPrintf("VBoxManage createhd -filename <filename>\n"

" -size <megabytes>\n"

" [-format VDI|VMDK|VHD]\n"

" [-static]\n"

" [-comment <comment>]\n"

" [-register]\n"

" [-type normal|writethrough] (default: normal)\n"

"\n");

}

if (u64Cmd & USAGE_MODIFYHD)

{

RTPrintf("VBoxManage modifyhd <uuid>|<filename>\n"

" settype normal|writethrough|immutable |\n"

" compact\n"

"\n");

}

if (u64Cmd & USAGE_CLONEHD)

{

RTPrintf("VBoxManage clonehd <uuid>|<filename> <outputfile>\n"

" [-format VDI|VMDK|VHD|RAW|<other>]\n"

" [-remember]\n"

"\n");

}

if (u64Cmd & USAGE_CONVERTFROMRAW)

{

RTPrintf("VBoxManage convertfromraw [-static] [-format VDI|VMDK|VHD]\n"

" <filename> <outputfile>\n"

"VBoxManage convertfromraw [-static] [-format VDI|VMDK|VHD]\n"

" stdin <outputfile> <bytes>\n"

"\n");

}

if (u64Cmd & USAGE_ADDISCSIDISK)

{

RTPrintf("VBoxManage addiscsidisk -server <name>|<ip>\n"

" -target <target>\n"

" [-port <port>]\n"

" [-lun <lun>]\n"

" [-encodedlun <lun>]\n"

" [-username <username>]\n"

" [-password <password>]\n"

" [-comment <comment>]\n"

" [-intnet]\n"

"\n");

}

if (u64Cmd & USAGE_GETEXTRADATA)

{

RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"

" <key>|enumerate\n"

"\n");

}

if (u64Cmd & USAGE_SETEXTRADATA)

{

RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"

" <key>\n"

" [<value>] (no value deletes key)\n"

"\n");

}

if (u64Cmd & USAGE_SETPROPERTY)

{

RTPrintf("VBoxManage setproperty hdfolder default|<folder> |\n"

" machinefolder default|<folder> |\n"

" vrdpauthlibrary default|<library> |\n"

" websrvauthlibrary default|null|<library> |\n"

" hwvirtexenabled yes|no\n"

" loghistorycount <value>\n"

"\n");

}

if (u64Cmd & USAGE_USBFILTER_ADD)

{

RTPrintf("VBoxManage usbfilter add <index,0-N>\n"

" -target <uuid>|<name>|global\n"

" -name <string>\n"

" -action ignore|hold (global filters only)\n"

" [-active yes|no] (yes)\n"

" [-vendorid <XXXX>] (null)\n"

" [-productid <XXXX>] (null)\n"

" [-revision <IIFF>] (null)\n"

" [-manufacturer <string>] (null)\n"

" [-product <string>] (null)\n"

" [-remote yes|no] (null, VM filters only)\n"

" [-serialnumber <string>] (null)\n"

" [-maskedinterfaces <XXXXXXXX>]\n"

"\n");

}

if (u64Cmd & USAGE_USBFILTER_MODIFY)

{

RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"

" -target <uuid>|<name>|global\n"

" [-name <string>]\n"

" [-action ignore|hold] (global filters only)\n"

" [-active yes|no]\n"

" [-vendorid <XXXX>|\"\"]\n"

" [-productid <XXXX>|\"\"]\n"

" [-revision <IIFF>|\"\"]\n"

" [-manufacturer <string>|\"\"]\n"

" [-product <string>|\"\"]\n"

" [-remote yes|no] (null, VM filters only)\n"

" [-serialnumber <string>|\"\"]\n"

" [-maskedinterfaces <XXXXXXXX>]\n"

"\n");

}

if (u64Cmd & USAGE_USBFILTER_REMOVE)

{

RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"

" -target <uuid>|<name>|global\n"

"\n");

}

if (u64Cmd & USAGE_SHAREDFOLDER_ADD)

{

RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"

" -name <name> -hostpath <hostpath>\n"

" [-transient] [-readonly]\n"

"\n");

}

if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)

{

RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"

" -name <name> [-transient]\n"

"\n");

}

if (u64Cmd & USAGE_VM_STATISTICS)

{

RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [-reset]\n"

" [-pattern <pattern>] [-descriptions]\n"

"\n");

}

#ifdef VBOX_WITH_GUEST_PROPS

if (u64Cmd & USAGE_GUESTPROPERTY)

usageGuestProperty();

#endif /* VBOX_WITH_GUEST_PROPS defined */

if (u64Cmd & USAGE_METRICS)

{

RTPrintf("VBoxManage metrics list [*|host|<vmname> [<metric_list>]] (comma-separated)\n\n"

"VBoxManage metrics setup\n"

" [-period <seconds>]\n"

" [-samples <count>]\n"

" [-list]\n"

" [*|host|<vmname> [<metric_list>]]\n\n"

"VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"

"VBoxManage metrics collect\n"

" [-period <seconds>]\n"

" [-samples <count>]\n"

" [-list]\n"

" [-detach]\n"

" [*|host|<vmname> [<metric_list>]]\n"

"\n");

}

}

int errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)

{

va_list args;

showLogo(); // show logo even if suppressed

#ifndef VBOX_ONLY_DOCS

if (g_fInternalMode)

printUsageInternal(u64Cmd);

else

printUsage(u64Cmd);

#endif /* !VBOX_ONLY_DOCS */

va_start(args, pszFormat);

RTPrintf("\n"

"Syntax error: %N\n", pszFormat, &args);

va_end(args);

return 1;

}

int errorArgument(const char *pszFormat, ...)

{

va_list args;

va_start(args, pszFormat);

RTPrintf("error: %N\n", pszFormat, &args);

va_end(args);

return 1;

}

#ifndef VBOX_ONLY_DOCS

void showProgress(ComPtr<IProgress> progress)

{

BOOL fCompleted;

LONG currentPercent;

LONG lastPercent = 0;

RTPrintf("0%%...");

RTStrmFlush(g_pStdOut);

while (SUCCEEDED(progress->COMGETTER(Completed(&fCompleted))))

{

progress->COMGETTER(Percent(&currentPercent));

/* did we cross a 10% mark? */

if (((currentPercent / 10) > (lastPercent / 10)))

{

/* make sure to also print out missed steps */

for (LONG curVal = (lastPercent / 10) * 10 + 10; curVal <= (currentPercent / 10) * 10; curVal += 10)

{

if (curVal < 100)

{

RTPrintf("%ld%%...", curVal);

RTStrmFlush(g_pStdOut);

}

}

lastPercent = (currentPercent / 10) * 10;

}

if (fCompleted)

break;

/* make sure the loop is not too tight */

progress->WaitForCompletion(100);

}

/* complete the line. */

HRESULT rc;

if (SUCCEEDED(progress->COMGETTER(ResultCode)(&rc)))

{

if (SUCCEEDED(rc))

RTPrintf("100%%\n");

else

RTPrintf("FAILED\n");

}

else

RTPrintf("\n");

RTStrmFlush(g_pStdOut);

}

#endif /* !VBOX_ONLY_DOCS */