Minor manpage formatting fix.
[fvwm.git] / doc / commands / EdgeResistance.xml
blob1191bc3f10165350222c78af295977ecfbb3321a
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: EdgeResistance.xml,v 1.4 2007/11/17 11:47:56 domivogt Exp $ -->
11 <section id='EdgeResistance'>
12 <title>EdgeResistance</title>
14 <cmdsynopsis>
15         <command>EdgeResistance</command>
16         <arg choice='plain'>
17                 <replaceable>delay</replaceable>
18         </arg>
20         <command>EdgeResistance</command
21         ><arg choice='plain'
22                 ><replaceable>scrolling</replaceable
23         ></arg
24         ><arg choice='plain'
25                 ><replaceable>moving</replaceable
26         ></arg>
27         <arg choice='opt'
28                 ><replaceable>xinerama-scrolling</replaceable
29         ></arg>
30 </cmdsynopsis>
32 <para>Tells how hard it should be to change the desktop viewport by
33 moving the mouse over the edge of the screen. The parameter tells
34 how many milliseconds the pointer must spend on the screen edge
35 before fvwm moves the viewport.  This is intended for people who
36 use</para>
38 <programlisting>
39 <fvwmref cmd="EdgeScroll"/> 100 100
40 </programlisting>
42 <para>but find themselves accidentally flipping pages when they do
43 not want to.  If -1 is given as the delay, scrolling is disabled
44 completely.</para>
46 <para>The second form of invocation with two or three arguments is
47 obsolete and should be replaced with the following three commands
48 as needed:</para>
50 <programlisting>
51 <fvwmref cmd="EdgeResistance"/> <replaceable>scrolling</replaceable>
52 <fvwmref cmd="Style"/> * EdgeMoveDelay <replaceable>scrolling</replaceable>
53 <fvwmref cmd="Style"/> * EdgeMoveResistance <replaceable>moving</replaceable>
55 <fvwmref cmd="Style"/> * EdgeMoveResistance <replaceable>moving</replaceable> <replaceable>xinerama-scrolling</replaceable>
56 </programlisting>
58 <para>Fvwm does this substitution automatically and prints a warning.</para>
60 </section>