Changeset 37866 in vbox

Timestamp:

Jul 11, 2011 12:02:08 PM (13 years ago)

Author:

vboxsync

Message:

Documentation update.

File:

• trunk/doc/manual/en_US/user_VBoxManage.xml (modified) (6 diffs)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -2456 +2456 @@
           running and has the following syntax:</para>
 
-          <screen>VBoxManage guestcontrol exec[ute] &lt;vmname&gt;|&lt;uuid&gt;
+          <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; exec[ute]
             --image &lt;path to program&gt;
             --username &lt;name&gt; --password &lt;password&gt;
+            [--dos2unix]
             [--environment "&lt;NAME&gt;=&lt;VALUE&gt; [&lt;NAME&gt;=&lt;VALUE&gt;]"]
-            [--flags &lt;flags&gt;] [--timeout &lt;msec&gt;]
-            [--verbose] [--wait-exit] [--wait-stdout] [--wait-stderr]
+            [--timeout &lt;msec&gt;] [--unix2dos] [--verbose]
+            [--wait-exit] [--wait-stdout] [--wait-stderr]
             -- [[&lt;argument1&gt;] ... [&lt;argumentN&gt;]]</screen>
 
@@ -2484 +2485 @@
 
               <glossentry>
-                <glossterm>--arguments "&lt;arguments&gt;"</glossterm>
+                <glossterm>--username &lt;name&gt;</glossterm>
 
                 <glossdef>
-                  <para>One or more arguments to pass to the process being
-                  executed.</para>
-
-                  <para>Arguments containing spaces must be enclosed in
-                  quotation marks. More than one
-                  <computeroutput>--arguments</computeroutput> at a time can
-                  be specified to keep the command line tidy.</para>
+                  <para>Name of the user the process should run under. This
+                  user must exist on the guest OS.</para>
+                </glossdef>
+              </glossentry>
+
+              <glossentry>
+                <glossterm>--password &lt;password&gt;</glossterm>
+
+                <glossdef>
+                  <para>Password of the user account specified with
+                  <computeroutput>--username</computeroutput>. If not given,
+                  an empty password is assumed.</para>
+                </glossdef>
+              </glossentry>
+
+              <glossentry>
+                <glossterm>--dos2unix</glossterm>
+
+                <glossdef>
+                  Converts output from DOS/Windows guests to UNIX-compatible
+                  line endings (CR + LF -> LF). Not implemented yet.
                 </glossdef>
               </glossentry>
@@ -2522 +2537 @@
 
               <glossentry>
-                <glossterm>--flags &lt;flags&gt;</glossterm>
-
-                <glossdef>
-                  <para>Additional flags to set. This is not used at the
-                  moment.</para>
-                </glossdef>
-              </glossentry>
-
-              <glossentry>
                 <glossterm>--timeout &lt;msec&gt;</glossterm>
 
@@ -2543 +2549 @@
 
               <glossentry>
-                <glossterm>--username &lt;name&gt;</glossterm>
+                <glossterm>--unix2dos</glossterm>
 
                 <glossdef>
-                  <para>Name of the user the process should run under. This
-                  user must exist on the guest OS.</para>
-                </glossdef>
-              </glossentry>
-
-              <glossentry>
-                <glossterm>--password &lt;password&gt;</glossterm>
-
-                <glossdef>
-                  <para>Password of the user account specified with
-                  <computeroutput>--username</computeroutput>. If not given,
-                  an empty password is assumed.</para>
+                  Converts output from a UNIX/Linux guests to DOS-/Windows-compatible
+                  line endings (LF -> CR + LF). Not implemented yet.
                 </glossdef>
               </glossentry>
@@ -2598 +2594 @@
               </glossentry>
 
+              <glossentry>
+                <glossterm>[-- [&lt;argument1s&gt;] ... [&lt;argumentNs&gt;]]</glossterm>
+
+                <glossdef>
+                  <para>One or more arguments to pass to the process being
+                  executed.</para>
+                  <para>Arguments containing spaces must be enclosed in
+                  quotation marks.</para>
+                </glossdef>
+              </glossentry>
+
             </glosslist></para>
 
@@ -2604 +2611 @@
               applications; please see <xref linkend="KnownIssues" /> for more
               information.</para>
-            </note> Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr"
-          --username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe"
-          --username foo --password bar --wait-for stdout</screen> Note that
+            </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
+          --username foo --password bar --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe"
+          --username foo --password bar --wait-exit --wait-stdout</screen> Note that
           the double backslashes in the second example are only required on
           Unix hosts.</para>