Changeset 92432 in vbox for trunk/src/VBox/Frontends
- Timestamp:
- Nov 15, 2021 3:58:43 PM (3 years ago)
- Location:
- trunk/src/VBox/Frontends/VBoxManage
- Files:
-
- 3 edited
-
VBoxManageGuestCtrl.cpp (modified) (2 diffs)
-
VBoxManageGuestProp.cpp (modified) (1 diff)
-
VBoxManageHelp.cpp (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp
r92403 r92432 235 235 if (~fAnonSubCmds & fSubcommandScope) 236 236 RTStrmPrintf(pStrm, 237 GuestCtrl::tr("%s guestcontrol %s <uuid|vmname> [--verbose|-v] [--quiet|-q]\n"238 239 " [--passwordfile <file> | --password <password>]\n%s"),237 "%s guestcontrol %s <uuid|vmname> [--verbose|-v] [--quiet|-q]\n" 238 " [--user[name] <name>] [--domain <domain>]\n" 239 " [--passwordfile <file> | --password <password>]\n%s", 240 240 pcszSep1, pcszSep2, (fSubcommandScope & RTMSGREFENTRYSTR_SCOPE_MASK) == RTMSGREFENTRYSTR_SCOPE_GLOBAL ? "\n" : ""); 241 241 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_RUN) 242 242 RTStrmPrintf(pStrm, 243 GuestCtrl::tr(" run [common-options]\n"244 245 246 247 248 249 250 251 "\n"));243 " run [common-options]\n" 244 " [--exe <path to executable>] [--timeout <msec>]\n" 245 " [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]\n" 246 " [--ignore-operhaned-processes] [--profile]\n" 247 " [--no-wait-stdout|--wait-stdout]\n" 248 " [--no-wait-stderr|--wait-stderr]\n" 249 " [--dos2unix] [--unix2dos]\n" 250 " -- <program/arg0> [argument1] ... [argumentN]]\n" 251 "\n"); 252 252 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_START) 253 253 RTStrmPrintf(pStrm, 254 GuestCtrl::tr(" start [common-options]\n"255 256 257 258 259 "\n"));254 " start [common-options]\n" 255 " [--exe <path to executable>] [--timeout <msec>]\n" 256 " [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]\n" 257 " [--ignore-operhaned-processes] [--profile]\n" 258 " -- <program/arg0> [argument1] ... [argumentN]]\n" 259 "\n"); 260 260 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_COPYFROM) 261 261 RTStrmPrintf(pStrm, 262 GuestCtrl::tr(" copyfrom [common-options]\n"263 264 265 266 267 268 269 270 "\n"));262 " copyfrom [common-options]\n" 263 " [--follow] [-R|--recursive]\n" 264 " <guest-src0> [guest-src1 [...]] <host-dst>\n" 265 "\n" 266 " copyfrom [common-options]\n" 267 " [--follow] [-R|--recursive]\n" 268 " [--target-directory <host-dst-dir>]\n" 269 " <guest-src0> [guest-src1 [...]]\n" 270 "\n"); 271 271 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_COPYTO) 272 272 RTStrmPrintf(pStrm, 273 GuestCtrl::tr(" copyto [common-options]\n"274 275 276 277 278 279 280 281 "\n"));273 " copyto [common-options]\n" 274 " [--follow] [-R|--recursive]\n" 275 " <host-src0> [host-src1 [...]] <guest-dst>\n" 276 "\n" 277 " copyto [common-options]\n" 278 " [--follow] [-R|--recursive]\n" 279 " [--target-directory <guest-dst>]\n" 280 " <host-src0> [host-src1 [...]]\n" 281 "\n"); 282 282 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_MKDIR) 283 283 RTStrmPrintf(pStrm, 284 GuestCtrl::tr(" mkdir|createdir[ectory] [common-options]\n"285 286 287 "\n"));284 " mkdir|createdir[ectory] [common-options]\n" 285 " [--parents] [--mode <mode>]\n" 286 " <guest directory> [...]\n" 287 "\n"); 288 288 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_RMDIR) 289 289 RTStrmPrintf(pStrm, 290 GuestCtrl::tr(" rmdir|removedir[ectory] [common-options]\n"291 292 293 "\n"));290 " rmdir|removedir[ectory] [common-options]\n" 291 " [-R|--recursive]\n" 292 " <guest directory> [...]\n" 293 "\n"); 294 294 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_RM) 295 295 RTStrmPrintf(pStrm, 296 GuestCtrl::tr(" removefile|rm [common-options] [-f|--force]\n"297 298 "\n"));296 " removefile|rm [common-options] [-f|--force]\n" 297 " <guest file> [...]\n" 298 "\n"); 299 299 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_MV) 300 300 RTStrmPrintf(pStrm, 301 GuestCtrl::tr(" mv|move|ren[ame] [common-options]\n"302 303 "\n"));301 " mv|move|ren[ame] [common-options]\n" 302 " <source> [source1 [...]] <dest>\n" 303 "\n"); 304 304 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_MKTEMP) 305 305 RTStrmPrintf(pStrm, 306 GuestCtrl::tr(" mktemp|createtemp[orary] [common-options]\n"307 308 309 "\n"));306 " mktemp|createtemp[orary] [common-options]\n" 307 " [--secure] [--mode <mode>] [--tmpdir <directory>]\n" 308 " <template>\n" 309 "\n"); 310 310 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_STAT) 311 311 RTStrmPrintf(pStrm, 312 GuestCtrl::tr(" stat [common-options]\n"313 314 "\n"));312 " stat [common-options]\n" 313 " <file> [...]\n" 314 "\n"); 315 315 316 316 /* … … 326 326 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_LIST) 327 327 RTStrmPrintf(pStrm, 328 GuestCtrl::tr(" list <all|sessions|processes|files> [common-opts]\n"329 "\n"));328 " list <all|sessions|processes|files> [common-opts]\n" 329 "\n"); 330 330 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_CLOSEPROCESS) 331 331 RTStrmPrintf(pStrm, 332 GuestCtrl::tr(" closeprocess [common-options]\n"333 334 335 336 "\n"));332 " closeprocess [common-options]\n" 333 " < --session-id <ID>\n" 334 " | --session-name <name or pattern>\n" 335 " <PID1> [PID1 [...]]\n" 336 "\n"); 337 337 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_CLOSESESSION) 338 338 RTStrmPrintf(pStrm, 339 GuestCtrl::tr(" closesession [common-options]\n"340 341 342 "\n"));339 " closesession [common-options]\n" 340 " < --all | --session-id <ID>\n" 341 " | --session-name <name or pattern> >\n" 342 "\n"); 343 343 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_UPDATEGA) 344 344 RTStrmPrintf(pStrm, 345 GuestCtrl::tr(" updatega|updateguestadditions|updateadditions\n"346 347 348 349 "\n"));345 " updatega|updateguestadditions|updateadditions\n" 346 " [--source <guest additions .ISO>]\n" 347 " [--wait-start] [common-options]\n" 348 " [-- [<argument1>] ... [<argumentN>]]\n" 349 "\n"); 350 350 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_WATCH) 351 351 RTStrmPrintf(pStrm, 352 GuestCtrl::tr(" watch [--timeout <msec>] [common-options]\n"353 "\n"));352 " watch [--timeout <msec>] [common-options]\n" 353 "\n"); 354 354 if (fSubcommandScope & HELP_SCOPE_GSTCTRL_WAITRUNLEVEL) 355 355 RTStrmPrintf(pStrm, 356 GuestCtrl::tr(" waitrunlevel [--timeout <msec>] [common-options]\n"357 358 "\n"));356 " waitrunlevel [--timeout <msec>] [common-options]\n" 357 " <system|userland|desktop>\n" 358 "\n"); 359 359 } 360 360 } -
trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestProp.cpp
r92372 r92432 56 56 void usageGuestProperty(PRTSTREAM pStrm, const char *pcszSep1, const char *pcszSep2) 57 57 { 58 RTStrmPrintf(pStrm, GuestProp::tr("%s guestproperty %s get <uuid|vmname>\n"59 60 "\n"), pcszSep1, pcszSep2);61 RTStrmPrintf(pStrm, GuestProp::tr("%s guestproperty %s set <uuid|vmname>\n"62 63 "\n"), pcszSep1, pcszSep2);64 RTStrmPrintf(pStrm, GuestProp::tr("%s guestproperty %s delete|unset <uuid|vmname>\n"65 66 "\n"), pcszSep1, pcszSep2);67 RTStrmPrintf(pStrm, GuestProp::tr("%s guestproperty %s enumerate <uuid|vmname>\n"68 69 "\n"), pcszSep1, pcszSep2);70 RTStrmPrintf(pStrm, GuestProp::tr("%s guestproperty %s wait <uuid|vmname> <patterns>\n"71 72 "\n"), pcszSep1, pcszSep2);58 RTStrmPrintf(pStrm, "%s guestproperty %s get <uuid|vmname>\n" 59 " <property> [--verbose]\n" 60 "\n", pcszSep1, pcszSep2); 61 RTStrmPrintf(pStrm, "%s guestproperty %s set <uuid|vmname>\n" 62 " <property> [<value> [--flags <flags>]]\n" 63 "\n", pcszSep1, pcszSep2); 64 RTStrmPrintf(pStrm, "%s guestproperty %s delete|unset <uuid|vmname>\n" 65 " <property>\n" 66 "\n", pcszSep1, pcszSep2); 67 RTStrmPrintf(pStrm, "%s guestproperty %s enumerate <uuid|vmname>\n" 68 " [--patterns <patterns>]\n" 69 "\n", pcszSep1, pcszSep2); 70 RTStrmPrintf(pStrm, "%s guestproperty %s wait <uuid|vmname> <patterns>\n" 71 " [--timeout <msec>] [--fail-on-timeout]\n" 72 "\n", pcszSep1, pcszSep2); 73 73 } 74 74 -
trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp
r92374 r92432 454 454 if (enmCommand == USAGE_S_ALL) 455 455 RTStrmPrintf(pStrm, 456 Help::tr( 457 " VBoxManage [<general option>] <command>\n" 458 "\n" 459 "\n" 460 "General Options:\n" 461 "\n" 462 " [-V|--version] print version number and exit\n" 463 " [--dump-build-type] print build type and exit\n" 464 " [-q|--nologo] suppress the logo\n" 465 " [--settingspw <pw>] provide the settings password\n" 466 " [--settingspwfile <file>] provide a file containing the settings password\n" 467 " [@<response-file>] load arguments from the given response file (bourne style)\n" 468 "\n" 469 "\n" 470 "Commands:\n" 471 "\n")); 456 " VBoxManage [<general option>] <command>\n" 457 "\n" 458 "\n" 459 "General Options:\n" 460 "\n" 461 " [-V|--version] print version number and exit\n" 462 " [--dump-build-type] print build type and exit\n" 463 " [-q|--nologo] suppress the logo\n" 464 " [--settingspw <pw>] provide the settings password\n" 465 " [--settingspwfile <file>] provide a file containing the settings password\n" 466 " [@<response-file>] load arguments from the given response file (bourne style)\n" 467 "\n" 468 "\n" 469 "Commands:\n" 470 "\n"); 472 471 473 472 const char *pcszSep1 = " "; … … 484 483 { 485 484 RTStrmPrintf(pStrm, 486 Help::tr( 487 "%s startvm %s <uuid|vmname>...\n" 488 " [--type gui"), SEP); 485 "%s startvm %s <uuid|vmname>...\n" 486 " [--type gui", SEP); 489 487 if (fVBoxSDL) 490 488 RTStrmPrintf(pStrm, "|sdl"); 491 489 RTStrmPrintf(pStrm, "|headless|separate]\n"); 492 490 RTStrmPrintf(pStrm, 493 Help::tr( 494 " [-E|--putenv <NAME>[=<VALUE>]]\n" 495 "\n")); 491 " [-E|--putenv <NAME>[=<VALUE>]]\n" 492 "\n"); 496 493 } 497 494 … … 499 496 { 500 497 RTStrmPrintf(pStrm, 501 Help::tr( 502 "%s controlvm %s <uuid|vmname>\n" 503 " pause|resume|reset|poweroff|savestate|\n"), SEP); 498 "%s controlvm %s <uuid|vmname>\n" 499 " pause|resume|reset|poweroff|savestate|\n", SEP); 504 500 #ifdef VBOX_WITH_GUEST_CONTROL 505 501 RTStrmPrintf(pStrm, … … 507 503 #endif 508 504 RTStrmPrintf(pStrm, 509 Help::tr( 510 " acpipowerbutton|acpisleepbutton|\n" 511 " keyboardputscancode <hex> [<hex> ...]|\n" 512 " keyboardputstring <string1> [<string2> ...]|\n" 513 " keyboardputfile <filename>|\n" 514 " setlinkstate<1-N> on|off |\n")); 505 " acpipowerbutton|acpisleepbutton|\n" 506 " keyboardputscancode <hex> [<hex> ...]|\n" 507 " keyboardputstring <string1> [<string2> ...]|\n" 508 " keyboardputfile <filename>|\n" 509 " setlinkstate<1-N> on|off |\n"); 515 510 #if defined(VBOX_WITH_NETFLT) 516 511 RTStrmPrintf(pStrm, 517 Help::tr( 518 " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n" 519 " natnetwork [<devicename>] |\n")); 512 " nic<1-N> null|nat|bridged|intnet|hostonly|generic|\n" 513 " natnetwork [<devicename>] |\n"); 520 514 #else /* !VBOX_WITH_NETFLT */ 521 515 RTStrmPrintf(pStrm, 522 Help::tr( 523 " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n" 524 " [<devicename>] |\n")); 516 " nic<1-N> null|nat|bridged|intnet|generic|natnetwork\n" 517 " [<devicename>] |\n"); 525 518 #endif /* !VBOX_WITH_NETFLT */ 526 519 RTStrmPrintf(pStrm, 527 Help::tr( 528 " nictrace<1-N> on|off |\n" 529 " nictracefile<1-N> <filename> |\n" 530 " nicproperty<1-N> name=[value] |\n" 531 " nicpromisc<1-N> deny|allow-vms|allow-all |\n" 532 " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" 533 " <hostport>,[<guestip>],<guestport> |\n" 534 " natpf<1-N> delete <rulename> |\n" 535 " guestmemoryballoon <balloonsize in MB> |\n" 536 " usbattach <uuid>|<address>\n" 537 " [--capturefile <filename>] |\n" 538 " usbdetach <uuid>|<address> |\n" 539 " audioin on|off |\n" 540 " audioout on|off |\n")); 520 " nictrace<1-N> on|off |\n" 521 " nictracefile<1-N> <filename> |\n" 522 " nicproperty<1-N> name=[value] |\n" 523 " nicpromisc<1-N> deny|allow-vms|allow-all |\n" 524 " natpf<1-N> [<rulename>],tcp|udp,[<hostip>],\n" 525 " <hostport>,[<guestip>],<guestport> |\n" 526 " natpf<1-N> delete <rulename> |\n" 527 " guestmemoryballoon <balloonsize in MB> |\n" 528 " usbattach <uuid>|<address>\n" 529 " [--capturefile <filename>] |\n" 530 " usbdetach <uuid>|<address> |\n" 531 " audioin on|off |\n" 532 " audioout on|off |\n"); 541 533 #ifdef VBOX_WITH_SHARED_CLIPBOARD 542 534 RTStrmPrintf(pStrm, 543 544 535 " clipboard mode disabled|hosttoguest|guesttohost|\n" 536 " bidirectional |\n"); 545 537 # ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS 546 538 RTStrmPrintf(pStrm, … … 549 541 #endif 550 542 RTStrmPrintf(pStrm, 551 Help::tr( 552 " draganddrop disabled|hosttoguest|guesttohost|\n" 553 " bidirectional |\n" 554 " vrde on|off |\n" 555 " vrdeport <port> |\n" 556 " vrdeproperty <name=[value]> |\n" 557 " vrdevideochannelquality <percent> |\n" 558 " setvideomodehint <xres> <yres> <bpp>\n" 559 " [[<display>] [<enabled:yes|no> |\n" 560 " [<xorigin> <yorigin>]]] |\n" 561 " setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off\n" 562 " screenshotpng <file> [display] |\n")); 543 " draganddrop disabled|hosttoguest|guesttohost|\n" 544 " bidirectional |\n" 545 " vrde on|off |\n" 546 " vrdeport <port> |\n" 547 " vrdeproperty <name=[value]> |\n" 548 " vrdevideochannelquality <percent> |\n" 549 " setvideomodehint <xres> <yres> <bpp>\n" 550 " [[<display>] [<enabled:yes|no> |\n" 551 " [<xorigin> <yorigin>]]] |\n" 552 " setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off\n" 553 " screenshotpng <file> [display] |\n"); 563 554 #ifdef VBOX_WITH_RECORDING 564 555 RTStrmPrintf(pStrm, 565 Help::tr( 566 " recording on|off |\n" 567 " recording screens all|none|<screen>,[<screen>...] |\n" 568 " recording filename <file> |\n" 569 " recording videores <width>x<height> |\n" 570 " recording videorate <rate> |\n" 571 " recording videofps <fps> |\n" 572 " recording maxtime <s> |\n" 573 " recording maxfilesize <MB> |\n")); 556 " recording on|off |\n" 557 " recording screens all|none|<screen>,[<screen>...] |\n" 558 " recording filename <file> |\n" 559 " recording videores <width>x<height> |\n" 560 " recording videorate <rate> |\n" 561 " recording videofps <fps> |\n" 562 " recording maxtime <s> |\n" 563 " recording maxfilesize <MB> |\n"); 574 564 #endif /* VBOX_WITH_RECORDING */ 575 565 RTStrmPrintf(pStrm, 576 Help::tr( 577 " setcredentials <username>\n" 578 " --passwordfile <file> | <password>\n" 579 " <domain>\n" 580 " [--allowlocallogon <yes|no>] |\n" 581 " teleport --host <name> --port <port>\n" 582 " [--maxdowntime <msec>]\n" 583 " [--passwordfile <file> |\n" 584 " --password <password>] |\n" 585 " plugcpu <id> |\n" 586 " unplugcpu <id> |\n" 587 " cpuexecutioncap <1-100>\n" 588 " webcam <attach [path [settings]]> | <detach [path]> | <list>\n" 589 " addencpassword <id>\n" 590 " <password file>|-\n" 591 " [--removeonsuspend <yes|no>]\n" 592 " removeencpassword <id>\n" 593 " removeallencpasswords\n" 594 " changeuartmode<1-N> disconnected|\n" 595 " server <pipe>|\n" 596 " client <pipe>|\n" 597 " tcpserver <port>|\n" 598 " tcpclient <hostname:port>|\n" 599 " file <file>|\n" 600 " <devicename>\n" 601 " vm-process-priority default|flat|low|normal|high\n" 602 " autostart-enabled on|off\n" 603 " autostart-delay <seconds>\n" 604 "\n")); 566 " setcredentials <username>\n" 567 " --passwordfile <file> | <password>\n" 568 " <domain>\n" 569 " [--allowlocallogon <yes|no>] |\n" 570 " teleport --host <name> --port <port>\n" 571 " [--maxdowntime <msec>]\n" 572 " [--passwordfile <file> |\n" 573 " --password <password>] |\n" 574 " plugcpu <id> |\n" 575 " unplugcpu <id> |\n" 576 " cpuexecutioncap <1-100>\n" 577 " webcam <attach [path [settings]]> | <detach [path]> | <list>\n" 578 " addencpassword <id>\n" 579 " <password file>|-\n" 580 " [--removeonsuspend <yes|no>]\n" 581 " removeencpassword <id>\n" 582 " removeallencpasswords\n" 583 " changeuartmode<1-N> disconnected|\n" 584 " server <pipe>|\n" 585 " client <pipe>|\n" 586 " tcpserver <port>|\n" 587 " tcpclient <hostname:port>|\n" 588 " file <file>|\n" 589 " <devicename>\n" 590 " vm-process-priority default|flat|low|normal|high\n" 591 " autostart-enabled on|off\n" 592 " autostart-delay <seconds>\n" 593 "\n"); 605 594 } 606 595 607 596 if (enmCommand == USAGE_DISCARDSTATE || enmCommand == USAGE_S_ALL) 608 597 RTStrmPrintf(pStrm, 609 Help::tr( 610 "%s discardstate %s <uuid|vmname>\n" 611 "\n"), SEP); 598 "%s discardstate %s <uuid|vmname>\n" 599 "\n", SEP); 612 600 613 601 if (enmCommand == USAGE_ADOPTSTATE || enmCommand == USAGE_S_ALL) 614 602 RTStrmPrintf(pStrm, 615 Help::tr( 616 "%s adoptstate %s <uuid|vmname> <state_file>\n" 617 "\n"), SEP); 603 "%s adoptstate %s <uuid|vmname> <state_file>\n" 604 "\n", SEP); 618 605 619 606 if (enmCommand == USAGE_CLOSEMEDIUM || enmCommand == USAGE_S_ALL) 620 607 RTStrmPrintf(pStrm, 621 Help::tr( 622 "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n" 623 " [--delete]\n" 624 "\n"), SEP); 608 "%s closemedium %s [disk|dvd|floppy] <uuid|filename>\n" 609 " [--delete]\n" 610 "\n", SEP); 625 611 626 612 if (enmCommand == USAGE_STORAGEATTACH || enmCommand == USAGE_S_ALL) 627 613 RTStrmPrintf(pStrm, 628 Help::tr( 629 "%s storageattach %s <uuid|vmname>\n" 630 " --storagectl <name>\n" 631 " [--port <number>]\n" 632 " [--device <number>]\n" 633 " [--type dvddrive|hdd|fdd]\n" 634 " [--medium none|emptydrive|additions|\n" 635 " <uuid|filename>|host:<drive>|iscsi]\n" 636 " [--mtype normal|writethrough|immutable|shareable|\n" 637 " readonly|multiattach]\n" 638 " [--comment <text>]\n" 639 " [--setuuid <uuid>]\n" 640 " [--setparentuuid <uuid>]\n" 641 " [--passthrough on|off]\n" 642 " [--tempeject on|off]\n" 643 " [--nonrotational on|off]\n" 644 " [--discard on|off]\n" 645 " [--hotpluggable on|off]\n" 646 " [--bandwidthgroup <name>]\n" 647 " [--forceunmount]\n" 648 " [--server <name>|<ip>]\n" 649 " [--target <target>]\n" 650 " [--tport <port>]\n" 651 " [--lun <lun>]\n" 652 " [--encodedlun <lun>]\n" 653 " [--username <username>]\n" 654 " [--password <password>]\n" 655 " [--passwordfile <file>]\n" 656 " [--initiator <initiator>]\n" 657 " [--intnet]\n" 658 "\n"), SEP); 614 "%s storageattach %s <uuid|vmname>\n" 615 " --storagectl <name>\n" 616 " [--port <number>]\n" 617 " [--device <number>]\n" 618 " [--type dvddrive|hdd|fdd]\n" 619 " [--medium none|emptydrive|additions|\n" 620 " <uuid|filename>|host:<drive>|iscsi]\n" 621 " [--mtype normal|writethrough|immutable|shareable|\n" 622 " readonly|multiattach]\n" 623 " [--comment <text>]\n" 624 " [--setuuid <uuid>]\n" 625 " [--setparentuuid <uuid>]\n" 626 " [--passthrough on|off]\n" 627 " [--tempeject on|off]\n" 628 " [--nonrotational on|off]\n" 629 " [--discard on|off]\n" 630 " [--hotpluggable on|off]\n" 631 " [--bandwidthgroup <name>]\n" 632 " [--forceunmount]\n" 633 " [--server <name>|<ip>]\n" 634 " [--target <target>]\n" 635 " [--tport <port>]\n" 636 " [--lun <lun>]\n" 637 " [--encodedlun <lun>]\n" 638 " [--username <username>]\n" 639 " [--password <password>]\n" 640 " [--passwordfile <file>]\n" 641 " [--initiator <initiator>]\n" 642 " [--intnet]\n" 643 "\n", SEP); 659 644 660 645 if (enmCommand == USAGE_STORAGECONTROLLER || enmCommand == USAGE_S_ALL) 661 646 RTStrmPrintf(pStrm, 662 Help::tr( 663 "%s storagectl %s <uuid|vmname>\n" 664 " --name <name>\n" 665 " [--add ide|sata|scsi|floppy|sas|usb|pcie|virtio]\n" 666 " [--controller LSILogic|LSILogicSAS|BusLogic|\n" 667 " IntelAHCI|PIIX3|PIIX4|ICH6|I82078|\n" 668 " [ USB|NVMe|VirtIO]\n" 669 " [--portcount <1-n>]\n" 670 " [--hostiocache on|off]\n" 671 " [--bootable on|off]\n" 672 " [--rename <name>]\n" 673 " [--remove]\n" 674 "\n"), SEP); 647 "%s storagectl %s <uuid|vmname>\n" 648 " --name <name>\n" 649 " [--add ide|sata|scsi|floppy|sas|usb|pcie|virtio]\n" 650 " [--controller LSILogic|LSILogicSAS|BusLogic|\n" 651 " IntelAHCI|PIIX3|PIIX4|ICH6|I82078|\n" 652 " [ USB|NVMe|VirtIO]\n" 653 " [--portcount <1-n>]\n" 654 " [--hostiocache on|off]\n" 655 " [--bootable on|off]\n" 656 " [--rename <name>]\n" 657 " [--remove]\n" 658 "\n", SEP); 675 659 676 660 if (enmCommand == USAGE_BANDWIDTHCONTROL || enmCommand == USAGE_S_ALL) 677 661 RTStrmPrintf(pStrm, 678 Help::tr( 679 "%s bandwidthctl %s <uuid|vmname>\n" 680 " add <name> --type disk|network\n" 681 " --limit <megabytes per second>[k|m|g|K|M|G] |\n" 682 " set <name>\n" 683 " --limit <megabytes per second>[k|m|g|K|M|G] |\n" 684 " remove <name> |\n" 685 " list [--machinereadable]\n" 686 " (limit units: k=kilobit, m=megabit, g=gigabit,\n" 687 " K=kilobyte, M=megabyte, G=gigabyte)\n" 688 "\n"), SEP); 662 "%s bandwidthctl %s <uuid|vmname>\n" 663 " add <name> --type disk|network\n" 664 " --limit <megabytes per second>[k|m|g|K|M|G] |\n" 665 " set <name>\n" 666 " --limit <megabytes per second>[k|m|g|K|M|G] |\n" 667 " remove <name> |\n" 668 " list [--machinereadable]\n" 669 " (limit units: k=kilobit, m=megabit, g=gigabit,\n" 670 " K=kilobyte, M=megabyte, G=gigabyte)\n" 671 "\n", SEP); 689 672 690 673 if (enmCommand == USAGE_SHOWMEDIUMINFO || enmCommand == USAGE_S_ALL) 691 674 RTStrmPrintf(pStrm, 692 Help::tr( 693 "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n" 694 "\n"), SEP); 675 "%s showmediuminfo %s [disk|dvd|floppy] <uuid|filename>\n" 676 "\n", SEP); 695 677 696 678 if (enmCommand == USAGE_CREATEMEDIUM || enmCommand == USAGE_S_ALL) 697 679 RTStrmPrintf(pStrm, 698 Help::tr( 699 "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n" 700 " [--size <megabytes>|--sizebyte <bytes>]\n" 701 " [--diffparent <uuid>|<filename>]\n" 702 " [--format VDI|VMDK|VHD] (default: VDI)]\n" 703 " [--variant Standard,Fixed,Split2G,Stream,ESX,\n" 704 " Formatted,RawDisk]\n" 705 " [[--property <name>=<value>] --property <name>=<value>\n" 706 " --property-file <name>=</path/to/file/with/value>]...\n" 707 "\n"), SEP); 680 "%s createmedium %s [disk|dvd|floppy] --filename <filename>\n" 681 " [--size <megabytes>|--sizebyte <bytes>]\n" 682 " [--diffparent <uuid>|<filename>]\n" 683 " [--format VDI|VMDK|VHD] (default: VDI)]\n" 684 " [--variant Standard,Fixed,Split2G,Stream,ESX,\n" 685 " Formatted,RawDisk]\n" 686 " [[--property <name>=<value>] --property <name>=<value>\n" 687 " --property-file <name>=</path/to/file/with/value>]...\n" 688 "\n", SEP); 708 689 709 690 if (enmCommand == USAGE_MODIFYMEDIUM || enmCommand == USAGE_S_ALL) 710 691 RTStrmPrintf(pStrm, 711 Help::tr( 712 "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n" 713 " [--type normal|writethrough|immutable|shareable|\n" 714 " readonly|multiattach]\n" 715 " [--autoreset on|off]\n" 716 " [--property <name=[value]>]\n" 717 " [--compact]\n" 718 " [--resize <megabytes>|--resizebyte <bytes>]\n" 719 " [--move <path>]\n" 720 " [--setlocation <path>]\n" 721 " [--description <description string>]" 722 "\n"), SEP); 692 "%s modifymedium %s [disk|dvd|floppy] <uuid|filename>\n" 693 " [--type normal|writethrough|immutable|shareable|\n" 694 " readonly|multiattach]\n" 695 " [--autoreset on|off]\n" 696 " [--property <name=[value]>]\n" 697 " [--compact]\n" 698 " [--resize <megabytes>|--resizebyte <bytes>]\n" 699 " [--move <path>]\n" 700 " [--setlocation <path>]\n" 701 " [--description <description string>]" 702 "\n", SEP); 723 703 724 704 if (enmCommand == USAGE_CLONEMEDIUM || enmCommand == USAGE_S_ALL) 725 705 RTStrmPrintf(pStrm, 726 Help::tr( 727 "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n" 728 " [--format VDI|VMDK|VHD|RAW|<other>]\n" 729 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 730 " [--existing]\n" 731 "\n"), SEP); 706 "%s clonemedium %s [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>\n" 707 " [--format VDI|VMDK|VHD|RAW|<other>]\n" 708 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 709 " [--existing]\n" 710 "\n", SEP); 732 711 733 712 if (enmCommand == USAGE_MEDIUMPROPERTY || enmCommand == USAGE_S_ALL) 734 713 RTStrmPrintf(pStrm, 735 Help::tr( 736 "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n" 737 " <property> <value>\n" 738 "\n" 739 " [disk|dvd|floppy] get <uuid|filename>\n" 740 " <property>\n" 741 "\n" 742 " [disk|dvd|floppy] delete <uuid|filename>\n" 743 " <property>\n" 744 "\n"), SEP); 714 "%s mediumproperty %s [disk|dvd|floppy] set <uuid|filename>\n" 715 " <property> <value>\n" 716 "\n" 717 " [disk|dvd|floppy] get <uuid|filename>\n" 718 " <property>\n" 719 "\n" 720 " [disk|dvd|floppy] delete <uuid|filename>\n" 721 " <property>\n" 722 "\n", SEP); 745 723 746 724 if (enmCommand == USAGE_ENCRYPTMEDIUM || enmCommand == USAGE_S_ALL) 747 725 RTStrmPrintf(pStrm, 748 Help::tr( 749 "%s encryptmedium %s <uuid|filename>\n" 750 " [--newpassword <file>|-]\n" 751 " [--oldpassword <file>|-]\n" 752 " [--cipher <cipher identifier>]\n" 753 " [--newpasswordid <password identifier>]\n" 754 "\n"), SEP); 726 "%s encryptmedium %s <uuid|filename>\n" 727 " [--newpassword <file>|-]\n" 728 " [--oldpassword <file>|-]\n" 729 " [--cipher <cipher identifier>]\n" 730 " [--newpasswordid <password identifier>]\n" 731 "\n", SEP); 755 732 756 733 if (enmCommand == USAGE_MEDIUMENCCHKPWD || enmCommand == USAGE_S_ALL) 757 734 RTStrmPrintf(pStrm, 758 Help::tr( 759 "%s checkmediumpwd %s <uuid|filename>\n" 760 " <pwd file>|-\n" 761 "\n"), SEP); 735 "%s checkmediumpwd %s <uuid|filename>\n" 736 " <pwd file>|-\n" 737 "\n", SEP); 762 738 763 739 if (enmCommand == USAGE_CONVERTFROMRAW || enmCommand == USAGE_S_ALL) 764 740 RTStrmPrintf(pStrm, 765 Help::tr( 766 "%s convertfromraw %s <filename> <outputfile>\n" 767 " [--format VDI|VMDK|VHD]\n" 768 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 769 " [--uuid <uuid>]\n" 770 "%s convertfromraw %s stdin <outputfile> <bytes>\n" 771 " [--format VDI|VMDK|VHD]\n" 772 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 773 " [--uuid <uuid>]\n" 774 "\n"), SEP, SEP); 741 "%s convertfromraw %s <filename> <outputfile>\n" 742 " [--format VDI|VMDK|VHD]\n" 743 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 744 " [--uuid <uuid>]\n" 745 "%s convertfromraw %s stdin <outputfile> <bytes>\n" 746 " [--format VDI|VMDK|VHD]\n" 747 " [--variant Standard,Fixed,Split2G,Stream,ESX]\n" 748 " [--uuid <uuid>]\n" 749 "\n", SEP, SEP); 775 750 776 751 if (enmCommand == USAGE_GETEXTRADATA || enmCommand == USAGE_S_ALL) 777 752 RTStrmPrintf(pStrm, 778 Help::tr( 779 "%s getextradata %s global|<uuid|vmname>\n" 780 " <key>|[enumerate]\n" 781 "\n"), SEP); 753 "%s getextradata %s global|<uuid|vmname>\n" 754 " <key>|[enumerate]\n" 755 "\n", SEP); 782 756 783 757 if (enmCommand == USAGE_SETEXTRADATA || enmCommand == USAGE_S_ALL) 784 758 RTStrmPrintf(pStrm, 785 Help::tr( 786 "%s setextradata %s global|<uuid|vmname>\n" 787 " <key>\n" 788 " [<value>] (no value deletes key)\n" 789 "\n"), SEP); 759 "%s setextradata %s global|<uuid|vmname>\n" 760 " <key>\n" 761 " [<value>] (no value deletes key)\n" 762 "\n", SEP); 790 763 791 764 if (enmCommand == USAGE_SETPROPERTY || enmCommand == USAGE_S_ALL) 792 765 RTStrmPrintf(pStrm, 793 Help::tr( 794 "%s setproperty %s machinefolder default|<folder> |\n" 795 " hwvirtexclusive on|off |\n" 796 " vrdeauthlibrary default|<library> |\n" 797 " websrvauthlibrary default|null|<library> |\n" 798 " vrdeextpack null|<library> |\n" 799 " autostartdbpath null|<folder> |\n" 800 " loghistorycount <value>\n" 801 " defaultfrontend default|<name>\n" 802 " logginglevel <log setting>\n" 803 " proxymode system|noproxy|manual\n" 804 " proxyurl <url>\n"), SEP); 766 "%s setproperty %s machinefolder default|<folder> |\n" 767 " hwvirtexclusive on|off |\n" 768 " vrdeauthlibrary default|<library> |\n" 769 " websrvauthlibrary default|null|<library> |\n" 770 " vrdeextpack null|<library> |\n" 771 " autostartdbpath null|<folder> |\n" 772 " loghistorycount <value>\n" 773 " defaultfrontend default|<name>\n" 774 " logginglevel <log setting>\n" 775 " proxymode system|noproxy|manual\n" 776 " proxyurl <url>\n", SEP); 805 777 #ifdef VBOX_WITH_MAIN_NLS 806 778 RTStrmPrintf(pStrm, 807 Help::tr( 808 " language <language id>\n")); 809 #endif 810 RTStrmPrintf(pStrm, 811 "\n"); 779 " language <language id>\n"); 780 #endif 781 RTStrmPrintf(pStrm, 782 "\n"); 812 783 813 784 if (enmCommand == USAGE_USBFILTER || enmCommand == USAGE_S_ALL) … … 815 786 if (fSubcommandScope & HELP_SCOPE_USBFILTER_ADD) 816 787 RTStrmPrintf(pStrm, 817 Help::tr( 818 "%s usbfilter %s add <index,0-N>\n" 819 " --target <uuid|vmname>|global\n" 820 " --name <string>\n" 821 " --action ignore|hold (global filters only)\n" 822 " [--active yes|no] (yes)\n" 823 " [--vendorid <XXXX>] (null)\n" 824 " [--productid <XXXX>] (null)\n" 825 " [--revision <IIFF>] (null)\n" 826 " [--manufacturer <string>] (null)\n" 827 " [--product <string>] (null)\n" 828 " [--remote yes|no] (null, VM filters only)\n" 829 " [--serialnumber <string>] (null)\n" 830 " [--maskedinterfaces <XXXXXXXX>]\n" 831 "\n"), SEP); 788 "%s usbfilter %s add <index,0-N>\n" 789 " --target <uuid|vmname>|global\n" 790 " --name <string>\n" 791 " --action ignore|hold (global filters only)\n" 792 " [--active yes|no] (yes)\n" 793 " [--vendorid <XXXX>] (null)\n" 794 " [--productid <XXXX>] (null)\n" 795 " [--revision <IIFF>] (null)\n" 796 " [--manufacturer <string>] (null)\n" 797 " [--product <string>] (null)\n" 798 " [--remote yes|no] (null, VM filters only)\n" 799 " [--serialnumber <string>] (null)\n" 800 " [--maskedinterfaces <XXXXXXXX>]\n" 801 "\n", SEP); 832 802 833 803 if (fSubcommandScope & HELP_SCOPE_USBFILTER_MODIFY) 834 804 RTStrmPrintf(pStrm, 835 Help::tr( 836 "%s usbfilter %s modify <index,0-N>\n" 837 " --target <uuid|vmname>|global\n" 838 " [--name <string>]\n" 839 " [--action ignore|hold] (global filters only)\n" 840 " [--active yes|no]\n" 841 " [--vendorid <XXXX>|\"\"]\n" 842 " [--productid <XXXX>|\"\"]\n" 843 " [--revision <IIFF>|\"\"]\n" 844 " [--manufacturer <string>|\"\"]\n" 845 " [--product <string>|\"\"]\n" 846 " [--remote yes|no] (null, VM filters only)\n" 847 " [--serialnumber <string>|\"\"]\n" 848 " [--maskedinterfaces <XXXXXXXX>]\n" 849 "\n"), SEP); 805 "%s usbfilter %s modify <index,0-N>\n" 806 " --target <uuid|vmname>|global\n" 807 " [--name <string>]\n" 808 " [--action ignore|hold] (global filters only)\n" 809 " [--active yes|no]\n" 810 " [--vendorid <XXXX>|\"\"]\n" 811 " [--productid <XXXX>|\"\"]\n" 812 " [--revision <IIFF>|\"\"]\n" 813 " [--manufacturer <string>|\"\"]\n" 814 " [--product <string>|\"\"]\n" 815 " [--remote yes|no] (null, VM filters only)\n" 816 " [--serialnumber <string>|\"\"]\n" 817 " [--maskedinterfaces <XXXXXXXX>]\n" 818 "\n", SEP); 850 819 851 820 if (fSubcommandScope & HELP_SCOPE_USBFILTER_REMOVE) 852 821 RTStrmPrintf(pStrm, 853 Help::tr( 854 "%s usbfilter %s remove <index,0-N>\n" 855 " --target <uuid|vmname>|global\n" 856 "\n"), SEP); 822 "%s usbfilter %s remove <index,0-N>\n" 823 " --target <uuid|vmname>|global\n" 824 "\n", SEP); 857 825 } 858 826 … … 869 837 if (enmCommand == USAGE_METRICS || enmCommand == USAGE_S_ALL) 870 838 RTStrmPrintf(pStrm, 871 Help::tr( 872 "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n" 873 " (comma-separated)\n\n" 874 "%s metrics %s setup\n" 875 " [--period <seconds>] (default: 1)\n" 876 " [--samples <count>] (default: 1)\n" 877 " [--list]\n" 878 " [*|host|<vmname> [<metric_list>]]\n\n" 879 "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n" 880 "%s metrics %s enable\n" 881 " [--list]\n" 882 " [*|host|<vmname> [<metric_list>]]\n\n" 883 "%s metrics %s disable\n" 884 " [--list]\n" 885 " [*|host|<vmname> [<metric_list>]]\n\n" 886 "%s metrics %s collect\n" 887 " [--period <seconds>] (default: 1)\n" 888 " [--samples <count>] (default: 1)\n" 889 " [--list]\n" 890 " [--detach]\n" 891 " [*|host|<vmname> [<metric_list>]]\n" 892 "\n"), SEP, SEP, SEP, SEP, SEP, SEP); 839 "%s metrics %s list [*|host|<vmname> [<metric_list>]]\n" 840 " (comma-separated)\n\n" 841 "%s metrics %s setup\n" 842 " [--period <seconds>] (default: 1)\n" 843 " [--samples <count>] (default: 1)\n" 844 " [--list]\n" 845 " [*|host|<vmname> [<metric_list>]]\n\n" 846 "%s metrics %s query [*|host|<vmname> [<metric_list>]]\n\n" 847 "%s metrics %s enable\n" 848 " [--list]\n" 849 " [*|host|<vmname> [<metric_list>]]\n\n" 850 "%s metrics %s disable\n" 851 " [--list]\n" 852 " [*|host|<vmname> [<metric_list>]]\n\n" 853 "%s metrics %s collect\n" 854 " [--period <seconds>] (default: 1)\n" 855 " [--samples <count>] (default: 1)\n" 856 " [--list]\n" 857 " [--detach]\n" 858 " [*|host|<vmname> [<metric_list>]]\n" 859 "\n", SEP, SEP, SEP, SEP, SEP, SEP); 893 860 894 861 #if defined(VBOX_WITH_NAT_SERVICE) … … 896 863 { 897 864 RTStrmPrintf(pStrm, 898 Help::tr( 899 "%s natnetwork %s add --netname <name>\n" 900 " --network <network>\n" 901 " [--enable|--disable]\n" 902 " [--dhcp on|off]\n" 903 " [--port-forward-4 <rule>]\n" 904 " [--loopback-4 <rule>]\n" 905 " [--ipv6 on|off]\n" 906 " [--port-forward-6 <rule>]\n" 907 " [--loopback-6 <rule>]\n\n" 908 "%s natnetwork %s remove --netname <name>\n\n" 909 "%s natnetwork %s modify --netname <name>\n" 910 " [--network <network>]\n" 911 " [--enable|--disable]\n" 912 " [--dhcp on|off]\n" 913 " [--port-forward-4 <rule>]\n" 914 " [--loopback-4 <rule>]\n" 915 " [--ipv6 on|off]\n" 916 " [--port-forward-6 <rule>]\n" 917 " [--loopback-6 <rule>]\n\n" 918 "%s natnetwork %s start --netname <name>\n\n" 919 "%s natnetwork %s stop --netname <name>\n\n" 920 "%s natnetwork %s list [<pattern>]\n" 921 "\n"), SEP, SEP, SEP, SEP, SEP, SEP); 865 "%s natnetwork %s add --netname <name>\n" 866 " --network <network>\n" 867 " [--enable|--disable]\n" 868 " [--dhcp on|off]\n" 869 " [--port-forward-4 <rule>]\n" 870 " [--loopback-4 <rule>]\n" 871 " [--ipv6 on|off]\n" 872 " [--port-forward-6 <rule>]\n" 873 " [--loopback-6 <rule>]\n\n" 874 "%s natnetwork %s remove --netname <name>\n\n" 875 "%s natnetwork %s modify --netname <name>\n" 876 " [--network <network>]\n" 877 " [--enable|--disable]\n" 878 " [--dhcp on|off]\n" 879 " [--port-forward-4 <rule>]\n" 880 " [--loopback-4 <rule>]\n" 881 " [--ipv6 on|off]\n" 882 " [--port-forward-6 <rule>]\n" 883 " [--loopback-6 <rule>]\n\n" 884 "%s natnetwork %s start --netname <name>\n\n" 885 "%s natnetwork %s stop --netname <name>\n\n" 886 "%s natnetwork %s list [<pattern>]\n" 887 "\n", SEP, SEP, SEP, SEP, SEP, SEP); 922 888 923 889 … … 929 895 { 930 896 RTStrmPrintf(pStrm, 931 Help::tr( 932 "%s hostonlyif %s ipconfig <name>\n" 933 " [--dhcp |\n" 934 " --ip <ipv4> [--netmask <ipv4> (def:255.255.255.0)]|\n" 935 " --ipv6 <ipv6> [--netmasklengthv6 <N> (def:64)]]"), SEP); 897 "%s hostonlyif %s ipconfig <name>\n" 898 " [--dhcp |\n" 899 " --ip <ipv4> [--netmask <ipv4> (def:255.255.255.0)]|\n" 900 " --ipv6 <ipv6> [--netmasklengthv6 <N> (def:64)]]", SEP); 936 901 # if !defined(RT_OS_SOLARIS) || defined(VBOX_ONLY_DOCS) 937 902 RTStrmPrintf(pStrm, 938 Help::tr( 939 " |\n" 940 " create |\n" 941 " remove <name>\n")); 903 " |\n" 904 " create |\n" 905 " remove <name>\n"); 942 906 # else 943 907 RTStrmPrintf(pStrm, 944 908 "\n"); 945 909 # endif 946 910 RTStrmPrintf(pStrm, 947 911 "\n"); 948 912 } 949 913 #endif … … 952 916 { 953 917 RTStrmPrintf(pStrm, 954 Help::tr( 955 "%s usbdevsource %s add <source name>\n" 956 " --backend <backend>\n" 957 " --address <address>\n" 958 "%s usbdevsource %s remove <source name>\n" 959 "\n"), SEP, SEP); 918 "%s usbdevsource %s add <source name>\n" 919 " --backend <backend>\n" 920 " --address <address>\n" 921 "%s usbdevsource %s remove <source name>\n" 922 "\n", SEP, SEP); 960 923 } 961 924
Note:
See TracChangeset
for help on using the changeset viewer.
