Changeset 107917 in vbox

Timestamp:

Jan 23, 2025 3:17:19 PM (2 weeks ago)

Author:

vboxsync

Message:

doc/manual: Update the 'VBoxManage guestcontrol' manual to consolidate
the information about running GUI applications via the 'start' and 'run'
subcommands using the existing entries outlining the caveats in the
manual and the explanatory text in the 'Known Issues' section of the
User Manual. Also remove the references to the 'Known Issues' in the
User Manual for this scenario since this isn't an issue to be fixed and
this is thus being removed from the 'Known Issues' section of the User
Manual. jiraref:VBP-1494

File:

• trunk/doc/manual/en_US/man_VBoxManage-guestcontrol.xml (modified) (3 diffs)

trunk/doc/manual/en_US/man_VBoxManage-guestcontrol.xml

@@ -498 +498 @@
       </para>
     </refsect2>
+    <refsect2 id="vboxmanage-guestcontrol-GUI-limitations">
+      <title>Running Graphical Applications Inside a Guest</title>
+      <para>
+        If using the <command>VBoxManage guestcontrol run</command> or
+        <command>VBoxManage guestcontrol start</command> commands to
+        execute a graphical application then the guest will need to be
+        running a graphical windowing environment typically as the same
+        user executing the GUI application.  For example on Windows
+        guests the user running the GUI application in the guest needs
+        to be currently logged in with a running desktop session.
+        Similarly on UNIX and UNIX-like guests a graphical windowing
+        system such as X11 or Wayland needs to be running and the user
+        executing the GUI application needs authorization to be able to
+        connect to the display server.
+      </para>
+    </refsect2>
     <refsect2 id="vboxmanage-guestcontrol-run">
       <title>Run a Command in the guest</title>
@@ -508 +524 @@
         to the host system until the program completes.
       </para>
-      <note>
-        <para>
-          Microsoft Windows imposes certain limitations when running
-          graphical user interface applications launched using
-          <command>VBoxManage guestcontrol run</command>. See
-          <xref linkend="known-issues" />.
-        </para>
-      </note>
-      <variablelist>
+     <variablelist>
         <varlistentry>
           <term><option>--exe=<replaceable>path-to-executable</replaceable></option></term>
@@ -678 +686 @@
         has been read before returning.
       </para>
-      <note>
-        <para>
-          Microsoft Windows imposes certain limitations when running
-          graphical user interface applications launched using
-          <command>VBoxManage guestcontrol start</command>. See
-          <xref linkend="known-issues" />.
-        </para>
-      </note>
     </refsect2>
     <refsect2 id="vboxmanage-guestcontrol-copyfrom">