Changeset 86092 in vbox for trunk/doc/manual

Timestamp:

Sep 11, 2020 12:37:47 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

140324

Message:

Docs/GAs: Adding a new section about guest monitor topology control.

Location:

trunk/doc/manual/en_US

Files:

• user_GuestAdditions.xml (modified) (1 diff)
• user_Troubleshooting.xml (modified) (3 diffs)

trunk/doc/manual/en_US/user_GuestAdditions.xml

@@ -2394 +2394 @@
   </sect1>
 
+  <sect1 id="guestadd-resizing">
+
+      <title>Controlling Virtual Monitor Topology</title>
+
+      <sect2 id="guestadd-resizing-linux">
+
+          <title>X11/Wayland Desktop Environments</title>
+
+          <para>
+              The Guest Additions provide necessary services to enable controlling
+              the guest system's monitor topology. My monitor topology the resolution
+              of each virtual monitor and its state are meant (disabled/enabled). The
+              resolution of a virtual monitor can be modified from the host side either
+              by resizing the window that hosts the virtual monitor or thru the view menu.
+              On guest operating systems with X11/Wayland desktops this is achieved by
+              either of two following services:
+        </para>
+
+        <screen>
+            VBoxClient --vmsvga
+            VBoxDRMClient
+        </screen>
+
+        <para>
+            Here are some details about guest screen resolution control functionality:
+        </para>
+
+        <itemizedlist>
+
+            <listitem>
+                <para>
+                    On X11/Wayland desktops the resizing service is started during
+                    desktop session initialization, that is desktop login. On X11 desktops
+                    VBoxClient --vmsvga service handles screen topology thru xrandr calls.
+                    On Wayland clients VBoxDRMClient is used. The decision of choosing either
+                    of these clients is done automatically at each desktop session start.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    On 32 bit guest OSs VBoxDRMClient, which is run during desktop
+                    session start, is used. The guest OS bitness check and choice
+                    of the service is done automatically.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    Since the mentioned monitor topology control services are initialized during
+                    the desktop session start, display managers' (gdm, lightdm, etc.) resolution
+                    cannot be controlled. This default behavior can be changed by setting the
+                    following guest property of the virtual machine to any value.
+                    <screen>
+                        /VirtualBox/GuestAdd/DRMResize
+                    </screen>
+                    Please refer to <xref linkend="guestadd-guestprops" /> for how to set/delete
+                    guest properties. When this guest property is set then VBoxDRMClient is started
+                    during the guest OS boot and stays active for both display manager's login screen
+                    and desktop session.
+                </para>
+            </listitem>
+
+        </itemizedlist>
+
+        <sect3 id="guestadd-resizing-linux-limitations">
+
+            <title>Known Limitations</title>
+            <para>
+                VBoxDRMClient is not able to handle arbitrary guest monitor topologies. Specifically,
+                disabling a guest monitor (except the last one) invalidates the monitor topology. That
+                is, when the guest is configured to have 4 monitors, disabling 2nd or 3rd monitor is not
+                recommended.
+            </para>
+
+        </sect3>
+
+    </sect2>
+    <!-- <sect2 id="guestadd-resizing-wayland"> -->
+    <!-- </sec2> -->
+
+    <!-- <sect2 id="guestadd-resizing-display-managers"> -->
+    <!-- </sec2> -->
+
+    <!-- <sect2 id="guestadd-resizing-32-bit-vms"> -->
+    <!-- </sec2> -->
+
+  </sect1>
+
+
 </chapter>

trunk/doc/manual/en_US/user_Troubleshooting.xml

@@ -1310 +1310 @@
   <sect1 id="ts_lin-x11-guests">
 
-    <title>Linux and X11 Guests</title>
+    <title>Linux and X11/Wayland Guests</title>
 
     <sect2 id="ts_linux-guest-high-cpu">
@@ -1386 +1386 @@
     <sect2 id="ts_linux-guest-x11-services">
 
-      <title>Shared Clipboard, Auto-Resizing, and Seamless Desktop in X11 Guests</title>
-
-      <para>
-        Guest desktop services in guests running the X11 window system
+      <title>Shared Clipboard, Auto-Resizing, and Seamless Desktop in X11/Wayland Guests</title>
+
+      <para>
+        Guest desktop services in guests running the X11/Wayland window system
         such as Oracle Solaris and Linux, are provided by a guest
         service called <command>VBoxClient</command>, which runs under
@@ -1400 +1400 @@
 <screen>$ VBoxClient --clipboard
 $ VBoxClient --display
-$ VBoxClient --seamless</screen>
+$ VBoxClient --seamless
+$ VBoxClient --vmsvga</screen>
 
       <para>