VBoxManageHelp.cpp revision 5d57bcb78f1f3f918bd3daf709b551b8c2d30485
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Copyright (C) 2006-2013 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
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*******************************************************************************
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync* Header Files *
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync*******************************************************************************/
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <VBox/version.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/buildconfig.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/ctype.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/err.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/getopt.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include <iprt/stream.h>
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#include "VBoxManage.h"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid showLogo(PRTSTREAM pStrm)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync static bool s_fShown; /* show only once */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (!s_fShown)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync VBOX_VERSION_STRING "\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "All rights reserved.\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync s_fShown = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDumpOpts = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_LINUX
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fLinux = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#else
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fLinux = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#endif
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef RT_OS_WINDOWS
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync 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
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef RT_OS_FREEBSD
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fFreeBSD = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef RT_OS_DARWIN
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fDarwin = false;
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#ifdef VBOX_WITH_VBOXSDL
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVBoxSDL = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_DUMPOPTS)
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync fDumpOpts = true;
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync fLinux = true;
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync fWin = true;
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync fSolaris = true;
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "Usage:\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " VBoxManage [<general option>] <command>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " \n \n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "General Options:\n \n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-v|--version] print version number and exit\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [-q|--nologo] suppress the logo\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--settingspw <pw>] provide the settings password\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--settingspwfile <file>] provide a file containing the settings password\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " \n \n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "Commands:\n \n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync const char *pcszSep1 = " ";
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync const char *pcszSep2 = " ";
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd != USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync pcszSep1 = "VBoxManage";
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync pcszSep2 = "";
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#define SEP pcszSep1, pcszSep2
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_LIST)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s list [--long|-l]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#else
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " bridgedifs|dhcpservers|hostinfo|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " usbhost|usbfilters|systemproperties|extpacks|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " groups\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n", SEP);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_SHOWVMINFO)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
9dfcf62b7a5a289684d46ee55f6042d49509daecvboxsync "%s showvminfo %s <uuid>|<name> [--details]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--machinereadable]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s showvminfo %s <uuid>|<name> --log <idx>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n", SEP, SEP);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_REGISTERVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s registervm %s <filename>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n", SEP);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_UNREGISTERVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s unregistervm %s <uuid>|<name> [--delete]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_CREATEVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s createvm %s --name <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--groups <group>, ...]\n"
a59528c40bbfdcee2e315756333f8c66f35b5accvboxsync " [--ostype <ostype>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--register]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--basefolder <path>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--uuid <uuid>]\n"
e214bb78026c1d64078b34ca9504d3f5abbc52efvboxsync "\n", SEP);
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_MODIFYVM)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync "%s modifyvm %s <uuid|name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--name <name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--groups <group>, ...]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--ostype <ostype>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--memory <memorysize in MB>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pagefusion on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vram <vramsize in MB>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--acpi on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PCI_PASSTHROUGH
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--pciattach 03:04.0]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pciattach 03:04.0@02:01.0]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pcidetach 03:04.0]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--ioapic on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pae on|off]\n"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync " [--hpet on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--hwvirtex on|off]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync " [--hwvirtexexcl on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nestedpaging on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--largepages on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vtxvpid on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--synthcpu on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cpuidremove <leaf>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cpuidremoveall]\n"
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync " [--hardwareuuid <uuid>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cpus <number>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--cpuhotplug on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--plugcpu <id>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--unplugcpu <id>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cpuexecutioncap <1-100>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--rtcuseutc on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--graphicscontroller none|vboxvga]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--monitorcount <number>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--accelerate3d on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--accelerate2dvideo on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--firmware bios|efi|efi32|efi64]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--chipset ich9|piix3]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogofadein on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogofadeout on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--bioslogodisplaytime <msec>]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--bioslogoimagepath <imagepath>]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--biossystemtimeoffset <msec>]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--biospxedebug on|off]\n"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|hostonly"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " generic"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nictype<1-N> Am79C970A|Am79C973"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_E1000
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|\n 82540EM|82543GC|82545EM"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VIRTIO
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|\n virtio"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* VBOX_WITH_VIRTIO */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--cableconnected<1-N> on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nictrace<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nictracefile<1-N> <filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nicproperty<1-N> name=[value]]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nicspeed<1-N> <kbps>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nicbootprio<1-N> <priority>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nicbandwidthgroup<1-N> none|<name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#if defined(VBOX_WITH_NETFLT)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--intnet<1-N> <network name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--natnet<1-N> <network>|default]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nicgenericdrv<1-N> <driver>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [<sockrcv>],[<tcpsnd>],\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [<tcprcv>]]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " <hostport>,[<guestip>],<guestport>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--natpf<1-N> delete <rulename>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--nattftpprefix<1-N> <prefix>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--nattftpfile<1-N> <file>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--nattftpserver<1-N> <ip>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--natbindip<1-N> <ip>\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--natdnspassdomain<1-N> on|off]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--natdnsproxy<1-N> on|off]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--natdnshostresolver<1-N> on|off]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [sameports]]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--macaddress<1-N> auto|<mac>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--mouse ps2|usb|usbtablet\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--keyboard ps2|usb\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--uartmode<1-N> disconnected|\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " server <pipe>|\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " client <pipe>|\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " file <file>|\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " <devicename>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync#if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " [--lpt<1-N> off|<I/O base> <IRQ>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--lptmode<1-N> <devicename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync " [--audio none|null", SEP);
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (fWin)
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_WINMM
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync RTStrmPrintf(pStrm, "|winmm|dsound");
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fSolaris)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|solaudio"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_SOLARIS_OSS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
000d3a358f1072f58336eaea956b19888b123e49vboxsync }
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync if (fLinux)
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync {
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync RTStrmPrintf(pStrm, "|oss"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#ifdef VBOX_WITH_ALSA
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync "|alsa"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#ifdef VBOX_WITH_PULSE
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync "|pulse"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fFreeBSD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync /* Get the line break sorted when dumping all option variants. */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDumpOpts)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " oss");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|oss");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PULSE
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|pulse");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDarwin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|coreaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--audiocontroller ac97|hda|sb16]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " bidirectional]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--draganddrop disabled|hosttoguest\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrde on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdeextpack default|<name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdeproperty <name=[value]>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdeport <hostport>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdeaddress <hostip>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdeauthtype null|external|guest]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdeauthlibrary default|<name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdemulticon on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdereusecon on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdevideochannel on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vrdevideochannelquality <percent>]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--usb on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--usbehci on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--snapshotfolder default|<path>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--teleporter on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--teleporterport <port>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--teleporteraddress <address|empty>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--teleporterpassword <password>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--teleporterpasswordfile <file>|stdin]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--tracing-enabled on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--tracing-config <config-string>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--tracing-allow-vm-access on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if 0
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--iocache on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--iocachesize <I/O cache size in MB>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if 0
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttolerance master|standby]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttoleranceaddress <name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttoleranceport <port>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttolerancesyncinterval <msec>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--faulttolerancepassword <password>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync#endif
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync#ifdef VBOX_WITH_USB_VIDEO
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--usbwebcam on|off]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync#endif
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync#ifdef VBOX_WITH_USB_CARDREADER
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--usbcardreader on|off]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--autostart-enabled on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--autostart-delay <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if 0 /* Disabled until the feature is implemented. */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--autostop-type disabled|savestate|poweroff|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " acpishutdown]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync#ifdef VBOX_WITH_VPX
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--vcpenabled on|off]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--vcpfile <filename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vcpwidth <width>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vcpheight <height>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vcprate <rate>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--defaultfrontend default|<name]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync }
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync if (u64Cmd & USAGE_CLONEVM)
70f7b6ff8dc13303a70e552dd7003aa672e985a2vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s clonevm %s <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--snapshot <uuid>|<name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--mode machine|machineandchildren|all]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--options link|keepallmacs|keepnatmacs|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " keepdisknames]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--name <name>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--groups <group>, ...]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [--basefolder <basefolder>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--uuid <uuid>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--register]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s import %s <ovf/ova>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--dry-run|-n]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--options keepallmacs|keepnatmacs]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [more options]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " (run with -n to have options displayed\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " for a particular OVF)\n\n", SEP);
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync RTStrmPrintf(pStrm,
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync "%s export %s <machines> --output|-o <name>.<ovf/ova>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--legacy09|--ovf09|--ovf10|--ovf20]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--manifest]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vsys <number of virtual system>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--product <product name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--producturl <product url>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vendor <vendor name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--vendorurl <vendor url>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--version <version info>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--eula <license text>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--eulafile <filename>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_STARTVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s startvm %s <uuid>|<name>...\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type gui", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVBoxSDL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|sdl");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm, "|headless]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CONTROLVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s controlvm %s <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " pause|resume|reset|poweroff|savestate|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " acpipowerbutton|acpisleepbutton|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " setlinkstate<1-N> on|off |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#if defined(VBOX_WITH_NETFLT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " nic<1-N> null|nat|bridged|intnet|hostonly|generic"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [<devicename>] |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#else /* !VBOX_WITH_NETFLT */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " nic<1-N> null|nat|bridged|intnet|generic\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [<devicename>] |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync#endif /* !VBOX_WITH_NETFLT */
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " nictrace<1-N> on|off |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " nictracefile<1-N> <filename> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " nicproperty<1-N> name=[value] |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " nicpromisc<1-N> deny|allow-vms|allow-all |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <hostport>,[<guestip>],<guestport> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " natpf<1-N> delete <rulename> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " guestmemoryballoon <balloonsize in MB> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbattach <uuid>|<address> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbdetach <uuid>|<address> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " clipboard disabled|hosttoguest|guesttohost|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " bidirectional |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " draganddrop disabled|hosttoguest |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " vrde on|off |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " vrdeport <port> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " vrdeproperty <name=[value]> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " vrdevideochannelquality <percent> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " setvideomodehint <xres> <yres> <bpp>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [[<display>] [<enabled:yes|no> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [<xorigin> <yorigin>]]] |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " screenshotpng <file> [display] |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " setcredentials <username>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --passwordfile <file> | <password>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <domain>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--allowlocallogon <yes|no>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " teleport --host <name> --port <port>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--maxdowntime <msec>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--passwordfile <file> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --password <password>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " plugcpu <id> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " unplugcpu <id> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " cpuexecutioncap <1-100>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_DISCARDSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s discardstate %s <uuid>|<name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_ADOPTSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s adoptstate %s <uuid>|<name> <state_file>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync if (u64Cmd & USAGE_SNAPSHOT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s snapshot %s <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " take <name> [--description <desc>] [--pause] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " delete <uuid>|<name> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " restore <uuid>|<name> |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " restorecurrent |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " edit <uuid>|<name>|--current\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--name <name>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--description <desc>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " list [--details|--machinereadable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " showvminfo <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s closemedium %s disk|dvd|floppy <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--delete]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync "\n", SEP);
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_STORAGEATTACH)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTStrmPrintf(pStrm,
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "%s storageattach %s <uuid|vmname>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --storagectl <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--port <number>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--device <number>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type dvddrive|hdd|fdd]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--medium none|emptydrive|additions|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <uuid>|<filename>|host:<drive>|iscsi]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--mtype normal|writethrough|immutable|shareable|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " readonly|multiattach]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--comment <text>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--setuuid <uuid>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--setparentuuid <uuid>]\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [--passthrough on|off]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--tempeject on|off]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--nonrotational on|off]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--discard on|off]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--bandwidthgroup <name>]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--forceunmount]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--server <name>|<ip>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--target <target>]\n"
410216171f7f7033678589acb6e342303978c918vboxsync " [--tport <port>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--lun <lun>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--encodedlun <lun>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--username <username>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--password <password>]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " [--initiator <initiator>]\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync " [--intnet]\n"
d1fcf24d24368926be13484524a9e378070a9157vboxsync "\n", SEP);
d1fcf24d24368926be13484524a9e378070a9157vboxsync
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync if (u64Cmd & USAGE_STORAGECONTROLLER)
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync RTStrmPrintf(pStrm,
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync "%s storagectl %s <uuid|vmname>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " --name <name>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--add ide|sata|scsi|floppy|sas]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--sataportcount <1-30>]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--hostiocache on|off]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--bootable on|off]\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync " [--remove]\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync "\n", SEP);
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync
d1fcf24d24368926be13484524a9e378070a9157vboxsync if (u64Cmd & USAGE_BANDWIDTHCONTROL)
d1fcf24d24368926be13484524a9e378070a9157vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s bandwidthctl %s <uuid|vmname>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " add <name> --type disk|network\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " set <name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " remove <name> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " list [--machinereadable]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " (limit units: k=kilobit, m=megabit, g=gigabit,\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " K=kilobyte, M=megabyte, G=gigabyte)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHOWHDINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s showhdinfo %s <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s createhd %s --filename <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--size <megabytes>|--sizebyte <bytes>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--diffparent <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTStrmPrintf(pStrm,
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "%s modifyhd %s <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--type normal|writethrough|immutable|shareable|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " readonly|multiattach]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--autoreset on|off]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--compact]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [--resize <megabytes>|--resizebyte <bytes>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n", SEP);
if (u64Cmd & USAGE_CLONEHD)
RTStrmPrintf(pStrm,
"%s clonehd %s <uuid>|<filename> <uuid>|<outputfile>\n"
" [--format VDI|VMDK|VHD|RAW|<other>]\n"
" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
" [--existing]\n"
"\n", SEP);
if (u64Cmd & USAGE_CONVERTFROMRAW)
RTStrmPrintf(pStrm,
"%s convertfromraw %s <filename> <outputfile>\n"
" [--format VDI|VMDK|VHD]\n"
" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
" [--uuid <uuid>]\n"
"%s convertfromraw %s stdin <outputfile> <bytes>\n"
" [--format VDI|VMDK|VHD]\n"
" [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
" [--uuid <uuid>]\n"
"\n", SEP, SEP);
if (u64Cmd & USAGE_GETEXTRADATA)
RTStrmPrintf(pStrm,
"%s getextradata %s global|<uuid>|<name>\n"
" <key>|enumerate\n"
"\n", SEP);
if (u64Cmd & USAGE_SETEXTRADATA)
RTStrmPrintf(pStrm,
"%s setextradata %s global|<uuid>|<name>\n"
" <key>\n"
" [<value>] (no value deletes key)\n"
"\n", SEP);
if (u64Cmd & USAGE_SETPROPERTY)
RTStrmPrintf(pStrm,
"%s setproperty %s machinefolder default|<folder> |\n"
" vrdeauthlibrary default|<library> |\n"
" websrvauthlibrary default|null|<library> |\n"
" vrdeextpack null|<library> |\n"
" autostartdbpath null|<folder> |\n"
" loghistorycount <value>\n"
" defaultfrontend default|<name>\n"
"\n", SEP);
if (u64Cmd & USAGE_USBFILTER_ADD)
RTStrmPrintf(pStrm,
"%s usbfilter %s add <index,0-N>\n"
" --target <uuid>|<name>|global\n"
" --name <string>\n"
" --action ignore|hold (global filters only)\n"
" [--active yes|no] (yes)\n"
" [--vendorid <XXXX>] (null)\n"
" [--productid <XXXX>] (null)\n"
" [--revision <IIFF>] (null)\n"
" [--manufacturer <string>] (null)\n"
" [--product <string>] (null)\n"
" [--remote yes|no] (null, VM filters only)\n"
" [--serialnumber <string>] (null)\n"
" [--maskedinterfaces <XXXXXXXX>]\n"
"\n", SEP);
if (u64Cmd & USAGE_USBFILTER_MODIFY)
RTStrmPrintf(pStrm,
"%s usbfilter %s modify <index,0-N>\n"
" --target <uuid>|<name>|global\n"
" [--name <string>]\n"
" [--action ignore|hold] (global filters only)\n"
" [--active yes|no]\n"
" [--vendorid <XXXX>|\"\"]\n"
" [--productid <XXXX>|\"\"]\n"
" [--revision <IIFF>|\"\"]\n"
" [--manufacturer <string>|\"\"]\n"
" [--product <string>|\"\"]\n"
" [--remote yes|no] (null, VM filters only)\n"
" [--serialnumber <string>|\"\"]\n"
" [--maskedinterfaces <XXXXXXXX>]\n"
"\n", SEP);
if (u64Cmd & USAGE_USBFILTER_REMOVE)
RTStrmPrintf(pStrm,
"%s usbfilter %s remove <index,0-N>\n"
" --target <uuid>|<name>|global\n"
"\n", SEP);
if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
RTStrmPrintf(pStrm,
"%s sharedfolder %s add <vmname>|<uuid>\n"
" --name <name> --hostpath <hostpath>\n"
" [--transient] [--readonly] [--automount]\n"
"\n", SEP);
if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
RTStrmPrintf(pStrm,
"%s sharedfolder %s remove <vmname>|<uuid>\n"
" --name <name> [--transient]\n"
"\n", SEP);
#ifdef VBOX_WITH_GUEST_PROPS
if (u64Cmd & USAGE_GUESTPROPERTY)
usageGuestProperty(pStrm, SEP);
#endif /* VBOX_WITH_GUEST_PROPS defined */
#ifdef VBOX_WITH_GUEST_CONTROL
if (u64Cmd & USAGE_GUESTCONTROL)
usageGuestControl(pStrm, SEP);
#endif /* VBOX_WITH_GUEST_CONTROL defined */
if (u64Cmd & USAGE_DEBUGVM)
{
RTStrmPrintf(pStrm,
"%s debugvm %s <uuid>|<name>\n"
" dumpguestcore --filename <name> |\n"
" info <item> [args] |\n"
" injectnmi |\n"
" log [--release|--debug] <settings> ...|\n"
" logdest [--release|--debug] <settings> ...|\n"
" logflags [--release|--debug] <settings> ...|\n"
" osdetect |\n"
" osinfo |\n"
" getregisters [--cpu <id>] <reg>|all ... |\n"
" setregisters [--cpu <id>] <reg>=<value> ... |\n"
" show [--human-readable|--sh-export|--sh-eval|\n"
" --cmd-set] \n"
" <logdbg-settings|logrel-settings>\n"
" [[opt] what ...] |\n"
" statistics [--reset] [--pattern <pattern>]\n"
" [--descriptions]\n"
"\n", SEP);
}
if (u64Cmd & USAGE_METRICS)
RTStrmPrintf(pStrm,
"%s metrics %s list [*|host|<vmname> [<metric_list>]]\n"
" (comma-separated)\n\n"
"%s metrics %s setup\n"
" [--period <seconds>] (default: 1)\n"
" [--samples <count>] (default: 1)\n"
" [--list]\n"
" [*|host|<vmname> [<metric_list>]]\n\n"
"%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n"
"%s metrics %s enable\n"
" [--list]\n"
" [*|host|<vmname> [<metric_list>]]\n\n"
"%s metrics %s disable\n"
" [--list]\n"
" [*|host|<vmname> [<metric_list>]]\n\n"
"%s metrics %s collect\n"
" [--period <seconds>] (default: 1)\n"
" [--samples <count>] (default: 1)\n"
" [--list]\n"
" [--detach]\n"
" [*|host|<vmname> [<metric_list>]]\n"
"\n", SEP, SEP, SEP, SEP, SEP, SEP);
#if defined(VBOX_WITH_NETFLT)
if (u64Cmd & USAGE_HOSTONLYIFS)
{
RTStrmPrintf(pStrm,
"%s hostonlyif %s ipconfig <name>\n"
" [--dhcp |\n"
" --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
" --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
# if !defined(RT_OS_SOLARIS)
" create |\n"
" remove <name>\n"
# endif
"\n", SEP);
}
#endif
if (u64Cmd & USAGE_DHCPSERVER)
{
RTStrmPrintf(pStrm,
"%s dhcpserver %s add|modify --netname <network_name> |\n"
#if defined(VBOX_WITH_NETFLT)
" --ifname <hostonly_if_name>\n"
#endif
" [--ip <ip_address>\n"
" --netmask <network_mask>\n"
" --lowerip <lower_ip>\n"
" --upperip <upper_ip>]\n"
" [--enable | --disable]\n\n"
"%s dhcpserver %s remove --netname <network_name> |\n"
#if defined(VBOX_WITH_NETFLT)
" --ifname <hostonly_if_name>\n"
#endif
"\n", SEP, SEP);
}
if (u64Cmd & USAGE_EXTPACK)
{
RTStrmPrintf(pStrm,
"%s extpack %s install [--replace] <tarball> |\n"
" uninstall [--force] <name> |\n"
" cleanup\n"
"\n", SEP);
}
}
/**
* Print a usage synopsis and the syntax error message.
* @returns RTEXITCODE_SYNTAX.
*/
RTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
{
va_list args;
showLogo(g_pStdErr); // show logo even if suppressed
#ifndef VBOX_ONLY_DOCS
if (g_fInternalMode)
printUsageInternal(u64Cmd, g_pStdErr);
else
printUsage(u64Cmd, g_pStdErr);
#endif /* !VBOX_ONLY_DOCS */
va_start(args, pszFormat);
RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
va_end(args);
return RTEXITCODE_SYNTAX;
}
/**
* errorSyntax for RTGetOpt users.
*
* @returns RTEXITCODE_SYNTAX.
*
* @param fUsageCategory The usage category of the command.
* @param rc The RTGetOpt return code.
* @param pValueUnion The value union.
*/
RTEXITCODE errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
{
/*
* Check if it is an unhandled standard option.
*/
if (rc == 'V')
{
RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
return RTEXITCODE_SUCCESS;
}
if (rc == 'h')
{
showLogo(g_pStdErr);
#ifndef VBOX_ONLY_DOCS
if (g_fInternalMode)
printUsageInternal(fUsageCategory, g_pStdOut);
else
printUsage(fUsageCategory, g_pStdOut);
#endif
return RTEXITCODE_SUCCESS;
}
/*
* General failure.
*/
showLogo(g_pStdErr); // show logo even if suppressed
#ifndef VBOX_ONLY_DOCS
if (g_fInternalMode)
printUsageInternal(fUsageCategory, g_pStdErr);
else
printUsage(fUsageCategory, g_pStdErr);
#endif /* !VBOX_ONLY_DOCS */
if (rc == VINF_GETOPT_NOT_OPTION)
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
if (rc > 0)
{
if (RT_C_IS_PRINT(rc))
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
}
if (rc == VERR_GETOPT_UNKNOWN_OPTION)
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
if (pValueUnion->pDef)
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
}
/**
* Print an error message without the syntax stuff.
*
* @returns RTEXITCODE_SYNTAX.
*/
RTEXITCODE errorArgument(const char *pszFormat, ...)
{
va_list args;
va_start(args, pszFormat);
RTMsgErrorV(pszFormat, args);
va_end(args);
return RTEXITCODE_SYNTAX;
}