Changeset 37761 in vbox for trunk

Timestamp:

Jul 4, 2011 12:22:02 PM (13 years ago)

Author:

vboxsync

Message:

GuestCtrl/Exec: Documentation/Syntax diagram fixes.

Location:

trunk

Files:

• doc/manual/en_US/user_VBoxManage.xml (modified) (7 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp (modified) (1 diff)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -747 +747 @@
           <listitem>
             <para><computeroutput>--nicgenericdrv&lt;1-N&gt;
-            &lt;backend driver&gt;</computeroutput>: If generic networking has been 
+            &lt;backend driver&gt;</computeroutput>: If generic networking has been
             enabled for a virtual network card (see the
             <computeroutput>--nic</computeroutput> option above; otherwise
@@ -754 +754 @@
             </para>
           </listitem>
-          
-          <listitem>
-            <para><computeroutput>--nicproperty&lt;1-N&gt; 
+
+          <listitem>
+            <para><computeroutput>--nicproperty&lt;1-N&gt;
             &lt;paramname&gt;="paramvalue"</computeroutput>:
             This option, in combination with "nicgenericdrv" allows you to
             pass parameters to rarely-used network backends.</para><para>
             Those parameters are backend engine-specific, and are different
-            between UDP Tunnel and the VDE backend drivers. For example, 
+            between UDP Tunnel and the VDE backend drivers. For example,
             please see <xref linkend="network_udp_tunnel" />.
             </para>
@@ -1340 +1340 @@
         (<computeroutput>intnet</computeroutput>) or host-only networking
         (<computeroutput>hostonly</computeroutput>) or access to rarely used
-        sub-modes 
+        sub-modes
         (<computeroutput>generic</computeroutput>). These options correspond
         to the modes which are described in detail in <xref
@@ -2456 +2456 @@
           running and has the following syntax:</para>
 
-          <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; exec[ute]
-            &lt;path to program&gt;
+          <screen>VBoxManage guestcontrol exec[ute] &lt;vmname&gt;|&lt;uuid&gt;
+            --image &lt;path to program&gt;
             --username &lt;name&gt; --password &lt;password&gt;
-            [--arguments "&lt;arguments&gt;"]
             [--environment "&lt;NAME&gt;=&lt;VALUE&gt; [&lt;NAME&gt;=&lt;VALUE&gt;]"]
             [--flags &lt;flags&gt;] [--timeout &lt;msec&gt;]
-            [--verbose] [--wait-for exit,stdout,stderr||]</screen>
+            [--verbose] [--wait-exit] [--wait-stdout] [--wait-stderr]
+            -- [[&lt;argument1&gt;] ... [&lt;argumentN&gt;]]</screen>
 
           <para>where the parameters mean: <glosslist>
@@ -2474 +2474 @@
 
               <glossentry>
-                <glossterm>path to program</glossterm>
+                <glossterm>--image "&lt;path to program&gt;"</glossterm>
 
                 <glossdef>
@@ -2570 +2570 @@
 
               <glossentry>
-                <glossterm>--wait-for &lt;action&gt;</glossterm>
+                <glossterm>--wait-exit</glossterm>
 
                 <glossdef>
-                  <para>Tells VBoxManage to wait for a certain action to
-                  happen and react to it. The following actions are available:
-                  <glosslist>
-                      <glossentry>
-                        <glossterm>exit</glossterm>
-
-                        <glossdef>
-                          <para>Waits until the process ends and outputs its
-                          exit code along with the exit reason/flags.</para>
-                        </glossdef>
-                      </glossentry>
-
-                      <glossentry>
-                        <glossterm>stdout or stderr</glossterm>
-
-                        <glossdef>
-                          <para>Waits until the process ends and outputs its
-                          exit code along with the exit reason/flags. After
-                          that VBoxManage retrieves the output collected from
-                          the guest process's stdout and stderr.</para>
-                        </glossdef>
-                      </glossentry>
-                    </glosslist></para>
+                  <para>Waits until the process ends and outputs its
+                  exit code along with the exit reason/flags.</para>
                 </glossdef>
               </glossentry>
+
+              <glossentry>
+                <glossterm>--wait-stdout</glossterm>
+
+                <glossdef>
+                  <para>Waits until the process ends and outputs its
+                  exit code along with the exit reason/flags. While waiting
+                  VBoxManage retrieves the process output collected from stdout.</para>
+                </glossdef>
+              </glossentry>
+
+              <glossentry>
+                <glossterm>--wait-stderr</glossterm>
+
+                <glossdef>
+                  <para>Waits until the process ends and outputs its
+                  exit code along with the exit reason/flags. While waiting
+                  VBoxManage retrieves the process output collected from stderr.</para>
+                </glossdef>
+              </glossentry>
+
             </glosslist></para>
 
@@ -2721 +2721 @@
           Additions 4.0 and later).</para>
 
-          <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; createdir[ectory]|mkdir|md 
+          <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; createdir[ectory]|mkdir|md
             &lt;directory to create on guest&gt;
             [--username "&lt;name&gt;"] [--password "&lt;password&gt;"]

trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestCtrl.cpp

@@ -186 +186 @@
                  "                            [--environment \"<NAME>=<VALUE> [<NAME>=<VALUE>]\"]\n"
                  "                            [--timeout <msec>] [--unix2dos] [--verbose]\n"
-                 "                            [--wait-exit] [--wait-stdout] [--wait-stdout]\n"
+                 "                            [--wait-exit] [--wait-stdout] [--wait-stderr]\n"
                  //"                          [--output-format=<dos>|<unix>]\n"
                  "                            [--output-type=<binary>|<text>]\n"
-                 "                            [-- [<argument1>] ... [<argumentN>]\n"
+                 "                            [-- [<argument1>] ... [<argumentN>]]\n"
                  /** @todo Add a "--" parameter (has to be last parameter) to directly execute
                   *        stuff, e.g. "VBoxManage guestcontrol execute <VMName> --username <> ... -- /bin/rm -Rf /foo". */