Minor grammatical improvements to the documentation.
[fvwm.git] / doc / commands / EdgeThickness.xml
blob1c275adc5532916c426c894adc762a3f9f071abe
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: EdgeThickness.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
11 <section id='EdgeThickness'>
12 <title>EdgeThickness</title>
14 <cmdsynopsis>
15         <command>EdgeThickness</command
16         ><group choice='plain'
17                 ><arg choice='plain'>0</arg
18                 ><arg choice='plain'>1</arg
19                 ><arg choice='plain'>2</arg
20         ></group>
21 </cmdsynopsis>
23 <para>This is the width or height of the invisible window that fvwm
24 creates on the edges of the screen that are used for the edge
25 scrolling feature.</para>
27 <para>In order to enable page scrolling via the mouse, four windows
28 called the "pan frames" are placed at the very edge of the
29 screen. This is how fvwm detects the mouse's presence at the
30 window edge. Because of the way this works, they need to be at the
31 top of the stack and eat mouse events, so if you have any kind of
32 error along the lines of: "mouse clicks at the edge of the screen
33 do the wrong thing" you're having trouble with the pan frames and
34 (assuming you do not use the mouse to flip between pages) should
35 set the EdgeThickness to 0.</para>
37 <para>A value of
38 <literal>0</literal>
39 completely disables mouse edge scrolling, even while dragging a
40 window.
41 <literal>1</literal>
42 gives the smallest pan frames, which seem to work best except on
43 some servers.</para>
45 <para><literal>2</literal>
46 is the default.</para>
48 <para>Pan frames of
49 <literal>1</literal> or <literal>2</literal>
50 pixels can sometimes be confusing, for example, if you drag a
51 window over the edge of the screen, so that it straddles a pan
52 frame, clicks on the window, near the edge of the screen are
53 treated as clicks on the root window.</para>
55 </section>