2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
f6b53aa7a361c1f26a3287a95172653219470233vboxsync * Copyright (C) 2006-2015 Oracle Corporation
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync *
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * available from http://www.virtualbox.org. This file is free software;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * General Public License (GPL) as published by the Free Software
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync/*******************************************************************************
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync* Header Files *
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync*******************************************************************************/
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#include <VBox/version.h>
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#include <iprt/buildconfig.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/ctype.h>
e0778e583cb4a0bdc9bcc48f5957e00a01108388vboxsync#include <iprt/err.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/getopt.h>
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#include <iprt/stream.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include "VBoxManage.h"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsyncvoid showLogo(PRTSTREAM pStrm)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync{
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync static bool s_fShown; /* show only once */
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync if (!s_fShown)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync VBOX_VERSION_STRING "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "All rights reserved.\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync s_fShown = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync }
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync}
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsyncvoid printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync bool fDumpOpts = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_LINUX
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_WINDOWS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fWin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_SOLARIS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fSolaris = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef RT_OS_FREEBSD
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#else
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync bool fFreeBSD = false;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_DARWIN
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef VBOX_WITH_VBOXSDL
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#else
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync fDumpOpts = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fSolaris = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fVBoxSDL = true;
23777a84b3e56937722404214b6064a797daf7b6vboxsync fCategory = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "Usage:\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory == USAGE_ALL)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " VBoxManage [<general option>] <command>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " \n \n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "General Options:\n \n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [-v|--version] print version number and exit\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [-q|--nologo] suppress the logo\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--settingspw <pw>] provide the settings password\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--settingspwfile <file>] provide a file containing the settings password\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " \n \n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "Commands:\n \n");
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync const char *pcszSep1 = " ";
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync const char *pcszSep2 = " ";
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory != USAGE_ALL)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync {
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync pcszSep1 = "VBoxManage";
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync pcszSep2 = "";
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync }
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync#define SEP pcszSep1, pcszSep2
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_LIST)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s list [--long|-l]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#else
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " intnets|bridgedifs|natnets|dhcpservers|hostinfo|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|\n"
4715f6e2473402353acb43c06a8986f957758259vboxsync " usbhost|usbfilters|systemproperties|extpacks|\n"
d01bb88591e2ae070aa233b99c81e58598d557e1vboxsync " groups|webcams|screenshotformats\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SHOWVMINFO)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s showvminfo %s <uuid|vmname> [--details]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--machinereadable]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s showvminfo %s <uuid|vmname> --log <idx>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP, SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_REGISTERVM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s registervm %s <filename>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_UNREGISTERVM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s unregistervm %s <uuid|vmname> [--delete]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_CREATEVM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s createvm %s --name <name>\n"
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " [--groups <group>, ...]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--register]\n"
7e8d44e04156d78379666f20d5daa2a79e5cbf44vboxsync " [--basefolder <path>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--uuid <uuid>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_MODIFYVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s modifyvm %s <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " [--groups <group>, ...]\n"
eae4be10b9f3dcb5680411373ff3fa42c136b6aavboxsync " [--description <desc>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ostype <ostype>]\n"
361a7fb527903c8dbfd0cc7dc779f943c6e348f6vboxsync " [--iconfile <filename>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--memory <memorysize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--pagefusion on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vram <vramsize in MB>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--acpi on|off]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync#ifdef VBOX_WITH_PCI_PASSTHROUGH
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--pciattach 03:04.0]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--pciattach 03:04.0@02:01.0]\n"
505ddd00252720bfb5569fcb17bfda53dc141e3bvboxsync " [--pcidetach 03:04.0]\n"
a1b4fb3917412d2632d358ff8989f1ec971f2d5bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--ioapic on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hpet on|off]\n"
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync " [--triplefaultreset on|off]\n"
56343f236d9d7c0e3d2b75e23f0f5575dc77f2e3vboxsync " [--paravirtprovider none|default|legacy|minimal|\n"
d11484e14d7d6490965166f2a3b3ee8b53b968d3vboxsync " hyperv|kvm]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hwvirtex on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nestedpaging on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--largepages on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vtxvpid on|off]\n"
ee1d93e48caef47c819586e7d765befa196be79cvboxsync " [--vtxux on|off]\n"
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync " [--pae on|off]\n"
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync " [--longmode on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--synthcpu on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremove <leaf>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuidremoveall]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hardwareuuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpus <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cpuhotplug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--plugcpu <id>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--unplugcpu <id>]\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " [--cpuexecutioncap <1-100>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--rtcuseutc on|off]\n"
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#ifdef VBOX_WITH_VMSVGA
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync " [--graphicscontroller none|vboxvga|vmsvga]\n"
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#else
8b36957d815c23b479eb35d93ac76c66392e9402vboxsync " [--graphicscontroller none|vboxvga]\n"
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--monitorcount <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate3d on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--accelerate2dvideo on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--firmware bios|efi|efi32|efi64]\n"
7a29aa5ce149ccd344a2929d2815b8e212690b92vboxsync " [--chipset ich9|piix3]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogofadein on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogofadeout on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogodisplaytime <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bioslogoimagepath <imagepath>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biossystemtimeoffset <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--biospxedebug on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|hostonly"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n"
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " generic|natnetwork"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictype<1-N> Am79C970A|Am79C973"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_E1000
5453eb2f2719bf3895ac3daeec4c26e0b6e2eb4avboxsync "|\n 82540EM|82543GC|82545EM"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#ifdef VBOX_WITH_VIRTIO
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|\n virtio"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#endif /* VBOX_WITH_VIRTIO */
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--cableconnected<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictrace<1-N> on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nictracefile<1-N> <filename>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--nicproperty<1-N> name=[value]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicspeed<1-N> <kbps>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--nicbootprio<1-N> <priority>]\n"
b604fbf16eda38d14b4999c245f032bfaa5aa85avboxsync " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
93c114476cca834cde109c60bfb95094fcd2c995vboxsync " [--nicbandwidthgroup<1-N> none|<name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--intnet<1-N> <network name>]\n"
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " [--nat-network<1-N> <network name>]\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--nicgenericdrv<1-N> <driver>\n"
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " [--natnet<1-N> <network>|default]\n"
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"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync " [--natbindip<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"
a85c47589af3385deccdbb1367b75108806d7cf5vboxsync " [--mouse ps2|usb|usbtablet|usbmultitouch]\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"
6fe2c7857678d9d48a4ac2798b62c702deeba133vboxsync " tcpserver <port>|\n"
6fe2c7857678d9d48a4ac2798b62c702deeba133vboxsync " tcpclient <hostname:port>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " file <file>|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <devicename>]\n"
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync#if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync " [--lpt<1-N> off|<I/O base> <IRQ>]\n"
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync " [--lptmode<1-N> <devicename>]\n"
67ee25dd0b63a61dc35a35d0aade75ca6cd06350vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--audio none|null", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fWin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_WINMM
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|winmm|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fSolaris)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|solaudio"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#ifdef VBOX_WITH_SOLARIS_OSS
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|oss"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fLinux)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_ALSA
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|alsa"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef VBOX_WITH_PULSE
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "|pulse"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync );
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync }
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync if (fFreeBSD)
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync {
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync /* Get the line break sorted when dumping all option variants. */
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync if (fDumpOpts)
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " oss");
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync }
229a63857c5fd2e441a62206eacce4156d0b2a26vboxsync else
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|oss");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PULSE
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|pulse");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDarwin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|coreaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "]\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--audiocontroller ac97|hda|sb16]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
2a171646d32f8a15e9820d6fb3bf3f9b9990ca3fvboxsync " bidirectional]\n"
56343f236d9d7c0e3d2b75e23f0f5575dc77f2e3vboxsync " [--draganddrop disabled|hosttoguest]\n");
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync RTStrmPrintf(pStrm,
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrde on|off]\n"
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync " [--vrdeextpack default|<name>\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " [--vrdeproperty <name=[value]>]\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " [--vrdeport <hostport>]\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " [--vrdeaddress <hostip>]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdeauthtype null|external|guest]\n"
6e25221ce8ef8e656d1e15eb7ec5cf8ae758ceb2vboxsync " [--vrdeauthlibrary default|<name>\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdemulticon on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdereusecon on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdevideochannel on|off]\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " [--vrdevideochannelquality <percent>]\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usb on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--usbehci on|off]\n"
6b08a46ae99f5b3552515e878d648f19a15b4f6bvboxsync " [--usbxhci on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--snapshotfolder default|<path>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporter on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterport <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporteraddress <address|empty>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--teleporterpassword <password>]\n"
34ee2570b5979d1e4ac39b4da8e453a9c99600a6vboxsync " [--teleporterpasswordfile <file>|stdin]\n"
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync " [--tracing-enabled on|off]\n"
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync " [--tracing-config <config-string>]\n"
a9315925c69e4c3bb342bb317ca5b6d29e1ee467vboxsync " [--tracing-allow-vm-access on|off]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync#if 0
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocache on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--iocachesize <I/O cache size in MB>]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync#endif
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync#if 0
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerance master|standby]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttoleranceaddress <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttoleranceport <port>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerancesyncinterval <msec>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--faulttolerancepassword <password>]\n"
7708252d252a55417a6a817041e4356797e34255vboxsync#endif
7708252d252a55417a6a817041e4356797e34255vboxsync#ifdef VBOX_WITH_USB_CARDREADER
7708252d252a55417a6a817041e4356797e34255vboxsync " [--usbcardreader on|off]\n"
d7c2269005543188a6fb12775f6d416431e39ebcvboxsync#endif
45a01ef53b009e9f56ce427bd8688da02ad32389vboxsync " [--autostart-enabled on|off]\n"
45a01ef53b009e9f56ce427bd8688da02ad32389vboxsync " [--autostart-delay <seconds>]\n"
dcc837f3a6f10996beb8aa7965f67f7f6c273fb4vboxsync#if 0
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [--autostop-type disabled|savestate|poweroff|\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " acpishutdown]\n"
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync#endif
2c6d6ff2ff146c92be6ec38cb87465c4f867a8fevboxsync#ifdef VBOX_WITH_VPX
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocap on|off]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapscreens all|<screen ID> [<screen ID> ...]]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapfile <filename>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapres <width> <height>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocaprate <rate>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapfps <fps>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapmaxtime <time>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapmaxsize <MB>]\n"
f6b53aa7a361c1f26a3287a95172653219470233vboxsync " [--videocapopts <key=value> [<key=value> ...]]\n"
9a32cc64d7694b4b8c46bbf17fdbb5e5f60d2d4avboxsync#endif
34ee2570b5979d1e4ac39b4da8e453a9c99600a6vboxsync " [--defaultfrontend default|<name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_CLONEVM)
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s clonevm %s <uuid|vmname>\n"
776985d1f8ee71ad78aa1067cce88766803c7b30vboxsync " [--snapshot <uuid>|<name>]\n"
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync " [--mode machine|machineandchildren|all]\n"
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync " [--options link|keepallmacs|keepnatmacs|\n"
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync " keepdisknames]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--name <name>]\n"
1147e980f6ab0b7ff1d08c13ad1c03eea30d102dvboxsync " [--groups <group>, ...]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--basefolder <basefolder>]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--uuid <uuid>]\n"
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync " [--register]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
f271f5e8fefdfe224f8bdeac77fefe6c655ae87evboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_IMPORTAPPLIANCE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s import %s <ovfname/ovaname>\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync " [--dry-run|-n]\n"
00ec08f7b2f0bbf53b2448f595a1e5eabd9266b3vboxsync " [--options keepallmacs|keepnatmacs|importtovdi]\n"
8ae161fca703d669e1306fafee128914f831f72bvboxsync " [more options]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " (run with -n to have options displayed\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " for a particular OVF)\n\n", SEP);
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_EXPORTAPPLIANCE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s export %s <machines> --output|-o <name>.<ovf/ova>\n"
454ac5c6ef4960887035ceea6b5247789d3272davboxsync " [--legacy09|--ovf09|--ovf10|--ovf20]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manifest]\n"
89d62ba649bc933540aa6fecf95712eed480bcd2vboxsync " [--iso]\n"
5e363664ceebe79185d44c3a1f354a39913e411avboxsync " [--options manifest|iso|nomacs|nomacsbutnat]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vsys <number of virtual system>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <product name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--producturl <product url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendor <vendor name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorurl <vendor url>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--version <version info>]\n"
e59069cf1c98c1c2e90a18ec76fbc2e9907fb917vboxsync " [--description <description info>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eula <license text>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--eulafile <filename>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_STARTVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s startvm %s <uuid|vmname>...\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync " [--type gui", SEP);
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (fVBoxSDL)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm, "|sdl");
e7f13bc53d33562180597cc29b5058eb6e70fb9avboxsync RTStrmPrintf(pStrm, "|headless|separate]\n");
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_CONTROLVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s controlvm %s <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " pause|resume|reset|poweroff|savestate|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " acpipowerbutton|acpisleepbutton|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " setlinkstate<1-N> on|off |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#if defined(VBOX_WITH_NETFLT)
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n"
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " natnetwork [<devicename>] |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#else /* !VBOX_WITH_NETFLT */
4b9a9888c020ed3508c8ac3a5b47842d6aa3f8d2vboxsync " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<devicename>] |\n"
aa0553becec2abc2e781f839ba1d399c31c2c07fvboxsync#endif /* !VBOX_WITH_NETFLT */
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " nictrace<1-N> on|off |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " nictracefile<1-N> <filename> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " nicproperty<1-N> name=[value] |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " nicpromisc<1-N> deny|allow-vms|allow-all |\n"
b4bcdbd7ac35c938e6f71a6403fe9f3ebf106a07vboxsync " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " <hostport>,[<guestip>],<guestport> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " natpf<1-N> delete <rulename> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " guestmemoryballoon <balloonsize in MB> |\n"
dcc837f3a6f10996beb8aa7965f67f7f6c273fb4vboxsync " usbattach <uuid>|<address>\n"
dcc837f3a6f10996beb8aa7965f67f7f6c273fb4vboxsync " [--capturefile <filename>] |\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " usbdetach <uuid>|<address> |\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " clipboard disabled|hosttoguest|guesttohost|\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " bidirectional |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " draganddrop disabled|hosttoguest |\n"
6fe1329154975472e055284198df7fa8e64dee3avboxsync " vrde on|off |\n"
36a04912b64bea8318327fe0723535f1b3f041b0vboxsync " vrdeport <port> |\n"
cc74f15083bf80fbc96723a89faa06c15d0dead8vboxsync " vrdeproperty <name=[value]> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " vrdevideochannelquality <percent> |\n"
28ae9ced88db55943497a8bb98682bc2be513476vboxsync " setvideomodehint <xres> <yres> <bpp>\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " [[<display>] [<enabled:yes|no> |\n"
28ae9ced88db55943497a8bb98682bc2be513476vboxsync " [<xorigin> <yorigin>]]] |\n"
9ce5d949e4f1572d445a5c0aecabe9de8b672c99vboxsync " screenshotpng <file> [display] |\n"
ab9d561bc33f1705a10c5e4bffed9c9e660dc32fvboxsync " vcpenabled on|off |\n"
ab9d561bc33f1705a10c5e4bffed9c9e660dc32fvboxsync " vcpscreens all|none|<screen>,[<screen>...] |\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " setcredentials <username>\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " --passwordfile <file> | <password>\n"
5af5f66dd66e8ed177bcb8b429a1c2f3093ab406vboxsync " <domain>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--allowlocallogon <yes|no>] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " teleport --host <name> --port <port>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [--maxdowntime <msec>]\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [--passwordfile <file> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " --password <password>] |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " plugcpu <id> |\n"
bc016d9f481b47ade01223d4d589080ad2e2a246vboxsync " unplugcpu <id> |\n"
657b2c9f6d33f08001e5fa6f6e0572dcf0391013vboxsync " cpuexecutioncap <1-100>\n"
dabb0e35338cb6c83e64a42302473c0ced05bf81vboxsync " webcam <attach [path [settings]]> | <detach [path]> | <list>\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " addencpassword <id>\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " <password>\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " [--removeonsuspend <yes|no>]\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " removeencpassword <id>\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " removeallencpasswords\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_DISCARDSTATE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s discardstate %s <uuid|vmname>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_ADOPTSTATE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s adoptstate %s <uuid|vmname> <state_file>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SNAPSHOT)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s snapshot %s <uuid|vmname>\n"
f906aa7f33207974c4bad1bc441a63b139958499vboxsync " take <name> [--description <desc>] [--live] |\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " delete <uuid|snapname> |\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " restore <uuid|snapname> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " restorecurrent |\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " edit <uuid|snapname>|--current\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--description <desc>] |\n"
a5224d14bb71df1d2da62ff9e4b0598ed5d2d85fvboxsync " list [--details|--machinereadable]\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " showvminfo <uuid|snapname>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_CLOSEMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--delete]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_STORAGEATTACH)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s storageattach %s <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --storagectl <name>\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync " [--port <number>]\n"
1568d715e75b8d2484ea3dc87f0483d4cf377838vboxsync " [--device <number>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--type dvddrive|hdd|fdd]\n"
c0a5da26f7222b0a486d6d9ba4d1f475a78a2c73vboxsync " [--medium none|emptydrive|additions|\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " <uuid|filename>|host:<drive>|iscsi]\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--mtype normal|writethrough|immutable|shareable|\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync " readonly|multiattach]\n"
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync " [--comment <text>]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--setuuid <uuid>]\n"
80e46f984efd827517661c0e081a36014ca41af8vboxsync " [--setparentuuid <uuid>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--passthrough on|off]\n"
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync " [--tempeject on|off]\n"
051eba4436f9c682f7873390fb327e8eceb9e0efvboxsync " [--nonrotational on|off]\n"
6febf3149010855617e4a37e2c49f93d68930d44vboxsync " [--discard on|off]\n"
2e8034536f2ada0455cc5c85f746e5e1cd49eea0vboxsync " [--hotpluggable on|off]\n"
63b785c3291332a86a9bc473e68f08121368898bvboxsync " [--bandwidthgroup <name>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--forceunmount]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--server <name>|<ip>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--target <target>]\n"
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync " [--tport <port>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--lun <lun>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--encodedlun <lun>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--username <username>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--password <password>]\n"
48dafba24ef28f07a241e5857a43b327822574a8vboxsync " [--initiator <initiator>]\n"
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync " [--intnet]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_STORAGECONTROLLER)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s storagectl %s <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"
2f5c096f8c07bf1779807cc3b108440a7f910b35vboxsync " [--portcount <1-n>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--hostiocache on|off]\n"
bf88068260ded16af90b7da4867240fbdd9c8017vboxsync " [--bootable on|off]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remove]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_BANDWIDTHCONTROL)
63b785c3291332a86a9bc473e68f08121368898bvboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s bandwidthctl %s <uuid|vmname>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " add <name> --type disk|network\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " set <name>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
e67a57a63d60b971a077d325eb0872a3ccde94a4vboxsync " remove <name> |\n"
e67a57a63d60b971a077d325eb0872a3ccde94a4vboxsync " list [--machinereadable]\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " (limit units: k=kilobit, m=megabit, g=gigabit,\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " K=kilobyte, M=megabyte, G=gigabyte)\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
63b785c3291332a86a9bc473e68f08121368898bvboxsync
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync if (fCategory & USAGE_SHOWMEDIUMINFO)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync if (fCategory & USAGE_CREATEMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n"
d502d47b275da0a8ecb1c2ec00d22ac396a61af4vboxsync " [--size <megabytes>|--sizebyte <bytes>]\n"
0a8b697b439859902a19c75e4a1d315ab03c57f9vboxsync " [--diffparent <uuid>|<filename>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync if (fCategory & USAGE_MODIFYMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n"
aed4b2dfb1673c0b476588860c9d27705700ce0dvboxsync " [--type normal|writethrough|immutable|shareable|\n"
dc9555b48e3a0576258aa498825c8d10e311cd47vboxsync " readonly|multiattach]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--autoreset on|off]\n"
639f8a89c08cdbefc3d4f8e1762ce9d38440e02bvboxsync " [--property <name=[value]>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--compact]\n"
5434d84d270a73565d8c3bed826cb4f95aba317bvboxsync " [--resize <megabytes>|--resizebyte <bytes>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync if (fCategory & USAGE_CLONEMEDIUM)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
5b298681ed3a24f71adcf7b557d3b0f850967bbfvboxsync " [--existing]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync if (fCategory & USAGE_MEDIUMPROPERTY)
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync RTStrmPrintf(pStrm,
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync " <property> <value>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync "\n"
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync " [disk|dvd|floppy] get <uuid|filename>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync " <property>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync "\n"
340c9153ef85fdaf7acf99926a068a62197308cfvboxsync " [disk|dvd|floppy] delete <uuid|filename>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync " <property>\n"
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync "\n", SEP);
7c6b8efedbf0a39b5ab31c00472a9a35497f01cavboxsync
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync if (fCategory & USAGE_ENCRYPTMEDIUM)
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync RTStrmPrintf(pStrm,
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync "%s encryptmedium %s <uuid|filename>\n"
fac9deff63e29da080d37fdb1efb9b1212fd87e3vboxsync " [--newpassword <file>|-]\n"
fac9deff63e29da080d37fdb1efb9b1212fd87e3vboxsync " [--oldpassword <file>|-]\n"
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync " [--cipher <cipher identifier>]\n"
d1aab951b0bd1de1a8a51daca46fce06daaed8d7vboxsync " [--newpasswordid <password identifier>]\n"
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync "\n", SEP);
b87c769f789d9f61e42149aa336e4c086f0f649evboxsync
24da6272332d6690a7480ff933d9c60436df80advboxsync if (fCategory & USAGE_MEDIUMENCCHKPWD)
24da6272332d6690a7480ff933d9c60436df80advboxsync RTStrmPrintf(pStrm,
24da6272332d6690a7480ff933d9c60436df80advboxsync "%s checkmediumpwd %s <uuid|filename>\n"
24da6272332d6690a7480ff933d9c60436df80advboxsync " <pwd file>|-\n"
24da6272332d6690a7480ff933d9c60436df80advboxsync "\n", SEP);
24da6272332d6690a7480ff933d9c60436df80advboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_CONVERTFROMRAW)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s convertfromraw %s <filename> <outputfile>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
4487ec756a4d0326ace76c20fd8a29d618b19a48vboxsync " [--uuid <uuid>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s convertfromraw %s stdin <outputfile> <bytes>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--format VDI|VMDK|VHD]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
4487ec756a4d0326ace76c20fd8a29d618b19a48vboxsync " [--uuid <uuid>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP, SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_GETEXTRADATA)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s getextradata %s global|<uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>|enumerate\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SETEXTRADATA)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s setextradata %s global|<uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " <key>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [<value>] (no value deletes key)\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SETPROPERTY)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s setproperty %s machinefolder default|<folder> |\n"
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync " hwvirtexclusive on|off |\n"
3933885bc0c2c93436d858a14564c6179ec72872vboxsync " vrdeauthlibrary default|<library> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " websrvauthlibrary default|null|<library> |\n"
9ca017ceee656f9d33f2cb6652e401b5f17fcfb7vboxsync " vrdeextpack null|<library> |\n"
200cc6562c6e5cec617903ea827cfb22083f5325vboxsync " autostartdbpath null|<folder> |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " loghistorycount <value>\n"
904810c4c6668233349b025cc58013cb7c11c701vboxsync " defaultfrontend default|<name>\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_USBFILTER_ADD)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s usbfilter %s add <index,0-N>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " --target <uuid|vmname>|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"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manufacturer <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>] (null)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_USBFILTER_MODIFY)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s usbfilter %s modify <index,0-N>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " --target <uuid|vmname>|global\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--name <string>]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--action ignore|hold] (global filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--active yes|no]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--vendorid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--productid <XXXX>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--revision <IIFF>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--manufacturer <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--product <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--remote yes|no] (null, VM filters only)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--serialnumber <string>|\"\"]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_USBFILTER_REMOVE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s usbfilter %s remove <index,0-N>\n"
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync " --target <uuid|vmname>|global\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SHAREDFOLDER_ADD)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s sharedfolder %s add <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> --hostpath <hostpath>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--transient] [--readonly] [--automount]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s sharedfolder %s remove <uuid|vmname>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --name <name> [--transient]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_GUEST_PROPS
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_GUESTPROPERTY)
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync usageGuestProperty(pStrm, SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
d450629f624308cb06e59a13554c697afea563d8vboxsync#ifdef VBOX_WITH_GUEST_CONTROL
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_GUESTCONTROL)
23777a84b3e56937722404214b6064a797daf7b6vboxsync usageGuestControl(pStrm, SEP, fSubCategory);
d450629f624308cb06e59a13554c697afea563d8vboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
d450629f624308cb06e59a13554c697afea563d8vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_DEBUGVM)
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync {
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync RTStrmPrintf(pStrm,
c6d49c0483db5a491b9394f017de7760aa5d6ac7vboxsync "%s debugvm %s <uuid|vmname>\n"
5f32a23884cca588e95be86778770d60cbc529f7vboxsync " dumpguestcore --filename <name> |\n"
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync " info <item> [args] |\n"
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync " injectnmi |\n"
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync " log [--release|--debug] <settings> ...|\n"
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync " logdest [--release|--debug] <settings> ...|\n"
f147b9c2c059b1af2d67e6369dcb0c0da36c05ebvboxsync " logflags [--release|--debug] <settings> ...|\n"
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync " osdetect |\n"
c6960665b76a45ed0489be4f3b4685a3170c3f8dvboxsync " osinfo |\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " getregisters [--cpu <id>] <reg>|all ... |\n"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync " setregisters [--cpu <id>] <reg>=<value> ... |\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " show [--human-readable|--sh-export|--sh-eval|\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " --cmd-set] \n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " <logdbg-settings|logrel-settings>\n"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync " [[opt] what ...] |\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " statistics [--reset] [--pattern <pattern>]\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " [--descriptions]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
500b54ffef573903725ee90aa3db3485fc6a5840vboxsync }
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_METRICS)
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " (comma-separated)\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s setup\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s enable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s disable\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s metrics %s collect\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--period <seconds>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--samples <count>] (default: 1)\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--list]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--detach]\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [*|host|<vmname> [<metric_list>]]\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP, SEP, SEP, SEP, SEP, SEP);
aeb9498c4d9854ed42b271541d34c7bad97b4c77vboxsync
71429ad59515f9055f394527e1ae942c98373cddvboxsync#if defined(VBOX_WITH_NAT_SERVICE)
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_NATNETWORK)
71429ad59515f9055f394527e1ae942c98373cddvboxsync {
71429ad59515f9055f394527e1ae942c98373cddvboxsync RTStrmPrintf(pStrm,
71429ad59515f9055f394527e1ae942c98373cddvboxsync "%s natnetwork %s add --netname <name>\n"
34ee2570b5979d1e4ac39b4da8e453a9c99600a6vboxsync " --network <network>\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--enable|--disable]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--dhcp on|off]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--port-forward-4 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--loopback-4 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--ipv6 on|off]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--port-forward-6 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--loopback-6 <rule>]\n\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync "%s natnetwork %s remove --netname <name>\n\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync "%s natnetwork %s modify --netname <name>\n"
34ee2570b5979d1e4ac39b4da8e453a9c99600a6vboxsync " [--network <network>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--enable|--disable]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--dhcp on|off]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--port-forward-4 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--loopback-4 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--ipv6 on|off]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--port-forward-6 <rule>]\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync " [--loopback-6 <rule>]\n\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync "%s natnetwork %s start --netname <name>\n\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync "%s natnetwork %s stop --netname <name>\n"
71429ad59515f9055f394527e1ae942c98373cddvboxsync "\n", SEP, SEP, SEP, SEP, SEP);
71429ad59515f9055f394527e1ae942c98373cddvboxsync
71429ad59515f9055f394527e1ae942c98373cddvboxsync
71429ad59515f9055f394527e1ae942c98373cddvboxsync }
71429ad59515f9055f394527e1ae942c98373cddvboxsync#endif
71429ad59515f9055f394527e1ae942c98373cddvboxsync
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_HOSTONLYIFS)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s hostonlyif %s ipconfig <name>\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " [--dhcp |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
98fbc4732a9519502e92799ef769789cbdd97dcevboxsync# if !defined(RT_OS_SOLARIS)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " create |\n"
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " remove <name>\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync# endif
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync#endif
d1fcf24d24368926be13484524a9e378070a9157vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_DHCPSERVER)
d1fcf24d24368926be13484524a9e378070a9157vboxsync {
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s dhcpserver %s add|modify --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " [--ip <ip_address>\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " --netmask <network_mask>\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " --lowerip <lower_ip>\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " --upperip <upper_ip>]\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " [--enable | --disable]\n\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s dhcpserver %s remove --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync " --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP, SEP);
d1fcf24d24368926be13484524a9e378070a9157vboxsync }
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (fCategory & USAGE_EXTPACK)
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync {
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync RTStrmPrintf(pStrm,
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "%s extpack %s install [--replace] <tarball> |\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " uninstall [--force] <name> |\n"
4c8907a420ed66a42f729eb08cddf9c1e57f25eavboxsync " cleanup\n"
914fe6f35c397cfd7d97b44a63398c6422579c49vboxsync "\n", SEP);
eaa687a9ede02b3b161a4595f7e42590a2e1b932vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print a usage synopsis and the syntax error message.
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync * @returns RTEXITCODE_SYNTAX.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
23777a84b3e56937722404214b6064a797daf7b6vboxsyncRTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync showLogo(g_pStdErr); // show logo even if suppressed
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifndef VBOX_ONLY_DOCS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (g_fInternalMode)
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsageInternal(fCategory, g_pStdErr);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync else
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsage(fCategory, ~0U, g_pStdErr);
23777a84b3e56937722404214b6064a797daf7b6vboxsync#endif /* !VBOX_ONLY_DOCS */
23777a84b3e56937722404214b6064a797daf7b6vboxsync va_start(args, pszFormat);
23777a84b3e56937722404214b6064a797daf7b6vboxsync RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
23777a84b3e56937722404214b6064a797daf7b6vboxsync va_end(args);
23777a84b3e56937722404214b6064a797daf7b6vboxsync return RTEXITCODE_SYNTAX;
23777a84b3e56937722404214b6064a797daf7b6vboxsync}
23777a84b3e56937722404214b6064a797daf7b6vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync/**
23777a84b3e56937722404214b6064a797daf7b6vboxsync * Print a usage synopsis and the syntax error message.
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @returns RTEXITCODE_SYNTAX.
23777a84b3e56937722404214b6064a797daf7b6vboxsync */
23777a84b3e56937722404214b6064a797daf7b6vboxsyncRTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
23777a84b3e56937722404214b6064a797daf7b6vboxsync{
23777a84b3e56937722404214b6064a797daf7b6vboxsync va_list args;
23777a84b3e56937722404214b6064a797daf7b6vboxsync showLogo(g_pStdErr); // show logo even if suppressed
23777a84b3e56937722404214b6064a797daf7b6vboxsync#ifndef VBOX_ONLY_DOCS
23777a84b3e56937722404214b6064a797daf7b6vboxsync if (g_fInternalMode)
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsageInternal(fCategory, g_pStdErr);
23777a84b3e56937722404214b6064a797daf7b6vboxsync else
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsage(fCategory, fSubCategory, g_pStdErr);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* !VBOX_ONLY_DOCS */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
3a8aa22ef125135ef67bfc396771bcee15ef02dfvboxsync RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTEXITCODE_SYNTAX;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync/**
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * errorSyntax for RTGetOpt users.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync *
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync * @returns RTEXITCODE_SYNTAX.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync *
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @param fCategory The usage category of the command.
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @param fSubCategory The usage sub-category of the command.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param rc The RTGetOpt return code.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param pValueUnion The value union.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync */
23777a84b3e56937722404214b6064a797daf7b6vboxsyncRTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync{
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync /*
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * Check if it is an unhandled standard option.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync */
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync if (rc == 'V')
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync {
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync return RTEXITCODE_SUCCESS;
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync }
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync if (rc == 'h')
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync {
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync showLogo(g_pStdErr);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#ifndef VBOX_ONLY_DOCS
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync if (g_fInternalMode)
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsageInternal(fCategory, g_pStdOut);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync else
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsage(fCategory, fSubCategory, g_pStdOut);
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync#endif
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync return RTEXITCODE_SUCCESS;
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync }
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync /*
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync * General failure.
1ce069685b24d243eb0464f46d4c56b250c64445vboxsync */
824ae3158a8b8f8233fec3f5a12c81f139933698vboxsync showLogo(g_pStdErr); // show logo even if suppressed
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#ifndef VBOX_ONLY_DOCS
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (g_fInternalMode)
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsageInternal(fCategory, g_pStdErr);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync else
23777a84b3e56937722404214b6064a797daf7b6vboxsync printUsage(fCategory, fSubCategory, g_pStdErr);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#endif /* !VBOX_ONLY_DOCS */
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc == VINF_GETOPT_NOT_OPTION)
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc > 0)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync {
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (RT_C_IS_PRINT(rc))
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync }
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc == VERR_GETOPT_UNKNOWN_OPTION)
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
01b2e367e947049139a5d5813ccc1fa162b11f76vboxsync if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
01b2e367e947049139a5d5813ccc1fa162b11f76vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (pValueUnion->pDef)
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync}
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
23777a84b3e56937722404214b6064a797daf7b6vboxsync/**
23777a84b3e56937722404214b6064a797daf7b6vboxsync * errorSyntax for RTGetOpt users.
23777a84b3e56937722404214b6064a797daf7b6vboxsync *
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @returns RTEXITCODE_SYNTAX.
23777a84b3e56937722404214b6064a797daf7b6vboxsync *
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @param fUsageCategory The usage category of the command.
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @param rc The RTGetOpt return code.
23777a84b3e56937722404214b6064a797daf7b6vboxsync * @param pValueUnion The value union.
23777a84b3e56937722404214b6064a797daf7b6vboxsync */
23777a84b3e56937722404214b6064a797daf7b6vboxsyncRTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
23777a84b3e56937722404214b6064a797daf7b6vboxsync{
23777a84b3e56937722404214b6064a797daf7b6vboxsync return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
23777a84b3e56937722404214b6064a797daf7b6vboxsync}
23777a84b3e56937722404214b6064a797daf7b6vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print an error message without the syntax stuff.
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync *
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync * @returns RTEXITCODE_SYNTAX.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsyncRTEXITCODE errorArgument(const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
9b1bd65f02252ae2d62078951eeac9df809bbdfdvboxsync RTMsgErrorV(pszFormat, args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
53c715b46bccd175005ee523f7acc7962cfcdf94vboxsync return RTEXITCODE_SYNTAX;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}