| 1 | /* $Id: VBoxManageHelp.cpp 54911 2015-03-23 17:24:33Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VBoxManage - help and other message output.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2015 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | /*******************************************************************************
|
|---|
| 20 | * Header Files *
|
|---|
| 21 | *******************************************************************************/
|
|---|
| 22 | #include <VBox/version.h>
|
|---|
| 23 |
|
|---|
| 24 | #include <iprt/buildconfig.h>
|
|---|
| 25 | #include <iprt/ctype.h>
|
|---|
| 26 | #include <iprt/err.h>
|
|---|
| 27 | #include <iprt/getopt.h>
|
|---|
| 28 | #include <iprt/stream.h>
|
|---|
| 29 |
|
|---|
| 30 | #include "VBoxManage.h"
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 | void showLogo(PRTSTREAM pStrm)
|
|---|
| 35 | {
|
|---|
| 36 | static bool s_fShown; /* show only once */
|
|---|
| 37 |
|
|---|
| 38 | if (!s_fShown)
|
|---|
| 39 | {
|
|---|
| 40 | RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version "
|
|---|
| 41 | VBOX_VERSION_STRING "\n"
|
|---|
| 42 | "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
|
|---|
| 43 | "All rights reserved.\n"
|
|---|
| 44 | "\n");
|
|---|
| 45 | s_fShown = true;
|
|---|
| 46 | }
|
|---|
| 47 | }
|
|---|
| 48 |
|
|---|
| 49 | void printUsage(USAGECATEGORY fCategory, uint32_t fSubCategory, PRTSTREAM pStrm)
|
|---|
| 50 | {
|
|---|
| 51 | bool fDumpOpts = false;
|
|---|
| 52 | #ifdef RT_OS_LINUX
|
|---|
| 53 | bool fLinux = true;
|
|---|
| 54 | #else
|
|---|
| 55 | bool fLinux = false;
|
|---|
| 56 | #endif
|
|---|
| 57 | #ifdef RT_OS_WINDOWS
|
|---|
| 58 | bool fWin = true;
|
|---|
| 59 | #else
|
|---|
| 60 | bool fWin = false;
|
|---|
| 61 | #endif
|
|---|
| 62 | #ifdef RT_OS_SOLARIS
|
|---|
| 63 | bool fSolaris = true;
|
|---|
| 64 | #else
|
|---|
| 65 | bool fSolaris = false;
|
|---|
| 66 | #endif
|
|---|
| 67 | #ifdef RT_OS_FREEBSD
|
|---|
| 68 | bool fFreeBSD = true;
|
|---|
| 69 | #else
|
|---|
| 70 | bool fFreeBSD = false;
|
|---|
| 71 | #endif
|
|---|
| 72 | #ifdef RT_OS_DARWIN
|
|---|
| 73 | bool fDarwin = true;
|
|---|
| 74 | #else
|
|---|
| 75 | bool fDarwin = false;
|
|---|
| 76 | #endif
|
|---|
| 77 | #ifdef VBOX_WITH_VBOXSDL
|
|---|
| 78 | bool fVBoxSDL = true;
|
|---|
| 79 | #else
|
|---|
| 80 | bool fVBoxSDL = false;
|
|---|
| 81 | #endif
|
|---|
| 82 |
|
|---|
| 83 | if (fCategory == USAGE_DUMPOPTS)
|
|---|
| 84 | {
|
|---|
| 85 | fDumpOpts = true;
|
|---|
| 86 | fLinux = true;
|
|---|
| 87 | fWin = true;
|
|---|
| 88 | fSolaris = true;
|
|---|
| 89 | fFreeBSD = true;
|
|---|
| 90 | fDarwin = true;
|
|---|
| 91 | fVBoxSDL = true;
|
|---|
| 92 | fCategory = USAGE_ALL;
|
|---|
| 93 | }
|
|---|
| 94 |
|
|---|
| 95 | RTStrmPrintf(pStrm,
|
|---|
| 96 | "Usage:\n"
|
|---|
| 97 | "\n");
|
|---|
| 98 |
|
|---|
| 99 | if (fCategory == USAGE_ALL)
|
|---|
| 100 | RTStrmPrintf(pStrm,
|
|---|
| 101 | " VBoxManage [<general option>] <command>\n"
|
|---|
| 102 | " \n \n"
|
|---|
| 103 | "General Options:\n \n"
|
|---|
| 104 | " [-v|--version] print version number and exit\n"
|
|---|
| 105 | " [-q|--nologo] suppress the logo\n"
|
|---|
| 106 | " [--settingspw <pw>] provide the settings password\n"
|
|---|
| 107 | " [--settingspwfile <file>] provide a file containing the settings password\n"
|
|---|
| 108 | " \n \n"
|
|---|
| 109 | "Commands:\n \n");
|
|---|
| 110 |
|
|---|
| 111 | const char *pcszSep1 = " ";
|
|---|
| 112 | const char *pcszSep2 = " ";
|
|---|
| 113 | if (fCategory != USAGE_ALL)
|
|---|
| 114 | {
|
|---|
| 115 | pcszSep1 = "VBoxManage";
|
|---|
| 116 | pcszSep2 = "";
|
|---|
| 117 | }
|
|---|
| 118 |
|
|---|
| 119 | #define SEP pcszSep1, pcszSep2
|
|---|
| 120 |
|
|---|
| 121 | if (fCategory & USAGE_LIST)
|
|---|
| 122 | RTStrmPrintf(pStrm,
|
|---|
| 123 | "%s list [--long|-l]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n"
|
|---|
| 124 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 125 | " intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|\n"
|
|---|
| 126 | #else
|
|---|
| 127 | " intnets|bridgedifs|natnets|dhcpservers|hostinfo|\n"
|
|---|
| 128 | #endif
|
|---|
| 129 | " hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|\n"
|
|---|
| 130 | " usbhost|usbfilters|systemproperties|extpacks|\n"
|
|---|
| 131 | " groups|webcams|screenshotformats\n"
|
|---|
| 132 | "\n", SEP);
|
|---|
| 133 |
|
|---|
| 134 | if (fCategory & USAGE_SHOWVMINFO)
|
|---|
| 135 | RTStrmPrintf(pStrm,
|
|---|
| 136 | "%s showvminfo %s <uuid|vmname> [--details]\n"
|
|---|
| 137 | " [--machinereadable]\n"
|
|---|
| 138 | "%s showvminfo %s <uuid|vmname> --log <idx>\n"
|
|---|
| 139 | "\n", SEP, SEP);
|
|---|
| 140 |
|
|---|
| 141 | if (fCategory & USAGE_REGISTERVM)
|
|---|
| 142 | RTStrmPrintf(pStrm,
|
|---|
| 143 | "%s registervm %s <filename>\n"
|
|---|
| 144 | "\n", SEP);
|
|---|
| 145 |
|
|---|
| 146 | if (fCategory & USAGE_UNREGISTERVM)
|
|---|
| 147 | RTStrmPrintf(pStrm,
|
|---|
| 148 | "%s unregistervm %s <uuid|vmname> [--delete]\n"
|
|---|
| 149 | "\n", SEP);
|
|---|
| 150 |
|
|---|
| 151 | if (fCategory & USAGE_CREATEVM)
|
|---|
| 152 | RTStrmPrintf(pStrm,
|
|---|
| 153 | "%s createvm %s --name <name>\n"
|
|---|
| 154 | " [--groups <group>, ...]\n"
|
|---|
| 155 | " [--ostype <ostype>]\n"
|
|---|
| 156 | " [--register]\n"
|
|---|
| 157 | " [--basefolder <path>]\n"
|
|---|
| 158 | " [--uuid <uuid>]\n"
|
|---|
| 159 | "\n", SEP);
|
|---|
| 160 |
|
|---|
| 161 | if (fCategory & USAGE_MODIFYVM)
|
|---|
| 162 | {
|
|---|
| 163 | RTStrmPrintf(pStrm,
|
|---|
| 164 | "%s modifyvm %s <uuid|vmname>\n"
|
|---|
| 165 | " [--name <name>]\n"
|
|---|
| 166 | " [--groups <group>, ...]\n"
|
|---|
| 167 | " [--description <desc>]\n"
|
|---|
| 168 | " [--ostype <ostype>]\n"
|
|---|
| 169 | " [--iconfile <filename>]\n"
|
|---|
| 170 | " [--memory <memorysize in MB>]\n"
|
|---|
| 171 | " [--pagefusion on|off]\n"
|
|---|
| 172 | " [--vram <vramsize in MB>]\n"
|
|---|
| 173 | " [--acpi on|off]\n"
|
|---|
| 174 | #ifdef VBOX_WITH_PCI_PASSTHROUGH
|
|---|
| 175 | " [--pciattach 03:04.0]\n"
|
|---|
| 176 | " [--pciattach 03:04.0@02:01.0]\n"
|
|---|
| 177 | " [--pcidetach 03:04.0]\n"
|
|---|
| 178 | #endif
|
|---|
| 179 | " [--ioapic on|off]\n"
|
|---|
| 180 | " [--hpet on|off]\n"
|
|---|
| 181 | " [--triplefaultreset on|off]\n"
|
|---|
| 182 | " [--paravirtprovider none|default|legacy|minimal|\n"
|
|---|
| 183 | " hyperv|kvm]\n"
|
|---|
| 184 | " [--hwvirtex on|off]\n"
|
|---|
| 185 | " [--nestedpaging on|off]\n"
|
|---|
| 186 | " [--largepages on|off]\n"
|
|---|
| 187 | " [--vtxvpid on|off]\n"
|
|---|
| 188 | " [--vtxux on|off]\n"
|
|---|
| 189 | " [--pae on|off]\n"
|
|---|
| 190 | " [--longmode on|off]\n"
|
|---|
| 191 | " [--synthcpu on|off]\n"
|
|---|
| 192 | " [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]\n"
|
|---|
| 193 | " [--cpuidremove <leaf>]\n"
|
|---|
| 194 | " [--cpuidremoveall]\n"
|
|---|
| 195 | " [--hardwareuuid <uuid>]\n"
|
|---|
| 196 | " [--cpus <number>]\n"
|
|---|
| 197 | " [--cpuhotplug on|off]\n"
|
|---|
| 198 | " [--plugcpu <id>]\n"
|
|---|
| 199 | " [--unplugcpu <id>]\n"
|
|---|
| 200 | " [--cpuexecutioncap <1-100>]\n"
|
|---|
| 201 | " [--rtcuseutc on|off]\n"
|
|---|
| 202 | #ifdef VBOX_WITH_VMSVGA
|
|---|
| 203 | " [--graphicscontroller none|vboxvga|vmsvga]\n"
|
|---|
| 204 | #else
|
|---|
| 205 | " [--graphicscontroller none|vboxvga]\n"
|
|---|
| 206 | #endif
|
|---|
| 207 | " [--monitorcount <number>]\n"
|
|---|
| 208 | " [--accelerate3d on|off]\n"
|
|---|
| 209 | #ifdef VBOX_WITH_VIDEOHWACCEL
|
|---|
| 210 | " [--accelerate2dvideo on|off]\n"
|
|---|
| 211 | #endif
|
|---|
| 212 | " [--firmware bios|efi|efi32|efi64]\n"
|
|---|
| 213 | " [--chipset ich9|piix3]\n"
|
|---|
| 214 | " [--bioslogofadein on|off]\n"
|
|---|
| 215 | " [--bioslogofadeout on|off]\n"
|
|---|
| 216 | " [--bioslogodisplaytime <msec>]\n"
|
|---|
| 217 | " [--bioslogoimagepath <imagepath>]\n"
|
|---|
| 218 | " [--biosbootmenu disabled|menuonly|messageandmenu]\n"
|
|---|
| 219 | " [--biossystemtimeoffset <msec>]\n"
|
|---|
| 220 | " [--biospxedebug on|off]\n"
|
|---|
| 221 | " [--boot<1-4> none|floppy|dvd|disk|net>]\n"
|
|---|
| 222 | " [--nic<1-N> none|null|nat|bridged|intnet"
|
|---|
| 223 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 224 | "|hostonly"
|
|---|
| 225 | #endif
|
|---|
| 226 | "|\n"
|
|---|
| 227 | " generic|natnetwork"
|
|---|
| 228 | "]\n"
|
|---|
| 229 | " [--nictype<1-N> Am79C970A|Am79C973"
|
|---|
| 230 | #ifdef VBOX_WITH_E1000
|
|---|
| 231 | "|\n 82540EM|82543GC|82545EM"
|
|---|
| 232 | #endif
|
|---|
| 233 | #ifdef VBOX_WITH_VIRTIO
|
|---|
| 234 | "|\n virtio"
|
|---|
| 235 | #endif /* VBOX_WITH_VIRTIO */
|
|---|
| 236 | "]\n"
|
|---|
| 237 | " [--cableconnected<1-N> on|off]\n"
|
|---|
| 238 | " [--nictrace<1-N> on|off]\n"
|
|---|
| 239 | " [--nictracefile<1-N> <filename>]\n"
|
|---|
| 240 | " [--nicproperty<1-N> name=[value]]\n"
|
|---|
| 241 | " [--nicspeed<1-N> <kbps>]\n"
|
|---|
| 242 | " [--nicbootprio<1-N> <priority>]\n"
|
|---|
| 243 | " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n"
|
|---|
| 244 | " [--nicbandwidthgroup<1-N> none|<name>]\n"
|
|---|
| 245 | " [--bridgeadapter<1-N> none|<devicename>]\n"
|
|---|
| 246 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 247 | " [--hostonlyadapter<1-N> none|<devicename>]\n"
|
|---|
| 248 | #endif
|
|---|
| 249 | " [--intnet<1-N> <network name>]\n"
|
|---|
| 250 | " [--nat-network<1-N> <network name>]\n"
|
|---|
| 251 | " [--nicgenericdrv<1-N> <driver>\n"
|
|---|
| 252 | " [--natnet<1-N> <network>|default]\n"
|
|---|
| 253 | " [--natsettings<1-N> [<mtu>],[<socksnd>],\n"
|
|---|
| 254 | " [<sockrcv>],[<tcpsnd>],\n"
|
|---|
| 255 | " [<tcprcv>]]\n"
|
|---|
| 256 | " [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
|
|---|
| 257 | " <hostport>,[<guestip>],<guestport>]\n"
|
|---|
| 258 | " [--natpf<1-N> delete <rulename>]\n"
|
|---|
| 259 | " [--nattftpprefix<1-N> <prefix>]\n"
|
|---|
| 260 | " [--nattftpfile<1-N> <file>]\n"
|
|---|
| 261 | " [--nattftpserver<1-N> <ip>]\n"
|
|---|
| 262 | " [--natbindip<1-N> <ip>\n"
|
|---|
| 263 | " [--natdnspassdomain<1-N> on|off]\n"
|
|---|
| 264 | " [--natdnsproxy<1-N> on|off]\n"
|
|---|
| 265 | " [--natdnshostresolver<1-N> on|off]\n"
|
|---|
| 266 | " [--nataliasmode<1-N> default|[log],[proxyonly],\n"
|
|---|
| 267 | " [sameports]]\n"
|
|---|
| 268 | " [--macaddress<1-N> auto|<mac>]\n"
|
|---|
| 269 | " [--mouse ps2|usb|usbtablet|usbmultitouch]\n"
|
|---|
| 270 | " [--keyboard ps2|usb\n"
|
|---|
| 271 | " [--uart<1-N> off|<I/O base> <IRQ>]\n"
|
|---|
| 272 | " [--uartmode<1-N> disconnected|\n"
|
|---|
| 273 | " server <pipe>|\n"
|
|---|
| 274 | " client <pipe>|\n"
|
|---|
| 275 | " file <file>|\n"
|
|---|
| 276 | " <devicename>]\n"
|
|---|
| 277 | #if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS)
|
|---|
| 278 | " [--lpt<1-N> off|<I/O base> <IRQ>]\n"
|
|---|
| 279 | " [--lptmode<1-N> <devicename>]\n"
|
|---|
| 280 | #endif
|
|---|
| 281 | " [--guestmemoryballoon <balloonsize in MB>]\n"
|
|---|
| 282 | " [--audio none|null", SEP);
|
|---|
| 283 | if (fWin)
|
|---|
| 284 | {
|
|---|
| 285 | #ifdef VBOX_WITH_WINMM
|
|---|
| 286 | RTStrmPrintf(pStrm, "|winmm|dsound");
|
|---|
| 287 | #else
|
|---|
| 288 | RTStrmPrintf(pStrm, "|dsound");
|
|---|
| 289 | #endif
|
|---|
| 290 | }
|
|---|
| 291 | if (fSolaris)
|
|---|
| 292 | {
|
|---|
| 293 | RTStrmPrintf(pStrm, "|solaudio"
|
|---|
| 294 | #ifdef VBOX_WITH_SOLARIS_OSS
|
|---|
| 295 | "|oss"
|
|---|
| 296 | #endif
|
|---|
| 297 | );
|
|---|
| 298 | }
|
|---|
| 299 | if (fLinux)
|
|---|
| 300 | {
|
|---|
| 301 | RTStrmPrintf(pStrm, "|oss"
|
|---|
| 302 | #ifdef VBOX_WITH_ALSA
|
|---|
| 303 | "|alsa"
|
|---|
| 304 | #endif
|
|---|
| 305 | #ifdef VBOX_WITH_PULSE
|
|---|
| 306 | "|pulse"
|
|---|
| 307 | #endif
|
|---|
| 308 | );
|
|---|
| 309 | }
|
|---|
| 310 | if (fFreeBSD)
|
|---|
| 311 | {
|
|---|
| 312 | /* Get the line break sorted when dumping all option variants. */
|
|---|
| 313 | if (fDumpOpts)
|
|---|
| 314 | {
|
|---|
| 315 | RTStrmPrintf(pStrm, "|\n"
|
|---|
| 316 | " oss");
|
|---|
| 317 | }
|
|---|
| 318 | else
|
|---|
| 319 | RTStrmPrintf(pStrm, "|oss");
|
|---|
| 320 | #ifdef VBOX_WITH_PULSE
|
|---|
| 321 | RTStrmPrintf(pStrm, "|pulse");
|
|---|
| 322 | #endif
|
|---|
| 323 | }
|
|---|
| 324 | if (fDarwin)
|
|---|
| 325 | {
|
|---|
| 326 | RTStrmPrintf(pStrm, "|coreaudio");
|
|---|
| 327 | }
|
|---|
| 328 | RTStrmPrintf(pStrm, "]\n");
|
|---|
| 329 | RTStrmPrintf(pStrm,
|
|---|
| 330 | " [--audiocontroller ac97|hda|sb16]\n"
|
|---|
| 331 | " [--clipboard disabled|hosttoguest|guesttohost|\n"
|
|---|
| 332 | " bidirectional]\n"
|
|---|
| 333 | " [--draganddrop disabled|hosttoguest]\n");
|
|---|
| 334 | RTStrmPrintf(pStrm,
|
|---|
| 335 | " [--vrde on|off]\n"
|
|---|
| 336 | " [--vrdeextpack default|<name>\n"
|
|---|
| 337 | " [--vrdeproperty <name=[value]>]\n"
|
|---|
| 338 | " [--vrdeport <hostport>]\n"
|
|---|
| 339 | " [--vrdeaddress <hostip>]\n"
|
|---|
| 340 | " [--vrdeauthtype null|external|guest]\n"
|
|---|
| 341 | " [--vrdeauthlibrary default|<name>\n"
|
|---|
| 342 | " [--vrdemulticon on|off]\n"
|
|---|
| 343 | " [--vrdereusecon on|off]\n"
|
|---|
| 344 | " [--vrdevideochannel on|off]\n"
|
|---|
| 345 | " [--vrdevideochannelquality <percent>]\n");
|
|---|
| 346 | RTStrmPrintf(pStrm,
|
|---|
| 347 | " [--usb on|off]\n"
|
|---|
| 348 | " [--usbehci on|off]\n"
|
|---|
| 349 | " [--snapshotfolder default|<path>]\n"
|
|---|
| 350 | " [--teleporter on|off]\n"
|
|---|
| 351 | " [--teleporterport <port>]\n"
|
|---|
| 352 | " [--teleporteraddress <address|empty>\n"
|
|---|
| 353 | " [--teleporterpassword <password>]\n"
|
|---|
| 354 | " [--teleporterpasswordfile <file>|stdin]\n"
|
|---|
| 355 | " [--tracing-enabled on|off]\n"
|
|---|
| 356 | " [--tracing-config <config-string>]\n"
|
|---|
| 357 | " [--tracing-allow-vm-access on|off]\n"
|
|---|
| 358 | #if 0
|
|---|
| 359 | " [--iocache on|off]\n"
|
|---|
| 360 | " [--iocachesize <I/O cache size in MB>]\n"
|
|---|
| 361 | #endif
|
|---|
| 362 | #if 0
|
|---|
| 363 | " [--faulttolerance master|standby]\n"
|
|---|
| 364 | " [--faulttoleranceaddress <name>]\n"
|
|---|
| 365 | " [--faulttoleranceport <port>]\n"
|
|---|
| 366 | " [--faulttolerancesyncinterval <msec>]\n"
|
|---|
| 367 | " [--faulttolerancepassword <password>]\n"
|
|---|
| 368 | #endif
|
|---|
| 369 | #ifdef VBOX_WITH_USB_CARDREADER
|
|---|
| 370 | " [--usbcardreader on|off]\n"
|
|---|
| 371 | #endif
|
|---|
| 372 | " [--autostart-enabled on|off]\n"
|
|---|
| 373 | " [--autostart-delay <seconds>]\n"
|
|---|
| 374 | #if 0
|
|---|
| 375 | " [--autostop-type disabled|savestate|poweroff|\n"
|
|---|
| 376 | " acpishutdown]\n"
|
|---|
| 377 | #endif
|
|---|
| 378 | #ifdef VBOX_WITH_VPX
|
|---|
| 379 | " [--videocap on|off]\n"
|
|---|
| 380 | " [--videocapscreens all|<screen ID> [<screen ID> ...]]\n"
|
|---|
| 381 | " [--videocapfile <filename>]\n"
|
|---|
| 382 | " [--videocapres <width> <height>]\n"
|
|---|
| 383 | " [--videocaprate <rate>]\n"
|
|---|
| 384 | " [--videocapfps <fps>]\n"
|
|---|
| 385 | " [--videocapmaxtime <time>]\n"
|
|---|
| 386 | " [--videocapmaxsize <MB>]\n"
|
|---|
| 387 | " [--videocapopts <key=value> [<key=value> ...]]\n"
|
|---|
| 388 | #endif
|
|---|
| 389 | " [--defaultfrontend default|<name>]\n"
|
|---|
| 390 | "\n");
|
|---|
| 391 | }
|
|---|
| 392 |
|
|---|
| 393 | if (fCategory & USAGE_CLONEVM)
|
|---|
| 394 | RTStrmPrintf(pStrm,
|
|---|
| 395 | "%s clonevm %s <uuid|vmname>\n"
|
|---|
| 396 | " [--snapshot <uuid>|<name>]\n"
|
|---|
| 397 | " [--mode machine|machineandchildren|all]\n"
|
|---|
| 398 | " [--options link|keepallmacs|keepnatmacs|\n"
|
|---|
| 399 | " keepdisknames]\n"
|
|---|
| 400 | " [--name <name>]\n"
|
|---|
| 401 | " [--groups <group>, ...]\n"
|
|---|
| 402 | " [--basefolder <basefolder>]\n"
|
|---|
| 403 | " [--uuid <uuid>]\n"
|
|---|
| 404 | " [--register]\n"
|
|---|
| 405 | "\n", SEP);
|
|---|
| 406 |
|
|---|
| 407 | if (fCategory & USAGE_IMPORTAPPLIANCE)
|
|---|
| 408 | RTStrmPrintf(pStrm,
|
|---|
| 409 | "%s import %s <ovfname/ovaname>\n"
|
|---|
| 410 | " [--dry-run|-n]\n"
|
|---|
| 411 | " [--options keepallmacs|keepnatmacs]\n"
|
|---|
| 412 | " [more options]\n"
|
|---|
| 413 | " (run with -n to have options displayed\n"
|
|---|
| 414 | " for a particular OVF)\n\n", SEP);
|
|---|
| 415 |
|
|---|
| 416 | if (fCategory & USAGE_EXPORTAPPLIANCE)
|
|---|
| 417 | RTStrmPrintf(pStrm,
|
|---|
| 418 | "%s export %s <machines> --output|-o <name>.<ovf/ova>\n"
|
|---|
| 419 | " [--legacy09|--ovf09|--ovf10|--ovf20]\n"
|
|---|
| 420 | " [--manifest]\n"
|
|---|
| 421 | " [--iso]\n"
|
|---|
| 422 | " [--options manifest|iso|nomacs|nomacsbutnat]\n"
|
|---|
| 423 | " [--vsys <number of virtual system>]\n"
|
|---|
| 424 | " [--product <product name>]\n"
|
|---|
| 425 | " [--producturl <product url>]\n"
|
|---|
| 426 | " [--vendor <vendor name>]\n"
|
|---|
| 427 | " [--vendorurl <vendor url>]\n"
|
|---|
| 428 | " [--version <version info>]\n"
|
|---|
| 429 | " [--description <description info>]\n"
|
|---|
| 430 | " [--eula <license text>]\n"
|
|---|
| 431 | " [--eulafile <filename>]\n"
|
|---|
| 432 | "\n", SEP);
|
|---|
| 433 |
|
|---|
| 434 | if (fCategory & USAGE_STARTVM)
|
|---|
| 435 | {
|
|---|
| 436 | RTStrmPrintf(pStrm,
|
|---|
| 437 | "%s startvm %s <uuid|vmname>...\n"
|
|---|
| 438 | " [--type gui", SEP);
|
|---|
| 439 | if (fVBoxSDL)
|
|---|
| 440 | RTStrmPrintf(pStrm, "|sdl");
|
|---|
| 441 | RTStrmPrintf(pStrm, "|headless]\n");
|
|---|
| 442 | RTStrmPrintf(pStrm,
|
|---|
| 443 | "\n");
|
|---|
| 444 | }
|
|---|
| 445 |
|
|---|
| 446 | if (fCategory & USAGE_CONTROLVM)
|
|---|
| 447 | {
|
|---|
| 448 | RTStrmPrintf(pStrm,
|
|---|
| 449 | "%s controlvm %s <uuid|vmname>\n"
|
|---|
| 450 | " pause|resume|reset|poweroff|savestate|\n"
|
|---|
| 451 | " acpipowerbutton|acpisleepbutton|\n"
|
|---|
| 452 | " keyboardputscancode <hex> [<hex> ...]|\n"
|
|---|
| 453 | " setlinkstate<1-N> on|off |\n"
|
|---|
| 454 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 455 | " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n"
|
|---|
| 456 | " natnetwork [<devicename>] |\n"
|
|---|
| 457 | #else /* !VBOX_WITH_NETFLT */
|
|---|
| 458 | " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n"
|
|---|
| 459 | " [<devicename>] |\n"
|
|---|
| 460 | #endif /* !VBOX_WITH_NETFLT */
|
|---|
| 461 | " nictrace<1-N> on|off |\n"
|
|---|
| 462 | " nictracefile<1-N> <filename> |\n"
|
|---|
| 463 | " nicproperty<1-N> name=[value] |\n"
|
|---|
| 464 | " nicpromisc<1-N> deny|allow-vms|allow-all |\n"
|
|---|
| 465 | " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n"
|
|---|
| 466 | " <hostport>,[<guestip>],<guestport> |\n"
|
|---|
| 467 | " natpf<1-N> delete <rulename> |\n"
|
|---|
| 468 | " guestmemoryballoon <balloonsize in MB> |\n"
|
|---|
| 469 | " usbattach <uuid>|<address>\n"
|
|---|
| 470 | " [--capturefile <filename>] |\n"
|
|---|
| 471 | " usbdetach <uuid>|<address> |\n"
|
|---|
| 472 | " clipboard disabled|hosttoguest|guesttohost|\n"
|
|---|
| 473 | " bidirectional |\n"
|
|---|
| 474 | " draganddrop disabled|hosttoguest |\n"
|
|---|
| 475 | " vrde on|off |\n"
|
|---|
| 476 | " vrdeport <port> |\n"
|
|---|
| 477 | " vrdeproperty <name=[value]> |\n"
|
|---|
| 478 | " vrdevideochannelquality <percent> |\n"
|
|---|
| 479 | " setvideomodehint <xres> <yres> <bpp>\n"
|
|---|
| 480 | " [[<display>] [<enabled:yes|no> |\n"
|
|---|
| 481 | " [<xorigin> <yorigin>]]] |\n"
|
|---|
| 482 | " screenshotpng <file> [display] |\n"
|
|---|
| 483 | " vcpenabled on|off |\n"
|
|---|
| 484 | " vcpscreens all|none|<screen>,[<screen>...] |\n"
|
|---|
| 485 | " setcredentials <username>\n"
|
|---|
| 486 | " --passwordfile <file> | <password>\n"
|
|---|
| 487 | " <domain>\n"
|
|---|
| 488 | " [--allowlocallogon <yes|no>] |\n"
|
|---|
| 489 | " teleport --host <name> --port <port>\n"
|
|---|
| 490 | " [--maxdowntime <msec>]\n"
|
|---|
| 491 | " [--passwordfile <file> |\n"
|
|---|
| 492 | " --password <password>] |\n"
|
|---|
| 493 | " plugcpu <id> |\n"
|
|---|
| 494 | " unplugcpu <id> |\n"
|
|---|
| 495 | " cpuexecutioncap <1-100>\n"
|
|---|
| 496 | " webcam <attach [path [settings]]> | <detach [path]> | <list>\n"
|
|---|
| 497 | " addencpassword <id>\n"
|
|---|
| 498 | " <password>\n"
|
|---|
| 499 | " [--removeonsuspend <yes|no>]\n"
|
|---|
| 500 | " removeencpassword <id>\n"
|
|---|
| 501 | " removeallencpasswords\n"
|
|---|
| 502 | "\n", SEP);
|
|---|
| 503 | }
|
|---|
| 504 |
|
|---|
| 505 | if (fCategory & USAGE_DISCARDSTATE)
|
|---|
| 506 | RTStrmPrintf(pStrm,
|
|---|
| 507 | "%s discardstate %s <uuid|vmname>\n"
|
|---|
| 508 | "\n", SEP);
|
|---|
| 509 |
|
|---|
| 510 | if (fCategory & USAGE_ADOPTSTATE)
|
|---|
| 511 | RTStrmPrintf(pStrm,
|
|---|
| 512 | "%s adoptstate %s <uuid|vmname> <state_file>\n"
|
|---|
| 513 | "\n", SEP);
|
|---|
| 514 |
|
|---|
| 515 | if (fCategory & USAGE_SNAPSHOT)
|
|---|
| 516 | RTStrmPrintf(pStrm,
|
|---|
| 517 | "%s snapshot %s <uuid|vmname>\n"
|
|---|
| 518 | " take <name> [--description <desc>] [--live] |\n"
|
|---|
| 519 | " delete <uuid|snapname> |\n"
|
|---|
| 520 | " restore <uuid|snapname> |\n"
|
|---|
| 521 | " restorecurrent |\n"
|
|---|
| 522 | " edit <uuid|snapname>|--current\n"
|
|---|
| 523 | " [--name <name>]\n"
|
|---|
| 524 | " [--description <desc>] |\n"
|
|---|
| 525 | " list [--details|--machinereadable]\n"
|
|---|
| 526 | " showvminfo <uuid|snapname>\n"
|
|---|
| 527 | "\n", SEP);
|
|---|
| 528 |
|
|---|
| 529 | if (fCategory & USAGE_CLOSEMEDIUM)
|
|---|
| 530 | RTStrmPrintf(pStrm,
|
|---|
| 531 | "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n"
|
|---|
| 532 | " [--delete]\n"
|
|---|
| 533 | "\n", SEP);
|
|---|
| 534 |
|
|---|
| 535 | if (fCategory & USAGE_STORAGEATTACH)
|
|---|
| 536 | RTStrmPrintf(pStrm,
|
|---|
| 537 | "%s storageattach %s <uuid|vmname>\n"
|
|---|
| 538 | " --storagectl <name>\n"
|
|---|
| 539 | " [--port <number>]\n"
|
|---|
| 540 | " [--device <number>]\n"
|
|---|
| 541 | " [--type dvddrive|hdd|fdd]\n"
|
|---|
| 542 | " [--medium none|emptydrive|additions|\n"
|
|---|
| 543 | " <uuid|filename>|host:<drive>|iscsi]\n"
|
|---|
| 544 | " [--mtype normal|writethrough|immutable|shareable|\n"
|
|---|
| 545 | " readonly|multiattach]\n"
|
|---|
| 546 | " [--comment <text>]\n"
|
|---|
| 547 | " [--setuuid <uuid>]\n"
|
|---|
| 548 | " [--setparentuuid <uuid>]\n"
|
|---|
| 549 | " [--passthrough on|off]\n"
|
|---|
| 550 | " [--tempeject on|off]\n"
|
|---|
| 551 | " [--nonrotational on|off]\n"
|
|---|
| 552 | " [--discard on|off]\n"
|
|---|
| 553 | " [--hotpluggable on|off]\n"
|
|---|
| 554 | " [--bandwidthgroup <name>]\n"
|
|---|
| 555 | " [--forceunmount]\n"
|
|---|
| 556 | " [--server <name>|<ip>]\n"
|
|---|
| 557 | " [--target <target>]\n"
|
|---|
| 558 | " [--tport <port>]\n"
|
|---|
| 559 | " [--lun <lun>]\n"
|
|---|
| 560 | " [--encodedlun <lun>]\n"
|
|---|
| 561 | " [--username <username>]\n"
|
|---|
| 562 | " [--password <password>]\n"
|
|---|
| 563 | " [--initiator <initiator>]\n"
|
|---|
| 564 | " [--intnet]\n"
|
|---|
| 565 | "\n", SEP);
|
|---|
| 566 |
|
|---|
| 567 | if (fCategory & USAGE_STORAGECONTROLLER)
|
|---|
| 568 | RTStrmPrintf(pStrm,
|
|---|
| 569 | "%s storagectl %s <uuid|vmname>\n"
|
|---|
| 570 | " --name <name>\n"
|
|---|
| 571 | " [--add ide|sata|scsi|floppy|sas]\n"
|
|---|
| 572 | " [--controller LSILogic|LSILogicSAS|BusLogic|\n"
|
|---|
| 573 | " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n"
|
|---|
| 574 | " [--portcount <1-n>]\n"
|
|---|
| 575 | " [--hostiocache on|off]\n"
|
|---|
| 576 | " [--bootable on|off]\n"
|
|---|
| 577 | " [--remove]\n"
|
|---|
| 578 | "\n", SEP);
|
|---|
| 579 |
|
|---|
| 580 | if (fCategory & USAGE_BANDWIDTHCONTROL)
|
|---|
| 581 | RTStrmPrintf(pStrm,
|
|---|
| 582 | "%s bandwidthctl %s <uuid|vmname>\n"
|
|---|
| 583 | " add <name> --type disk|network\n"
|
|---|
| 584 | " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
|
|---|
| 585 | " set <name>\n"
|
|---|
| 586 | " --limit <megabytes per second>[k|m|g|K|M|G] |\n"
|
|---|
| 587 | " remove <name> |\n"
|
|---|
| 588 | " list [--machinereadable]\n"
|
|---|
| 589 | " (limit units: k=kilobit, m=megabit, g=gigabit,\n"
|
|---|
| 590 | " K=kilobyte, M=megabyte, G=gigabyte)\n"
|
|---|
| 591 | "\n", SEP);
|
|---|
| 592 |
|
|---|
| 593 | if (fCategory & USAGE_SHOWMEDIUMINFO)
|
|---|
| 594 | RTStrmPrintf(pStrm,
|
|---|
| 595 | "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n"
|
|---|
| 596 | "\n", SEP);
|
|---|
| 597 |
|
|---|
| 598 | if (fCategory & USAGE_CREATEMEDIUM)
|
|---|
| 599 | RTStrmPrintf(pStrm,
|
|---|
| 600 | "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n"
|
|---|
| 601 | " [--size <megabytes>|--sizebyte <bytes>]\n"
|
|---|
| 602 | " [--diffparent <uuid>|<filename>\n"
|
|---|
| 603 | " [--format VDI|VMDK|VHD] (default: VDI)\n"
|
|---|
| 604 | " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
|
|---|
| 605 | "\n", SEP);
|
|---|
| 606 |
|
|---|
| 607 | if (fCategory & USAGE_MODIFYMEDIUM)
|
|---|
| 608 | RTStrmPrintf(pStrm,
|
|---|
| 609 | "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n"
|
|---|
| 610 | " [--type normal|writethrough|immutable|shareable|\n"
|
|---|
| 611 | " readonly|multiattach]\n"
|
|---|
| 612 | " [--autoreset on|off]\n"
|
|---|
| 613 | " [--property <name=[value]>]\n"
|
|---|
| 614 | " [--compact]\n"
|
|---|
| 615 | " [--resize <megabytes>|--resizebyte <bytes>]\n"
|
|---|
| 616 | "\n", SEP);
|
|---|
| 617 |
|
|---|
| 618 | if (fCategory & USAGE_CLONEMEDIUM)
|
|---|
| 619 | RTStrmPrintf(pStrm,
|
|---|
| 620 | "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n"
|
|---|
| 621 | " [--format VDI|VMDK|VHD|RAW|<other>]\n"
|
|---|
| 622 | " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
|
|---|
| 623 | " [--existing]\n"
|
|---|
| 624 | "\n", SEP);
|
|---|
| 625 |
|
|---|
| 626 | if (fCategory & USAGE_MEDIUMPROPERTY)
|
|---|
| 627 | RTStrmPrintf(pStrm,
|
|---|
| 628 | "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n"
|
|---|
| 629 | " <property> <value>\n"
|
|---|
| 630 | "\n"
|
|---|
| 631 | " [disk|dvd|floppy] get <uuid|filename>\n"
|
|---|
| 632 | " <property>\n"
|
|---|
| 633 | "\n"
|
|---|
| 634 | " [disk|dvd|floppy] delete <uuid|filename>\n"
|
|---|
| 635 | " <property>\n"
|
|---|
| 636 | "\n", SEP);
|
|---|
| 637 |
|
|---|
| 638 | if (fCategory & USAGE_ENCRYPTMEDIUM)
|
|---|
| 639 | RTStrmPrintf(pStrm,
|
|---|
| 640 | "%s encryptmedium %s <uuid|filename>\n"
|
|---|
| 641 | " [--newpassword <file>|-]\n"
|
|---|
| 642 | " [--oldpassword <file>|-]\n"
|
|---|
| 643 | " [--cipher <cipher identifier>]\n"
|
|---|
| 644 | " [--newpasswordid <password identifier>]\n"
|
|---|
| 645 | "\n", SEP);
|
|---|
| 646 |
|
|---|
| 647 | if (fCategory & USAGE_MEDIUMENCCHKPWD)
|
|---|
| 648 | RTStrmPrintf(pStrm,
|
|---|
| 649 | "%s checkmediumpwd %s <uuid|filename>\n"
|
|---|
| 650 | " <pwd file>|-\n"
|
|---|
| 651 | "\n", SEP);
|
|---|
| 652 |
|
|---|
| 653 | if (fCategory & USAGE_CONVERTFROMRAW)
|
|---|
| 654 | RTStrmPrintf(pStrm,
|
|---|
| 655 | "%s convertfromraw %s <filename> <outputfile>\n"
|
|---|
| 656 | " [--format VDI|VMDK|VHD]\n"
|
|---|
| 657 | " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
|
|---|
| 658 | " [--uuid <uuid>]\n"
|
|---|
| 659 | "%s convertfromraw %s stdin <outputfile> <bytes>\n"
|
|---|
| 660 | " [--format VDI|VMDK|VHD]\n"
|
|---|
| 661 | " [--variant Standard,Fixed,Split2G,Stream,ESX]\n"
|
|---|
| 662 | " [--uuid <uuid>]\n"
|
|---|
| 663 | "\n", SEP, SEP);
|
|---|
| 664 |
|
|---|
| 665 | if (fCategory & USAGE_GETEXTRADATA)
|
|---|
| 666 | RTStrmPrintf(pStrm,
|
|---|
| 667 | "%s getextradata %s global|<uuid|vmname>\n"
|
|---|
| 668 | " <key>|enumerate\n"
|
|---|
| 669 | "\n", SEP);
|
|---|
| 670 |
|
|---|
| 671 | if (fCategory & USAGE_SETEXTRADATA)
|
|---|
| 672 | RTStrmPrintf(pStrm,
|
|---|
| 673 | "%s setextradata %s global|<uuid|vmname>\n"
|
|---|
| 674 | " <key>\n"
|
|---|
| 675 | " [<value>] (no value deletes key)\n"
|
|---|
| 676 | "\n", SEP);
|
|---|
| 677 |
|
|---|
| 678 | if (fCategory & USAGE_SETPROPERTY)
|
|---|
| 679 | RTStrmPrintf(pStrm,
|
|---|
| 680 | "%s setproperty %s machinefolder default|<folder> |\n"
|
|---|
| 681 | " hwvirtexclusive on|off |\n"
|
|---|
| 682 | " vrdeauthlibrary default|<library> |\n"
|
|---|
| 683 | " websrvauthlibrary default|null|<library> |\n"
|
|---|
| 684 | " vrdeextpack null|<library> |\n"
|
|---|
| 685 | " autostartdbpath null|<folder> |\n"
|
|---|
| 686 | " loghistorycount <value>\n"
|
|---|
| 687 | " defaultfrontend default|<name>\n"
|
|---|
| 688 | "\n", SEP);
|
|---|
| 689 |
|
|---|
| 690 | if (fCategory & USAGE_USBFILTER_ADD)
|
|---|
| 691 | RTStrmPrintf(pStrm,
|
|---|
| 692 | "%s usbfilter %s add <index,0-N>\n"
|
|---|
| 693 | " --target <uuid|vmname>|global\n"
|
|---|
| 694 | " --name <string>\n"
|
|---|
| 695 | " --action ignore|hold (global filters only)\n"
|
|---|
| 696 | " [--active yes|no] (yes)\n"
|
|---|
| 697 | " [--vendorid <XXXX>] (null)\n"
|
|---|
| 698 | " [--productid <XXXX>] (null)\n"
|
|---|
| 699 | " [--revision <IIFF>] (null)\n"
|
|---|
| 700 | " [--manufacturer <string>] (null)\n"
|
|---|
| 701 | " [--product <string>] (null)\n"
|
|---|
| 702 | " [--remote yes|no] (null, VM filters only)\n"
|
|---|
| 703 | " [--serialnumber <string>] (null)\n"
|
|---|
| 704 | " [--maskedinterfaces <XXXXXXXX>]\n"
|
|---|
| 705 | "\n", SEP);
|
|---|
| 706 |
|
|---|
| 707 | if (fCategory & USAGE_USBFILTER_MODIFY)
|
|---|
| 708 | RTStrmPrintf(pStrm,
|
|---|
| 709 | "%s usbfilter %s modify <index,0-N>\n"
|
|---|
| 710 | " --target <uuid|vmname>|global\n"
|
|---|
| 711 | " [--name <string>]\n"
|
|---|
| 712 | " [--action ignore|hold] (global filters only)\n"
|
|---|
| 713 | " [--active yes|no]\n"
|
|---|
| 714 | " [--vendorid <XXXX>|\"\"]\n"
|
|---|
| 715 | " [--productid <XXXX>|\"\"]\n"
|
|---|
| 716 | " [--revision <IIFF>|\"\"]\n"
|
|---|
| 717 | " [--manufacturer <string>|\"\"]\n"
|
|---|
| 718 | " [--product <string>|\"\"]\n"
|
|---|
| 719 | " [--remote yes|no] (null, VM filters only)\n"
|
|---|
| 720 | " [--serialnumber <string>|\"\"]\n"
|
|---|
| 721 | " [--maskedinterfaces <XXXXXXXX>]\n"
|
|---|
| 722 | "\n", SEP);
|
|---|
| 723 |
|
|---|
| 724 | if (fCategory & USAGE_USBFILTER_REMOVE)
|
|---|
| 725 | RTStrmPrintf(pStrm,
|
|---|
| 726 | "%s usbfilter %s remove <index,0-N>\n"
|
|---|
| 727 | " --target <uuid|vmname>|global\n"
|
|---|
| 728 | "\n", SEP);
|
|---|
| 729 |
|
|---|
| 730 | if (fCategory & USAGE_SHAREDFOLDER_ADD)
|
|---|
| 731 | RTStrmPrintf(pStrm,
|
|---|
| 732 | "%s sharedfolder %s add <uuid|vmname>\n"
|
|---|
| 733 | " --name <name> --hostpath <hostpath>\n"
|
|---|
| 734 | " [--transient] [--readonly] [--automount]\n"
|
|---|
| 735 | "\n", SEP);
|
|---|
| 736 |
|
|---|
| 737 | if (fCategory & USAGE_SHAREDFOLDER_REMOVE)
|
|---|
| 738 | RTStrmPrintf(pStrm,
|
|---|
| 739 | "%s sharedfolder %s remove <uuid|vmname>\n"
|
|---|
| 740 | " --name <name> [--transient]\n"
|
|---|
| 741 | "\n", SEP);
|
|---|
| 742 |
|
|---|
| 743 | #ifdef VBOX_WITH_GUEST_PROPS
|
|---|
| 744 | if (fCategory & USAGE_GUESTPROPERTY)
|
|---|
| 745 | usageGuestProperty(pStrm, SEP);
|
|---|
| 746 | #endif /* VBOX_WITH_GUEST_PROPS defined */
|
|---|
| 747 |
|
|---|
| 748 | #ifdef VBOX_WITH_GUEST_CONTROL
|
|---|
| 749 | if (fCategory & USAGE_GUESTCONTROL)
|
|---|
| 750 | usageGuestControl(pStrm, SEP, fSubCategory);
|
|---|
| 751 | #endif /* VBOX_WITH_GUEST_CONTROL defined */
|
|---|
| 752 |
|
|---|
| 753 | if (fCategory & USAGE_DEBUGVM)
|
|---|
| 754 | {
|
|---|
| 755 | RTStrmPrintf(pStrm,
|
|---|
| 756 | "%s debugvm %s <uuid|vmname>\n"
|
|---|
| 757 | " dumpguestcore --filename <name> |\n"
|
|---|
| 758 | " info <item> [args] |\n"
|
|---|
| 759 | " injectnmi |\n"
|
|---|
| 760 | " log [--release|--debug] <settings> ...|\n"
|
|---|
| 761 | " logdest [--release|--debug] <settings> ...|\n"
|
|---|
| 762 | " logflags [--release|--debug] <settings> ...|\n"
|
|---|
| 763 | " osdetect |\n"
|
|---|
| 764 | " osinfo |\n"
|
|---|
| 765 | " getregisters [--cpu <id>] <reg>|all ... |\n"
|
|---|
| 766 | " setregisters [--cpu <id>] <reg>=<value> ... |\n"
|
|---|
| 767 | " show [--human-readable|--sh-export|--sh-eval|\n"
|
|---|
| 768 | " --cmd-set] \n"
|
|---|
| 769 | " <logdbg-settings|logrel-settings>\n"
|
|---|
| 770 | " [[opt] what ...] |\n"
|
|---|
| 771 | " statistics [--reset] [--pattern <pattern>]\n"
|
|---|
| 772 | " [--descriptions]\n"
|
|---|
| 773 | "\n", SEP);
|
|---|
| 774 | }
|
|---|
| 775 | if (fCategory & USAGE_METRICS)
|
|---|
| 776 | RTStrmPrintf(pStrm,
|
|---|
| 777 | "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n"
|
|---|
| 778 | " (comma-separated)\n\n"
|
|---|
| 779 | "%s metrics %s setup\n"
|
|---|
| 780 | " [--period <seconds>] (default: 1)\n"
|
|---|
| 781 | " [--samples <count>] (default: 1)\n"
|
|---|
| 782 | " [--list]\n"
|
|---|
| 783 | " [*|host|<vmname> [<metric_list>]]\n\n"
|
|---|
| 784 | "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n"
|
|---|
| 785 | "%s metrics %s enable\n"
|
|---|
| 786 | " [--list]\n"
|
|---|
| 787 | " [*|host|<vmname> [<metric_list>]]\n\n"
|
|---|
| 788 | "%s metrics %s disable\n"
|
|---|
| 789 | " [--list]\n"
|
|---|
| 790 | " [*|host|<vmname> [<metric_list>]]\n\n"
|
|---|
| 791 | "%s metrics %s collect\n"
|
|---|
| 792 | " [--period <seconds>] (default: 1)\n"
|
|---|
| 793 | " [--samples <count>] (default: 1)\n"
|
|---|
| 794 | " [--list]\n"
|
|---|
| 795 | " [--detach]\n"
|
|---|
| 796 | " [*|host|<vmname> [<metric_list>]]\n"
|
|---|
| 797 | "\n", SEP, SEP, SEP, SEP, SEP, SEP);
|
|---|
| 798 |
|
|---|
| 799 | #if defined(VBOX_WITH_NAT_SERVICE)
|
|---|
| 800 | if (fCategory & USAGE_NATNETWORK)
|
|---|
| 801 | {
|
|---|
| 802 | RTStrmPrintf(pStrm,
|
|---|
| 803 | "%s natnetwork %s add --netname <name>\n"
|
|---|
| 804 | " --network <network>\n"
|
|---|
| 805 | " [--enable|--disable]\n"
|
|---|
| 806 | " [--dhcp on|off]\n"
|
|---|
| 807 | " [--port-forward-4 <rule>]\n"
|
|---|
| 808 | " [--loopback-4 <rule>]\n"
|
|---|
| 809 | " [--ipv6 on|off]\n"
|
|---|
| 810 | " [--port-forward-6 <rule>]\n"
|
|---|
| 811 | " [--loopback-6 <rule>]\n\n"
|
|---|
| 812 | "%s natnetwork %s remove --netname <name>\n\n"
|
|---|
| 813 | "%s natnetwork %s modify --netname <name>\n"
|
|---|
| 814 | " [--network <network>]\n"
|
|---|
| 815 | " [--enable|--disable]\n"
|
|---|
| 816 | " [--dhcp on|off]\n"
|
|---|
| 817 | " [--port-forward-4 <rule>]\n"
|
|---|
| 818 | " [--loopback-4 <rule>]\n"
|
|---|
| 819 | " [--ipv6 on|off]\n"
|
|---|
| 820 | " [--port-forward-6 <rule>]\n"
|
|---|
| 821 | " [--loopback-6 <rule>]\n\n"
|
|---|
| 822 | "%s natnetwork %s start --netname <name>\n\n"
|
|---|
| 823 | "%s natnetwork %s stop --netname <name>\n"
|
|---|
| 824 | "\n", SEP, SEP, SEP, SEP, SEP);
|
|---|
| 825 |
|
|---|
| 826 |
|
|---|
| 827 | }
|
|---|
| 828 | #endif
|
|---|
| 829 |
|
|---|
| 830 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 831 | if (fCategory & USAGE_HOSTONLYIFS)
|
|---|
| 832 | {
|
|---|
| 833 | RTStrmPrintf(pStrm,
|
|---|
| 834 | "%s hostonlyif %s ipconfig <name>\n"
|
|---|
| 835 | " [--dhcp |\n"
|
|---|
| 836 | " --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |\n"
|
|---|
| 837 | " --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]\n"
|
|---|
| 838 | # if !defined(RT_OS_SOLARIS)
|
|---|
| 839 | " create |\n"
|
|---|
| 840 | " remove <name>\n"
|
|---|
| 841 | # endif
|
|---|
| 842 | "\n", SEP);
|
|---|
| 843 | }
|
|---|
| 844 | #endif
|
|---|
| 845 |
|
|---|
| 846 | if (fCategory & USAGE_DHCPSERVER)
|
|---|
| 847 | {
|
|---|
| 848 | RTStrmPrintf(pStrm,
|
|---|
| 849 | "%s dhcpserver %s add|modify --netname <network_name> |\n"
|
|---|
| 850 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 851 | " --ifname <hostonly_if_name>\n"
|
|---|
| 852 | #endif
|
|---|
| 853 | " [--ip <ip_address>\n"
|
|---|
| 854 | " --netmask <network_mask>\n"
|
|---|
| 855 | " --lowerip <lower_ip>\n"
|
|---|
| 856 | " --upperip <upper_ip>]\n"
|
|---|
| 857 | " [--enable | --disable]\n\n"
|
|---|
| 858 | "%s dhcpserver %s remove --netname <network_name> |\n"
|
|---|
| 859 | #if defined(VBOX_WITH_NETFLT)
|
|---|
| 860 | " --ifname <hostonly_if_name>\n"
|
|---|
| 861 | #endif
|
|---|
| 862 | "\n", SEP, SEP);
|
|---|
| 863 | }
|
|---|
| 864 | if (fCategory & USAGE_EXTPACK)
|
|---|
| 865 | {
|
|---|
| 866 | RTStrmPrintf(pStrm,
|
|---|
| 867 | "%s extpack %s install [--replace] <tarball> |\n"
|
|---|
| 868 | " uninstall [--force] <name> |\n"
|
|---|
| 869 | " cleanup\n"
|
|---|
| 870 | "\n", SEP);
|
|---|
| 871 | }
|
|---|
| 872 | }
|
|---|
| 873 |
|
|---|
| 874 | /**
|
|---|
| 875 | * Print a usage synopsis and the syntax error message.
|
|---|
| 876 | * @returns RTEXITCODE_SYNTAX.
|
|---|
| 877 | */
|
|---|
| 878 | RTEXITCODE errorSyntax(USAGECATEGORY fCategory, const char *pszFormat, ...)
|
|---|
| 879 | {
|
|---|
| 880 | va_list args;
|
|---|
| 881 | showLogo(g_pStdErr); // show logo even if suppressed
|
|---|
| 882 | #ifndef VBOX_ONLY_DOCS
|
|---|
| 883 | if (g_fInternalMode)
|
|---|
| 884 | printUsageInternal(fCategory, g_pStdErr);
|
|---|
| 885 | else
|
|---|
| 886 | printUsage(fCategory, ~0U, g_pStdErr);
|
|---|
| 887 | #endif /* !VBOX_ONLY_DOCS */
|
|---|
| 888 | va_start(args, pszFormat);
|
|---|
| 889 | RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
|
|---|
| 890 | va_end(args);
|
|---|
| 891 | return RTEXITCODE_SYNTAX;
|
|---|
| 892 | }
|
|---|
| 893 |
|
|---|
| 894 | /**
|
|---|
| 895 | * Print a usage synopsis and the syntax error message.
|
|---|
| 896 | * @returns RTEXITCODE_SYNTAX.
|
|---|
| 897 | */
|
|---|
| 898 | RTEXITCODE errorSyntaxEx(USAGECATEGORY fCategory, uint32_t fSubCategory, const char *pszFormat, ...)
|
|---|
| 899 | {
|
|---|
| 900 | va_list args;
|
|---|
| 901 | showLogo(g_pStdErr); // show logo even if suppressed
|
|---|
| 902 | #ifndef VBOX_ONLY_DOCS
|
|---|
| 903 | if (g_fInternalMode)
|
|---|
| 904 | printUsageInternal(fCategory, g_pStdErr);
|
|---|
| 905 | else
|
|---|
| 906 | printUsage(fCategory, fSubCategory, g_pStdErr);
|
|---|
| 907 | #endif /* !VBOX_ONLY_DOCS */
|
|---|
| 908 | va_start(args, pszFormat);
|
|---|
| 909 | RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args);
|
|---|
| 910 | va_end(args);
|
|---|
| 911 | return RTEXITCODE_SYNTAX;
|
|---|
| 912 | }
|
|---|
| 913 |
|
|---|
| 914 | /**
|
|---|
| 915 | * errorSyntax for RTGetOpt users.
|
|---|
| 916 | *
|
|---|
| 917 | * @returns RTEXITCODE_SYNTAX.
|
|---|
| 918 | *
|
|---|
| 919 | * @param fCategory The usage category of the command.
|
|---|
| 920 | * @param fSubCategory The usage sub-category of the command.
|
|---|
| 921 | * @param rc The RTGetOpt return code.
|
|---|
| 922 | * @param pValueUnion The value union.
|
|---|
| 923 | */
|
|---|
| 924 | RTEXITCODE errorGetOptEx(USAGECATEGORY fCategory, uint32_t fSubCategory, int rc, union RTGETOPTUNION const *pValueUnion)
|
|---|
| 925 | {
|
|---|
| 926 | /*
|
|---|
| 927 | * Check if it is an unhandled standard option.
|
|---|
| 928 | */
|
|---|
| 929 | if (rc == 'V')
|
|---|
| 930 | {
|
|---|
| 931 | RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision());
|
|---|
| 932 | return RTEXITCODE_SUCCESS;
|
|---|
| 933 | }
|
|---|
| 934 |
|
|---|
| 935 | if (rc == 'h')
|
|---|
| 936 | {
|
|---|
| 937 | showLogo(g_pStdErr);
|
|---|
| 938 | #ifndef VBOX_ONLY_DOCS
|
|---|
| 939 | if (g_fInternalMode)
|
|---|
| 940 | printUsageInternal(fCategory, g_pStdOut);
|
|---|
| 941 | else
|
|---|
| 942 | printUsage(fCategory, fSubCategory, g_pStdOut);
|
|---|
| 943 | #endif
|
|---|
| 944 | return RTEXITCODE_SUCCESS;
|
|---|
| 945 | }
|
|---|
| 946 |
|
|---|
| 947 | /*
|
|---|
| 948 | * General failure.
|
|---|
| 949 | */
|
|---|
| 950 | showLogo(g_pStdErr); // show logo even if suppressed
|
|---|
| 951 | #ifndef VBOX_ONLY_DOCS
|
|---|
| 952 | if (g_fInternalMode)
|
|---|
| 953 | printUsageInternal(fCategory, g_pStdErr);
|
|---|
| 954 | else
|
|---|
| 955 | printUsage(fCategory, fSubCategory, g_pStdErr);
|
|---|
| 956 | #endif /* !VBOX_ONLY_DOCS */
|
|---|
| 957 |
|
|---|
| 958 | if (rc == VINF_GETOPT_NOT_OPTION)
|
|---|
| 959 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz);
|
|---|
| 960 | if (rc > 0)
|
|---|
| 961 | {
|
|---|
| 962 | if (RT_C_IS_PRINT(rc))
|
|---|
| 963 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc);
|
|---|
| 964 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc);
|
|---|
| 965 | }
|
|---|
| 966 | if (rc == VERR_GETOPT_UNKNOWN_OPTION)
|
|---|
| 967 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz);
|
|---|
| 968 | if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT)
|
|---|
| 969 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz);
|
|---|
| 970 | if (pValueUnion->pDef)
|
|---|
| 971 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc);
|
|---|
| 972 | return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc);
|
|---|
| 973 | }
|
|---|
| 974 |
|
|---|
| 975 | /**
|
|---|
| 976 | * errorSyntax for RTGetOpt users.
|
|---|
| 977 | *
|
|---|
| 978 | * @returns RTEXITCODE_SYNTAX.
|
|---|
| 979 | *
|
|---|
| 980 | * @param fUsageCategory The usage category of the command.
|
|---|
| 981 | * @param rc The RTGetOpt return code.
|
|---|
| 982 | * @param pValueUnion The value union.
|
|---|
| 983 | */
|
|---|
| 984 | RTEXITCODE errorGetOpt(USAGECATEGORY fCategory, int rc, union RTGETOPTUNION const *pValueUnion)
|
|---|
| 985 | {
|
|---|
| 986 | return errorGetOptEx(fCategory, ~0U, rc, pValueUnion);
|
|---|
| 987 | }
|
|---|
| 988 |
|
|---|
| 989 | /**
|
|---|
| 990 | * Print an error message without the syntax stuff.
|
|---|
| 991 | *
|
|---|
| 992 | * @returns RTEXITCODE_SYNTAX.
|
|---|
| 993 | */
|
|---|
| 994 | RTEXITCODE errorArgument(const char *pszFormat, ...)
|
|---|
| 995 | {
|
|---|
| 996 | va_list args;
|
|---|
| 997 | va_start(args, pszFormat);
|
|---|
| 998 | RTMsgErrorV(pszFormat, args);
|
|---|
| 999 | va_end(args);
|
|---|
| 1000 | return RTEXITCODE_SYNTAX;
|
|---|
| 1001 | }
|
|---|
