/* $Id: VBoxManageHelp.cpp 48630 2013-09-23 10:42:42Z vboxsync $ */ /** @file * VBoxManage - help and other message output. */ /* * Copyright (C) 2006-2013 Oracle Corporation * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. */ /******************************************************************************* * Header Files * *******************************************************************************/ #include #include #include #include #include #include #include "VBoxManage.h" void showLogo(PRTSTREAM pStrm) { static bool s_fShown; /* show only once */ if (!s_fShown) { RTStrmPrintf(pStrm, VBOX_PRODUCT " Command Line Management Interface Version " VBOX_VERSION_STRING "\n" "(C) 2005-" VBOX_C_YEAR " " VBOX_VENDOR "\n" "All rights reserved.\n" "\n"); s_fShown = true; } } void printUsage(USAGECATEGORY u64Cmd, PRTSTREAM pStrm) { bool fDumpOpts = false; #ifdef RT_OS_LINUX bool fLinux = true; #else bool fLinux = false; #endif #ifdef RT_OS_WINDOWS bool fWin = true; #else bool fWin = false; #endif #ifdef RT_OS_SOLARIS bool fSolaris = true; #else bool fSolaris = false; #endif #ifdef RT_OS_FREEBSD bool fFreeBSD = true; #else bool fFreeBSD = false; #endif #ifdef RT_OS_DARWIN bool fDarwin = true; #else bool fDarwin = false; #endif #ifdef VBOX_WITH_VBOXSDL bool fVBoxSDL = true; #else bool fVBoxSDL = false; #endif if (u64Cmd == USAGE_DUMPOPTS) { fDumpOpts = true; fLinux = true; fWin = true; fSolaris = true; fFreeBSD = true; fDarwin = true; fVBoxSDL = true; u64Cmd = USAGE_ALL; } RTStrmPrintf(pStrm, "Usage:\n" "\n"); if (u64Cmd == USAGE_ALL) RTStrmPrintf(pStrm, " VBoxManage [] \n" " \n \n" "General Options:\n \n" " [-v|--version] print version number and exit\n" " [-q|--nologo] suppress the logo\n" " [--settingspw ] provide the settings password\n" " [--settingspwfile ] provide a file containing the settings password\n" " \n \n" "Commands:\n \n"); const char *pcszSep1 = " "; const char *pcszSep2 = " "; if (u64Cmd != USAGE_ALL) { pcszSep1 = "VBoxManage"; pcszSep2 = ""; } #define SEP pcszSep1, pcszSep2 if (u64Cmd & USAGE_LIST) RTStrmPrintf(pStrm, "%s list [--long|-l]%s vms|runningvms|ostypes|hostdvds|hostfloppies|\n" #if defined(VBOX_WITH_NETFLT) " intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|\n" #else " intnets|bridgedifs|natnets|dhcpservers|hostinfo|\n" #endif " hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|\n" " usbhost|usbfilters|systemproperties|extpacks|\n" " groups|webcams\n" "\n", SEP); if (u64Cmd & USAGE_SHOWVMINFO) RTStrmPrintf(pStrm, "%s showvminfo %s [--details]\n" " [--machinereadable]\n" "%s showvminfo %s --log \n" "\n", SEP, SEP); if (u64Cmd & USAGE_REGISTERVM) RTStrmPrintf(pStrm, "%s registervm %s \n" "\n", SEP); if (u64Cmd & USAGE_UNREGISTERVM) RTStrmPrintf(pStrm, "%s unregistervm %s [--delete]\n" "\n", SEP); if (u64Cmd & USAGE_CREATEVM) RTStrmPrintf(pStrm, "%s createvm %s --name \n" " [--groups , ...]\n" " [--ostype ]\n" " [--register]\n" " [--basefolder ]\n" " [--uuid ]\n" "\n", SEP); if (u64Cmd & USAGE_MODIFYVM) { RTStrmPrintf(pStrm, "%s modifyvm %s \n" " [--name ]\n" " [--groups , ...]\n" " [--ostype ]\n" " [--iconfile ]\n" " [--memory ]\n" " [--pagefusion on|off]\n" " [--vram ]\n" " [--acpi on|off]\n" #ifdef VBOX_WITH_PCI_PASSTHROUGH " [--pciattach 03:04.0]\n" " [--pciattach 03:04.0@02:01.0]\n" " [--pcidetach 03:04.0]\n" #endif " [--ioapic on|off]\n" " [--hpet on|off]\n" " [--hwvirtex on|off]\n" " [--nestedpaging on|off]\n" " [--largepages on|off]\n" " [--vtxvpid on|off]\n" " [--vtxux on|off]\n" " [--pae on|off]\n" " [--longmode on|off]\n" " [--synthcpu on|off]\n" " [--cpuidset ]\n" " [--cpuidremove ]\n" " [--cpuidremoveall]\n" " [--hardwareuuid ]\n" " [--cpus ]\n" " [--cpuhotplug on|off]\n" " [--plugcpu ]\n" " [--unplugcpu ]\n" " [--cpuexecutioncap <1-100>]\n" " [--rtcuseutc on|off]\n" " [--graphicscontroller none|vboxvga]\n" " [--monitorcount ]\n" " [--accelerate3d on|off]\n" #ifdef VBOX_WITH_VIDEOHWACCEL " [--accelerate2dvideo on|off]\n" #endif " [--firmware bios|efi|efi32|efi64]\n" " [--chipset ich9|piix3]\n" " [--bioslogofadein on|off]\n" " [--bioslogofadeout on|off]\n" " [--bioslogodisplaytime ]\n" " [--bioslogoimagepath ]\n" " [--biosbootmenu disabled|menuonly|messageandmenu]\n" " [--biossystemtimeoffset ]\n" " [--biospxedebug on|off]\n" " [--boot<1-4> none|floppy|dvd|disk|net>]\n" " [--nic<1-N> none|null|nat|bridged|intnet" #if defined(VBOX_WITH_NETFLT) "|hostonly" #endif "|\n" " generic|natnetwork" "]\n" " [--nictype<1-N> Am79C970A|Am79C973" #ifdef VBOX_WITH_E1000 "|\n 82540EM|82543GC|82545EM" #endif #ifdef VBOX_WITH_VIRTIO "|\n virtio" #endif /* VBOX_WITH_VIRTIO */ "]\n" " [--cableconnected<1-N> on|off]\n" " [--nictrace<1-N> on|off]\n" " [--nictracefile<1-N> ]\n" " [--nicproperty<1-N> name=[value]]\n" " [--nicspeed<1-N> ]\n" " [--nicbootprio<1-N> ]\n" " [--nicpromisc<1-N> deny|allow-vms|allow-all]\n" " [--nicbandwidthgroup<1-N> none|]\n" " [--bridgeadapter<1-N> none|]\n" #if defined(VBOX_WITH_NETFLT) " [--hostonlyadapter<1-N> none|]\n" #endif " [--intnet<1-N> ]\n" " [--nat-network<1-N> ]\n" " [--nicgenericdrv<1-N> \n" " [--natnet<1-N> |default]\n" " [--natsettings<1-N> [],[],\n" " [],[],\n" " []]\n" " [--natpf<1-N> [],tcp|udp,[],\n" " ,[],]\n" " [--natpf<1-N> delete ]\n" " [--nattftpprefix<1-N> ]\n" " [--nattftpfile<1-N> ]\n" " [--nattftpserver<1-N> ]\n" " [--natbindip<1-N> \n" " [--natdnspassdomain<1-N> on|off]\n" " [--natdnsproxy<1-N> on|off]\n" " [--natdnshostresolver<1-N> on|off]\n" " [--nataliasmode<1-N> default|[log],[proxyonly],\n" " [sameports]]\n" " [--macaddress<1-N> auto|]\n" " [--mouse ps2|usb|usbtablet|usbmultitouch]\n" " [--keyboard ps2|usb\n" " [--uart<1-N> off| ]\n" " [--uartmode<1-N> disconnected|\n" " server |\n" " client |\n" " file |\n" " ]\n" #if defined(RT_OS_LINUX) || defined(RT_OS_WINDOWS) " [--lpt<1-N> off| ]\n" " [--lptmode<1-N> ]\n" #endif " [--guestmemoryballoon ]\n" " [--audio none|null", SEP); if (fWin) { #ifdef VBOX_WITH_WINMM RTStrmPrintf(pStrm, "|winmm|dsound"); #else RTStrmPrintf(pStrm, "|dsound"); #endif } if (fSolaris) { RTStrmPrintf(pStrm, "|solaudio" #ifdef VBOX_WITH_SOLARIS_OSS "|oss" #endif ); } if (fLinux) { RTStrmPrintf(pStrm, "|oss" #ifdef VBOX_WITH_ALSA "|alsa" #endif #ifdef VBOX_WITH_PULSE "|pulse" #endif ); } if (fFreeBSD) { /* Get the line break sorted when dumping all option variants. */ if (fDumpOpts) { RTStrmPrintf(pStrm, "|\n" " oss"); } else RTStrmPrintf(pStrm, "|oss"); #ifdef VBOX_WITH_PULSE RTStrmPrintf(pStrm, "|pulse"); #endif } if (fDarwin) { RTStrmPrintf(pStrm, "|coreaudio"); } RTStrmPrintf(pStrm, "]\n"); RTStrmPrintf(pStrm, " [--audiocontroller ac97|hda|sb16]\n" " [--clipboard disabled|hosttoguest|guesttohost|\n" " bidirectional]\n" " [--draganddrop disabled|hosttoguest\n"); RTStrmPrintf(pStrm, " [--vrde on|off]\n" " [--vrdeextpack default|\n" " [--vrdeproperty ]\n" " [--vrdeport ]\n" " [--vrdeaddress ]\n" " [--vrdeauthtype null|external|guest]\n" " [--vrdeauthlibrary default|\n" " [--vrdemulticon on|off]\n" " [--vrdereusecon on|off]\n" " [--vrdevideochannel on|off]\n" " [--vrdevideochannelquality ]\n"); RTStrmPrintf(pStrm, " [--usb on|off]\n" " [--usbehci on|off]\n" " [--snapshotfolder default|]\n" " [--teleporter on|off]\n" " [--teleporterport ]\n" " [--teleporteraddress \n" " [--teleporterpassword ]\n" " [--teleporterpasswordfile |stdin]\n" " [--tracing-enabled on|off]\n" " [--tracing-config ]\n" " [--tracing-allow-vm-access on|off]\n" #if 0 " [--iocache on|off]\n" " [--iocachesize ]\n" #endif #if 0 " [--faulttolerance master|standby]\n" " [--faulttoleranceaddress ]\n" " [--faulttoleranceport ]\n" " [--faulttolerancesyncinterval ]\n" " [--faulttolerancepassword ]\n" #endif #ifdef VBOX_WITH_USB_CARDREADER " [--usbcardreader on|off]\n" #endif " [--autostart-enabled on|off]\n" " [--autostart-delay ]\n" #if 0 /* Disabled until the feature is implemented. */ " [--autostop-type disabled|savestate|poweroff|\n" " acpishutdown]\n" #endif #ifdef VBOX_WITH_VPX " [--vcpenabled on|off]\n" " [--vcpscreens [],...\n" " [--vcpfile ]\n" " [--vcpwidth ]\n" " [--vcpheight ]\n" " [--vcprate ]\n" " [--vcpfps ]\n" #endif " [--defaultfrontend default|\n" " [--snapshot |]\n" " [--mode machine|machineandchildren|all]\n" " [--options link|keepallmacs|keepnatmacs|\n" " keepdisknames]\n" " [--name ]\n" " [--groups , ...]\n" " [--basefolder ]\n" " [--uuid ]\n" " [--register]\n" "\n", SEP); if (u64Cmd & USAGE_IMPORTAPPLIANCE) RTStrmPrintf(pStrm, "%s import %s \n" " [--dry-run|-n]\n" " [--options keepallmacs|keepnatmacs]\n" " [more options]\n" " (run with -n to have options displayed\n" " for a particular OVF)\n\n", SEP); if (u64Cmd & USAGE_EXPORTAPPLIANCE) RTStrmPrintf(pStrm, "%s export %s --output|-o .\n" " [--legacy09|--ovf09|--ovf10|--ovf20]\n" " [--manifest]\n" " [--vsys ]\n" " [--product ]\n" " [--producturl ]\n" " [--vendor ]\n" " [--vendorurl ]\n" " [--version ]\n" " [--description ]\n" " [--eula ]\n" " [--eulafile ]\n" "\n", SEP); if (u64Cmd & USAGE_STARTVM) { RTStrmPrintf(pStrm, "%s startvm %s ...\n" " [--type gui", SEP); if (fVBoxSDL) RTStrmPrintf(pStrm, "|sdl"); RTStrmPrintf(pStrm, "|headless]\n"); RTStrmPrintf(pStrm, "\n"); } if (u64Cmd & USAGE_CONTROLVM) { RTStrmPrintf(pStrm, "%s controlvm %s \n" " pause|resume|reset|poweroff|savestate|\n" " acpipowerbutton|acpisleepbutton|\n" " keyboardputscancode [ ...]|\n" " setlinkstate<1-N> on|off |\n" #if defined(VBOX_WITH_NETFLT) " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n" " natnetwork [] |\n" #else /* !VBOX_WITH_NETFLT */ " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n" " [] |\n" #endif /* !VBOX_WITH_NETFLT */ " nictrace<1-N> on|off |\n" " nictracefile<1-N> |\n" " nicproperty<1-N> name=[value] |\n" " nicpromisc<1-N> deny|allow-vms|allow-all |\n" " natpf<1-N> [],tcp|udp,[],\n" " ,[], |\n" " natpf<1-N> delete |\n" " guestmemoryballoon |\n" " usbattach |
|\n" " usbdetach |
|\n" " clipboard disabled|hosttoguest|guesttohost|\n" " bidirectional |\n" " draganddrop disabled|hosttoguest |\n" " vrde on|off |\n" " vrdeport |\n" " vrdeproperty |\n" " vrdevideochannelquality |\n" " setvideomodehint \n" " [[] [ |\n" " [ ]]] |\n" " screenshotpng [display] |\n" " vcpenabled on|off |\n" " vcpscreens all|none|,[...] |\n" " setcredentials \n" " --passwordfile | \n" " \n" " [--allowlocallogon ] |\n" " teleport --host --port \n" " [--maxdowntime ]\n" " [--passwordfile |\n" " --password ] |\n" " plugcpu |\n" " unplugcpu |\n" " cpuexecutioncap <1-100>\n" " webcam attach [path [settings]] | detach [path] | list]\n" "\n", SEP); } if (u64Cmd & USAGE_DISCARDSTATE) RTStrmPrintf(pStrm, "%s discardstate %s \n" "\n", SEP); if (u64Cmd & USAGE_ADOPTSTATE) RTStrmPrintf(pStrm, "%s adoptstate %s \n" "\n", SEP); if (u64Cmd & USAGE_SNAPSHOT) RTStrmPrintf(pStrm, "%s snapshot %s \n" " take [--description ] [--live] |\n" " delete |\n" " restore |\n" " restorecurrent |\n" " edit |--current\n" " [--name ]\n" " [--description ] |\n" " list [--details|--machinereadable]\n" " showvminfo \n" "\n", SEP); if (u64Cmd & USAGE_CLOSEMEDIUM) RTStrmPrintf(pStrm, "%s closemedium %s disk|dvd|floppy \n" " [--delete]\n" "\n", SEP); if (u64Cmd & USAGE_STORAGEATTACH) RTStrmPrintf(pStrm, "%s storageattach %s \n" " --storagectl \n" " [--port ]\n" " [--device ]\n" " [--type dvddrive|hdd|fdd]\n" " [--medium none|emptydrive|additions|\n" " |host:|iscsi]\n" " [--mtype normal|writethrough|immutable|shareable|\n" " readonly|multiattach]\n" " [--comment ]\n" " [--setuuid ]\n" " [--setparentuuid ]\n" " [--passthrough on|off]\n" " [--tempeject on|off]\n" " [--nonrotational on|off]\n" " [--discard on|off]\n" " [--bandwidthgroup ]\n" " [--forceunmount]\n" " [--server |]\n" " [--target ]\n" " [--tport ]\n" " [--lun ]\n" " [--encodedlun ]\n" " [--username ]\n" " [--password ]\n" " [--initiator ]\n" " [--intnet]\n" "\n", SEP); if (u64Cmd & USAGE_STORAGECONTROLLER) RTStrmPrintf(pStrm, "%s storagectl %s \n" " --name \n" " [--add ide|sata|scsi|floppy|sas]\n" " [--controller LSILogic|LSILogicSAS|BusLogic|\n" " IntelAHCI|PIIX3|PIIX4|ICH6|I82078]\n" " [--sataportcount <1-30>]\n" " [--hostiocache on|off]\n" " [--bootable on|off]\n" " [--remove]\n" "\n", SEP); if (u64Cmd & USAGE_BANDWIDTHCONTROL) RTStrmPrintf(pStrm, "%s bandwidthctl %s \n" " add --type disk|network\n" " --limit [k|m|g|K|M|G] |\n" " set \n" " --limit [k|m|g|K|M|G] |\n" " remove |\n" " list [--machinereadable]\n" " (limit units: k=kilobit, m=megabit, g=gigabit,\n" " K=kilobyte, M=megabyte, G=gigabyte)\n" "\n", SEP); if (u64Cmd & USAGE_SHOWHDINFO) RTStrmPrintf(pStrm, "%s showhdinfo %s \n" "\n", SEP); if (u64Cmd & USAGE_CREATEHD) RTStrmPrintf(pStrm, "%s createhd %s --filename \n" " [--size |--sizebyte ]\n" " [--diffparent |\n" " [--format VDI|VMDK|VHD] (default: VDI)\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" "\n", SEP); if (u64Cmd & USAGE_MODIFYHD) RTStrmPrintf(pStrm, "%s modifyhd %s \n" " [--type normal|writethrough|immutable|shareable|\n" " readonly|multiattach]\n" " [--autoreset on|off]\n" " [--property ]\n" " [--compact]\n" " [--resize |--resizebyte ]\n" "\n", SEP); if (u64Cmd & USAGE_CLONEHD) RTStrmPrintf(pStrm, "%s clonehd %s \n" " [--format VDI|VMDK|VHD|RAW|]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" " [--existing]\n" "\n", SEP); if (u64Cmd & USAGE_CONVERTFROMRAW) RTStrmPrintf(pStrm, "%s convertfromraw %s \n" " [--format VDI|VMDK|VHD]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" " [--uuid ]\n" "%s convertfromraw %s stdin \n" " [--format VDI|VMDK|VHD]\n" " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" " [--uuid ]\n" "\n", SEP, SEP); if (u64Cmd & USAGE_GETEXTRADATA) RTStrmPrintf(pStrm, "%s getextradata %s global|\n" " |enumerate\n" "\n", SEP); if (u64Cmd & USAGE_SETEXTRADATA) RTStrmPrintf(pStrm, "%s setextradata %s global|\n" " \n" " [] (no value deletes key)\n" "\n", SEP); if (u64Cmd & USAGE_SETPROPERTY) RTStrmPrintf(pStrm, "%s setproperty %s machinefolder default| |\n" " hwvirtexclusive on|off |\n" " vrdeauthlibrary default| |\n" " websrvauthlibrary default|null| |\n" " vrdeextpack null| |\n" " autostartdbpath null| |\n" " loghistorycount \n" " defaultfrontend default|\n" "\n", SEP); if (u64Cmd & USAGE_USBFILTER_ADD) RTStrmPrintf(pStrm, "%s usbfilter %s add \n" " --target |global\n" " --name \n" " --action ignore|hold (global filters only)\n" " [--active yes|no] (yes)\n" " [--vendorid ] (null)\n" " [--productid ] (null)\n" " [--revision ] (null)\n" " [--manufacturer ] (null)\n" " [--product ] (null)\n" " [--remote yes|no] (null, VM filters only)\n" " [--serialnumber ] (null)\n" " [--maskedinterfaces ]\n" "\n", SEP); if (u64Cmd & USAGE_USBFILTER_MODIFY) RTStrmPrintf(pStrm, "%s usbfilter %s modify \n" " --target |global\n" " [--name ]\n" " [--action ignore|hold] (global filters only)\n" " [--active yes|no]\n" " [--vendorid |\"\"]\n" " [--productid |\"\"]\n" " [--revision |\"\"]\n" " [--manufacturer |\"\"]\n" " [--product |\"\"]\n" " [--remote yes|no] (null, VM filters only)\n" " [--serialnumber |\"\"]\n" " [--maskedinterfaces ]\n" "\n", SEP); if (u64Cmd & USAGE_USBFILTER_REMOVE) RTStrmPrintf(pStrm, "%s usbfilter %s remove \n" " --target |global\n" "\n", SEP); if (u64Cmd & USAGE_SHAREDFOLDER_ADD) RTStrmPrintf(pStrm, "%s sharedfolder %s add \n" " --name --hostpath \n" " [--transient] [--readonly] [--automount]\n" "\n", SEP); if (u64Cmd & USAGE_SHAREDFOLDER_REMOVE) RTStrmPrintf(pStrm, "%s sharedfolder %s remove \n" " --name [--transient]\n" "\n", SEP); #ifdef VBOX_WITH_GUEST_PROPS if (u64Cmd & USAGE_GUESTPROPERTY) usageGuestProperty(pStrm, SEP); #endif /* VBOX_WITH_GUEST_PROPS defined */ #ifdef VBOX_WITH_GUEST_CONTROL if (u64Cmd & USAGE_GUESTCONTROL) usageGuestControl(pStrm, SEP); #endif /* VBOX_WITH_GUEST_CONTROL defined */ if (u64Cmd & USAGE_DEBUGVM) { RTStrmPrintf(pStrm, "%s debugvm %s \n" " dumpguestcore --filename |\n" " info [args] |\n" " injectnmi |\n" " log [--release|--debug] ...|\n" " logdest [--release|--debug] ...|\n" " logflags [--release|--debug] ...|\n" " osdetect |\n" " osinfo |\n" " getregisters [--cpu ] |all ... |\n" " setregisters [--cpu ] = ... |\n" " show [--human-readable|--sh-export|--sh-eval|\n" " --cmd-set] \n" " \n" " [[opt] what ...] |\n" " statistics [--reset] [--pattern ]\n" " [--descriptions]\n" "\n", SEP); } if (u64Cmd & USAGE_METRICS) RTStrmPrintf(pStrm, "%s metrics %s list [*|host| []]\n" " (comma-separated)\n\n" "%s metrics %s setup\n" " [--period ] (default: 1)\n" " [--samples ] (default: 1)\n" " [--list]\n" " [*|host| []]\n\n" "%s metrics %s query [*|host| []]\n\n" "%s metrics %s enable\n" " [--list]\n" " [*|host| []]\n\n" "%s metrics %s disable\n" " [--list]\n" " [*|host| []]\n\n" "%s metrics %s collect\n" " [--period ] (default: 1)\n" " [--samples ] (default: 1)\n" " [--list]\n" " [--detach]\n" " [*|host| []]\n" "\n", SEP, SEP, SEP, SEP, SEP, SEP); #if defined(VBOX_WITH_NAT_SERVICE) if (u64Cmd & USAGE_NATNETWORK) { RTStrmPrintf(pStrm, "%s natnetwork %s add --netname \n" " --network ]\n" " [--loopback-4 ]\n" " [--ipv6 on|off]\n" " [--port-forward-6 ]\n" " [--loopback-6 ]\n\n" "%s natnetwork %s remove --netname \n\n" "%s natnetwork %s modify --netname \n" " [--network ]\n" " [--loopback-4 ]\n" " [--ipv6 on|off]\n" " [--port-forward-6 ]\n" " [--loopback-6 ]\n\n" "%s natnetwork %s start --netname \n\n" "%s natnetwork %s stop --netname \n" "\n", SEP, SEP, SEP, SEP, SEP); } #endif #if defined(VBOX_WITH_NETFLT) if (u64Cmd & USAGE_HOSTONLYIFS) { RTStrmPrintf(pStrm, "%s hostonlyif %s ipconfig \n" " [--dhcp |\n" " --ip [--netmask (def: 255.255.255.0)] |\n" " --ipv6 [--netmasklengthv6 (def: 64)]]\n" # if !defined(RT_OS_SOLARIS) " create |\n" " remove \n" # endif "\n", SEP); } #endif if (u64Cmd & USAGE_DHCPSERVER) { RTStrmPrintf(pStrm, "%s dhcpserver %s add|modify --netname |\n" #if defined(VBOX_WITH_NETFLT) " --ifname \n" #endif " [--ip \n" " --netmask \n" " --lowerip \n" " --upperip ]\n" " [--enable | --disable]\n\n" "%s dhcpserver %s remove --netname |\n" #if defined(VBOX_WITH_NETFLT) " --ifname \n" #endif "\n", SEP, SEP); } if (u64Cmd & USAGE_EXTPACK) { RTStrmPrintf(pStrm, "%s extpack %s install [--replace] |\n" " uninstall [--force] |\n" " cleanup\n" "\n", SEP); } } /** * Print a usage synopsis and the syntax error message. * @returns RTEXITCODE_SYNTAX. */ RTEXITCODE errorSyntax(USAGECATEGORY u64Cmd, const char *pszFormat, ...) { va_list args; showLogo(g_pStdErr); // show logo even if suppressed #ifndef VBOX_ONLY_DOCS if (g_fInternalMode) printUsageInternal(u64Cmd, g_pStdErr); else printUsage(u64Cmd, g_pStdErr); #endif /* !VBOX_ONLY_DOCS */ va_start(args, pszFormat); RTStrmPrintf(g_pStdErr, "\nSyntax error: %N\n", pszFormat, &args); va_end(args); return RTEXITCODE_SYNTAX; } /** * errorSyntax for RTGetOpt users. * * @returns RTEXITCODE_SYNTAX. * * @param fUsageCategory The usage category of the command. * @param rc The RTGetOpt return code. * @param pValueUnion The value union. */ RTEXITCODE errorGetOpt(USAGECATEGORY fUsageCategory, int rc, union RTGETOPTUNION const *pValueUnion) { /* * Check if it is an unhandled standard option. */ if (rc == 'V') { RTPrintf("%sr%d\n", VBOX_VERSION_STRING, RTBldCfgRevision()); return RTEXITCODE_SUCCESS; } if (rc == 'h') { showLogo(g_pStdErr); #ifndef VBOX_ONLY_DOCS if (g_fInternalMode) printUsageInternal(fUsageCategory, g_pStdOut); else printUsage(fUsageCategory, g_pStdOut); #endif return RTEXITCODE_SUCCESS; } /* * General failure. */ showLogo(g_pStdErr); // show logo even if suppressed #ifndef VBOX_ONLY_DOCS if (g_fInternalMode) printUsageInternal(fUsageCategory, g_pStdErr); else printUsage(fUsageCategory, g_pStdErr); #endif /* !VBOX_ONLY_DOCS */ if (rc == VINF_GETOPT_NOT_OPTION) return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid parameter '%s'", pValueUnion->psz); if (rc > 0) { if (RT_C_IS_PRINT(rc)) return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option -%c", rc); return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid option case %i", rc); } if (rc == VERR_GETOPT_UNKNOWN_OPTION) return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Unknown option: %s", pValueUnion->psz); if (rc == VERR_GETOPT_INVALID_ARGUMENT_FORMAT) return RTMsgErrorExit(RTEXITCODE_SYNTAX, "Invalid argument format: %s", pValueUnion->psz); if (pValueUnion->pDef) return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%s: %Rrs", pValueUnion->pDef->pszLong, rc); return RTMsgErrorExit(RTEXITCODE_SYNTAX, "%Rrs", rc); } /** * Print an error message without the syntax stuff. * * @returns RTEXITCODE_SYNTAX. */ RTEXITCODE errorArgument(const char *pszFormat, ...) { va_list args; va_start(args, pszFormat); RTMsgErrorV(pszFormat, args); va_end(args); return RTEXITCODE_SYNTAX; }