doc/commands/PointerKey.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: PointerKey.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='PointerKey'>
  12 <title>PointerKey</title>
  13
  14 <cmdsynopsis>
  15         <command>PointerKey</command
  16         ><arg choice='opt'
  17                 >(<replaceable>window</replaceable
  18         >)</arg
  19         ><arg choice='plain'
  20                 ><replaceable>Keyname</replaceable
  21         ></arg
  22         ><arg choice='plain'
  23                 ><replaceable>Context</replaceable
  24         ></arg
  25         ><arg choice='plain'
  26                 ><replaceable>Modifiers</replaceable
  27         ></arg
  28         ><arg choice='plain'
  29                 ><replaceable>Function</replaceable
  30         ></arg>
  31 </cmdsynopsis>
  32
  33 <para>This command works exactly like the
  34 <fvwmref cmd="Key"/>
  35 command.  The only difference is that the binding operates on the
  36 window under the pointer.  Normal key bindings operate on the
  37 focused window instead.  The
  38 <emphasis remap='B'>PointerKey</emphasis>
  39 command can for example be used to bind keys to the root window if
  40 you are using
  41 <fvwmref cmd="Style" opt="SloppyFocus"/> or
  42 <fvwmref cmd="Style" opt="ClickToFocus"/>.
  43 However, some applications (xterm is one example) are unable to
  44 handle this key anymore, even if the pointer is over the xterm
  45 window.  It is recommended to use the
  46 <emphasis remap='B'>PointerKey</emphasis>
  47 command only for key combinations that are not needed in any
  48 application window.</para>
  49
  50 <para>Example:</para>
  51
  52 <programlisting>
  53 <fvwmref cmd="Style"/> * <fvwmref cmd="Style" opt="SloppyFocus"/>
  54 PointerKey f1 a m <fvwmref cmd="Menu"/> MainMenu
  55 </programlisting>
  56
  57
  58 </section>