Index: /trunk/doc/manual/en_US/user_VBoxManage.xml
===================================================================
--- /trunk/doc/manual/en_US/user_VBoxManage.xml (revision 55958)
+++ /trunk/doc/manual/en_US/user_VBoxManage.xml (revision 55959)
@@ -2815,10 +2815,10 @@
hwvirtexclusive
- This specifies whether VirtualBox will make exclusive use of
+ This specifies whether VirtualBox will make exclusive use of
the hardware virtualization extensions (Intel VT-x or AMD-V) of the
host system's processor; see . If you wish to
share these extensions with other hypervisors running at the same time,
you must disable this setting. Doing so has negative performance implications.
-
+
@@ -3068,41 +3068,78 @@
linkend="guestadd-guestcontrol" /> for an introduction.
- Generally, the syntax is as follows:
-
- VBoxManage guestcontrol <uuid|vmname> <command>
-
- The following subcommands are available (where
- <uuid|vmname>, in each case, can either be a
- VM name or a VM UUID, as with the other VBoxManage commands):
-
- execute,
- which allows for
- executing a program/script (process) which already is installed and
- runnable on the guest. This command only works while a VM is up and
- running and has the following syntax:
-
- VBoxManage guestcontrol <uuid|vmname> exec[ute]
- --image <path to program> --username <name>
- [--passwordfile <file> | --password <password>]
- [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
- [--verbose] [--timeout <msec>]
- [--wait-exit] [--wait-stdout] [--wait-stderr]
+ There are two sets of subcommands here. The first set requires guest
+ credentials to be specified, the second set does not.
+
+ The first set of subcommands are on the following form:
+
+ VBoxManage guestcontrol <uuid|vmname> <sub-command>
+ [-v|--verbose] [-q|quiet] [--username <name>] [--domain <domain> ]
+ [--passwordfile <file> | --password <password>] ...
+
+
+ and the second set are on the following form:
+
+ VBoxManage guestcontrol <uuid|vmname> <sub-command>
+ [-v|--verbose] [-q|quiet] ...
+
+
+ where the common parameters are:
+
+
+ uuid|vmname
+ The VM UUID or VM name. Mandatory.
+
+
+ --username <name>
+ Name of the user the process should run under. This
+ user must exist on the guest OS. If not specified the host user
+ name is used.
+
+
+
+ --domain <domain>
+ User domain for windows guests, optional.
+
+
+ --passwordfile <file>
+ Password of the specified user account to be read from
+ the given file. If not given, an empty password is assumed.
+
+
+ --password <password>
+ Password of the specified user account. If not given,
+ an empty password is assumed.
+
+
+ -v|--verbose
+ Makes the sub-command execution more noisy.
+
+
+ -q|--quiet
+ Makes the sub-command execution more quiet.
+
+
+
+
+ The first set of subcommands:
+
+ run,
+ allows you to execute a guest program waiting for it to complete and
+ forwarding stdout, stderr and stdin to/from the host.
+
+ VBoxManage guestcontrol <uuid|vmname> run [common-options]
+ [--exe <path to executable>] [--timeout <msec>]
+ [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
+ [--ignore-operhaned-processes] [--no-profile]
+ [--no-wait-stdout|--wait-stdout]
+ [--no-wait-stderr|--wait-stderr]
[--dos2unix] [--unix2dos]
- -- [[<argument1>] ... [<argumentN>]]
-
- where the parameters mean:
-
- uuid|vmname
-
-
- The VM UUID or VM name. Mandatory.
-
-
-
-
- --image "<path to program>"
-
-
- Absolute path and process name of process to execute
+ -- <program/arg0> [argument1] ... [argumentN]]
+
+
+ where the options are:
+
+ --exe "<path to program>"
+ Guest path to the guest executable that should be executed.
in the guest, e.g.
C:\Windows\System32\calc.exe
@@ -3142,7 +3179,7 @@
--dos2unix
-
+
Converts output from DOS/Windows guests to UNIX-compatible
- line endings (CR + LF -> LF). Not implemented yet.
+ line endings (CR + LF -> LF). Not implemented yet.
@@ -3187,8 +3224,7 @@
--unix2dos
-
+
Converts output from a UNIX/Linux guests to DOS-/Windows-compatible
- line endings (LF -> CR + LF). Not implemented yet.
-
+ line endings (LF -> CR + LF). Not implemented yet.