Add "BugOpts QtDragnDropWorkaround"
[fvwm.git] / doc / commands / BugOpts.xml
blob643a59c29c36ddd544d6d0a4e1686b545e0e7023
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3   "../docbook-xml/docbookx.dtd"
5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
6 %myents;
7 ]>
9 <!-- $Id: BugOpts.xml,v 1.5 2009/12/31 17:35:47 tadam Exp $ -->
11 <section id='BugOpts'>
12 <title>BugOpts</title>
14 <cmdsynopsis>
15         <command>BugOpts</command
16         ><arg choice='plain' rep='repeat'
17                 ><arg choice='opt'
18                         ><replaceable>option</replaceable
19                         ><arg choice='opt'
20                                 ><replaceable>bool</replaceable
21                         ></arg
22                 ></arg
23         >,</arg>
24 </cmdsynopsis>
26 <para>This command controls several workarounds for bugs in third party
27 programs.  The individual options are separated by commas.  The
28 optional argument
29 <replaceable>bool</replaceable>
30 is a boolean argument and controls if the bug workaround is
31 enabled or not.  It can either be "True" or "False" to turn the
32 option on or off, or "toggle" to switch is back and forth.  If
33 <replaceable>bool</replaceable>
34 is omitted, the default setting is restored.</para>
36 <para><fvwmopt cmd="BugOpts" opt="FlickeringMoveWorkaround"/>
37 disables ConfigureNotify events that are usually sent to an
38 application while it is moved.  If some windows flicker annoyingly
39 while being moved, this option may help you.  Note that if this
40 problem occurs it is not an fvwm bug, it is a problem of the
41 application.</para>
43 <para><fvwmopt cmd="BugOpts" opt="MixedVisualWorkaround"/>
44 makes fvwm install the root colormap before it does some
45 operations using the root window visuals.  This is only useful
46 when the
47 <option>-visual</option>
48 option is used to start fvwm and then only with some
49 configurations of some servers (e.g. Exceed 6.0 with an 8 bit
50 PseudoColor root and fvwm using a 24 bit TrueColor visual).</para>
52 <para>The
53 <fvwmopt cmd="BugOpts" opt="ModalityIsEvil"/>
54 option controls whether Motif applications have the ability to
55 have modal dialogs (dialogs that force you to close them first
56 before you can do anything else).  The default is to not allow
57 applications to have modal dialogs.  Use this option with
58 care. Once this option is turned on, you have to restart fvwm to
59 turn it off.</para>
61 <para><fvwmopt cmd="BugOpts" opt="RaiseOverNativeWindows"/>
62 makes fvwm try to raise the windows it manages over native windows
63 of the X server's host system.  This is needed for some X servers
64 running under Windows, Windows NT or Mac OS X.  Fvwm tries to detect if it
65 is running under such an X server and initializes the flag
66 accordingly.</para>
68 <para><fvwmopt cmd="BugOpts" opt="RaiseOverUnmanaged"/>
69 makes fvwm try to raise the windows it manages over
70 override_redirect windows.  This is used to cope with ill-mannered
71 applications that use long-lived windows of this sort, contrary to
72 <acronym>ICCCM</acronym>
73 conventions.  It is useful with the
74 <fvwmref cmd="Style" opt="Unmanaged"/>
75 style option too.</para>
77 <para><fvwmopt cmd="BugOpts" opt="FlickeringQtDialogsWorkaround"/>
78 suppresses flickering of the focused window in some modules when
79 using <acronym>KDE</acronym> or <acronym>QT</acronym> applications with application modal dialog
80 windows.  By default this option is turned on.  This option may be
81 visually disturbing for other applications using windows not
82 managed by fvwm.  Since these applications are rare it is most
83 likely safe to leave this option at its default.</para>
85 <para><fvwmopt cmd="BugOpts" opt="QtDragnDropWorkaround"/>
86 surpresses the forwarding of unknown ClientEvent messages to windows --
87 usually this is harmless, but Qt has problems handling unrecognised
88 ClientEvent messages.  Enabling this option might therefore help for Qt
89 applications using DragnDrop.  This option is off by default.</para>
91 <para><fvwmopt cmd="BugOpts" opt="EWMHIconicStateWorkaround"/>
92 is needed by <acronym>EWMH</acronym> compliant pagers or taskbars which represent
93 windows which are on a different desktops as iconified. These
94 pagers and taskbars use a version of the <acronym>EWMH</acronym> specification before
95 version 1.2 (the current <acronym>KDE</acronym> 2 &amp; 3 versions).  These pagers and
96 taskbars use the IconicState WM_STATE state to determine if an
97 application is iconified.  This state, according to the
98 <acronym>ICCCM</acronym>,
99 does not imply that a window is iconified (in the usual sense).
100 Turning on this option forces fvwm to establish an equivalence
101 between the IconicState WM_STATE state and the iconified window.
102 This violates
103 <acronym>ICCCM</acronym>
104 compliance but should not cause big problems.
105 By default this option is off.</para>
107 <para>With the
108 <fvwmopt cmd="BugOpts" opt="DisplayNewWindowNames"/>
109 enabled, fvwm prints the name, icon name (if available), resource
110 and class of new windows to the console.  This can help in finding
111 the correct strings to use in the
112 <fvwmref cmd="Style"/>
113 command.</para>
115 <para>When the
116 <fvwmopt cmd="BugOpts" opt="ExplainWindowPlacement"/>
117 option is enabled, fvwm prints a message to the console whenever a
118 new window is placed or one of the commands
119 <fvwmref cmd="PlaceAgain"/>,
120 <fvwmref cmd="Recapture"/> or
121 <fvwmref cmd="RecaptureWindow"/>
122 is used.  The message explains on which desk, page, Xinerama
123 screen and position it was placed and why.  This option can be
124 used to figure out why a specific window does not appear where you
125 think it should.</para>
127 <para>The
128 <fvwmopt cmd="BugOpts" opt="DebugCRMotionMethod"/>
129 option enables some debugging code in the ConfigureRequest
130 handling routines of fvwm.  It is not helpful for the user, but if
131 you report a bug to the fvwm team we may ask you to enable this
132 option.</para>
134 <para>The <fvwmopt cmd="BugOpts" opt="TransliterateUtf8"/> option
135 enables transliteration during conversions from utf-8 strings.  By
136 default fvwm will not transliterate during conversion, but will fall
137 back to alternate strings provided by the clients if conversion from
138 utf-8 fails due to characters which have no direct correspondance in
139 the target charecter set. Some clients however neglect to set non utf-8
140 properties correctly in which case this option may help.</para>
142 </section>