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