Frontends/VBoxManage/VBoxManageHelp.cpp

	VBoxManageHelp.cpp revision ac2b2ae448fe887af9a3269e40afff11ebb1f9d3
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
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/stream.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/getopt.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
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
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        fVRDP = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    RTPrintf("Usage:\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync             "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("VBoxManage [-v|-version]    print version number and exit\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "VBoxManage -nologo ...      suppress the logo\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_LIST)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                            bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#else
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                            bridgedifs|hostinfo|dhcpservers|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync                 "                            hddbackends|hdds|dvds|floppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            usbhost|usbfilters|systemproperties\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_SHOWVMINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("VBoxManage showvminfo       <uuid>|<name> [-details] [-statistics]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-machinereadable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_REGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage registervm       <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_UNREGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("VBoxManage unregistervm     <uuid>|<name> [-delete]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_CREATEVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("VBoxManage createvm         -name <name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-ostype <ostype>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-register]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-basefolder <path> | -settingsfile <path>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-uuid <uuid>]\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"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-acpi on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-ioapic on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-pae on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-hwvirtex on|off|default]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nestedpaging on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-vtxvpid on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-monitorcount <number>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-accelerate3d <on|off>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-bioslogofadein on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-bioslogofadeout on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-bioslogodisplaytime <msec>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-bioslogoimagepath <imagepath>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-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"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#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
a59528c40bbfdcee2e315756333f8c66f35b5accvboxsync#ifdef VBOX_WITH_SCSI
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-scsi on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-scsiport<1-16> none|<uuid>|<filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-scsitype LsiLogic|BusLogic]\n"
e214bb78026c1d64078b34ca9504d3f5abbc52efvboxsync#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"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nic<1-N> none|null|nat|bridged|intnet|hostonly]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nic<1-N> none|null|nat|bridged|intnet]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN  */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nictype<1-N> Am79C970A|Am79C973"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_E1000
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                                                                              "|82540EM|82543GC|82545EM"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-cableconnected<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nictrace<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nictracefile<1-N> <filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-nicspeed<1-N> <kbps>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-bridgeadapter<1-N> none|<devicename>]\n"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync#if defined(VBOX_WITH_NETFLT)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-hostonlyadapter<1-N> none|<devicename>]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-intnet<1-N> <network name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-natnet<1-N> <network>|default]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-macaddress<1-N> auto|<mac>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-uart<1-N> off|<I/O base> <IRQ>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-uartmode<1-N> disconnected|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                            server <pipe>|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                            client <pipe>|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                            <devicename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_MEM_BALLOONING
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-guestmemoryballoon <balloonsize in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-gueststatisticsinterval <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 );
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("                            [-audio none|null");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fWin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_WINMM
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf(                        "|winmm|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf(                        "|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fSolaris)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf(                        "|solaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fLinux)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf(                        "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_ALSA
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                                             "|alsa"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PULSE
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                                             "|pulse"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                                             );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fDarwin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf(                        "|coreaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf(                            "]\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("                            [-audiocontroller ac97|sb16]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-clipboard disabled|hosttoguest|guesttohost|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                        bidirectional]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fVRDP)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync            RTPrintf("                            [-vrdp on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                     "                            [-vrdpport default|<port>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                     "                            [-vrdpaddress <host>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                     "                            [-vrdpauthtype null|external|guest]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                     "                            [-vrdpmulticon on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                     "                            [-vrdpreusecon on|off]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("                            [-usb on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-usbehci on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-snapshotfolder default|<path>]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    if (u64Cmd & USAGE_IMPORTAPPLIANCE)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    {
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync        RTPrintf("VBoxManage import           <ovf> [--dry-run|-n] [more options]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync                 "    (run with -n to have options displayed for a particular OVF)\n\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    if (u64Cmd & USAGE_EXPORTAPPLIANCE)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync        RTPrintf("VBoxManage export           <machines> --output|-o <ovf>\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync                 "\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync    }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_STARTVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage startvm          <uuid>|<name>\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fVRDP)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync            RTPrintf("                            [-type gui|vrdp]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_CONTROLVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage controlvm        <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            pause|resume|reset|poweroff|savestate|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            acpipowerbutton|acpisleepbutton|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            keyboardputscancode <hex> [<hex> ...]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            injectnmi|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            setlinkstate<1-4> on|off |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            usbattach <uuid>|<address> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            usbdetach <uuid>|<address> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            dvdattach none|<uuid>|<filename>|host:<drive> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            floppyattach none|<uuid>|<filename>|host:<drive> |\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        if (fVRDP)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync            RTPrintf("                            vrdp on|off] |\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("                            setvideomodehint <xres> <yres> <bpp> [display]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            setcredentials <username> <password> <domain>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                           [-allowlocallogon <yes|no>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_DISCARDSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage discardstate     <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_ADOPTSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage adoptstate       <uuid>|<name> <state_file>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_SNAPSHOT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage snapshot         <uuid>|<name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            take <name> [-desc <desc>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            discard <uuid>|<name> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            discardcurrent -state|-all |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            edit <uuid>|<name>|-current\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                 [-newname <name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                                 [-newdesc <desc>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            showvminfo <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync    if (u64Cmd & USAGE_OPENMEDIUM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage openmedium       disk|dvd|floppy <filename>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--type normal|immutable|writethrough] (disk only)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync    if (u64Cmd & USAGE_CLOSEMEDIUM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage closemedium      disk|dvd|floppy <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_SHOWHDINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage showhdinfo       <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_CREATEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync        RTPrintf("VBoxManage createhd         --filename <filename>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            --size <megabytes>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--format VDI|VMDK|VHD] (default: VDI)\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync                 "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--type normal|writethrough] (default: normal)\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--comment <comment>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--remember]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_MODIFYHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage modifyhd         <uuid>|<filename>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--type normal|writethrough|immutable]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--autoreset on|off]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync#if 0
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--compact]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_CLONEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage clonehd          <uuid>|<filename> <outputfile>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--format VDI|VMDK|VHD|RAW|<other>]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync                 "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--type normal|writethrough|immutable]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--remember]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_CONVERTFROMRAW)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync        RTPrintf("VBoxManage convertfromraw   <filename> <outputfile>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--format VDI|VMDK|VHD]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync                 "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "VBoxManage convertfromraw   stdin <outputfile> <bytes>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync                 "                            [--format VDI|VMDK|VHD]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync                 "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_ADDISCSIDISK)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync        RTPrintf("VBoxManage addiscsidisk     --server <name>|<ip>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            --target <target>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--port <port>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--lun <lun>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--encodedlun <lun>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--username <username>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--password <password>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--type normal|writethrough|immutable]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--comment <comment>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync                 "                            [--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    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage setextradata     global|<uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            <key>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            [<value>] (no value deletes key)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    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"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            loghistorycount <value>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_USBFILTER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage usbfilter        add <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -target <uuid>|<name>|global\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -name <string>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -action ignore|hold (global filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-active yes|no] (yes)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-vendorid <XXXX>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-productid <XXXX>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-revision <IIFF>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-manufacturer <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-product <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-remote yes|no] (null, VM filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-serialnumber <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-maskedinterfaces <XXXXXXXX>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_USBFILTER_MODIFY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage usbfilter        modify <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -target <uuid>|<name>|global\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-name <string>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-action ignore|hold] (global filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-active yes|no]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-vendorid <XXXX>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-productid <XXXX>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-revision <IIFF>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-manufacturer <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-product <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-remote yes|no] (null, VM filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-serialnumber <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-maskedinterfaces <XXXXXXXX>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_USBFILTER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage usbfilter        remove <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage sharedfolder     add <vmname>|<uuid>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -name <name> -hostpath <hostpath>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-transient] [-readonly]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        RTPrintf("VBoxManage sharedfolder     remove <vmname>|<uuid>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            -name <name> [-transient]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_VM_STATISTICS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync        RTPrintf("VBoxManage vmstatistics     <vmname>|<uuid> [-reset]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-pattern <pattern>] [-descriptions]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_GUEST_PROPS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_GUESTPROPERTY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync        usageGuestProperty();
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    if (u64Cmd & USAGE_METRICS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync        RTPrintf("VBoxManage metrics          list [*|host|<vmname> [<metric_list>]]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync                 "                                                 (comma-separated)\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "VBoxManage metrics          setup\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-period <seconds>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-samples <count>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-list]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "VBoxManage metrics          query [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "VBoxManage metrics          collect\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-period <seconds>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-samples <count>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-list]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync                 "                            [-detach]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "                            [*|host|<vmname> [<metric_list>]]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync                 "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    }
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync    if (u64Cmd & USAGE_HOSTONLYIFS)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync    {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync        RTPrintf("VBoxManage hostonlyif       ipconfig <name>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                            [--dhcp |\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                            --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                            --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync# if defined(RT_OS_WINDOWS)
410216171f7f7033678589acb6e342303978c918vboxsync                 "                            create |\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync                 "                            remove <name>\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync# endif
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync                 "\n");
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync    }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync#endif
d1fcf24d24368926be13484524a9e378070a9157vboxsync
d1fcf24d24368926be13484524a9e378070a9157vboxsync    if (u64Cmd & USAGE_DHCPSERVER)
d1fcf24d24368926be13484524a9e378070a9157vboxsync    {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync        RTPrintf("VBoxManage dhcpserver       add|modify --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                       --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                [--ip <ip_address>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                 --netmask <network_mask>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                 --lowerip <lower_ip>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                 --upperip <upper_ip>]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                [--enable | --disable]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "VBoxManage dhcpserver       remove --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync                 "                                   --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
d1fcf24d24368926be13484524a9e378070a9157vboxsync                 "\n");
d1fcf24d24368926be13484524a9e378070a9157vboxsync    }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print a usage synopsis and the syntax error message.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    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);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#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}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
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);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    RTPrintf("error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync    return 1;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync