VBoxManageHelp.cpp revision aceec09dd145a4d6fb14f2ea75a459cc88b334ab
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/* $Id$ */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/** @file
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VBoxManage - help and other message output.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/*
e64031e20c39650a7bc902a3e1aba613b9415deevboxsync * Copyright (C) 2006-2010 Oracle Corporation
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync *
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * available from http://www.virtualbox.org. This file is free software;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * General Public License (GPL) as published by the Free Software
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync/*******************************************************************************
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync* Header Files *
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync*******************************************************************************/
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync#include <VBox/version.h>
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
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
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsyncvoid showLogo(void)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync{
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync static bool s_fShown; /* show only once */
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync if (!s_fShown)
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync {
57958eb1223628d507daf47ed31ea25c4e8c6da9vboxsync RTPrintf(VBOX_PRODUCT" Command Line Management Interface Version "
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync VBOX_VERSION_STRING "\n"
22d7a125fcbe8650770ac700108b6f27ca1f0dfdvboxsync "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync "All rights reserved.\n"
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync "\n");
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync s_fShown = true;
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync }
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync}
b0ad0bbadf3a5b5258acda1bfe16f0ad8bee5ff0vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncvoid printUsage(USAGECATEGORY u64Cmd)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
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
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_VRDP
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync bool fVRDP = false;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#ifdef VBOX_WITH_VBOXSDL
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#else
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync bool fVBoxSDL = false;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_DUMPOPTS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fLinux = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fWin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fSolaris = true;
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync fFreeBSD = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fDarwin = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync fVRDP = true;
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync fVBoxSDL = true;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync u64Cmd = USAGE_ALL;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("Usage:\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd == USAGE_ALL)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage [-v|--version] print version number and exit\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "VBoxManage [-q|--nologo] ... suppress the logo\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_LIST)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " bridgedifs|hostonlyifs|dhcpservers|hostinfo|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#else
ffb14f6b8aefea7399c4bf70faab4c9fc26e6cd5vboxsync " bridgedifs|dhcpservers|hostinfo|\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
ffb14f6b8aefea7399c4bf70faab4c9fc26e6cd5vboxsync " hostcpuids|hddbackends|hdds|dvds|floppies|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbhost|usbfilters|systemproperties\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHOWVMINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage showvminfo <uuid>|<name> [--details] [--statistics]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--machinereadable]\n"
83e0da18877bbce83f52a975d9102fbbdb9727a8vboxsync "VBoxManage showvminfo <uuid>|<name> --log <idx>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_REGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage registervm <filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_UNREGISTERVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage unregistervm <uuid>|<name> [--delete]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage createvm --name <name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--ostype <ostype>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--register]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--basefolder <path> | --settingsfile <path>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--uuid <uuid>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage modifyvm <uuid|name>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--name <name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--ostype <ostype>]\n"
9133c0526e3c7cebf5b3bf9bee5addfd7f298fe0vboxsync " [--memory <memorysize in MB>]\n"
b304856b23107864c9c594a80cebca6006623f31vboxsync " [--pagefusion on|off\n"
9133c0526e3c7cebf5b3bf9bee5addfd7f298fe0vboxsync " [--vram <vramsize in MB>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--acpi on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--ioapic on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pae on|off]\n"
dbabc9de5bf52ce5eb77cf82b038e9a6166c5a04vboxsync " [--hpet on|off]\n"
4cf22805d13f50eef86e917f2c7106fe5198a2d8vboxsync " [--hwvirtex on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nestedpaging on|off]\n"
c33fc49611f2444dade533488bf431e29eb88bcdvboxsync " [--largepages on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vtxvpid on|off]\n"
505b794841d6f18d9917bc4ecaedb0a2782623f8vboxsync " [--synthcpu on|off]\n"
db0ecde8f28fdb4525bc6d94056166c70b02ebb8vboxsync " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
db0ecde8f28fdb4525bc6d94056166c70b02ebb8vboxsync " [--cpuidremove <leaf>]\n"
db0ecde8f28fdb4525bc6d94056166c70b02ebb8vboxsync " [--cpuidremoveall]\n"
505b794841d6f18d9917bc4ecaedb0a2782623f8vboxsync " [--hardwareuuid <uuid>]\n"
9dfcf62b7a5a289684d46ee55f6042d49509daecvboxsync " [--cpus <number>]\n"
e2760cdc84c692bc46cfaf5018d313db2f122acavboxsync " [--rtcuseutc]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--monitorcount <number>]\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--accelerate3d on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#ifdef VBOX_WITH_VIDEOHWACCEL
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--accelerate2dvideo on|off]\n"
49e54e2ffe0c10864d06e9d1ebe24a8eb1327a6bvboxsync#endif
3a0bc95d0adf57baefd303e94b8f1b7b31a8f080vboxsync " [--firmware bios|efi|efi32|efi64]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bioslogofadein on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bioslogofadeout on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bioslogodisplaytime <msec>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bioslogoimagepath <imagepath>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--biossystemtimeoffset <msec>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--biospxedebug on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync " [--nic<1-N> none|null|nat|bridged|intnet"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#if defined(VBOX_WITH_NETFLT) /* RT_OS_LINUX || RT_OS_DARWIN */
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync "|hostonly"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#endif
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#ifdef VBOX_WITH_VDE
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync "|vde"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#endif
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync "]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nictype<1-N> Am79C970A|Am79C973"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_E1000
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync "|\n 82540EM|82543GC|82545EM"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#ifdef VBOX_WITH_VIRTIO
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync "|\n virtio"
9bb98d54790a98dad0ad6d9bdc5d319b6fdf0bffvboxsync#endif /* VBOX_WITH_VIRTIO */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--cableconnected<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nictrace<1-N> on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nictracefile<1-N> <filename>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--nicspeed<1-N> <kbps>]\n"
f62342e2cc901a67e27fa69c0e712ee35e9c4c68vboxsync " [--nicbootprio<1-N> <priority>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--bridgeadapter<1-N> none|<devicename>]\n"
629e8f58c569e4c51a98284c41754fd9f0b973f8vboxsync#if defined(VBOX_WITH_NETFLT)
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--hostonlyadapter<1-N> none|<devicename>]\n"
7c1f498692cd2393f8ba68cb62be482495106f93vboxsync#endif
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--intnet<1-N> <network name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--natnet<1-N> <network>|default]\n"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#ifdef VBOX_WITH_VDE
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync " [--vdenet<1-N> <network>|default]\n"
8c58249d7f93d82395aa6c8b31526443892bc375vboxsync#endif
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--natsettings<1-N> \"[<mtu>],[<socksnd>],[<sockrcv>],\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [<tcpsnd>],[<tcprcv>]\"]\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--natpf<1-N> \"[<rulename>],tcp|udp,\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [<hostip>],<hostport>,\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [<guestip>],<guestport>\"]\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--natpf<1-N> delete <rulename>]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--nattftpprefix<1-N> <prefix>]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--nattftpfile<1-N> <file>]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--nattftpserver<1-N> <ip>]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--natdnspassdomain<1-N> on|off]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--natdnsproxy<1-N> on|off]\n"
8cfd6e2b7edd6c0d95653de8e7e237a3ccae99bevboxsync " [--natdnshostresolver<1-N> on|off]\n"
62a515eec8de1b7804ec6997c0f2013fef5c5a6bvboxsync " [--nataliasmode<1-N> default|[log],[proxyonly],[sameports]]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--macaddress<1-N> auto|<mac>]\n"
19cb1f8699e352d590c4946caee33863a5157241vboxsync " [--mouse ps2|usb|usbtablet\n"
19cb1f8699e352d590c4946caee33863a5157241vboxsync " [--keyboard ps2|usb\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--uart<1-N> off|<I/O base> <IRQ>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--uartmode<1-N> disconnected|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " server <pipe>|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " client <pipe>|\n"
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync " file <file>|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " <devicename>]\n"
9133c0526e3c7cebf5b3bf9bee5addfd7f298fe0vboxsync " [--guestmemoryballoon <balloonsize in MB>]\n"
14f3b3761dd547223728deb999e4ea962fc83280vboxsync " [--gueststatisticsinterval <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf(" [--audio none|null");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fWin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_WINMM
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "|winmm|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "|dsound");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fSolaris)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync RTPrintf( "|solaudio"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#ifdef VBOX_WITH_SOLARIS_OSS
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync "|oss"
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync#endif
5704a317c3b6bdf4b59f6a6ebe45d443296b1995vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fLinux)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_ALSA
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|alsa"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#ifdef VBOX_WITH_PULSE
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync "|pulse"
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync#endif
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync );
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync }
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync if (fFreeBSD)
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync {
a0644dbbd30adb9bd2937110d6f016e56c4cc52bvboxsync RTPrintf( "|oss"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_PULSE
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "|pulse"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fDarwin)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "|coreaudio");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf( "]\n");
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf(" [--audiocontroller ac97|sb16]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--clipboard disabled|hosttoguest|guesttohost|\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " bidirectional]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVRDP)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf(" [--vrdp on|off]\n"
432d08d68b9683d01880890d475a4cadd84b69cevboxsync " [--vrdpport default|<ports>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdpaddress <host>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdpauthtype null|external|guest]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vrdpmulticon on|off]\n"
b8462d2d5e78448e277a4214655ce1cd6c7e9249vboxsync " [--vrdpreusecon on|off]\n"
b8462d2d5e78448e277a4214655ce1cd6c7e9249vboxsync " [--vrdpvideochannel on|off]\n"
873b289f12cd7a7b0023a65f0f62c355860f759fvboxsync " [--vrdpvideochannelquality <percent>]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf(" [--usb on|off]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--usbehci on|off]\n"
4114dcbc0414579cc42b66f4f7bd464a37672af7vboxsync " [--snapshotfolder default|<path>]\n"
f106b549ead77cab51ff1e2c116060aaabb90d5evboxsync " [--teleporter on|off]\n"
9e4ea89b1085fdaa5861e45a729d9c978db1a8f1vboxsync " [--teleporterport <port>]\n"
9e4ea89b1085fdaa5861e45a729d9c978db1a8f1vboxsync " [--teleporteraddress <address|empty>\n"
ad9e5a61fea617d40d07390ff1737277d6aef869vboxsync " [--teleporterpassword <password>]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync#if 0
4090390866c02d5d0ad061151cdb298b9a173e86vboxsync " [--iocache on|off]\n"
9133c0526e3c7cebf5b3bf9bee5addfd7f298fe0vboxsync " [--iocachesize <I/O cache size in MB>]\n"
1d6a57d4c53f6e86fd1aacd7c5b8da50a8a2e552vboxsync " [--iobandwidthmax <Maximum I/O bandwidth in MB/s>]\n"
80b09746c07120c881b61b18f30c9c4a2a4af9c5vboxsync#endif
ad9e5a61fea617d40d07390ff1737277d6aef869vboxsync );
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync if (u64Cmd & USAGE_IMPORTAPPLIANCE)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync {
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync RTPrintf("VBoxManage import <ovf> [--dry-run|-n] [more options]\n"
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync " (run with -n to have options displayed\n"
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync " for a particular OVF)\n\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync if (u64Cmd & USAGE_EXPORTAPPLIANCE)
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync RTPrintf("VBoxManage export <machines> --output|-o <ovf>\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--legacy09]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--vsys <number of virtual system>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--product <product name>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--producturl <product url>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--vendor <vendor name>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--vendorurl <vendor url>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--version <version info>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--eula <license text>]\n"
1e289ac7f0c5324ef5712727fc61b2a322eb2e1avboxsync " [--eulafile <filename>]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync "\n");
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync }
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_STARTVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage startvm <uuid>|<name>\n");
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync RTPrintf(" [--type gui");
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync if (fVBoxSDL)
a2d9f81753c129b5e3bbe3769627dcd25a3724bdvboxsync RTPrintf( "|sdl");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVRDP)
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync RTPrintf( "|vrdp");
251867ef7a8ad4e0d583f4ff4dbdce6071387e26vboxsync RTPrintf( "|headless]\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CONTROLVM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage controlvm <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " pause|resume|reset|poweroff|savestate|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " acpipowerbutton|acpisleepbutton|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " keyboardputscancode <hex> [<hex> ...]|\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " injectnmi|\n"
000d3a358f1072f58336eaea956b19888b123e49vboxsync " setlinkstate<1-N> on|off |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#ifdef VBOX_DYNAMIC_NET_ATTACH
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#if defined(VBOX_WITH_NETFLT)
b6957a412c94dd85c0e5f9e201bb715c4b685f2fvboxsync " nic<1-N> null|nat|bridged|intnet|hostonly\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync " [<devicename>] |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#else /* !RT_OS_LINUX && !RT_OS_DARWIN */
b6957a412c94dd85c0e5f9e201bb715c4b685f2fvboxsync " nic<1-N> null|nat|bridged|intnet\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync " [<devicename>] |\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif /* !RT_OS_LINUX && !RT_OS_DARWIN */
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync " nictrace<1-N> on|off\n"
be6a25d1b25b8692d8c035b0549e5258c6986dc5vboxsync " nictracefile<1-N> <filename>\n"
a1a2e3f1c3ca7d6190c90ff67b7995b50b258794vboxsync#endif /* VBOX_DYNAMIC_NET_ATTACH */
9133c0526e3c7cebf5b3bf9bee5addfd7f298fe0vboxsync " guestmemoryballoon <balloonsize in MB>]\n"
bb4fe96a4ea42b5ea9563d86c79424d58941e2bfvboxsync " gueststatisticsinterval <seconds>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " usbattach <uuid>|<address> |\n"
9d3628862c2a985acccba6c4cc72684efc6c28dbvboxsync " usbdetach <uuid>|<address> |\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (fVRDP)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
432d08d68b9683d01880890d475a4cadd84b69cevboxsync RTPrintf(" vrdp on|off |\n");
70ca8d009d026a301bf7fa08cd18c6494c45fdeevboxsync RTPrintf(" vrdpport default|<ports> |\n"
70ca8d009d026a301bf7fa08cd18c6494c45fdeevboxsync " vrdpvideochannelquality <percent>\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
4114dcbc0414579cc42b66f4f7bd464a37672af7vboxsync RTPrintf(" setvideomodehint <xres> <yres> <bpp> [display] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " setcredentials <username> <password> <domain>\n"
4114dcbc0414579cc42b66f4f7bd464a37672af7vboxsync " [--allowlocallogon <yes|no>] |\n"
8e0f079384d0e8445e59e4660763bdce27b42dd9vboxsync " teleport --host <name> --port <port>\n"
8e0f079384d0e8445e59e4660763bdce27b42dd9vboxsync " [--maxdowntime <msec>] [--password password]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_DISCARDSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage discardstate <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_ADOPTSTATE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage adoptstate <uuid>|<name> <state_file>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SNAPSHOT)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage snapshot <uuid>|<name>\n"
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync " take <name> [--description <desc>] [--pause] |\n"
3d7b51bd4d6fdb130637f3160fe6a5816f1babe3vboxsync " delete <uuid>|<name> |\n"
3d7b51bd4d6fdb130637f3160fe6a5816f1babe3vboxsync " restore <uuid>|<name> |\n"
18cbdecd71d504221768c44a14b6eecbed66c252vboxsync " restorecurrent |\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " edit <uuid>|<name>|--current\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--name <name>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--description <desc>] |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " showvminfo <uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync if (u64Cmd & USAGE_OPENMEDIUM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage openmedium disk|dvd|floppy <filename>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--type normal|immutable|writethrough] (disk only)\n"
6a3efac09015e76c24ba7e9eb7436c82891bb2c8vboxsync " [--uuid <uuid>]\n"
6a3efac09015e76c24ba7e9eb7436c82891bb2c8vboxsync " [--parentuuid <uuid>] (disk only)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync if (u64Cmd & USAGE_CLOSEMEDIUM)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage closemedium disk|dvd|floppy <uuid>|<filename>\n"
6a3efac09015e76c24ba7e9eb7436c82891bb2c8vboxsync " [--delete]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync if (u64Cmd & USAGE_STORAGEATTACH)
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync {
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync RTPrintf("VBoxManage storageattach <uuid|vmname>\n"
a425b5e790c27d6a1a2cf738802e9034f0764a00vboxsync " --storagectl <name>\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " --port <number>\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " --device <number>\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--type dvddrive|hdd|fdd\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " --medium none|emptydrive|uuid|filename|host:<drive>]\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--passthrough on|off]\n"
80626cd34607c5dbf3f0af51b32396ce58bf493bvboxsync " [--forceunmount]\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync "\n");
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync }
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync if (u64Cmd & USAGE_STORAGECONTROLLER)
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync {
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync RTPrintf("VBoxManage storagectl <uuid|vmname>\n"
2294b1479e3fb6f4e9c9550b3e15f3d3a3f1fc24vboxsync " --name <name>\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--add ide|sata|scsi|floppy|sas]\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " [--controller LSILogic|LSILogicSAS|BusLogic|IntelAHCI|\n"
b5e852fe286f938722f7d8eb6ab96cced98237e4vboxsync " PIIX3|PIIX4|ICH6|I82078]\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " [--sataideemulation<1-4> <1-30>]\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " [--sataportcount <1-30>]\n"
aceec09dd145a4d6fb14f2ea75a459cc88b334abvboxsync " [--hostiocache on|off]\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync " [--remove]\n"
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync "\n");
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync }
bddad5eeab93a98d4ea571ccdf016531bb4318advboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHOWHDINFO)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage showhdinfo <uuid>|<filename>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CREATEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync RTPrintf("VBoxManage createhd --filename <filename>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " --size <megabytes>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--format VDI|VMDK|VHD] (default: VDI)\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--type normal|writethrough] (default: normal)\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--comment <comment>]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--remember]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_MODIFYHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage modifyhd <uuid>|<filename>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--type normal|writethrough|immutable]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--autoreset on|off]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--compact]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CLONEHD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage clonehd <uuid>|<filename> <outputfile>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--format VDI|VMDK|VHD|RAW|<other>]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--type normal|writethrough|immutable]\n"
70f7b6ff8dc13303a70e552dd7003aa672e985a2vboxsync " [--remember] [--existing]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_CONVERTFROMRAW)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync RTPrintf("VBoxManage convertfromraw <filename> <outputfile>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--format VDI|VMDK|VHD]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync "VBoxManage convertfromraw stdin <outputfile> <bytes>\n"
47699a0c42ead32866009e0d91bfb349490feaf9vboxsync " [--format VDI|VMDK|VHD]\n"
78dfd747e1837f5de0bc5625c39dff4b98e3d4d4vboxsync " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_ADDISCSIDISK)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync RTPrintf("VBoxManage addiscsidisk --server <name>|<ip>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " --target <target>\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--port <port>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--lun <lun>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--encodedlun <lun>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--username <username>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--password <password>]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--type normal|writethrough|immutable]\n"
ac2b2ae448fe887af9a3269e40afff11ebb1f9d3vboxsync " [--intnet]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_GETEXTRADATA)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage getextradata global|<uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " <key>|enumerate\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SETEXTRADATA)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage setextradata global|<uuid>|<name>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " <key>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [<value>] (no value deletes key)\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SETPROPERTY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage setproperty hdfolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " machinefolder default|<folder> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " vrdpauthlibrary default|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " websrvauthlibrary default|null|<library> |\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " loghistorycount <value>\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_USBFILTER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter add <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --target <uuid>|<name>|global\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --name <string>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --action ignore|hold (global filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--active yes|no] (yes)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vendorid <XXXX>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--productid <XXXX>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--revision <IIFF>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--manufacturer <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--product <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--remote yes|no] (null, VM filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--serialnumber <string>] (null)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_USBFILTER_MODIFY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter modify <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --target <uuid>|<name>|global\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--name <string>]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--action ignore|hold] (global filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--active yes|no]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--vendorid <XXXX>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--productid <XXXX>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--revision <IIFF>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--manufacturer <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--product <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--remote yes|no] (null, VM filters only)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--serialnumber <string>|\"\"]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--maskedinterfaces <XXXXXXXX>]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_USBFILTER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage usbfilter remove <index,0-N>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --target <uuid>|<name>|global\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_ADD)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage sharedfolder add <vmname>|<uuid>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --name <name> --hostpath <hostpath>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--transient] [--readonly]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("VBoxManage sharedfolder remove <vmname>|<uuid>\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " --name <name> [--transient]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_VM_STATISTICS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync RTPrintf("VBoxManage vmstatistics <vmname>|<uuid> [--reset]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--pattern <pattern>] [--descriptions]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifdef VBOX_WITH_GUEST_PROPS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_GUESTPROPERTY)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync usageGuestProperty();
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* VBOX_WITH_GUEST_PROPS defined */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
d450629f624308cb06e59a13554c697afea563d8vboxsync#ifdef VBOX_WITH_GUEST_CONTROL
d450629f624308cb06e59a13554c697afea563d8vboxsync if (u64Cmd & USAGE_GUESTCONTROL)
d450629f624308cb06e59a13554c697afea563d8vboxsync usageGuestControl();
d450629f624308cb06e59a13554c697afea563d8vboxsync#endif /* VBOX_WITH_GUEST_CONTROL defined */
d450629f624308cb06e59a13554c697afea563d8vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (u64Cmd & USAGE_METRICS)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync RTPrintf("VBoxManage metrics list [*|host|<vmname> [<metric_list>]]\n"
b8c2e8ba48bd659fa09a06770a7cedfae977d73bvboxsync " (comma-separated)\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics setup\n"
3c6e4b9d8c57a342a5fedb9eabdcc5a203b832fcvboxsync " [--period <seconds>] (default: 1)\n"
3c6e4b9d8c57a342a5fedb9eabdcc5a203b832fcvboxsync " [--samples <count>] (default: 1)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--list]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics query [*|host|<vmname> [<metric_list>]]\n\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync "VBoxManage metrics enable\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync " [--list]\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync "VBoxManage metrics disable\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync " [--list]\n"
e46a94731390fd08fb2097fab60d378853c4a293vboxsync " [*|host|<vmname> [<metric_list>]]\n\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "VBoxManage metrics collect\n"
3c6e4b9d8c57a342a5fedb9eabdcc5a203b832fcvboxsync " [--period <seconds>] (default: 1)\n"
3c6e4b9d8c57a342a5fedb9eabdcc5a203b832fcvboxsync " [--samples <count>] (default: 1)\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--list]\n"
d40a840eecf0146eee47c14edaef7ace1ddfb5a6vboxsync " [--detach]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync " [*|host|<vmname> [<metric_list>]]\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "\n");
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync }
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync if (u64Cmd & USAGE_HOSTONLYIFS)
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync RTPrintf("VBoxManage hostonlyif ipconfig <name>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--dhcp |\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync# if defined(RT_OS_WINDOWS)
410216171f7f7033678589acb6e342303978c918vboxsync " create |\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync " remove <name>\n"
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync# endif
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync "\n");
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync }
ec9dc23c50665e8603e1be5a9b6b6fd4c4d949d4vboxsync#endif
d1fcf24d24368926be13484524a9e378070a9157vboxsync
d1fcf24d24368926be13484524a9e378070a9157vboxsync if (u64Cmd & USAGE_DHCPSERVER)
d1fcf24d24368926be13484524a9e378070a9157vboxsync {
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync RTPrintf("VBoxManage dhcpserver add|modify --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " [--ip <ip_address>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --netmask <network_mask>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --lowerip <lower_ip>\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --upperip <upper_ip>]\n"
f94a0382949ced48c6e6a8d33e0e1db52bc6d505vboxsync " [--enable | --disable]\n\n"
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync "VBoxManage dhcpserver remove --netname <network_name> |\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#if defined(VBOX_WITH_NETFLT)
3dd53c06fd54914761cf550503f02fce1ed5a815vboxsync " --ifname <hostonly_if_name>\n"
7bf07b1592dfaab1a4fb6d497fd0ff1302fb7585vboxsync#endif
d1fcf24d24368926be13484524a9e378070a9157vboxsync "\n");
d1fcf24d24368926be13484524a9e378070a9157vboxsync }
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print a usage synopsis and the syntax error message.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync showLogo(); // show logo even if suppressed
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#ifndef VBOX_ONLY_DOCS
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync if (g_fInternalMode)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync printUsageInternal(u64Cmd);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync else
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync printUsage(u64Cmd);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync#endif /* !VBOX_ONLY_DOCS */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("\n"
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync "Syntax error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return 1;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync/**
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * errorSyntax for RTGetOpt users.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync *
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @returns 1.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync *
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param fUsageCategory The usage category of the command.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param rc The RTGetOpt return code.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync * @param pValueUnion The value union.
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync */
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsyncint errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync{
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync showLogo(); // show logo even if suppressed
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#ifndef VBOX_ONLY_DOCS
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (g_fInternalMode)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync printUsageInternal(fUsageCategory);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync else
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync printUsage(fUsageCategory);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync#endif /* !VBOX_ONLY_DOCS */
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc == VINF_GETOPT_NOT_OPTION)
cd6f772684d21033e3f63af1801e9a08a61ee540vboxsync return RTPrintf("error: Invalid parameter '%s'\n", pValueUnion->psz);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc > 0)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync {
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (RT_C_IS_PRINT(rc))
cd6f772684d21033e3f63af1801e9a08a61ee540vboxsync return RTPrintf("error: Invalid option -%c\n", rc);
cd6f772684d21033e3f63af1801e9a08a61ee540vboxsync return RTPrintf("error: Invalid option case %i\n", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync }
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (rc == VERR_GETOPT_UNKNOWN_OPTION)
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync return RTPrintf("error: unknown option: %s\n", pValueUnion->psz);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync if (pValueUnion->pDef)
cd6f772684d21033e3f63af1801e9a08a61ee540vboxsync return RTPrintf("error: %s: %Rrs\n", pValueUnion->pDef->pszLong, rc);
cd6f772684d21033e3f63af1801e9a08a61ee540vboxsync return RTPrintf("error: %Rrs\n", rc);
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync}
a55af63ead2dcca370bfc0dfe49771d9dcc61b93vboxsync
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync/**
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync * Print an error message without the syntax stuff.
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync */
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsyncint errorArgument(const char *pszFormat, ...)
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync{
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_list args;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_start(args, pszFormat);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync RTPrintf("error: %N\n", pszFormat, &args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync va_end(args);
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync return 1;
2711c80499bbd95e3da4a6cd2dffd9f81a5dce98vboxsync}