VBoxManageHelp.cpp revision 824ae3158a8b8f8233fec3f5a12c81f139933698
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
5d39cab83ac9a6c6e4c5da4690ac53b4cfec73aavboxsync * Copyright (C) 2006-2010 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/ctype.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/err.h>
e0778e583cb4a0bdc9bcc48f5957e00a01108388vboxsync#include <iprt/getopt.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/stream.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include "VBoxManage.h"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsyncvoid showLogo(PRTSTREAM pStrm)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync{
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync static bool s_fShown; /* show only once */
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync if (!s_fShown)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync {
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync VBOX_VERSION_STRING "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "All rights reserved.\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync s_fShown = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync }
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync}
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDumpOpts = false;
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#ifdef RT_OS_LINUX
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_WINDOWS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_SOLARIS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_FREEBSD
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#else
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = false;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef RT_OS_DARWIN
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VRDP
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVRDP = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#else
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVRDP = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#endif
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef VBOX_WITH_VBOXSDL
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = false;
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync fDumpOpts = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fLinux = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync fVRDP = true;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync fVBoxSDL = true;
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "Usage:\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage [-v|--version] print version number and exit\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync if (u64Cmd & USAGE_LIST)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#else
66b8ee000e49b0cc08a897451350cd6927d77b60vboxsync " bridgedifs|dhcpservers|hostinfo|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " usbhost|usbfilters|systemproperties\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SHOWVMINFO)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--machinereadable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage showvminfo <uuid>|<name> --log <idx>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_REGISTERVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage registervm <filename>\n"
7e8d44e04156d78379666f20d5daa2a79e5cbf44vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_UNREGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage unregistervm <uuid>|<name> [--delete]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CREATEVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage createvm --name <name>\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync " [--ostype <ostype>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--register]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--basefolder <path> | --settingsfile <path>]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--uuid <uuid>]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_MODIFYVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
85bc82f92f4d7a7b95e96d133c4847b2847703dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage modifyvm <uuid|name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--memory <memorysize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pagefusion on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vram <vramsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--acpi on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ioapic on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pae on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hpet on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hwvirtex on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nestedpaging on|off]\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " [--largepages on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vtxvpid on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--synthcpu on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [--cpuidremove <leaf>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremoveall]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync " [--hardwareuuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpus <number>]\n"
7a29aa5ce149ccd344a2929d2815b8e212690b92vboxsync " [--cpuhotplug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--plugcpu <id>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--unplugcpu <id>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--rtcuseutc on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--monitorcount <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate3d on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate2dvideo on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--firmware bios|efi|efi32|efi64]\n"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync " [--bioslogofadein on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogofadeout on|off]\n"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync " [--bioslogodisplaytime <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogoimagepath <imagepath>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biossystemtimeoffset <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biospxedebug on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
5453eb2f2719bf3895ac3daeec4c26e0b6e2eb4avboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync "|hostonly"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#ifdef VBOX_WITH_VDE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " vde"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--nictype<1-N> Am79C970A|Am79C973"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_E1000
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n 82540EM|82543GC|82545EM"
b604fbf16eda38d14b4999c245f032bfaa5aa85avboxsync#endif
93c114476cca834cde109c60bfb95094fcd2c995vboxsync#ifdef VBOX_WITH_VIRTIO
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n virtio"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync#endif /* VBOX_WITH_VIRTIO */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync " [--cableconnected<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictrace<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictracefile<1-N> <filename>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--nicspeed<1-N> <kbps>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicbootprio<1-N> <priority>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet<1-N> <network name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natnet<1-N> <network>|default]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_VDE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vdenet<1-N> <network>|default]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<sockrcv>],[<tcpsnd>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<tcprcv>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <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"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnspassdomain<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnsproxy<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--natdnshostresolver<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [sameports]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--macaddress<1-N> auto|<mac>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--mouse ps2|usb|usbtablet\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--keyboard ps2|usb\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--uartmode<1-N> disconnected|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " server <pipe>|\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " client <pipe>|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " file <file>|\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " <devicename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--gueststatisticsinterval <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--audio none|null");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fWin)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#ifdef VBOX_WITH_WINMM
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|winmm|dsound");
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#else
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fSolaris)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|solaudio"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_SOLARIS_OSS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|oss"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (fLinux)
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync {
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTStrmPrintf(pStrm, "|oss"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef VBOX_WITH_ALSA
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync "|alsa"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#endif
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#ifdef VBOX_WITH_PULSE
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "|pulse"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync );
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync }
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 }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync else
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|oss");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync#ifdef VBOX_WITH_PULSE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|pulse");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync if (fDarwin)
3933885bc0c2c93436d858a14564c6179ec72872vboxsync {
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync RTStrmPrintf(pStrm, "|coreaudio");
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync }
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync RTStrmPrintf(pStrm, "]\n");
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync RTStrmPrintf(pStrm,
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--audiocontroller ac97|hda|sb16]\n"
6e25221ce8ef8e656d1e15eb7ec5cf8ae758ceb2vboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " bidirectional]\n");
3933885bc0c2c93436d858a14564c6179ec72872vboxsync if (fVRDP)
3933885bc0c2c93436d858a14564c6179ec72872vboxsync {
3933885bc0c2c93436d858a14564c6179ec72872vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--vrdp on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpport default|<ports>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpaddress <host>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpauthtype null|external|guest]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpmulticon on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpreusecon on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpvideochannel on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vrdpvideochannelquality <percent>]\n");
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usb on|off]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync " [--usbehci on|off]\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync " [--snapshotfolder default|<path>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporter on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterport <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporteraddress <address|empty>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterpassword <password>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if 0
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync " [--iocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocachesize <I/O cache size in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttolerance master|standby]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--faulttoleranceaddress <name>]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--faulttoleranceport <port>]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--faulttolerancesyncinterval <msec>]\n"
776985d1f8ee71ad78aa1067cce88766803c7b30vboxsync " [--faulttolerancepassword <password>]\n"
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync "\n");
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync }
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync {
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync RTStrmPrintf(pStrm,
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync "VBoxManage import <ovf> [--dry-run|-n] [more options]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " (run with -n to have options displayed\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " for a particular OVF)\n\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
8ae161fca703d669e1306fafee128914f831f72bvboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
8ae161fca703d669e1306fafee128914f831f72bvboxsync {
8ae161fca703d669e1306fafee128914f831f72bvboxsync RTStrmPrintf(pStrm,
8ae161fca703d669e1306fafee128914f831f72bvboxsync "VBoxManage export <machines> --output|-o <ovf>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--legacy09]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manifest]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--vsys <number of virtual system>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--product <product name>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--producturl <product url>]\n"
2355157d3ea6596738c7c74e803220ad1bd6b4a8vboxsync " [--vendor <vendor name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorurl <vendor url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--version <version info>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eula <license text>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eulafile <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_STARTVM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage startvm <uuid>|<name>\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type gui");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVBoxSDL)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|sdl");
0c22b67dbc2b7236d71d4044992c5af9886f587avboxsync if (fVRDP)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|vrdp");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm, "|headless]\n");
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CONTROLVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage controlvm <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " pause|resume|reset|poweroff|savestate|\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " acpipowerbutton|acpisleepbutton|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " injectnmi|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setlinkstate<1-N> on|off |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_DYNAMIC_NET_ATTACH
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#if defined(VBOX_WITH_NETFLT)
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync " nic<1-N> null|nat|bridged|intnet|hostonly\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [<devicename>] |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nic<1-N> null|nat|bridged|intnet\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [<devicename>] |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " nictrace<1-N> on|off\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " nictracefile<1-N> <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* VBOX_DYNAMIC_NET_ATTACH */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " guestmemoryballoon <balloonsize in MB>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " gueststatisticsinterval <seconds>]\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync " usbattach <uuid>|<address> |\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync " usbdetach <uuid>|<address> |\n");
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync if (fVRDP)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " vrdp on|off |\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " vrdpport default|<ports> |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdpvideochannelquality <percent>\n");
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync }
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync RTStrmPrintf(pStrm,
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " setvideomodehint <xres> <yres> <bpp> [display] |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " setcredentials <username> <password> <domain>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--allowlocallogon <yes|no>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " teleport --host <name> --port <port>\n"
9ce5d949e4f1572d445a5c0aecabe9de8b672c99vboxsync " [--maxdowntime <msec>] [--password password]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " plugcpu <id>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " unplugcpu <id>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_DISCARDSTATE)
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage discardstate <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_ADOPTSTATE)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage adoptstate <uuid>|<name> <state_file>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SNAPSHOT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage snapshot <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " take <name> [--description <desc>] [--pause] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " delete <uuid>|<name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " restore <uuid>|<name> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " restorecurrent |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " edit <uuid>|<name>|--current\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--description <desc>] |\n"
a5224d14bb71df1d2da62ff9e4b0598ed5d2d85fvboxsync " showvminfo <uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync if (u64Cmd & USAGE_OPENMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage openmedium disk|dvd|floppy <filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|immutable|writethrough|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " shareable] (disk only)\n"
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync " [--uuid <uuid>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--parentuuid <uuid>] (disk only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync
1568d715e75b8d2484ea3dc87f0483d4cf377838vboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync "VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--delete]\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync "\n");
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync }
80e46f984efd827517661c0e081a36014ca41af8vboxsync
80e46f984efd827517661c0e081a36014ca41af8vboxsync if (u64Cmd & USAGE_STORAGEATTACH)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync RTStrmPrintf(pStrm,
051eba4436f9c682f7873390fb327e8eceb9e0efvboxsync "VBoxManage storageattach <uuid|vmname>\n"
6febf3149010855617e4a37e2c49f93d68930d44vboxsync " --storagectl <name>\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync " --port <number>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --device <number>\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--type dvddrive|hdd|fdd]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--medium none|emptydrive|\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync " <uuid>|<filename>|host:<drive>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--passthrough on|off]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--forceunmount]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync "\n");
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync }
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_STORAGECONTROLLER)
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync {
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage storagectl <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--add ide|sata|scsi|floppy|sas]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--sataideemulation<1-4> <1-30>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--sataportcount <1-30>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostiocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remove]\n"
bf88068260ded16af90b7da4867240fbdd9c8017vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync if (u64Cmd & USAGE_SHOWHDINFO)
63b785c3291332a86a9bc473e68f08121368898bvboxsync {
63b785c3291332a86a9bc473e68f08121368898bvboxsync RTStrmPrintf(pStrm,
63b785c3291332a86a9bc473e68f08121368898bvboxsync "VBoxManage showhdinfo <uuid>|<filename>\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync "\n");
63b785c3291332a86a9bc473e68f08121368898bvboxsync }
63b785c3291332a86a9bc473e68f08121368898bvboxsync
63b785c3291332a86a9bc473e68f08121368898bvboxsync if (u64Cmd & USAGE_CREATEHD)
63b785c3291332a86a9bc473e68f08121368898bvboxsync {
63b785c3291332a86a9bc473e68f08121368898bvboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage createhd --filename <filename>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " --size <megabytes>|--sizebyte <bytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type normal|writethrough|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " shareable] (default: normal)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--comment <comment>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remember]\n"
d502d47b275da0a8ecb1c2ec00d22ac396a61af4vboxsync "\n");
d502d47b275da0a8ecb1c2ec00d22ac396a61af4vboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_MODIFYHD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage modifyhd <uuid>|<filename>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--type normal|writethrough|immutable|shareable]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--autoreset on|off]\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--compact]\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync " [--resize <megabytes>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
5434d84d270a73565d8c3bed826cb4f95aba317bvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_CLONEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
5d39cab83ac9a6c6e4c5da4690ac53b4cfec73aavboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable|shareable]\n"
5b298681ed3a24f71adcf7b557d3b0f850967bbfvboxsync " [--remember] [--existing]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage convertfromraw <filename> <outputfile>\n"
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync " [--format VDI|VMDK|VHD]\n"
1a3c29d55b3cf1f6d60f53b8e3c33161ca97cd95vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifndef RT_OS_WINDOWS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD]\n"
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
1a3c29d55b3cf1f6d60f53b8e3c33161ca97cd95vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_ADDISCSIDISK)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage addiscsidisk --server <name>|<ip>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --target <target>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--port <port>]\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--lun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--encodedlun <lun>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--username <username>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--password <password>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type normal|writethrough|immutable|shareable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--intnet]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync }
95a6be61815bc19c98d76c390b164600364b3e3dvboxsync
3933885bc0c2c93436d858a14564c6179ec72872vboxsync if (u64Cmd & USAGE_GETEXTRADATA)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage getextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>|enumerate\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SETEXTRADATA)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage setextradata global|<uuid>|<name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<value>] (no value deletes key)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_SETPROPERTY)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage setproperty hdfolder default|<folder> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " machinefolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " vrdpauthlibrary default|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " websrvauthlibrary default|null|<library> |\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " loghistorycount <value>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter add <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <string>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --action ignore|hold (global filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--active yes|no] (yes)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--revision <IIFF>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--manufacturer <string>] (null)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--product <string>] (null)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage usbfilter modify <index,0-N>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--name <string>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--action ignore|hold] (global filters only)\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " [--active yes|no]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--revision <IIFF>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--manufacturer <string>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--product <string>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--remote yes|no] (null, VM filters only)\n"
7e8c58de93a6432f55ba0f4550c02a47b4302effvboxsync " [--serialnumber <string>|\"\"]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
d450629f624308cb06e59a13554c697afea563d8vboxsync }
d450629f624308cb06e59a13554c697afea563d8vboxsync
7e8c58de93a6432f55ba0f4550c02a47b4302effvboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
d450629f624308cb06e59a13554c697afea563d8vboxsync {
d450629f624308cb06e59a13554c697afea563d8vboxsync RTStrmPrintf(pStrm,
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync "VBoxManage usbfilter remove <index,0-N>\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync " --target <uuid>|<name>|global\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync "\n");
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync }
5f32a23884cca588e95be86778770d60cbc529f7vboxsync
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync {
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync RTStrmPrintf(pStrm,
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync "VBoxManage sharedfolder add <vmname>|<uuid>\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " --name <name> --hostpath <hostpath>\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " [--transient] [--readonly] [--automount]\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync "\n");
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync }
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage sharedfolder remove <vmname>|<uuid>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> [--transient]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_VM_STATISTICS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pattern <pattern>] [--descriptions]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_GUEST_PROPS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync usageGuestProperty();
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync#ifdef VBOX_WITH_GUEST_CONTROL
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync if (u64Cmd & USAGE_GUESTCONTROL)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync usageGuestControl();
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync if (u64Cmd & USAGE_METRICS)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " (comma-separated)\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics setup\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
98fbc4732a9519502e92799ef769789cbdd97dcevboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage metrics enable\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--list]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync "VBoxManage metrics disable\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync " [--list]\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage metrics collect\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [--detach]\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " [*|host|<vmname> [<metric_list>]]\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync "\n");
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync }
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync#if defined(VBOX_WITH_NETFLT)
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync if (u64Cmd & USAGE_HOSTONLYIFS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync {
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "VBoxManage hostonlyif ipconfig <name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [--dhcp |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync# if defined(RT_OS_WINDOWS)
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync " create |\n"
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync " remove <name>\n"
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync# endif
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync "\n");
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync }
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync#endif
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_DHCPSERVER)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage dhcpserver add|modify --netname <network_name> |\n"
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --ifname <hostonly_if_name>\n"
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--ip <ip_address>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --netmask <network_mask>\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " --lowerip <lower_ip>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --upperip <upper_ip>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--enable | --disable]\n\n"
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync " --ifname <hostonly_if_name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print a usage synopsis and the syntax error message.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync */
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync{
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync va_list args;
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync showLogo(g_pStdErr); // show logo even if suppressed
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#ifndef VBOX_ONLY_DOCS
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (g_fInternalMode)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync printUsageInternal(u64Cmd, g_pStdErr);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync else
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync printUsage(u64Cmd, g_pStdErr);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#endif /* !VBOX_ONLY_DOCS */
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync va_start(args, pszFormat);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync va_end(args);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync return 1;
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync}
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync/**
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * errorSyntax for RTGetOpt users.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync *
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * @returns 1.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync *
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * @param fUsageCategory The usage category of the command.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * @param rc The RTGetOpt return code.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * @param pValueUnion The value union.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync */
1ce069685b24d243eb0464f46d4c56b250c64445vboxsyncint errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync{
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync showLogo(g_pStdErr); // show logo even if suppressed
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#ifndef VBOX_ONLY_DOCS
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync if (g_fInternalMode)
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync printUsageInternal(fUsageCategory, g_pStdErr);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync else
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync printUsage(fUsageCategory, g_pStdErr);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#endif /* !VBOX_ONLY_DOCS */
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc == VINF_GETOPT_NOT_OPTION)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTMsgError("Invalid parameter '%s'", pValueUnion->psz);
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (rc > 0)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync if (RT_C_IS_PRINT(rc))
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTMsgError("Invalid option -%c", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTMsgError("Invalid option case %i", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync }
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync if (rc == VERR_GETOPT_UNKNOWN_OPTION)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTMsgError("Unknown option: %s", pValueUnion->psz);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (pValueUnion->pDef)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTMsgError("%s: %Rrs", pValueUnion->pDef->pszLong, rc);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgError("%Rrs", rc);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync}
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync/**
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync * Print an error message without the syntax stuff.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync */
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsyncint errorArgument(const char *pszFormat, ...)
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync{
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync va_list args;
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync va_start(args, pszFormat);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTMsgError(pszFormat, args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return 1;
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync