- Timestamp:
- Nov 4, 2010 2:15:00 PM (14 years ago)
- Location:
- trunk/doc/manual
- Files:
-
- 3 edited
-
en_US/user_GuestAdditions.xml (modified) (2 diffs)
-
en_US/user_VBoxManage.xml (modified) (1 diff)
-
user_ChangeLogImpl.xml (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_GuestAdditions.xml
r32662 r33768 206 206 207 207 <para>In the "Devices" menu in the virtual machine's menu bar, 208 VirtualBox has a handy menu item named "Install guest additions", 209 which mounts the Guest Additions ISO file inside your virtual machine. 210 A Windows guest should then automatically start the Guest Additions 211 installer, which installs the Guest Additions into your Windows 212 guest.</para> 208 VirtualBox has a handy menu item named "Install Guest Additions", 209 which either allows to upgrade already installed Guest Additions 210 (only Windows Guest Additions 4.0 and later) automatically or 211 mounts the Guest Additions ISO file inside your virtual machine 212 to perform a manual update.</para> 213 214 <para>In case of a manual update, a Windows guest should then 215 automatically start the Guest Additions installer, which allows to 216 install the Guest Additions into your Windows guest.</para> 213 217 214 218 <note> … … 1413 1417 the guest.</para> 1414 1418 1415 <para>To use this feature, use the VirtualBox command line. See <xref 1416 linkend="vboxmanage-guestcontrol" /> for details.</para> 1419 <para>Starting with version 4.0, the Guest Additions for Windows 1420 allow for automatic updating (only already installed Guest Additions 4.0 1421 or later).</para> 1422 1423 <para>To use these feature, use the VirtualBox command line or the GUI. See 1424 <xref linkend="mountingadditionsiso" /> or <xref linkend="vboxmanage-guestcontrol" /> 1425 for details.</para> 1417 1426 </sect1> 1418 1427 -
trunk/doc/manual/en_US/user_VBoxManage.xml
r33456 r33768 2397 2397 <screen>VBoxManage guestcontrol <command></screen> 2398 2398 2399 <para>At this time, the only available 2400 <computeroutput><command></computeroutput> is "execute", which 2401 allows for executing a program/script (process) which is already installed 2402 and runnable on the guest. This command only works while a VM is up and 2403 running and has the following syntax:</para> 2404 2405 <screen>VBoxManage guestcontrol execute <vmname>|<uuid> 2406 <pathToProgram> 2407 --username <name> --password <password> 2408 [--arguments "<arguments>"] 2409 [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"] 2410 [--flags <flags>] [--timeout <msec>] 2411 [--verbose] [--wait-for exit,stdout,stderr||]</screen> 2412 2413 <para>where the parameters mean: <glosslist> 2414 <glossentry> 2415 <glossterm>uuid|vmname</glossterm> 2416 2417 <glossdef> 2418 <para>The VM UUID or VM name. Mandatory.</para> 2419 </glossdef> 2420 </glossentry> 2421 2422 <glossentry> 2423 <glossterm>pathToProgram</glossterm> 2424 2425 <glossdef> 2426 <para>Absolute path and process name of process to execute in the 2427 guest, e.g. 2428 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 2429 </glossdef> 2430 </glossentry> 2431 2432 <glossentry> 2433 <glossterm>--arguments "<arguments>"</glossterm> 2434 2435 <glossdef> 2436 <para>One or more arguments to pass to the process being 2437 executed.</para> 2438 2439 <para>Arguments containing spaces must be enclosed in quotation 2440 marks. More than one <computeroutput>--arguments</computeroutput> 2441 at a time can be specified to keep the command line tidy.</para> 2442 </glossdef> 2443 </glossentry> 2444 2445 <glossentry> 2446 <glossterm>--environment "<NAME>=<VALUE>"</glossterm> 2447 2448 <glossdef> 2449 <para>One or more environment variables to be set or unset.</para> 2450 2451 <para>By default, the new process in the guest will be created 2452 with the the standard environment of the guest OS. This option 2453 allows for modifying that environment. To set/modify a variable, a 2454 pair of <computeroutput>NAME=VALUE</computeroutput> must be 2455 specified; to unset a certain variable, the name with no value 2456 must set, e.g. <computeroutput>NAME=</computeroutput>.</para> 2457 2458 <para>Arguments containing spaces must be enclosed in quotation 2459 marks. More than one 2460 <computeroutput>--environment</computeroutput> at a time can be 2461 specified to keep the command line tidy.</para> 2462 </glossdef> 2463 </glossentry> 2464 2465 <glossentry> 2466 <glossterm>--flags <flags></glossterm> 2467 2468 <glossdef> 2469 <para>Additional flags to set. This is not used at the 2470 moment.</para> 2471 </glossdef> 2472 </glossentry> 2473 2474 <glossentry> 2475 <glossterm>--timeout <msec></glossterm> 2476 2477 <glossdef> 2478 <para>Value (in milliseconds) that specifies the time how long the 2479 started process is allowed to run and how long VBoxManage waits 2480 for getting output from that process. If no timeout is specified, 2481 VBoxManage will wait forever until the started process ends or an 2482 error occured.</para> 2483 </glossdef> 2484 </glossentry> 2485 2486 <glossentry> 2487 <glossterm>--username <name></glossterm> 2488 2489 <glossdef> 2490 <para>Name of the user the process should run under. This user 2491 must exist on the guest OS.</para> 2492 </glossdef> 2493 </glossentry> 2494 2495 <glossentry> 2496 <glossterm>--password <password></glossterm> 2497 2498 <glossdef> 2499 <para>Password of the user account specified with 2500 <computeroutput>--username</computeroutput>. If not given, an 2501 empty password is assumed.</para> 2502 </glossdef> 2503 </glossentry> 2504 2505 <glossentry> 2506 <glossterm>--verbose</glossterm> 2507 2508 <glossdef> 2509 <para>Tells VBoxManage to be more verbose during the 2510 execution.</para> 2511 </glossdef> 2512 </glossentry> 2513 2514 <glossentry> 2515 <glossterm>--wait-for <action></glossterm> 2516 2517 <glossdef> 2518 <para>Tells VBoxManage to wait for a certain action to happen and 2519 react to it. The following actions are available: <glosslist> 2520 <glossentry> 2521 <glossterm>exit</glossterm> 2522 2523 <glossdef> 2524 <para>Waits until the process ends and outputs its exit 2525 code along with the exit reason/flags.</para> 2526 </glossdef> 2527 </glossentry> 2528 2529 <glossentry> 2530 <glossterm>stdout or stderr</glossterm> 2531 2532 <glossdef> 2533 <para>Waits until the process ends and outputs its exit 2534 code along with the exit reason/flags. After that 2535 VBoxManage retrieves the output collected from the guest 2536 process's stdout and stderr.</para> 2537 </glossdef> 2538 </glossentry> 2539 </glosslist></para> 2540 </glossdef> 2541 </glossentry> 2542 </glosslist></para> 2543 2544 <para><note> 2545 <para>On Windows there are certain limitations for graphical 2546 applications; please see <xref linkend="KnownIssues" /> for more 2547 information.</para> 2548 </note> Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr" 2549 --username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe" 2550 --username foo --password bar --wait-for stdout</screen> Note that 2551 the double backslashes in the second example are only required on Unix 2552 hosts.</para> 2399 <para>The following subcommands are available (where 2400 <computeroutput><vm></computeroutput>, in each case, can either be a 2401 VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist> 2402 <listitem> 2403 <para><computeroutput>execute</computeroutput>, which 2404 allows for executing a program/script (process) which is already installed 2405 and runnable on the guest. This command only works while a VM is up and 2406 running and has the following syntax:</para> 2407 2408 <screen>VBoxManage guestcontrol execute <vmname>|<uuid> 2409 <path to program> 2410 --username <name> --password <password> 2411 [--arguments "<arguments>"] 2412 [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"] 2413 [--flags <flags>] [--timeout <msec>] 2414 [--verbose] [--wait-for exit,stdout,stderr||]</screen> 2415 2416 <para>where the parameters mean: <glosslist> 2417 <glossentry> 2418 <glossterm>uuid|vmname</glossterm> 2419 2420 <glossdef> 2421 <para>The VM UUID or VM name. Mandatory.</para> 2422 </glossdef> 2423 </glossentry> 2424 2425 <glossentry> 2426 <glossterm>path to program</glossterm> 2427 2428 <glossdef> 2429 <para>Absolute path and process name of process to execute in the 2430 guest, e.g. 2431 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 2432 </glossdef> 2433 </glossentry> 2434 2435 <glossentry> 2436 <glossterm>--arguments "<arguments>"</glossterm> 2437 2438 <glossdef> 2439 <para>One or more arguments to pass to the process being 2440 executed.</para> 2441 2442 <para>Arguments containing spaces must be enclosed in quotation 2443 marks. More than one <computeroutput>--arguments</computeroutput> 2444 at a time can be specified to keep the command line tidy.</para> 2445 </glossdef> 2446 </glossentry> 2447 2448 <glossentry> 2449 <glossterm>--environment "<NAME>=<VALUE>"</glossterm> 2450 2451 <glossdef> 2452 <para>One or more environment variables to be set or unset.</para> 2453 2454 <para>By default, the new process in the guest will be created 2455 with the the standard environment of the guest OS. This option 2456 allows for modifying that environment. To set/modify a variable, a 2457 pair of <computeroutput>NAME=VALUE</computeroutput> must be 2458 specified; to unset a certain variable, the name with no value 2459 must set, e.g. <computeroutput>NAME=</computeroutput>.</para> 2460 2461 <para>Arguments containing spaces must be enclosed in quotation 2462 marks. More than one 2463 <computeroutput>--environment</computeroutput> at a time can be 2464 specified to keep the command line tidy.</para> 2465 </glossdef> 2466 </glossentry> 2467 2468 <glossentry> 2469 <glossterm>--flags <flags></glossterm> 2470 2471 <glossdef> 2472 <para>Additional flags to set. This is not used at the 2473 moment.</para> 2474 </glossdef> 2475 </glossentry> 2476 2477 <glossentry> 2478 <glossterm>--timeout <msec></glossterm> 2479 2480 <glossdef> 2481 <para>Value (in milliseconds) that specifies the time how long the 2482 started process is allowed to run and how long VBoxManage waits 2483 for getting output from that process. If no timeout is specified, 2484 VBoxManage will wait forever until the started process ends or an 2485 error occured.</para> 2486 </glossdef> 2487 </glossentry> 2488 2489 <glossentry> 2490 <glossterm>--username <name></glossterm> 2491 2492 <glossdef> 2493 <para>Name of the user the process should run under. This user 2494 must exist on the guest OS.</para> 2495 </glossdef> 2496 </glossentry> 2497 2498 <glossentry> 2499 <glossterm>--password <password></glossterm> 2500 2501 <glossdef> 2502 <para>Password of the user account specified with 2503 <computeroutput>--username</computeroutput>. If not given, an 2504 empty password is assumed.</para> 2505 </glossdef> 2506 </glossentry> 2507 2508 <glossentry> 2509 <glossterm>--verbose</glossterm> 2510 2511 <glossdef> 2512 <para>Tells VBoxManage to be more verbose during the 2513 execution.</para> 2514 </glossdef> 2515 </glossentry> 2516 2517 <glossentry> 2518 <glossterm>--wait-for <action></glossterm> 2519 2520 <glossdef> 2521 <para>Tells VBoxManage to wait for a certain action to happen and 2522 react to it. The following actions are available: <glosslist> 2523 <glossentry> 2524 <glossterm>exit</glossterm> 2525 2526 <glossdef> 2527 <para>Waits until the process ends and outputs its exit 2528 code along with the exit reason/flags.</para> 2529 </glossdef> 2530 </glossentry> 2531 2532 <glossentry> 2533 <glossterm>stdout or stderr</glossterm> 2534 2535 <glossdef> 2536 <para>Waits until the process ends and outputs its exit 2537 code along with the exit reason/flags. After that 2538 VBoxManage retrieves the output collected from the guest 2539 process's stdout and stderr.</para> 2540 </glossdef> 2541 </glossentry> 2542 </glosslist></para> 2543 </glossdef> 2544 </glossentry> 2545 </glosslist> 2546 </para> 2547 2548 <para> 2549 <note> 2550 <para>On Windows there are certain limitations for graphical 2551 applications; please see <xref linkend="KnownIssues" /> for more 2552 information. 2553 </para> 2554 </note> 2555 Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr" 2556 --username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe" 2557 --username foo --password bar --wait-for stdout</screen> Note that 2558 the double backslashes in the second example are only required on Unix 2559 hosts. 2560 </para> 2561 </listitem> 2562 2563 <listitem> 2564 <para><computeroutput>copyto</computeroutput>, which 2565 allows copying files from the host to the guest 2566 (only with installed Guest Additions 4.0 and later).</para> 2567 2568 <screen>VBoxManage copyto <vmname>|<uuid> 2569 <source on host> <destination on guest> 2570 [--username "<name>"] [--password "<password>"] 2571 [--dryrun] [--recursive] [--verbose] [--flags <flags>]</screen> 2572 2573 <para>where the parameters mean: <glosslist> 2574 <glossentry> 2575 <glossterm>uuid|vmname</glossterm> 2576 2577 <glossdef> 2578 <para>The VM UUID or VM name. Mandatory.</para> 2579 </glossdef> 2580 </glossentry> 2581 2582 <glossentry> 2583 <glossterm>source on host</glossterm> 2584 2585 <glossdef> 2586 <para>Absolute path of source file(s) on host to copy over to 2587 the guest, e.g. 2588 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. This also 2589 can be a wildcard expression, e.g. 2590 <computeroutput>C:\Windows\System32\*.dll</computeroutput> 2591 </para> 2592 </glossdef> 2593 </glossentry> 2594 2595 <glossentry> 2596 <glossterm>destination on guest</glossterm> 2597 2598 <glossdef> 2599 <para>Absolute destination path on the guest, e.g. 2600 <computeroutput>C:\Temp</computeroutput></para> 2601 </glossdef> 2602 </glossentry> 2603 2604 <glossentry> 2605 <glossterm>--username <name></glossterm> 2606 2607 <glossdef> 2608 <para>Name of the user the copy process should run under. This user 2609 must exist on the guest OS.</para> 2610 </glossdef> 2611 </glossentry> 2612 2613 <glossentry> 2614 <glossterm>--password <password></glossterm> 2615 2616 <glossdef> 2617 <para>Password of the user account specified with 2618 <computeroutput>--username</computeroutput>. If not given, an 2619 empty password is assumed.</para> 2620 </glossdef> 2621 </glossentry> 2622 2623 <glossentry> 2624 <glossterm>--dryrun</glossterm> 2625 2626 <glossdef> 2627 <para>Tells VBoxManage to only perform a dry run instead of 2628 really copying files to the guest.</para> 2629 </glossdef> 2630 </glossentry> 2631 2632 <glossentry> 2633 <glossterm>--recursive</glossterm> 2634 2635 <glossdef> 2636 <para>Recursively copies files/directories.</para> 2637 </glossdef> 2638 </glossentry> 2639 2640 <glossentry> 2641 <glossterm>--verbose</glossterm> 2642 2643 <glossdef> 2644 <para>Tells VBoxManage to be more verbose during the 2645 copy operation.</para> 2646 </glossdef> 2647 </glossentry> 2648 2649 <glossentry> 2650 <glossterm>--flags <flags></glossterm> 2651 2652 <glossdef> 2653 <para>Additional flags to set. This is not used at the 2654 moment.</para> 2655 </glossdef> 2656 </glossentry> 2657 2658 </glosslist> 2659 </para> 2660 </listitem> 2661 2662 <listitem> 2663 <para><computeroutput>updateadditions</computeroutput>, which 2664 allows for updating an already installed Guest Additions version on 2665 the guest (only already installed Guest Additions 4.0 and later).</para> 2666 2667 <screen>VBoxManage guestcontrol updateadditions <vmname>|<uuid> 2668 [--source "<guest additions .ISO file to use>"] [--verbose]</screen> 2669 2670 <para>where the parameters mean: <glosslist> 2671 <glossentry> 2672 <glossterm>uuid|vmname</glossterm> 2673 2674 <glossdef> 2675 <para>The VM UUID or VM name. Mandatory.</para> 2676 </glossdef> 2677 </glossentry> 2678 2679 <glossentry> 2680 <glossterm>--source "<guest additions .ISO file to use>"</glossterm> 2681 2682 <glossdef> 2683 <para>Full path to an alternative VirtualBox Guest Additions .ISO file to use 2684 for the Guest Additions update.</para> 2685 </glossdef> 2686 </glossentry> 2687 2688 <glossentry> 2689 <glossterm>--verbose</glossterm> 2690 2691 <glossdef> 2692 <para>Tells VBoxManage to be more verbose during the 2693 update.</para> 2694 </glossdef> 2695 </glossentry> 2696 2697 </glosslist> 2698 </para> 2699 </listitem> 2700 2701 </itemizedlist></para> 2553 2702 </sect1> 2554 2703 -
trunk/doc/manual/user_ChangeLogImpl.xml
r33552 r33768 24 24 </listitem> 25 25 26 <listitem> 27 <para>Windows Additions: Support for automatic updating Guest Additions 28 (only already installed Windows Guest Additions 4.0 and later)</para> 29 </listitem> 30 31 <listitem> 32 <para>Guest Additions: Support for copying files from host to the guest</para> 33 </listitem> 34 26 35 </itemizedlist> 27 36
Note:
See TracChangeset
for help on using the changeset viewer.
