Update documentation for the compositing manager

(Old svn revision: 12116)

1 files changed, 34 insertions, 6 deletions

diff --git a/COMPOSITOR b/COMPOSITOR
index b48f9c422..c5e1e1a1b 100644
--- a/COMPOSITOR
+++ b/COMPOSITOR
@@ -4,9 +4,10 @@ Compositing manager notes.
 xfwm4 now features a compositing manager. This code is new and has received only
 a moderate amount of testing, so it's disabled by default.
 
-If you want to stay safe, keep it disabled. If you still want to try the 
-compositor extensions with xfwm4, here follows how to enable the compositing
-manager.
+So, if you want to stay safe, keep the compositor disabled...
+
+If you still want to try the compositor extensions with xfwm4, here follows how
+to enable the compositing manager in xfwm4.
 
 1) Enabling the compositor manager in xfwm4
 -------------------------------------------
@@ -42,7 +43,34 @@ EndSection
                                                                                                               
 - Save the configuration file and restart the Xserver.
 
-3) Tips
+3) Troobleshooting
+------------------
+
+The composite extensions in X.org look fairly new and there are several problems 
+that may arise when using the compositing manager in xfwm4:
+
+- Windows aren't correctly refreshed
+- Scrolling may leave glitches
+- Xv and composite extension don't always play nice together
+- Xinerama and composite extension have problems too
+
+All this is not specifically related to the xfwm4's compositing manager. It's
+not worth filling bugs in Xfce's bugzilla.
+
+If you still think you have found a bug in xfwm4 compositing manager, here
+are a few hints that could help categorizing the problem:
+
+- Does it happen when xfwm4 compositor is disabled?
+  ie, when running "xfwm4 --compositor=no"
+- Does it happen with xcompmgr?
+  ie, when running "xfwm4 --compositor=no; xcompmgr -c"
+- Does it show with the Xserver embedded compositor manager?
+  ie, when running "xfwm4 --compositor=auto"
+  
+If the problem with xcompmgr and/or with the Xserver compositor, then there
+is a good chance that the problem is not with xfwm4...
+
+4) Tips
 -------
 
 The following tips are from my own experience. I am not connected to any graphic
@@ -51,8 +79,8 @@ card vendor.
 If you have usefull tips to improve XRender performance for your favorite video
 card, feel free to submit your own tips.
 
-3.1 NVidia
-~~~~~~~~~~
+4.1) NVidia
+~~~~~~~~~~~
 
 The XRender extension can be very CPU consuming. The NVidia binary closed source
 drivers are able to perform the rendering in hardware.