Frontends/VBoxManage/VBoxManageHelp.cpp

	VBoxManageHelp.cpp revision a1b4fb3917412d2632d358ff8989f1ec971f2d5b
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync/* $Id$ */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync/** @file
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * VBoxManage - help and other message output.
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync/*
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * Copyright (C) 2006-2010 Oracle Corporation
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync *
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * available from http://www.virtualbox.org. This file is free software;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * you can redistribute it and/or modify it under the terms of the GNU
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * General Public License (GPL) as published by the Free Software
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync/*******************************************************************************
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync*   Header Files                                                               *
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync*******************************************************************************/
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <VBox/version.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <iprt/buildconfig.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <iprt/ctype.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <iprt/err.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <iprt/getopt.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include <iprt/stream.h>
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#include "VBoxManage.h"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsyncvoid showLogo(PRTSTREAM pStrm)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync{
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    static bool s_fShown; /* show only once */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (!s_fShown)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     VBOX_VERSION_STRING "\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "All rights reserved.\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        s_fShown = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync}
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync{
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fDumpOpts = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef RT_OS_LINUX
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fLinux = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fLinux = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef RT_OS_WINDOWS
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fWin = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fWin = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef RT_OS_SOLARIS
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fSolaris = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fSolaris = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef RT_OS_FREEBSD
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fFreeBSD = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fFreeBSD = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef RT_OS_DARWIN
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fDarwin = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fDarwin = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_VBOXSDL
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fVBoxSDL = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    bool fVBoxSDL = false;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd == USAGE_DUMPOPTS)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fDumpOpts = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fLinux = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fWin = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fSolaris = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fFreeBSD = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fDarwin = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        fVBoxSDL = true;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        u64Cmd = USAGE_ALL;
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                 "Usage:\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                 "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd == USAGE_ALL)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage [-v|--version]    print version number and exit\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage [-q|--nologo] ... suppress the logo\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_LIST)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if defined(VBOX_WITH_NETFLT)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            bridgedifs|dhcpservers|hostinfo|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            hostcpuids|hddbackends|hdds|dvds|floppies|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            usbhost|usbfilters|systemproperties|extpacks\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_SHOWVMINFO)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage showvminfo       <uuid>|<name> [--details]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--machinereadable]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage showvminfo       <uuid>|<name> --log <idx>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_REGISTERVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage registervm       <filename>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_UNREGISTERVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage unregistervm     <uuid>|<name> [--delete]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_CREATEVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage createvm         --name <name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--ostype <ostype>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--register]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--basefolder <path> | --settingsfile <path>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--uuid <uuid>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_MODIFYVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage modifyvm         <uuid|name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--name <name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--ostype <ostype>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--memory <memorysize in MB>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--pagefusion on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vram <vramsize in MB>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--acpi on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_PCI_PASSTHROUGH
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--attachpci 03:04.0]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--attachpci 03:04.0@02:01.0]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--detachpci 03:04.0]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--ioapic on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--pae on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hpet on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hwvirtex on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hwvirtexexcl on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nestedpaging on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--largepages on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vtxvpid on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--synthcpu on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpuidremove <leaf>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpuidremoveall]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hardwareuuid <uuid>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpus <number>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpuhotplug on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--plugcpu <id>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--unplugcpu <id>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cpuexecutioncap <1-100>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--rtcuseutc on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--monitorcount <number>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--accelerate3d on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--accelerate2dvideo on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--firmware bios|efi|efi32|efi64]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--chipset ich9|piix3]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bioslogofadein on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bioslogofadeout on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bioslogodisplaytime <msec>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bioslogoimagepath <imagepath>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--biosbootmenu disabled|menuonly|messageandmenu]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--biossystemtimeoffset <msec>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--biospxedebug on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--boot<1-4> none|floppy|dvd|disk|net>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nic<1-N> none|null|nat|bridged|intnet"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if defined(VBOX_WITH_NETFLT)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "|hostonly"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_VDE
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                        vde"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nictype<1-N> Am79C970A|Am79C973"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_E1000
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                  "|\n                                            82540EM|82543GC|82545EM"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_VIRTIO
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                  "|\n                                            virtio"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif /* VBOX_WITH_VIRTIO */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--cableconnected<1-N> on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nictrace<1-N> on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nictracefile<1-N> <filename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nicspeed<1-N> <kbps>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nicbootprio<1-N> <priority>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nicbandwidthgroup<1-N> none|<name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bridgeadapter<1-N> none|<devicename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if defined(VBOX_WITH_NETFLT)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hostonlyadapter<1-N> none|<devicename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--intnet<1-N> <network name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natnet<1-N> <network>|default]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_VDE
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vdenet<1-N> <network>|default]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                                [<sockrcv>],[<tcpsnd>],\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                                [<tcprcv>]]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                          <hostport>,[<guestip>],<guestport>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natpf<1-N> delete <rulename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nattftpprefix<1-N> <prefix>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nattftpfile<1-N> <file>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nattftpserver<1-N> <ip>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natdnspassdomain<1-N> on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natdnsproxy<1-N> on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--natdnshostresolver<1-N> on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--nataliasmode<1-N> default|[log],[proxyonly],\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                                         [sameports]]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--macaddress<1-N> auto|<mac>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--mouse ps2|usb|usbtablet\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--keyboard ps2|usb\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--uart<1-N> off|<I/O base> <IRQ>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--uartmode<1-N> disconnected|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                             server <pipe>|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                             client <pipe>|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                             file <file>|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                             <devicename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--guestmemoryballoon <balloonsize in MB>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--gueststatisticsinterval <seconds>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--audio none|null");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fWin)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_WINMM
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|winmm|dsound");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|dsound");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fSolaris)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|solaudio"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_SOLARIS_OSS
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                                    "|oss"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                        );
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fLinux)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|oss"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_ALSA
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                                    "|alsa"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_PULSE
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                                    "|pulse"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                        );
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fFreeBSD)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            /* Get the line break sorted when dumping all option variants. */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            if (fDumpOpts)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                RTStrmPrintf(pStrm, "|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                     oss");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            else
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                RTStrmPrintf(pStrm, "|oss");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#ifdef VBOX_WITH_PULSE
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|pulse");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fDarwin)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|coreaudio");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm, "]\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--audiocontroller ac97|hda|sb16]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--clipboard disabled|hosttoguest|guesttohost|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                         bidirectional]\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrde on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeextpack default|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeproperty <name=[value]>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeport <hostport>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeaddress <hostip>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeauthtype null|external|guest]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdeauthlibrary default|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdemulticon on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdereusecon on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdevideochannel on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vrdevideochannelquality <percent>]\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--usb on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--usbehci on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--snapshotfolder default|<path>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--teleporter on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--teleporterport <port>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--teleporteraddress <address|empty>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--teleporterpassword <password>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if 0
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--iocache on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--iocachesize <I/O cache size in MB>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if 0
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--faulttolerance master|standby]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--faulttoleranceaddress <name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--faulttoleranceport <port>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--faulttolerancesyncinterval <msec>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--faulttolerancepassword <password>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_IMPORTAPPLIANCE)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage import           <ovf/ova> [--dry-run|-n] [more options]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            (run with -n to have options displayed\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                             for a particular OVF)\n\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_EXPORTAPPLIANCE)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage export           <machines> --output|-o <ovf/ova>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--legacy09]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--manifest]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--vsys <number of virtual system>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--product <product name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--producturl <product url>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--vendor <vendor name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--vendorurl <vendor url>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--version <version info>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--eula <license text>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                    [--eulafile <filename>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_STARTVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage startvm          <uuid>|<name>\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--type gui");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        if (fVBoxSDL)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync            RTStrmPrintf(pStrm, "|sdl");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm, "|headless]\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_CONTROLVM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    {
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage controlvm        <uuid>|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            pause|resume|reset|poweroff|savestate|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            acpipowerbutton|acpisleepbutton|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            keyboardputscancode <hex> [<hex> ...]|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            setlinkstate<1-N> on|off |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#if defined(VBOX_WITH_NETFLT)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            nic<1-N> null|nat|bridged|intnet|hostonly\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                     [<devicename>] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            nic<1-N> null|nat|bridged|intnet\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                     [<devicename>] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN  */
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            nictrace<1-N> on|off\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            nictracefile<1-N> <filename>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                          <hostport>,[<guestip>],<guestport>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            natpf<1-N> delete <rulename>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            guestmemoryballoon <balloonsize in MB>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            gueststatisticsinterval <seconds>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            usbattach <uuid>|<address> |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            usbdetach <uuid>|<address> |\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            vrde on|off |\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            vrdeport <port> |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            vrdeproperty <name=[value]> |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            vrdevideochannelquality <percent>\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            setvideomodehint <xres> <yres> <bpp> [display] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            setcredentials <username> <password> <domain>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                           [--allowlocallogon <yes|no>] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            teleport --host <name> --port <port>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                   [--maxdowntime <msec>] [--password password]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            plugcpu <id>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            unplugcpu <id>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            cpuexecutioncap <1-100>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    }
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_DISCARDSTATE)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage discardstate     <uuid>|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_ADOPTSTATE)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage adoptstate       <uuid>|<name> <state_file>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_SNAPSHOT)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage snapshot         <uuid>|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            take <name> [--description <desc>] [--pause] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            delete <uuid>|<name> |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            restore <uuid>|<name> |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            restorecurrent |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            edit <uuid>|<name>|--current\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                 [--name <name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                 [--description <desc>] |\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            showvminfo <uuid>|<name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_CLOSEMEDIUM)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage closemedium      disk|dvd|floppy <uuid>|<filename>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--delete]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_STORAGEATTACH)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage storageattach    <uuid|vmname>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            --storagectl <name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            --port <number>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            --device <number>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--type dvddrive|hdd|fdd]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--medium none|emptydrive|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                      <uuid>|<filename>|host:<drive>|iscsi]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--mtype normal|writethrough|immutable|shareable|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                     readonly|multiattach]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--comment <text>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--passthrough on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bandwidthgroup <name>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--forceunmount]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--server <name>|<ip>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--target <target>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--port <port>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--lun <lun>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--encodedlun <lun>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--username <username>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--password <password>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--intnet]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_STORAGECONTROLLER)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage storagectl       <uuid|vmname>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            --name <name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--add ide|sata|scsi|floppy|sas]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--controller LSILogic|LSILogicSAS|BusLogic|\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                                          IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--sataideemulation<1-4> <1-30>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--sataportcount <1-30>]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--hostiocache on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--bootable on|off]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--remove]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_BANDWIDTHCONTROL)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage bandwidthctl     <uuid|vmname>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            --name <name>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--add disk|network]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--limit <megabytes per second>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "                            [--delete]\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync    if (u64Cmd & USAGE_SHOWHDINFO)
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync        RTStrmPrintf(pStrm,
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "VBoxManage showhdinfo       <uuid>|<filename>\n"
040082187f3f86940a3a876e4dd478bd8581b36fvboxsync                     "\n");

    if (u64Cmd & USAGE_CREATEHD)
        RTStrmPrintf(pStrm,
                     "VBoxManage createhd         --filename <filename>\n"
                     "                            --size <megabytes>|--sizebyte <bytes>\n"
                     "                            [--format VDI|VMDK|VHD] (default: VDI)\n"
                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
                     "\n");

    if (u64Cmd & USAGE_MODIFYHD)
        RTStrmPrintf(pStrm,
                     "VBoxManage modifyhd         <uuid>|<filename>\n"
                     "                            [--type normal|writethrough|immutable|shareable|\n"
                     "                                    readonly|multiattach]\n"
                     "                            [--autoreset on|off]\n"
                     "                            [--compact]\n"
                     "                            [--resize <megabytes>|--resizebyte <bytes>]\n"
                     "\n");

    if (u64Cmd & USAGE_CLONEHD)
        RTStrmPrintf(pStrm,
                     "VBoxManage clonehd          <uuid>|<filename> <outputfile>\n"
                     "                            [--format VDI|VMDK|VHD|RAW|<other>]\n"
                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
                     "                            [--existing]\n"
                     "\n");

    if (u64Cmd & USAGE_CONVERTFROMRAW)
        RTStrmPrintf(pStrm,
                     "VBoxManage convertfromraw   <filename> <outputfile>\n"
                     "                            [--format VDI|VMDK|VHD]\n"
                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
#ifndef RT_OS_WINDOWS
                     "VBoxManage convertfromraw   stdin <outputfile> <bytes>\n"
                     "                            [--format VDI|VMDK|VHD]\n"
                     "                            [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
#endif
                     "\n");

    if (u64Cmd & USAGE_GETEXTRADATA)
        RTStrmPrintf(pStrm,
                     "VBoxManage getextradata     global|<uuid>|<name>\n"
                     "                            <key>|enumerate\n"
                     "\n");

    if (u64Cmd & USAGE_SETEXTRADATA)
        RTStrmPrintf(pStrm,
                     "VBoxManage setextradata     global|<uuid>|<name>\n"
                     "                            <key>\n"
                     "                            [<value>] (no value deletes key)\n"
                     "\n");

    if (u64Cmd & USAGE_SETPROPERTY)
        RTStrmPrintf(pStrm,
                     "VBoxManage setproperty      machinefolder default|<folder> |\n"
                     "                            vrdeauthlibrary default|<library> |\n"
                     "                            websrvauthlibrary default|null|<library> |\n"
                     "                            vrdeextpack null|<library> |\n"
                     "                            loghistorycount <value>\n"
                     "\n");

    if (u64Cmd & USAGE_USBFILTER_ADD)
        RTStrmPrintf(pStrm,
                     "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)
        RTStrmPrintf(pStrm,
                     "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)
        RTStrmPrintf(pStrm,
                     "VBoxManage usbfilter        remove <index,0-N>\n"
                     "                            --target <uuid>|<name>|global\n"
                     "\n");

    if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
        RTStrmPrintf(pStrm,
                     "VBoxManage sharedfolder     add <vmname>|<uuid>\n"
                     "                            --name <name> --hostpath <hostpath>\n"
                     "                            [--transient] [--readonly] [--automount]\n"
                     "\n");

    if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
        RTStrmPrintf(pStrm,
                     "VBoxManage sharedfolder     remove <vmname>|<uuid>\n"
                     "                            --name <name> [--transient]\n"
                     "\n");

#ifdef VBOX_WITH_GUEST_PROPS
    if (u64Cmd & USAGE_GUESTPROPERTY)
        usageGuestProperty(pStrm);
#endif /* VBOX_WITH_GUEST_PROPS defined */

#ifdef VBOX_WITH_GUEST_CONTROL
    if (u64Cmd & USAGE_GUESTCONTROL)
        usageGuestControl(pStrm);
#endif /* VBOX_WITH_GUEST_CONTROL defined */

    if (u64Cmd & USAGE_DEBUGVM)
    {
        RTStrmPrintf(pStrm,
                     "VBoxManage debugvm          <uuid>|<name>\n"
                     "                            dumpguestcore --filename <name> |\n"
                     "                            info <item> [args] |\n"
                     "                            injectnmi |\n"
                     "                            osdetect |\n"
                     "                            osinfo |\n"
                     "                            getregisters [--cpu <id>] <reg>|all ... |\n"
                     "                            setregisters [--cpu <id>] <reg>=<value> ... |\n"
                     "                            statistics [--reset] [--pattern <pattern>]\n"
                     "                            [--descriptions]\n"
                     "\n");
    }
    if (u64Cmd & USAGE_METRICS)
        RTStrmPrintf(pStrm,
                     "VBoxManage metrics          list [*|host|<vmname> [<metric_list>]]\n"
                     "                                                 (comma-separated)\n\n"
                     "VBoxManage metrics          setup\n"
                     "                            [--period <seconds>] (default: 1)\n"
                     "                            [--samples <count>] (default: 1)\n"
                     "                            [--list]\n"
                     "                            [*|host|<vmname> [<metric_list>]]\n\n"
                     "VBoxManage metrics          query [*|host|<vmname> [<metric_list>]]\n\n"
                     "VBoxManage metrics          enable\n"
                     "                            [--list]\n"
                     "                            [*|host|<vmname> [<metric_list>]]\n\n"
                     "VBoxManage metrics          disable\n"
                     "                            [--list]\n"
                     "                            [*|host|<vmname> [<metric_list>]]\n\n"
                     "VBoxManage metrics          collect\n"
                     "                            [--period <seconds>] (default: 1)\n"
                     "                            [--samples <count>] (default: 1)\n"
                     "                            [--list]\n"
                     "                            [--detach]\n"
                     "                            [*|host|<vmname> [<metric_list>]]\n"
                     "\n");

#if defined(VBOX_WITH_NETFLT)
    if (u64Cmd & USAGE_HOSTONLYIFS)
    {
        RTStrmPrintf(pStrm,
                     "VBoxManage hostonlyif       ipconfig <name>\n"
                     "                            [--dhcp |\n"
                     "                            --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
                     "                            --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
# if !defined(RT_OS_SOLARIS)
                     "                            create |\n"
                     "                            remove <name>\n"
# endif
                     "\n");
    }
#endif

    if (u64Cmd & USAGE_DHCPSERVER)
    {
        RTStrmPrintf(pStrm,
                     "VBoxManage dhcpserver       add|modify --netname <network_name> |\n"
#if defined(VBOX_WITH_NETFLT)
                     "                                       --ifname <hostonly_if_name>\n"
#endif
                     "                            [--ip <ip_address>\n"
                     "                            --netmask <network_mask>\n"
                     "                            --lowerip <lower_ip>\n"
                     "                            --upperip <upper_ip>]\n"
                     "                            [--enable | --disable]\n\n"
                     "VBoxManage dhcpserver       remove --netname <network_name> |\n"
#if defined(VBOX_WITH_NETFLT)
                     "                                   --ifname <hostonly_if_name>\n"
#endif
                     "\n");
    }
    if (u64Cmd & USAGE_EXTPACK)
    {
        RTStrmPrintf(pStrm,
                     "VBoxManage extpack          install <tarball> |\n"
                     "                            uninstall [--force] <name> |\n"
                     "                            cleanup\n"
                     "\n");
    }
}

/**
 * Print a usage synopsis and the syntax error message.
 * @returns RTEXITCODE_SYNTAX.
 */
RTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
{
    va_list args;
    showLogo(g_pStdErr); // show logo even if suppressed
#ifndef VBOX_ONLY_DOCS
    if (g_fInternalMode)
        printUsageInternal(u64Cmd, g_pStdErr);
    else
        printUsage(u64Cmd, g_pStdErr);
#endif /* !VBOX_ONLY_DOCS */
    va_start(args, pszFormat);
    RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
    va_end(args);
    return RTEXITCODE_SYNTAX;
}

/**
 * errorSyntax for RTGetOpt users.
 *
 * @returns RTEXITCODE_SYNTAX.
 *
 * @param   fUsageCategory  The usage category of the command.
 * @param   rc              The RTGetOpt return code.
 * @param   pValueUnion     The value union.
 */
RTEXITCODE errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
{
    /*
     * Check if it is an unhandled standard option.
     */
    if (rc == 'V')
    {
        RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
        return RTEXITCODE_SUCCESS;
    }

    if (rc == 'h')
    {
        showLogo(g_pStdErr);
#ifndef VBOX_ONLY_DOCS
        if (g_fInternalMode)
            printUsageInternal(fUsageCategory, g_pStdOut);
        else
            printUsage(fUsageCategory, g_pStdOut);
#endif
        return RTEXITCODE_SUCCESS;
    }

    /*
     * General failure.
     */
    showLogo(g_pStdErr); // show logo even if suppressed
#ifndef VBOX_ONLY_DOCS
    if (g_fInternalMode)
        printUsageInternal(fUsageCategory, g_pStdErr);
    else
        printUsage(fUsageCategory, g_pStdErr);
#endif /* !VBOX_ONLY_DOCS */

    if (rc == VINF_GETOPT_NOT_OPTION)
        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
    if (rc > 0)
    {
        if (RT_C_IS_PRINT(rc))
            return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
    }
    if (rc == VERR_GETOPT_UNKNOWN_OPTION)
        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
    if (pValueUnion->pDef)
        return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
    return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
}

/**
 * Print an error message without the syntax stuff.
 *
 * @returns RTEXITCODE_SYNTAX.
 */
RTEXITCODE errorArgument(const char *pszFormat, ...)
{
    va_list args;
    va_start(args, pszFormat);
    RTMsgErrorV(pszFormat, args);
    va_end(args);
    return RTEXITCODE_SYNTAX;
}