VBoxManageHelp.cpp revision 6febf3149010855617e4a37e2c49f93d68930d44
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
904810c4c6668233349b025cc58013cb7c11c701vboxsync * Copyright (C) 2006-2011 Oracle Corporation
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
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync/*******************************************************************************
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync* Header Files *
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync*******************************************************************************/
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#include <VBox/version.h>
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#include <iprt/buildconfig.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/ctype.h>
e0778e583cb4a0bdc9bcc48f5957e00a01108388vboxsync#include <iprt/err.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/getopt.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/stream.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include "VBoxManage.h"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsyncvoid showLogo(PRTSTREAM pStrm)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync{
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync static bool s_fShown; /* show only once */
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync if (!s_fShown)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync VBOX_VERSION_STRING "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "All rights reserved.\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync s_fShown = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync }
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync}
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync bool fDumpOpts = false;
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
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef RT_OS_FREEBSD
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#else
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = false;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_DARWIN
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef VBOX_WITH_VBOXSDL
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#else
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync fDumpOpts = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fSolaris = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "Usage:\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_ALL)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage [-v|--version] print version number and exit\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_LIST)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#if defined(VBOX_WITH_NETFLT)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#else
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " bridgedifs|dhcpservers|hostinfo|\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#endif
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " usbhost|usbfilters|systemproperties|extpacks\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_SHOWVMINFO)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage showvminfo <uuid>|<name> [--details]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--machinereadable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage showvminfo <uuid>|<name> --log <idx>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync if (u64Cmd & USAGE_REGISTERVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync "VBoxManage registervm <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_UNREGISTERVM)
4715f6e2473402353acb43c06a8986f957758259vboxsync RTStrmPrintf(pStrm,
4715f6e2473402353acb43c06a8986f957758259vboxsync "VBoxManage unregistervm <uuid>|<name> [--delete]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEVM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "VBoxManage createvm --name <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--register]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--basefolder <path>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--uuid <uuid>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_MODIFYVM)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage modifyvm <uuid|name>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--name <name>]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--ostype <ostype>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--memory <memorysize in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--pagefusion on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vram <vramsize in MB>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--acpi on|off]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#ifdef VBOX_WITH_PCI_PASSTHROUGH
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " [--pciattach 03:04.0]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pciattach 03:04.0@02:01.0]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pcidetach 03:04.0]\n"
7e8d44e04156d78379666f20d5daa2a79e5cbf44vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ioapic on|off]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--pae on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--hpet on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--hwvirtex on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--hwvirtexexcl on|off]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--nestedpaging on|off]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--largepages on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vtxvpid on|off]\n"
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " [--synthcpu on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremove <leaf>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremoveall]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hardwareuuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpus <number>]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync " [--cpuhotplug on|off]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--plugcpu <id>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--unplugcpu <id>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--cpuexecutioncap <1-100>]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync " [--rtcuseutc on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--monitorcount <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate3d on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
85bc82f92f4d7a7b95e96d133c4847b2847703dfvboxsync " [--accelerate2dvideo on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--firmware bios|efi|efi32|efi64]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--chipset ich9|piix3]\n"
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync " [--bioslogofadein on|off]\n"
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync " [--bioslogofadeout on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogodisplaytime <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogoimagepath <imagepath>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biossystemtimeoffset <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biospxedebug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|hostonly"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n"
8b36957d815c23b479eb35d93ac76c66392e9402vboxsync " generic"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictype<1-N> Am79C970A|Am79C973"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#ifdef VBOX_WITH_E1000
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n 82540EM|82543GC|82545EM"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_VIRTIO
7a29aa5ce149ccd344a2929d2815b8e212690b92vboxsync "|\n virtio"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* VBOX_WITH_VIRTIO */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cableconnected<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictrace<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictracefile<1-N> <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicproperty<1-N> name=[value]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicspeed<1-N> <kbps>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicbootprio<1-N> <priority>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--nicbandwidthgroup<1-N> none|<name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet<1-N> <network name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natnet<1-N> <network>|default]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nicgenericdrv<1-N> <driver>\n"
5453eb2f2719bf3895ac3daeec4c26e0b6e2eb4avboxsync " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [<sockrcv>],[<tcpsnd>],\n"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync " [<tcprcv>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync " <hostport>,[<guestip>],<guestport>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natpf<1-N> delete <rulename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpprefix<1-N> <prefix>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpfile<1-N> <file>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nattftpserver<1-N> <ip>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--natbindip<1-N> <ip>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnspassdomain<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnsproxy<1-N> on|off]\n"
b604fbf16eda38d14b4999c245f032bfaa5aa85avboxsync " [--natdnshostresolver<1-N> on|off]\n"
93c114476cca834cde109c60bfb95094fcd2c995vboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [sameports]]\n"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync " [--macaddress<1-N> auto|<mac>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--mouse ps2|usb|usbtablet\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync " [--keyboard ps2|usb\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uartmode<1-N> disconnected|\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " server <pipe>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " client <pipe>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " file <file>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--gueststatisticsinterval <seconds>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--audio none|null");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fWin)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_WINMM
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync RTStrmPrintf(pStrm, "|winmm|dsound");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#else
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|dsound");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fSolaris)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
a85c47589af3385deccdbb1367b75108806d7cf5vboxsync RTStrmPrintf(pStrm, "|solaudio"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_SOLARIS_OSS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|oss"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fLinux)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync RTStrmPrintf(pStrm, "|oss"
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync#ifdef VBOX_WITH_ALSA
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync "|alsa"
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_PULSE
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "|pulse"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (fFreeBSD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync /* Get the line break sorted when dumping all option variants. */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDumpOpts)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " oss");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync else
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|oss");
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#ifdef VBOX_WITH_PULSE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|pulse");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDarwin)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|coreaudio");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "]\n");
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--audiocontroller ac97|hda|sb16]\n"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " bidirectional]\n");
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTStrmPrintf(pStrm,
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync " [--vrde on|off]\n"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync " [--vrdeextpack default|<name>\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--vrdeproperty <name=[value]>]\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--vrdeport <hostport>]\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--vrdeaddress <hostip>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--vrdeauthtype null|external|guest]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdeauthlibrary default|<name>\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--vrdemulticon on|off]\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--vrdereusecon on|off]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--vrdevideochannel on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdevideochannelquality <percent>]\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--usb on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--usbehci on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--snapshotfolder default|<path>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--teleporter on|off]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--teleporterport <port>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--teleporteraddress <address|empty>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--teleporterpassword <password>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#if 0
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocachesize <I/O cache size in MB>]\n"
2a171646d32f8a15e9820d6fb3bf3f9b9990ca3fvboxsync#endif
2a171646d32f8a15e9820d6fb3bf3f9b9990ca3fvboxsync#if 0
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--faulttolerance master|standby]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--faulttoleranceaddress <name>]\n"
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync " [--faulttoleranceport <port>]\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--faulttolerancesyncinterval <msec>]\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " [--faulttolerancepassword <password>]\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync#endif
3933885bc0c2c93436d858a14564c6179ec72872vboxsync "\n");
6e25221ce8ef8e656d1e15eb7ec5cf8ae758ceb2vboxsync }
3933885bc0c2c93436d858a14564c6179ec72872vboxsync
3933885bc0c2c93436d858a14564c6179ec72872vboxsync if (u64Cmd & USAGE_CLONEVM)
3933885bc0c2c93436d858a14564c6179ec72872vboxsync RTStrmPrintf(pStrm,
3933885bc0c2c93436d858a14564c6179ec72872vboxsync "VBoxManage clonevm <uuid>|<name>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--snapshot <uuid>|<name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--mode machine|machineandchildren|all]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--options link|keepallmacs|keepnatmacs|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " keepdisknames]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--basefolder <basefolder>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--register]\n"
23d9dbdaf1b83107abf9882246a4a46933f733efvboxsync "\n");
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync RTStrmPrintf(pStrm,
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync "VBoxManage import <ovf/ova>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--dry-run|-n]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--options keepallmacs|keepnatmacs]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync " [more options]\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync " (run with -n to have options displayed\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " for a particular OVF)\n\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage export <machines> --output|-o <ovf/ova>\n"
7708252d252a55417a6a817041e4356797e34255vboxsync " [--legacy09]\n"
62ab017295981c81484e5a5f93ff8b5f85f7defbvboxsync " [--manifest]\n"
62ab017295981c81484e5a5f93ff8b5f85f7defbvboxsync " [--vsys <number of virtual system>]\n"
62ab017295981c81484e5a5f93ff8b5f85f7defbvboxsync " [--product <product name>]\n"
7708252d252a55417a6a817041e4356797e34255vboxsync " [--producturl <product url>]\n"
7708252d252a55417a6a817041e4356797e34255vboxsync " [--vendor <vendor name>]\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync " [--vendorurl <vendor url>]\n"
45a01ef53b009e9f56ce427bd8688da02ad32389vboxsync " [--version <version info>]\n"
45a01ef53b009e9f56ce427bd8688da02ad32389vboxsync " [--eula <license text>]\n"
9a32cc64d7694b4b8c46bbf17fdbb5e5f60d2d4avboxsync " [--eulafile <filename>]\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync "\n");
94c4b844625733fedcd2b473c207981b31316bd9vboxsync
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync if (u64Cmd & USAGE_STARTVM)
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync {
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync RTStrmPrintf(pStrm,
48890ac9b4b339e0341e826b5c26ce6408729987vboxsync "VBoxManage startvm <uuid>|<name>...\n");
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync RTStrmPrintf(pStrm,
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync " [--type gui");
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync if (fVBoxSDL)
5d57bcb78f1f3f918bd3daf709b551b8c2d30485vboxsync RTStrmPrintf(pStrm, "|sdl");
cccc6ee5f7156cfcdf13acca545cf65124d9ed44vboxsync RTStrmPrintf(pStrm, "|headless]\n");
9a32cc64d7694b4b8c46bbf17fdbb5e5f60d2d4avboxsync RTStrmPrintf(pStrm,
904810c4c6668233349b025cc58013cb7c11c701vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CONTROLVM)
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync {
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "VBoxManage controlvm <uuid>|<name>\n"
776985d1f8ee71ad78aa1067cce88766803c7b30vboxsync " pause|resume|reset|poweroff|savestate|\n"
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync " acpipowerbutton|acpisleepbutton|\n"
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync " setlinkstate<1-N> on|off |\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync#if defined(VBOX_WITH_NETFLT)
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " nic<1-N> null|nat|bridged|intnet|hostonly|generic"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync "\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [<devicename>] |\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync#else /* !VBOX_WITH_NETFLT */
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " nic<1-N> null|nat|bridged|intnet|generic\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [<devicename>] |\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync#endif /* !VBOX_WITH_NETFLT */
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " nictrace<1-N> on|off\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " nictracefile<1-N> <filename>\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync " nicproperty<1-N> name=[value]\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync " <hostport>,[<guestip>],<guestport>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " natpf<1-N> delete <rulename>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " guestmemoryballoon <balloonsize in MB>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " gueststatisticsinterval <seconds>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " usbattach <uuid>|<address> |\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " usbdetach <uuid>|<address> |\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
454ac5c6ef4960887035ceea6b5247789d3272davboxsync " vrde on|off |\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " vrdeport <port> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " vrdeproperty <name=[value]> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " vrdevideochannelquality <percent>\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setvideomodehint <xres> <yres> <bpp> [display] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " screenshotpng <file> [display] |\n"
e59069cf1c98c1c2e90a18ec76fbc2e9907fb917vboxsync " setcredentials <username> <password> <domain>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--allowlocallogon <yes|no>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " teleport --host <name> --port <port>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--maxdowntime <msec>] [--password password]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " plugcpu <id>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " unplugcpu <id>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " cpuexecutioncap <1-100>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync }
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (u64Cmd & USAGE_DISCARDSTATE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage discardstate <uuid>|<name>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_ADOPTSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage adoptstate <uuid>|<name> <state_file>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync if (u64Cmd & USAGE_SNAPSHOT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage snapshot <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " take <name> [--description <desc>] [--pause] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " delete <uuid>|<name> |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync " restore <uuid>|<name> |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " restorecurrent |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " edit <uuid>|<name>|--current\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--description <desc>] |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " showvminfo <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync RTStrmPrintf(pStrm,
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync "VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--delete]\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync "\n");
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync if (u64Cmd & USAGE_STORAGEATTACH)
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage storageattach <uuid|vmname>\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " --storagectl <name>\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " [--port <number>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--device <number>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--type dvddrive|hdd|fdd]\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " [--medium none|emptydrive|\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " <uuid>|<filename>|host:<drive>|iscsi]\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--mtype normal|writethrough|immutable|shareable|\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " readonly|multiattach]\n"
28ae9ced88db55943497a8bb98682bc2be513476vboxsync " [--comment <text>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--setuuid <uuid>]\n"
28ae9ced88db55943497a8bb98682bc2be513476vboxsync " [--setparentuuid <uuid>]\n"
9ce5d949e4f1572d445a5c0aecabe9de8b672c99vboxsync " [--passthrough on|off]\n"
ab9d561bc33f1705a10c5e4bffed9c9e660dc32fvboxsync " [--tempeject on|off]\n"
ab9d561bc33f1705a10c5e4bffed9c9e660dc32fvboxsync " [--nonrotational on|off]\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " [--discard on|off]\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " [--bandwidthgroup <name>]\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " [--forceunmount]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--server <name>|<ip>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--target <target>]\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [--tport <port>]\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [--lun <lun>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--encodedlun <lun>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--username <username>]\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [--password <password>]\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " [--intnet]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_STORAGECONTROLLER)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage storagectl <uuid|vmname>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " --name <name>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--add ide|sata|scsi|floppy|sas]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--sataideemulation<1-4> <1-30>]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--sataportcount <1-30>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--hostiocache on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bootable on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--remove]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_BANDWIDTHCONTROL)
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "VBoxManage bandwidthctl <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--add disk|network]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--limit <megabytes per second>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--delete]\n"
a5224d14bb71df1d2da62ff9e4b0598ed5d2d85fvboxsync "\n");
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_SHOWHDINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync "VBoxManage showhdinfo <uuid>|<filename>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CREATEHD)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage createhd --filename <filename>\n"
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync " --diffparent <uuid>|<filename>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--size <megabytes>|--sizebyte <bytes>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync "\n");
1568d715e75b8d2484ea3dc87f0483d4cf377838vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_MODIFYHD)
c0a5da26f7222b0a486d6d9ba4d1f475a78a2c73vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "VBoxManage modifyhd <uuid>|<filename>\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--type normal|writethrough|immutable|shareable|\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync " readonly|multiattach]\n"
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync " [--autoreset on|off]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--compact]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--resize <megabytes>|--resizebyte <bytes>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync
051eba4436f9c682f7873390fb327e8eceb9e0efvboxsync if (u64Cmd & USAGE_CLONEHD)
6febf3149010855617e4a37e2c49f93d68930d44vboxsync RTStrmPrintf(pStrm,
63b785c3291332a86a9bc473e68f08121368898bvboxsync "VBoxManage clonehd <uuid>|<filename> <uuid>|<outputfile>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--existing]\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync "\n");
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync RTStrmPrintf(pStrm,
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync "VBoxManage convertfromraw <filename> <outputfile>\n"
48dafba24ef28f07a241e5857a43b327822574a8vboxsync " [--format VDI|VMDK|VHD]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--uuid <uuid>\n>"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync#ifndef RT_OS_WINDOWS
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--format VDI|VMDK|VHD]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uuid <uuid>\n>"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_GETEXTRADATA)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
bf88068260ded16af90b7da4867240fbdd9c8017vboxsync "VBoxManage getextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>|enumerate\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync
63b785c3291332a86a9bc473e68f08121368898bvboxsync if (u64Cmd & USAGE_SETEXTRADATA)
63b785c3291332a86a9bc473e68f08121368898bvboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage setextradata global|<uuid>|<name>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " <key>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [<value>] (no value deletes key)\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync "\n");
94c4b844625733fedcd2b473c207981b31316bd9vboxsync
e67a57a63d60b971a077d325eb0872a3ccde94a4vboxsync if (u64Cmd & USAGE_SETPROPERTY)
e67a57a63d60b971a077d325eb0872a3ccde94a4vboxsync RTStrmPrintf(pStrm,
94c4b844625733fedcd2b473c207981b31316bd9vboxsync "VBoxManage setproperty machinefolder default|<folder> |\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " vrdeauthlibrary default|<library> |\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " websrvauthlibrary default|null|<library> |\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync " vrdeextpack null|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " loghistorycount <value>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage usbfilter add <index,0-N>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " --target <uuid>|<name>|global\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " --name <string>\n"
d502d47b275da0a8ecb1c2ec00d22ac396a61af4vboxsync " --action ignore|hold (global filters only)\n"
0a8b697b439859902a19c75e4a1d315ab03c57f9vboxsync " [--active yes|no] (yes)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>] (null)\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--revision <IIFF>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--manufacturer <string>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--product <string>] (null)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--remote yes|no] (null, VM filters only)\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--serialnumber <string>] (null)\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
5434d84d270a73565d8c3bed826cb4f95aba317bvboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage usbfilter modify <index,0-N>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--name <string>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--action ignore|hold] (global filters only)\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--active yes|no]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>|\"\"]\n"
5b298681ed3a24f71adcf7b557d3b0f850967bbfvboxsync " [--revision <IIFF>|\"\"]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--manufacturer <string>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--product <string>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--remote yes|no] (null, VM filters only)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--serialnumber <string>|\"\"]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
4487ec756a4d0326ace76c20fd8a29d618b19a48vboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter remove <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
4487ec756a4d0326ace76c20fd8a29d618b19a48vboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage sharedfolder add <vmname>|<uuid>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " --name <name> --hostpath <hostpath>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--transient] [--readonly] [--automount]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "VBoxManage sharedfolder remove <vmname>|<uuid>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> [--transient]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_GUEST_PROPS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync usageGuestProperty(pStrm);
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
3933885bc0c2c93436d858a14564c6179ec72872vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_GUEST_CONTROL
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync if (u64Cmd & USAGE_GUESTCONTROL)
200cc6562c6e5cec617903ea827cfb22083f5325vboxsync usageGuestControl(pStrm);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
904810c4c6668233349b025cc58013cb7c11c701vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_DEBUGVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage debugvm <uuid>|<name>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " dumpguestcore --filename <name> |\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " info <item> [args] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " injectnmi |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " osdetect |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " osinfo |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " getregisters [--cpu <id>] <reg>|all ... |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setregisters [--cpu <id>] <reg>=<value> ... |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " statistics [--reset] [--pattern <pattern>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--descriptions]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_METRICS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " (comma-separated)\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics setup\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--period <seconds>] (default: 1)\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--samples <count>] (default: 1)\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics enable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics disable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics collect\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>] (default: 1)\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--list]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--detach]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [*|host|<vmname> [<metric_list>]]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync#if defined(VBOX_WITH_NETFLT)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (u64Cmd & USAGE_HOSTONLYIFS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage hostonlyif ipconfig <name>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " [--dhcp |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync# if !defined(RT_OS_SOLARIS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " create |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " remove <name>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync# endif
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_DHCPSERVER)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage dhcpserver add|modify --netname <network_name> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
d450629f624308cb06e59a13554c697afea563d8vboxsync " --ifname <hostonly_if_name>\n"
d450629f624308cb06e59a13554c697afea563d8vboxsync#endif
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--ip <ip_address>\n"
d450629f624308cb06e59a13554c697afea563d8vboxsync " --netmask <network_mask>\n"
d450629f624308cb06e59a13554c697afea563d8vboxsync " --lowerip <lower_ip>\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync " --upperip <upper_ip>]\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync " [--enable | --disable]\n\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync#if defined(VBOX_WITH_NETFLT)
5f32a23884cca588e95be86778770d60cbc529f7vboxsync " --ifname <hostonly_if_name>\n"
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync#endif
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync "\n");
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync }
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync if (u64Cmd & USAGE_EXTPACK)
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync {
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync RTStrmPrintf(pStrm,
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync "VBoxManage extpack install [--replace] <tarball> |\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " uninstall [--force] <name> |\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " cleanup\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync "\n");
94c4b844625733fedcd2b473c207981b31316bd9vboxsync }
94c4b844625733fedcd2b473c207981b31316bd9vboxsync}
94c4b844625733fedcd2b473c207981b31316bd9vboxsync
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync/**
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync * Print a usage synopsis and the syntax error message.
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync * @returns RTEXITCODE_SYNTAX.
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncRTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync{
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync va_list args;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync showLogo(g_pStdErr); // show logo even if suppressed
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#ifndef VBOX_ONLY_DOCS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (g_fInternalMode)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync printUsageInternal(u64Cmd, g_pStdErr);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync else
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync printUsage(u64Cmd, g_pStdErr);
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#endif /* !VBOX_ONLY_DOCS */
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync va_start(args, pszFormat);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync va_end(args);
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync return RTEXITCODE_SYNTAX;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync}
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync/**
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync * errorSyntax for RTGetOpt users.
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync *
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync * @returns RTEXITCODE_SYNTAX.
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync *
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync * @param fUsageCategory The usage category of the command.
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync * @param rc The RTGetOpt return code.
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync * @param pValueUnion The value union.
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync */
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsyncRTEXITCODE errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync{
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync /*
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync * Check if it is an unhandled standard option.
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (rc == 'V')
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
98fbc4732a9519502e92799ef769789cbdd97dcevboxsync RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return RTEXITCODE_SUCCESS;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (rc == 'h')
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync {
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync showLogo(g_pStdErr);
d1fcf24d24368926be13484524a9e378070a9157vboxsync#ifndef VBOX_ONLY_DOCS
d1fcf24d24368926be13484524a9e378070a9157vboxsync if (g_fInternalMode)
d1fcf24d24368926be13484524a9e378070a9157vboxsync printUsageInternal(fUsageCategory, g_pStdOut);
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync else
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync printUsage(fUsageCategory, g_pStdOut);
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync return RTEXITCODE_SUCCESS;
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync }
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync /*
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync * General failure.
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync */
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync showLogo(g_pStdErr); // show logo even if suppressed
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#ifndef VBOX_ONLY_DOCS
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync if (g_fInternalMode)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync printUsageInternal(fUsageCategory, g_pStdErr);
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync else
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync printUsage(fUsageCategory, g_pStdErr);
d1fcf24d24368926be13484524a9e378070a9157vboxsync#endif /* !VBOX_ONLY_DOCS */
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync if (rc == VINF_GETOPT_NOT_OPTION)
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync if (rc > 0)
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync {
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync if (RT_C_IS_PRINT(rc))
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (rc == VERR_GETOPT_UNKNOWN_OPTION)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (pValueUnion->pDef)
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync * Print an error message without the syntax stuff.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync *
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * @returns RTEXITCODE_SYNTAX.
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncRTEXITCODE errorArgument(const char *pszFormat, ...)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTMsgErrorV(pszFormat, args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTEXITCODE_SYNTAX;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync