doc/commands/EdgeScroll.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: EdgeScroll.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='EdgeScroll'>
  12 <title>EdgeScroll</title>
  13
  14
  15 <cmdsynopsis>
  16         <command>EdgeScroll</command
  17         ><arg choice='plain'
  18                 ><replaceable>horizontal</replaceable
  19                 ><optional>p</optional
  20         ></arg
  21         ><arg choice='plain'
  22                 ><replaceable>vertical</replaceable
  23                 ><optional>p</optional>
  24         </arg
  25         ><group choice='opt'
  26                 ><arg choice='plain'>wrap</arg
  27                 ><arg choice='plain'>wrapx</arg
  28                 ><arg choice='plain'>wrapy</arg
  29         ></group>
  30 </cmdsynopsis>
  31
  32 <para>Specifies the percentage of a page to scroll when the cursor hits
  33 the edge of a page.  A trailing
  34 '<fvwmopt cmd="EdgeScroll" opt="p"/>'
  35 changes the interpretation to mean pixels.  If you do not want any
  36 paging or scrolling when you hit the edge of a page include</para>
  37
  38 <programlisting>
  39 EdgeScroll 0 0
  40 </programlisting>
  41
  42 <para>in your
  43 <filename>config</filename>
  44 file, or possibly better, set the
  45 <fvwmref cmd="EdgeThickness"/>
  46 to zero.  See the
  47 <fvwmref cmd="EdgeThickness"/>
  48 command. If you want whole pages, use</para>
  49
  50 <programlisting>
  51 EdgeScroll 100 100
  52 </programlisting>
  53
  54 <para>Both
  55 <replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
  56 should be positive numbers.</para>
  57
  58 <para>If the
  59 <replaceable>horizontal</replaceable> and <replaceable>vertical</replaceable>
  60 percentages are multiplied by 1000 or one of the keywords
  61 <fvwmopt cmd="EdgeScroll" opt="wrap"/>, <fvwmopt cmd="EdgeScroll" opt="wrapx"/>
  62 and <fvwmopt cmd="EdgeScroll" opt="wrapy"/>
  63 is given then scrolling wraps around at the edge of the desktop.
  64 If</para>
  65
  66 <programlisting>
  67 EdgeScroll 100000 100000
  68 </programlisting>
  69
  70 <para>is used fvwm scrolls by whole pages, wrapping around at the edge
  71 of the desktop.</para>
  72
  73 </section>